2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief platform neutral timing utilities
34 * A timer can be started/stopped multiple times and measures the (wallclock)
35 * time spent between start and stop calls.
37 typedef struct ir_timer_t ir_timer_t;
40 * Switch to real-time scheduling.
41 * This shall make measurements more precise.
42 * @note Does not work for all operating systems.
43 * @note You could need special user privileges.
44 * @return 0 on success, else UNIX error code.
46 FIRM_API int ir_timer_enter_high_priority(void);
49 * Leave the high priority mode.
50 * @see ir_timer_enter_high_priority()
51 * @return 0 on success, else UNIX error code.
53 FIRM_API int ir_timer_leave_high_priority(void);
56 * Returns the amount of bytes allocated on the heap.
57 * @return The number of bytes allocated on the heap.
59 FIRM_API size_t ir_get_heap_used_bytes(void);
66 FIRM_API ir_timer_t *ir_timer_new(void);
69 * free memory occupied by a timer
70 * @param timer The timer
72 FIRM_API void ir_timer_free(ir_timer_t *timer);
76 * @param timer The timer.
78 FIRM_API void ir_timer_start(ir_timer_t *timer);
81 * Reset a timer and start it.
82 * @param timer The timer.
84 FIRM_API void ir_timer_reset_and_start(ir_timer_t *timer);
88 * @param timer The timer.
90 FIRM_API void ir_timer_reset(ir_timer_t *timer);
94 * Stopping a stopped timer has no effect.
95 * @param timer The timer.
97 FIRM_API void ir_timer_stop(ir_timer_t *timer);
100 * Push a timer of the timer stack. This automatically
101 * stop the previous timer on tos and start the new one.
103 * @param timer The timer to push on stack.
104 * @return non-zero on succes, zero if the timer is already on the stack.
106 FIRM_API int ir_timer_push(ir_timer_t *timer);
109 * Pop the current timer. This automatically stops it and
110 * start the timer that is now on the stack.
111 * @return the popped timer
113 FIRM_API ir_timer_t *ir_timer_pop(void);
116 * Returns the number of milliseconds, the timer has elapsed.
117 * @param timer The timer.
118 * @return The number of milliseconds the timer is (was) running.
120 FIRM_API unsigned long ir_timer_elapsed_msec(const ir_timer_t *timer);
123 * Returns the number of microseconds, the timer has elapsed.
124 * @param timer The timer.
125 * @return The number of milliseconds the timer is (was) running.
127 FIRM_API unsigned long ir_timer_elapsed_usec(const ir_timer_t *timer);