include/sys/debug.h

   1 /*
   2  *  This file is part of the SPL: Solaris Porting Layer.
   3  *
   4  *  Copyright (c) 2008 Lawrence Livermore National Security, LLC.
   5  *  Produced at Lawrence Livermore National Laboratory
   6  *  Written by:
   7  *          Brian Behlendorf <behlendorf1@llnl.gov>,
   8  *          Herb Wartens <wartens2@llnl.gov>,
   9  *          Jim Garlick <garlick@llnl.gov>
  10  *  UCRL-CODE-235197
  11  *
  12  *  This is free software; you can redistribute it and/or modify it
  13  *  under the terms of the GNU General Public License as published by
  14  *  the Free Software Foundation; either version 2 of the License, or
  15  *  (at your option) any later version.
  16  *
  17  *  This is distributed in the hope that it will be useful, but WITHOUT
  18  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  *  for more details.
  21  *
  22  *  You should have received a copy of the GNU General Public License along
  23  *  with this program; if not, write to the Free Software Foundation, Inc.,
  24  *  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  */
  26
  27 #ifndef _SPL_DEBUG_H
  28 #define _SPL_DEBUG_H
  29
  30 #ifdef  __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #include <linux/sched.h> /* THREAD_SIZE */
  35 #include <linux/proc_fs.h>
  36
  37 extern unsigned long spl_debug_mask;
  38 extern unsigned long spl_debug_subsys;
  39
  40 #define S_UNDEFINED   0x00000001
  41 #define S_ATOMIC      0x00000002
  42 #define S_KOBJ        0x00000004
  43 #define S_VNODE       0x00000008
  44 #define S_TIME        0x00000010
  45 #define S_RWLOCK      0x00000020
  46 #define S_THREAD      0x00000040
  47 #define S_CONDVAR     0x00000080
  48 #define S_MUTEX       0x00000100
  49 #define S_RNG         0x00000200
  50 #define S_TASKQ       0x00000400
  51 #define S_KMEM        0x00000800
  52 #define S_DEBUG       0x00001000
  53 #define S_GENERIC     0x00002000
  54 #define S_PROC        0x00004000
  55 #define S_MODULE      0x00008000
  56
  57 #define D_TRACE       0x00000001
  58 #define D_INFO        0x00000002
  59 #define D_WARNING     0x00000004
  60 #define D_ERROR       0x00000008
  61 #define D_EMERG       0x00000010
  62 #define D_CONSOLE     0x00000020
  63 #define D_IOCTL       0x00000040
  64 #define D_DPRINTF     0x00000080
  65 #define D_OTHER       0x00000100
  66
  67 #define D_CANTMASK    (D_ERROR | D_EMERG | D_WARNING | D_CONSOLE)
  68 #define DEBUG_SUBSYSTEM S_UNDEFINED
  69
  70 int debug_init(void);
  71 void debug_fini(void);
  72 int spl_debug_mask2str(char *str, int size, unsigned long mask, int is_subsys);
  73 int spl_debug_str2mask(unsigned long *mask, const char *str, int is_subsys);
  74
  75 extern unsigned long spl_debug_subsys;
  76 extern unsigned long spl_debug_mask;
  77 extern unsigned long spl_debug_printk;
  78 extern int spl_debug_mb;
  79 extern unsigned int spl_debug_binary;
  80 extern unsigned int spl_debug_catastrophe;
  81 extern unsigned int spl_debug_panic_on_bug;
  82 extern char spl_debug_file_path[PATH_MAX];
  83 extern unsigned int spl_console_ratelimit;
  84 extern long spl_console_max_delay;
  85 extern long spl_console_min_delay;
  86 extern unsigned int spl_console_backoff;
  87 extern unsigned int spl_debug_stack;
  88
  89 #define TCD_MAX_PAGES                   (5 << (20 - PAGE_SHIFT))
  90 #define TCD_STOCK_PAGES                 (TCD_MAX_PAGES)
  91 #define TRACE_CONSOLE_BUFFER_SIZE       1024
  92
  93 #define SPL_DEFAULT_MAX_DELAY           (600 * HZ)
  94 #define SPL_DEFAULT_MIN_DELAY           ((HZ + 1) / 2)
  95 #define SPL_DEFAULT_BACKOFF             2
  96
  97 #define DL_NOTHREAD                     0x0001 /* Do not create a new thread */
  98 #define DL_SINGLE_CPU                   0x0002 /* Collect pages from this CPU */
  99
 100 typedef struct dumplog_priv {
 101         wait_queue_head_t dp_waitq;
 102         pid_t dp_pid;
 103         int dp_flags;
 104         atomic_t dp_done;
 105 } dumplog_priv_t;
 106
 107 typedef struct {
 108         unsigned long cdls_next;
 109         int           cdls_count;
 110         long          cdls_delay;
 111 } spl_debug_limit_state_t;
 112
 113 /* Three trace data types */
 114 typedef enum {
 115         TCD_TYPE_PROC,
 116         TCD_TYPE_SOFTIRQ,
 117         TCD_TYPE_IRQ,
 118         TCD_TYPE_MAX
 119 } tcd_type_t;
 120
 121 union trace_data_union {
 122         struct trace_cpu_data {
 123                 /* pages with trace records not yet processed by tracefiled */
 124                 struct list_head        tcd_pages;
 125                 /* number of pages on ->tcd_pages */
 126                 unsigned long           tcd_cur_pages;
 127                 /* Max number of pages allowed on ->tcd_pages */
 128                 unsigned long           tcd_max_pages;
 129
 130                 /*
 131                  * preallocated pages to write trace records into. Pages from
 132                  * ->tcd_stock_pages are moved to ->tcd_pages by spl_debug_msg().
 133                  *
 134                  * This list is necessary, because on some platforms it's
 135                  * impossible to perform efficient atomic page allocation in a
 136                  * non-blockable context.
 137                  *
 138                  * Such platforms fill ->tcd_stock_pages "on occasion", when
 139                  * tracing code is entered in blockable context.
 140                  *
 141                  * trace_get_tage_try() tries to get a page from
 142                  * ->tcd_stock_pages first and resorts to atomic page
 143                  * allocation only if this queue is empty. ->tcd_stock_pages
 144                  * is replenished when tracing code is entered in blocking
 145                  * context (darwin-tracefile.c:trace_get_tcd()). We try to
 146                  * maintain TCD_STOCK_PAGES (40 by default) pages in this
 147                  * queue. Atomic allocation is only required if more than
 148                  * TCD_STOCK_PAGES pagesful are consumed by trace records all
 149                  * emitted in non-blocking contexts. Which is quite unlikely.
 150                  */
 151                 struct list_head        tcd_stock_pages;
 152                 /* number of pages on ->tcd_stock_pages */
 153                 unsigned long           tcd_cur_stock_pages;
 154
 155                 unsigned short          tcd_shutting_down;
 156                 unsigned short          tcd_cpu;
 157                 unsigned short          tcd_type;
 158                 /* The factors to share debug memory. */
 159                 unsigned short          tcd_pages_factor;
 160         } tcd;
 161         char __pad[L1_CACHE_ALIGN(sizeof(struct trace_cpu_data))];
 162 };
 163
 164 extern union trace_data_union (*trace_data[TCD_TYPE_MAX])[NR_CPUS];
 165
 166 #define tcd_for_each(tcd, i, j)                                       \
 167     for (i = 0; trace_data[i] != NULL; i++)                           \
 168         for (j = 0, ((tcd) = &(*trace_data[i])[j].tcd);               \
 169              j < num_possible_cpus(); j++, (tcd) = &(*trace_data[i])[j].tcd)
 170
 171 #define tcd_for_each_type_lock(tcd, i)                                \
 172     for (i = 0; trace_data[i] &&                                      \
 173          (tcd = &(*trace_data[i])[smp_processor_id()].tcd) &&         \
 174          trace_lock_tcd(tcd); trace_unlock_tcd(tcd), i++)
 175
 176 struct trace_page {
 177         struct page *    page;    /* page itself */
 178         struct list_head linkage;  /* Used by lists in trace_data_union */
 179         unsigned int     used;     /* number of bytes used within this page */
 180         unsigned short   cpu;      /* cpu that owns this page */
 181         unsigned short   type;     /* type(context) of this page */
 182 };
 183
 184 struct page_collection {
 185         struct list_head  pc_pages;
 186         spinlock_t        pc_lock;
 187         int               pc_want_daemon_pages;
 188 };
 189
 190 #define SBUG()            spl_debug_bug(__FILE__, __FUNCTION__, __LINE__, 0);
 191
 192 #ifdef NDEBUG
 193
 194 #define CDEBUG_STACK()                  (0)
 195 #define __CDEBUG_LIMIT(x, y, z, a...)   ((void)0)
 196 #define CDEBUG(mask, format, a...)      ((void)0)
 197 #define CWARN(fmt, a...)                ((void)0)
 198 #define CERROR(fmt, a...)               ((void)0)
 199 #define CEMERG(fmt, a...)               ((void)0)
 200 #define CONSOLE(mask, fmt, a...)        ((void)0)
 201
 202 #define ENTRY                           ((void)0)
 203 #define EXIT                            ((void)0)
 204 #define RETURN(x)                       return (x)
 205 #define GOTO(x, y)                      { ((void)(y)); goto x; }
 206
 207 #define __ASSERT(x)                     ((void)0)
 208 #define __ASSERT_TAGE_INVARIANT(x)      ((void)0)
 209 #define ASSERT(x)                       ((void)0)
 210 #define ASSERTF(x, y, z...)             ((void)0)
 211 #define VERIFY(x)                       ((void)(x))
 212
 213 #define VERIFY3_IMPL(x, y, z, t, f, c)  if (x == z) ((void)0)
 214
 215 #define VERIFY3S(x,y,z) VERIFY3_IMPL(x, y, z, int64_t, "%ld", (long))
 216 #define VERIFY3U(x,y,z) VERIFY3_IMPL(x, y, z, uint64_t, "%lu", (unsigned long))
 217 #define VERIFY3P(x,y,z) VERIFY3_IMPL(x, y, z, uintptr_t, "%p", (void *))
 218
 219 #define ASSERT3S(x,y,z) VERIFY3S(x, y, z)
 220 #define ASSERT3U(x,y,z) VERIFY3U(x, y, z)
 221 #define ASSERT3P(x,y,z) VERIFY3P(x, y, z)
 222
 223 #else /* NDEBUG */
 224
 225 #ifdef  __ia64__
 226 #define CDEBUG_STACK() (THREAD_SIZE -                                   \
 227                        ((unsigned long)__builtin_dwarf_cfa() &          \
 228                        (THREAD_SIZE - 1)))
 229 #else
 230 #define CDEBUG_STACK() (THREAD_SIZE -                                   \
 231                        ((unsigned long)__builtin_frame_address(0) &     \
 232                         (THREAD_SIZE - 1)))
 233 # endif /* __ia64__ */
 234
 235 /* DL_SINGLE_CPU flag is passed to spl_debug_bug() because we are about
 236  * to over run our stack and likely damage at least one other unknown
 237  * thread stack.  We must finish generating the needed debug info within
 238  * this thread context because once we yeild the CPU its very likely
 239  * the system will crash.
 240  */
 241 #define __CHECK_STACK(file, func, line)                                 \
 242 do {                                                                    \
 243         if (unlikely(CDEBUG_STACK() > spl_debug_stack)) {               \
 244                 spl_debug_stack = CDEBUG_STACK();                       \
 245                                                                         \
 246                 if (unlikely(CDEBUG_STACK() > (4 * THREAD_SIZE) / 5)) { \
 247                         spl_debug_msg(NULL, D_TRACE, D_WARNING,         \
 248                                       file, func, line, "Error "        \
 249                                       "exceeded maximum safe stack "    \
 250                                       "size (%lu/%lu)\n",               \
 251                                       CDEBUG_STACK(), THREAD_SIZE);     \
 252                         spl_debug_bug(file, func, line, DL_SINGLE_CPU); \
 253                 }                                                       \
 254         }                                                               \
 255 } while (0)
 256
 257 #define CHECK_STACK()   __CHECK_STACK(__FILE__, __func__, __LINE__)
 258
 259 /* ASSERTION that is safe to use within the debug system */
 260 #define __ASSERT(cond)                                                  \
 261 do {                                                                    \
 262         if (unlikely(!(cond))) {                                        \
 263                 printk(KERN_ERR "ASSERTION(" #cond ") failed");         \
 264                 BUG();                                                  \
 265         }                                                               \
 266 } while (0)
 267
 268 #define __ASSERT_TAGE_INVARIANT(tage)                                   \
 269 do {                                                                    \
 270         __ASSERT(tage != NULL);                                         \
 271         __ASSERT(tage->page != NULL);                                   \
 272         __ASSERT(tage->used <= PAGE_SIZE);                              \
 273         __ASSERT(page_count(tage->page) > 0);                           \
 274 } while(0)
 275
 276 /* ASSERTION that will debug log used outside the debug sysytem */
 277 #define ASSERT(cond)                                                    \
 278 do {                                                                    \
 279         CHECK_STACK();                                                  \
 280                                                                         \
 281         if (unlikely(!(cond))) {                                        \
 282                 spl_debug_msg(NULL, DEBUG_SUBSYSTEM, D_EMERG,           \
 283                               __FILE__, __FUNCTION__, __LINE__,         \
 284                               "ASSERTION(" #cond ") failed\n");         \
 285                 SBUG();                                                 \
 286         }                                                               \
 287 } while (0)
 288
 289 #define ASSERTF(cond, fmt, a...)                                        \
 290 do {                                                                    \
 291         CHECK_STACK();                                                  \
 292                                                                         \
 293         if (unlikely(!(cond))) {                                        \
 294                 spl_debug_msg(NULL, DEBUG_SUBSYSTEM, D_EMERG,           \
 295                               __FILE__, __FUNCTION__, __LINE__,         \
 296                               "ASSERTION(" #cond ") failed: " fmt,      \
 297                                  ## a);                                 \
 298                 SBUG();                                                 \
 299         }                                                               \
 300 } while (0)
 301
 302 #define VERIFY3_IMPL(LEFT, OP, RIGHT, TYPE, FMT, CAST)                  \
 303 do {                                                                    \
 304         CHECK_STACK();                                                  \
 305                                                                         \
 306         if (!((TYPE)(LEFT) OP (TYPE)(RIGHT))) {                         \
 307                 spl_debug_msg(NULL, DEBUG_SUBSYSTEM, D_EMERG,           \
 308                               __FILE__, __FUNCTION__, __LINE__,         \
 309                               "VERIFY3(" FMT " " #OP " " FMT ")\n",     \
 310                               CAST (LEFT), CAST (RIGHT));               \
 311                 SBUG();                                                 \
 312         }                                                               \
 313 } while (0)
 314
 315 #define VERIFY3S(x,y,z) VERIFY3_IMPL(x, y, z, int64_t, "%ld", (long))
 316 #define VERIFY3U(x,y,z) VERIFY3_IMPL(x, y, z, uint64_t, "%lu", (unsigned long))
 317 #define VERIFY3P(x,y,z) VERIFY3_IMPL(x, y, z, uintptr_t, "%p", (void *))
 318
 319 #define ASSERT3S(x,y,z) VERIFY3S(x, y, z)
 320 #define ASSERT3U(x,y,z) VERIFY3U(x, y, z)
 321 #define ASSERT3P(x,y,z) VERIFY3P(x, y, z)
 322
 323 #define VERIFY(x)       ASSERT(x)
 324
 325 #define __CDEBUG(cdls, subsys, mask, format, a...)                      \
 326 do {                                                                    \
 327         CHECK_STACK();                                                  \
 328                                                                         \
 329         if (((mask) & D_CANTMASK) != 0 ||                               \
 330             ((spl_debug_mask & (mask)) != 0 &&                          \
 331              (spl_debug_subsys & (subsys)) != 0))                       \
 332                 spl_debug_msg(cdls, subsys, mask,                       \
 333                               __FILE__, __FUNCTION__, __LINE__,         \
 334                               format, ## a);                            \
 335 } while (0)
 336
 337 #define CDEBUG(mask, format, a...)                                      \
 338         __CDEBUG(NULL, DEBUG_SUBSYSTEM, mask, format, ## a)
 339
 340 #define __CDEBUG_LIMIT(subsys, mask, format, a...)                      \
 341 do {                                                                    \
 342         static spl_debug_limit_state_t cdls;                            \
 343                                                                         \
 344         __CDEBUG(&cdls, subsys, mask, format, ## a);                    \
 345 } while (0)
 346
 347 #define CDEBUG_LIMIT(mask, format, a...)                                \
 348         __CDEBUG_LIMIT(DEBUG_SUBSYSTEM, mask, format, ## a)
 349
 350 #define CWARN(fmt, a...)               CDEBUG_LIMIT(D_WARNING, fmt, ## a)
 351 #define CERROR(fmt, a...)              CDEBUG_LIMIT(D_ERROR, fmt, ## a)
 352 #define CEMERG(fmt, a...)              CDEBUG_LIMIT(D_EMERG, fmt, ## a)
 353 #define CONSOLE(mask, fmt, a...)       CDEBUG(D_CONSOLE | (mask), fmt, ## a)
 354
 355 #define GOTO(label, rc)                                                 \
 356 do {                                                                    \
 357         long GOTO__ret = (long)(rc);                                    \
 358         CDEBUG(D_TRACE,"Process leaving via %s (rc=%lu : %ld : %lx)\n", \
 359                #label, (unsigned long)GOTO__ret, (signed long)GOTO__ret,\
 360                (signed long)GOTO__ret);                                 \
 361         goto label;                                                     \
 362 } while (0)
 363
 364 #define RETURN(rc)                                                      \
 365 do {                                                                    \
 366         typeof(rc) RETURN__ret = (rc);                                  \
 367         CDEBUG(D_TRACE, "Process leaving (rc=%lu : %ld : %lx)\n",       \
 368                (long)RETURN__ret, (long)RETURN__ret, (long)RETURN__ret);\
 369         return RETURN__ret;                                             \
 370 } while (0)
 371
 372 #define __ENTRY(subsys)                                                 \
 373 do {                                                                    \
 374         __CDEBUG(NULL, subsys, D_TRACE, "Process entered\n");           \
 375 } while (0)
 376
 377 #define __EXIT(subsys)                                                  \
 378 do {                                                                    \
 379         __CDEBUG(NULL, subsys, D_TRACE, "Process leaving\n");           \
 380 } while(0)
 381
 382 #define ENTRY                           __ENTRY(DEBUG_SUBSYSTEM)
 383 #define EXIT                            __EXIT(DEBUG_SUBSYSTEM)
 384 #endif /* NDEBUG */
 385
 386 #define spl_debug_msg(cdls, subsys, mask, file, fn, line, format, a...) \
 387         spl_debug_vmsg(cdls, subsys, mask, file, fn,                    \
 388                        line, NULL, NULL, format, ##a)
 389
 390 extern int spl_debug_vmsg(spl_debug_limit_state_t *cdls, int subsys, int mask,
 391                           const char *file, const char *fn, const int line,
 392                           const char *format1, va_list args, const char *format2, ...);
 393
 394 extern unsigned long spl_debug_set_mask(unsigned long mask);
 395 extern unsigned long spl_debug_get_mask(void);
 396 extern unsigned long spl_debug_set_subsys(unsigned long mask);
 397 extern unsigned long spl_debug_get_subsys(void);
 398 extern int spl_debug_set_mb(int mb);
 399 extern int spl_debug_get_mb(void);
 400
 401 extern int spl_debug_dumplog(int flags);
 402 extern void spl_debug_dumpstack(struct task_struct *tsk);
 403 extern void spl_debug_bug(char *file, const char *func, const int line, int flags);
 404
 405 extern int spl_debug_clear_buffer(void);
 406 extern int spl_debug_mark_buffer(char *text);
 407
 408 #ifdef  __cplusplus
 409 }
 410 #endif
 411
 412 #endif /* SPL_DEBUG_H */