Whamcloud - gitweb
LU-8066 obd: harden debugfs handling
[fs/lustre-release.git] / lustre / include / lprocfs_status.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/include/lprocfs_status.h
33  *
34  * Top level header file for LProc
35  *
36  * Author: Hariharan Thantry thantry@users.sourceforge.net
37  */
38 #ifndef _LPROCFS_STATUS_H
39 #define _LPROCFS_STATUS_H
40
41 #include <linux/fs.h>
42 #include <linux/proc_fs.h>
43 #include <linux/debugfs.h>
44 #include <linux/rwsem.h>
45 #include <linux/spinlock.h>
46 #include <linux/seq_file.h>
47
48 #include <libcfs/libcfs.h>
49 #include <uapi/linux/lustre/lustre_idl.h>
50
51 struct lprocfs_vars {
52         const char                      *name;
53         const struct file_operations    *fops;
54         void                            *data;
55         /**
56          * /proc file mode.
57          */
58         mode_t                           proc_mode;
59 };
60
61 static inline unsigned int pct(unsigned long a, unsigned long b)
62 {
63         return b ? a * 100 / b : 0;
64 }
65
66 #define PAGES_TO_MiB(pages)     ((pages) >> (20 - PAGE_SHIFT))
67 #define MiB_TO_PAGES(mb)        ((mb) << (20 - PAGE_SHIFT))
68
69 /**
70  * Append a space separated list of current set flags to str.
71  */
72 #define flag2str(port, flag)                                            \
73         do {                                                            \
74                 if ((port)->port##_##flag) {                            \
75                         seq_printf(m, "%s" #flag, first ? "" : ", ");   \
76                         first = false;                                  \
77                 }                                                       \
78         } while (0)
79
80 void obd_connect_seq_flags2str(struct seq_file *m, __u64 flags, __u64 flags2,
81                                const char *sep);
82 void obd_connect_data_seqprint(struct seq_file *m,
83                                struct obd_connect_data *ocd);
84
85 /* if we find more consumers this could be generalized */
86 #define OBD_HIST_MAX 32
87 struct obd_histogram {
88         spinlock_t      oh_lock;
89         unsigned long   oh_buckets[OBD_HIST_MAX];
90 };
91
92 enum {
93         BRW_R_PAGES = 0,
94         BRW_W_PAGES,
95         BRW_R_RPC_HIST,
96         BRW_W_RPC_HIST,
97         BRW_R_IO_TIME,
98         BRW_W_IO_TIME,
99         BRW_R_DISCONT_PAGES,
100         BRW_W_DISCONT_PAGES,
101         BRW_R_DISCONT_BLOCKS,
102         BRW_W_DISCONT_BLOCKS,
103         BRW_R_DISK_IOSIZE,
104         BRW_W_DISK_IOSIZE,
105         BRW_R_DIO_FRAGS,
106         BRW_W_DIO_FRAGS,
107         BRW_LAST,
108 };
109
110 struct brw_stats {
111         struct obd_histogram hist[BRW_LAST];
112 };
113
114 enum {
115         RENAME_SAMEDIR_SIZE = 0,
116         RENAME_CROSSDIR_SRC_SIZE,
117         RENAME_CROSSDIR_TGT_SIZE,
118         RENAME_LAST,
119 };
120
121 struct rename_stats {
122         struct obd_histogram hist[RENAME_LAST];
123 };
124
125 /* An lprocfs counter can be configured using the enum bit masks below.
126  *
127  * LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
128  * protects this counter from concurrent updates. If not specified,
129  * lprocfs an internal per-counter lock variable. External locks are
130  * not used to protect counter increments, but are used to protect
131  * counter readout and resets.
132  *
133  * LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
134  * (i.e. counter can be incremented by more than "1"). When specified,
135  * the counter maintains min, max and sum in addition to a simple
136  * invocation count. This allows averages to be be computed.
137  * If not specified, the counter is an increment-by-1 counter.
138  * min, max, sum, etc. are not maintained.
139  *
140  * LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
141  * squares (for multi-valued counter samples only). This allows
142  * external computation of standard deviation, but involves a 64-bit
143  * multiply per counter increment.
144  */
145
146 enum {
147         LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
148         LPROCFS_CNTR_AVGMINMAX    = 0x0002,
149         LPROCFS_CNTR_STDDEV       = 0x0004,
150
151         /* counter data type */
152         LPROCFS_TYPE_REGS         = 0x0100,
153         LPROCFS_TYPE_BYTES        = 0x0200,
154         LPROCFS_TYPE_PAGES        = 0x0400,
155         LPROCFS_TYPE_CYCLE        = 0x0800,
156 };
157
158 #define LC_MIN_INIT ((~(__u64)0) >> 1)
159
160 struct lprocfs_counter_header {
161         unsigned int            lc_config;
162         const char              *lc_name;   /* must be static */
163         const char              *lc_units;  /* must be static */
164 };
165
166 struct lprocfs_counter {
167         __s64   lc_count;
168         __s64   lc_min;
169         __s64   lc_max;
170         __s64   lc_sumsquare;
171         /*
172          * Every counter has lc_array_sum[0], while lc_array_sum[1] is only
173          * for irq context counter, i.e. stats with
174          * LPROCFS_STATS_FLAG_IRQ_SAFE flag, its counter need
175          * lc_array_sum[1]
176          */
177         __s64   lc_array_sum[1];
178 };
179 #define lc_sum          lc_array_sum[0]
180 #define lc_sum_irq      lc_array_sum[1]
181
182 struct lprocfs_percpu {
183         struct lprocfs_counter lp_cntr[0];
184 };
185
186 enum lprocfs_stats_lock_ops {
187         LPROCFS_GET_NUM_CPU     = 0x0001, /* number allocated per-CPU stats */
188         LPROCFS_GET_SMP_ID      = 0x0002, /* current stat to be updated */
189 };
190
191 enum lprocfs_stats_flags {
192         LPROCFS_STATS_FLAG_NONE     = 0x0000, /* per cpu counter */
193         LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
194                                                * area and need locking */
195         LPROCFS_STATS_FLAG_IRQ_SAFE = 0x0002, /* alloc need irq safe */
196 };
197
198 enum lprocfs_fields_flags {
199         LPROCFS_FIELDS_FLAGS_CONFIG     = 0x0001,
200         LPROCFS_FIELDS_FLAGS_SUM        = 0x0002,
201         LPROCFS_FIELDS_FLAGS_MIN        = 0x0003,
202         LPROCFS_FIELDS_FLAGS_MAX        = 0x0004,
203         LPROCFS_FIELDS_FLAGS_AVG        = 0x0005,
204         LPROCFS_FIELDS_FLAGS_SUMSQUARE  = 0x0006,
205         LPROCFS_FIELDS_FLAGS_COUNT      = 0x0007,
206 };
207
208 struct lprocfs_stats {
209         /* # of counters */
210         unsigned short                  ls_num;
211         /* 1 + the biggest cpu # whose ls_percpu slot has been allocated */
212         unsigned short                  ls_biggest_alloc_num;
213         enum lprocfs_stats_flags        ls_flags;
214         /* Lock used when there are no percpu stats areas; For percpu stats,
215          * it is used to protect ls_biggest_alloc_num change */
216         spinlock_t                      ls_lock;
217
218         /* has ls_num of counter headers */
219         struct lprocfs_counter_header   *ls_cnt_header;
220         struct lprocfs_percpu           *ls_percpu[0];
221 };
222
223 #define OPC_RANGE(seg) (seg ## _LAST_OPC - seg ## _FIRST_OPC)
224
225 /* Pack all opcodes down into a single monotonically increasing index */
226 static inline int opcode_offset(__u32 opc) {
227         if (opc < OST_LAST_OPC) {
228                  /* OST opcode */
229                 return (opc - OST_FIRST_OPC);
230         } else if (opc < MDS_LAST_OPC) {
231                 /* MDS opcode */
232                 return (opc - MDS_FIRST_OPC +
233                         OPC_RANGE(OST));
234         } else if (opc < LDLM_LAST_OPC) {
235                 /* LDLM Opcode */
236                 return (opc - LDLM_FIRST_OPC +
237                         OPC_RANGE(MDS) +
238                         OPC_RANGE(OST));
239         } else if (opc < MGS_LAST_OPC) {
240                 /* MGS Opcode */
241                 return (opc - MGS_FIRST_OPC +
242                         OPC_RANGE(LDLM) +
243                         OPC_RANGE(MDS) +
244                         OPC_RANGE(OST));
245         } else if (opc < OBD_LAST_OPC) {
246                 /* OBD Ping */
247                 return (opc - OBD_FIRST_OPC +
248                         OPC_RANGE(MGS) +
249                         OPC_RANGE(LDLM) +
250                         OPC_RANGE(MDS) +
251                         OPC_RANGE(OST));
252         } else if (opc < LLOG_LAST_OPC) {
253                 /* LLOG Opcode */
254                 return (opc - LLOG_FIRST_OPC +
255                         OPC_RANGE(OBD) +
256                         OPC_RANGE(MGS) +
257                         OPC_RANGE(LDLM) +
258                         OPC_RANGE(MDS) +
259                         OPC_RANGE(OST));
260         } else if (opc < QUOTA_LAST_OPC) {
261                 /* LQUOTA Opcode */
262                 return (opc - QUOTA_FIRST_OPC +
263                         OPC_RANGE(LLOG) +
264                         OPC_RANGE(OBD) +
265                         OPC_RANGE(MGS) +
266                         OPC_RANGE(LDLM) +
267                         OPC_RANGE(MDS) +
268                         OPC_RANGE(OST));
269         } else if (opc < SEQ_LAST_OPC) {
270                 /* SEQ opcode */
271                 return (opc - SEQ_FIRST_OPC +
272                         OPC_RANGE(QUOTA) +
273                         OPC_RANGE(LLOG) +
274                         OPC_RANGE(OBD) +
275                         OPC_RANGE(MGS) +
276                         OPC_RANGE(LDLM) +
277                         OPC_RANGE(MDS) +
278                         OPC_RANGE(OST));
279         } else if (opc < SEC_LAST_OPC) {
280                 /* SEC opcode */
281                 return (opc - SEC_FIRST_OPC +
282                         OPC_RANGE(SEQ) +
283                         OPC_RANGE(QUOTA) +
284                         OPC_RANGE(LLOG) +
285                         OPC_RANGE(OBD) +
286                         OPC_RANGE(MGS) +
287                         OPC_RANGE(LDLM) +
288                         OPC_RANGE(MDS) +
289                         OPC_RANGE(OST));
290         } else if (opc < FLD_LAST_OPC) {
291                 /* FLD opcode */
292                  return (opc - FLD_FIRST_OPC +
293                         OPC_RANGE(SEC) +
294                         OPC_RANGE(SEQ) +
295                         OPC_RANGE(QUOTA) +
296                         OPC_RANGE(LLOG) +
297                         OPC_RANGE(OBD) +
298                         OPC_RANGE(MGS) +
299                         OPC_RANGE(LDLM) +
300                         OPC_RANGE(MDS) +
301                         OPC_RANGE(OST));
302         } else if (opc < OUT_UPDATE_LAST_OPC) {
303                 /* update opcode */
304                 return (opc - OUT_UPDATE_FIRST_OPC +
305                         OPC_RANGE(FLD) +
306                         OPC_RANGE(SEC) +
307                         OPC_RANGE(SEQ) +
308                         OPC_RANGE(QUOTA) +
309                         OPC_RANGE(LLOG) +
310                         OPC_RANGE(OBD) +
311                         OPC_RANGE(MGS) +
312                         OPC_RANGE(LDLM) +
313                         OPC_RANGE(MDS) +
314                         OPC_RANGE(OST));
315         } else if (opc < LFSCK_LAST_OPC) {
316                 /* LFSCK opcode */
317                 return (opc - LFSCK_FIRST_OPC +
318                         OPC_RANGE(OUT_UPDATE) +
319                         OPC_RANGE(FLD) +
320                         OPC_RANGE(SEC) +
321                         OPC_RANGE(SEQ) +
322                         OPC_RANGE(QUOTA) +
323                         OPC_RANGE(LLOG) +
324                         OPC_RANGE(OBD) +
325                         OPC_RANGE(MGS) +
326                         OPC_RANGE(LDLM) +
327                         OPC_RANGE(MDS) +
328                         OPC_RANGE(OST));
329         } else {
330                 /* Unknown Opcode */
331                 return -1;
332         }
333 }
334
335
336 #define LUSTRE_MAX_OPCODES (OPC_RANGE(OST)  + \
337                             OPC_RANGE(MDS)  + \
338                             OPC_RANGE(LDLM) + \
339                             OPC_RANGE(MGS)  + \
340                             OPC_RANGE(OBD)  + \
341                             OPC_RANGE(LLOG) + \
342                             OPC_RANGE(SEC)  + \
343                             OPC_RANGE(SEQ)  + \
344                             OPC_RANGE(SEC)  + \
345                             OPC_RANGE(FLD)  + \
346                             OPC_RANGE(OUT_UPDATE) + \
347                             OPC_RANGE(LFSCK))
348
349 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR)  + \
350                             OPC_RANGE(EXTRA))
351
352 enum {
353         PTLRPC_REQWAIT_CNTR = 0,
354         PTLRPC_REQQDEPTH_CNTR,
355         PTLRPC_REQACTIVE_CNTR,
356         PTLRPC_TIMEOUT,
357         PTLRPC_REQBUF_AVAIL_CNTR,
358         PTLRPC_LAST_CNTR
359 };
360
361 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
362
363 enum lprocfs_extra_opc {
364         LDLM_GLIMPSE_ENQUEUE = 0,
365         LDLM_PLAIN_ENQUEUE,
366         LDLM_EXTENT_ENQUEUE,
367         LDLM_FLOCK_ENQUEUE,
368         LDLM_IBITS_ENQUEUE,
369         MDS_REINT_SETATTR,
370         MDS_REINT_CREATE,
371         MDS_REINT_LINK,
372         MDS_REINT_UNLINK,
373         MDS_REINT_RENAME,
374         MDS_REINT_OPEN,
375         MDS_REINT_SETXATTR,
376         MDS_REINT_RESYNC,
377         BRW_READ_BYTES,
378         BRW_WRITE_BYTES,
379         EXTRA_LAST_OPC
380 };
381
382 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
383 /* class_obd.c */
384 extern struct proc_dir_entry *proc_lustre_root;
385 extern struct dentry *debugfs_lustre_root;
386 extern struct kset *lustre_kset;
387
388 struct obd_device;
389 struct obd_histogram;
390
391 #define JOBSTATS_JOBID_VAR_MAX_LEN      20
392 #define JOBSTATS_DISABLE                "disable"
393 #define JOBSTATS_PROCNAME_UID           "procname_uid"
394 #define JOBSTATS_NODELOCAL              "nodelocal"
395 #define JOBSTATS_SESSION                "session"
396
397 typedef void (*cntr_init_callback)(struct lprocfs_stats *stats);
398
399 struct obd_job_stats {
400         struct cfs_hash        *ojs_hash;       /* hash of jobids */
401         struct list_head        ojs_list;       /* list of job_stat structs */
402         rwlock_t                ojs_lock;       /* protect ojs_list/js_list */
403         unsigned int            ojs_cleanup_interval;/* seconds before expiry */
404         time64_t                ojs_last_cleanup; /* previous cleanup time */
405         cntr_init_callback      ojs_cntr_init_fn;/* lprocfs_stats initializer */
406         unsigned short          ojs_cntr_num;   /* number of stats in struct */
407         bool                    ojs_cleaning;   /* currently expiring stats */
408 };
409
410 #ifdef CONFIG_PROC_FS
411
412 int lprocfs_stats_alloc_one(struct lprocfs_stats *stats,
413                             unsigned int cpuid);
414 int lprocfs_stats_lock(struct lprocfs_stats *stats,
415                        enum lprocfs_stats_lock_ops opc,
416                        unsigned long *flags);
417 void lprocfs_stats_unlock(struct lprocfs_stats *stats,
418                           enum lprocfs_stats_lock_ops opc,
419                           unsigned long *flags);
420
421 static inline unsigned int
422 lprocfs_stats_counter_size(struct lprocfs_stats *stats)
423 {
424         unsigned int percpusize;
425
426         percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
427
428         /* irq safe stats need lc_array_sum[1] */
429         if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
430                 percpusize += stats->ls_num * sizeof(__s64);
431
432         if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
433                 percpusize = L1_CACHE_ALIGN(percpusize);
434
435         return percpusize;
436 }
437
438 static inline struct lprocfs_counter *
439 lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
440                           int index)
441 {
442         struct lprocfs_counter *cntr;
443
444         cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
445
446         if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
447                 cntr = (void *)cntr + index * sizeof(__s64);
448
449         return cntr;
450 }
451
452 /* Two optimized LPROCFS counter increment functions are provided:
453  *     lprocfs_counter_incr(cntr, value) - optimized for by-one counters
454  *     lprocfs_counter_add(cntr) - use for multi-valued counters
455  * Counter data layout allows config flag, counter lock and the
456  * count itself to reside within a single cache line.
457  */
458
459 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
460                                 long amount);
461 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
462                                 long amount);
463
464 #define lprocfs_counter_incr(stats, idx) \
465         lprocfs_counter_add(stats, idx, 1)
466 #define lprocfs_counter_decr(stats, idx) \
467         lprocfs_counter_sub(stats, idx, 1)
468
469 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
470                                  struct lprocfs_counter_header *header,
471                                  enum lprocfs_stats_flags flags,
472                                  enum lprocfs_fields_flags field);
473 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
474                             enum lprocfs_fields_flags field);
475
476 extern struct lprocfs_stats *
477 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags);
478 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
479 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
480 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
481 extern int lprocfs_alloc_obd_stats(struct obd_device *obddev,
482                                    unsigned int num_stats);
483 extern int lprocfs_alloc_md_stats(struct obd_device *obddev,
484                                   unsigned int num_private_stats);
485 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
486                                  unsigned conf, const char *name,
487                                  const char *units);
488 extern void lprocfs_free_obd_stats(struct obd_device *obddev);
489 extern void lprocfs_free_md_stats(struct obd_device *obddev);
490 struct obd_export;
491 struct nid_stat;
492 extern int lprocfs_add_clear_entry(struct obd_device * obd,
493                                    struct proc_dir_entry *entry);
494 #ifdef HAVE_SERVER_SUPPORT
495 extern int lprocfs_exp_setup(struct obd_export *exp, lnet_nid_t *peer_nid);
496 extern int lprocfs_exp_cleanup(struct obd_export *exp);
497 struct dentry *ldebugfs_add_symlink(const char *name, const char *target,
498                                     const char *format, ...);
499 #else
500 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
501 { return 0; }
502 #endif
503 struct dentry *ldebugfs_add_simple(struct dentry *root, char *name, void *data,
504                                    const struct file_operations *fops);
505 extern struct proc_dir_entry *
506 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
507                    void *data, const struct file_operations *fops);
508 extern struct proc_dir_entry *
509 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
510                     const char *format, ...);
511 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
512 #ifdef HAVE_SERVER_SUPPORT
513 extern ssize_t
514 lprocfs_nid_stats_clear_seq_write(struct file *file, const char __user *buffer,
515                                         size_t count, loff_t *off);
516 extern int lprocfs_nid_stats_clear_seq_show(struct seq_file *file, void *data);
517 #endif
518 extern int ldebugfs_register_stats(struct dentry *parent, const char *name,
519                                    struct lprocfs_stats *stats);
520 extern int lprocfs_register_stats(struct proc_dir_entry *root, const char *name,
521                                   struct lprocfs_stats *stats);
522
523 /* lprocfs_status.c */
524 extern int ldebugfs_add_vars(struct dentry *parent, struct lprocfs_vars *var,
525                              void *data);
526 extern int lprocfs_add_vars(struct proc_dir_entry *root,
527                             struct lprocfs_vars *var, void *data);
528
529 extern struct dentry *ldebugfs_register(const char *name,
530                                         struct dentry *parent,
531                                         struct lprocfs_vars *list,
532                                         void *data);
533 extern struct proc_dir_entry *
534 lprocfs_register(const char *name, struct proc_dir_entry *parent,
535                  struct lprocfs_vars *list, void *data);
536
537 extern void ldebugfs_remove(struct dentry **entryp);
538 extern void lprocfs_remove(struct proc_dir_entry **root);
539 extern void lprocfs_remove_proc_entry(const char *name,
540                                       struct proc_dir_entry *parent);
541 #ifndef HAVE_REMOVE_PROC_SUBTREE
542 extern int remove_proc_subtree(const char *name,
543                                struct proc_dir_entry *parent);
544 #define PDE_DATA(inode)         (PDE(inode)->data)
545
546 static inline int LPROCFS_ENTRY_CHECK(struct inode *inode)
547 {
548         struct proc_dir_entry *dp = PDE(inode);
549         int deleted = 0;
550
551         spin_lock(&(dp)->pde_unload_lock);
552         if (dp->proc_fops == NULL)
553                 deleted = 1;
554         spin_unlock(&(dp)->pde_unload_lock);
555         if (deleted)
556                 return -ENODEV;
557         return 0;
558 }
559 #else
560 static inline int LPROCFS_ENTRY_CHECK(struct inode *inode)
561 { return 0; }
562 #endif
563
564 extern int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only);
565 extern int lprocfs_obd_cleanup(struct obd_device *obd);
566 #ifdef HAVE_SERVER_SUPPORT
567 extern const struct file_operations lprocfs_evict_client_fops;
568 #endif
569
570 int ldebugfs_seq_create(struct dentry *parent, const char *name, umode_t mode,
571                         const struct file_operations *seq_fops, void *data);
572 extern int lprocfs_seq_create(struct proc_dir_entry *parent, const char *name,
573                               mode_t mode,
574                               const struct file_operations *seq_fops,
575                               void *data);
576 extern int lprocfs_obd_seq_create(struct obd_device *dev, const char *name,
577                                   mode_t mode,
578                                   const struct file_operations *seq_fops,
579                                   void *data);
580
581 /* Generic callbacks */
582 extern int lprocfs_uuid_seq_show(struct seq_file *m, void *data);
583 extern int lprocfs_server_uuid_seq_show(struct seq_file *m, void *data);
584 ssize_t conn_uuid_show(struct kobject *kobj, struct attribute *attr, char *buf);
585 extern int lprocfs_import_seq_show(struct seq_file *m, void *data);
586 extern int lprocfs_state_seq_show(struct seq_file *m, void *data);
587 extern int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data);
588 #ifdef HAVE_SERVER_SUPPORT
589 extern int lprocfs_num_exports_seq_show(struct seq_file *m, void *data);
590 #endif
591 struct adaptive_timeout;
592 extern int lprocfs_at_hist_helper(struct seq_file *m,
593                                   struct adaptive_timeout *at);
594 extern int lprocfs_timeouts_seq_show(struct seq_file *m, void *data);
595 extern ssize_t
596 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
597                            size_t count, loff_t *off);
598 #ifdef HAVE_SERVER_SUPPORT
599 extern ssize_t
600 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
601                                 size_t count, loff_t *off);
602 #endif
603 ssize_t ping_store(struct kobject *kobj, struct attribute *attr,
604                    const char *buffer, size_t count);
605 ssize_t ping_show(struct kobject *kobj, struct attribute *attr,
606                   char *buffer);
607
608 extern ssize_t
609 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
610                          size_t count, loff_t *off);
611 extern int lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data);
612 extern ssize_t
613 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
614                                size_t count, loff_t *off);
615
616 extern int lprocfs_str_with_units_to_s64(const char __user *buffer,
617                                          unsigned long count, __s64 *val,
618                                          char defunit);
619
620 char *lprocfs_strnstr(const char *s1, const char *s2, size_t len);
621 char *lprocfs_find_named_value(const char *buffer, const char *name,
622                                 size_t *count);
623 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
624 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
625 void lprocfs_oh_clear(struct obd_histogram *oh);
626 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
627
628 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
629                            struct lprocfs_counter *cnt);
630
631 #ifdef HAVE_SERVER_SUPPORT
632 /* lprocfs_status.c: recovery status */
633 int lprocfs_recovery_status_seq_show(struct seq_file *m, void *data);
634
635 /* lprocfs_status.c: hash statistics */
636 int lprocfs_hash_seq_show(struct seq_file *m, void *data);
637
638 /* lprocfs_status.c: IR factor */
639 int lprocfs_ir_factor_seq_show(struct seq_file *m, void *data);
640 ssize_t
641 lprocfs_ir_factor_seq_write(struct file *file, const char __user *buffer,
642                                 size_t count, loff_t *off);
643 #endif
644
645 /* lprocfs_status.c: dump pages on cksum error */
646 int lprocfs_checksum_dump_seq_show(struct seq_file *m, void *data);
647 ssize_t
648 lprocfs_checksum_dump_seq_write(struct file *file, const char __user *buffer,
649                                 size_t count, loff_t *off);
650
651 extern int lprocfs_single_release(struct inode *, struct file *);
652 extern int lprocfs_seq_release(struct inode *, struct file *);
653
654 /* You must use these macros when you want to refer to
655  * the import in a client obd_device for a lprocfs entry */
656 #define LPROCFS_CLIMP_CHECK(obd) do {           \
657         typecheck(struct obd_device *, obd);    \
658         down_read(&(obd)->u.cli.cl_sem);    \
659         if ((obd)->u.cli.cl_import == NULL) {   \
660              up_read(&(obd)->u.cli.cl_sem); \
661              return -ENODEV;                    \
662         }                                       \
663 } while(0)
664 #define LPROCFS_CLIMP_EXIT(obd)                 \
665         up_read(&(obd)->u.cli.cl_sem);
666
667 /* write the name##_seq_show function, call LDEBUGFS_SEQ_FOPS_RO for read-only
668  * debugfs entries; otherwise, you will define name##_seq_write function also
669  * for a read-write debugfs entry, and then call LDEBUGFS_SEQ_FOPS instead.
670  * Finally, call ldebugfs_seq_create(obd, filename, 0444, &name#_fops, data);
671  */
672 #define __LDEBUGFS_SEQ_FOPS(name, custom_seq_write)                     \
673 static int name##_single_open(struct inode *inode, struct file *file)   \
674 {                                                                       \
675         return single_open(file, name##_seq_show, inode->i_private);    \
676 }                                                                       \
677 static const struct file_operations name##_fops = {                     \
678         .owner   = THIS_MODULE,                                         \
679         .open    = name##_single_open,                                  \
680         .read    = seq_read,                                            \
681         .write   = custom_seq_write,                                    \
682         .llseek  = seq_lseek,                                           \
683         .release = single_release,                                      \
684 }
685
686 #define LDEBUGFS_SEQ_FOPS_RO(name)      __LDEBUGFS_SEQ_FOPS(name, NULL)
687 #define LDEBUGFS_SEQ_FOPS(name)         __LDEBUGFS_SEQ_FOPS(name, \
688                                                             name##_seq_write)
689
690 #define LDEBUGFS_SEQ_FOPS_RO_TYPE(name, type)                           \
691         static int name##_##type##_seq_show(struct seq_file *m, void *v)\
692         {                                                               \
693                 if (!m->private)                                        \
694                         return -ENODEV;                                 \
695                 return lprocfs_##type##_seq_show(m, m->private);        \
696         }                                                               \
697         LDEBUGFS_SEQ_FOPS_RO(name##_##type)
698
699 #define LDEBUGFS_SEQ_FOPS_RW_TYPE(name, type)                           \
700         static int name##_##type##_seq_show(struct seq_file *m, void *v)\
701         {                                                               \
702                 if (!m->private)                                        \
703                         return -ENODEV;                                 \
704                 return lprocfs_##type##_seq_show(m, m->private);        \
705         }                                                               \
706         static ssize_t name##_##type##_seq_write(struct file *file,     \
707                         const char __user *buffer, size_t count,        \
708                         loff_t *off)                                    \
709         {                                                               \
710                 struct seq_file *seq = file->private_data;              \
711                                                                         \
712                 if (!seq->private)                                      \
713                         return -ENODEV;                                 \
714                 return ldebugfs_##type##_seq_write(file, buffer, count, \
715                                                    seq->private);       \
716         }                                                               \
717         LDEBUGFS_SEQ_FOPS(name##_##type);
718
719 #define LDEBUGFS_FOPS_WR_ONLY(name, type)                               \
720         static ssize_t name##_##type##_write(struct file *file,         \
721                         const char __user *buffer, size_t count,        \
722                         loff_t *off)                                    \
723         {                                                               \
724                 return ldebugfs_##type##_seq_write(file, buffer, count, \
725                                                    off);                \
726         }                                                               \
727         static int name##_##type##_open(struct inode *inode,            \
728                                         struct file *file)              \
729         {                                                               \
730                 return single_open(file, NULL, inode->i_private);       \
731         }                                                               \
732         static const struct file_operations name##_##type##_fops = {    \
733                 .open    = name##_##type##_open,                        \
734                 .write   = name##_##type##_write,                       \
735                 .release = single_release,                              \
736         };
737
738 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
739  * proc entries; otherwise, you will define name##_seq_write function also for
740  * a read-write proc entry, and then call LPROC_SEQ_FOPS instead. Finally,
741  * call ldebugfs_obd_seq_create(obd, filename, 0444, &name#_fops, data);
742  */
743 #define __LPROC_SEQ_FOPS(name, custom_seq_write)                        \
744 static int name##_single_open(struct inode *inode, struct file *file)   \
745 {                                                                       \
746         int rc;                                                         \
747                                                                         \
748         rc = LPROCFS_ENTRY_CHECK(inode);                                \
749         if (rc < 0)                                                     \
750                 return rc;                                              \
751                                                                         \
752         return single_open(file, name##_seq_show,                       \
753                            inode->i_private ? inode->i_private :        \
754                                               PDE_DATA(inode));         \
755 }                                                                       \
756 static const struct file_operations name##_fops = {                     \
757         .owner   = THIS_MODULE,                                         \
758         .open    = name##_single_open,                                  \
759         .read    = seq_read,                                            \
760         .write   = custom_seq_write,                                    \
761         .llseek  = seq_lseek,                                           \
762         .release = lprocfs_single_release,                              \
763 }
764
765 #define LPROC_SEQ_FOPS_RO(name)         __LPROC_SEQ_FOPS(name, NULL)
766 #define LPROC_SEQ_FOPS(name)            __LPROC_SEQ_FOPS(name, name##_seq_write)
767
768 #define LPROC_SEQ_FOPS_RO_TYPE(name, type)                              \
769         static int name##_##type##_seq_show(struct seq_file *m, void *v)\
770         {                                                               \
771                 return lprocfs_##type##_seq_show(m, m->private);        \
772         }                                                               \
773         LPROC_SEQ_FOPS_RO(name##_##type)
774
775 #define LPROC_SEQ_FOPS_RW_TYPE(name, type)                              \
776         static int name##_##type##_seq_show(struct seq_file *m, void *v)\
777         {                                                               \
778                 return lprocfs_##type##_seq_show(m, m->private);        \
779         }                                                               \
780         static ssize_t name##_##type##_seq_write(struct file *file,     \
781                         const char __user *buffer, size_t count,        \
782                         loff_t *off)                                    \
783         {                                                               \
784                 struct seq_file *seq = file->private_data;              \
785                 return lprocfs_##type##_seq_write(file, buffer,         \
786                                                   count, seq->private); \
787         }                                                               \
788         LPROC_SEQ_FOPS(name##_##type);
789
790 #define LPROC_SEQ_FOPS_WR_ONLY(name, type)                              \
791         static ssize_t name##_##type##_write(struct file *file,         \
792                         const char __user *buffer, size_t count,        \
793                         loff_t *off)                                    \
794         {                                                               \
795                 return lprocfs_##type##_seq_write(file, buffer, count, off);\
796         }                                                               \
797         static int name##_##type##_open(struct inode *inode, struct file *file)\
798         {                                                               \
799                 return single_open(file, NULL,                          \
800                                    inode->i_private ? inode->i_private : \
801                                    PDE_DATA(inode));                    \
802         }                                                               \
803         static const struct file_operations name##_##type##_fops = {    \
804                 .open    = name##_##type##_open,                        \
805                 .write   = name##_##type##_write,                       \
806                 .release = lprocfs_single_release,                      \
807         };
808
809 struct lustre_attr {
810         struct attribute attr;
811         ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
812                         char *buf);
813         ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
814                          const char *buf, size_t len);
815 };
816
817 #define LUSTRE_ATTR(name, mode, show, store) \
818 static struct lustre_attr lustre_attr_##name = __ATTR(name, mode, show, store)
819
820 #define LUSTRE_WO_ATTR(name) LUSTRE_ATTR(name, 0200, NULL, name##_store)
821 #define LUSTRE_RO_ATTR(name) LUSTRE_ATTR(name, 0444, name##_show, NULL)
822 #define LUSTRE_RW_ATTR(name) LUSTRE_ATTR(name, 0644, name##_show, name##_store)
823
824 ssize_t lustre_attr_show(struct kobject *kobj, struct attribute *attr,
825                          char *buf);
826 ssize_t lustre_attr_store(struct kobject *kobj, struct attribute *attr,
827                           const char *buf, size_t len);
828
829 extern const struct sysfs_ops lustre_sysfs_ops;
830
831 /* lproc_ptlrpc.c */
832 struct ptlrpc_request;
833 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
834
835 #ifdef HAVE_SERVER_SUPPORT
836 /* lprocfs_jobstats.c */
837 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
838                           int event, long amount);
839 void lprocfs_job_stats_fini(struct obd_device *obd);
840 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
841                            cntr_init_callback fn);
842 int lprocfs_job_interval_seq_show(struct seq_file *m, void *data);
843 ssize_t
844 lprocfs_job_interval_seq_write(struct file *file, const char __user *buffer,
845                                 size_t count, loff_t *off);
846 /* lproc_status.c */
847 int lprocfs_recovery_time_soft_seq_show(struct seq_file *m, void *data);
848 ssize_t lprocfs_recovery_time_soft_seq_write(struct file *file,
849                                                 const char __user *buffer,
850                                                 size_t count, loff_t *off);
851 int lprocfs_recovery_time_hard_seq_show(struct seq_file *m, void *data);
852 ssize_t
853 lprocfs_recovery_time_hard_seq_write(struct file *file,
854                                      const char __user *buffer,
855                                      size_t count, loff_t *off);
856 int lprocfs_target_instance_seq_show(struct seq_file *m, void *data);
857 #endif
858 int lprocfs_obd_max_pages_per_rpc_seq_show(struct seq_file *m, void *data);
859 ssize_t lprocfs_obd_max_pages_per_rpc_seq_write(struct file *file,
860                                                 const char __user *buffer,
861                                                 size_t count, loff_t *off);
862 int lprocfs_obd_short_io_bytes_seq_show(struct seq_file *m, void *data);
863 ssize_t lprocfs_obd_short_io_bytes_seq_write(struct file *file,
864                                              const char __user *buffer,
865                                              size_t count, loff_t *off);
866 ssize_t short_io_bytes_show(struct kobject *kobj, struct attribute *attr,
867                             char *buf);
868 ssize_t short_io_bytes_store(struct kobject *kobj, struct attribute *attr,
869                              const char *buffer, size_t count);
870
871 struct root_squash_info;
872 int lprocfs_wr_root_squash(const char __user *buffer, unsigned long count,
873                            struct root_squash_info *squash, char *name);
874 int lprocfs_wr_nosquash_nids(const char __user *buffer, unsigned long count,
875                              struct root_squash_info *squash, char *name);
876
877 #else /* !CONFIG_PROC_FS */
878
879 #define proc_lustre_root NULL
880
881 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
882                                        int index, long amount)
883 { return; }
884 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
885                                         int index)
886 { return; }
887 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
888                                        int index, long amount)
889 { return; }
890 static inline void lprocfs_counter_decr(struct lprocfs_stats *stats,
891                                         int index)
892 { return; }
893 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
894                                         int index, unsigned conf,
895                                         const char *name, const char *units)
896 { return; }
897
898 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
899                                    enum lprocfs_fields_flags field)
900 { return 0; }
901
902 /* NB: we return !NULL to satisfy error checker */
903 static inline struct lprocfs_stats *
904 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags)
905 { return (struct lprocfs_stats *)1; }
906 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
907 { return; }
908 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
909 { return; }
910 static inline int lprocfs_register_stats(struct proc_dir_entry *root,
911                                          const char *name,
912                                          struct lprocfs_stats *stats)
913 { return 0; }
914 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
915 { return; }
916 static inline int lprocfs_alloc_obd_stats(struct obd_device *obddev,
917                                           unsigned int num_stats)
918 { return 0; }
919 static inline int lprocfs_alloc_md_stats(struct obd_device *obddev,
920                                          unsigned int num_private_stats)
921 { return 0; }
922 static inline void lprocfs_free_obd_stats(struct obd_device *obddev)
923 { return; }
924 static inline void lprocfs_free_md_stats(struct obd_device *obddev)
925 { return; }
926
927 struct obd_export;
928 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
929 { return 0; }
930 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
931 { return; }
932 #ifdef HAVE_SERVER_SUPPORT
933 static inline
934 ssize_t lprocfs_nid_stats_seq_write(struct file *file,
935                                     const char __user *buffer,
936                                     size_t count, loff_t *off)
937 {return 0;}
938 static inline
939 int lprocfs_nid_stats_clear_seq_show(struct seq_file *m, void *data)
940 {return 0;}
941 static inline int lprocfs_exp_setup(struct obd_export *exp,lnet_nid_t *peer_nid)
942 { return 0; }
943 #endif
944 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
945 { return 0; }
946 static inline struct proc_dir_entry *
947 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
948                    void *data, const struct file_operations *fops)
949 {return 0; }
950 static inline struct proc_dir_entry *
951 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
952                     const char *format, ...)
953 {return NULL; }
954 static inline int lprocfs_add_vars(struct proc_dir_entry *root,
955                                    struct lprocfs_vars *var, void *data)
956 { return 0; }
957 static inline struct proc_dir_entry *
958 lprocfs_register(const char *name, struct proc_dir_entry *parent,
959                  struct lprocfs_vars *list, void *data)
960 { return NULL; }
961 static inline void lprocfs_remove(struct proc_dir_entry **root)
962 { return; }
963 static inline void lprocfs_remove_proc_entry(const char *name,
964                                              struct proc_dir_entry *parent)
965 { return; }
966 static inline int lprocfs_obd_setup(struct obd_device *dev, bool uuid_only)
967 { return 0; }
968 static inline int lprocfs_obd_cleanup(struct obd_device *dev)
969 { return 0; }
970 static inline int lprocfs_uuid_seq_show(struct seq_file *m, void *data)
971 { return 0; }
972 static inline int lprocfs_server_seq_show(struct seq_file *m, void *data)
973 { return 0; }
974 static inline int lprocfs_import_seq_show(struct seq_file *m, void *data)
975 { return 0; }
976 static inline int lprocfs_state_seq_show(struct seq_file *m, void *data)
977 { return 0; }
978 static inline int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data)
979 { return 0; }
980 #ifdef HAVE_SERVER_SUPPORT
981 static inline int lprocfs_num_exports_seq_show(struct seq_file *m, void *data)
982 { return 0; }
983 #endif
984 struct adaptive_timeout;
985 static inline int lprocfs_at_hist_helper(struct seq_file *m,
986                                          struct adaptive_timeout *at)
987 { return 0; }
988 static inline int lprocfs_timeouts_seq_show(struct seq_file *m, void *data)
989 { return 0; }
990 static inline ssize_t
991 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
992                            size_t count, loff_t *off)
993 { return 0; }
994 #ifdef HAVE_SERVER_SUPPORT
995 static inline ssize_t
996 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
997                                size_t count, loff_t *off)
998 { return 0; }
999 #endif
1000 static inline ssize_t
1001 lprocfs_ping_seq_write(struct file *file, const char __user *buffer,
1002                        size_t count, loff_t *off)
1003 { return 0; }
1004 static inline ssize_t
1005 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
1006                          size_t count, loff_t *off)
1007 { return 0; }
1008 static inline int
1009 lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data)
1010 { return 0; }
1011 static inline ssize_t
1012 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
1013                                size_t count, loff_t *off)
1014 { return 0; }
1015
1016 /* Statfs helpers */
1017 static inline
1018 int lprocfs_blksize_seq_show(struct seq_file *m, void *data)
1019 { return 0; }
1020 static inline
1021 int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data)
1022 { return 0; }
1023 static inline
1024 int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data)
1025 { return 0; }
1026 static inline
1027 int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data)
1028 { return 0; }
1029 static inline
1030 int lprocfs_filestotal_seq_show(struct seq_file *m, void *data)
1031 { return 0; }
1032 static inline
1033 int lprocfs_filesfree_seq_show(struct seq_file *m, void *data)
1034 { return 0; }
1035 static inline
1036 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value)
1037 { return; }
1038 static inline
1039 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value)
1040 { return; }
1041 static inline
1042 void lprocfs_oh_clear(struct obd_histogram *oh)
1043 { return; }
1044 static inline
1045 unsigned long lprocfs_oh_sum(struct obd_histogram *oh)
1046 { return 0; }
1047 static inline
1048 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
1049                            struct lprocfs_counter *cnt)
1050 { return; }
1051 static inline
1052 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
1053                             enum lprocfs_fields_flags field)
1054 { return (__u64)0; }
1055
1056 #define LPROC_SEQ_FOPS_RO(name)
1057 #define LPROC_SEQ_FOPS(name)
1058 #define LPROC_SEQ_FOPS_RO_TYPE(name, type)
1059 #define LPROC_SEQ_FOPS_RW_TYPE(name, type)
1060 #define LPROC_SEQ_FOPS_WR_ONLY(name, type)
1061
1062 /* lprocfs_jobstats.c */
1063 static inline
1064 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid, int event,
1065                           long amount)
1066 { return 0; }
1067 static inline
1068 void lprocfs_job_stats_fini(struct obd_device *obd)
1069 { return; }
1070 static inline
1071 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
1072                            cntr_init_callback fn)
1073 { return 0; }
1074
1075
1076 /* lproc_ptlrpc.c */
1077 #define target_print_req NULL
1078
1079 #endif /* CONFIG_PROC_FS */
1080
1081 #endif /* LPROCFS_STATUS_H */