projects
/
libfirm
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
fix doxygen warning
[libfirm]
/
include
/
libfirm
/
irmemory.h
diff --git
a/include/libfirm/irmemory.h
b/include/libfirm/irmemory.h
index
f14c137
..
43858e6
100644
(file)
--- a/
include/libfirm/irmemory.h
+++ b/
include/libfirm/irmemory.h
@@
-22,7
+22,6
@@
* @brief Memory disambiguator
* @author Michael Beck
* @date 27.12.2006
* @brief Memory disambiguator
* @author Michael Beck
* @date 27.12.2006
- * @version $Id$
*/
#ifndef FIRM_ANA_IRMEMORY_H
#define FIRM_ANA_IRMEMORY_H
*/
#ifndef FIRM_ANA_IRMEMORY_H
#define FIRM_ANA_IRMEMORY_H
@@
-30,6
+29,15
@@
#include "firm_types.h"
#include "begin.h"
#include "firm_types.h"
#include "begin.h"
+/** @ingroup irana
+ * @defgroup ir_memory Memory Disambiguator
+ *
+ * A memory disambiguator checks whether 2 given SSA values representing
+ * addresses alias.
+ *
+ * @{
+ */
+
/** The alias relation of two memory addresses. */
typedef enum ir_alias_relation {
ir_no_alias, /**< No alias. */
/** The alias relation of two memory addresses. */
typedef enum ir_alias_relation {
ir_no_alias, /**< No alias. */
@@
-75,7
+83,7
@@
typedef enum ir_storage_class_class_t {
} ir_storage_class_class_t;
ENUM_BITSET(ir_storage_class_class_t)
} ir_storage_class_class_t;
ENUM_BITSET(ir_storage_class_class_t)
-/**
Get
the base storage class (ignore modifier) */
+/**
Returns
the base storage class (ignore modifier) */
FIRM_API ir_storage_class_class_t get_base_sc(ir_storage_class_class_t x);
/**
FIRM_API ir_storage_class_class_t get_base_sc(ir_storage_class_class_t x);
/**
@@
-138,7
+146,7
@@
FIRM_API ir_alias_relation get_alias_relation(
const ir_node *adr2, const ir_mode *mode2);
/**
const ir_node *adr2, const ir_mode *mode2);
/**
- * Set a source language specific memory disambiguator function.
+ * Set
s
a source language specific memory disambiguator function.
*
* @param func The callback.
*/
*
* @param func The callback.
*/
@@
-149,11
+157,10
@@
FIRM_API void set_language_memory_disambiguator(DISAMBIGUATOR_FUNC func);
*/
FIRM_API void mem_disambig_init(void);
*/
FIRM_API void mem_disambig_init(void);
-/*
+/*
*
* Determine the alias relation between two addresses and
* cache the result.
*
* Determine the alias relation between two addresses and
* cache the result.
*
- * @param irg The current graph.
* @param adr1 The first address.
* @param mode1 The mode of the first memory access.
* @param adr2 The second address.
* @param adr1 The first address.
* @param mode1 The mode of the first memory access.
* @param adr2 The second address.
@@
-170,19
+177,11
@@
FIRM_API ir_alias_relation get_alias_relation_ex(
*/
FIRM_API void mem_disambig_term(void);
*/
FIRM_API void mem_disambig_term(void);
-FIRM_API ir_entity_usage_computed_state get_irg_entity_usage_state(const ir_graph *irg);
-
-FIRM_API void set_irg_entity_usage_state(ir_graph *irg,
- ir_entity_usage_computed_state state);
-
/**
* Assure that the entity usage flags have been computed for the given graph.
*
* This analysis computes the entity usage state for all local variables.
*
/**
* Assure that the entity usage flags have been computed for the given graph.
*
* This analysis computes the entity usage state for all local variables.
*
- * Note that this is a conservative estimation that by no Firm transformation
- * can be invalidated, so it's only recomputed if manually triggered by calling
- * set_irg_entity_usage_state(irg, ir_entity_usage_not_computed).
* Even then the information is not cleaned from the variables, call
* assure_irg_entity_usage_computed() again for recomputation.
*/
* Even then the information is not cleaned from the variables, call
* assure_irg_entity_usage_computed() again for recomputation.
*/
@@
-215,14
+214,14
@@
FIRM_API void set_irp_globals_entity_usage_state(ir_entity_usage_computed_state
FIRM_API void assure_irp_globals_entity_usage_computed(void);
/**
FIRM_API void assure_irp_globals_entity_usage_computed(void);
/**
- *
Get
the memory disambiguator options for a graph.
+ *
Returns
the memory disambiguator options for a graph.
*
* @param irg the graph
*/
FIRM_API unsigned get_irg_memory_disambiguator_options(const ir_graph *irg);
/**
*
* @param irg the graph
*/
FIRM_API unsigned get_irg_memory_disambiguator_options(const ir_graph *irg);
/**
- * Set the memory disambiguator options for a graph.
+ * Set
s
the memory disambiguator options for a graph.
*
* @param irg the graph
* @param options a set of options
*
* @param irg the graph
* @param options a set of options
@@
-231,7
+230,8
@@
FIRM_API void set_irg_memory_disambiguator_options(ir_graph *irg,
unsigned options);
/**
unsigned options);
/**
- * Set the global disambiguator options for all graphs not having local options.
+ * Sets the global disambiguator options for all graphs not having local
+ * options.
*
* @param options a set of options
*/
*
* @param options a set of options
*/
@@
-253,6
+253,8
@@
FIRM_API void mark_private_methods(void);
*/
FIRM_API ir_prog_pass_t *mark_private_methods_pass(const char *name);
*/
FIRM_API ir_prog_pass_t *mark_private_methods_pass(const char *name);
+/** @} */
+
#include "end.h"
#endif
#include "end.h"
#endif