1 .. SPDX-License-Identifier: GPL-2.0 1 .. SPDX-License-Identifier: GPL-2.0
2 2
3 ====================== 3 ======================
4 The seq_file Interface 4 The seq_file Interface
5 ====================== 5 ======================
6 6
7 Copyright 2003 Jonathan Corbet <corbet@ 7 Copyright 2003 Jonathan Corbet <corbet@lwn.net>
8 8
9 This file is originally from the LWN.n 9 This file is originally from the LWN.net Driver Porting series at
10 https://lwn.net/Articles/driver-portin 10 https://lwn.net/Articles/driver-porting/
11 11
12 12
13 There are numerous ways for a device driver (o 13 There are numerous ways for a device driver (or other kernel component) to
14 provide information to the user or system admi 14 provide information to the user or system administrator. One useful
15 technique is the creation of virtual files, in 15 technique is the creation of virtual files, in debugfs, /proc or elsewhere.
16 Virtual files can provide human-readable outpu 16 Virtual files can provide human-readable output that is easy to get at
17 without any special utility programs; they can 17 without any special utility programs; they can also make life easier for
18 script writers. It is not surprising that the 18 script writers. It is not surprising that the use of virtual files has
19 grown over the years. 19 grown over the years.
20 20
21 Creating those files correctly has always been 21 Creating those files correctly has always been a bit of a challenge,
22 however. It is not that hard to make a virtual 22 however. It is not that hard to make a virtual file which returns a
23 string. But life gets trickier if the output i 23 string. But life gets trickier if the output is long - anything greater
24 than an application is likely to read in a sin 24 than an application is likely to read in a single operation. Handling
25 multiple reads (and seeks) requires careful at 25 multiple reads (and seeks) requires careful attention to the reader's
26 position within the virtual file - that positi 26 position within the virtual file - that position is, likely as not, in the
27 middle of a line of output. The kernel has tra 27 middle of a line of output. The kernel has traditionally had a number of
28 implementations that got this wrong. 28 implementations that got this wrong.
29 29
30 The 2.6 kernel contains a set of functions (im 30 The 2.6 kernel contains a set of functions (implemented by Alexander Viro)
31 which are designed to make it easy for virtual 31 which are designed to make it easy for virtual file creators to get it
32 right. 32 right.
33 33
34 The seq_file interface is available via <linux 34 The seq_file interface is available via <linux/seq_file.h>. There are
35 three aspects to seq_file: 35 three aspects to seq_file:
36 36
37 * An iterator interface which lets a virt 37 * An iterator interface which lets a virtual file implementation
38 step through the objects it is presenti 38 step through the objects it is presenting.
39 39
40 * Some utility functions for formatting o 40 * Some utility functions for formatting objects for output without
41 needing to worry about things like outp 41 needing to worry about things like output buffers.
42 42
43 * A set of canned file_operations which i 43 * A set of canned file_operations which implement most operations on
44 the virtual file. 44 the virtual file.
45 45
46 We'll look at the seq_file interface via an ex 46 We'll look at the seq_file interface via an extremely simple example: a
47 loadable module which creates a file called /p 47 loadable module which creates a file called /proc/sequence. The file, when
48 read, simply produces a set of increasing inte 48 read, simply produces a set of increasing integer values, one per line. The
49 sequence will continue until the user loses pa 49 sequence will continue until the user loses patience and finds something
50 better to do. The file is seekable, in that on 50 better to do. The file is seekable, in that one can do something like the
51 following:: 51 following::
52 52
53 dd if=/proc/sequence of=out1 count=1 53 dd if=/proc/sequence of=out1 count=1
54 dd if=/proc/sequence skip=1 of=out2 count= 54 dd if=/proc/sequence skip=1 of=out2 count=1
55 55
56 Then concatenate the output files out1 and out 56 Then concatenate the output files out1 and out2 and get the right
57 result. Yes, it is a thoroughly useless module 57 result. Yes, it is a thoroughly useless module, but the point is to show
58 how the mechanism works without getting lost i 58 how the mechanism works without getting lost in other details. (Those
59 wanting to see the full source for this module 59 wanting to see the full source for this module can find it at
60 https://lwn.net/Articles/22359/). 60 https://lwn.net/Articles/22359/).
61 61
62 Deprecated create_proc_entry 62 Deprecated create_proc_entry
63 ============================ 63 ============================
64 64
65 Note that the above article uses create_proc_e 65 Note that the above article uses create_proc_entry which was removed in
66 kernel 3.10. Current versions require the foll 66 kernel 3.10. Current versions require the following update::
67 67
68 - entry = create_proc_entry("sequence", 68 - entry = create_proc_entry("sequence", 0, NULL);
69 - if (entry) 69 - if (entry)
70 - entry->proc_fops = &ct_file_op 70 - entry->proc_fops = &ct_file_ops;
71 + entry = proc_create("sequence", 0, NUL 71 + entry = proc_create("sequence", 0, NULL, &ct_file_ops);
72 72
73 The iterator interface 73 The iterator interface
74 ====================== 74 ======================
75 75
76 Modules implementing a virtual file with seq_f 76 Modules implementing a virtual file with seq_file must implement an
77 iterator object that allows stepping through t 77 iterator object that allows stepping through the data of interest
78 during a "session" (roughly one read() system 78 during a "session" (roughly one read() system call). If the iterator
79 is able to move to a specific position - like 79 is able to move to a specific position - like the file they implement,
80 though with freedom to map the position number 80 though with freedom to map the position number to a sequence location
81 in whatever way is convenient - the iterator n 81 in whatever way is convenient - the iterator need only exist
82 transiently during a session. If the iterator 82 transiently during a session. If the iterator cannot easily find a
83 numerical position but works well with a first 83 numerical position but works well with a first/next interface, the
84 iterator can be stored in the private data are 84 iterator can be stored in the private data area and continue from one
85 session to the next. 85 session to the next.
86 86
87 A seq_file implementation that is formatting f 87 A seq_file implementation that is formatting firewall rules from a
88 table, for example, could provide a simple ite 88 table, for example, could provide a simple iterator that interprets
89 position N as the Nth rule in the chain. A se 89 position N as the Nth rule in the chain. A seq_file implementation
90 that presents the content of a, potentially vo 90 that presents the content of a, potentially volatile, linked list
91 might record a pointer into that list, providi 91 might record a pointer into that list, providing that can be done
92 without risk of the current location being rem 92 without risk of the current location being removed.
93 93
94 Positioning can thus be done in whatever way m 94 Positioning can thus be done in whatever way makes the most sense for
95 the generator of the data, which need not be a 95 the generator of the data, which need not be aware of how a position
96 translates to an offset in the virtual file. T 96 translates to an offset in the virtual file. The one obvious exception
97 is that a position of zero should indicate the 97 is that a position of zero should indicate the beginning of the file.
98 98
99 The /proc/sequence iterator just uses the coun 99 The /proc/sequence iterator just uses the count of the next number it
100 will output as its position. 100 will output as its position.
101 101
102 Four functions must be implemented to make the 102 Four functions must be implemented to make the iterator work. The
103 first, called start(), starts a session and ta 103 first, called start(), starts a session and takes a position as an
104 argument, returning an iterator which will sta 104 argument, returning an iterator which will start reading at that
105 position. The pos passed to start() will alwa 105 position. The pos passed to start() will always be either zero, or
106 the most recent pos used in the previous sessi 106 the most recent pos used in the previous session.
107 107
108 For our simple sequence example, 108 For our simple sequence example,
109 the start() function looks like:: 109 the start() function looks like::
110 110
111 static void *ct_seq_start(struct seq_f 111 static void *ct_seq_start(struct seq_file *s, loff_t *pos)
112 { 112 {
113 loff_t *spos = kmalloc(sizeof( 113 loff_t *spos = kmalloc(sizeof(loff_t), GFP_KERNEL);
114 if (! spos) 114 if (! spos)
115 return NULL; 115 return NULL;
116 *spos = *pos; 116 *spos = *pos;
117 return spos; 117 return spos;
118 } 118 }
119 119
120 The entire data structure for this iterator is 120 The entire data structure for this iterator is a single loff_t value
121 holding the current position. There is no uppe 121 holding the current position. There is no upper bound for the sequence
122 iterator, but that will not be the case for mo 122 iterator, but that will not be the case for most other seq_file
123 implementations; in most cases the start() fun 123 implementations; in most cases the start() function should check for a
124 "past end of file" condition and return NULL i 124 "past end of file" condition and return NULL if need be.
125 125
126 For more complicated applications, the private 126 For more complicated applications, the private field of the seq_file
127 structure can be used to hold state from sessi 127 structure can be used to hold state from session to session. There is
128 also a special value which can be returned by 128 also a special value which can be returned by the start() function
129 called SEQ_START_TOKEN; it can be used if you 129 called SEQ_START_TOKEN; it can be used if you wish to instruct your
130 show() function (described below) to print a h 130 show() function (described below) to print a header at the top of the
131 output. SEQ_START_TOKEN should only be used if 131 output. SEQ_START_TOKEN should only be used if the offset is zero,
132 however. SEQ_START_TOKEN has no special meani !! 132 however.
133 code. It is provided as a convenience for a s <<
134 communicate with the next() and show() functio <<
135 133
136 The next function to implement is called, amaz 134 The next function to implement is called, amazingly, next(); its job is to
137 move the iterator forward to the next position 135 move the iterator forward to the next position in the sequence. The
138 example module can simply increment the positi 136 example module can simply increment the position by one; more useful
139 modules will do what is needed to step through 137 modules will do what is needed to step through some data structure. The
140 next() function returns a new iterator, or NUL 138 next() function returns a new iterator, or NULL if the sequence is
141 complete. Here's the example version:: 139 complete. Here's the example version::
142 140
143 static void *ct_seq_next(struct seq_fi 141 static void *ct_seq_next(struct seq_file *s, void *v, loff_t *pos)
144 { 142 {
145 loff_t *spos = v; 143 loff_t *spos = v;
146 *pos = ++*spos; 144 *pos = ++*spos;
147 return spos; 145 return spos;
148 } 146 }
149 147
150 The next() function should set ``*pos`` to a v <<
151 to find the new location in the sequence. Whe <<
152 stored in the private data area, rather than b <<
153 start(), it might seem sufficient to simply se <<
154 value (zero always tells start() to restart th <<
155 sufficient due to historical problems. <<
156 <<
157 Historically, many next() functions have *not* <<
158 end-of-file. If the value is then used by sta <<
159 iterator, this can result in corner cases wher <<
160 sequence is reported twice in the file. In or <<
161 from being resurrected, the core seq_file code <<
162 a next() function does not change the value of <<
163 next() function *must* change the value of ``* <<
164 set it to a non-zero value. <<
165 <<
166 The stop() function closes a session; its job, 148 The stop() function closes a session; its job, of course, is to clean
167 up. If dynamic memory is allocated for the ite 149 up. If dynamic memory is allocated for the iterator, stop() is the
168 place to free it; if a lock was taken by start 150 place to free it; if a lock was taken by start(), stop() must release
169 that lock. The value that ``*pos`` was set to 151 that lock. The value that ``*pos`` was set to by the last next() call
170 before stop() is remembered, and used for the 152 before stop() is remembered, and used for the first start() call of
171 the next session unless lseek() has been calle 153 the next session unless lseek() has been called on the file; in that
172 case next start() will be asked to start at po 154 case next start() will be asked to start at position zero::
173 155
174 static void ct_seq_stop(struct seq_fil 156 static void ct_seq_stop(struct seq_file *s, void *v)
175 { 157 {
176 kfree(v); 158 kfree(v);
177 } 159 }
178 160
179 Finally, the show() function should format the 161 Finally, the show() function should format the object currently pointed to
180 by the iterator for output. The example modul 162 by the iterator for output. The example module's show() function is::
181 163
182 static int ct_seq_show(struct seq_file 164 static int ct_seq_show(struct seq_file *s, void *v)
183 { 165 {
184 loff_t *spos = v; 166 loff_t *spos = v;
185 seq_printf(s, "%lld\n", (long 167 seq_printf(s, "%lld\n", (long long)*spos);
186 return 0; 168 return 0;
187 } 169 }
188 170
189 If all is well, the show() function should ret 171 If all is well, the show() function should return zero. A negative error
190 code in the usual manner indicates that someth 172 code in the usual manner indicates that something went wrong; it will be
191 passed back to user space. This function can 173 passed back to user space. This function can also return SEQ_SKIP, which
192 causes the current item to be skipped; if the 174 causes the current item to be skipped; if the show() function has already
193 generated output before returning SEQ_SKIP, th 175 generated output before returning SEQ_SKIP, that output will be dropped.
194 176
195 We will look at seq_printf() in a moment. But 177 We will look at seq_printf() in a moment. But first, the definition of the
196 seq_file iterator is finished by creating a se 178 seq_file iterator is finished by creating a seq_operations structure with
197 the four functions we have just defined:: 179 the four functions we have just defined::
198 180
199 static const struct seq_operations ct_ 181 static const struct seq_operations ct_seq_ops = {
200 .start = ct_seq_start, 182 .start = ct_seq_start,
201 .next = ct_seq_next, 183 .next = ct_seq_next,
202 .stop = ct_seq_stop, 184 .stop = ct_seq_stop,
203 .show = ct_seq_show 185 .show = ct_seq_show
204 }; 186 };
205 187
206 This structure will be needed to tie our itera 188 This structure will be needed to tie our iterator to the /proc file in
207 a little bit. 189 a little bit.
208 190
209 It's worth noting that the iterator value retu 191 It's worth noting that the iterator value returned by start() and
210 manipulated by the other functions is consider 192 manipulated by the other functions is considered to be completely opaque by
211 the seq_file code. It can thus be anything tha 193 the seq_file code. It can thus be anything that is useful in stepping
212 through the data to be output. Counters can be 194 through the data to be output. Counters can be useful, but it could also be
213 a direct pointer into an array or linked list. 195 a direct pointer into an array or linked list. Anything goes, as long as
214 the programmer is aware that things can happen 196 the programmer is aware that things can happen between calls to the
215 iterator function. However, the seq_file code 197 iterator function. However, the seq_file code (by design) will not sleep
216 between the calls to start() and stop(), so ho 198 between the calls to start() and stop(), so holding a lock during that time
217 is a reasonable thing to do. The seq_file code 199 is a reasonable thing to do. The seq_file code will also avoid taking any
218 other locks while the iterator is active. 200 other locks while the iterator is active.
219 <<
220 The iterator value returned by start() or next <<
221 passed to a subsequent next() or stop() call. <<
222 such as locks that were taken to be reliably r <<
223 guarantee that the iterator will be passed to <<
224 it often will be. <<
225 201
226 202
227 Formatted output 203 Formatted output
228 ================ 204 ================
229 205
230 The seq_file code manages positioning within t 206 The seq_file code manages positioning within the output created by the
231 iterator and getting it into the user's buffer 207 iterator and getting it into the user's buffer. But, for that to work, that
232 output must be passed to the seq_file code. So 208 output must be passed to the seq_file code. Some utility functions have
233 been defined which make this task easy. 209 been defined which make this task easy.
234 210
235 Most code will simply use seq_printf(), which 211 Most code will simply use seq_printf(), which works pretty much like
236 printk(), but which requires the seq_file poin 212 printk(), but which requires the seq_file pointer as an argument.
237 213
238 For straight character output, the following f 214 For straight character output, the following functions may be used::
239 215
240 seq_putc(struct seq_file *m, char c); 216 seq_putc(struct seq_file *m, char c);
241 seq_puts(struct seq_file *m, const cha 217 seq_puts(struct seq_file *m, const char *s);
242 seq_escape(struct seq_file *m, const c 218 seq_escape(struct seq_file *m, const char *s, const char *esc);
243 219
244 The first two output a single character and a 220 The first two output a single character and a string, just like one would
245 expect. seq_escape() is like seq_puts(), excep 221 expect. seq_escape() is like seq_puts(), except that any character in s
246 which is in the string esc will be represented 222 which is in the string esc will be represented in octal form in the output.
247 223
248 There are also a pair of functions for printin 224 There are also a pair of functions for printing filenames::
249 225
250 int seq_path(struct seq_file *m, const 226 int seq_path(struct seq_file *m, const struct path *path,
251 const char *esc); 227 const char *esc);
252 int seq_path_root(struct seq_file *m, 228 int seq_path_root(struct seq_file *m, const struct path *path,
253 const struct path *r 229 const struct path *root, const char *esc)
254 230
255 Here, path indicates the file of interest, and 231 Here, path indicates the file of interest, and esc is a set of characters
256 which should be escaped in the output. A call 232 which should be escaped in the output. A call to seq_path() will output
257 the path relative to the current process's fil 233 the path relative to the current process's filesystem root. If a different
258 root is desired, it can be used with seq_path_ 234 root is desired, it can be used with seq_path_root(). If it turns out that
259 path cannot be reached from root, seq_path_roo 235 path cannot be reached from root, seq_path_root() returns SEQ_SKIP.
260 236
261 A function producing complicated output may wa 237 A function producing complicated output may want to check::
262 238
263 bool seq_has_overflowed(struct seq_fil 239 bool seq_has_overflowed(struct seq_file *m);
264 240
265 and avoid further seq_<output> calls if true i 241 and avoid further seq_<output> calls if true is returned.
266 242
267 A true return from seq_has_overflowed means th 243 A true return from seq_has_overflowed means that the seq_file buffer will
268 be discarded and the seq_show function will at 244 be discarded and the seq_show function will attempt to allocate a larger
269 buffer and retry printing. 245 buffer and retry printing.
270 246
271 247
272 Making it all work 248 Making it all work
273 ================== 249 ==================
274 250
275 So far, we have a nice set of functions which 251 So far, we have a nice set of functions which can produce output within the
276 seq_file system, but we have not yet turned th 252 seq_file system, but we have not yet turned them into a file that a user
277 can see. Creating a file within the kernel req 253 can see. Creating a file within the kernel requires, of course, the
278 creation of a set of file_operations which imp 254 creation of a set of file_operations which implement the operations on that
279 file. The seq_file interface provides a set of 255 file. The seq_file interface provides a set of canned operations which do
280 most of the work. The virtual file author stil 256 most of the work. The virtual file author still must implement the open()
281 method, however, to hook everything up. The op 257 method, however, to hook everything up. The open function is often a single
282 line, as in the example module:: 258 line, as in the example module::
283 259
284 static int ct_open(struct inode *inode 260 static int ct_open(struct inode *inode, struct file *file)
285 { 261 {
286 return seq_open(file, &ct_seq_ 262 return seq_open(file, &ct_seq_ops);
287 } 263 }
288 264
289 Here, the call to seq_open() takes the seq_ope 265 Here, the call to seq_open() takes the seq_operations structure we created
290 before, and gets set up to iterate through the 266 before, and gets set up to iterate through the virtual file.
291 267
292 On a successful open, seq_open() stores the st 268 On a successful open, seq_open() stores the struct seq_file pointer in
293 file->private_data. If you have an application 269 file->private_data. If you have an application where the same iterator can
294 be used for more than one file, you can store 270 be used for more than one file, you can store an arbitrary pointer in the
295 private field of the seq_file structure; that 271 private field of the seq_file structure; that value can then be retrieved
296 by the iterator functions. 272 by the iterator functions.
297 273
298 There is also a wrapper function to seq_open() 274 There is also a wrapper function to seq_open() called seq_open_private(). It
299 kmallocs a zero filled block of memory and sto 275 kmallocs a zero filled block of memory and stores a pointer to it in the
300 private field of the seq_file structure, retur 276 private field of the seq_file structure, returning 0 on success. The
301 block size is specified in a third parameter t 277 block size is specified in a third parameter to the function, e.g.::
302 278
303 static int ct_open(struct inode *inode 279 static int ct_open(struct inode *inode, struct file *file)
304 { 280 {
305 return seq_open_private(file, 281 return seq_open_private(file, &ct_seq_ops,
306 sizeof 282 sizeof(struct mystruct));
307 } 283 }
308 284
309 There is also a variant function, __seq_open_p 285 There is also a variant function, __seq_open_private(), which is functionally
310 identical except that, if successful, it retur 286 identical except that, if successful, it returns the pointer to the allocated
311 memory block, allowing further initialisation 287 memory block, allowing further initialisation e.g.::
312 288
313 static int ct_open(struct inode *inode 289 static int ct_open(struct inode *inode, struct file *file)
314 { 290 {
315 struct mystruct *p = 291 struct mystruct *p =
316 __seq_open_private(fil 292 __seq_open_private(file, &ct_seq_ops, sizeof(*p));
317 293
318 if (!p) 294 if (!p)
319 return -ENOMEM; 295 return -ENOMEM;
320 296
321 p->foo = bar; /* initialize my 297 p->foo = bar; /* initialize my stuff */
322 ... 298 ...
323 p->baz = true; 299 p->baz = true;
324 300
325 return 0; 301 return 0;
326 } 302 }
327 303
328 A corresponding close function, seq_release_pr 304 A corresponding close function, seq_release_private() is available which
329 frees the memory allocated in the correspondin 305 frees the memory allocated in the corresponding open.
330 306
331 The other operations of interest - read(), lls 307 The other operations of interest - read(), llseek(), and release() - are
332 all implemented by the seq_file code itself. S 308 all implemented by the seq_file code itself. So a virtual file's
333 file_operations structure will look like:: 309 file_operations structure will look like::
334 310
335 static const struct file_operations ct 311 static const struct file_operations ct_file_ops = {
336 .owner = THIS_MODULE, 312 .owner = THIS_MODULE,
337 .open = ct_open, 313 .open = ct_open,
338 .read = seq_read, 314 .read = seq_read,
339 .llseek = seq_lseek, 315 .llseek = seq_lseek,
340 .release = seq_release 316 .release = seq_release
341 }; 317 };
342 318
343 There is also a seq_release_private() which pa 319 There is also a seq_release_private() which passes the contents of the
344 seq_file private field to kfree() before relea 320 seq_file private field to kfree() before releasing the structure.
345 321
346 The final step is the creation of the /proc fi 322 The final step is the creation of the /proc file itself. In the example
347 code, that is done in the initialization code 323 code, that is done in the initialization code in the usual way::
348 324
349 static int ct_init(void) 325 static int ct_init(void)
350 { 326 {
351 struct proc_dir_entry *entry; 327 struct proc_dir_entry *entry;
352 328
353 proc_create("sequence", 0, NUL 329 proc_create("sequence", 0, NULL, &ct_file_ops);
354 return 0; 330 return 0;
355 } 331 }
356 332
357 module_init(ct_init); 333 module_init(ct_init);
358 334
359 And that is pretty much it. 335 And that is pretty much it.
360 336
361 337
362 seq_list 338 seq_list
363 ======== 339 ========
364 340
365 If your file will be iterating through a linke 341 If your file will be iterating through a linked list, you may find these
366 routines useful:: 342 routines useful::
367 343
368 struct list_head *seq_list_start(struc 344 struct list_head *seq_list_start(struct list_head *head,
369 loff_ 345 loff_t pos);
370 struct list_head *seq_list_start_head( 346 struct list_head *seq_list_start_head(struct list_head *head,
371 347 loff_t pos);
372 struct list_head *seq_list_next(void * 348 struct list_head *seq_list_next(void *v, struct list_head *head,
373 loff_t 349 loff_t *ppos);
374 350
375 These helpers will interpret pos as a position 351 These helpers will interpret pos as a position within the list and iterate
376 accordingly. Your start() and next() function 352 accordingly. Your start() and next() functions need only invoke the
377 ``seq_list_*`` helpers with a pointer to the a 353 ``seq_list_*`` helpers with a pointer to the appropriate list_head structure.
378 354
379 355
380 The extra-simple version 356 The extra-simple version
381 ======================== 357 ========================
382 358
383 For extremely simple virtual files, there is a 359 For extremely simple virtual files, there is an even easier interface. A
384 module can define only the show() function, wh 360 module can define only the show() function, which should create all the
385 output that the virtual file will contain. The 361 output that the virtual file will contain. The file's open() method then
386 calls:: 362 calls::
387 363
388 int single_open(struct file *file, 364 int single_open(struct file *file,
389 int (*show)(struct seq 365 int (*show)(struct seq_file *m, void *p),
390 void *data); 366 void *data);
391 367
392 When output time comes, the show() function wi 368 When output time comes, the show() function will be called once. The data
393 value given to single_open() can be found in t 369 value given to single_open() can be found in the private field of the
394 seq_file structure. When using single_open(), 370 seq_file structure. When using single_open(), the programmer should use
395 single_release() instead of seq_release() in t 371 single_release() instead of seq_release() in the file_operations structure
396 to avoid a memory leak. 372 to avoid a memory leak.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.