sl@0: /*
sl@0:  * LIBOIL - Library of Optimized Inner Loops
sl@0:  * Copyright (c) 2003,2004 David A. Schleef <ds@schleef.org>
sl@0:  * All rights reserved.
sl@0:  *
sl@0:  * Redistribution and use in source and binary forms, with or without
sl@0:  * modification, are permitted provided that the following conditions
sl@0:  * are met:
sl@0:  * 1. Redistributions of source code must retain the above copyright
sl@0:  *    notice, this list of conditions and the following disclaimer.
sl@0:  * 2. Redistributions in binary form must reproduce the above copyright
sl@0:  *    notice, this list of conditions and the following disclaimer in the
sl@0:  *    documentation and/or other materials provided with the distribution.
sl@0:  * 
sl@0:  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
sl@0:  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
sl@0:  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
sl@0:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
sl@0:  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
sl@0:  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
sl@0:  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
sl@0:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
sl@0:  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
sl@0:  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
sl@0:  * POSSIBILITY OF SUCH DAMAGE.
sl@0:  */
sl@0: 
sl@0: #ifndef _LIBOIL_PROFILE_H_
sl@0: #define _LIBOIL_PROFILE_H_
sl@0: 
sl@0: #include <liboil/liboilutils.h>
sl@0: 
sl@0: OIL_BEGIN_DECLS
sl@0: 
sl@0: #ifdef OIL_ENABLE_UNSTABLE_API
sl@0: 
sl@0: /**
sl@0:  * OIL_PROFILE_HIST_LENGTH
sl@0:  *
sl@0:  * Internal definition of the number of histogram entries in #OilProfile.
sl@0:  */
sl@0: #define OIL_PROFILE_HIST_LENGTH 10
sl@0: 
sl@0: typedef struct _OilProfile OilProfile;
sl@0: /**
sl@0:  * OilProfile:
sl@0:  *
sl@0:  * An opaque structure representing profiling information.
sl@0:  */
sl@0: struct _OilProfile {
sl@0:   /*< private >*/
sl@0:   unsigned long start;
sl@0:   unsigned long stop;
sl@0:   unsigned long min;
sl@0:   unsigned long last;
sl@0:   unsigned long total;
sl@0:   int n;
sl@0: 
sl@0:   int hist_n;
sl@0:   unsigned long hist_time[OIL_PROFILE_HIST_LENGTH];
sl@0:   int hist_count[OIL_PROFILE_HIST_LENGTH];
sl@0: };
sl@0: 
sl@0: IMPORT_C unsigned long oil_profile_stamp(void);
sl@0: IMPORT_C void oil_profile_init(OilProfile *prof);
sl@0: IMPORT_C void oil_profile_stop_handle(OilProfile *prof);
sl@0: IMPORT_C void oil_profile_get_ave_std (OilProfile *prof, double *ave_p, double *std_p);
sl@0: 
sl@0: /**
sl@0:  * oil_profile_start:
sl@0:  * @x: a pointer to an OilProfile structure
sl@0:  *
sl@0:  * Starts a profiling run by obtaining a timestamp via oil_profile_stamp()
sl@0:  * and writing it into @x.
sl@0:  */
sl@0: #define oil_profile_start(x) do{ \
sl@0: 	(x)->start = oil_profile_stamp(); \
sl@0: }while(0)
sl@0: /**
sl@0:  * oil_profile_stop:
sl@0:  * @x: a pointer to an OilProfile structure
sl@0:  *
sl@0:  * Stops a profiling run by obtaining a timestamp via oil_profile_stamp()
sl@0:  * and writing it into @x.  It then calls oil_profile_stop_handle() to
sl@0:  * handle post-processing of the profiling run.
sl@0:  */
sl@0: #define oil_profile_stop(x) do{ \
sl@0: 	(x)->stop = oil_profile_stamp(); \
sl@0:         oil_profile_stop_handle(x); \
sl@0: }while(0)
sl@0: 
sl@0: #endif
sl@0: 
sl@0: OIL_END_DECLS
sl@0: 
sl@0: 
sl@0: #endif
sl@0: