/* -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: t; tab-width: 4 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is Value-Profiling Utility. * * The Initial Developer of the Original Code is * Intel Corporation. * Portions created by the Initial Developer are Copyright (C) 2008 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Mohammad R. Haghighat [mohammad.r.haghighat@intel.com] * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ // // Here are a few examples of using the value-profiling utility: // // _vprof (e); // at the end of program execution, you'll get a dump of the source location of this probe, // its min, max, average, the total sum of all instances of e, and the total number of times this probe was called. // // _vprof (x > 0); // shows how many times and what percentage of the cases x was > 0, // that is the probablitiy that x > 0. // // _vprof (n % 2 == 0); // shows how many times n was an even number // as well as th probablitiy of n being an even number. // // _hprof (n, 4, 1000, 5000, 5001, 10000); // gives you the histogram of n over the given 4 bucket boundaries: // # cases < 1000 // # cases >= 1000 and < 5000 // # cases >= 5000 and < 5001 // # cases >= 5001 and < 10000 // # cases >= 10000 // // _nvprof ("event name", value); // all instances with the same name are merged // so, you can call _vprof with the same event name at difference places // // _vprof (e, myProbe); // value profile e and call myProbe (void* vprofID) at the profiling point. // inside the probe, the client has the predefined variables: // _VAL, _COUNT, _SUM, _MIN, _MAX, and the general purpose registers // _IVAR1, ..., IVAR4 general integer registrs // _I64VAR1, ..., I64VAR4 general integer64 registrs // _DVAR1, ..., _DVAR4 general double registers // _GENPTR a generic pointer that can be used by the client // the number of registers can be changed in vprof.h // #ifndef __VPROF__ #define __VPROF__ // // If the application for which you want to use vprof is threaded, THREADED must be defined as 1, otherwise define it as 0 // // If your application is not threaded, define THREAD_SAFE 0, // otherwise, you have the option of setting THREAD_SAFE to 1 which results in exact counts or to 0 which results in a much more efficient but non-exact counts // #define THREADED 0 #define THREAD_SAFE 0 #ifdef _MSC_VER typedef unsigned char uint8_t; typedef unsigned short uint16_t; typedef signed char int8_t; typedef short int16_t; typedef unsigned int uint32_t; typedef signed int int32_t; typedef __int64 int64_t; typedef unsigned __int64 uint64_t; typedef long long int64_t; typedef unsigned long long uint64_t; #else #include <inttypes.h> #endif // portable align macro #if defined(_MSC_VER) #define vprof_align8(t) __declspec(align(8)) t #elif defined(__GNUC__) #define vprof_align8(t) t __attribute__ ((aligned (8))) #endif #ifdef __cplusplus extern "C" { #endif int profileValue (void** id, char* file, int line, int64_t value, ...); int _profileEntryValue (void* id, int64_t value); int histValue(void** id, char* file, int line, int64_t value, int nbins, ...); int _histEntryValue (void* id, int64_t value); #ifdef __cplusplus } #endif #define DOPROF #ifndef DOPROF #define _vprof(v) #define _hprof(h) #else #define _vprof(v,...) \ { \ static void* id = 0; \ (id != 0) ? \ _profileEntryValue (id, (int64_t) (v)) \ : \ profileValue (&id, __FILE__, __LINE__, (int64_t) (v), ##__VA_ARGS__, NULL) \ ;\ } #define _nvprof(e,v,...) \ { \ static void* id = 0; \ (id != 0) ? \ _profileEntryValue (id, (int64_t) (v)) \ : \ profileValue (&id, (char*) (e), -1, (int64_t) (v), ##__VA_ARGS__, NULL) \ ; \ } #define _hprof(v,n,...) \ { \ static void* id = 0; \ (id != 0) ? \ _histEntryValue (id, (int64_t) (v)) \ : \ histValue (&id, __FILE__, __LINE__, (int64_t) (v), (int) (n), ##__VA_ARGS__) \ ; \ } #define _nhprof(e,v,n,...) \ { \ static void* id = 0; \ (id != 0) ? \ _histEntryValue (id, (int64_t) (v)) \ : \ histValue (&id, (char*) (e), -1, (int64_t) (v), (int) (n), ##__VA_ARGS__) \ ; \ } #endif #define NUM_EVARS 4 typedef enum { LOCK_IS_FREE = 0, LOCK_IS_TAKEN = 1 }; extern #ifdef __cplusplus "C" #endif long _InterlockedCompareExchange ( long volatile * Destination, long Exchange, long Comperand ); typedef struct hist hist; typedef struct hist { int nbins; int64_t* lb; int64_t* count; } *hist_t; typedef struct entry entry; typedef struct entry { long lock; char* file; int line; int64_t value; int64_t count; int64_t sum; int64_t min; int64_t max; void (*func)(void*); hist* h; entry* next; // exposed to the clients void* genptr; int ivar[NUM_EVARS]; vprof_align8(int64_t) i64var[NUM_EVARS]; vprof_align8(double) dvar[NUM_EVARS]; // char pad[128]; // avoid false sharing } *entry_t; #define _VAL ((entry_t)vprofID)->value #define _COUNT ((entry_t)vprofID)->count #define _SUM ((entry_t)vprofID)->sum #define _MIN ((entry_t)vprofID)->min #define _MAX ((entry_t)vprofID)->max #define _GENPTR ((entry_t)vprofID)->genptr #define _IVAR0 ((entry_t)vprofID)->ivar[0] #define _IVAR1 ((entry_t)vprofID)->ivar[1] #define _IVAR2 ((entry_t)vprofID)->ivar[2] #define _IVAR3 ((entry_t)vprofID)->ivar[3] #define _I64VAR0 ((entry_t)vprofID)->i64var[0] #define _I64VAR1 ((entry_t)vprofID)->i64var[1] #define _I64VAR2 ((entry_t)vprofID)->i64var[2] #define _I64VAR3 ((entry_t)vprofID)->i64var[3] #define _DVAR0 ((entry_t)vprofID)->dvar[0] #define _DVAR1 ((entry_t)vprofID)->dvar[1] #define _DVAR2 ((entry_t)vprofID)->dvar[2] #define _DVAR3 ((entry_t)vprofID)->dvar[3] #endif /* __VPROF__ */