Subversion Repositories or1k

/*

 *  include/asm-s390/debug.h

 *   S/390 debug facility

 *

 *    Copyright (C) 1999, 2000 IBM Deutschland Entwicklung GmbH,

 *                             IBM Corporation

 */

#ifndef DEBUG_H

#define DEBUG_H

/* Note:

 * struct __debug_entry must be defined outside of #ifdef __KERNEL__

 * in order to allow a user program to analyze the 'raw'-view.

 */

struct __debug_entry{

        union {

                struct {

                        unsigned long long clock:52;

                        unsigned long long exception:1;

                        unsigned long long level:3;

                        unsigned long long cpuid:8;

                } fields;

                unsigned long long stck;

        } id;

        void* caller;

} __attribute__((packed));

#define __DEBUG_FEATURE_VERSION      1  /* version of debug feature */

#ifdef __KERNEL__

#include <linux/version.h>

#if (LINUX_VERSION_CODE < KERNEL_VERSION(2,3,0))

 #include <asm/spinlock.h>

#else

 #include <linux/spinlock.h>

#endif /* LINUX_VERSION_CODE */

#include <linux/kernel.h>

#include <linux/time.h>

#include <linux/proc_fs.h>

#define DEBUG_MAX_LEVEL            6  /* debug levels range from 0 to 6 */

#define DEBUG_OFF_LEVEL            -1 /* level where debug is switched off */

#define DEBUG_FLUSH_ALL            -1 /* parameter to flush all areas */

#define DEBUG_MAX_VIEWS            10 /* max number of views in proc fs */

#define DEBUG_MAX_PROCF_LEN        16 /* max length for a proc file name */

#define DEBUG_DEFAULT_LEVEL        3  /* initial debug level */

#define DEBUG_DIR_ROOT "s390dbf" /* name of debug root directory in proc fs */

#define DEBUG_DATA(entry) (char*)(entry + 1) /* data is stored behind */

                                             /* the entry information */

#define STCK(x) asm volatile ("STCK 0(%0)" : : "a" (&(x)) : "memory", "cc")

typedef struct __debug_entry debug_entry_t;

struct debug_view;

typedef struct debug_info {

        struct debug_info* next;

        struct debug_info* prev;

        atomic_t ref_count;

        spinlock_t lock;

        int level;

        int nr_areas;

        int page_order;

        int buf_size;

        int entry_size;

        debug_entry_t** areas;

        int active_area;

        int *active_entry;

        struct proc_dir_entry* proc_root_entry;

        struct proc_dir_entry* proc_entries[DEBUG_MAX_VIEWS];

        struct debug_view* views[DEBUG_MAX_VIEWS];

        char name[DEBUG_MAX_PROCF_LEN];

} debug_info_t;

typedef int (debug_header_proc_t) (debug_info_t* id,

                                   struct debug_view* view,

                                   int area,

                                   debug_entry_t* entry,

                                   char* out_buf);

typedef int (debug_format_proc_t) (debug_info_t* id,

                                   struct debug_view* view, char* out_buf,

                                   const char* in_buf);

typedef int (debug_prolog_proc_t) (debug_info_t* id,

                                   struct debug_view* view,

                                   char* out_buf);

typedef int (debug_input_proc_t) (debug_info_t* id,

                                  struct debug_view* view,

                                  struct file* file, const char* user_buf,

                                  size_t in_buf_size, loff_t* offset);

int debug_dflt_header_fn(debug_info_t* id, struct debug_view* view,

                         int area, debug_entry_t* entry, char* out_buf);

struct debug_view {

        char name[DEBUG_MAX_PROCF_LEN];

        debug_prolog_proc_t* prolog_proc;

        debug_header_proc_t* header_proc;

        debug_format_proc_t* format_proc;

        debug_input_proc_t*  input_proc;

        void*                private_data;

};

extern struct debug_view debug_hex_ascii_view;

extern struct debug_view debug_raw_view;

extern struct debug_view debug_sprintf_view;

/* do NOT use the _common functions */

debug_entry_t* debug_event_common(debug_info_t* id, int level,

                                  const void* data, int length);

debug_entry_t* debug_exception_common(debug_info_t* id, int level,

                                      const void* data, int length);

/* Debug Feature API: */

debug_info_t* debug_register(char* name, int pages_index, int nr_areas,

                             int buf_size);

void debug_unregister(debug_info_t* id);

void debug_set_level(debug_info_t* id, int new_level);

extern inline debug_entry_t*

debug_event(debug_info_t* id, int level, void* data, int length)

{

        if ((!id) || (level > id->level)) return NULL;

        return debug_event_common(id,level,data,length);

}

extern inline debug_entry_t*

debug_int_event(debug_info_t* id, int level, unsigned int tag)

{

        unsigned int t=tag;

        if ((!id) || (level > id->level)) return NULL;

        return debug_event_common(id,level,&t,sizeof(unsigned int));

}

extern inline debug_entry_t *

debug_long_event (debug_info_t* id, int level, unsigned long tag)

{

        unsigned long t=tag;

        if ((!id) || (level > id->level)) return NULL;

        return debug_event_common(id,level,&t,sizeof(unsigned long));

}

extern inline debug_entry_t*

debug_text_event(debug_info_t* id, int level, const char* txt)

{

        if ((!id) || (level > id->level)) return NULL;

        return debug_event_common(id,level,txt,strlen(txt));

}

extern debug_entry_t *

debug_sprintf_event(debug_info_t* id,int level,char *string,...);

extern inline debug_entry_t*

debug_exception(debug_info_t* id, int level, void* data, int length)

{

        if ((!id) || (level > id->level)) return NULL;

        return debug_exception_common(id,level,data,length);

}

extern inline debug_entry_t*

debug_int_exception(debug_info_t* id, int level, unsigned int tag)

{

        unsigned int t=tag;

        if ((!id) || (level > id->level)) return NULL;

        return debug_exception_common(id,level,&t,sizeof(unsigned int));

}

extern inline debug_entry_t *

debug_long_exception (debug_info_t* id, int level, unsigned long tag)

{

        unsigned long t=tag;

        if ((!id) || (level > id->level)) return NULL;

        return debug_exception_common(id,level,&t,sizeof(unsigned long));

}

extern inline debug_entry_t*

debug_text_exception(debug_info_t* id, int level, const char* txt)

{

        if ((!id) || (level > id->level)) return NULL;

        return debug_exception_common(id,level,txt,strlen(txt));

}

extern debug_entry_t *

debug_sprintf_exception(debug_info_t* id,int level,char *string,...);

int debug_register_view(debug_info_t* id, struct debug_view* view);

int debug_unregister_view(debug_info_t* id, struct debug_view* view);

/*

   define the debug levels:

   - 0 No debugging output to console or syslog

   - 1 Log internal errors to syslog, ignore check conditions

   - 2 Log internal errors and check conditions to syslog

   - 3 Log internal errors to console, log check conditions to syslog

   - 4 Log internal errors and check conditions to console

   - 5 panic on internal errors, log check conditions to console

   - 6 panic on both, internal errors and check conditions

 */

#ifndef DEBUG_LEVEL

#define DEBUG_LEVEL 4

#endif

#define INTERNAL_ERRMSG(x,y...) "E" __FILE__ "%d: " x, __LINE__, y

#define INTERNAL_WRNMSG(x,y...) "W" __FILE__ "%d: " x, __LINE__, y

#define INTERNAL_INFMSG(x,y...) "I" __FILE__ "%d: " x, __LINE__, y

#define INTERNAL_DEBMSG(x,y...) "D" __FILE__ "%d: " x, __LINE__, y

#if DEBUG_LEVEL > 0

#define PRINT_DEBUG(x...) printk ( KERN_DEBUG PRINTK_HEADER x )

#define PRINT_INFO(x...) printk ( KERN_INFO PRINTK_HEADER x )

#define PRINT_WARN(x...) printk ( KERN_WARNING PRINTK_HEADER x )

#define PRINT_ERR(x...) printk ( KERN_ERR PRINTK_HEADER x )

#define PRINT_FATAL(x...) panic ( PRINTK_HEADER x )

#else

#define PRINT_DEBUG(x...) printk ( KERN_DEBUG PRINTK_HEADER x )

#define PRINT_INFO(x...) printk ( KERN_DEBUG PRINTK_HEADER x )

#define PRINT_WARN(x...) printk ( KERN_DEBUG PRINTK_HEADER x )

#define PRINT_ERR(x...) printk ( KERN_DEBUG PRINTK_HEADER x )

#define PRINT_FATAL(x...) printk ( KERN_DEBUG PRINTK_HEADER x )

#endif                          /* DASD_DEBUG */

#if DASD_DEBUG > 4

#define INTERNAL_ERROR(x...) PRINT_FATAL ( INTERNAL_ERRMSG ( x ) )

#elif DASD_DEBUG > 2

#define INTERNAL_ERROR(x...) PRINT_ERR ( INTERNAL_ERRMSG ( x ) )

#elif DASD_DEBUG > 0

#define INTERNAL_ERROR(x...) PRINT_WARN ( INTERNAL_ERRMSG ( x ) )

#else

#define INTERNAL_ERROR(x...)

#endif                          /* DASD_DEBUG */

#if DASD_DEBUG > 5

#define INTERNAL_CHECK(x...) PRINT_FATAL ( INTERNAL_CHKMSG ( x ) )

#elif DASD_DEBUG > 3

#define INTERNAL_CHECK(x...) PRINT_ERR ( INTERNAL_CHKMSG ( x ) )

#elif DASD_DEBUG > 1

#define INTERNAL_CHECK(x...) PRINT_WARN ( INTERNAL_CHKMSG ( x ) )

#else

#define INTERNAL_CHECK(x...)

#endif                          /* DASD_DEBUG */

#undef DEBUG_MALLOC

#ifdef DEBUG_MALLOC

void *b;

#define kmalloc(x...) (PRINT_INFO(" kmalloc %p\n",b=kmalloc(x)),b)

#define kfree(x) PRINT_INFO(" kfree %p\n",x);kfree(x)

#define get_free_page(x...) (PRINT_INFO(" gfp %p\n",b=get_free_page(x)),b)

#define __get_free_pages(x...) (PRINT_INFO(" gfps %p\n",b=__get_free_pages(x)),b)

#endif                          /* DEBUG_MALLOC */

#endif                          /* __KERNEL__ */

#endif                          /* DEBUG_H */