Mercurial > hg > xemacs-beta
annotate src/mule-ccl.h @ 4921:17362f371cc2
add more byte-code assertions and better failure output
-------------------- ChangeLog entries follow: --------------------
src/ChangeLog addition:
2010-02-03 Ben Wing <ben@xemacs.org>
* alloc.c (Fmake_byte_code):
* bytecode.h:
* lisp.h:
* lread.c:
* lread.c (readevalloop):
* lread.c (Fread):
* lread.c (Fread_from_string):
* lread.c (read_list_conser):
* lread.c (read_list):
* lread.c (vars_of_lread):
* symbols.c:
* symbols.c (Fdefine_function):
Turn on the "compiled-function annotation hack". Implement it
properly by hooking into Fdefalias(). Note in the docstring to
`defalias' that we do this. Remove some old broken code and
change code that implemented the old kludgy way of hooking into
the Lisp reader into bracketed by `#ifdef
COMPILED_FUNCTION_ANNOTATION_HACK_OLD_WAY', which is not enabled.
Also enable byte-code metering when DEBUG_XEMACS -- this is a form
of profiling for computing histograms of which sequences of two
bytecodes are used most often.
* bytecode-ops.h:
* bytecode-ops.h (OPCODE):
New file. Extract out all the opcodes and declare them using
OPCODE(), a bit like frame slots and such. This way the file can
be included multiple times if necessary to iterate multiple times
over the byte opcodes.
* bytecode.c:
* bytecode.c (NUM_REMEMBERED_BYTE_OPS):
* bytecode.c (OPCODE):
* bytecode.c (assert_failed_with_remembered_ops):
* bytecode.c (READ_UINT_2):
* bytecode.c (READ_INT_1):
* bytecode.c (READ_INT_2):
* bytecode.c (PEEK_INT_1):
* bytecode.c (PEEK_INT_2):
* bytecode.c (JUMP_RELATIVE):
* bytecode.c (JUMP_NEXT):
* bytecode.c (PUSH):
* bytecode.c (POP_WITH_MULTIPLE_VALUES):
* bytecode.c (DISCARD):
* bytecode.c (UNUSED):
* bytecode.c (optimize_byte_code):
* bytecode.c (optimize_compiled_function):
* bytecode.c (Fbyte_code):
* bytecode.c (vars_of_bytecode):
* bytecode.c (init_opcode_table_multi_op):
* bytecode.c (reinit_vars_of_bytecode):
* emacs.c (main_1):
* eval.c (funcall_compiled_function):
* symsinit.h:
Any time we change either the instruction pointer or the stack
pointer, assert that we're going to move it to a valid location.
This should catch failures right when they occur rather than
sometime later. This requires that we pass in another couple of
parameters into some functions (only with error-checking enabled,
see below).
Also keep track, using a circular queue, of the last 100 byte
opcodes seen, and when we hit an assert failure during byte-code
execution, output the contents of the queue in a nice readable
fashion. This requires that bytecode-ops.h be included a second
time so that a table mapping opcodes to the name of their operation
can be constructed. This table is constructed in new function
reinit_vars_of_bytecode().
Everything in the last two paras happens only when
ERROR_CHECK_BYTE_CODE.
Add some longish comments describing how the arrays that hold the
stack and instructions, and the pointers used to access them, work.
* gc.c:
Import some code from my `latest-fix' workspace to mark the
staticpro's in order from lowest to highest, rather than highest to
lowest, so it's easier to debug when something goes wrong.
* lisp.h (abort_with_message): Renamed from abort_with_msg().
* symbols.c (defsymbol_massage_name_1):
* symbols.c (defsymbol_nodump):
* symbols.c (defsymbol):
* symbols.c (defkeyword):
* symeval.h (DEFVAR_SYMVAL_FWD_OBJECT):
Make the various calls to staticpro() instead call staticpro_1(),
passing in the name of the C var being staticpro'ed, so that it
shows up in staticpro_names. Otherwise staticpro_names just has
1000+ copies of the word `location'.
author | Ben Wing <ben@xemacs.org> |
---|---|
date | Wed, 03 Feb 2010 08:01:55 -0600 |
parents | 0c54de4c4b9d |
children | 308d34e9f07d |
rev | line source |
---|---|
428 | 1 /* Header for CCL (Code Conversion Language) interpreter. |
444 | 2 Copyright (C) 1995 Electrotechnical Laboratory, JAPAN. |
428 | 3 Licensed to the Free Software Foundation. |
4 | |
5 This file is part of XEmacs. | |
6 | |
613 | 7 XEmacs is free software; you can redistribute it and/or modify |
428 | 8 it under the terms of the GNU General Public License as published by |
9 the Free Software Foundation; either version 2, or (at your option) | |
10 any later version. | |
11 | |
613 | 12 XEmacs is distributed in the hope that it will be useful, |
428 | 13 but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 GNU General Public License for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
613 | 18 along with XEmacs; see the file COPYING. If not, write to |
428 | 19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
20 Boston, MA 02111-1307, USA. */ | |
21 | |
440 | 22 #ifndef INCLUDED_mule_ccl_h_ |
23 #define INCLUDED_mule_ccl_h_ | |
428 | 24 |
25 /* Macros for exit status of CCL program. */ | |
26 #define CCL_STAT_SUCCESS 0 /* Terminated successfully. */ | |
27 #define CCL_STAT_SUSPEND_BY_SRC 1 /* Terminated by empty input. */ | |
28 #define CCL_STAT_SUSPEND_BY_DST 2 /* Terminated by output buffer full. */ | |
29 #define CCL_STAT_INVALID_CMD 3 /* Terminated because of invalid | |
30 command. */ | |
31 #define CCL_STAT_QUIT 4 /* Terminated because of quit. */ | |
32 | |
33 /* Structure to hold information about running CCL code. Read | |
34 comments in the file ccl.c for the detail of each field. */ | |
35 struct ccl_program { | |
36 int size; /* Size of the compiled code. */ | |
37 Lisp_Object *prog; /* Pointer into the compiled code. */ | |
38 int ic; /* Instruction Counter (index for PROG). */ | |
39 int eof_ic; /* Instruction Counter for end-of-file | |
40 processing code. */ | |
41 int reg[8]; /* CCL registers, reg[7] is used for | |
42 condition flag of relational | |
43 operations. */ | |
44 int private_state; /* CCL instruction may use this | |
444 | 45 for private use, mainly for saving |
46 internal states on suspending. | |
428 | 47 This variable is set to 0 when ccl is |
48 set up. */ | |
49 int last_block; /* Set to 1 while processing the last | |
50 block. */ | |
51 int status; /* Exit status of the CCL program. */ | |
52 int buf_magnification; /* Output buffer magnification. How | |
53 many times bigger the output buffer | |
54 should be than the input buffer. */ | |
55 int stack_idx; /* How deep the call of CCL_Call is nested. */ | |
444 | 56 int eol_type; /* When the CCL program is used for |
57 encoding by a coding system, set to | |
58 the eol_type of the coding | |
59 system. */ | |
60 int multibyte; /* 1 if the source text is multibyte. */ | |
428 | 61 }; |
62 | |
63 #define CCL_MODE_ENCODING 0 | |
64 #define CCL_MODE_DECODING 1 | |
65 | |
444 | 66 #define CCL_CODING_EOL_LF 0 /* Line-feed only, same as Emacs' |
67 internal format. */ | |
68 #define CCL_CODING_EOL_CRLF 1 /* Sequence of carriage-return and | |
69 line-feed. */ | |
70 #define CCL_CODING_EOL_CR 2 /* Carriage-return only. */ | |
428 | 71 |
4745
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
72 /* If OBJECT is symbol designating a registered CCL program, return it. |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
73 Else if OBJECT is a vector CCL program with no unresolved symbols, return |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
74 it. |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
75 Else, if OBJECT is a vector CCL program with unresolved symbols, return a |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
76 newly-created vector reflecting the CCL program with all symbols |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
77 resolved, if that is currently possible in this XEmacs. |
444 | 78 |
4745
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
79 Otherwise, signal `invalid-argument'. */ |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
80 extern Lisp_Object get_ccl_program (Lisp_Object object); |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
81 |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
82 /* Set up fields of the structure pointed by CCL appropriately for the |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
83 execution of ccl program CCL_PROG (a symbol or a vector). |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
84 |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
85 If CCL_PROG is a vector and contains unresolved symbols, this function |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
86 will throw an assertion failure. To avoid this, call get_ccl_program at |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
87 the point that you receive the CCL program from Lisp, and use and store |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
88 its (resolved) result instead. */ |
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
89 extern int setup_ccl_program (struct ccl_program *, Lisp_Object ccl_prog); |
444 | 90 |
91 extern int ccl_driver (struct ccl_program *, const unsigned char *, | |
92 unsigned_char_dynarr *, int, int *, int); | |
93 | |
94 EXFUN (Fregister_ccl_program, 2); | |
95 | |
428 | 96 extern Lisp_Object Qccl_program; |
97 | |
444 | 98 /* Vector of CCL program names vs corresponding program data. */ |
99 extern Lisp_Object Vccl_program_table; | |
100 | |
101 /* Symbols of ccl program have this property, a value of the property | |
102 is an index for Vccl_program_table. */ | |
103 extern Lisp_Object Qccl_program_idx; | |
104 | |
440 | 105 #endif /* INCLUDED_mule_ccl_h_ */ |