1 #ifndef _LINUX_SEQ_FILE_H
2 #define _LINUX_SEQ_FILE_H
4 #include <linux/types.h>
5 #include <linux/string.h>
7 #include <linux/mutex.h>
8 #include <linux/cpumask.h>
9 #include <linux/nodemask.h>
11 struct seq_operations
;
16 struct user_namespace
;
28 const struct seq_operations
*op
;
31 struct user_namespace
*user_ns
;
36 struct seq_operations
{
37 void * (*start
) (struct seq_file
*m
, loff_t
*pos
);
38 void (*stop
) (struct seq_file
*m
, void *v
);
39 void * (*next
) (struct seq_file
*m
, void *v
, loff_t
*pos
);
40 int (*show
) (struct seq_file
*m
, void *v
);
46 * seq_has_overflowed - check if the buffer has overflowed
47 * @m: the seq_file handle
49 * seq_files have a buffer which may overflow. When this happens a larger
50 * buffer is reallocated and all the data will be printed again.
51 * The overflow state is true when m->count == m->size.
53 * Returns true if the buffer received more than it can hold.
55 static inline bool seq_has_overflowed(struct seq_file
*m
)
57 return m
->count
== m
->size
;
61 * seq_get_buf - get buffer to write arbitrary data to
62 * @m: the seq_file handle
63 * @bufp: the beginning of the buffer is stored here
65 * Return the number of bytes available in the buffer, or zero if
68 static inline size_t seq_get_buf(struct seq_file
*m
, char **bufp
)
70 BUG_ON(m
->count
> m
->size
);
71 if (m
->count
< m
->size
)
72 *bufp
= m
->buf
+ m
->count
;
76 return m
->size
- m
->count
;
80 * seq_commit - commit data to the buffer
81 * @m: the seq_file handle
82 * @num: the number of bytes to commit
84 * Commit @num bytes of data written to a buffer previously acquired
85 * by seq_buf_get. To signal an error condition, or that the data
86 * didn't fit in the available space, pass a negative @num value.
88 static inline void seq_commit(struct seq_file
*m
, int num
)
93 BUG_ON(m
->count
+ num
> m
->size
);
99 * seq_setwidth - set padding width
100 * @m: the seq_file handle
101 * @size: the max number of bytes to pad.
103 * Call seq_setwidth() for setting max width, then call seq_printf() etc. and
104 * finally call seq_pad() to pad the remaining bytes.
106 static inline void seq_setwidth(struct seq_file
*m
, size_t size
)
108 m
->pad_until
= m
->count
+ size
;
110 void seq_pad(struct seq_file
*m
, char c
);
112 char *mangle_path(char *s
, const char *p
, const char *esc
);
113 int seq_open(struct file
*, const struct seq_operations
*);
114 ssize_t
seq_read(struct file
*, char __user
*, size_t, loff_t
*);
115 loff_t
seq_lseek(struct file
*, loff_t
, int);
116 int seq_release(struct inode
*, struct file
*);
117 int seq_write(struct seq_file
*seq
, const void *data
, size_t len
);
120 void seq_vprintf(struct seq_file
*m
, const char *fmt
, va_list args
);
122 void seq_printf(struct seq_file
*m
, const char *fmt
, ...);
123 void seq_putc(struct seq_file
*m
, char c
);
124 void seq_puts(struct seq_file
*m
, const char *s
);
125 void seq_put_decimal_ull(struct seq_file
*m
, char delimiter
,
126 unsigned long long num
);
127 void seq_put_decimal_ll(struct seq_file
*m
, char delimiter
, long long num
);
128 void seq_escape(struct seq_file
*m
, const char *s
, const char *esc
);
130 void seq_hex_dump(struct seq_file
*m
, const char *prefix_str
, int prefix_type
,
131 int rowsize
, int groupsize
, const void *buf
, size_t len
,
134 int seq_path(struct seq_file
*, const struct path
*, const char *);
135 int seq_file_path(struct seq_file
*, struct file
*, const char *);
136 int seq_dentry(struct seq_file
*, struct dentry
*, const char *);
137 int seq_path_root(struct seq_file
*m
, const struct path
*path
,
138 const struct path
*root
, const char *esc
);
140 int single_open(struct file
*, int (*)(struct seq_file
*, void *), void *);
141 int single_open_size(struct file
*, int (*)(struct seq_file
*, void *), void *, size_t);
142 int single_release(struct inode
*, struct file
*);
143 void *__seq_open_private(struct file
*, const struct seq_operations
*, int);
144 int seq_open_private(struct file
*, const struct seq_operations
*, int);
145 int seq_release_private(struct inode
*, struct file
*);
147 static inline struct user_namespace
*seq_user_ns(struct seq_file
*seq
)
149 #ifdef CONFIG_USER_NS
152 extern struct user_namespace init_user_ns
;
153 return &init_user_ns
;
158 * seq_show_options - display mount options with appropriate escapes.
159 * @m: the seq_file handle
160 * @name: the mount option name
161 * @value: the mount option name's value, can be NULL
163 static inline void seq_show_option(struct seq_file
*m
, const char *name
,
167 seq_escape(m
, name
, ",= \t\n\\");
170 seq_escape(m
, value
, ", \t\n\\");
175 * seq_show_option_n - display mount options with appropriate escapes
176 * where @value must be a specific length.
177 * @m: the seq_file handle
178 * @name: the mount option name
179 * @value: the mount option name's value, cannot be NULL
180 * @length: the length of @value to display
182 * This is a macro since this uses "length" to define the size of the
185 #define seq_show_option_n(m, name, value, length) { \
186 char val_buf[length + 1]; \
187 strncpy(val_buf, value, length); \
188 val_buf[length] = '\0'; \
189 seq_show_option(m, name, val_buf); \
192 #define SEQ_START_TOKEN ((void *)1)
194 * Helpers for iteration over list_head-s in seq_files
197 extern struct list_head
*seq_list_start(struct list_head
*head
,
199 extern struct list_head
*seq_list_start_head(struct list_head
*head
,
201 extern struct list_head
*seq_list_next(void *v
, struct list_head
*head
,
205 * Helpers for iteration over hlist_head-s in seq_files
208 extern struct hlist_node
*seq_hlist_start(struct hlist_head
*head
,
210 extern struct hlist_node
*seq_hlist_start_head(struct hlist_head
*head
,
212 extern struct hlist_node
*seq_hlist_next(void *v
, struct hlist_head
*head
,
215 extern struct hlist_node
*seq_hlist_start_rcu(struct hlist_head
*head
,
217 extern struct hlist_node
*seq_hlist_start_head_rcu(struct hlist_head
*head
,
219 extern struct hlist_node
*seq_hlist_next_rcu(void *v
,
220 struct hlist_head
*head
,
223 /* Helpers for iterating over per-cpu hlist_head-s in seq_files */
224 extern struct hlist_node
*seq_hlist_start_percpu(struct hlist_head __percpu
*head
, int *cpu
, loff_t pos
);
226 extern struct hlist_node
*seq_hlist_next_percpu(void *v
, struct hlist_head __percpu
*head
, int *cpu
, loff_t
*pos
);