annotate dynodump/README @ 826:6728e641994e

[xemacs-hg @ 2002-05-05 11:30:15 by ben] syntax cache, 8-bit-format, lots of code cleanup README.packages: Update info about --package-path. i.c: Create an inheritable event and pass it on to XEmacs, so that ^C can be handled properly. Intercept ^C and signal the event. "Stop Build" in VC++ now works. bytecomp-runtime.el: Doc string changes. compat.el: Some attempts to redo this to make it truly useful and fix the "multiple versions interacting with each other" problem. Not yet done. Currently doesn't work. files.el: Use with-obsolete-variable to avoid warnings in new revert-buffer code. xemacs.mak: Split up CFLAGS into a version without flags specifying the C library. The problem seems to be that minitar depends on zlib, which depends specifically on libc.lib, not on any of the other C libraries. Unless you compile with libc.lib, you get errors -- specifically, no _errno in the other libraries, which must make it something other than an int. (#### But this doesn't seem to obtain in XEmacs, which also uses zlib, and can be linked with any of the C libraries. Maybe zlib is used differently and doesn't need errno, or maybe XEmacs provides an int errno; ... I don't understand. Makefile.in.in: Fix so that packages are around when testing. abbrev.c, alloc.c, buffer.c, buffer.h, bytecode.c, callint.c, casefiddle.c, casetab.c, casetab.h, charset.h, chartab.c, chartab.h, cmds.c, console-msw.h, console-stream.c, console-x.c, console.c, console.h, data.c, device-msw.c, device.c, device.h, dialog-msw.c, dialog-x.c, dired-msw.c, dired.c, doc.c, doprnt.c, dumper.c, editfns.c, elhash.c, emacs.c, eval.c, event-Xt.c, event-gtk.c, event-msw.c, event-stream.c, events.c, events.h, extents.c, extents.h, faces.c, file-coding.c, file-coding.h, fileio.c, fns.c, font-lock.c, frame-gtk.c, frame-msw.c, frame-x.c, frame.c, frame.h, glade.c, glyphs-gtk.c, glyphs-msw.c, glyphs-msw.h, glyphs-x.c, glyphs.c, glyphs.h, gui-msw.c, gui-x.c, gui.h, gutter.h, hash.h, indent.c, insdel.c, intl-win32.c, intl.c, keymap.c, lisp-disunion.h, lisp-union.h, lisp.h, lread.c, lrecord.h, lstream.c, lstream.h, marker.c, menubar-gtk.c, menubar-msw.c, menubar-x.c, menubar.c, minibuf.c, mule-ccl.c, mule-charset.c, mule-coding.c, mule-wnnfns.c, nas.c, objects-msw.c, objects-x.c, opaque.c, postgresql.c, print.c, process-nt.c, process-unix.c, process.c, process.h, profile.c, rangetab.c, redisplay-gtk.c, redisplay-msw.c, redisplay-output.c, redisplay-x.c, redisplay.c, redisplay.h, regex.c, regex.h, scrollbar-msw.c, search.c, select-x.c, specifier.c, specifier.h, symbols.c, symsinit.h, syntax.c, syntax.h, syswindows.h, tests.c, text.c, text.h, tooltalk.c, ui-byhand.c, ui-gtk.c, unicode.c, win32.c, window.c: Another big Ben patch. -- FUNCTIONALITY CHANGES: add partial support for 8-bit-fixed, 16-bit-fixed, and 32-bit-fixed formats. not quite done yet. (in particular, needs functions to actually convert the buffer.) NOTE: lots of changes to regex.c here. also, many new *_fmt() inline funs that take an Internal_Format argument. redo syntax cache code. make the cache per-buffer; keep the cache valid across calls to functions that use it. also keep it valid across insertions/deletions and extent changes, as much as is possible. eliminate the junky regex-reentrancy code by passing in the relevant lisp info to the regex routines as local vars. add general mechanism in extents code for signalling extent changes. fix numerous problems with the case-table implementation; yoshiki never properly transferred many algorithms from old-style to new-style case tables. redo char tables to support a default argument, so that mapping only occurs over changed args. change many chartab functions to accept Lisp_Object instead of Lisp_Char_Table *. comment out the code in font-lock.c by default, because font-lock.el no longer uses it. we should consider eliminating it entirely. Don't output bell as ^G in console-stream when not a TTY. add -mswindows-termination-handle to interface with i.c, so we can properly kill a build. add more error-checking to buffer/string macros. add some additional buffer_or_string_() funs. -- INTERFACE CHANGES AFFECTING MORE CODE: switch the arguments of write_c_string and friends to be consistent with write_fmt_string, which must have printcharfun first. change BI_* macros to BYTE_* for increased clarity; similarly for bi_* local vars. change VOID_TO_LISP to be a one-argument function. eliminate no-longer-needed CVOID_TO_LISP. -- char/string macro changes: rename MAKE_CHAR() to make_emchar() for slightly less confusion with make_char(). (The former generates an Emchar, the latter a Lisp object. Conceivably we should rename make_char() -> wrap_char() and similarly for make_int(), make_float().) Similar changes for other *CHAR* macros -- we now consistently use names with `emchar' whenever we are working with Emchars. Any remaining name with just `char' always refers to a Lisp object. rename macros with XSTRING_* to string_* except for those that reference actual fields in the Lisp_String object, following conventions used elsewhere. rename set_string_{data,length} macros (the only ones to work with a Lisp_String_* instead of a Lisp_Object) to set_lispstringp_* to make the difference clear. try to be consistent about caps vs. lowercase in macro/inline-fun names for chars and such, which wasn't the case before. we now reserve caps either for XFOO_ macros that reference object fields (e.g. XSTRING_DATA) or for things that have non-function semantics, e.g. directly modifying an arg (BREAKUP_EMCHAR) or evaluating an arg (any arg) more than once. otherwise, use lowercase. here is a summary of most of the macros/inline funs changed by all of the above changes: BYTE_*_P -> byte_*_p XSTRING_BYTE -> string_byte set_string_data/length -> set_lispstringp_data/length XSTRING_CHAR_LENGTH -> string_char_length XSTRING_CHAR -> string_emchar INTBYTE_FIRST_BYTE_P -> intbyte_first_byte_p INTBYTE_LEADING_BYTE_P -> intbyte_leading_byte_p charptr_copy_char -> charptr_copy_emchar LEADING_BYTE_* -> leading_byte_* CHAR_* -> EMCHAR_* *_CHAR_* -> *_EMCHAR_* *_CHAR -> *_EMCHAR CHARSET_BY_ -> charset_by_* BYTE_SHIFT_JIS* -> byte_shift_jis* BYTE_BIG5* -> byte_big5* REP_BYTES_BY_FIRST_BYTE -> rep_bytes_by_first_byte char_to_unicode -> emchar_to_unicode valid_char_p -> valid_emchar_p Change intbyte_strcmp -> qxestrcmp_c (duplicated functionality). -- INTERFACE CHANGES AFFECTING LESS CODE: use DECLARE_INLINE_HEADER in various places. remove '#ifdef emacs' from XEmacs-only files. eliminate CHAR_TABLE_VALUE(), which duplicated the functionality of get_char_table(). add BUFFER_TEXT_LOOP to simplify iterations over buffer text. define typedefs for signed and unsigned types of fixed sizes (INT_32_BIT, UINT_32_BIT, etc.). create ALIGN_FOR_TYPE as a higher-level interface onto ALIGN_SIZE; fix code to use it. add charptr_emchar_len to return the text length of the character pointed to by a ptr; use it in place of charcount_to_bytecount(..., 1). add emchar_len to return the text length of a given character. add types Bytexpos and Charxpos to generalize Bytebpos/Bytecount and Charbpos/Charcount, in code (particularly, the extents code and redisplay code) that works with either kind of index. rename redisplay struct params with names such as `charbpos' to e.g. `charpos' when they are e.g. a Charxpos, not a Charbpos. eliminate xxDEFUN in place of DEFUN; no longer necessary with changes awhile back to doc.c. split up big ugly combined list of EXFUNs in lisp.h on a file-by-file basis, since other prototypes are similarly split. rewrite some "*_UNSAFE" macros as inline funs and eliminate the _UNSAFE suffix. move most string code from lisp.h to text.h; the string code and text.h code is now intertwined in such a fashion that they need to be in the same place and partially interleaved. (you can't create forward references for inline funs) automated/lisp-tests.el, automated/symbol-tests.el, automated/test-harness.el: Fix test harness to output FAIL messages to stderr when in batch mode. Fix up some problems in lisp-tests/symbol-tests that were causing spurious failures.
author ben
date Sun, 05 May 2002 11:33:57 +0000
parents 376386a54a3c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 DYNODUMP
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 --------
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 Dynodump, not to be confused with DinoTurd (as seen in Jurassic Park),
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 is a shared object that provides one function:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 int dynodump(char *new_file);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 dynodump(), called from a running program will write a new executable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 in new_file a la unexec() in GNU Emacs. The difference lies in the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 relocations.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 dynodump() will create an image with any relocations (which were
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 performed by the run-time dynamic linker) undone. This allows the new
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 image to be run in a different environment. There is, however, one
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 potentially major caveat. If a symbol reference gets updated during
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 the running of the calling program, its updated value will be lost.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 An example (with additional blank lines for legibility):
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 $ cat lib.c
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 char _foo[] = "hello";
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 char _bar[] = "world";
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 $ cc -G -o lib.so lib.c
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 $ cat prog.c
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 extern char _foo, _bar;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 int beenhere = 0;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 char * foo = &_foo;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 char * bar = &_bar;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 int
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 main(void)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 {
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 (void) printf("%d: foo = %x\n", beenhere, foo);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 (void) printf("%d: bar = %x, ", beenhere, bar);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 if (!beenhere) {
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 beenhere = 1;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 bar++;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 dynodump("newfile");
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 }
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 (void) printf("%x\n", bar);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 }
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 $ cc -o prog prog.c -R. lib.so dynodump.so
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 $ ./prog
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 0: foo = ef7503cc
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 0: bar = ef7503d2, ef7503d3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 $ ./newfile
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 1: foo = ef7503cc
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 1: bar = ef7503d2, ef7503d2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 Notice that in the run of newfile, bar points at "world" instead of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 the perhaps expected "orld".
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 Dynodump supports sparc, intel, and power pc architectures.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 Dynodump is buildable with GNU make and gcc. If it works for you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 with these tools, let me know.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 unexec()
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 --------
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 Also supplied is an unexsol2.c which belongs in the XEmacs src
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 directory with the other unex*.c files. The src/s/sol2.h should be
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70 have the following added to it:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 #ifdef UNEXEC
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 #undef UNEXEC
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 #define UNEXEC unexsol2.o
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 This unexec() will attempt to dlopen() the dynodump.so to find the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 dynodump function. The default is "../dynodump/dynodump.so" which
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 should be appropriate for the typical XEmacs build (unless you used
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 configure to set up separate build and source trees). You may change
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 it by setting the DYNODUMP environment variable to the full path of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82 the dynodump shared object.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 Other notes:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86 If you're using the 4.0 C compiler from Sun, you should arrange to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 shut off the incremental linker. This is done with the -xildoff
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 option to the compiler. The common.mk and testsuite/Makefile files
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89 have commentary and ready made lines for uncommenting for this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90 purpose.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 If you're interested in playing with the UltraSPARC specific options
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93 to the aforementioned compiler, then the same makefiles have some
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94 commentary and flags settings to point you in that direction.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 Questions:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98 dynodump() was developed by Rod.Evans@Eng.Sun.COM and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99 Georg.Nikodym@Canada.Sun.COM. If you have questions, feel free to ask
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
100 them but be aware that Rod, "don't know jack about emacs."
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101