1 /* Parse expressions for GDB.
2 Copyright (C) 1986, 1989, 1990, 1991, 1994 Free Software Foundation, Inc.
3 Modified from expread.y by the Department of Computer Science at the
4 State University of New York at Buffalo, 1991.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
22 /* Parse an expression from text in a string,
23 and return the result as a struct expression pointer.
24 That structure contains arithmetic operations in reverse polish,
25 with constants represented by operations that are followed by special data.
26 See expression.h for the details of the format.
27 What is important here is that it can be built up sequentially
28 during the process of parsing; the lower levels of the tree always
29 come first in the result. */
32 #include "gdb_string.h"
36 #include "expression.h"
40 #include "parser-defs.h"
42 /* Global variables declared in parser-defs.h (and commented there). */
43 struct expression *expout;
46 struct block *expression_context_block;
47 struct block *innermost_block;
49 union type_stack_elt *type_stack;
50 int type_stack_depth, type_stack_size;
57 free_funcalls PARAMS ((void));
60 prefixify_expression PARAMS ((struct expression *));
63 prefixify_subexp PARAMS ((struct expression *, struct expression *, int, int));
65 /* Data structure for saving values of arglist_len for function calls whose
66 arguments contain other function calls. */
74 static struct funcall *funcall_chain;
76 /* Assign machine-independent names to certain registers
77 (unless overridden by the REGISTER_NAMES table) */
80 unsigned num_std_regs = 0;
81 struct std_regs std_regs[1];
83 struct std_regs std_regs[] = {
100 unsigned num_std_regs = (sizeof std_regs / sizeof std_regs[0]);
104 /* The generic method for targets to specify how their registers are named.
105 The mapping can be derived from three sources: reg_names; std_regs; or
106 a target specific alias hook. */
109 target_map_name_to_register (str, len)
115 /* First try target specific aliases. We try these first because on some
116 systems standard names can be context dependent (eg. $pc on a
117 multiprocessor can be could be any of several PCs). */
118 #ifdef REGISTER_NAME_ALIAS_HOOK
119 i = REGISTER_NAME_ALIAS_HOOK (str, len);
124 /* Search architectural register name space. */
125 for (i = 0; i < NUM_REGS; i++)
126 if (reg_names[i] && len == strlen (reg_names[i])
127 && STREQN (str, reg_names[i], len))
132 /* Try standard aliases */
133 for (i = 0; i < num_std_regs; i++)
134 if (std_regs[i].name && len == strlen (std_regs[i].name)
135 && STREQN (str, std_regs[i].name, len))
137 return std_regs[i].regnum;
143 /* Begin counting arguments for a function call,
144 saving the data about any containing call. */
149 register struct funcall *new;
151 new = (struct funcall *) xmalloc (sizeof (struct funcall));
152 new->next = funcall_chain;
153 new->arglist_len = arglist_len;
158 /* Return the number of arguments in a function call just terminated,
159 and restore the data for the containing function call. */
164 register int val = arglist_len;
165 register struct funcall *call = funcall_chain;
166 funcall_chain = call->next;
167 arglist_len = call->arglist_len;
172 /* Free everything in the funcall chain.
173 Used when there is an error inside parsing. */
178 register struct funcall *call, *next;
180 for (call = funcall_chain; call; call = next)
187 /* This page contains the functions for adding data to the struct expression
188 being constructed. */
190 /* Add one element to the end of the expression. */
192 /* To avoid a bug in the Sun 4 compiler, we pass things that can fit into
193 a register through here */
196 write_exp_elt (expelt)
197 union exp_element expelt;
199 if (expout_ptr >= expout_size)
202 expout = (struct expression *)
203 xrealloc ((char *) expout, sizeof (struct expression)
204 + EXP_ELEM_TO_BYTES (expout_size));
206 expout->elts[expout_ptr++] = expelt;
210 write_exp_elt_opcode (expelt)
211 enum exp_opcode expelt;
213 union exp_element tmp;
221 write_exp_elt_sym (expelt)
222 struct symbol *expelt;
224 union exp_element tmp;
232 write_exp_elt_block (b)
235 union exp_element tmp;
241 write_exp_elt_longcst (expelt)
244 union exp_element tmp;
246 tmp.longconst = expelt;
252 write_exp_elt_dblcst (expelt)
255 union exp_element tmp;
257 tmp.doubleconst = expelt;
263 write_exp_elt_type (expelt)
266 union exp_element tmp;
274 write_exp_elt_intern (expelt)
275 struct internalvar *expelt;
277 union exp_element tmp;
279 tmp.internalvar = expelt;
284 /* Add a string constant to the end of the expression.
286 String constants are stored by first writing an expression element
287 that contains the length of the string, then stuffing the string
288 constant itself into however many expression elements are needed
289 to hold it, and then writing another expression element that contains
290 the length of the string. I.E. an expression element at each end of
291 the string records the string length, so you can skip over the
292 expression elements containing the actual string bytes from either
293 end of the string. Note that this also allows gdb to handle
294 strings with embedded null bytes, as is required for some languages.
296 Don't be fooled by the fact that the string is null byte terminated,
297 this is strictly for the convenience of debugging gdb itself. Gdb
298 Gdb does not depend up the string being null terminated, since the
299 actual length is recorded in expression elements at each end of the
300 string. The null byte is taken into consideration when computing how
301 many expression elements are required to hold the string constant, of
306 write_exp_string (str)
309 register int len = str.length;
311 register char *strdata;
313 /* Compute the number of expression elements required to hold the string
314 (including a null byte terminator), along with one expression element
315 at each end to record the actual string length (not including the
316 null byte terminator). */
318 lenelt = 2 + BYTES_TO_EXP_ELEM (len + 1);
320 /* Ensure that we have enough available expression elements to store
323 if ((expout_ptr + lenelt) >= expout_size)
325 expout_size = max (expout_size * 2, expout_ptr + lenelt + 10);
326 expout = (struct expression *)
327 xrealloc ((char *) expout, (sizeof (struct expression)
328 + EXP_ELEM_TO_BYTES (expout_size)));
331 /* Write the leading length expression element (which advances the current
332 expression element index), then write the string constant followed by a
333 terminating null byte, and then write the trailing length expression
336 write_exp_elt_longcst ((LONGEST) len);
337 strdata = (char *) &expout->elts[expout_ptr];
338 memcpy (strdata, str.ptr, len);
339 *(strdata + len) = '\0';
340 expout_ptr += lenelt - 2;
341 write_exp_elt_longcst ((LONGEST) len);
344 /* Add a bitstring constant to the end of the expression.
346 Bitstring constants are stored by first writing an expression element
347 that contains the length of the bitstring (in bits), then stuffing the
348 bitstring constant itself into however many expression elements are
349 needed to hold it, and then writing another expression element that
350 contains the length of the bitstring. I.E. an expression element at
351 each end of the bitstring records the bitstring length, so you can skip
352 over the expression elements containing the actual bitstring bytes from
353 either end of the bitstring. */
356 write_exp_bitstring (str)
359 register int bits = str.length; /* length in bits */
360 register int len = (bits + HOST_CHAR_BIT - 1) / HOST_CHAR_BIT;
362 register char *strdata;
364 /* Compute the number of expression elements required to hold the bitstring,
365 along with one expression element at each end to record the actual
366 bitstring length in bits. */
368 lenelt = 2 + BYTES_TO_EXP_ELEM (len);
370 /* Ensure that we have enough available expression elements to store
373 if ((expout_ptr + lenelt) >= expout_size)
375 expout_size = max (expout_size * 2, expout_ptr + lenelt + 10);
376 expout = (struct expression *)
377 xrealloc ((char *) expout, (sizeof (struct expression)
378 + EXP_ELEM_TO_BYTES (expout_size)));
381 /* Write the leading length expression element (which advances the current
382 expression element index), then write the bitstring constant, and then
383 write the trailing length expression element. */
385 write_exp_elt_longcst ((LONGEST) bits);
386 strdata = (char *) &expout->elts[expout_ptr];
387 memcpy (strdata, str.ptr, len);
388 expout_ptr += lenelt - 2;
389 write_exp_elt_longcst ((LONGEST) bits);
392 /* Add the appropriate elements for a minimal symbol to the end of
393 the expression. The rationale behind passing in text_symbol_type and
394 data_symbol_type was so that Modula-2 could pass in WORD for
395 data_symbol_type. Perhaps it still is useful to have those types vary
396 based on the language, but they no longer have names like "int", so
397 the initial rationale is gone. */
399 static struct type *msym_text_symbol_type;
400 static struct type *msym_data_symbol_type;
401 static struct type *msym_unknown_symbol_type;
404 write_exp_msymbol (msymbol, text_symbol_type, data_symbol_type)
405 struct minimal_symbol *msymbol;
406 struct type *text_symbol_type;
407 struct type *data_symbol_type;
409 write_exp_elt_opcode (OP_LONG);
410 write_exp_elt_type (lookup_pointer_type (builtin_type_void));
411 write_exp_elt_longcst ((LONGEST) SYMBOL_VALUE_ADDRESS (msymbol));
412 write_exp_elt_opcode (OP_LONG);
414 write_exp_elt_opcode (UNOP_MEMVAL);
415 switch (msymbol -> type)
419 case mst_solib_trampoline:
420 write_exp_elt_type (msym_text_symbol_type);
427 write_exp_elt_type (msym_data_symbol_type);
431 write_exp_elt_type (msym_unknown_symbol_type);
434 write_exp_elt_opcode (UNOP_MEMVAL);
437 /* Recognize tokens that start with '$'. These include:
439 $regname A native register name or a "standard
442 $variable A convenience variable with a name chosen
445 $digits Value history with index <digits>, starting
446 from the first value which has index 1.
448 $$digits Value history with index <digits> relative
449 to the last value. I.E. $$0 is the last
450 value, $$1 is the one previous to that, $$2
451 is the one previous to $$1, etc.
453 $ | $0 | $$0 The last value in the value history.
455 $$ An abbreviation for the second to the last
456 value in the value history, I.E. $$1
461 write_dollar_variable (str)
464 /* Handle the tokens $digits; also $ (short for $0) and $$ (short for $$1)
465 and $$digits (equivalent to $<-digits> if you could type that). */
469 /* Double dollar means negate the number and add -1 as well.
470 Thus $$ alone means -1. */
471 if (str.length >= 2 && str.ptr[1] == '$')
478 /* Just dollars (one or two) */
482 /* Is the rest of the token digits? */
483 for (; i < str.length; i++)
484 if (!(str.ptr[i] >= '0' && str.ptr[i] <= '9'))
488 i = atoi (str.ptr + 1 + negate);
494 /* Handle tokens that refer to machine registers:
495 $ followed by a register name. */
496 i = target_map_name_to_register( str.ptr + 1, str.length - 1 );
498 goto handle_register;
500 /* Any other names starting in $ are debugger internal variables. */
502 write_exp_elt_opcode (OP_INTERNALVAR);
503 write_exp_elt_intern (lookup_internalvar (copy_name (str) + 1));
504 write_exp_elt_opcode (OP_INTERNALVAR);
507 write_exp_elt_opcode (OP_LAST);
508 write_exp_elt_longcst ((LONGEST) i);
509 write_exp_elt_opcode (OP_LAST);
512 write_exp_elt_opcode (OP_REGISTER);
513 write_exp_elt_longcst (i);
514 write_exp_elt_opcode (OP_REGISTER);
518 /* Return a null-terminated temporary copy of the name
519 of a string token. */
525 memcpy (namecopy, token.ptr, token.length);
526 namecopy[token.length] = 0;
530 /* Reverse an expression from suffix form (in which it is constructed)
531 to prefix form (in which we can conveniently print or execute it). */
534 prefixify_expression (expr)
535 register struct expression *expr;
538 sizeof (struct expression) + EXP_ELEM_TO_BYTES (expr->nelts);
539 register struct expression *temp;
540 register int inpos = expr->nelts, outpos = 0;
542 temp = (struct expression *) alloca (len);
544 /* Copy the original expression into temp. */
545 memcpy (temp, expr, len);
547 prefixify_subexp (temp, expr, inpos, outpos);
550 /* Return the number of exp_elements in the subexpression of EXPR
551 whose last exp_element is at index ENDPOS - 1 in EXPR. */
554 length_of_subexp (expr, endpos)
555 register struct expression *expr;
558 register int oplen = 1;
559 register int args = 0;
563 error ("?error in length_of_subexp");
565 i = (int) expr->elts[endpos - 1].opcode;
571 oplen = longest_to_int (expr->elts[endpos - 2].longconst);
572 oplen = 5 + BYTES_TO_EXP_ELEM (oplen + 1);
595 case OP_F77_UNDETERMINED_ARGLIST:
597 args = 1 + longest_to_int (expr->elts[endpos - 2].longconst);
625 case STRUCTOP_STRUCT:
633 oplen = longest_to_int (expr->elts[endpos - 2].longconst);
634 oplen = 4 + BYTES_TO_EXP_ELEM (oplen + 1);
638 oplen = longest_to_int (expr->elts[endpos - 2].longconst);
639 oplen = (oplen + HOST_CHAR_BIT - 1) / HOST_CHAR_BIT;
640 oplen = 4 + BYTES_TO_EXP_ELEM (oplen);
645 args = longest_to_int (expr->elts[endpos - 2].longconst);
646 args -= longest_to_int (expr->elts[endpos - 3].longconst);
652 case TERNOP_SLICE_COUNT:
657 case MULTI_SUBSCRIPT:
659 args = 1 + longest_to_int (expr->elts[endpos- 2].longconst);
662 case BINOP_ASSIGN_MODIFY:
673 args = 1 + (i < (int) BINOP_END);
678 oplen += length_of_subexp (expr, endpos - oplen);
685 /* Copy the subexpression ending just before index INEND in INEXPR
686 into OUTEXPR, starting at index OUTBEG.
687 In the process, convert it from suffix to prefix form. */
690 prefixify_subexp (inexpr, outexpr, inend, outbeg)
691 register struct expression *inexpr;
692 struct expression *outexpr;
696 register int oplen = 1;
697 register int args = 0;
700 enum exp_opcode opcode;
702 /* Compute how long the last operation is (in OPLEN),
703 and also how many preceding subexpressions serve as
704 arguments for it (in ARGS). */
706 opcode = inexpr->elts[inend - 1].opcode;
711 oplen = longest_to_int (inexpr->elts[inend - 2].longconst);
712 oplen = 5 + BYTES_TO_EXP_ELEM (oplen + 1);
735 case OP_F77_UNDETERMINED_ARGLIST:
737 args = 1 + longest_to_int (inexpr->elts[inend - 2].longconst);
763 case STRUCTOP_STRUCT:
772 oplen = longest_to_int (inexpr->elts[inend - 2].longconst);
773 oplen = 4 + BYTES_TO_EXP_ELEM (oplen + 1);
777 oplen = longest_to_int (inexpr->elts[inend - 2].longconst);
778 oplen = (oplen + HOST_CHAR_BIT - 1) / HOST_CHAR_BIT;
779 oplen = 4 + BYTES_TO_EXP_ELEM (oplen);
784 args = longest_to_int (inexpr->elts[inend - 2].longconst);
785 args -= longest_to_int (inexpr->elts[inend - 3].longconst);
791 case TERNOP_SLICE_COUNT:
795 case BINOP_ASSIGN_MODIFY:
801 case MULTI_SUBSCRIPT:
803 args = 1 + longest_to_int (inexpr->elts[inend - 2].longconst);
812 args = 1 + ((int) opcode < (int) BINOP_END);
815 /* Copy the final operator itself, from the end of the input
816 to the beginning of the output. */
818 memcpy (&outexpr->elts[outbeg], &inexpr->elts[inend],
819 EXP_ELEM_TO_BYTES (oplen));
822 /* Find the lengths of the arg subexpressions. */
823 arglens = (int *) alloca (args * sizeof (int));
824 for (i = args - 1; i >= 0; i--)
826 oplen = length_of_subexp (inexpr, inend);
831 /* Now copy each subexpression, preserving the order of
832 the subexpressions, but prefixifying each one.
833 In this loop, inend starts at the beginning of
834 the expression this level is working on
835 and marches forward over the arguments.
836 outbeg does similarly in the output. */
837 for (i = 0; i < args; i++)
841 prefixify_subexp (inexpr, outexpr, inend, outbeg);
846 /* This page contains the two entry points to this file. */
848 /* Read an expression from the string *STRINGPTR points to,
849 parse it, and return a pointer to a struct expression that we malloc.
850 Use block BLOCK as the lexical context for variable names;
851 if BLOCK is zero, use the block of the selected stack frame.
852 Meanwhile, advance *STRINGPTR to point after the expression,
853 at the first nonwhite character that is not part of the expression
854 (possibly a null character).
856 If COMMA is nonzero, stop if a comma is reached. */
859 parse_exp_1 (stringptr, block, comma)
864 struct cleanup *old_chain;
869 type_stack_depth = 0;
871 comma_terminates = comma;
873 if (lexptr == 0 || *lexptr == 0)
874 error_no_arg ("expression to compute");
876 old_chain = make_cleanup (free_funcalls, 0);
879 expression_context_block = block ? block : get_selected_block ();
881 namecopy = (char *) alloca (strlen (lexptr) + 1);
884 expout = (struct expression *)
885 xmalloc (sizeof (struct expression) + EXP_ELEM_TO_BYTES (expout_size));
886 expout->language_defn = current_language;
887 make_cleanup (free_current_contents, &expout);
889 if (current_language->la_parser ())
890 current_language->la_error (NULL);
892 discard_cleanups (old_chain);
894 /* Record the actual number of expression elements, and then
895 reallocate the expression memory so that we free up any
898 expout->nelts = expout_ptr;
899 expout = (struct expression *)
900 xrealloc ((char *) expout,
901 sizeof (struct expression) + EXP_ELEM_TO_BYTES (expout_ptr));;
903 /* Convert expression from postfix form as generated by yacc
904 parser, to a prefix form. */
906 DUMP_EXPRESSION (expout, gdb_stdout, "before conversion to prefix form");
907 prefixify_expression (expout);
908 DUMP_EXPRESSION (expout, gdb_stdout, "after conversion to prefix form");
914 /* Parse STRING as an expression, and complain if this fails
915 to use up all of the contents of STRING. */
918 parse_expression (string)
921 register struct expression *exp;
922 exp = parse_exp_1 (&string, 0, 0);
924 error ("Junk after end of expression.");
928 /* Stuff for maintaining a stack of types. Currently just used by C, but
929 probably useful for any language which declares its types "backwards". */
935 if (type_stack_depth == type_stack_size)
937 type_stack_size *= 2;
938 type_stack = (union type_stack_elt *)
939 xrealloc ((char *) type_stack, type_stack_size * sizeof (*type_stack));
941 type_stack[type_stack_depth++].piece = tp;
948 if (type_stack_depth == type_stack_size)
950 type_stack_size *= 2;
951 type_stack = (union type_stack_elt *)
952 xrealloc ((char *) type_stack, type_stack_size * sizeof (*type_stack));
954 type_stack[type_stack_depth++].int_val = n;
960 if (type_stack_depth)
961 return type_stack[--type_stack_depth].piece;
968 if (type_stack_depth)
969 return type_stack[--type_stack_depth].int_val;
970 /* "Can't happen". */
974 /* Pop the type stack and return the type which corresponds to FOLLOW_TYPE
975 as modified by all the stuff on the stack. */
977 follow_types (follow_type)
978 struct type *follow_type;
982 struct type *range_type;
991 follow_type = lookup_pointer_type (follow_type);
994 follow_type = lookup_reference_type (follow_type);
997 array_size = pop_type_int ();
998 /* FIXME-type-allocation: need a way to free this type when we are
1001 create_range_type ((struct type *) NULL,
1002 builtin_type_int, 0,
1003 array_size >= 0 ? array_size - 1 : 0);
1005 create_array_type ((struct type *) NULL,
1006 follow_type, range_type);
1008 TYPE_ARRAY_UPPER_BOUND_TYPE(follow_type)
1009 = BOUND_CANNOT_BE_DETERMINED;
1012 /* FIXME-type-allocation: need a way to free this type when we are
1014 follow_type = lookup_function_type (follow_type);
1021 _initialize_parse ()
1023 type_stack_size = 80;
1024 type_stack_depth = 0;
1025 type_stack = (union type_stack_elt *)
1026 xmalloc (type_stack_size * sizeof (*type_stack));
1028 msym_text_symbol_type =
1029 init_type (TYPE_CODE_FUNC, 1, 0, "<text variable, no debug info>", NULL);
1030 TYPE_TARGET_TYPE (msym_text_symbol_type) = builtin_type_int;
1031 msym_data_symbol_type =
1032 init_type (TYPE_CODE_INT, TARGET_INT_BIT / HOST_CHAR_BIT, 0,
1033 "<data variable, no debug info>", NULL);
1034 msym_unknown_symbol_type =
1035 init_type (TYPE_CODE_INT, 1, 0,
1036 "<variable (not text or data), no debug info>",