osfmk/profiling/i386/profile-md.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * HISTORY
  33  *
  34  * Revision 1.1.1.1  1998/09/22 21:05:49  wsanchez
  35  * Import of Mac OS X kernel (~semeria)
  36  *
  37  * Revision 1.1.1.1  1998/03/07 02:26:08  wsanchez
  38  * Import of OSF Mach kernel (~mburg)
  39  *
  40  * Revision 1.1.5.2  1996/07/31  09:57:36  paire
  41  *      Added some more constraints to __asm__ functions for compilation
  42  *      under gcc2.7.1 for PROF_CNT_[L]{ADD|SUB} macros
  43  *      [96/06/14            paire]
  44  *
  45  * Revision 1.1.5.1  1995/01/06  19:53:52  devrcs
  46  *      mk6 CR668 - 1.3b26 merge
  47  *      new file for mk6
  48  *      [1994/10/12  22:25:27  dwm]
  49  *
  50  * Revision 1.1.2.2  1994/05/16  19:19:26  meissner
  51  *      Add {,L}PROF_CNT_{SUB,LSUB,OVERFLOW} macros for gprof command.
  52  *      [1994/05/10  10:36:06  meissner]
  53  *
  54  *      Correct 64-bit integer asms to specify result values as inputs, and use =g instead of =m.
  55  *      Cast the integer argument to PROF_CNT_ADD to unsigned long, so a short register is widened.
  56  *      Add more support for writing the gprof command.
  57  *      PROF_CNT_{EQ,NE} should not use ^=, it just uses ^.
  58  *      Round PROF_CNT_DIGITS up to 24 bytes so it is word aligned.
  59  *      _profile_cnt_to_decimal now takes the low/high values as separate arguments.
  60  *      Delete _profile_cnt_to_hex.
  61  *      [1994/04/28  21:45:07  meissner]
  62  *
  63  *      Add more 64 bit arithmetic macros to support writing gprof.
  64  *      [1994/04/20  15:47:05  meissner]
  65  *
  66  * Revision 1.1.2.1  1994/04/08  17:51:56  meissner
  67  *      Correct spelling on LPROF_CNT_TO_LDOUBLE macro.
  68  *      [1994/04/08  16:18:06  meissner]
  69  *
  70  *      Make LHISTCOUNTER be 64 bits.
  71  *      Define LPROF_CNT_INC to increment LHISTCOUNTER.
  72  *      [1994/04/08  12:40:32  meissner]
  73  *
  74  *      Make most stats 64 bits, except for things like memory allocation.
  75  *      [1994/04/02  14:58:34  meissner]
  76  *
  77  *      Add overflow support for {gprof,prof,old,dummy}_mcount counters.
  78  *      [1994/03/17  20:13:37  meissner]
  79  *
  80  *      Add gprof/prof overflow support
  81  *      [1994/03/17  14:56:56  meissner]
  82  *
  83  *      Define LHISTCOUNTER.
  84  *      [1994/02/28  12:05:16  meissner]
  85  *
  86  *      Set HISTFRACTION to 4, so new lprofil call takes the same space.
  87  *      [1994/02/24  16:15:34  meissner]
  88  *
  89  *      Add too_low/too_high to profile_stats.
  90  *      [1994/02/16  22:38:23  meissner]
  91  *
  92  *      Make prof_cnt_t unsigned long.
  93  *      [1994/02/11  16:52:09  meissner]
  94  *
  95  *      Remember function unique ptr in gfuncs structure to reset profiling.
  96  *      Add support for range checking gprof arc {from,self}pc addresses.
  97  *      Add counter for # times acontext was locked.
  98  *      Expand copyright.
  99  *      [1994/02/07  12:41:08  meissner]
 100  *
 101  *      Keep track of the number of times the kernel overflows the HISTCOUNTER counter.
 102  *      [1994/02/03  20:13:31  meissner]
 103  *
 104  *      Add stats for {user,kernel,idle} mode in the kernel.
 105  *      [1994/02/03  15:17:36  meissner]
 106  *
 107  *      No change.
 108  *      [1994/02/03  00:58:59  meissner]
 109  *
 110  *      Combine _profile_{vars,stats,md}; Allow more than one _profile_vars.
 111  *      [1994/02/01  12:04:04  meissner]
 112  *
 113  *      Split # records to # gprof and # prof records.
 114  *      Add my_cpu/max_cpu fields.
 115  *      [1994/01/28  23:33:30  meissner]
 116  *
 117  *      Eliminate hash_{size,mask} from gfuncs structure.
 118  *      [1994/01/26  20:23:41  meissner]
 119  *
 120  *      Add structure size fields to _profile_{vars,stats,md}.
 121  *      Add major/minor version number to _profile_md.
 122  *      Move allocation context block pointer to main structure.
 123  *      Delete shift count for allocation contexts.
 124  *      [1994/01/25  01:46:08  meissner]
 125  *
 126  *      Add HASHFRACTION
 127  *      [1994/01/22  01:14:02  meissner]
 128  *
 129  *      Split profile-md.h into profile-internal.h and profile-md.
 130  *      [1994/01/20  20:57:18  meissner]
 131  *
 132  *      Fixup copyright.
 133  *      [1994/01/18  23:08:14  meissner]
 134  *
 135  *      Make flags byte-sized.
 136  *      Add have_bb flag.
 137  *      Add init_format flag.
 138  *      [1994/01/18  21:57:18  meissner]
 139  *
 140  *      CR 10198 - Initial version.
 141  *      [1994/01/18  19:44:59  meissner]
 142  *
 143  * $EndLog$
 144  */
 145
 146 #ifndef _PROFILE_MD_H
 147 #define _PROFILE_MD_H
 148
 149 #include <types.h>
 150
 151 /*
 152  * Define the interfaces between the assembly language profiling support
 153  * that is common between the kernel, mach servers, and user space library.
 154  */
 155
 156 /*
 157  * Integer types used.
 158  */
 159
 160 typedef long            prof_ptrint_t;  /* hold either pointer or signed int */
 161 typedef unsigned long   prof_uptrint_t; /* hold either pointer or unsigned int */
 162 typedef long            prof_lock_t;    /* lock word type */
 163 typedef unsigned char   prof_flag_t;    /* type for boolean flags */
 164
 165 /*
 166  * Double precision counter.
 167  */
 168
 169 typedef struct prof_cnt_t {
 170         prof_uptrint_t  low;            /* low 32 bits of counter */
 171         prof_uptrint_t  high;           /* high 32 bits of counter */
 172 } prof_cnt_t;
 173
 174 #if defined(__GNUC__) && !defined(lint)
 175 #define PROF_CNT_INC(cnt)                                       \
 176         __asm__("addl $1,%0; adcl $0,%1"                        \
 177                 : "=g" ((cnt).low), "=g" ((cnt).high)           \
 178                 : "0" ((cnt).low), "1" ((cnt).high))
 179
 180 #define PROF_CNT_ADD(cnt,val)                                   \
 181         __asm__("addl %2,%0; adcl $0,%1"                        \
 182                 : "=g,r" ((cnt).low), "=g,r" ((cnt).high)       \
 183                 : "r,g" ((unsigned long)(val)),                 \
 184                 "0,0" ((cnt).low), "1,1" ((cnt).high))
 185
 186 #define PROF_CNT_LADD(cnt,val)                                  \
 187         __asm__("addl %2,%0; adcl %3,%1"                        \
 188                 : "=g,r" ((cnt).low), "=g,r" ((cnt).high)       \
 189                 : "r,g" ((val).low), "r,g" ((val).high),        \
 190                 "0,0" ((cnt).low), "1,1" ((cnt).high))
 191
 192 #define PROF_CNT_SUB(cnt,val)                                   \
 193         __asm__("subl %2,%0; sbbl $0,%1"                        \
 194                 : "=g,r" ((cnt).low), "=g,r" ((cnt).high)       \
 195                 : "r,g" ((unsigned long)(val)),                 \
 196                 "0,0" ((cnt).low), "1,1" ((cnt).high))
 197
 198 #define PROF_CNT_LSUB(cnt,val)                                  \
 199         __asm__("subl %2,%0; sbbl %3,%1"                        \
 200                 : "=g,r" ((cnt).low), "=g,r" ((cnt).high)       \
 201                 : "r,g" ((val).low), "r,g" ((val).high),        \
 202                 "0,0" ((cnt).low), "1,1" ((cnt).high))
 203
 204 #else
 205 #define PROF_CNT_INC(cnt)       ((++((cnt).low) == 0) ? ++((cnt).high) : 0)
 206 #define PROF_CNT_ADD(cnt,val)   (((((cnt).low + (val)) < (val)) ? ((cnt).high++) : 0), ((cnt).low += (val)))
 207 #define PROF_CNT_LADD(cnt,val)  (PROF_CNT_ADD(cnt,(val).low), (cnt).high += (val).high)
 208 #define PROF_CNT_SUB(cnt,val)   (((((cnt).low - (val)) > (cnt).low) ? ((cnt).high--) : 0), ((cnt).low -= (val)))
 209 #define PROF_CNT_LSUB(cnt,val)  (PROF_CNT_SUB(cnt,(val).low), (cnt).high -= (val).high)
 210 #endif
 211
 212 #define PROF_ULONG_TO_CNT(cnt,val)      (((cnt).high = 0), ((cnt).low = val))
 213 #define PROF_CNT_OVERFLOW(cnt,high,low) (((high) = (cnt).high), ((low) = (cnt).low))
 214 #define PROF_CNT_TO_ULONG(cnt)          (((cnt).high == 0) ? (cnt).low : 0xffffffffu)
 215 #define PROF_CNT_TO_LDOUBLE(cnt)        ((((long double)(cnt).high) * 4294967296.0L) + (long double)(cnt).low)
 216 #define PROF_CNT_TO_DECIMAL(buf,cnt)    _profile_cnt_to_decimal(buf, (cnt).low, (cnt).high)
 217 #define PROF_CNT_EQ_0(cnt)              (((cnt).high | (cnt).low) == 0)
 218 #define PROF_CNT_NE_0(cnt)              (((cnt).high | (cnt).low) != 0)
 219 #define PROF_CNT_EQ(cnt1,cnt2)          ((((cnt1).high ^ (cnt2).high) | ((cnt1).low ^ (cnt2).low)) == 0)
 220 #define PROF_CNT_NE(cnt1,cnt2)          ((((cnt1).high ^ (cnt2).high) | ((cnt1).low ^ (cnt2).low)) != 0)
 221 #define PROF_CNT_GT(cnt1,cnt2)          (((cnt1).high > (cnt2).high) || ((cnt1).low > (cnt2).low))
 222 #define PROF_CNT_LT(cnt1,cnt2)          (((cnt1).high < (cnt2).high) || ((cnt1).low < (cnt2).low))
 223
 224 /* max # digits + null to hold prof_cnt_t values (round up to multiple of 4) */
 225 #define PROF_CNT_DIGITS                 24
 226
 227 /*
 228  * Types of the profil counter.
 229  */
 230
 231 typedef unsigned short  HISTCOUNTER;            /* profil */
 232 typedef prof_cnt_t      LHISTCOUNTER;           /* lprofil */
 233
 234 #define LPROF_ULONG_TO_CNT(cnt,val)     PROF_ULONG_TO_CNT(cnt,val)
 235 #define LPROF_CNT_INC(lp)               PROF_CNT_INC(lp)
 236 #define LPROF_CNT_ADD(lp,val)           PROF_CNT_ADD(lp,val)
 237 #define LPROF_CNT_LADD(lp,val)          PROF_CNT_LADD(lp,val)
 238 #define LPROF_CNT_SUB(lp,val)           PROF_CNT_SUB(lp,val)
 239 #define LPROF_CNT_LSUB(lp,val)          PROF_CNT_LSUB(lp,val)
 240 #define LPROF_CNT_OVERFLOW(lp,high,low) PROF_CNT_OVERFLOW(lp,high,low)
 241 #define LPROF_CNT_TO_ULONG(lp)          PROF_CNT_TO_ULONG(lp)
 242 #define LPROF_CNT_TO_LDOUBLE(lp)        PROF_CNT_TO_LDOUBLE(lp)
 243 #define LPROF_CNT_TO_DECIMAL(buf,cnt)   PROF_CNT_TO_DECIMAL(buf,cnt)
 244 #define LPROF_CNT_EQ_0(cnt)             PROF_CNT_EQ_0(cnt)
 245 #define LPROF_CNT_NE_0(cnt)             PROF_CNT_NE_0(cnt)
 246 #define LPROF_CNT_EQ(cnt1,cnt2)         PROF_CNT_EQ(cnt1,cnt2)
 247 #define LPROF_CNT_NE(cnt1,cnt2)         PROF_CNT_NE(cnt1,cnt2)
 248 #define LPROF_CNT_GT(cnt1,cnt2)         PROF_CNT_GT(cnt1,cnt2)
 249 #define LPROF_CNT_LT(cnt1,cnt2)         PROF_CNT_LT(cnt1,cnt2)
 250 #define LPROF_CNT_DIGITS                PROF_CNT_DIGITS
 251
 252 /*
 253  *  fraction of text space to allocate for histogram counters
 254  */
 255
 256 #define HISTFRACTION    4
 257
 258 /*
 259  * Fraction of text space to allocate for from hash buckets.
 260  */
 261
 262 #define HASHFRACTION    HISTFRACTION
 263
 264 /*
 265  * Prof call count, external format.
 266  */
 267
 268 struct prof_ext {
 269         prof_uptrint_t  cvalue;         /* caller address */
 270         prof_uptrint_t  cncall;         /* # of calls */
 271 };
 272
 273 /*
 274  * Prof call count, internal format.
 275  */
 276
 277 struct prof_int {
 278         struct prof_ext prof;           /* external prof struct */
 279         prof_uptrint_t  overflow;       /* # times prof counter overflowed */
 280 };
 281
 282 /*
 283  * Gprof arc, external format.
 284  */
 285
 286 struct gprof_arc {
 287         prof_uptrint_t   frompc;        /* caller's caller */
 288         prof_uptrint_t   selfpc;        /* caller's address */
 289         prof_uptrint_t   count;         /* # times arc traversed */
 290 };
 291
 292 /*
 293  * Gprof arc, internal format.
 294  */
 295
 296 struct hasharc {
 297         struct hasharc  *next;          /* next gprof record */
 298         struct gprof_arc arc;           /* gprof record */
 299         prof_uptrint_t   overflow;      /* # times counter overflowed */
 300 };
 301
 302 /*
 303  * Linked list of all function profile blocks.
 304  */
 305
 306 #define MAX_CACHE       3               /* # cache table entries */
 307
 308 struct gfuncs {
 309         struct hasharc **hash_ptr;              /* gprof hash table */
 310         struct hasharc **unique_ptr;            /* function unique pointer */
 311         struct prof_int prof;                   /* -p stats for elf */
 312         struct hasharc *cache_ptr[MAX_CACHE];   /* cache element pointers */
 313 };
 314
 315 /*
 316  * Profile information which might be written out in ELF {,g}mon.out files.
 317  */
 318
 319 #define MAX_BUCKETS 9                   /* max bucket chain to print out */
 320
 321 struct profile_stats {                  /* Debugging counters */
 322         prof_uptrint_t major_version;   /* major version number */
 323         prof_uptrint_t minor_version;   /* minor version number */
 324         prof_uptrint_t stats_size;      /* size of profile_vars structure */
 325         prof_uptrint_t profil_buckets;  /* # profil buckets */
 326         prof_uptrint_t my_cpu;          /* identify current cpu/thread */
 327         prof_uptrint_t max_cpu;         /* identify max cpu/thread */
 328         prof_uptrint_t prof_records;    /* # of functions profiled */
 329         prof_uptrint_t gprof_records;   /* # of gprof arcs */
 330         prof_uptrint_t hash_buckets;    /* # gprof hash buckets */
 331         prof_uptrint_t bogus_count;     /* # of bogus functions found in gprof */
 332
 333         prof_cnt_t cnt;                 /* # of calls to _{,g}prof_mcount */
 334         prof_cnt_t dummy;               /* # of calls to _dummy_mcount */
 335         prof_cnt_t old_mcount;          /* # of calls to old mcount */
 336         prof_cnt_t hash_search;         /* # hash buckets searched */
 337         prof_cnt_t hash_num;            /* # times hash table searched */
 338         prof_cnt_t user_ticks;          /* # ticks in user space */
 339         prof_cnt_t kernel_ticks;        /* # ticks in kernel space */
 340         prof_cnt_t idle_ticks;          /* # ticks in idle mode */
 341         prof_cnt_t overflow_ticks;      /* # ticks where HISTCOUNTER overflowed */
 342         prof_cnt_t acontext_locked;     /* # times an acontext was locked */
 343         prof_cnt_t too_low;             /* # times a histogram tick was too low */
 344         prof_cnt_t too_high;            /* # times a histogram tick was too high */
 345         prof_cnt_t prof_overflow;       /* # times a prof count field overflowed */
 346         prof_cnt_t gprof_overflow;      /* # times a gprof count field overflowed */
 347
 348                                         /* allocation statistics */
 349         prof_uptrint_t num_alloc  [(int)ACONTEXT_MAX];  /* # allocations */
 350         prof_uptrint_t bytes_alloc[(int)ACONTEXT_MAX];  /* bytes allocated */
 351         prof_uptrint_t num_context[(int)ACONTEXT_MAX];  /* # contexts */
 352         prof_uptrint_t wasted     [(int)ACONTEXT_MAX];  /* wasted bytes */
 353         prof_uptrint_t overhead   [(int)ACONTEXT_MAX];  /* overhead bytes */
 354
 355         prof_uptrint_t buckets[MAX_BUCKETS+1]; /* # hash indexes that have n buckets */
 356         prof_cnt_t     cache_hits[MAX_CACHE];  /* # times nth cache entry matched */
 357
 358         prof_cnt_t stats_unused[64];    /* reserved for future use */
 359 };
 360
 361 #define PROFILE_MAJOR_VERSION 1
 362 #define PROFILE_MINOR_VERSION 1
 363
 364 /*
 365  * Machine dependent fields.
 366  */
 367
 368 struct profile_md {
 369         int major_version;              /* major version number */
 370         int minor_version;              /* minor version number */
 371         size_t md_size;                 /* size of profile_md structure */
 372         struct hasharc **hash_ptr;      /* gprof hash table */
 373         size_t hash_size;               /* size of hash table */
 374         prof_uptrint_t num_cache;       /* # of cache entries */
 375         void (*save_mcount_ptr)(void);  /* save for _mcount_ptr */
 376         void (**mcount_ptr_ptr)(void);  /* pointer to _mcount_ptr */
 377         struct hasharc *dummy_ptr;      /* pointer to dummy gprof record */
 378         void *(*alloc_pages)(size_t);   /* pointer to _profile_alloc_pages */
 379         char num_buffer[PROF_CNT_DIGITS]; /* convert 64 bit ints to string */
 380         long md_unused[58];             /* add unused fields */
 381 };
 382
 383 /*
 384  * Record information about each function call.  Specify
 385  * caller, caller's caller, and a unique label for use by
 386  * the profiling routines.
 387  */
 388 extern void _prof_mcount(void);
 389 extern void _gprof_mcount(void);
 390 extern void _dummy_mcount(void);
 391 extern void (*_mcount_ptr)(void);
 392
 393 /*
 394  * Function in profile-md.c to convert prof_cnt_t to string format (decimal & hex).
 395  */
 396 extern char *_profile_cnt_to_decimal(char *, prof_uptrint_t, prof_uptrint_t);
 397
 398 #endif /* _PROFILE_MD_H */