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