view src/README.kkcc @ 5206:39d74978fd32

Keep around file info for dumped functions and variables without docstrings. src/ChangeLog addition: 2010-04-17 Aidan Kehoe <kehoea@parhasard.net> * doc.c (Fdocumentation): If we have a zero length doc string in DOC, as may happen for undocumented compiled function objects which nonetheless have file information stored, return nil. (Fsnarf_documentation): DOC info existing for compiled functions without docstrings is perfectly legitimate, now the file is also used to store file names. * bytecode.c (set_compiled_function_documentation): Allow this function to set the documentation successfully for compiled function objects that don't currently have documentation; most relevant for functions without docstrings which have file information stored in DOC. lib-src/ChangeLog addition: 2010-04-17 Aidan Kehoe <kehoea@parhasard.net> * make-docfile.c (scan_lisp_file): Even if a function doesn't have a doc string, store its file name in DOC. lisp/ChangeLog addition: 2010-04-17 Aidan Kehoe <kehoea@parhasard.net> * loadup.el (load-history): Be a bit more discriminate in the entries we remove from load-history, only removing those where the information is entirely available from DOC. Fixes problems finding the files that dumped undocumented variables were loaded from, reported by Didier Verna. * loadhist.el (symbol-file): Correct a regexp here, I had forgotten to double a backslash.
author Aidan Kehoe <kehoea@parhasard.net>
date Sat, 17 Apr 2010 10:40:03 +0100
parents ac1be85b4a5f
children 3889ef128488
line wrap: on
line source

2002-07-17  Marcus Crestani  <crestani@informatik.uni-tuebingen.de>
	    Markus Kaltenbach  <makalten@informatik.uni-tuebingen.de>
	    Mike Sperber <mike@xemacs.org>

	updated 2003-07-29

	New KKCC-GC mark algorithm:
	configure flag : --use-kkcc

	For better understanding, first a few words about the mark algorithm 
	up to now:
	Every Lisp_Object has its own mark method, which calls mark_object
	with the stuff to be marked.
	Also, many Lisp_Objects have pdump descriptions memory_descriptions, 
	which are used by the portable dumper. The dumper gets all the 
	information it needs about the Lisp_Object from the descriptions.

	Also the garbage collector can use the information in the pdump
	descriptions, so we can get rid of the mark methods.
	That is what we have been doing.

	
	DUMPABLE FLAG
	-------------
	First we added a dumpable flag to lrecord_implementation. It shows,
	if the object is dumpable and should be processed by the dumper.
	The dumpable flag is the third argument of a lrecord_implementation
	definition (DEFINE_LRECORD_IMPLEMENTATION).
	If it is set to 1, the dumper processes the descriptions and dumps
	the Object, if it is set to 0, the dumper does not care about it.
		

	KKCC MARKING
	------------
	All Lisp_Objects have memory_descriptions now, so we could get
	rid of the mark_object calls.
	The KKCC algorithm manages its own stack. Instead of calling 
	mark_object, all the alive Lisp_Objects are pushed on the 
	kkcc_gc_stack. Then these elements on the stack  are processed 
	according to their descriptions.


	TODO
	----
	- For weakness use weak datatypes instead of XD_FLAG_NO_KKCC.
	  XD_FLAG_NO_KKCC occurs in:
		* elhash.c: htentry
		* extents.c: lispobject_gap_array, extent_list, extent_info
		* marker.c: marker     
	  Not everything has to be rewritten. See Ben's comment in lrecord.h.
	- Clean up special case marking (weak_hash_tables, weak_lists,
	  ephemerons).
	- Stack optimization (have one stack during runtime instead of 
	  malloc/free it for every garbage collect)

	There are a few Lisp_Objects, where there occured differences and
	inexactness between the mark-method and the pdump description.  All
	these Lisp_Objects get dumped (except image instances), so their
	descriptions have been written, before we started our work:
	* alloc.c: string
	description: size_, data_, and plist is described
	mark: only plist is marked, but flush_cached_extent_info is called.
	      flush_cached_extent_info ->
		free_soe ->
		  free_extent_list ->
		    free_gap_array ->
		      gap_array_delete_all_markers ->
			Add gap_array to the gap_array_marker_freelist

	* glyphs.c: image_instance
	description: device is not set to nil
	mark: mark method sets device to nil if dead
	See comment above the description.