api/debug.hpp

#if !defined(__API_DEBUG_HPP__)
#define __API_DEBUG_HPP__

//
// detailed debugging switches
//
#if L4VMM_BUILD_DEBUG

    //
    // use a global lock upon library entry.
    //     use only for debugging ! may cause deadlocks !
    //
    #define L4VMM_API_LOCK              0

    //
    // ***** API (code that implements the API functions only) *****
    //

    //
    // 0: disabled
    // 1: sanity checks
    // 2: verbose initialization including type size checks
    // 3: all library entries and corresponding informational messages
    // 4: additionally all library exits
    //
    #define L4VMM_DEBUG_VMM             2

    //
    // 0: disabled
    // 1: sanity checks
    // 2: print message when client threads wake up (IRQ assertions)
    // 3: print message when client threads go to sleep (IRQ waits)
    //
    #define L4VMM_DEBUG_OMEGA0          1

    //
    // 0: disabled
    // 1: sanity checks
    //
    #define L4VMM_DEBUG_L4IO            1

    //
    // 0: disabled
    // 1: sanity checks
    // 2/3: every piece of data read/written through I/O space API functions
    //
    #define L4VMM_DEBUG_L4UTIL          1

#else /* L4VMM_BUILD_DEBUG */

    #define L4VMM_API_LOCK              0

    #define L4VMM_DEBUG_VMM             0
    #define L4VMM_DEBUG_OMEGA0          0
    #define L4VMM_DEBUG_L4IO            0
    #define L4VMM_DEBUG_L4UTIL          0

#endif /* L4VMM_BUILD_DEBUG */

//
// debug routines
//
#if L4VMM_DEBUG_VMM >= 2
    #include "core/util/c++0x.hpp"
    void l4vmm_check_types(const char *header=nullptr);
#endif

//
// traceing type
//
#if L4VMM_DEBUG_VMM >= 3
    struct l4vmm_entry_frame
    {
        const char *function;
        char notes[80];

        l4vmm_entry_frame(const char *function, const char *format=nullptr, ...);
        ~l4vmm_entry_frame(void);

        void print(const char *prefix=nullptr);
    };
#endif

//
// global lock
//
#if L4VMM_API_LOCK
    extern struct lock l4vmm_library_lock;
#endif

//
// library entry macro
//
#if L4VMM_DEBUG_VMM >= 3
    #define l4vmm_enter_nolock(args...)     l4vmm_entry_frame __enter__(args)
#else
    #define l4vmm_enter_nolock(...)         do {} while(0)
#endif

#if L4VMM_API_LOCK
    #define l4vmm_enter(args...)            l4vmm_enter_nolock(args);                           \
                                            auto_lock<lock> __lock_guard__(l4vmm_library_lock)
#else
    #define l4vmm_enter(args...)            l4vmm_enter_nolock(args);
#endif

#endif

// ***** end of source ***** //