OSDN Git Service

PR rtl-optimization/14782
[pf3gnuchains/gcc-fork.git] / gcc / tree.def
1 /* This file contains the definitions and documentation for the
2    tree codes used in GCC.
3    Copyright (C) 1987, 1988, 1993, 1995, 1997, 1998, 2000, 2001, 2004
4    Free Software Foundation, Inc.
5
6 This file is part of GCC.
7
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
11 version.
12
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
16 for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING.  If not, write to the Free
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
21 02111-1307, USA.  */
22
23  
24 /* The third argument can be:
25    'x' for an exceptional code (fits no category).
26    't' for a type object code.
27    'c' for codes for constants.
28    'd' for codes for declarations (also serving as variable refs).
29    'r' for codes for references to storage.
30    '<' for codes for comparison expressions.
31    '1' for codes for unary arithmetic expressions.
32    '2' for codes for binary arithmetic expressions.
33    's' for codes for "statement" expressions, which have side-effects,
34        but usually no interesting value.
35    'e' for codes for other kinds of expressions.  */
36
37 /* For `r', `e', `<', `1', `2', and `s' nodes, which use struct
38    tree_exp, the 4th element is the number of argument slots to
39    allocate.  This determines the size of the tree node object.
40    Other nodes use different structures, and the size is determined
41    by the tree_union member structure; the 4th element should be
42    zero.  Languages that define language-specific 'x' or 'c' codes
43    must define the tree_size langhook to say how big they are.  */
44
45 /* Any erroneous construct is parsed into a node of this type.
46    This type of node is accepted without complaint in all contexts
47    by later parsing activities, to avoid multiple error messages
48    for one error.
49    No fields in these nodes are used except the TREE_CODE.  */
50 DEFTREECODE (ERROR_MARK, "error_mark", 'x', 0)
51
52 /* Used to represent a name (such as, in the DECL_NAME of a decl node).
53    Internally it looks like a STRING_CST node.
54    There is only one IDENTIFIER_NODE ever made for any particular name.
55    Use `get_identifier' to get it (or create it, the first time).  */
56 DEFTREECODE (IDENTIFIER_NODE, "identifier_node", 'x', 0)
57
58 /* Has the TREE_VALUE and TREE_PURPOSE fields.  */
59 /* These nodes are made into lists by chaining through the
60    TREE_CHAIN field.  The elements of the list live in the
61    TREE_VALUE fields, while TREE_PURPOSE fields are occasionally
62    used as well to get the effect of Lisp association lists.  */
63 DEFTREECODE (TREE_LIST, "tree_list", 'x', 0)
64
65 /* These nodes contain an array of tree nodes.  */
66 DEFTREECODE (TREE_VEC, "tree_vec", 'x', 0)
67
68 /* A symbol binding block.  These are arranged in a tree,
69    where the BLOCK_SUBBLOCKS field contains a chain of subblocks
70    chained through the BLOCK_CHAIN field.
71    BLOCK_SUPERCONTEXT points to the parent block.
72      For a block which represents the outermost scope of a function, it
73      points to the FUNCTION_DECL node.
74    BLOCK_VARS points to a chain of decl nodes.
75    BLOCK_TYPE_TAGS points to a chain of types which have their own names.
76    BLOCK_CHAIN points to the next BLOCK at the same level.
77    BLOCK_ABSTRACT_ORIGIN points to the original (abstract) tree node which
78    this block is an instance of, or else is NULL to indicate that this
79    block is not an instance of anything else.  When non-NULL, the value
80    could either point to another BLOCK node or it could point to a
81    FUNCTION_DECL node (e.g. in the case of a block representing the
82    outermost scope of a particular inlining of a function).
83    BLOCK_ABSTRACT is nonzero if the block represents an abstract
84    instance of a block (i.e. one which is nested within an abstract
85    instance of an inline function). 
86    TREE_ASM_WRITTEN is nonzero if the block was actually referenced
87    in the generated assembly.  */
88 DEFTREECODE (BLOCK, "block", 'x', 0)
89 \f
90 /* Each data type is represented by a tree node whose code is one of
91    the following:  */
92 /* Each node that represents a data type has a component TYPE_SIZE
93    containing a tree that is an expression for the size in bits.
94    The TYPE_MODE contains the machine mode for values of this type.
95    The TYPE_POINTER_TO field contains a type for a pointer to this type,
96      or zero if no such has been created yet.
97    The TYPE_NEXT_VARIANT field is used to chain together types
98      that are variants made by type modifiers such as "const" and "volatile".
99    The TYPE_MAIN_VARIANT field, in any member of such a chain,
100      points to the start of the chain.
101    The TYPE_NONCOPIED_PARTS field is a list specifying which parts
102      of an object of this type should *not* be copied by assignment.
103      The TREE_VALUE of each is a FIELD_DECL that should not be
104      copied.  The TREE_PURPOSE is an initial value for that field when
105      an object of this type is initialized via an INIT_EXPR.  It may
106      be NULL if no special value is required.  Even the things in this
107      list are copied if the right-hand side of an assignment is known
108      to be a complete object (rather than being, perhaps, a subobject
109      of some other object.)  The determination of what constitutes a
110      complete object is done by fixed_type_p.
111    The TYPE_NAME field contains info on the name used in the program
112      for this type (for GDB symbol table output).  It is either a
113      TYPE_DECL node, for types that are typedefs, or an IDENTIFIER_NODE
114      in the case of structs, unions or enums that are known with a tag,
115      or zero for types that have no special name.
116    The TYPE_CONTEXT for any sort of type which could have a name or
117     which could have named members (e.g. tagged types in C/C++) will
118     point to the node which represents the scope of the given type, or
119     will be NULL_TREE if the type has "file scope".  For most types, this
120     will point to a BLOCK node or a FUNCTION_DECL node, but it could also
121     point to a FUNCTION_TYPE node (for types whose scope is limited to the
122     formal parameter list of some function type specification) or it
123     could point to a RECORD_TYPE, UNION_TYPE or QUAL_UNION_TYPE node
124     (for C++ "member" types).
125     For non-tagged-types, TYPE_CONTEXT need not be set to anything in
126     particular, since any type which is of some type category  (e.g.
127     an array type or a function type) which cannot either have a name
128     itself or have named members doesn't really have a "scope" per se.
129   The TREE_CHAIN field is used as a forward-references to names for
130     ENUMERAL_TYPE, RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE nodes;
131     see below.  */
132
133 DEFTREECODE (VOID_TYPE, "void_type", 't', 0)    /* The void type in C */
134
135 /* Integer types in all languages, including char in C.
136    Also used for sub-ranges of other discrete types.
137    Has components TYPE_MIN_VALUE, TYPE_MAX_VALUE (expressions, inclusive)
138    and TYPE_PRECISION (number of bits used by this type).
139    In the case of a subrange type in Pascal, the TREE_TYPE
140    of this will point at the supertype (another INTEGER_TYPE,
141    or an ENUMERAL_TYPE, CHAR_TYPE, or BOOLEAN_TYPE).
142    Otherwise, the TREE_TYPE is zero.  */
143 DEFTREECODE (INTEGER_TYPE, "integer_type", 't', 0)
144
145 /* C's float and double.  Different floating types are distinguished
146    by machine mode and by the TYPE_SIZE and the TYPE_PRECISION.  */
147 DEFTREECODE (REAL_TYPE, "real_type", 't', 0)
148
149 /* Complex number types.  The TREE_TYPE field is the data type
150    of the real and imaginary parts.  */
151 DEFTREECODE (COMPLEX_TYPE, "complex_type", 't', 0)
152
153 /* Vector types.  The TREE_TYPE field is the data type of the vector
154    elements.  */
155 DEFTREECODE (VECTOR_TYPE, "vector_type", 't', 0)
156
157 /* C enums.  The type node looks just like an INTEGER_TYPE node.
158    The symbols for the values of the enum type are defined by
159    CONST_DECL nodes, but the type does not point to them;
160    however, the TYPE_VALUES is a list in which each element's TREE_PURPOSE
161    is a name and the TREE_VALUE is the value (an INTEGER_CST node).  */
162 /* A forward reference `enum foo' when no enum named foo is defined yet
163    has zero (a null pointer) in its TYPE_SIZE.  The tag name is in
164    the TYPE_NAME field.  If the type is later defined, the normal
165    fields are filled in.
166    RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE forward refs are
167    treated similarly.  */
168 DEFTREECODE (ENUMERAL_TYPE, "enumeral_type", 't', 0)
169
170 /* Pascal's boolean type (true or false are the only values);
171    no special fields needed.  */
172 DEFTREECODE (BOOLEAN_TYPE, "boolean_type", 't', 0)
173
174 /* CHAR in Pascal; not used in C.
175    No special fields needed.  */
176 DEFTREECODE (CHAR_TYPE, "char_type", 't', 0)
177
178 /* All pointer-to-x types have code POINTER_TYPE.
179    The TREE_TYPE points to the node for the type pointed to.  */
180 DEFTREECODE (POINTER_TYPE, "pointer_type", 't', 0)
181
182 /* An offset is a pointer relative to an object.
183    The TREE_TYPE field is the type of the object at the offset.
184    The TYPE_OFFSET_BASETYPE points to the node for the type of object
185    that the offset is relative to.  */
186 DEFTREECODE (OFFSET_TYPE, "offset_type", 't', 0)
187
188 /* A reference is like a pointer except that it is coerced
189    automatically to the value it points to.  Used in C++.  */
190 DEFTREECODE (REFERENCE_TYPE, "reference_type", 't', 0)
191
192 /* METHOD_TYPE is the type of a function which takes an extra first
193    argument for "self", which is not present in the declared argument list.
194    The TREE_TYPE is the return type of the method.  The TYPE_METHOD_BASETYPE
195    is the type of "self".  TYPE_ARG_TYPES is the real argument list, which
196    includes the hidden argument for "self".  */
197 DEFTREECODE (METHOD_TYPE, "method_type", 't', 0)
198
199 /* Used for Pascal; details not determined right now.  */
200 DEFTREECODE (FILE_TYPE, "file_type", 't', 0)
201
202 /* Types of arrays.  Special fields:
203    TREE_TYPE              Type of an array element.
204    TYPE_DOMAIN            Type to index by.
205                             Its range of values specifies the array length.
206  The field TYPE_POINTER_TO (TREE_TYPE (array_type)) is always nonzero
207  and holds the type to coerce a value of that array type to in C.
208  TYPE_STRING_FLAG indicates a string (in contrast to an array of chars)
209  in languages (such as Chill) that make a distinction.  */
210 /* Array types in C or Pascal */
211 DEFTREECODE (ARRAY_TYPE, "array_type", 't', 0)
212
213 /* Types of sets for Pascal.  Special fields are the same as
214    in an array type.  The target type is always a boolean type.
215    Used for both bitstrings and powersets in Chill;
216    TYPE_STRING_FLAG indicates a bitstring.  */
217 DEFTREECODE (SET_TYPE, "set_type", 't', 0)
218
219 /* Struct in C, or record in Pascal.  */
220 /* Special fields:
221    TYPE_FIELDS  chain of FIELD_DECLs for the fields of the struct,
222      and VAR_DECLs, TYPE_DECLs and CONST_DECLs for record-scope variables,
223      types and enumerators.
224    A few may need to be added for Pascal.  */
225 /* See the comment above, before ENUMERAL_TYPE, for how
226    forward references to struct tags are handled in C.  */
227 DEFTREECODE (RECORD_TYPE, "record_type", 't', 0)
228
229 /* Union in C.  Like a struct, except that the offsets of the fields
230    will all be zero.  */
231 /* See the comment above, before ENUMERAL_TYPE, for how
232    forward references to union tags are handled in C.  */
233 DEFTREECODE (UNION_TYPE, "union_type", 't', 0)  /* C union type */
234
235 /* Similar to UNION_TYPE, except that the expressions in DECL_QUALIFIER
236    in each FIELD_DECL determine what the union contains.  The first
237    field whose DECL_QUALIFIER expression is true is deemed to occupy
238    the union.  */
239 DEFTREECODE (QUAL_UNION_TYPE, "qual_union_type", 't', 0)
240
241 /* Type of functions.  Special fields:
242    TREE_TYPE                type of value returned.
243    TYPE_ARG_TYPES      list of types of arguments expected.
244         this list is made of TREE_LIST nodes.
245    Types of "Procedures" in languages where they are different from functions
246    have code FUNCTION_TYPE also, but then TREE_TYPE is zero or void type.  */
247 DEFTREECODE (FUNCTION_TYPE, "function_type", 't', 0)
248
249 /* This is a language-specific kind of type.
250    Its meaning is defined by the language front end.
251    layout_type does not know how to lay this out,
252    so the front-end must do so manually.  */
253 DEFTREECODE (LANG_TYPE, "lang_type", 't', 0)
254 \f
255 /* Expressions */
256
257 /* First, the constants.  */
258
259 /* Contents are in TREE_INT_CST_LOW and TREE_INT_CST_HIGH fields,
260    32 bits each, giving us a 64 bit constant capability.
261    Note: constants of type char in Pascal are INTEGER_CST,
262    and so are pointer constants such as nil in Pascal or NULL in C.
263    `(int *) 1' in C also results in an INTEGER_CST.  */
264 DEFTREECODE (INTEGER_CST, "integer_cst", 'c', 0)
265
266 /* Contents are in TREE_REAL_CST field.  */
267 DEFTREECODE (REAL_CST, "real_cst", 'c', 0)
268
269 /* Contents are in TREE_REALPART and TREE_IMAGPART fields,
270    whose contents are other constant nodes.  */
271 DEFTREECODE (COMPLEX_CST, "complex_cst", 'c', 0)
272
273 /* Contents are in TREE_VECTOR_CST_ELTS field.  */
274 DEFTREECODE (VECTOR_CST, "vector_cst", 'c', 0)     
275
276 /* Contents are TREE_STRING_LENGTH and TREE_STRING_POINTER fields.  */
277 DEFTREECODE (STRING_CST, "string_cst", 'c', 0)
278
279 /* Declarations.  All references to names are represented as ..._DECL
280    nodes.  The decls in one binding context are chained through the
281    TREE_CHAIN field.  Each DECL has a DECL_NAME field which contains
282    an IDENTIFIER_NODE.  (Some decls, most often labels, may have zero
283    as the DECL_NAME).  DECL_CONTEXT points to the node representing
284    the context in which this declaration has its scope.  For
285    FIELD_DECLs, this is the RECORD_TYPE, UNION_TYPE, or
286    QUAL_UNION_TYPE node that the field is a member of.  For VAR_DECL,
287    PARM_DECL, FUNCTION_DECL, LABEL_DECL, and CONST_DECL nodes, this
288    points to either the FUNCTION_DECL for the containing function, the
289    RECORD_TYPE or UNION_TYPE for the containing type, or NULL_TREE or
290    a TRANSLATION_UNIT_DECL if the given decl has "file scope".
291    DECL_ABSTRACT_ORIGIN, if non-NULL, points to the original (abstract)
292     ..._DECL node of which this decl is an (inlined or template expanded)
293     instance.
294    The TREE_TYPE field holds the data type of the object, when relevant.
295     LABEL_DECLs have no data type.  For TYPE_DECL, the TREE_TYPE field
296     contents are the type whose name is being declared.
297    The DECL_ALIGN, DECL_SIZE,
298     and DECL_MODE fields exist in decl nodes just as in type nodes.
299     They are unused in LABEL_DECL, TYPE_DECL and CONST_DECL nodes.
300
301    DECL_FIELD_BIT_OFFSET holds an integer number of bits offset for
302    the location.  DECL_VOFFSET holds an expression for a variable
303    offset; it is to be multiplied by DECL_VOFFSET_UNIT (an integer).
304    These fields are relevant only in FIELD_DECLs and PARM_DECLs.
305
306    DECL_INITIAL holds the value to initialize a variable to,
307    or the value of a constant.  For a function, it holds the body
308    (a node of type BLOCK representing the function's binding contour
309    and whose body contains the function's statements.)  For a LABEL_DECL
310    in C, it is a flag, nonzero if the label's definition has been seen.
311
312    PARM_DECLs use a special field:
313    DECL_ARG_TYPE is the type in which the argument is actually
314     passed, which may be different from its type within the function.
315
316    FUNCTION_DECLs use four special fields:
317    DECL_ARGUMENTS holds a chain of PARM_DECL nodes for the arguments.
318    DECL_RESULT holds a RESULT_DECL node for the value of a function,
319     or it is 0 for a function that returns no value.
320     (C functions returning void have zero here.)
321     The TREE_TYPE field is the type in which the result is actually
322     returned.  This is usually the same as the return type of the
323     FUNCTION_DECL, but it may be a wider integer type because of
324     promotion.
325    DECL_FUNCTION_CODE is a code number that is nonzero for
326     built-in functions.  Its value is an enum built_in_function
327     that says which built-in function it is.
328
329    DECL_SOURCE_FILE holds a filename string and DECL_SOURCE_LINE
330    holds a line number.  In some cases these can be the location of
331    a reference, if no definition has been seen.
332
333    DECL_ABSTRACT is nonzero if the decl represents an abstract instance
334    of a decl (i.e. one which is nested within an abstract instance of a
335    inline function.  */
336
337 DEFTREECODE (FUNCTION_DECL, "function_decl", 'd', 0)
338 DEFTREECODE (LABEL_DECL, "label_decl", 'd', 0)
339 DEFTREECODE (CONST_DECL, "const_decl", 'd', 0)
340 DEFTREECODE (TYPE_DECL, "type_decl", 'd', 0)
341 DEFTREECODE (VAR_DECL, "var_decl", 'd', 0)
342 DEFTREECODE (PARM_DECL, "parm_decl", 'd', 0)
343 DEFTREECODE (RESULT_DECL, "result_decl", 'd', 0)
344 DEFTREECODE (FIELD_DECL, "field_decl", 'd', 0)
345
346 /* A namespace declaration.  Namespaces appear in DECL_CONTEXT of other
347    _DECLs, providing a hierarchy of names.  */
348 DEFTREECODE (NAMESPACE_DECL, "namespace_decl", 'd', 0)
349
350 /* A translation unit.  This is not technically a declaration, since it
351    can't be looked up, but it's close enough.  */
352 DEFTREECODE (TRANSLATION_UNIT_DECL, "translation_unit_decl", 'd', 0)
353 \f
354 /* References to storage.  */
355
356 /* Value is structure or union component.
357    Operand 0 is the structure or union (an expression);
358    operand 1 is the field (a node of type FIELD_DECL).  */
359 DEFTREECODE (COMPONENT_REF, "component_ref", 'r', 2)
360
361 /* Reference to a group of bits within an object.  Similar to COMPONENT_REF
362    except the position is given explicitly rather than via a FIELD_DECL.
363    Operand 0 is the structure or union expression;
364    operand 1 is a tree giving the number of bits being referenced;
365    operand 2 is a tree giving the position of the first referenced bit.
366    The field can be either a signed or unsigned field;
367    BIT_FIELD_REF_UNSIGNED says which.  */
368 DEFTREECODE (BIT_FIELD_REF, "bit_field_ref", 'r', 3)
369    
370 /* C unary `*' or Pascal `^'.  One operand, an expression for a pointer.  */
371 DEFTREECODE (INDIRECT_REF, "indirect_ref", 'r', 1)
372
373 /* Pascal `^` on a file.  One operand, an expression for the file.  */
374 DEFTREECODE (BUFFER_REF, "buffer_ref", 'r', 1)
375
376 /* Array indexing.
377    Operand 0 is the array; operand 1 is a (single) array index.  */
378 DEFTREECODE (ARRAY_REF, "array_ref", 'r', 2)
379
380 /* Likewise, except that the result is a range ("slice") of the array.  The
381    starting index of the resulting array is taken from operand 1 and the size
382    of the range is taken from the type of the expression.  */
383 DEFTREECODE (ARRAY_RANGE_REF, "array_range_ref", 'r', 2)
384
385 /* Vtable indexing.  Carries data useful for emitting information
386    for vtable garbage collection.
387    Operand 0: an array_ref (or equivalent expression)
388    Operand 1: the vtable base (must be a var_decl)
389    Operand 2: index into vtable (must be an integer_cst).  */
390 DEFTREECODE (VTABLE_REF, "vtable_ref", 'r', 3)
391
392 /* The exception object from the runtime.  */
393 DEFTREECODE (EXC_PTR_EXPR, "exc_ptr_expr", 'e', 0)
394
395 /* The filter object from the runtime.  */
396 DEFTREECODE (FILTER_EXPR, "filter_expr", 'e', 0)
397
398 /* Constructor: return an aggregate value made from specified components.
399    In C, this is used only for structure and array initializers.
400    Also used for SET_TYPE in Chill (and potentially Pascal).
401    The operand is a list of component values made out of a chain of
402    TREE_LIST nodes.
403
404    For ARRAY_TYPE:
405    The TREE_PURPOSE of each node is the corresponding index.
406    If the TREE_PURPOSE is a RANGE_EXPR, it is a short-hand for many nodes,
407    one for each index in the range.  (If the corresponding TREE_VALUE
408    has side-effects, they are evaluated once for each element.  Wrap the
409    value in a SAVE_EXPR if you want to evaluate side effects only once.)
410
411    For RECORD_TYPE, UNION_TYPE, or QUAL_UNION_TYPE:
412    The TREE_PURPOSE of each node is a FIELD_DECL.
413
414    For SET_TYPE:
415    The TREE_VALUE specifies a value (index) in the set that is true.
416    If TREE_PURPOSE is non-NULL, it specifies the lower limit of a
417    range of true values.  Elements not listed are false (not in the set).  */
418 DEFTREECODE (CONSTRUCTOR, "constructor", 'e', 1)
419
420 /* The expression types are mostly straightforward, with the fourth argument
421    of DEFTREECODE saying how many operands there are.
422    Unless otherwise specified, the operands are expressions and the
423    types of all the operands and the expression must all be the same.  */
424
425 /* Contains two expressions to compute, one followed by the other.
426    the first value is ignored.  The second one's value is used.  The
427    type of the first expression need not agree with the other types.  */
428 DEFTREECODE (COMPOUND_EXPR, "compound_expr", 'e', 2)
429
430 /* Assignment expression.  Operand 0 is the what to set; 1, the new value.  */
431 DEFTREECODE (MODIFY_EXPR, "modify_expr", 'e', 2)
432
433 /* Initialization expression.  Operand 0 is the variable to initialize;
434    Operand 1 is the initializer.  */
435 DEFTREECODE (INIT_EXPR, "init_expr", 'e', 2)
436
437 /* For TARGET_EXPR, operand 0 is the target of an initialization,
438    operand 1 is the initializer for the target, which may be void
439      if simply expanding it initializes the target.
440    operand 2 is the cleanup for this node, if any.
441    operand 3 is the saved initializer after this node has been
442    expanded once; this is so we can re-expand the tree later.  */
443 DEFTREECODE (TARGET_EXPR, "target_expr", 'e', 4)
444
445 /* Conditional expression ( ... ? ... : ...  in C).
446    Operand 0 is the condition.
447    Operand 1 is the then-value.
448    Operand 2 is the else-value.
449    Operand 0 may be of any type.
450    Operand 1 must have the same type as the entire expression, unless
451    it unconditionally throws an exception, in which case it should
452    have VOID_TYPE.  The same constraints apply to operand 2.  */
453 DEFTREECODE (COND_EXPR, "cond_expr", 'e', 3)
454
455 /* Declare local variables, including making RTL and allocating space.
456    BIND_EXPR_VARS is a chain of VAR_DECL nodes for the variables.
457    BIND_EXPR_BODY is the body, the expression to be computed using 
458    the variables.  The value of operand 1 becomes that of the BIND_EXPR.
459    BIND_EXPR_BLOCK is the BLOCK that corresponds to these bindings
460    for debugging purposes.  If this BIND_EXPR is actually expanded,
461    that sets the TREE_USED flag in the BLOCK.
462
463    The BIND_EXPR is not responsible for informing parsers
464    about these variables.  If the body is coming from the input file,
465    then the code that creates the BIND_EXPR is also responsible for 
466    informing the parser of the variables.
467
468    If the BIND_EXPR is ever expanded, its TREE_USED flag is set.
469    This tells the code for debugging symbol tables not to ignore the BIND_EXPR.
470    If the BIND_EXPR should be output for debugging but will not be expanded, 
471    set the TREE_USED flag by hand.
472
473    In order for the BIND_EXPR to be known at all, the code that creates it
474    must also install it as a subblock in the tree of BLOCK
475    nodes for the function.  */
476 DEFTREECODE (BIND_EXPR, "bind_expr", 'e', 3)
477
478 /* A labeled block. Operand 0 is the label that will be generated to
479    mark the end of the block.
480    Operand 1 is the labeled block body.  */
481 DEFTREECODE (LABELED_BLOCK_EXPR, "labeled_block_expr", 'e', 2)
482
483 /* Function call.  Operand 0 is the function.
484    Operand 1 is the argument list, a list of expressions
485    made out of a chain of TREE_LIST nodes.
486    Operand 2 is the static chain argument, or NULL.  */
487 DEFTREECODE (CALL_EXPR, "call_expr", 'e', 3)
488
489 /* Specify a value to compute along with its corresponding cleanup.
490    Operand 0 argument is an expression whose value needs a cleanup.
491    Operand 1 is the cleanup expression for the object.
492    Operand 2 is an RTL_EXPR which will eventually represent that value.
493      The RTL_EXPR is used in this expression, which is how the expression
494      manages to act on the proper value.
495    The cleanup is executed by the first enclosing CLEANUP_POINT_EXPR, if
496    it exists, otherwise it is the responsibility of the caller to manually
497    call expand_start_target_temps/expand_end_target_temps, as needed.
498
499    This differs from TRY_CATCH_EXPR in that operand 2 is always
500    evaluated when an exception isn't thrown when cleanups are run.  */
501 DEFTREECODE (WITH_CLEANUP_EXPR, "with_cleanup_expr", 'e', 3)
502
503 /* Specify a cleanup point.
504    Operand 0 is an expression that may have cleanups.  If it does, those
505    cleanups are executed after the expression is expanded.
506
507    Note that if the expression is a reference to storage, it is forced out
508    of memory before the cleanups are run.  This is necessary to handle
509    cases where the cleanups modify the storage referenced; in the
510    expression 't.i', if 't' is a struct with an integer member 'i' and a
511    cleanup which modifies 'i', the value of the expression depends on
512    whether the cleanup is run before or after 't.i' is evaluated.  When
513    expand_expr is run on 't.i', it returns a MEM.  This is not good enough;
514    the value of 't.i' must be forced out of memory.
515
516    As a consequence, the operand of a CLEANUP_POINT_EXPR must not have
517    BLKmode, because it will not be forced out of memory.  */
518 DEFTREECODE (CLEANUP_POINT_EXPR, "cleanup_point_expr", 'e', 1)
519
520 /* The following two codes are used in languages that have types where
521    some field in an object of the type contains a value that is used in
522    the computation of another field's offset or size and/or the size of
523    the type.  The positions and/or sizes of fields can vary from object
524    to object of the same type or even for one and the same object within
525    its scope.
526
527    Record types with discriminants in Ada or schema types in Pascal are
528    examples of such types.  This mechanism is also used to create "fat
529    pointers" for unconstrained array types in Ada; the fat pointer is a
530    structure one of whose fields is a pointer to the actual array type
531    and the other field is a pointer to a template, which is a structure
532    containing the bounds of the array.  The bounds in the type pointed
533    to by the first field in the fat pointer refer to the values in the
534    template.
535
536    When you wish to construct such a type you need "self-references"
537    that allow you to reference the object having this type from the
538    TYPE node, i.e. without having a variable instantiating this type.
539
540    Such a "self-references" is done using a PLACEHOLDER_EXPR.  This is
541    a node that will later be replaced with the object being referenced.
542    Its type is that of the object and selects which object to use from
543    a chain of references (see below).  No other slots are used in the
544    PLACEHOLDER_EXPR.
545
546    For example, if your type FOO is a RECORD_TYPE with a field BAR,
547    and you need the value of <variable>.BAR to calculate TYPE_SIZE
548    (FOO), just substitute <variable> above with a PLACEHOLDER_EXPR
549    whose TREE_TYPE is FOO.  Then construct your COMPONENT_REF with
550    the PLACEHOLDER_EXPR as the first operand (which has the correct
551    type).  Later, when the size is needed in the program, the back-end
552    will find this PLACEHOLDER_EXPR and generate code to calculate the
553    actual size at run-time.  In the following, we describe how this
554    calculation is done.
555
556    When we wish to evaluate a size or offset, we check whether it contains a
557    PLACEHOLDER_EXPR.  If it does, we call substitute_placeholder_in_expr
558    passing both that tree and an expression within which the object may be
559    found.  The latter expression is the object itself in the simple case of
560    an Ada record with discriminant, but it can be the array in the case of an
561    unconstrained array.
562
563    In the latter case, we need the fat pointer, because the bounds of
564    the array can only be accessed from it.  However, we rely here on the
565    fact that the expression for the array contains the dereference of
566    the fat pointer that obtained the array pointer.  */
567
568 /* Denotes a record to later be substituted before evaluating this expression.
569    The type of this expression is used to find the record to replace it.  */
570 DEFTREECODE (PLACEHOLDER_EXPR, "placeholder_expr", 'x', 0)
571
572 /* Simple arithmetic.  */
573 DEFTREECODE (PLUS_EXPR, "plus_expr", '2', 2)
574 DEFTREECODE (MINUS_EXPR, "minus_expr", '2', 2)
575 DEFTREECODE (MULT_EXPR, "mult_expr", '2', 2)
576
577 /* Division for integer result that rounds the quotient toward zero.  */
578 DEFTREECODE (TRUNC_DIV_EXPR, "trunc_div_expr", '2', 2)
579
580 /* Division for integer result that rounds the quotient toward infinity.  */
581 DEFTREECODE (CEIL_DIV_EXPR, "ceil_div_expr", '2', 2)
582
583 /* Division for integer result that rounds toward minus infinity.  */
584 DEFTREECODE (FLOOR_DIV_EXPR, "floor_div_expr", '2', 2)
585
586 /* Division for integer result that rounds toward nearest integer.  */
587 DEFTREECODE (ROUND_DIV_EXPR, "round_div_expr", '2', 2)
588
589 /* Four kinds of remainder that go with the four kinds of division.  */
590 DEFTREECODE (TRUNC_MOD_EXPR, "trunc_mod_expr", '2', 2)
591 DEFTREECODE (CEIL_MOD_EXPR, "ceil_mod_expr", '2', 2)
592 DEFTREECODE (FLOOR_MOD_EXPR, "floor_mod_expr", '2', 2)
593 DEFTREECODE (ROUND_MOD_EXPR, "round_mod_expr", '2', 2)
594
595 /* Division for real result.  */
596 DEFTREECODE (RDIV_EXPR, "rdiv_expr", '2', 2)
597
598 /* Division which is not supposed to need rounding.
599    Used for pointer subtraction in C.  */
600 DEFTREECODE (EXACT_DIV_EXPR, "exact_div_expr", '2', 2)
601
602 /* Conversion of real to fixed point: four ways to round,
603    like the four ways to divide.
604    CONVERT_EXPR can also be used to convert a real to an integer,
605    and that is what is used in languages that do not have ways of
606    specifying which of these is wanted.  Maybe these are not needed.  */
607 DEFTREECODE (FIX_TRUNC_EXPR, "fix_trunc_expr", '1', 1)
608 DEFTREECODE (FIX_CEIL_EXPR, "fix_ceil_expr", '1', 1)
609 DEFTREECODE (FIX_FLOOR_EXPR, "fix_floor_expr", '1', 1)
610 DEFTREECODE (FIX_ROUND_EXPR, "fix_round_expr", '1', 1)
611
612 /* Conversion of an integer to a real.  */
613 DEFTREECODE (FLOAT_EXPR, "float_expr", '1', 1)
614
615 /* Unary negation.  */
616 DEFTREECODE (NEGATE_EXPR, "negate_expr", '1', 1)
617
618 DEFTREECODE (MIN_EXPR, "min_expr", '2', 2)
619 DEFTREECODE (MAX_EXPR, "max_expr", '2', 2)
620
621 /* Represents the absolute value of the operand.
622
623    An ABS_EXPR must have either an INTEGER_TYPE or a REAL_TYPE.  The
624    operand of the ABS_EXPR must have the same type.  */
625 DEFTREECODE (ABS_EXPR, "abs_expr", '1', 1)
626
627 /* Shift operations for shift and rotate.
628    Shift means logical shift if done on an
629    unsigned type, arithmetic shift if done on a signed type.
630    The second operand is the number of bits to
631    shift by; it need not be the same type as the first operand and result.
632    Note that the result is undefined if the second operand is larger
633    than the first operand's type size.  */
634 DEFTREECODE (LSHIFT_EXPR, "lshift_expr", '2', 2)
635 DEFTREECODE (RSHIFT_EXPR, "rshift_expr", '2', 2)
636 DEFTREECODE (LROTATE_EXPR, "lrotate_expr", '2', 2)
637 DEFTREECODE (RROTATE_EXPR, "rrotate_expr", '2', 2)
638
639 /* Bitwise operations.  Operands have same mode as result.  */
640 DEFTREECODE (BIT_IOR_EXPR, "bit_ior_expr", '2', 2)
641 DEFTREECODE (BIT_XOR_EXPR, "bit_xor_expr", '2', 2)
642 DEFTREECODE (BIT_AND_EXPR, "bit_and_expr", '2', 2)
643 DEFTREECODE (BIT_NOT_EXPR, "bit_not_expr", '1', 1)
644
645 /* ANDIF and ORIF allow the second operand not to be computed if the
646    value of the expression is determined from the first operand.  AND,
647    OR, and XOR always compute the second operand whether its value is
648    needed or not (for side effects).  The operand may have
649    BOOLEAN_TYPE or INTEGER_TYPE.  In either case, the argument will be
650    either zero or one.  For example, a TRUTH_NOT_EXPR will never have
651    an INTEGER_TYPE VAR_DECL as its argument; instead, a NE_EXPR will be
652    used to compare the VAR_DECL to zero, thereby obtaining a node with
653    value zero or one.  */
654 DEFTREECODE (TRUTH_ANDIF_EXPR, "truth_andif_expr", 'e', 2)
655 DEFTREECODE (TRUTH_ORIF_EXPR, "truth_orif_expr", 'e', 2)
656 DEFTREECODE (TRUTH_AND_EXPR, "truth_and_expr", 'e', 2)
657 DEFTREECODE (TRUTH_OR_EXPR, "truth_or_expr", 'e', 2)
658 DEFTREECODE (TRUTH_XOR_EXPR, "truth_xor_expr", 'e', 2)
659 DEFTREECODE (TRUTH_NOT_EXPR, "truth_not_expr", 'e', 1)
660
661 /* Relational operators.
662    `EQ_EXPR' and `NE_EXPR' are allowed for any types.
663    The others are allowed only for integer (or pointer or enumeral)
664    or real types.
665    In all cases the operands will have the same type,
666    and the value is always the type used by the language for booleans.  */
667 DEFTREECODE (LT_EXPR, "lt_expr", '<', 2)
668 DEFTREECODE (LE_EXPR, "le_expr", '<', 2)
669 DEFTREECODE (GT_EXPR, "gt_expr", '<', 2)
670 DEFTREECODE (GE_EXPR, "ge_expr", '<', 2)
671 DEFTREECODE (EQ_EXPR, "eq_expr", '<', 2)
672 DEFTREECODE (NE_EXPR, "ne_expr", '<', 2)
673
674 /* Additional relational operators for floating point unordered.  */
675 DEFTREECODE (UNORDERED_EXPR, "unordered_expr", '<', 2)
676 DEFTREECODE (ORDERED_EXPR, "ordered_expr", '<', 2)
677
678 /* These are equivalent to unordered or ...  */
679 DEFTREECODE (UNLT_EXPR, "unlt_expr", '<', 2)
680 DEFTREECODE (UNLE_EXPR, "unle_expr", '<', 2)
681 DEFTREECODE (UNGT_EXPR, "ungt_expr", '<', 2)
682 DEFTREECODE (UNGE_EXPR, "unge_expr", '<', 2)
683 DEFTREECODE (UNEQ_EXPR, "uneq_expr", '<', 2)
684
685 /* This is the reverse of uneq_expr.  */
686 DEFTREECODE (LTGT_EXPR, "ltgt_expr", '<', 2)
687
688 /* Operations for Pascal sets.  Not used now.  */
689 DEFTREECODE (IN_EXPR, "in_expr", '2', 2)
690 DEFTREECODE (SET_LE_EXPR, "set_le_expr", '<', 2)
691 DEFTREECODE (CARD_EXPR, "card_expr", '1', 1)
692 DEFTREECODE (RANGE_EXPR, "range_expr", '2', 2)
693
694 /* Represents a conversion of type of a value.
695    All conversions, including implicit ones, must be
696    represented by CONVERT_EXPR or NOP_EXPR nodes.  */
697 DEFTREECODE (CONVERT_EXPR, "convert_expr", '1', 1)
698
699 /* Represents a conversion expected to require no code to be generated.  */
700 DEFTREECODE (NOP_EXPR, "nop_expr", '1', 1)
701
702 /* Value is same as argument, but guaranteed not an lvalue.  */
703 DEFTREECODE (NON_LVALUE_EXPR, "non_lvalue_expr", '1', 1)
704
705 /* Represents viewing something of one type as being of a second type.
706    This corresponds to an "Unchecked Conversion" in Ada and roughly to
707    the idiom *(type2 *)&X in C.  The only operand is the value to be
708    viewed as being of another type.  It is undefined if the type of the
709    input and of the expression have different sizes.
710
711    This code may also be used within the LHS of a MODIFY_EXPR, in which
712    case no actual data motion may occur.  TREE_ADDRESSABLE will be set in
713    this case and GCC must abort if it could not do the operation without
714    generating insns.  */
715 DEFTREECODE (VIEW_CONVERT_EXPR, "view_convert_expr", '1', 1)
716
717 /* Represents something we computed once and will use multiple times.
718    First operand is that expression.  Second is the function decl
719    in which the SAVE_EXPR was created.  The third operand is the RTL,
720    nonzero only after the expression has been computed.  */
721 DEFTREECODE (SAVE_EXPR, "save_expr", 'e', 3)
722
723 /* For a UNSAVE_EXPR, operand 0 is the value to unsave.  By unsave, we
724    mean that all _EXPRs such as TARGET_EXPRs, SAVE_EXPRs,
725    CALL_EXPRs and RTL_EXPRs, that are protected
726    from being evaluated more than once should be reset so that a new
727    expand_expr call of this expr will cause those to be re-evaluated.
728    This is useful when we want to reuse a tree in different places,
729    but where we must re-expand.  */
730 DEFTREECODE (UNSAVE_EXPR, "unsave_expr", 'e', 1)
731
732 /* Represents something whose RTL has already been expanded as a
733    sequence which should be emitted when this expression is expanded.
734    The first operand is the RTL to emit.  It is the first of a chain
735    of insns.  The second is the RTL expression for the result.  The
736    third operand is the "alternate RTL expression" for the result, if
737    any; if the second argument is the DECL_RTL for a VAR_DECL, but
738    with an invalid memory address replaced by a valid one, then the
739    third operand will be the original DECL_RTL.  Any temporaries
740    created during the building of the RTL_EXPR can be reused once the
741    RTL_EXPR has been expanded, with the exception of the
742    RTL_EXPR_RTL.  */
743 DEFTREECODE (RTL_EXPR, "rtl_expr", 'e', 3)
744
745 /* & in C.  Value is the address at which the operand's value resides.
746    Operand may have any mode.  Result mode is Pmode.  */
747 DEFTREECODE (ADDR_EXPR, "addr_expr", 'e', 1)
748
749 /* Non-lvalue reference or pointer to an object.  */
750 DEFTREECODE (REFERENCE_EXPR, "reference_expr", 'e', 1)
751
752 /* Operand is a function constant; result is a function variable value
753    of type EPmode.  Used only for languages that need static chains.  */
754 DEFTREECODE (ENTRY_VALUE_EXPR, "entry_value_expr", 'e', 1)
755
756 /* Operand0 is a function constant; result is part N of a function 
757    descriptor of type ptr_mode.  */
758 DEFTREECODE (FDESC_EXPR, "fdesc_expr", 'e', 2)
759
760 /* Given two real or integer operands of the same type,
761    returns a complex value of the corresponding complex type.  */
762 DEFTREECODE (COMPLEX_EXPR, "complex_expr", '2', 2)
763
764 /* Complex conjugate of operand.  Used only on complex types.  */
765 DEFTREECODE (CONJ_EXPR, "conj_expr", '1', 1)
766
767 /* Used only on an operand of complex type, these return
768    a value of the corresponding component type.  */
769 DEFTREECODE (REALPART_EXPR, "realpart_expr", '1', 1)
770 DEFTREECODE (IMAGPART_EXPR, "imagpart_expr", '1', 1)
771
772 /* Nodes for ++ and -- in C.
773    The second arg is how much to increment or decrement by.
774    For a pointer, it would be the size of the object pointed to.  */
775 DEFTREECODE (PREDECREMENT_EXPR, "predecrement_expr", 'e', 2)
776 DEFTREECODE (PREINCREMENT_EXPR, "preincrement_expr", 'e', 2)
777 DEFTREECODE (POSTDECREMENT_EXPR, "postdecrement_expr", 'e', 2)
778 DEFTREECODE (POSTINCREMENT_EXPR, "postincrement_expr", 'e', 2)
779
780 /* Used to implement `va_arg'.  */
781 DEFTREECODE (VA_ARG_EXPR, "va_arg_expr", 'e', 1)
782
783 /* Evaluate operand 1.  If and only if an exception is thrown during
784    the evaluation of operand 1, evaluate operand 2.
785
786    This differs from TRY_FINALLY_EXPR in that operand 2 is not evaluated
787    on a normal or jump exit, only on an exception.  */
788 DEFTREECODE (TRY_CATCH_EXPR, "try_catch_expr", 'e', 2)
789
790 /* Evaluate the first operand.
791    The second operand is a cleanup expression which is evaluated
792    on any exit (normal, exception, or jump out) from this expression.  */
793 DEFTREECODE (TRY_FINALLY_EXPR, "try_finally", 'e', 2)
794 \f
795 /* These types of expressions have no useful value,
796    and always have side effects.  */
797
798 /* A label definition, encapsulated as a statement.
799    Operand 0 is the LABEL_DECL node for the label that appears here.
800    The type should be void and the value should be ignored.  */
801 DEFTREECODE (LABEL_EXPR, "label_expr", 's', 1)
802
803 /* GOTO.  Operand 0 is a LABEL_DECL node or an expression.
804    The type should be void and the value should be ignored.  */
805 DEFTREECODE (GOTO_EXPR, "goto_expr", 's', 1)
806
807 /* Used internally for cleanups in the implementation of TRY_FINALLY_EXPR.
808    (Specifically, it is created by expand_expr, not front-ends.)
809    Operand 0 is the rtx for the start of the subroutine we need to call.
810    Operand 1 is the rtx for a variable in which to store the address
811    of where the subroutine should return to.  */
812 DEFTREECODE (GOTO_SUBROUTINE_EXPR, "goto_subroutine", 's', 2)
813
814 /* RETURN.  Evaluates operand 0, then returns from the current function.
815    Presumably that operand is an assignment that stores into the
816    RESULT_DECL that hold the value to be returned.
817    The operand may be null.
818    The type should be void and the value should be ignored.  */
819 DEFTREECODE (RETURN_EXPR, "return_expr", 's', 1)
820
821 /* Exit the inner most loop conditionally.  Operand 0 is the condition.
822    The type should be void and the value should be ignored.  */
823 DEFTREECODE (EXIT_EXPR, "exit_expr", 's', 1)
824
825 /* A loop.  Operand 0 is the body of the loop.
826    It must contain an EXIT_EXPR or is an infinite loop.
827    The type should be void and the value should be ignored.  */
828 DEFTREECODE (LOOP_EXPR, "loop_expr", 's', 1)
829
830 /* Exit a labeled block, possibly returning a value.  Operand 0 is a
831    LABELED_BLOCK_EXPR to exit.  Operand 1 is the value to return. It
832    may be left null.  */
833 DEFTREECODE (EXIT_BLOCK_EXPR, "exit_block_expr", 's', 2)
834
835 /* Switch expression.
836
837    TREE_TYPE is the original type of the condition, before any
838    language required type conversions.  It may be NULL, in which case
839    the original type and final types are assumed to be the same.
840
841    Operand 0 is the expression used to perform the branch,
842    Operand 1 is the body of the switch, which probably contains
843      CASE_LABEL_EXPRs.  It may also be NULL, in which case operand 2
844      must not be NULL.
845    Operand 2 is either NULL_TREE or a TREE_VEC of the CASE_LABEL_EXPRs
846      of all the cases.  */
847 DEFTREECODE (SWITCH_EXPR, "switch_expr", 's', 3)
848
849 /* Used to represent a case label. The operands are CASE_LOW and
850    CASE_HIGH, respectively. If CASE_LOW is NULL_TREE, the label is a
851    'default' label. If CASE_HIGH is NULL_TREE, the label is a normal case
852    label.  CASE_LABEL is the corresponding LABEL_DECL.  */
853 DEFTREECODE (CASE_LABEL_EXPR, "case_label_expr", 's', 3)
854
855 /* RESX.  Resume execution after an exception.  Operand 0 is a 
856    number indicating the exception region that is being left.  */
857 DEFTREECODE (RESX_EXPR, "resx_expr", 's', 1)
858
859 /* Used to represent an inline assembly statement.  ASM_STRING returns a
860    STRING_CST for the instruction (e.g., "mov x, y"). ASM_OUTPUTS,
861    ASM_INPUTS, and ASM_CLOBBERS represent the outputs, inputs, and clobbers
862    for the statement.  */
863 DEFTREECODE (ASM_EXPR, "asm_expr", 's', 4)
864
865 /* Variable references for SSA analysis.  New SSA names are created every
866    time a variable is assigned a new value.  The SSA builder uses SSA_NAME
867    nodes to implement SSA versioning.  */
868 DEFTREECODE (SSA_NAME, "ssa_name", 'x', 0)
869
870 /* SSA PHI operator.  PHI_RESULT is the new SSA_NAME node created by
871    the PHI node.  PHI_ARG_LENGTH is the number of arguments.
872    PHI_ARG_ELT returns the Ith tuple <ssa_name, edge> from the
873    argument list.  Each tuple contains the incoming reaching
874    definition (SSA_NAME node) and the edge via which that definition
875    is coming through.   */
876 DEFTREECODE (PHI_NODE, "phi_node", 'x', 0)
877
878 /* Used to represent a typed exception handler.  CATCH_TYPES is the type (or
879    list of types) handled, and CATCH_BODY is the code for the handler.  */
880 DEFTREECODE (CATCH_EXPR, "catch_expr", 's', 2)
881
882 /* Used to represent an exception specification.  EH_FILTER_TYPES is a list
883    of allowed types, and EH_FILTER_FAILURE is an expression to evaluate on
884    failure.  EH_FILTER_MUST_NOT_THROW controls which range type to use when
885    expanding.  */
886 DEFTREECODE (EH_FILTER_EXPR, "eh_filter_expr", 's', 2)
887
888 /* Used to chain children of container statements together.
889    Use the interface in tree-iterator.h to access this node.  */
890 DEFTREECODE (STATEMENT_LIST, "statement_list", 'x', 0)
891
892 /*
893 Local variables:
894 mode:c
895 End:
896 */