~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/seq_file.h

Version: ~ [ linux-5.4-rc3 ] ~ [ linux-5.3.6 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.79 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.149 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.196 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.196 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.75 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 #ifndef _LINUX_SEQ_FILE_H
  2 #define _LINUX_SEQ_FILE_H
  3 
  4 #include <linux/types.h>
  5 #include <linux/string.h>
  6 #include <linux/mutex.h>
  7 #include <linux/cpumask.h>
  8 #include <linux/nodemask.h>
  9 
 10 struct seq_operations;
 11 struct file;
 12 struct path;
 13 struct inode;
 14 struct dentry;
 15 
 16 struct seq_file {
 17         char *buf;
 18         size_t size;
 19         size_t from;
 20         size_t count;
 21         loff_t index;
 22         loff_t read_pos;
 23         u64 version;
 24         struct mutex lock;
 25         const struct seq_operations *op;
 26         int poll_event;
 27         void *private;
 28 };
 29 
 30 struct seq_operations {
 31         void * (*start) (struct seq_file *m, loff_t *pos);
 32         void (*stop) (struct seq_file *m, void *v);
 33         void * (*next) (struct seq_file *m, void *v, loff_t *pos);
 34         int (*show) (struct seq_file *m, void *v);
 35 };
 36 
 37 #define SEQ_SKIP 1
 38 
 39 /**
 40  * seq_get_buf - get buffer to write arbitrary data to
 41  * @m: the seq_file handle
 42  * @bufp: the beginning of the buffer is stored here
 43  *
 44  * Return the number of bytes available in the buffer, or zero if
 45  * there's no space.
 46  */
 47 static inline size_t seq_get_buf(struct seq_file *m, char **bufp)
 48 {
 49         BUG_ON(m->count > m->size);
 50         if (m->count < m->size)
 51                 *bufp = m->buf + m->count;
 52         else
 53                 *bufp = NULL;
 54 
 55         return m->size - m->count;
 56 }
 57 
 58 /**
 59  * seq_commit - commit data to the buffer
 60  * @m: the seq_file handle
 61  * @num: the number of bytes to commit
 62  *
 63  * Commit @num bytes of data written to a buffer previously acquired
 64  * by seq_buf_get.  To signal an error condition, or that the data
 65  * didn't fit in the available space, pass a negative @num value.
 66  */
 67 static inline void seq_commit(struct seq_file *m, int num)
 68 {
 69         if (num < 0) {
 70                 m->count = m->size;
 71         } else {
 72                 BUG_ON(m->count + num > m->size);
 73                 m->count += num;
 74         }
 75 }
 76 
 77 char *mangle_path(char *s, char *p, char *esc);
 78 int seq_open(struct file *, const struct seq_operations *);
 79 ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
 80 loff_t seq_lseek(struct file *, loff_t, int);
 81 int seq_release(struct inode *, struct file *);
 82 int seq_escape(struct seq_file *, const char *, const char *);
 83 int seq_putc(struct seq_file *m, char c);
 84 int seq_puts(struct seq_file *m, const char *s);
 85 int seq_write(struct seq_file *seq, const void *data, size_t len);
 86 
 87 __printf(2, 3) int seq_printf(struct seq_file *, const char *, ...);
 88 
 89 int seq_path(struct seq_file *, struct path *, char *);
 90 int seq_dentry(struct seq_file *, struct dentry *, char *);
 91 int seq_path_root(struct seq_file *m, struct path *path, struct path *root,
 92                   char *esc);
 93 int seq_bitmap(struct seq_file *m, const unsigned long *bits,
 94                                    unsigned int nr_bits);
 95 static inline int seq_cpumask(struct seq_file *m, const struct cpumask *mask)
 96 {
 97         return seq_bitmap(m, cpumask_bits(mask), nr_cpu_ids);
 98 }
 99 
100 static inline int seq_nodemask(struct seq_file *m, nodemask_t *mask)
101 {
102         return seq_bitmap(m, mask->bits, MAX_NUMNODES);
103 }
104 
105 int seq_bitmap_list(struct seq_file *m, const unsigned long *bits,
106                 unsigned int nr_bits);
107 
108 static inline int seq_cpumask_list(struct seq_file *m,
109                                    const struct cpumask *mask)
110 {
111         return seq_bitmap_list(m, cpumask_bits(mask), nr_cpu_ids);
112 }
113 
114 static inline int seq_nodemask_list(struct seq_file *m, nodemask_t *mask)
115 {
116         return seq_bitmap_list(m, mask->bits, MAX_NUMNODES);
117 }
118 
119 int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
120 int single_release(struct inode *, struct file *);
121 void *__seq_open_private(struct file *, const struct seq_operations *, int);
122 int seq_open_private(struct file *, const struct seq_operations *, int);
123 int seq_release_private(struct inode *, struct file *);
124 
125 /**
126  * seq_show_options - display mount options with appropriate escapes.
127  * @m: the seq_file handle
128  * @name: the mount option name
129  * @value: the mount option name's value, can be NULL
130  */
131 static inline void seq_show_option(struct seq_file *m, const char *name,
132                                    const char *value)
133 {
134         seq_putc(m, ',');
135         seq_escape(m, name, ",= \t\n\\");
136         if (value) {
137                 seq_putc(m, '=');
138                 seq_escape(m, value, ", \t\n\\");
139         }
140 }
141 
142 /**
143  * seq_show_option_n - display mount options with appropriate escapes
144  *                     where @value must be a specific length.
145  * @m: the seq_file handle
146  * @name: the mount option name
147  * @value: the mount option name's value, cannot be NULL
148  * @length: the length of @value to display
149  *
150  * This is a macro since this uses "length" to define the size of the
151  * stack buffer.
152  */
153 #define seq_show_option_n(m, name, value, length) {     \
154         char val_buf[length + 1];                       \
155         strncpy(val_buf, value, length);                \
156         val_buf[length] = '\0';                         \
157         seq_show_option(m, name, val_buf);              \
158 }
159 
160 #define SEQ_START_TOKEN ((void *)1)
161 
162 /*
163  * Helpers for iteration over list_head-s in seq_files
164  */
165 
166 extern struct list_head *seq_list_start(struct list_head *head,
167                 loff_t pos);
168 extern struct list_head *seq_list_start_head(struct list_head *head,
169                 loff_t pos);
170 extern struct list_head *seq_list_next(void *v, struct list_head *head,
171                 loff_t *ppos);
172 
173 /*
174  * Helpers for iteration over hlist_head-s in seq_files
175  */
176 
177 extern struct hlist_node *seq_hlist_start(struct hlist_head *head,
178                                           loff_t pos);
179 extern struct hlist_node *seq_hlist_start_head(struct hlist_head *head,
180                                                loff_t pos);
181 extern struct hlist_node *seq_hlist_next(void *v, struct hlist_head *head,
182                                          loff_t *ppos);
183 
184 extern struct hlist_node *seq_hlist_start_rcu(struct hlist_head *head,
185                                               loff_t pos);
186 extern struct hlist_node *seq_hlist_start_head_rcu(struct hlist_head *head,
187                                                    loff_t pos);
188 extern struct hlist_node *seq_hlist_next_rcu(void *v,
189                                                    struct hlist_head *head,
190                                                    loff_t *ppos);
191 #endif
192 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp