- removed orphan declarations
[libfirm] / ir / be / ia32 / ia32_address_mode.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       This file contains functions for matching firm graphs for
23  *              nodes that can be used as address mode for x86 instructions
24  * @author      Matthias Braun
25  * @version     $Id$
26  */
27 #ifndef IA32_ADDRESS_MODE_H
28 #define IA32_ADDRESS_MODE_H
29
30 #include "irtypes.h"
31 #include "../beirg.h"
32
33 /**
34  * The address mode data: Used to construct (memory) address modes.
35  */
36 typedef struct ia32_address_t ia32_address_t;
37 struct ia32_address_t {
38         ir_node   *base;          /**< The base register (if any) */
39         ir_node   *index;         /**< The index register (if any). */
40         ir_node   *mem;           /**< The memory value (if any). */
41         int        offset;        /**< An integer offset. */
42         int        scale;         /**< An integer scale. {0,1,2,3} */
43         ir_entity *symconst_ent;  /**< A SynConst entity if any. */
44         int        use_frame;     /**< Set, if the frame is accessed */
45         ir_entity *frame_entity;  /**< The accessed frame entity if any. */
46         int        symconst_sign; /**< The "sign" of the symconst. */
47 };
48
49 typedef enum ia32_create_am_flags_t {
50         ia32_create_am_force      = 1U << 0, /**< Ignore the marking of node as a
51                                                   non-address-mode node */
52         ia32_create_am_double_use = 1U << 1  /**< Fold AM, even if the root of
53                                                   address calculation has two users.
54                                                   This is useful for dest AM */
55 } ia32_create_am_flags_t;
56
57 /**
58  * Create an address mode for a given node.
59  */
60 void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, ia32_create_am_flags_t);
61
62 /**
63  * Mark those nodes of the given graph that cannot be used inside an
64  * address mode because there values must be materialized in registers.
65  */
66 void ia32_calculate_non_address_mode_nodes(be_irg_t *birg);
67
68 /**
69  * Free the non_address_mode information.
70  */
71 void ia32_free_non_address_mode_nodes(void);
72
73 /**
74  * Tells whether the given node is a non address mode node.
75  */
76 int ia32_is_non_address_mode_node(ir_node const *node);
77
78 /**
79  * mark a node so it will not be used as part of address modes
80  */
81 void ia32_mark_non_am(ir_node *node);
82
83 #endif