Mercurial > hg > xemacs-beta
annotate src/bytecode.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 | d674024a8674 |
children | b5df3737028a |
rev | line source |
---|---|
428 | 1 /* Definitions for bytecode interpretation and compiled-function objects. |
2 Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, Inc. | |
814 | 3 Copyright (C) 2002 Ben Wing. |
428 | 4 |
5 This file is part of XEmacs. | |
6 | |
7 XEmacs is free software; you can redistribute it and/or modify it | |
8 under the terms of the GNU General Public License as published by the | |
9 Free Software Foundation; either version 2, or (at your option) any | |
10 later version. | |
11 | |
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
18 along with XEmacs; see the file COPYING. If not, write to | |
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
20 Boston, MA 02111-1307, USA. */ | |
21 | |
22 /* Synched up with: Not in FSF. */ | |
23 | |
24 /* Authorship: | |
25 | |
26 FSF: long ago. | |
27 Mly: rewrote for 19.8, properly abstracted. | |
28 Jon Reid: some changes for I18N3 (domain, etc), for 19.8. | |
29 */ | |
30 | |
440 | 31 #ifndef INCLUDED_bytecode_h_ |
32 #define INCLUDED_bytecode_h_ | |
428 | 33 |
3092 | 34 #ifdef NEW_GC |
35 struct compiled_function_args | |
36 { | |
37 struct lrecord_header header; | |
38 long size; | |
39 Lisp_Object args[1]; | |
40 }; | |
41 | |
42 typedef struct compiled_function_args Lisp_Compiled_Function_Args; | |
43 | |
44 DECLARE_LRECORD (compiled_function_args, Lisp_Compiled_Function_Args); | |
45 | |
46 #define XCOMPILED_FUNCTION_ARGS(x) \ | |
47 XRECORD (x, compiled_function_args, Lisp_Compiled_Function_Args) | |
48 #define wrap_compiled_function_args(p) wrap_record (p, compiled_function_args) | |
49 #define COMPILED_FUNCTION_ARGS_P(x) RECORDP (x, compiled_function_args) | |
50 #define CHECK_COMPILED_FUNCTION_ARGS(x) \ | |
51 CHECK_RECORD (x, compiled_function_args) | |
52 #define CONCHECK_COMPILED_FUNCTION_ARGS(x) \ | |
53 CONCHECK_RECORD (x, compiled_function_args) | |
54 | |
55 #define compiled_function_args_data(v) ((v)->args) | |
56 #define XCOMPILED_FUNCTION_ARGS_DATA(s) \ | |
57 compiled_function_args_data (XCOMPILED_FUNCTION_ARGS (s)) | |
3263 | 58 #endif /* NEW_GC */ |
3092 | 59 |
428 | 60 /* Meanings of slots in a Lisp_Compiled_Function. |
61 Don't use these! For backward compatibility only. */ | |
62 #define COMPILED_ARGLIST 0 | |
63 #define COMPILED_INSTRUCTIONS 1 | |
64 #define COMPILED_CONSTANTS 2 | |
65 #define COMPILED_STACK_DEPTH 3 | |
66 #define COMPILED_DOC_STRING 4 | |
67 #define COMPILED_INTERACTIVE 5 | |
68 #define COMPILED_DOMAIN 6 | |
69 | |
4921
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
70 /* Someone claims: [[ It doesn't make sense to have this and also have |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
71 load-history ]] But in fact they are quite different things. Perhaps |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
72 we should turn this on only when DEBUG_XEMACS but there's no speed |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
73 harm at all, so no reason not to do it always. */ |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
74 #define COMPILED_FUNCTION_ANNOTATION_HACK |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
75 |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
76 #ifdef DEBUG_XEMACS |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
77 /* Define BYTE_CODE_METER to enable generation of a byte-op usage |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
78 histogram. This isn't defined in FSF Emacs and isn't defined in XEmacs |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
79 v19. But this is precisely the thing to turn on when DEBUG_XEMACS. It |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
80 may lead to a slight speed penalty but nothing major. */ |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
81 #define BYTE_CODE_METER |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
82 #endif |
428 | 83 |
84 struct Lisp_Compiled_Function | |
85 { | |
86 struct lrecord_header lheader; | |
87 unsigned short stack_depth; | |
88 unsigned short specpdl_depth; | |
89 struct | |
90 { | |
91 unsigned int documentationp: 1; | |
92 unsigned int interactivep: 1; | |
93 /* Only used if I18N3, but always defined for simplicity. */ | |
94 unsigned int domainp: 1; | |
95 /* Non-zero if this bytecode came from a v18 or v19 file. | |
96 We need to Ebolify the `assoc', `delq', etc. functions. */ | |
97 unsigned int ebolified: 1; | |
98 } flags; | |
99 Lisp_Object instructions; | |
100 Lisp_Object constants; | |
101 Lisp_Object arglist; | |
814 | 102 /* For speed, we unroll arglist into an array of argument symbols, so we |
103 don't have to process arglist every time we make a function call. */ | |
3092 | 104 #ifdef NEW_GC |
105 Lisp_Object arguments; | |
106 #else /* not NEW_GC */ | |
814 | 107 Lisp_Object *args; |
3092 | 108 #endif /* not NEW_GC */ |
814 | 109 /* Minimum and maximum number of arguments. If MAX_ARGS == MANY, the |
110 function was declared with &rest, and (args_in_array - 1) indicates | |
111 how many arguments there are before the &rest argument. (We could | |
112 munge the max_non_rest_args into max_args by using a negative number, | |
113 but that interferes with pdump marking. We don't want to use a flag | |
114 to indicate &rest because that would add an extra check in the | |
115 simplest case.) */ | |
116 int min_args, max_args; | |
117 int args_in_array; | |
428 | 118 /* This uses the minimal number of conses; see accessors in data.c. */ |
119 Lisp_Object doc_and_interactive; | |
120 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK | |
121 /* Something indicating where the bytecode came from */ | |
122 Lisp_Object annotated; | |
123 #endif | |
124 }; | |
125 typedef struct Lisp_Compiled_Function Lisp_Compiled_Function; | |
126 | |
127 Lisp_Object run_byte_code (Lisp_Object compiled_function_or_instructions, ...); | |
128 | |
129 Lisp_Object compiled_function_arglist (Lisp_Compiled_Function *f); | |
130 Lisp_Object compiled_function_instructions (Lisp_Compiled_Function *f); | |
131 Lisp_Object compiled_function_constants (Lisp_Compiled_Function *f); | |
132 int compiled_function_stack_depth (Lisp_Compiled_Function *f); | |
133 Lisp_Object compiled_function_documentation (Lisp_Compiled_Function *f); | |
134 Lisp_Object compiled_function_annotation (Lisp_Compiled_Function *f); | |
135 Lisp_Object compiled_function_domain (Lisp_Compiled_Function *f); | |
136 Lisp_Object compiled_function_interactive (Lisp_Compiled_Function *f); | |
137 | |
138 void set_compiled_function_documentation (Lisp_Compiled_Function *f, | |
139 Lisp_Object new_doc); | |
140 | |
141 void optimize_compiled_function (Lisp_Object compiled_function); | |
142 | |
814 | 143 typedef unsigned char Opbyte; |
144 Lisp_Object execute_optimized_program (const Opbyte *program, | |
4921
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
145 #ifdef ERROR_CHECK_BYTE_CODE |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
146 Elemcount program_length, |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
147 #endif |
814 | 148 int stack_depth, |
149 Lisp_Object *constants_data); | |
150 | |
428 | 151 DECLARE_LRECORD (compiled_function, Lisp_Compiled_Function); |
152 #define XCOMPILED_FUNCTION(x) XRECORD (x, compiled_function, \ | |
153 Lisp_Compiled_Function) | |
617 | 154 #define wrap_compiled_function(p) wrap_record (p, compiled_function) |
428 | 155 #define COMPILED_FUNCTIONP(x) RECORDP (x, compiled_function) |
156 #define CHECK_COMPILED_FUNCTION(x) CHECK_RECORD (x, compiled_function) | |
157 #define CONCHECK_COMPILED_FUNCTION(x) CONCHECK_RECORD (x, compiled_function) | |
158 | |
159 extern Lisp_Object Qbyte_code; | |
160 | |
161 /* total 1765 internal 101 doc-and-int 775 doc-only 389 int-only 42 neither 559 | |
162 no doc slot, no int slot | |
163 overhead : (* 1765 0) = 0 | |
164 doc-and-int (args . (doc . int)): (* 775 4) = 3100 | |
165 doc-only (args . doc) : (* 389 2) = 778 | |
166 int-only (args . int) : (* 42 2) = 84 | |
167 neither args : (* 559 0) = 0 = 3962 | |
168 combined | |
169 overhead : (* 1765 1) = 1765 | |
170 doc-and-int (doc . int) : (* 775 2) = 1550 | |
171 doc-only doc : (* 389 0) = 0 | |
172 int-only int : (* 42 0) = 0 | |
173 neither - : (* 559 0) = 0 = 3315 | |
174 both | |
175 overhead : (* 1765 2) = 3530 | |
176 doc-and-int - : (* 775 0) = 0 | |
177 doc-only - : (* 389 0) = 0 | |
178 int-only - : (* 42 0) = 0 | |
179 neither - : (* 559 0) = 0 = 3530 | |
180 */ | |
181 | |
440 | 182 #endif /* INCLUDED_bytecode_h_ */ |
428 | 183 |