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