aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/filesystems/seq_file.txt
diff options
context:
space:
mode:
authorGreg Kroah-Hartman <gregkh@linuxfoundation.org>2014-09-14 22:17:40 -0700
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2014-09-14 22:17:40 -0700
commit882ebfc28c389be86535bda4a7d9e407020356bf (patch)
treee8f3ddeda13196f40040f3ba4701ece5d38c63cc /Documentation/filesystems/seq_file.txt
parent1c84cd48a117486166f3597c081b170b76e5bd81 (diff)
parent9e82bf014195d6f0054982c463575cdce24292be (diff)
downloadkernel_replicant_linux-882ebfc28c389be86535bda4a7d9e407020356bf.tar.gz
kernel_replicant_linux-882ebfc28c389be86535bda4a7d9e407020356bf.tar.bz2
kernel_replicant_linux-882ebfc28c389be86535bda4a7d9e407020356bf.zip
Merge 3.17-rc5 into tty-next
We want those fixes in here as well. Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/filesystems/seq_file.txt')
-rw-r--r--Documentation/filesystems/seq_file.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/Documentation/filesystems/seq_file.txt b/Documentation/filesystems/seq_file.txt
index 1fe0ccb1af55..8ea3e90ace07 100644
--- a/Documentation/filesystems/seq_file.txt
+++ b/Documentation/filesystems/seq_file.txt
@@ -235,6 +235,39 @@ be used for more than one file, you can store an arbitrary pointer in the
private field of the seq_file structure; that value can then be retrieved
by the iterator functions.
+There is also a wrapper function to seq_open() called seq_open_private(). It
+kmallocs a zero filled block of memory and stores a pointer to it in the
+private field of the seq_file structure, returning 0 on success. The
+block size is specified in a third parameter to the function, e.g.:
+
+ static int ct_open(struct inode *inode, struct file *file)
+ {
+ return seq_open_private(file, &ct_seq_ops,
+ sizeof(struct mystruct));
+ }
+
+There is also a variant function, __seq_open_private(), which is functionally
+identical except that, if successful, it returns the pointer to the allocated
+memory block, allowing further initialisation e.g.:
+
+ static int ct_open(struct inode *inode, struct file *file)
+ {
+ struct mystruct *p =
+ __seq_open_private(file, &ct_seq_ops, sizeof(*p));
+
+ if (!p)
+ return -ENOMEM;
+
+ p->foo = bar; /* initialize my stuff */
+ ...
+ p->baz = true;
+
+ return 0;
+ }
+
+A corresponding close function, seq_release_private() is available which
+frees the memory allocated in the corresponding open.
+
The other operations of interest - read(), llseek(), and release() - are
all implemented by the seq_file code itself. So a virtual file's
file_operations structure will look like: