Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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/bug.h>
7#include <linux/mutex.h>
8#include <linux/cpumask.h>
9#include <linux/nodemask.h>
10
11struct seq_operations;
12struct file;
13struct path;
14struct inode;
15struct dentry;
16struct user_namespace;
17
18struct seq_file {
19 char *buf;
20 size_t size;
21 size_t from;
22 size_t count;
23 size_t pad_until;
24 loff_t index;
25 loff_t read_pos;
26 u64 version;
27 struct mutex lock;
28 const struct seq_operations *op;
29 int poll_event;
30#ifdef CONFIG_USER_NS
31 struct user_namespace *user_ns;
32#endif
33 void *private;
34};
35
36struct 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);
41};
42
43#define SEQ_SKIP 1
44
45/**
46 * seq_has_overflowed - check if the buffer has overflowed
47 * @m: the seq_file handle
48 *
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.
52 *
53 * Returns true if the buffer received more than it can hold.
54 */
55static inline bool seq_has_overflowed(struct seq_file *m)
56{
57 return m->count == m->size;
58}
59
60/**
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
64 *
65 * Return the number of bytes available in the buffer, or zero if
66 * there's no space.
67 */
68static inline size_t seq_get_buf(struct seq_file *m, char **bufp)
69{
70 BUG_ON(m->count > m->size);
71 if (m->count < m->size)
72 *bufp = m->buf + m->count;
73 else
74 *bufp = NULL;
75
76 return m->size - m->count;
77}
78
79/**
80 * seq_commit - commit data to the buffer
81 * @m: the seq_file handle
82 * @num: the number of bytes to commit
83 *
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.
87 */
88static inline void seq_commit(struct seq_file *m, int num)
89{
90 if (num < 0) {
91 m->count = m->size;
92 } else {
93 BUG_ON(m->count + num > m->size);
94 m->count += num;
95 }
96}
97
98/**
99 * seq_setwidth - set padding width
100 * @m: the seq_file handle
101 * @size: the max number of bytes to pad.
102 *
103 * Call seq_setwidth() for setting max width, then call seq_printf() etc. and
104 * finally call seq_pad() to pad the remaining bytes.
105 */
106static inline void seq_setwidth(struct seq_file *m, size_t size)
107{
108 m->pad_until = m->count + size;
109}
110void seq_pad(struct seq_file *m, char c);
111
112char *mangle_path(char *s, const char *p, const char *esc);
113int seq_open(struct file *, const struct seq_operations *);
114ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
115loff_t seq_lseek(struct file *, loff_t, int);
116int seq_release(struct inode *, struct file *);
117int seq_escape(struct seq_file *, const char *, const char *);
118int seq_putc(struct seq_file *m, char c);
119int seq_puts(struct seq_file *m, const char *s);
120int seq_write(struct seq_file *seq, const void *data, size_t len);
121
122__printf(2, 3) int seq_printf(struct seq_file *, const char *, ...);
123__printf(2, 0) int seq_vprintf(struct seq_file *, const char *, va_list args);
124
125int seq_path(struct seq_file *, const struct path *, const char *);
126int seq_dentry(struct seq_file *, struct dentry *, const char *);
127int seq_path_root(struct seq_file *m, const struct path *path,
128 const struct path *root, const char *esc);
129int seq_bitmap(struct seq_file *m, const unsigned long *bits,
130 unsigned int nr_bits);
131static inline int seq_cpumask(struct seq_file *m, const struct cpumask *mask)
132{
133 return seq_bitmap(m, cpumask_bits(mask), nr_cpu_ids);
134}
135
136static inline int seq_nodemask(struct seq_file *m, nodemask_t *mask)
137{
138 return seq_bitmap(m, mask->bits, MAX_NUMNODES);
139}
140
141int seq_bitmap_list(struct seq_file *m, const unsigned long *bits,
142 unsigned int nr_bits);
143
144static inline int seq_cpumask_list(struct seq_file *m,
145 const struct cpumask *mask)
146{
147 return seq_bitmap_list(m, cpumask_bits(mask), nr_cpu_ids);
148}
149
150static inline int seq_nodemask_list(struct seq_file *m, nodemask_t *mask)
151{
152 return seq_bitmap_list(m, mask->bits, MAX_NUMNODES);
153}
154
155int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
156int single_open_size(struct file *, int (*)(struct seq_file *, void *), void *, size_t);
157int single_release(struct inode *, struct file *);
158void *__seq_open_private(struct file *, const struct seq_operations *, int);
159int seq_open_private(struct file *, const struct seq_operations *, int);
160int seq_release_private(struct inode *, struct file *);
161int seq_put_decimal_ull(struct seq_file *m, char delimiter,
162 unsigned long long num);
163int seq_put_decimal_ll(struct seq_file *m, char delimiter,
164 long long num);
165
166static inline struct user_namespace *seq_user_ns(struct seq_file *seq)
167{
168#ifdef CONFIG_USER_NS
169 return seq->user_ns;
170#else
171 extern struct user_namespace init_user_ns;
172 return &init_user_ns;
173#endif
174}
175
176#define SEQ_START_TOKEN ((void *)1)
177/*
178 * Helpers for iteration over list_head-s in seq_files
179 */
180
181extern struct list_head *seq_list_start(struct list_head *head,
182 loff_t pos);
183extern struct list_head *seq_list_start_head(struct list_head *head,
184 loff_t pos);
185extern struct list_head *seq_list_next(void *v, struct list_head *head,
186 loff_t *ppos);
187
188/*
189 * Helpers for iteration over hlist_head-s in seq_files
190 */
191
192extern struct hlist_node *seq_hlist_start(struct hlist_head *head,
193 loff_t pos);
194extern struct hlist_node *seq_hlist_start_head(struct hlist_head *head,
195 loff_t pos);
196extern struct hlist_node *seq_hlist_next(void *v, struct hlist_head *head,
197 loff_t *ppos);
198
199extern struct hlist_node *seq_hlist_start_rcu(struct hlist_head *head,
200 loff_t pos);
201extern struct hlist_node *seq_hlist_start_head_rcu(struct hlist_head *head,
202 loff_t pos);
203extern struct hlist_node *seq_hlist_next_rcu(void *v,
204 struct hlist_head *head,
205 loff_t *ppos);
206
207/* Helpers for iterating over per-cpu hlist_head-s in seq_files */
208extern struct hlist_node *seq_hlist_start_percpu(struct hlist_head __percpu *head, int *cpu, loff_t pos);
209
210extern struct hlist_node *seq_hlist_next_percpu(void *v, struct hlist_head __percpu *head, int *cpu, loff_t *pos);
211
212#endif