becopyheur4: Clean up co_mst_irn_init().
[libfirm] / ir / be / ia32 / ia32_address_mode.h
index fba3c0c..b42f64f 100644 (file)
@@ -1,47 +1,73 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
- *
  * This file is part of libFirm.
- *
- * This file may be distributed and/or modified under the terms of the
- * GNU General Public License version 2 as published by the Free Software
- * Foundation and appearing in the file LICENSE.GPL included in the
- * packaging of this file.
- *
- * Licensees holding valid libFirm Professional Edition licenses may use
- * this file in accordance with the libFirm Commercial License.
- * Agreement provided with the Software.
- *
- * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
- * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE.
+ * Copyright (C) 2012 University of Karlsruhe.
  */
 
 /**
  * @file
  * @brief       This file contains functions for matching firm graphs for
- *              nodes that can be used as addressmode for x86 commands
+ *              nodes that can be used as address mode for x86 instructions
  * @author      Matthias Braun
- * @version     $Id$
  */
 #ifndef IA32_ADDRESS_MODE_H
 #define IA32_ADDRESS_MODE_H
 
+#include <stdbool.h>
 #include "irtypes.h"
 
+/**
+ * The address mode data: Used to construct (memory) address modes.
+ */
 typedef struct ia32_address_t ia32_address_t;
 struct ia32_address_t {
-    ir_node   *base;
-    ir_node   *index;
-       ir_node   *mem;
-    int        offset;
-    int        scale;
-    ir_entity *symconst_ent;
-    int        use_frame;
-    ir_entity *frame_entity;
-    int        symconst_sign;
+       ir_node   *base;          /**< The base register (if any) */
+       ir_node   *index;         /**< The index register (if any). */
+       ir_node   *mem;           /**< The memory value (if any). */
+       int        offset;        /**< An integer offset. */
+       int        scale;         /**< An integer scale. {0,1,2,3} */
+       ir_entity *symconst_ent;  /**< A SynConst entity if any. */
+       bool       use_frame;     /**< Set, if the frame is accessed */
+       bool       tls_segment;   /**< Set if AM is relative to TLS */
+       ir_entity *frame_entity;  /**< The accessed frame entity if any. */
+       bool       symconst_sign; /**< The "sign" of the symconst. */
 };
 
-void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, int force);
+/**
+ * Additional flags for the address mode creation.
+ */
+typedef enum ia32_create_am_flags_t {
+       ia32_create_am_normal     = 0,       /**< Normal operation. */
+       ia32_create_am_force      = 1U << 0, /**< Ignore the marking of node as a
+                                                 non-address-mode node. */
+       ia32_create_am_double_use = 1U << 1  /**< Fold AM, even if the root of
+                                                 address calculation has two users.
+                                                 This is useful for dest AM. */
+} ia32_create_am_flags_t;
+
+/**
+ * Create an address mode for a given node.
+ */
+void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, ia32_create_am_flags_t);
+
+/**
+ * Mark those nodes of the given graph that cannot be used inside an
+ * address mode because there values must be materialized in registers.
+ */
+void ia32_calculate_non_address_mode_nodes(ir_graph *irg);
+
+/**
+ * Free the non_address_mode information.
+ */
+void ia32_free_non_address_mode_nodes(void);
+
+/**
+ * Tells whether the given node is a non address mode node.
+ */
+int ia32_is_non_address_mode_node(ir_node const *node);
+
+/**
+ * mark a node so it will not be used as part of address modes
+ */
+void ia32_mark_non_am(ir_node *node);
 
 #endif