nsz Git - libfirm/blob - include/libfirm/timing.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    platform neutral timing utilities
  23  */
  24 #ifndef FIRM_TIMING_H
  25 #define FIRM_TIMING_H
  26
  27 #include <stdlib.h>
  28
  29 #include "begin.h"
  30
  31 typedef struct ir_timer_t ir_timer_t;
  32
  33 /**
  34  * Switch to real-time scheduling.
  35  * This shall make measurements more precise.
  36  * @note Does not work for all operating systems.
  37  * @note You could need special user privileges.
  38  * @return 0 on success, else UNIX error code.
  39  */
  40 FIRM_API int ir_timer_enter_high_priority(void);
  41
  42 /**
  43  * Leave the high priority mode.
  44  * @see ir_timer_enter_high_priority()
  45  * @return 0 on success, else UNIX error code.
  46  */
  47 FIRM_API int ir_timer_leave_high_priority(void);
  48
  49 /**
  50  * Get the amount of bytes allocated on the heap.
  51  * @return The number of bytes allocated on the heap.
  52  */
  53 FIRM_API size_t ir_get_heap_used_bytes(void);
  54
  55 /**
  56  * Create a new timer
  57  * @return The timer.
  58  */
  59 FIRM_API ir_timer_t *ir_timer_new(void);
  60
  61 /**
  62  * free memory occupied by a timer
  63  * @param timer The timer
  64  */
  65 FIRM_API void ir_timer_free(ir_timer_t *timer);
  66
  67 /**
  68  * Start a timer.
  69  * @param timer The timer.
  70  */
  71 FIRM_API void ir_timer_start(ir_timer_t *timer);
  72
  73 /**
  74  * Reset a timer and start it.
  75  * @param timer The timer.
  76  */
  77 FIRM_API void ir_timer_reset_and_start(ir_timer_t *timer);
  78
  79 /**
  80  * Reset a timer.
  81  * @param timer The timer.
  82  */
  83 FIRM_API void ir_timer_reset(ir_timer_t *timer);
  84
  85 /**
  86  * Stop a timer.
  87  * Stopping a stopped timer has no effect.
  88  * @param timer The timer.
  89  */
  90 FIRM_API void ir_timer_stop(ir_timer_t *timer);
  91
  92 /**
  93  * Push a timer of the timer stack. This automatically
  94  * stop the previous timer on tos and start the new one.
  95  *
  96  * @param timer   The timer to push on stack.
  97  * @return non-zero on succes, zero if the timer is already on the stack.
  98  */
  99 FIRM_API int ir_timer_push(ir_timer_t *timer);
 100
 101 /**
 102  * Pop the current timer. This automatically stops it and
 103  * start the timer that is now on the stack.
 104  * @return the popped timer
 105  */
 106 FIRM_API ir_timer_t *ir_timer_pop(void);
 107
 108 /**
 109  * Get the number of milliseconds, the timer has elapsed.
 110  * @param timer The timer.
 111  * @return The number of milliseconds the timer is (was) running.
 112  */
 113 FIRM_API unsigned long ir_timer_elapsed_msec(const ir_timer_t *timer);
 114
 115 /**
 116  * Get the number of microseconds, the timer has elapsed.
 117  * @param timer The timer.
 118  * @return The number of milliseconds the timer is (was) running.
 119  */
 120 FIRM_API unsigned long ir_timer_elapsed_usec(const ir_timer_t *timer);
 121
 122 #include "end.h"
 123
 124 #endif