Whamcloud - gitweb
branch: HEAD
[fs/lustre-release.git] / lustre / include / lprocfs_status.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
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 SNMP
39  *
40  * Author: Hariharan Thantry thantry@users.sourceforge.net
41  */
42 #ifndef _LPROCFS_SNMP_H
43 #define _LPROCFS_SNMP_H
44
45 #if defined(__linux__)
46 #include <linux/lprocfs_status.h>
47 #elif defined(__APPLE__)
48 #include <darwin/lprocfs_status.h>
49 #elif defined(__WINNT__)
50 #include <winnt/lprocfs_status.h>
51 #else
52 #error Unsupported operating system.
53 #endif
54 #include <lustre/lustre_idl.h>
55
56 #undef LPROCFS
57 #if (defined(__KERNEL__) && defined(CONFIG_PROC_FS))
58 # define LPROCFS
59 #endif
60
61 struct lprocfs_vars {
62         const char   *name;
63         cfs_read_proc_t *read_fptr;
64         cfs_write_proc_t *write_fptr;
65         void *data;
66         struct file_operations *fops;
67         /**
68          * /proc file mode.
69          */
70         mode_t proc_mode;
71 };
72
73 struct lprocfs_static_vars {
74         struct lprocfs_vars *module_vars;
75         struct lprocfs_vars *obd_vars;
76 };
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
108 /* An lprocfs counter can be configured using the enum bit masks below.
109  *
110  * LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
111  * protects this counter from concurrent updates. If not specified,
112  * lprocfs an internal per-counter lock variable. External locks are
113  * not used to protect counter increments, but are used to protect
114  * counter readout and resets.
115  *
116  * LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
117  * (i.e. counter can be incremented by more than "1"). When specified,
118  * the counter maintains min, max and sum in addition to a simple
119  * invocation count. This allows averages to be be computed.
120  * If not specified, the counter is an increment-by-1 counter.
121  * min, max, sum, etc. are not maintained.
122  *
123  * LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
124  * squares (for multi-valued counter samples only). This allows
125  * external computation of standard deviation, but involves a 64-bit
126  * multiply per counter increment.
127  */
128
129 enum {
130         LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
131         LPROCFS_CNTR_AVGMINMAX    = 0x0002,
132         LPROCFS_CNTR_STDDEV       = 0x0004,
133
134         /* counter data type */
135         LPROCFS_TYPE_REGS         = 0x0100,
136         LPROCFS_TYPE_BYTES        = 0x0200,
137         LPROCFS_TYPE_PAGES        = 0x0400,
138         LPROCFS_TYPE_CYCLE        = 0x0800,
139 };
140
141 struct lprocfs_atomic {
142         atomic_t               la_entry;
143         atomic_t               la_exit;
144 };
145
146 #define LC_MIN_INIT ((~(__u64)0) >> 1)
147
148 struct lprocfs_counter {
149         struct lprocfs_atomic  lc_cntl;  /* may need to move to per set */
150         unsigned int           lc_config;
151         __s64                  lc_count;
152         __s64                  lc_sum;
153         __s64                  lc_sum_irq;
154         __s64                  lc_min;
155         __s64                  lc_max;
156         __s64                  lc_sumsquare;
157         const char            *lc_name;   /* must be static */
158         const char            *lc_units;  /* must be static */
159 };
160
161 struct lprocfs_percpu {
162         struct lprocfs_counter lp_cntr[0];
163 };
164
165 #define LPROCFS_GET_NUM_CPU 0x0001
166 #define LPROCFS_GET_SMP_ID  0x0002
167
168 enum lprocfs_stats_flags {
169         LPROCFS_STATS_FLAG_NONE     = 0x0000, /* per cpu counter */
170         LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
171                                                * area and need locking */
172         LPROCFS_STATS_GET_SMP_ID    = 0x0002, /* just record locking with
173                                                * LPROCFS_GET_SMP_ID flag */
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         unsigned int           ls_num;     /* # of counters */
188         int                    ls_flags; /* See LPROCFS_STATS_FLAG_* */
189         spinlock_t             ls_lock;  /* Lock used only when there are
190                                           * no percpu stats areas */
191         struct lprocfs_percpu *ls_percpu[0];
192 };
193
194 #define OPC_RANGE(seg) (seg ## _LAST_OPC - seg ## _FIRST_OPC)
195
196 /* Pack all opcodes down into a single monotonically increasing index */
197 static inline int opcode_offset(__u32 opc) {
198         if (opc < OST_LAST_OPC) {
199                  /* OST opcode */
200                 return (opc - OST_FIRST_OPC);
201         } else if (opc < MDS_LAST_OPC) {
202                 /* MDS opcode */
203                 return (opc - MDS_FIRST_OPC +
204                         OPC_RANGE(OST));
205         } else if (opc < LDLM_LAST_OPC) {
206                 /* LDLM Opcode */
207                 return (opc - LDLM_FIRST_OPC +
208                         OPC_RANGE(MDS) +
209                         OPC_RANGE(OST));
210         } else if (opc < MGS_LAST_OPC) {
211                 /* MGS Opcode */
212                 return (opc - MGS_FIRST_OPC +
213                         OPC_RANGE(LDLM) +
214                         OPC_RANGE(MDS) +
215                         OPC_RANGE(OST));
216         } else if (opc < OBD_LAST_OPC) {
217                 /* OBD Ping */
218                 return (opc - OBD_FIRST_OPC +
219                         OPC_RANGE(MGS) +
220                         OPC_RANGE(LDLM) +
221                         OPC_RANGE(MDS) +
222                         OPC_RANGE(OST));
223         } else if (opc < LLOG_LAST_OPC) {
224                 /* LLOG Opcode */
225                 return (opc - LLOG_FIRST_OPC +
226                         OPC_RANGE(OBD) +
227                         OPC_RANGE(MGS) +
228                         OPC_RANGE(LDLM) +
229                         OPC_RANGE(MDS) +
230                         OPC_RANGE(OST));
231         } else if (opc < QUOTA_LAST_OPC) {
232                 /* LQUOTA Opcode */
233                 return (opc - QUOTA_FIRST_OPC +
234                         OPC_RANGE(LLOG) +
235                         OPC_RANGE(OBD) +
236                         OPC_RANGE(MGS) +
237                         OPC_RANGE(LDLM) +
238                         OPC_RANGE(MDS) +
239                         OPC_RANGE(OST));
240         } else if (opc < SEQ_LAST_OPC) {
241                 /* SEQ opcode */
242                 return (opc - SEQ_FIRST_OPC +
243                         OPC_RANGE(QUOTA) +
244                         OPC_RANGE(LLOG) +
245                         OPC_RANGE(OBD) +
246                         OPC_RANGE(MGS) +
247                         OPC_RANGE(LDLM) +
248                         OPC_RANGE(MDS) +
249                         OPC_RANGE(OST));
250         } else if (opc < SEC_LAST_OPC) {
251                 /* SEC opcode */
252                 return (opc - SEC_FIRST_OPC +
253                         OPC_RANGE(SEQ) +
254                         OPC_RANGE(QUOTA) +
255                         OPC_RANGE(LLOG) +
256                         OPC_RANGE(OBD) +
257                         OPC_RANGE(MGS) +
258                         OPC_RANGE(LDLM) +
259                         OPC_RANGE(MDS) +
260                         OPC_RANGE(OST));
261         } else if (opc < FLD_LAST_OPC) {
262                 /* FLD opcode */
263                  return (opc - FLD_FIRST_OPC +
264                         OPC_RANGE(SEC) +
265                         OPC_RANGE(SEQ) +
266                         OPC_RANGE(QUOTA) +
267                         OPC_RANGE(LLOG) +
268                         OPC_RANGE(OBD) +
269                         OPC_RANGE(MGS) +
270                         OPC_RANGE(LDLM) +
271                         OPC_RANGE(MDS) +
272                         OPC_RANGE(OST));
273         } else {
274                 /* Unknown Opcode */
275                 return -1;
276         }
277 }
278
279
280 #define LUSTRE_MAX_OPCODES (OPC_RANGE(OST)  + \
281                             OPC_RANGE(MDS)  + \
282                             OPC_RANGE(LDLM) + \
283                             OPC_RANGE(MGS)  + \
284                             OPC_RANGE(OBD)  + \
285                             OPC_RANGE(LLOG) + \
286                             OPC_RANGE(SEC)  + \
287                             OPC_RANGE(SEQ)  + \
288                             OPC_RANGE(SEC)  + \
289                             OPC_RANGE(FLD)  )
290
291 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR)  + \
292                             OPC_RANGE(EXTRA))
293
294 enum {
295         PTLRPC_REQWAIT_CNTR = 0,
296         PTLRPC_REQQDEPTH_CNTR,
297         PTLRPC_REQACTIVE_CNTR,
298         PTLRPC_TIMEOUT,
299         PTLRPC_REQBUF_AVAIL_CNTR,
300         PTLRPC_LAST_CNTR
301 };
302
303 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
304
305 enum {
306         LDLM_GLIMPSE_ENQUEUE = 0,
307         LDLM_PLAIN_ENQUEUE,
308         LDLM_EXTENT_ENQUEUE,
309         LDLM_FLOCK_ENQUEUE,
310         LDLM_IBITS_ENQUEUE,
311         MDS_REINT_SETATTR,
312         MDS_REINT_CREATE,
313         MDS_REINT_LINK,
314         MDS_REINT_UNLINK,
315         MDS_REINT_RENAME,
316         MDS_REINT_OPEN,
317         MDS_REINT_SETXATTR,
318         BRW_READ_BYTES,
319         BRW_WRITE_BYTES,
320         EXTRA_LAST_OPC
321 };
322
323 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
324 /* class_obd.c */
325 extern cfs_proc_dir_entry_t *proc_lustre_root;
326
327 struct obd_device;
328 struct file;
329 struct obd_histogram;
330
331 /* Days / hours / mins / seconds format */
332 struct dhms {
333         int d,h,m,s;
334 };
335 static inline void s2dhms(struct dhms *ts, time_t secs)
336 {
337         ts->d = secs / 86400;
338         secs = secs % 86400;
339         ts->h = secs / 3600;
340         secs = secs % 3600;
341         ts->m = secs / 60;
342         ts->s = secs % 60;
343 }
344 #define DHMS_FMT "%dd%dh%02dm%02ds"
345 #define DHMS_VARS(x) (x)->d, (x)->h, (x)->m, (x)->s
346
347
348 #ifdef LPROCFS
349
350 static inline int lprocfs_stats_lock(struct lprocfs_stats *stats, int type)
351 {
352         int rc = 0;
353
354         if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
355                 if (type & LPROCFS_GET_NUM_CPU)
356                         rc = 1;
357                 if (type & LPROCFS_GET_SMP_ID)
358                         rc = 0;
359                 spin_lock(&stats->ls_lock);
360         } else {
361                 if (type & LPROCFS_GET_NUM_CPU)
362                         rc = num_possible_cpus();
363                 if (type & LPROCFS_GET_SMP_ID) {
364                         stats->ls_flags |= LPROCFS_STATS_GET_SMP_ID;
365                         rc = cfs_get_cpu();
366                 }
367         }
368         return rc;
369 }
370
371 static inline void lprocfs_stats_unlock(struct lprocfs_stats *stats)
372 {
373         if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU)
374                 spin_unlock(&stats->ls_lock);
375         else if (stats->ls_flags & LPROCFS_STATS_GET_SMP_ID)
376                 cfs_put_cpu();
377 }
378
379 /* Two optimized LPROCFS counter increment functions are provided:
380  *     lprocfs_counter_incr(cntr, value) - optimized for by-one counters
381  *     lprocfs_counter_add(cntr) - use for multi-valued counters
382  * Counter data layout allows config flag, counter lock and the
383  * count itself to reside within a single cache line.
384  */
385
386 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
387                                 long amount);
388 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
389                                 long amount);
390
391 #define lprocfs_counter_incr(stats, idx) \
392         lprocfs_counter_add(stats, idx, 1)
393 #define lprocfs_counter_decr(stats, idx) \
394         lprocfs_counter_sub(stats, idx, 1)
395
396 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
397                                  enum lprocfs_fields_flags field);
398 static inline __u64 lprocfs_stats_collector(struct lprocfs_stats *stats,
399                                             int idx,
400                                             enum lprocfs_fields_flags field)
401 {
402         __u64 ret = 0;
403         int i;
404
405         LASSERT(stats != NULL);
406         for (i = 0; i < num_possible_cpus(); i++)
407                 ret += lprocfs_read_helper(&(stats->ls_percpu[i]->lp_cntr[idx]),
408                                            field);
409         return ret;
410 }
411
412 extern struct lprocfs_stats *lprocfs_alloc_stats(unsigned int num,
413                                                  enum lprocfs_stats_flags flags);
414 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
415 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
416 extern void lprocfs_init_ops_stats(int num_private_stats,
417                                    struct lprocfs_stats *stats);
418 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
419 extern int lprocfs_alloc_obd_stats(struct obd_device *obddev,
420                                    unsigned int num_private_stats);
421 extern int lprocfs_alloc_md_stats(struct obd_device *obddev,
422                                   unsigned int num_private_stats);
423 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
424                                  unsigned conf, const char *name,
425                                  const char *units);
426 extern void lprocfs_free_obd_stats(struct obd_device *obddev);
427 struct obd_export;
428 struct nid_stat;
429 extern int lprocfs_add_clear_entry(struct obd_device * obd,
430                                    cfs_proc_dir_entry_t *entry);
431 extern int lprocfs_exp_setup(struct obd_export *exp,
432                              lnet_nid_t *peer_nid, int *newnid);
433 extern int lprocfs_exp_cleanup(struct obd_export *exp);
434 extern cfs_proc_dir_entry_t *lprocfs_add_simple(struct proc_dir_entry *root,
435                                                 char *name,
436                                                 cfs_read_proc_t *read_proc,
437                                                 cfs_write_proc_t *write_proc,
438                                                 void *data,
439                                                 struct file_operations *fops);
440 extern struct proc_dir_entry *lprocfs_add_symlink(const char *name,
441                         struct proc_dir_entry *parent, const char *dest);
442 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
443 extern int lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
444                                          unsigned long count, void *data);
445 extern int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
446                                         int count, int *eof,  void *data);
447
448 extern int lprocfs_register_stats(cfs_proc_dir_entry_t *root, const char *name,
449                                   struct lprocfs_stats *stats);
450
451 /* lprocfs_status.c */
452 extern int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
453                             struct lprocfs_vars *var,
454                             void *data);
455
456 extern cfs_proc_dir_entry_t *lprocfs_register(const char *name,
457                                                cfs_proc_dir_entry_t *parent,
458                                                struct lprocfs_vars *list,
459                                                void *data);
460
461 extern void lprocfs_remove(cfs_proc_dir_entry_t **root);
462 extern void lprocfs_remove_proc_entry(const char *name,
463                                       struct proc_dir_entry *parent);
464
465 extern cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *root,
466                                            const char *name);
467
468 extern int lprocfs_obd_setup(struct obd_device *obd, struct lprocfs_vars *list);
469 extern int lprocfs_obd_cleanup(struct obd_device *obd);
470 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
471 extern struct file_operations lprocfs_evict_client_fops;
472
473 extern int lprocfs_seq_create(cfs_proc_dir_entry_t *parent, char *name,
474                               mode_t mode, struct file_operations *seq_fops,
475                               void *data);
476 extern int lprocfs_obd_seq_create(struct obd_device *dev, char *name,
477                                   mode_t mode, struct file_operations *seq_fops,
478                                   void *data);
479
480 /* Generic callbacks */
481
482 extern int lprocfs_rd_u64(char *page, char **start, off_t off,
483                           int count, int *eof, void *data);
484 extern int lprocfs_rd_atomic(char *page, char **start, off_t off,
485                              int count, int *eof, void *data);
486 extern int lprocfs_wr_atomic(struct file *file, const char *buffer,
487                              unsigned long count, void *data);
488 extern int lprocfs_rd_uint(char *page, char **start, off_t off,
489                            int count, int *eof, void *data);
490 extern int lprocfs_wr_uint(struct file *file, const char *buffer,
491                            unsigned long count, void *data);
492 extern int lprocfs_rd_uuid(char *page, char **start, off_t off,
493                            int count, int *eof, void *data);
494 extern int lprocfs_rd_name(char *page, char **start, off_t off,
495                            int count, int *eof, void *data);
496 extern int lprocfs_rd_fstype(char *page, char **start, off_t off,
497                              int count, int *eof, void *data);
498 extern int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
499                                   int count, int *eof, void *data);
500 extern int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
501                                 int count, int *eof, void *data);
502 extern int lprocfs_rd_import(char *page, char **start, off_t off, int count,
503                              int *eof, void *data);
504 extern int lprocfs_rd_state(char *page, char **start, off_t off, int count,
505                             int *eof, void *data);
506 extern int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
507                                     int count, int *eof, void *data);
508 extern int lprocfs_rd_num_exports(char *page, char **start, off_t off,
509                                   int count, int *eof, void *data);
510 extern int lprocfs_rd_numrefs(char *page, char **start, off_t off,
511                               int count, int *eof, void *data);
512 struct adaptive_timeout;
513 extern int lprocfs_at_hist_helper(char *page, int count, int rc,
514                                   struct adaptive_timeout *at);
515 extern int lprocfs_rd_timeouts(char *page, char **start, off_t off,
516                                int count, int *eof, void *data);
517 extern int lprocfs_wr_timeouts(struct file *file, const char *buffer,
518                                unsigned long count, void *data);
519 extern int lprocfs_wr_evict_client(struct file *file, const char *buffer,
520                                    unsigned long count, void *data);
521 extern int lprocfs_wr_ping(struct file *file, const char *buffer,
522                            unsigned long count, void *data);
523
524 extern int lprocfs_rd_quota_resend_count(char *page, char **start, off_t off,
525                                          int count, int *eof, void *data);
526 extern int lprocfs_wr_quota_resend_count(struct file *file, const char *buffer,
527                                          unsigned long count, void *data);
528
529 /* Statfs helpers */
530 extern int lprocfs_rd_blksize(char *page, char **start, off_t off,
531                               int count, int *eof, void *data);
532 extern int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
533                                   int count, int *eof, void *data);
534 extern int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
535                                  int count, int *eof, void *data);
536 extern int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
537                                  int count, int *eof, void *data);
538 extern int lprocfs_rd_filestotal(char *page, char **start, off_t off,
539                                  int count, int *eof, void *data);
540 extern int lprocfs_rd_filesfree(char *page, char **start, off_t off,
541                                 int count, int *eof, void *data);
542 extern int lprocfs_rd_filegroups(char *page, char **start, off_t off,
543                                  int count, int *eof, void *data);
544
545 extern int lprocfs_write_helper(const char *buffer, unsigned long count,
546                                 int *val);
547 extern int lprocfs_write_frac_helper(const char *buffer, unsigned long count,
548                                      int *val, int mult);
549 extern int lprocfs_read_frac_helper(char *buffer, unsigned long count,
550                                     long val, int mult);
551 extern int lprocfs_write_u64_helper(const char *buffer, unsigned long count,
552                                     __u64 *val);
553 extern int lprocfs_write_frac_u64_helper(const char *buffer, unsigned long count,
554                                          __u64 *val, int mult);
555 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
556 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
557 void lprocfs_oh_clear(struct obd_histogram *oh);
558 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
559
560 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
561                            struct lprocfs_counter *cnt);
562
563
564 /* lprocfs_status.c: recovery status */
565 int lprocfs_obd_rd_recovery_status(char *page, char **start, off_t off,
566                                    int count, int *eof, void *data);
567
568 /* lprocfs_statuc.c: hash statistics */
569 int lprocfs_obd_rd_hash(char *page, char **start, off_t off,
570                         int count, int *eof, void *data);
571
572 extern int lprocfs_seq_release(struct inode *, struct file *);
573
574 /* in lprocfs_stat.c, to protect the private data for proc entries */
575 extern struct rw_semaphore _lprocfs_lock;
576 #define LPROCFS_ENTRY()           do {  \
577         down_read(&_lprocfs_lock);      \
578 } while(0)
579 #define LPROCFS_EXIT()            do {  \
580         up_read(&_lprocfs_lock);        \
581 } while(0)
582 #define LPROCFS_ENTRY_AND_CHECK(dp) do {        \
583         typecheck(struct proc_dir_entry *, dp); \
584         LPROCFS_ENTRY();                        \
585         if ((dp)->deleted) {                    \
586                 LPROCFS_EXIT();                 \
587                 return -ENODEV;                 \
588         }                                       \
589 } while(0)
590 #define LPROCFS_WRITE_ENTRY()     do {  \
591         down_write(&_lprocfs_lock);     \
592 } while(0)
593 #define LPROCFS_WRITE_EXIT()      do {  \
594         up_write(&_lprocfs_lock);       \
595 } while(0)
596
597 /* You must use these macros when you want to refer to
598  * the import in a client obd_device for a lprocfs entry */
599 #define LPROCFS_CLIMP_CHECK(obd) do {           \
600         typecheck(struct obd_device *, obd);    \
601         down_read(&(obd)->u.cli.cl_sem);        \
602         if ((obd)->u.cli.cl_import == NULL) {   \
603              up_read(&(obd)->u.cli.cl_sem);     \
604              return -ENODEV;                    \
605         }                                       \
606 } while(0)
607 #define LPROCFS_CLIMP_EXIT(obd)                 \
608         up_read(&(obd)->u.cli.cl_sem);
609
610
611 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
612   proc entries; otherwise, you will define name##_seq_write function also for
613   a read-write proc entry, and then call LPROC_SEQ_SEQ instead. Finally,
614   call lprocfs_obd_seq_create(obd, filename, 0444, &name#_fops, data); */
615 #define __LPROC_SEQ_FOPS(name, custom_seq_write)                           \
616 static int name##_seq_open(struct inode *inode, struct file *file) {       \
617         struct proc_dir_entry *dp = PDE(inode);                            \
618         int rc;                                                            \
619         LPROCFS_ENTRY_AND_CHECK(dp);                                       \
620         rc = single_open(file, name##_seq_show, dp->data);                 \
621         if (rc) {                                                          \
622                 LPROCFS_EXIT();                                            \
623                 return rc;                                                 \
624         }                                                                  \
625         return 0;                                                          \
626 }                                                                          \
627 struct file_operations name##_fops = {                                     \
628         .owner   = THIS_MODULE,                                            \
629         .open    = name##_seq_open,                                        \
630         .read    = seq_read,                                               \
631         .write   = custom_seq_write,                                       \
632         .llseek  = seq_lseek,                                              \
633         .release = lprocfs_seq_release,                                    \
634 }
635
636 #define LPROC_SEQ_FOPS_RO(name)         __LPROC_SEQ_FOPS(name, NULL)
637 #define LPROC_SEQ_FOPS(name)            __LPROC_SEQ_FOPS(name, name##_seq_write)
638
639 /* lproc_ptlrpc.c */
640 struct ptlrpc_request;
641 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
642
643 /* lprocfs_status.c: read recovery max time bz13079 */
644 int lprocfs_obd_rd_recovery_maxtime(char *page, char **start, off_t off,
645                                     int count, int *eof, void *data);
646
647 /* lprocfs_status.c: write recovery max time bz13079 */
648 int lprocfs_obd_wr_recovery_maxtime(struct file *file, const char *buffer,
649                                     unsigned long count, void *data);
650
651 /* all quota proc functions */
652 extern int lprocfs_quota_rd_bunit(char *page, char **start, off_t off, int count,
653                                   int *eof, void *data);
654 extern int lprocfs_quota_wr_bunit(struct file *file, const char *buffer,
655                                   unsigned long count, void *data);
656 extern int lprocfs_quota_rd_btune(char *page, char **start, off_t off, int count,
657                                   int *eof, void *data);
658 extern int lprocfs_quota_wr_btune(struct file *file, const char *buffer,
659                                   unsigned long count, void *data);
660 extern int lprocfs_quota_rd_iunit(char *page, char **start, off_t off, int count,
661                                   int *eof, void *data);
662 extern int lprocfs_quota_wr_iunit(struct file *file, const char *buffer,
663                                   unsigned long count, void *data);
664 extern int lprocfs_quota_rd_itune(char *page, char **start, off_t off, int count,
665                                   int *eof, void *data);
666 extern int lprocfs_quota_wr_itune(struct file *file, const char *buffer,
667                                   unsigned long count, void *data);
668 extern int lprocfs_quota_rd_type(char *page, char **start, off_t off, int count,
669                                  int *eof, void *data);
670 extern int lprocfs_quota_wr_type(struct file *file, const char *buffer,
671                                  unsigned long count, void *data);
672 extern int lprocfs_quota_rd_switch_seconds(char *page, char **start, off_t off,
673                                            int count, int *eof, void *data);
674 extern int lprocfs_quota_wr_switch_seconds(struct file *file, const char *buffer,
675                                            unsigned long count, void *data);
676 extern int lprocfs_quota_rd_sync_blk(char *page, char **start, off_t off,
677                                      int count, int *eof, void *data);
678 extern int lprocfs_quota_wr_sync_blk(struct file *file, const char *buffer,
679                                      unsigned long count, void *data);
680 extern int lprocfs_quota_rd_switch_qs(char *page, char **start, off_t off,
681                                       int count, int *eof, void *data);
682 extern int lprocfs_quota_wr_switch_qs(struct file *file, const char *buffer,
683                                       unsigned long count, void *data);
684 extern int lprocfs_quota_rd_boundary_factor(char *page, char **start, off_t off,
685                                             int count, int *eof, void *data);
686 extern int lprocfs_quota_wr_boundary_factor(struct file *file, const char *buffer,
687                                             unsigned long count, void *data);
688 extern int lprocfs_quota_rd_least_bunit(char *page, char **start, off_t off,
689                                         int count, int *eof, void *data);
690 extern int lprocfs_quota_wr_least_bunit(struct file *file, const char *buffer,
691                                         unsigned long count, void *data);
692 extern int lprocfs_quota_rd_least_iunit(char *page, char **start, off_t off,
693                                         int count, int *eof, void *data);
694 extern int lprocfs_quota_wr_least_iunit(struct file *file, const char *buffer,
695                                         unsigned long count, void *data);
696 extern int lprocfs_quota_rd_qs_factor(char *page, char **start, off_t off,
697                                       int count, int *eof, void *data);
698 extern int lprocfs_quota_wr_qs_factor(struct file *file, const char *buffer,
699                                       unsigned long count, void *data);
700
701
702
703 #else
704 /* LPROCFS is not defined */
705
706
707
708 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
709                                        int index, long amount) { return; }
710 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
711                                         int index) { return; }
712 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
713                                        int index, long amount) { return; }
714 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
715                                         int index, unsigned conf,
716                                         const char *name, const char *units)
717 { return; }
718
719 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
720                                    enum lprocfs_fields_flags field)
721 { return 0; }
722
723 static inline struct lprocfs_stats* lprocfs_alloc_stats(unsigned int num,
724                                                         enum lprocfs_stats_flags flags)
725 { return NULL; }
726 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
727 { return; }
728 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
729 { return; }
730 static inline int lprocfs_register_stats(cfs_proc_dir_entry_t *root,
731                                             const char *name,
732                                             struct lprocfs_stats *stats)
733 { return 0; }
734 static inline void lprocfs_init_ops_stats(int num_private_stats,
735                                           struct lprocfs_stats *stats)
736 { return; }
737 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
738 { return; }
739 static inline int lprocfs_alloc_obd_stats(struct obd_device *obddev,
740                                           unsigned int num_private_stats)
741 { return 0; }
742 static inline int lprocfs_alloc_md_stats(struct obd_device *obddev,
743                                          unsigned int num_private_stats)
744 { return 0; }
745 static inline void lprocfs_free_obd_stats(struct obd_device *obddev)
746 { return; }
747
748 struct obd_export;
749 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
750 { return 0; }
751 static inline int lprocfs_exp_setup(struct obd_export *exp,
752                                     lnet_nid_t *peer_nid, int *newnid)
753 { return 0; }
754 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
755 { return 0; }
756 static inline cfs_proc_dir_entry_t *lprocfs_add_simple(struct proc_dir_entry *root,
757                                      char *name,
758                                      cfs_read_proc_t *read_proc,
759                                      cfs_write_proc_t *write_proc,
760                                      void *data,
761                                      struct file_operations *fops)
762 {return 0; }
763 static inline struct proc_dir_entry *lprocfs_add_symlink(const char *name,
764                         struct proc_dir_entry *parent, const char *dest)
765 {return NULL; }
766 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
767 {}
768 static inline
769 int lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
770                                   unsigned long count, void *data)
771 {return count;}
772 static inline
773 int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
774                                  int count, int *eof,  void *data)
775 {return count;}
776
777 static inline cfs_proc_dir_entry_t *
778 lprocfs_register(const char *name, cfs_proc_dir_entry_t *parent,
779                  struct lprocfs_vars *list, void *data) { return NULL; }
780 static inline int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
781                                    struct lprocfs_vars *var,
782                                    void *data) { return 0; }
783 static inline void lprocfs_remove(cfs_proc_dir_entry_t **root) {};
784 static inline void lprocfs_remove_proc_entry(const char *name,
785                                              struct proc_dir_entry *parent) {};
786 static inline cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *head,
787                                     const char *name) {return 0;}
788 static inline int lprocfs_obd_setup(struct obd_device *dev,
789                                     struct lprocfs_vars *list) { return 0; }
790 static inline int lprocfs_obd_cleanup(struct obd_device *dev)  { return 0; }
791 static inline int lprocfs_rd_u64(char *page, char **start, off_t off,
792                                  int count, int *eof, void *data) { return 0; }
793 static inline int lprocfs_rd_uuid(char *page, char **start, off_t off,
794                                   int count, int *eof, void *data) { return 0; }
795 static inline int lprocfs_rd_name(char *page, char **start, off_t off,
796                                   int count, int *eof, void *data) { return 0; }
797 static inline int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
798                                          int count, int *eof, void *data)
799 { return 0; }
800 static inline int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
801                                        int count, int *eof, void *data)
802 { return 0; }
803 static inline int lprocfs_rd_import(char *page, char **start, off_t off,
804                                     int count, int *eof, void *data)
805 { return 0; }
806 static inline int lprocfs_rd_state(char *page, char **start, off_t off,
807                                    int count, int *eof, void *data)
808 { return 0; }
809 static inline int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
810                                            int count, int *eof, void *data)
811 { return 0; }
812 static inline int lprocfs_rd_num_exports(char *page, char **start, off_t off,
813                                          int count, int *eof, void *data)
814 { return 0; }
815 static inline int lprocfs_rd_numrefs(char *page, char **start, off_t off,
816                                      int count, int *eof, void *data)
817 { return 0; }
818 struct adaptive_timeout;
819 static inline int lprocfs_at_hist_helper(char *page, int count, int rc,
820                                          struct adaptive_timeout *at)
821 { return 0; }
822 static inline int lprocfs_rd_timeouts(char *page, char **start, off_t off,
823                                       int count, int *eof, void *data)
824 { return 0; }
825 static inline int lprocfs_wr_timeouts(struct file *file, const char *buffer,
826                                       unsigned long count, void *data)
827 { return 0; }
828 static inline int lprocfs_wr_evict_client(struct file *file, const char *buffer,
829                                           unsigned long count, void *data)
830 { return 0; }
831 static inline int lprocfs_wr_ping(struct file *file, const char *buffer,
832                                   unsigned long count, void *data)
833 { return 0; }
834
835
836 /* Statfs helpers */
837 static inline
838 int lprocfs_rd_blksize(char *page, char **start, off_t off,
839                        int count, int *eof, void *data) { return 0; }
840 static inline
841 int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
842                            int count, int *eof, void *data) { return 0; }
843 static inline
844 int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
845                           int count, int *eof, void *data) { return 0; }
846 static inline
847 int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
848                            int count, int *eof, void *data) { return 0; }
849 static inline
850 int lprocfs_rd_filestotal(char *page, char **start, off_t off,
851                           int count, int *eof, void *data) { return 0; }
852 static inline
853 int lprocfs_rd_filesfree(char *page, char **start, off_t off,
854                          int count, int *eof, void *data)  { return 0; }
855 static inline
856 int lprocfs_rd_filegroups(char *page, char **start, off_t off,
857                           int count, int *eof, void *data) { return 0; }
858 static inline
859 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value) {}
860 static inline
861 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value) {}
862 static inline
863 void lprocfs_oh_clear(struct obd_histogram *oh) {}
864 static inline
865 unsigned long lprocfs_oh_sum(struct obd_histogram *oh) { return 0; }
866 static inline
867 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
868                            struct lprocfs_counter *cnt) {}
869
870 static inline
871 __u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
872                                enum lprocfs_fields_flags field)
873 { return (__u64)0; }
874
875 #define LPROCFS_ENTRY()
876 #define LPROCFS_EXIT()
877 #define LPROCFS_ENTRY_AND_CHECK(dp)
878 #define LPROC_SEQ_FOPS_RO(name)
879 #define LPROC_SEQ_FOPS(name)
880
881 /* lproc_ptlrpc.c */
882 #define target_print_req NULL
883
884 #endif /* LPROCFS */
885
886 #endif /* LPROCFS_SNMP_H */