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