* @brief Memory disambiguator
* @author Michael Beck
* @date 27.12.2006
- * @version $Id$
*/
#ifndef FIRM_ANA_IRMEMORY_H
#define FIRM_ANA_IRMEMORY_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. */
} 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);
/**
const ir_node *adr2, const ir_mode *mode2);
/**
- * Set a source language specific memory disambiguator function.
+ * Sets a source language specific memory disambiguator function.
*
* @param func The callback.
*/
*/
FIRM_API void mem_disambig_init(void);
-/*
+/**
* 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.
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);
/**
- * Set the memory disambiguator options for a graph.
+ * Sets the memory disambiguator options for a graph.
*
* @param irg the graph
* @param options a set of 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
*/
*/
FIRM_API ir_prog_pass_t *mark_private_methods_pass(const char *name);
+/** @} */
+
#include "end.h"
#endif