214 lines
5.8 KiB
C
214 lines
5.8 KiB
C
/* EINA - EFL data type library
|
|
* Copyright (C) 2008 Cedric Bail
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library;
|
|
* if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef EINA_COUNTER_H_
|
|
#define EINA_COUNTER_H_
|
|
|
|
#include "eina_types.h"
|
|
|
|
/**
|
|
* @addtogroup Eina_Counter_Group Counter
|
|
*
|
|
* @brief These functions allow you to get the time spent in a part of a code.
|
|
*
|
|
* Before using the counter system, Eina must be initialized with
|
|
* eina_init() and later shut down with eina_shutdown(). The create a
|
|
* counter, use eina_counter_new(). To free it, use
|
|
* eina_counter_free().
|
|
*
|
|
* To time a part of a code, call eina_counter_start() just before it,
|
|
* and eina_counter_stop() just after it. Each time you start to time
|
|
* a code, a clock is added to a list. You can give a number of that
|
|
* clock with the second argument of eina_counter_stop(). To send all
|
|
* the registered clocks to a stream (like stdout, ofr a file), use
|
|
* eina_counter_dump().
|
|
*
|
|
* Here is a straightforward example:
|
|
*
|
|
* @code
|
|
* #include <stdlib.h>
|
|
* #include <stdio.h>
|
|
*
|
|
* #include <eina_counter.h>
|
|
*
|
|
* void test_malloc(void)
|
|
* {
|
|
* int i;
|
|
*
|
|
* for (i = 0; i < 100000; ++i)
|
|
* {
|
|
* void *buf;
|
|
*
|
|
* buf = malloc(100);
|
|
* free(buf);
|
|
* }
|
|
* }
|
|
*
|
|
* int main(void)
|
|
* {
|
|
* Eina_Counter *counter;
|
|
*
|
|
* if (!eina_init())
|
|
* {
|
|
* printf("Error during the initialization of eina\n");
|
|
* return EXIT_FAILURE;
|
|
* }
|
|
*
|
|
* counter = eina_counter_new("malloc");
|
|
*
|
|
* eina_counter_start(counter);
|
|
* test_malloc();
|
|
* eina_counter_stop(counter, 1);
|
|
*
|
|
* char* result = eina_counter_dump(counter);
|
|
* printf("%s", result);
|
|
* free(result);
|
|
*
|
|
* eina_counter_free(counter);
|
|
* eina_shutdown();
|
|
*
|
|
* return EXIT_SUCCESS;
|
|
* }
|
|
* @endcode
|
|
*
|
|
* Compile this code with the following commant:
|
|
*
|
|
* @verbatim
|
|
* gcc -Wall -o test_eina_counter test_eina.c `pkg-config --cflags --libs eina`
|
|
* @endverbatim
|
|
*
|
|
* The result should be something like that:
|
|
*
|
|
* @verbatim
|
|
* \# specimen experiment time starting time ending time
|
|
* 1 9794125 783816 10577941
|
|
* @endverbatim
|
|
*
|
|
* @note The displayed time is in nanosecond.
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup Eina_Tools_Group Tools
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @defgroup Eina_Counter_Group Counter
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @typedef Eina_Counter
|
|
* Counter type.
|
|
*/
|
|
typedef struct _Eina_Counter Eina_Counter;
|
|
|
|
|
|
/**
|
|
* @brief Return a counter.
|
|
*
|
|
* @param name The name of the counter.
|
|
* @return A newly allocated counter.
|
|
*
|
|
* This function returns a new counter. It is characterized by @p
|
|
* name. If @p name is @c NULL, the function returns @c NULL
|
|
* immediately. If memory allocation fails, @c NULL is returned and the
|
|
* error is set to #EINA_ERROR_OUT_OF_MEMORY.
|
|
*
|
|
* Whe the new counter is not needed anymore, use eina_counter_free() to
|
|
* free the allocated memory.
|
|
*/
|
|
EAPI Eina_Counter *eina_counter_new(const char *name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Delete a counter.
|
|
*
|
|
* @param counter The counter to delete.
|
|
*
|
|
* This function remove the clock of @p counter from the used clocks
|
|
* (see eina_counter_start()) and frees the memory allocated for
|
|
* @p counter. If @p counter is @c NULL, the function returns
|
|
* immediately.
|
|
*/
|
|
EAPI void eina_counter_free(Eina_Counter *counter) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Start the time count.
|
|
*
|
|
* @param counter The counter.
|
|
*
|
|
* This function specifies that the part of the code beginning just
|
|
* after its call is being to be timed, using @p counter. If
|
|
* @p counter is @c NULL, this function returns immediately.
|
|
*
|
|
* This function adds the clock associated to @p counter in a list. If
|
|
* the memory needed by that clock can not be allocated, the function
|
|
* returns and the error is set to #EINA_ERROR_OUT_OF_MEMORY.
|
|
*
|
|
* To stop the timing, eina_counter_stop() must be called with the
|
|
* same counter.
|
|
*/
|
|
EAPI void eina_counter_start(Eina_Counter *counter) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Stop the time count.
|
|
*
|
|
* @param counter The counter.
|
|
* @param specimen The number of the test.
|
|
*
|
|
* This function stop the timing that has been started with
|
|
* eina_counter_start(). @p counter must be the same than the one used
|
|
* with eina_counter_start(). @p specimen is the number of the
|
|
* test. If @p counter or its associated clock are @c NULL, or if the
|
|
* time can't be retrieved the function exits.
|
|
*/
|
|
EAPI void eina_counter_stop(Eina_Counter *counter,
|
|
int specimen) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Dump the result of all clocks of a counter to a stream.
|
|
*
|
|
* @return A string with a summary of the test.
|
|
* @param counter The counter.
|
|
*
|
|
* This function returns an malloc'd string containing the dump of
|
|
* all the valid clocks of @p counter.
|
|
* If @p counter @c NULL, the functions exits
|
|
* immediately. Otherwise, the output is formattted like that:
|
|
*
|
|
* @verbatim
|
|
* \# specimen experiment time starting time ending time
|
|
* 1 208 120000 120208
|
|
* @endverbatim
|
|
*
|
|
* The unit of time is the nanosecond.
|
|
*/
|
|
EAPI char *eina_counter_dump(Eina_Counter *counter) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* EINA_COUNTER_H_ */
|