Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
scsi_logging.h
Go to the documentation of this file.
1 #ifndef _SCSI_LOGGING_H
2 #define _SCSI_LOGGING_H
3 
4 
5 /*
6  * This defines the scsi logging feature. It is a means by which the user
7  * can select how much information they get about various goings on, and it
8  * can be really useful for fault tracing. The logging word is divided into
9  * 8 nibbles, each of which describes a loglevel. The division of things is
10  * somewhat arbitrary, and the division of the word could be changed if it
11  * were really needed for any reason. The numbers below are the only place
12  * where these are specified. For a first go-around, 3 bits is more than
13  * enough, since this gives 8 levels of logging (really 7, since 0 is always
14  * off). Cutting to 2 bits might be wise at some point.
15  */
16 
17 #define SCSI_LOG_ERROR_SHIFT 0
18 #define SCSI_LOG_TIMEOUT_SHIFT 3
19 #define SCSI_LOG_SCAN_SHIFT 6
20 #define SCSI_LOG_MLQUEUE_SHIFT 9
21 #define SCSI_LOG_MLCOMPLETE_SHIFT 12
22 #define SCSI_LOG_LLQUEUE_SHIFT 15
23 #define SCSI_LOG_LLCOMPLETE_SHIFT 18
24 #define SCSI_LOG_HLQUEUE_SHIFT 21
25 #define SCSI_LOG_HLCOMPLETE_SHIFT 24
26 #define SCSI_LOG_IOCTL_SHIFT 27
27 
28 #define SCSI_LOG_ERROR_BITS 3
29 #define SCSI_LOG_TIMEOUT_BITS 3
30 #define SCSI_LOG_SCAN_BITS 3
31 #define SCSI_LOG_MLQUEUE_BITS 3
32 #define SCSI_LOG_MLCOMPLETE_BITS 3
33 #define SCSI_LOG_LLQUEUE_BITS 3
34 #define SCSI_LOG_LLCOMPLETE_BITS 3
35 #define SCSI_LOG_HLQUEUE_BITS 3
36 #define SCSI_LOG_HLCOMPLETE_BITS 3
37 #define SCSI_LOG_IOCTL_BITS 3
38 
39 extern unsigned int scsi_logging_level;
40 
41 #ifdef CONFIG_SCSI_LOGGING
42 
43 #define SCSI_LOG_LEVEL(SHIFT, BITS) \
44  ((scsi_logging_level >> (SHIFT)) & ((1 << (BITS)) - 1))
45 
46 #define SCSI_CHECK_LOGGING(SHIFT, BITS, LEVEL, CMD) \
47 do { \
48  if (unlikely((SCSI_LOG_LEVEL(SHIFT, BITS)) > (LEVEL))) \
49  do { \
50  CMD; \
51  } while (0); \
52 } while (0)
53 #else
54 #define SCSI_CHECK_LOGGING(SHIFT, BITS, LEVEL, CMD)
55 #endif /* CONFIG_SCSI_LOGGING */
56 
57 /*
58  * These are the macros that are actually used throughout the code to
59  * log events. If logging isn't enabled, they are no-ops and will be
60  * completely absent from the user's code.
61  */
62 #define SCSI_LOG_ERROR_RECOVERY(LEVEL,CMD) \
63  SCSI_CHECK_LOGGING(SCSI_LOG_ERROR_SHIFT, SCSI_LOG_ERROR_BITS, LEVEL,CMD);
64 #define SCSI_LOG_TIMEOUT(LEVEL,CMD) \
65  SCSI_CHECK_LOGGING(SCSI_LOG_TIMEOUT_SHIFT, SCSI_LOG_TIMEOUT_BITS, LEVEL,CMD);
66 #define SCSI_LOG_SCAN_BUS(LEVEL,CMD) \
67  SCSI_CHECK_LOGGING(SCSI_LOG_SCAN_SHIFT, SCSI_LOG_SCAN_BITS, LEVEL,CMD);
68 #define SCSI_LOG_MLQUEUE(LEVEL,CMD) \
69  SCSI_CHECK_LOGGING(SCSI_LOG_MLQUEUE_SHIFT, SCSI_LOG_MLQUEUE_BITS, LEVEL,CMD);
70 #define SCSI_LOG_MLCOMPLETE(LEVEL,CMD) \
71  SCSI_CHECK_LOGGING(SCSI_LOG_MLCOMPLETE_SHIFT, SCSI_LOG_MLCOMPLETE_BITS, LEVEL,CMD);
72 #define SCSI_LOG_LLQUEUE(LEVEL,CMD) \
73  SCSI_CHECK_LOGGING(SCSI_LOG_LLQUEUE_SHIFT, SCSI_LOG_LLQUEUE_BITS, LEVEL,CMD);
74 #define SCSI_LOG_LLCOMPLETE(LEVEL,CMD) \
75  SCSI_CHECK_LOGGING(SCSI_LOG_LLCOMPLETE_SHIFT, SCSI_LOG_LLCOMPLETE_BITS, LEVEL,CMD);
76 #define SCSI_LOG_HLQUEUE(LEVEL,CMD) \
77  SCSI_CHECK_LOGGING(SCSI_LOG_HLQUEUE_SHIFT, SCSI_LOG_HLQUEUE_BITS, LEVEL,CMD);
78 #define SCSI_LOG_HLCOMPLETE(LEVEL,CMD) \
79  SCSI_CHECK_LOGGING(SCSI_LOG_HLCOMPLETE_SHIFT, SCSI_LOG_HLCOMPLETE_BITS, LEVEL,CMD);
80 #define SCSI_LOG_IOCTL(LEVEL,CMD) \
81  SCSI_CHECK_LOGGING(SCSI_LOG_IOCTL_SHIFT, SCSI_LOG_IOCTL_BITS, LEVEL,CMD);
82 
83 #endif /* _SCSI_LOGGING_H */