include/asm-s390/debug.h

   1 /*
   2  *  include/asm-s390/debug.h
   3  *   S/390 debug facility
   4  *
   5  *    Copyright (C) 1999, 2000 IBM Deutschland Entwicklung GmbH,
   6  *                             IBM Corporation
   7  */
   8
   9 #ifndef DEBUG_H
  10 #define DEBUG_H
  11
  12 #include <linux/string.h>
  13
  14 /* Note:
  15  * struct __debug_entry must be defined outside of #ifdef __KERNEL__
  16  * in order to allow a user program to analyze the 'raw'-view.
  17  */
  18
  19 struct __debug_entry{
  20         union {
  21                 struct {
  22                         unsigned long long clock:52;
  23                         unsigned long long exception:1;
  24                         unsigned long long level:3;
  25                         unsigned long long cpuid:8;
  26                 } fields;
  27
  28                 unsigned long long stck;
  29         } id;
  30         void* caller;
  31 } __attribute__((packed));
  32
  33
  34 #define __DEBUG_FEATURE_VERSION      1  /* version of debug feature */
  35
  36 #ifdef __KERNEL__
  37 #include <linux/version.h>
  38 #include <linux/spinlock.h>
  39 #include <linux/kernel.h>
  40 #include <linux/time.h>
  41 #include <linux/proc_fs.h>
  42
  43 #define DEBUG_MAX_LEVEL            6  /* debug levels range from 0 to 6 */
  44 #define DEBUG_OFF_LEVEL            -1 /* level where debug is switched off */
  45 #define DEBUG_FLUSH_ALL            -1 /* parameter to flush all areas */
  46 #define DEBUG_MAX_VIEWS            10 /* max number of views in proc fs */
  47 #define DEBUG_MAX_PROCF_LEN        16 /* max length for a proc file name */
  48 #define DEBUG_DEFAULT_LEVEL        3  /* initial debug level */
  49
  50 #define DEBUG_DIR_ROOT "s390dbf" /* name of debug root directory in proc fs */
  51
  52 #define DEBUG_DATA(entry) (char*)(entry + 1) /* data is stored behind */
  53                                              /* the entry information */
  54
  55 #define STCK(x) asm volatile ("STCK 0(%1)" : "=m" (x) : "a" (&(x)) : "cc")
  56
  57 typedef struct __debug_entry debug_entry_t;
  58
  59 struct debug_view;
  60
  61 typedef struct debug_info {
  62         struct debug_info* next;
  63         struct debug_info* prev;
  64         atomic_t ref_count;
  65         spinlock_t lock;
  66         int level;
  67         int nr_areas;
  68         int page_order;
  69         int buf_size;
  70         int entry_size;
  71         debug_entry_t** areas;
  72         int active_area;
  73         int *active_entry;
  74         struct proc_dir_entry* proc_root_entry;
  75         struct proc_dir_entry* proc_entries[DEBUG_MAX_VIEWS];
  76         struct debug_view* views[DEBUG_MAX_VIEWS];
  77         char name[DEBUG_MAX_PROCF_LEN];
  78 } debug_info_t;
  79
  80 typedef int (debug_header_proc_t) (debug_info_t* id,
  81                                    struct debug_view* view,
  82                                    int area,
  83                                    debug_entry_t* entry,
  84                                    char* out_buf);
  85
  86 typedef int (debug_format_proc_t) (debug_info_t* id,
  87                                    struct debug_view* view, char* out_buf,
  88                                    const char* in_buf);
  89 typedef int (debug_prolog_proc_t) (debug_info_t* id,
  90                                    struct debug_view* view,
  91                                    char* out_buf);
  92 typedef int (debug_input_proc_t) (debug_info_t* id,
  93                                   struct debug_view* view,
  94                                   struct file* file,
  95                                   const char __user *user_buf,
  96                                   size_t in_buf_size, loff_t* offset);
  97
  98 int debug_dflt_header_fn(debug_info_t* id, struct debug_view* view,
  99                          int area, debug_entry_t* entry, char* out_buf);
 100
 101 struct debug_view {
 102         char name[DEBUG_MAX_PROCF_LEN];
 103         debug_prolog_proc_t* prolog_proc;
 104         debug_header_proc_t* header_proc;
 105         debug_format_proc_t* format_proc;
 106         debug_input_proc_t*  input_proc;
 107         void*                private_data;
 108 };
 109
 110 extern struct debug_view debug_hex_ascii_view;
 111 extern struct debug_view debug_raw_view;
 112 extern struct debug_view debug_sprintf_view;
 113
 114 /* do NOT use the _common functions */
 115
 116 debug_entry_t* debug_event_common(debug_info_t* id, int level,
 117                                   const void* data, int length);
 118
 119 debug_entry_t* debug_exception_common(debug_info_t* id, int level,
 120                                       const void* data, int length);
 121
 122 /* Debug Feature API: */
 123
 124 debug_info_t* debug_register(char* name, int pages_index, int nr_areas,
 125                              int buf_size);
 126
 127 void debug_unregister(debug_info_t* id);
 128
 129 void debug_set_level(debug_info_t* id, int new_level);
 130
 131 extern inline debug_entry_t*
 132 debug_event(debug_info_t* id, int level, void* data, int length)
 133 {
 134         if ((!id) || (level > id->level)) return NULL;
 135         return debug_event_common(id,level,data,length);
 136 }
 137
 138 extern inline debug_entry_t*
 139 debug_int_event(debug_info_t* id, int level, unsigned int tag)
 140 {
 141         unsigned int t=tag;
 142         if ((!id) || (level > id->level)) return NULL;
 143         return debug_event_common(id,level,&t,sizeof(unsigned int));
 144 }
 145
 146 extern inline debug_entry_t *
 147 debug_long_event (debug_info_t* id, int level, unsigned long tag)
 148 {
 149         unsigned long t=tag;
 150         if ((!id) || (level > id->level)) return NULL;
 151         return debug_event_common(id,level,&t,sizeof(unsigned long));
 152 }
 153
 154 extern inline debug_entry_t*
 155 debug_text_event(debug_info_t* id, int level, const char* txt)
 156 {
 157         if ((!id) || (level > id->level)) return NULL;
 158         return debug_event_common(id,level,txt,strlen(txt));
 159 }
 160
 161 extern debug_entry_t *
 162 debug_sprintf_event(debug_info_t* id,int level,char *string,...)
 163         __attribute__ ((format(printf, 3, 4)));
 164
 165
 166 extern inline debug_entry_t*
 167 debug_exception(debug_info_t* id, int level, void* data, int length)
 168 {
 169         if ((!id) || (level > id->level)) return NULL;
 170         return debug_exception_common(id,level,data,length);
 171 }
 172
 173 extern inline debug_entry_t*
 174 debug_int_exception(debug_info_t* id, int level, unsigned int tag)
 175 {
 176         unsigned int t=tag;
 177         if ((!id) || (level > id->level)) return NULL;
 178         return debug_exception_common(id,level,&t,sizeof(unsigned int));
 179 }
 180
 181 extern inline debug_entry_t *
 182 debug_long_exception (debug_info_t* id, int level, unsigned long tag)
 183 {
 184         unsigned long t=tag;
 185         if ((!id) || (level > id->level)) return NULL;
 186         return debug_exception_common(id,level,&t,sizeof(unsigned long));
 187 }
 188
 189 extern inline debug_entry_t*
 190 debug_text_exception(debug_info_t* id, int level, const char* txt)
 191 {
 192         if ((!id) || (level > id->level)) return NULL;
 193         return debug_exception_common(id,level,txt,strlen(txt));
 194 }
 195
 196
 197 extern debug_entry_t *
 198 debug_sprintf_exception(debug_info_t* id,int level,char *string,...)
 199         __attribute__ ((format(printf, 3, 4)));
 200
 201 int debug_register_view(debug_info_t* id, struct debug_view* view);
 202 int debug_unregister_view(debug_info_t* id, struct debug_view* view);
 203
 204 /*
 205    define the debug levels:
 206    - 0 No debugging output to console or syslog
 207    - 1 Log internal errors to syslog, ignore check conditions
 208    - 2 Log internal errors and check conditions to syslog
 209    - 3 Log internal errors to console, log check conditions to syslog
 210    - 4 Log internal errors and check conditions to console
 211    - 5 panic on internal errors, log check conditions to console
 212    - 6 panic on both, internal errors and check conditions
 213  */
 214
 215 #ifndef DEBUG_LEVEL
 216 #define DEBUG_LEVEL 4
 217 #endif
 218
 219 #define INTERNAL_ERRMSG(x,y...) "E" __FILE__ "%d: " x, __LINE__, y
 220 #define INTERNAL_WRNMSG(x,y...) "W" __FILE__ "%d: " x, __LINE__, y
 221 #define INTERNAL_INFMSG(x,y...) "I" __FILE__ "%d: " x, __LINE__, y
 222 #define INTERNAL_DEBMSG(x,y...) "D" __FILE__ "%d: " x, __LINE__, y
 223
 224 #if DEBUG_LEVEL > 0
 225 #define PRINT_DEBUG(x...) printk ( KERN_DEBUG PRINTK_HEADER x )
 226 #define PRINT_INFO(x...) printk ( KERN_INFO PRINTK_HEADER x )
 227 #define PRINT_WARN(x...) printk ( KERN_WARNING PRINTK_HEADER x )
 228 #define PRINT_ERR(x...) printk ( KERN_ERR PRINTK_HEADER x )
 229 #define PRINT_FATAL(x...) panic ( PRINTK_HEADER x )
 230 #else
 231 #define PRINT_DEBUG(x...) printk ( KERN_DEBUG PRINTK_HEADER x )
 232 #define PRINT_INFO(x...) printk ( KERN_DEBUG PRINTK_HEADER x )
 233 #define PRINT_WARN(x...) printk ( KERN_DEBUG PRINTK_HEADER x )
 234 #define PRINT_ERR(x...) printk ( KERN_DEBUG PRINTK_HEADER x )
 235 #define PRINT_FATAL(x...) printk ( KERN_DEBUG PRINTK_HEADER x )
 236 #endif                          /* DASD_DEBUG */
 237
 238 #undef DEBUG_MALLOC
 239 #ifdef DEBUG_MALLOC
 240 void *b;
 241 #define kmalloc(x...) (PRINT_INFO(" kmalloc %p\n",b=kmalloc(x)),b)
 242 #define kfree(x) PRINT_INFO(" kfree %p\n",x);kfree(x)
 243 #define get_zeroed_page(x...) (PRINT_INFO(" gfp %p\n",b=get_zeroed_page(x)),b)
 244 #define __get_free_pages(x...) (PRINT_INFO(" gfps %p\n",b=__get_free_pages(x)),b)
 245 #endif                          /* DEBUG_MALLOC */
 246
 247 #endif                          /* __KERNEL__ */
 248 #endif                          /* DEBUG_H */