includes firm_types.h now
[libfirm] / ir / tr / type.h
index 52c5a44..98989dd 100644 (file)
 # ifndef _TYPE_H_
 # define _TYPE_H_
 
-#include <stdbool.h>
-
+# include "firm_types.h"
 # include "tpop.h"
 # include "firm_common.h"
 # include "ident.h"
 # include "irmode.h"
 # include "dbginfo.h"
-
-/* to resolve recursion between entity.h and type.h */
-#ifndef _ENTITY_TYPEDEF_
-#define _ENTITY_TYPEDEF_
-typedef struct entity entity;
-#endif
-
-#ifndef _IR_NODE_TYPEDEF_
-#define _IR_NODE_TYPEDEF_
-typedef struct ir_node ir_node;
-#endif
-
 # include "tr_inheritance.h"
 
 /**
@@ -118,7 +105,7 @@ typedef struct ir_node ir_node;
  */
 #ifndef _TYPE_TYPEDEF_
 #define _TYPE_TYPEDEF_
-typedef struct type type;
+typedef struct ir_type type;
 #endif
 
 # include "type_or_entity.h"
@@ -307,7 +294,7 @@ unsigned long get_type_visited(const type *tp);
 void          set_type_visited(type *tp, unsigned long num);
 /* Sets visited field in type to type_visited. */
 void          mark_type_visited(type *tp);
-/* @@@ name clash!! int           type_visited(const type *tp); */
+int           type_visited(const type *tp);
 int           type_not_visited(const type *tp);
 
 /** Returns the associated link field of a type. */
@@ -318,15 +305,15 @@ void          set_type_link(type *tp, void *l);
 /**
  * Visited flag to traverse the type information.
  *
- * Increase this flag by one before traversing the type information.
- * Mark type nodes as visited by set_type_visited(type, type_visited).
- * Check whether node was already visited by comparing get_type_visited(type)
- * and type_visited.
+ * Increase this flag by one before traversing the type information
+ * using inc_master_type_visited().
+ * Mark type nodes as visited by mark_type_visited(type).
+ * Check whether node was already visited by type_visited(type)
+ * and type_not_visited(type).
  * Or use the function to walk all types.
  *
  * @see  typewalk
  */
-extern unsigned long type_visited;
 void          set_master_type_visited(unsigned long val);
 unsigned long get_master_type_visited(void);
 void          inc_master_type_visited(void);
@@ -344,12 +331,13 @@ int is_type            (const void *thing);
 /**
  *   Checks whether two types are structurally equal.
  *
- *   @param st pointer type
- *   @param lt pointer type
+ *   @param typ1  the first type
+ *   @param typ2  the second type
  *
  *   @return
  *    true if the types are equal, else false.
- *    Types are equal if :
+ *
+ *   Types are equal if :
  *    - they are the same type kind
  *    - they have the same name
  *    - they have the same mode (if applicable)
@@ -376,7 +364,7 @@ int is_type            (const void *thing);
  *       This is to avoid endless recursions; with pointer types cyclic
  *       type graphs are possible.)
  */
-int equal_type(type *tpy1, type *typ2);
+int equal_type(type *typ1, type *typ2);
 
 /**
  *   Checks whether two types are structural comparable.
@@ -550,6 +538,14 @@ void    set_class_supertype   (type *clss, type *supertype, int pos);
 /** Finds supertype in the list of supertypes and removes it */
 void    remove_class_supertype(type *clss, type *supertype);
 
+/** Convenience macro */
+#define add_class_base_type(clss, basetype)  add_class_supertype(clss, basetype)
+#define get_class_n_base_types(clss)  get_class_n_supertypes(clss)
+#define get_class_base_type_index(clss, base_clss) get_class_supertype_index(clss, base_clss)
+#define get_class_base_type(clss, pos)  get_class_supertype(clss, pos)
+#define set_class_base_type(clss, basetype, pos) set_class_supertype(clss, basetype, pos)
+#define remove_class_base_type(clss, basetype)  remove_class_supertype(clss, basetype)
+
 /** Convenience macro */
 #define add_class_base_type(clss, basetype)        add_class_supertype(clss, basetype)
 #define get_class_n_base_types(clss)               get_class_n_supertypes(clss)
@@ -766,11 +762,116 @@ int get_method_first_variadic_param_index(const type *method);
  */
 void set_method_first_variadic_param_index(type *method, int index);
 
+/**
+ * additional method type properties:
+ *  Tell about special properties of a method type. Some
+ *  of these may be discovered by analyses.
+ */
+typedef enum {
+  mtp_no_property        = 0x00000000, /**< no additional properties, default */
+  mtp_property_const     = 0x00000001, /**< This method did not access memory and calculates
+                                         its return values solely from its parameters.
+                                         GCC: __attribute__((const)). */
+  mtp_property_pure      = 0x00000002, /**< This method did NOT write to memory and calculates
+                                         its return values solely form its parameters and
+                                         the memory they points to (or global vars).
+                                         GCC: __attribute__((pure)). */
+  mtp_property_noreturn  = 0x00000004, /**< This method did not return due to an aborting system
+                                         call.
+                                         GCC: __attribute__((noreturn)). */
+  mtp_property_nothrow   = 0x00000008, /**< This method cannot throw an exception.
+                                         GCC: __attribute__((nothrow)). */
+  mtp_property_naked     = 0x00000010, /**< This method is naked.
+                                         GCC: __attribute__((naked)). */
+  mtp_property_malloc    = 0x00000020, /**< This method returns newly allocate memory.
+                                         GCC: __attribute__((malloc)). */
+  mtp_property_inherited = 0x40000000  /**< used only in irg's, means property is inherited
+                                         from type. */
+} mtp_additional_property;
+
+/** Returns the mask of the additional graph properties. */
+unsigned get_method_additional_properties(const type *method);
+
+/** Sets the mask of the additional graph properties. */
+void set_method_additional_properties(type *method, unsigned property_mask);
+
+/** Sets one additional graph property. */
+void set_method_additional_property(type *method, mtp_additional_property flag);
+
+/**
+ * calling conventions: lower 24 bits are the number of register parameters,
+ * upper 8 encode the calling conventions
+ */
+typedef enum {
+  cc_reg_param        = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
+                                         This flag may be set as default on some architectures. */
+  cc_last_on_top      = 0x02000000, /**< The last non-register parameter is transmitted on top of
+                                             the stack. This is equivalent to the stdcall or pascal
+                                             calling convention. If this flag is not set, the first
+                                             non-register parameter is used (cdecl calling convention) */
+  cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
+                                         function calls (stdcall). */
+  cc_this_call        = 0x08000000, /**< The first parameter is a this pointer and is transmitted
+                                         in a special way. */
+
+  /* some often used cases */
+  cc_cdecl_set        = 0,                                /**< cdecl calling convention */
+  cc_stdcall_set      = cc_callee_clear_stk,              /**< stdcall calling convention */
+  cc_fastcall_set     = cc_reg_param|cc_callee_clear_stk, /**< fastcall calling convention */
+
+  cc_bits             = (0xFF << 24)                      /**< the calling convention bits */
+} calling_convention;
+
+/** return the default calling convention for method types */
+unsigned get_default_cc_mask(void);
+
+/**
+ * check for the CDECL calling convention
+ */
+#define IS_CDECL(cc_mask)     (((cc_mask) & cc_bits) == cc_cdecl_set)
+
+/**
+ * check for the STDCALL calling convention
+ */
+#define IS_STDCALL(cc_mask)   (((cc_mask) & cc_bits) == cc_stdcall_set)
+
+/**
+ * check for the FASTCALL calling convention
+ */
+#define IS_FASTCALL(cc_mask)  (((cc_mask) & cc_bits) == cc_fastcall_set)
+
+/**
+ * set the CDECL convention bits
+ */
+#define SET_CDECL(cc_mask)    (((cc_mask) & ~cc_bits) | cc_cdecl_set)
+
+/**
+ * set the STDCALL convention bits
+ */
+#define SET_STDCALL(cc_mask)  (((cc_mask) & ~cc_bits) | cc_stdcall_set)
+
+/**
+ * set the FASTCALL convention bits
+ */
+#define SET_FASTCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_fastcall_set)
+
+/** Returns the calling convention of an entities graph. */
+unsigned get_method_calling_convention(const type *method);
+
+/** Sets the calling convention of an entities graph. */
+void set_method_calling_convention(type *method, unsigned cc_mask);
+
+/** Returns the number of registers parameters, 0 means default. */
+unsigned get_method_n_regparams(type *method);
+
+/** Sets the number of registers parameters, 0 means default. */
+void set_method_n_regparams(type *method, unsigned n_regs);
+
 /** Returns true if a type is a method type. */
 int   is_Method_type     (const type *method);
 
 /**
- *   @page union_type   Representation of a union type.
+ *   @page union_type   Representation of a union (variant) type.
  *
  *   The union type represents union types.
  *   - n_types:     Number of unioned types.
@@ -956,19 +1057,16 @@ int     is_Enumeration_type     (const type *enumeration);
 /**
  * @page pointer_type   Representation of a pointer type
  *
- * The mode of the pointer type must be a mode_reference.
+ * The mode of the pointer type must be a reference mode.
  *
  * Pointer types:
  * - points_to:      The type of the entity this pointer points to.
  */
 
-/** Creates a new type pointer with mode mode_p. */
-#define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_data)
-
-/** Creates a new type pointer with given pointer mode. */
-type *new_type_pointer_mode      (ident *name, type *points_to, ir_mode *ptr_mode);
+/** Creates a new type pointer. */
+type *new_type_pointer           (ident *name, type *points_to, ir_mode *ptr_mode);
 
-/** Creates a new type pointer given pointer mode and with debug information. */
+/** Creates a new type pointer with debug information. */
 type *new_d_type_pointer         (ident *name, type *points_to, ir_mode *ptr_mode, dbg_info* db);
 
 /* --- manipulate fields of type_pointer --- */