added new licence header
[libfirm] / ir / be / beprofile.h
index f72014d..adcfc24 100644 (file)
@@ -1,3 +1,22 @@
+/*
+ * 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.
+ */
+
 /** vim: set sw=4 ts=4:
  * @file   beprofile.h
  * @date   2006-04-06
 #ifndef _BEPROFILE_H_
 #define _BEPROFILE_H_
 
+/** Additional flags for profiling */
+enum profile_flags {
+       profile_with_locations = 0x0001,   /**< create location table */
+       profile_default        = 0         /**< default settings */
+};
+
 /**
- * Instruments irgs with profile code.
+ * Instruments irgs with profile code
+ *
+ * @param filename  The name of the output file for the profile information
+ * @param flags     Additional flags
+ *
  * @return The irg doing the profile initialization.
  */
-ir_graph *be_profile_instrument(void);
+ir_graph *be_profile_instrument(const char *filename, unsigned flags);
+
+/**
+ * Reads the corresponding profile info file if it exists and returns a
+ * profile info struct
+ * @param filename The name of the file containing profile information
+ */
+void be_profile_read(const char *filename);
 
-void be_profile_read(void);
+/**
+ * Frees the profile info
+ */
+void be_profile_free(void);
+
+/**
+ * Get block execution count as determined be profiling
+ */
+unsigned int be_profile_get_block_execcount(const ir_node * block);
+
+/**
+ * Initializes exec_freq structure for an irg based on profile data
+ */
+ir_exec_freq *be_create_execfreqs_from_profile(ir_graph *irg);
+
+/**
+ * Tells whether profile module has acquired data
+ */
+int be_profile_has_data(void);
 
 #endif /* _BEPROFILE_H_ */