blob: 6f53742ae2b6c3108a78b872970fbfa2a40875b6 [file] [log] [blame]
Randy Dunlapb67ad182008-11-12 13:26:55 -08001If variable is of Type, use printk format specifier:
2---------------------------------------------------------
3 int %d or %x
4 unsigned int %u or %x
5 long %ld or %lx
6 unsigned long %lu or %lx
7 long long %lld or %llx
8 unsigned long long %llu or %llx
9 size_t %zu or %zx
10 ssize_t %zd or %zx
11
Andrew Murray04c55712011-06-15 12:57:09 -070012Raw pointer value SHOULD be printed with %p. The kernel supports
13the following extended format specifiers for pointer types:
14
15Symbols/Function Pointers:
16
17 %pF versatile_init+0x0/0x110
18 %pf versatile_init
19 %pS versatile_init+0x0/0x110
20 %ps versatile_init
21 %pB prev_fn_of_versatile_init+0x88/0x88
22
23 For printing symbols and function pointers. The 'S' and 's' specifiers
24 result in the symbol name with ('S') or without ('s') offsets. Where
25 this is used on a kernel without KALLSYMS - the symbol address is
26 printed instead.
27
28 The 'B' specifier results in the symbol name with offsets and should be
29 used when printing stack backtraces. The specifier takes into
30 consideration the effect of compiler optimisations which may occur
31 when tail-call's are used and marked with the noreturn GCC attribute.
32
33 On ia64, ppc64 and parisc64 architectures function pointers are
34 actually function descriptors which must first be resolved. The 'F' and
35 'f' specifiers perform this resolution and then provide the same
36 functionality as the 'S' and 's' specifiers.
37
38Kernel Pointers:
39
40 %pK 0x01234567 or 0x0123456789abcdef
41
42 For printing kernel pointers which should be hidden from unprivileged
43 users. The behaviour of %pK depends on the kptr_restrict sysctl - see
44 Documentation/sysctl/kernel.txt for more details.
45
46Struct Resources:
47
48 %pr [mem 0x60000000-0x6fffffff flags 0x2200] or
49 [mem 0x0000000060000000-0x000000006fffffff flags 0x2200]
50 %pR [mem 0x60000000-0x6fffffff pref] or
51 [mem 0x0000000060000000-0x000000006fffffff pref]
52
53 For printing struct resources. The 'R' and 'r' specifiers result in a
54 printed resource with ('R') or without ('r') a decoded flags member.
55
Stepan Moskovchenkoe9ba0642013-01-21 13:27:25 -080056Physical addresses:
57
58 %pa 0x01234567 or 0x0123456789abcdef
59
60 For printing a phys_addr_t type (and its derivatives, such as
61 resource_size_t) which can vary based on build options, regardless of
62 the width of the CPU data path. Passed by reference.
63
Andrew Murray04c55712011-06-15 12:57:09 -070064MAC/FDDI addresses:
65
66 %pM 00:01:02:03:04:05
67 %pMF 00-01-02-03-04-05
68 %pm 000102030405
69
70 For printing 6-byte MAC/FDDI addresses in hex notation. The 'M' and 'm'
71 specifiers result in a printed address with ('M') or without ('m') byte
72 separators. The default byte separator is the colon (':').
73
74 Where FDDI addresses are concerned the 'F' specifier can be used after
75 the 'M' specifier to use dash ('-') separators instead of the default
76 separator.
77
78IPv4 addresses:
79
80 %pI4 1.2.3.4
81 %pi4 001.002.003.004
82 %p[Ii][hnbl]
83
84 For printing IPv4 dot-separated decimal addresses. The 'I4' and 'i4'
85 specifiers result in a printed address with ('i4') or without ('I4')
86 leading zeros.
87
88 The additional 'h', 'n', 'b', and 'l' specifiers are used to specify
89 host, network, big or little endian order addresses respectively. Where
90 no specifier is provided the default network/big endian order is used.
91
92IPv6 addresses:
93
94 %pI6 0001:0002:0003:0004:0005:0006:0007:0008
95 %pi6 00010002000300040005000600070008
96 %pI6c 1:2:3:4:5:6:7:8
97
98 For printing IPv6 network-order 16-bit hex addresses. The 'I6' and 'i6'
99 specifiers result in a printed address with ('I6') or without ('i6')
100 colon-separators. Leading zeros are always used.
101
102 The additional 'c' specifier can be used with the 'I' specifier to
103 print a compressed IPv6 address as described by
104 http://tools.ietf.org/html/rfc5952
105
106UUID/GUID addresses:
107
108 %pUb 00010203-0405-0607-0809-0a0b0c0d0e0f
109 %pUB 00010203-0405-0607-0809-0A0B0C0D0E0F
110 %pUl 03020100-0504-0706-0809-0a0b0c0e0e0f
111 %pUL 03020100-0504-0706-0809-0A0B0C0E0E0F
112
113 For printing 16-byte UUID/GUIDs addresses. The additional 'l', 'L',
114 'b' and 'B' specifiers are used to specify a little endian order in
115 lower ('l') or upper case ('L') hex characters - and big endian order
116 in lower ('b') or upper case ('B') hex characters.
117
118 Where no additional specifiers are used the default little endian
119 order with lower case hex characters will be printed.
120
121struct va_format:
122
123 %pV
124
125 For printing struct va_format structures. These contain a format string
126 and va_list as follows:
127
128 struct va_format {
129 const char *fmt;
130 va_list *va;
131 };
132
133 Do not use this feature without some mechanism to verify the
134 correctness of the format string and va_list arguments.
Randy Dunlapb67ad182008-11-12 13:26:55 -0800135
136u64 SHOULD be printed with %llu/%llx, (unsigned long long):
137
138 printk("%llu", (unsigned long long)u64_var);
139
140s64 SHOULD be printed with %lld/%llx, (long long):
141
142 printk("%lld", (long long)s64_var);
143
144If <type> is dependent on a config option for its size (e.g., sector_t,
Stepan Moskovchenkoe9ba0642013-01-21 13:27:25 -0800145blkcnt_t) or is architecture-dependent for its size (e.g., tcflag_t), use a
146format specifier of its largest possible type and explicitly cast to it.
147Example:
Randy Dunlapb67ad182008-11-12 13:26:55 -0800148
149 printk("test: sector number/total blocks: %llu/%llu\n",
150 (unsigned long long)sector, (unsigned long long)blockcount);
151
152Reminder: sizeof() result is of type size_t.
153
154Thank you for your cooperation and attention.
155
156
Andrew Murray04c55712011-06-15 12:57:09 -0700157By Randy Dunlap <rdunlap@xenotime.net> and
158Andrew Murray <amurray@mpc-data.co.uk>