1 /*

     2  * LIBOIL - Library of Optimized Inner Loops

     3  * Copyright (c) 2003,2004 David A. Schleef <ds@schleef.org>

     4  * All rights reserved.

     5  *

     6  * Redistribution and use in source and binary forms, with or without

     7  * modification, are permitted provided that the following conditions

     8  * are met:

     9  * 1. Redistributions of source code must retain the above copyright

    10  *    notice, this list of conditions and the following disclaimer.

    11  * 2. Redistributions in binary form must reproduce the above copyright

    12  *    notice, this list of conditions and the following disclaimer in the

    13  *    documentation and/or other materials provided with the distribution.

    14  * 

    15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR

    16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

    17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

    18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,

    19  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

    20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

    21  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

    22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

    23  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING

    24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

    25  * POSSIBILITY OF SUCH DAMAGE.

    26  */

    27 

    28 #ifndef _LIBOIL_PROFILE_H_

    29 #define _LIBOIL_PROFILE_H_

    30 

    31 #include <liboil/liboilutils.h>

    32 

    33 OIL_BEGIN_DECLS

    34 

    35 #ifdef OIL_ENABLE_UNSTABLE_API

    36 

    37 /**

    38  * OIL_PROFILE_HIST_LENGTH

    39  *

    40  * Internal definition of the number of histogram entries in #OilProfile.

    41  */

    42 #define OIL_PROFILE_HIST_LENGTH 10

    43 

    44 typedef struct _OilProfile OilProfile;

    45 /**

    46  * OilProfile:

    47  *

    48  * An opaque structure representing profiling information.

    49  */

    50 struct _OilProfile {

    51   /*< private >*/

    52   unsigned long start;

    53   unsigned long stop;

    54   unsigned long min;

    55   unsigned long last;

    56   unsigned long total;

    57   int n;

    58 

    59   int hist_n;

    60   unsigned long hist_time[OIL_PROFILE_HIST_LENGTH];

    61   int hist_count[OIL_PROFILE_HIST_LENGTH];

    62 };

    63 

    64 IMPORT_C unsigned long oil_profile_stamp(void);

    65 IMPORT_C void oil_profile_init(OilProfile *prof);

    66 IMPORT_C void oil_profile_stop_handle(OilProfile *prof);

    67 IMPORT_C void oil_profile_get_ave_std (OilProfile *prof, double *ave_p, double *std_p);

    68 

    69 /**

    70  * oil_profile_start:

    71  * @x: a pointer to an OilProfile structure

    72  *

    73  * Starts a profiling run by obtaining a timestamp via oil_profile_stamp()

    74  * and writing it into @x.

    75  */

    76 #define oil_profile_start(x) do{ \

    77 	(x)->start = oil_profile_stamp(); \

    78 }while(0)

    79 /**

    80  * oil_profile_stop:

    81  * @x: a pointer to an OilProfile structure

    82  *

    83  * Stops a profiling run by obtaining a timestamp via oil_profile_stamp()

    84  * and writing it into @x.  It then calls oil_profile_stop_handle() to

    85  * handle post-processing of the profiling run.

    86  */

    87 #define oil_profile_stop(x) do{ \

    88 	(x)->stop = oil_profile_stamp(); \

    89         oil_profile_stop_handle(x); \

    90 }while(0)

    91 

    92 #endif

    93 

    94 OIL_END_DECLS

    95 

    96 

    97 #endif

    98