use xmalloc instead of malloc
[libfirm] / ir / ir / ircons.h
index d761a62..c665f56 100644 (file)
  *    ---------------------------------------------------------------------------
  *
  *    There are three kinds of symbolic constants:
- *     symconst_type_tag  The symbolic constant represents a type tag.
- *     symconst_size      The symbolic constant represents the size of a class.
- *     symconst_addr_name Information for the linker, e.g. the name of a global
- *                variable.
+ *     symconst_type_tag   The symbolic constant represents a type tag.
+ *     symconst_type_size  The symbolic constant represents the size of a type.
+ *     symconst_type_align The symbolic constant represents the alignment of a type.
+ *     symconst_addr_name  Information for the linker, e.g. the name of a global
+ *                         variable.
+ *     symconst_addr_name  The symbolic constant represents the address of an entity.
+ *
  *    To represent a pointer to an entity that is represented by an entity
  *    datastructure don't use
  *      new_SymConst((type_or_id*)get_entity_ld_ident(ent), symconst_addr_name);.
  *    Use a real const instead:
- *      new_SymConst(mode_P_mach, tarval_p_from_entity(ent));
+ *      new_SymConst(ent, symconst_addr_ent);
  *    This makes the Constant independent of name changes of the entity due to
  *    mangling.
  *
  *    Attributes:
  *      attr.i.num       The symconst_addr_ent, i.e. one of
  *                        -symconst_type_tag
- *                        -symconst_size
- *                - symconst_addr_name
- *        If the attr.i.num is symconst_type_tag or symconst_size, the node contains an attribute
+ *                        -symconst_type_size
+ *                        -symconst_type_align
+ *                        -symconst_addr_name
+ *
+ *    If the attr.i.num is symconst_type_tag, symconst_type_size or symconst_type_align,
+ *    the node contains an attribute:
+ *
  *      attr.i.*type,    a pointer to a type_class.  The mode of the node is mode_Is.
  *        if it is linkage_ptr_info it contains
  *      attr.i.*ptrinfo,  an ident holding information for the linker.  The mode
  *   node.
  *
  */
-#ifndef _IRCONS_H_
-#define _IRCONS_H_
+#ifndef _FIRM_IR_IRCONS_H_
+#define _FIRM_IR_IRCONS_H_
 
 #include "firm_common.h"
 #include "irnode.h"
@@ -1231,17 +1238,20 @@ ir_node *new_rd_Const  (dbg_info *db, ir_graph *irg, ir_node *block,
  *
  *  This is the constructor for a symbolic constant.
  *    There are four kinds of symbolic constants:
- *    - type_tag  The symbolic constant represents a type tag.  The type the
- *                tag stands for is given explicitly.
- *    - size      The symbolic constant represents the size of a type.  The
- *                type of which the constant represents the size is given
- *                explicitly.
- *    - addr_name The symbolic constant represents the address of an entity
- *                (variable or method).  The variable is indicated by a name
- *                that is valid for linking.
+ *    - type_tag   The symbolic constant represents a type tag.  The type the
+ *                 tag stands for is given explicitly.
+ *    - type_size  The symbolic constant represents the size of a type.  The
+ *                 type of which the constant represents the size is given
+ *                 explicitly.
+ *    - type_align The symbolic constant represents the alignment of a type.  The
+ *                 type of which the constant represents the size is given
+ *                 explicitly.
+ *    - addr_name  The symbolic constant represents the address of an entity
+ *                 (variable or method).  The variable is indicated by a name
+ *                 that is valid for linking.
  *    - addr_ent   The symbolic constant represents the address of an entity
- *                (variable or method).  The variable is given explicitly by
- *                a firm entity.
+ *                 (variable or method).  The variable is given explicitly by
+ *                 a firm entity.
  *
  *    Inputs to the node:
  *      No inputs except the block it belongs to.
@@ -1291,10 +1301,17 @@ ir_node *new_rd_SymConst_type_tag (dbg_info *db, ir_graph *irg, ir_type *symbol,
 /** Constructor for a SymConst size node.
  *
  * Same as new_rd_SymConst_type, except that the constructor is tailored for
- * symconst_addr_ent.
+ * symconst_type_size.
  * Adds the SymConst to the start block of irg. */
 ir_node *new_rd_SymConst_size (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
 
+/** Constructor for a SymConst size node.
+ *
+ * Same as new_rd_SymConst_type, except that the constructor is tailored for
+ * symconst_type_align.
+ * Adds the SymConst to the start block of irg. */
+ir_node *new_rd_SymConst_align (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
+
 /** Constructor for a simpleSel node.
  *
  *  This is a shortcut for the new_rd_Sel() constructor.  To be used for
@@ -2447,7 +2464,7 @@ ir_node *new_r_Alloc  (ir_graph *irg, ir_node *block, ir_node *store,
 ir_node *new_r_Free   (ir_graph *irg, ir_node *block, ir_node *store,
                ir_node *ptr, ir_node *size, ir_type *free_type, where_alloc where);
 
-/** Constructor for a  Sync node.
+/** Constructor for a Sync node.
  *
  * Merges several memory values.  The node assumes that a variable
  * either occurs only in one of the memories, or it contains the same
@@ -2459,7 +2476,7 @@ ir_node *new_r_Free   (ir_graph *irg, ir_node *block, ir_node *store,
  * @param  *in[]    An array of pointers to nodes that produce an output of  type memory.
  *                  The constructor copies this array.
  */
-ir_node *new_r_Sync   (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
+ir_node *new_r_Sync (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
 
 /** Constructor for a Proj node.
  *
@@ -2850,8 +2867,8 @@ ir_node *new_d_Const  (dbg_info *db, ir_mode *mode, tarval *con);
  *
  * @param *db     A pointer for debug information.
  * @param value   A type, entity or ident depending on the SymConst kind.
- * @param kind    The kind of the symbolic constant: symconst_type_tag, symconst_size
- *                or symconst_addr_name.
+ * @param kind    The kind of the symbolic constant: symconst_type_tag, symconst_type_size,
+ *                symconst_type_align, symconst_addr_name or symconst_addr_ent.
  * @param tp      The source type of the constant.
  */
 ir_node *new_d_SymConst_type (dbg_info *db, union symconst_symbol value, symconst_kind kind, ir_type *tp);
@@ -3580,6 +3597,9 @@ ir_node *new_Const_type(tarval *con, ir_type *tp);
  *    -# size      The symbolic constant represents the size of a type.  The
  *                 type of which the constant represents the size is given
  *                 explicitly.
+ *    -# align     The symbolic constant represents the alignment of a type.  The
+ *                 type of which the constant represents the size is given
+ *                 explicitly.
  *    -# addr_name The symbolic constant represents the address of an entity
  *                 (variable or method).  The variable is indicated by a name
  *                 that is valid for linking.
@@ -3593,7 +3613,8 @@ ir_node *new_Const_type(tarval *con, ir_type *tp);
  *      An unsigned integer (I_u) or a pointer (P).
  *
  * @param value   A type or a ident depending on the SymConst kind.
- * @param kind    The kind of the symbolic constant: symconst_type_tag, symconst_size or symconst_addr_name.
+ * @param kind    The kind of the symbolic constant: symconst_type_tag, symconst_type_size
+ *                symconst_type_align, symconst_addr_name or symconst_addr_ent.
  */
 ir_node *new_SymConst (union symconst_symbol value, symconst_kind kind);
 
@@ -3920,7 +3941,7 @@ ir_node *new_Alloc  (ir_node *store, ir_node *size, ir_type *alloc_type,
 ir_node *new_Free   (ir_node *store, ir_node *ptr, ir_node *size,
                     ir_type *free_type, where_alloc where);
 
-/** Constructor for a  Sync node.
+/** Constructor for a Sync node.
  *
  * Merges several memory values.  The node assumes that a variable
  * either occurs only in one of the memories, or it contains the same
@@ -4205,4 +4226,4 @@ void irp_finalize_cons(void);
  */
 typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
 
-#endif /* _IRCONS_H_ */
+#endif /* _FIRM_IR_IRCONS_H_ */