gt.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2009, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 */
/*
 *  ======== gt.h ========
 */

/*  Note        There are two definitions that affect which portions of trace
 *              are actually compiled into the client: @c GT_TRACE and
 *              @c GT_ASSERT. If @c GT_TRACE is set to 0 then all trace
 *              statements (except for assertions) will be compiled
 *              out of the client. If @c GT_ASSERT is set to 0 then
 *              assertions will be compiled out of the
 *              client.  @c GT_ASSERT can not be set to 0 unless @c GT_TRACE
 *              is also set to 0 (i.e. @c GT_TRACE == 1 implies @c GT_ASSERT
 *              == 1).
 */

#ifndef ti_sdo_utils_trace_GT_
#define ti_sdo_utils_trace_GT_

#ifdef __cplusplus
extern "C" {
#endif


#ifndef GT_TRACE
#define GT_TRACE 1  /* 0 = "trace compiled out"; 1 = "trace active" */
#endif

#if !defined(GT_ASSERT) || GT_TRACE
#define GT_ASSERT 1
#endif

typedef Void   (*GT_PrintFxn)(String fmt, ...);
typedef Ptr    (*GT_MallocFxn)(Int size);
typedef Void   (*GT_FreeFxn)(Ptr addr, Int size);
typedef UInt32 (*GT_TimeFxn)(Void);

typedef struct {
    GT_PrintFxn  PRINTFXN;
    Fxn          PIDFXN;
    Fxn          TIDFXN;
    GT_PrintFxn  ERRORFXN;
    GT_MallocFxn MALLOCFXN;
    GT_FreeFxn   FREEFXN;
    GT_TimeFxn   TIMEFXN;
    Fxn          LOCKFXN;
    Fxn          UNLOCKFXN;
    Fxn          INITFXN;
} GT_Config;

#if (GT_TRACE != 0) || (GT_ASSERT !=0 ) 
extern __FAR__ GT_Config *GT;
#endif 

typedef struct {
    String      modName;    
    UInt8      *flags;      
} GT_Mask;


/*
 *  New GT Class definitions.
 *
 * [dm]TODO:H new proposal for how we should use different tracing classes: {
 *
 * - GT_ENTER (class 0): On entry to *and exit from* functions: consider
 *                       in general this class to be of interest to users
 *
 * - GT_1CLASS : debugging info of interest to module developer only
 *
 * - GT_2CLASS : info for developer that *might* be of interest to users
 *
 * - GT_3CLASS : open (module developer can creatively use this one)
 *
 * - GT_4CLASS : info for developer that's likely to be important to the users
 *
 * - GT_5CLASS : benchmarking
 *
 * - GT_6CLASS : warnings
 *
 * - GT_7CLASS : errors
 *
 * }
 */

#define GT_ENTER        ((UInt8)0x01)

#define GT_1CLASS       ((UInt8)0x02)   
#define GT_2CLASS       ((UInt8)0x04)   
#define GT_3CLASS       ((UInt8)0x08)   
#define GT_4CLASS       ((UInt8)0x10)   
#define GT_5CLASS       ((UInt8)0x20)

#define GT_6CLASS       ((UInt8)0x40)

#define GT_7CLASS       ((UInt8)0x80)

/*
 *  ======== _GT_create ========
 */
extern Void _GT_create(GT_Mask *mask, String modName);


extern UInt32 GT_curTime(Void);

#define GT_exit()

/*
 *  ======== GT_init ========
 */
extern Void GT_init(Void);


/*
 *  ======== _GT_set ========
 */
extern Void _GT_set(String str);


/*
 *  ======== _GT_trace ========
 */
extern Int _GT_trace(GT_Mask *mask, Int classId, String format, ...);

extern Void GT_disable(Void);
extern Void GT_enable(Void);
extern Bool GT_getModNameFlags(String modName, UInt8 *flags);

#if GT_ASSERT == 0

#define GT_assert( mask, expr )
#define GT_config( config )
#define GT_configInit( config )
#define GT_seterror( fxn )

#else

extern GT_Config _ti_sdo_utils_trace_GT_params;

#define GT_assert( mask, expr ) \
        (!(expr) ? \
            (*GT->ERRORFXN)("assertion violation: %s, line %d\n", \
                            __FILE__, __LINE__), NULL : NULL)

#define GT_config(config)     (_ti_sdo_utils_trace_GT_params = *(config))
#define GT_configInit(config) (*(config) = _ti_sdo_utils_trace_GT_params)
#define GT_seterror(fxn) (_ti_sdo_utils_trace_GT_params.ERRORFXN = (Fxn)(fxn))

#endif

#if GT_TRACE == 0

#define GT_curLine()                ((MdUns)__LINE__)
#define GT_curTime()                ((UInt32)0)
#define GT_create(mask, modName)
#define GT_exit()
#define GT_init()
#define GT_set(str)
#define GT_setprintf( fxn )

#define GT_query( mask, classId )     FALSE

#define GT_0trace( mask, classId, format )
#define GT_1trace( mask, classId, format, arg1 )
#define GT_2trace( mask, classId, format, arg1, arg2 )
#define GT_3trace( mask, classId, format, arg1, arg2, arg3 )
#define GT_4trace( mask, classId, format, arg1, arg2, arg3, arg4 )
#define GT_5trace( mask, classId, format, arg1, arg2, arg3, arg4, arg5 )
#define GT_6trace( mask, classId, format, arg1, arg2, arg3, arg4, arg5, arg6 )

#else   /* GT_TRACE == 1 */

extern String GT_format;

#define GT_curLine()      ((MdUns)__LINE__)
#define GT_setprintf(fxn) (_ti_sdo_utils_trace_GT_params.PRINTFXN = (fxn))

#define GT_query(mask, classId) ((*(mask).flags & (classId)))

#define GT_create(mask, modName)    _GT_create((mask), (modName))

#define GT_set(str)                 _GT_set(str)

#define GT_0trace( mask, classId, format ) \
    ((*(mask).flags & (classId)) ? \
    _GT_trace(&(mask), (classId), (format)) : 0)

#define GT_1trace( mask, classId, format, arg1 ) \
    ((*(mask).flags & (classId)) ? \
    _GT_trace(&(mask), (classId), (format), (arg1)) : 0)

#define GT_2trace( mask, classId, format, arg1, arg2 ) \
    ((*(mask).flags & (classId)) ? \
    _GT_trace(&(mask), (classId), (format), (arg1), (arg2)) : 0)

#define GT_3trace( mask, classId, format, arg1, arg2, arg3 ) \
    ((*(mask).flags & (classId)) ? \
    _GT_trace(&(mask), (classId), (format), (arg1), (arg2), (arg3)) : 0)

#define GT_4trace( mask, classId, format, arg1, arg2, arg3, arg4 ) \
    ((*(mask).flags & (classId)) ? \
    _GT_trace(&(mask), (classId), (format), (arg1), (arg2), (arg3), (arg4)) : 0)

#define GT_5trace( mask, classId, format, arg1, arg2, arg3, arg4, arg5 ) \
    ((*(mask).flags & (classId)) ? \
    _GT_trace(&(mask), (classId), (format), (arg1), (arg2), (arg3), (arg4), (arg5)) : 0)

#define GT_6trace( mask, classId, format, arg1, arg2, arg3, arg4, arg5, arg6 ) \
    ((*(mask).flags & (classId)) ? \
    _GT_trace(&(mask), (classId), (format), (arg1), (arg2), (arg3), (arg4), \
        (arg5), (arg6)) : 0)



#endif /* GT_TRACE */
  /* ingroup */

#ifdef __cplusplus
}
#endif

#endif

/*
 */
/*
 *  @(#) ti.sdo.utils.trace; 1, 0, 0,164; 11-8-2009 20:59:11; /db/atree/library/trees/fc/fc-l04x/src/
 */