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 [sun.com URL with a
  20  * copy of GPLv2].
  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 #include <lustre/lustre_idl.h>
  46 #if defined(__linux__)
  47 #include <linux/lprocfs_status.h>
  48 #elif defined(__APPLE__)
  49 #include <darwin/lprocfs_status.h>
  50 #elif defined(__WINNT__)
  51 #include <winnt/lprocfs_status.h>
  52 #else
  53 #error Unsupported operating system.
  54 #endif
  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
  69 struct lprocfs_static_vars {
  70         struct lprocfs_vars *module_vars;
  71         struct lprocfs_vars *obd_vars;
  72 };
  73
  74 /* if we find more consumers this could be generalized */
  75 #define OBD_HIST_MAX 32
  76 struct obd_histogram {
  77         spinlock_t      oh_lock;
  78         unsigned long   oh_buckets[OBD_HIST_MAX];
  79 };
  80
  81 enum {
  82         BRW_R_PAGES = 0,
  83         BRW_W_PAGES,
  84         BRW_R_RPC_HIST,
  85         BRW_W_RPC_HIST,
  86         BRW_R_IO_TIME,
  87         BRW_W_IO_TIME,
  88         BRW_R_DISCONT_PAGES,
  89         BRW_W_DISCONT_PAGES,
  90         BRW_R_DISCONT_BLOCKS,
  91         BRW_W_DISCONT_BLOCKS,
  92         BRW_R_DISK_IOSIZE,
  93         BRW_W_DISK_IOSIZE,
  94         BRW_R_DIO_FRAGS,
  95         BRW_W_DIO_FRAGS,
  96         BRW_LAST,
  97 };
  98
  99 struct brw_stats {
 100         struct obd_histogram hist[BRW_LAST];
 101 };
 102
 103
 104 /* An lprocfs counter can be configured using the enum bit masks below.
 105  *
 106  * LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
 107  * protects this counter from concurrent updates. If not specified,
 108  * lprocfs an internal per-counter lock variable. External locks are
 109  * not used to protect counter increments, but are used to protect
 110  * counter readout and resets.
 111  *
 112  * LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
 113  * (i.e. counter can be incremented by more than "1"). When specified,
 114  * the counter maintains min, max and sum in addition to a simple
 115  * invocation count. This allows averages to be be computed.
 116  * If not specified, the counter is an increment-by-1 counter.
 117  * min, max, sum, etc. are not maintained.
 118  *
 119  * LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
 120  * squares (for multi-valued counter samples only). This allows
 121  * external computation of standard deviation, but involves a 64-bit
 122  * multiply per counter increment.
 123  */
 124
 125 enum {
 126         LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
 127         LPROCFS_CNTR_AVGMINMAX    = 0x0002,
 128         LPROCFS_CNTR_STDDEV       = 0x0004,
 129
 130         /* counter data type */
 131         LPROCFS_TYPE_REGS         = 0x0100,
 132         LPROCFS_TYPE_BYTES        = 0x0200,
 133         LPROCFS_TYPE_PAGES        = 0x0400,
 134         LPROCFS_TYPE_CYCLE        = 0x0800,
 135 };
 136
 137 struct lprocfs_atomic {
 138         atomic_t               la_entry;
 139         atomic_t               la_exit;
 140 };
 141
 142 #define LC_MIN_INIT ((~(__u64)0) >> 1)
 143
 144 struct lprocfs_counter {
 145         struct lprocfs_atomic  lc_cntl;  /* may need to move to per set */
 146         unsigned int           lc_config;
 147         __s64                  lc_count;
 148         __s64                  lc_sum;
 149         __s64                  lc_min;
 150         __s64                  lc_max;
 151         __s64                  lc_sumsquare;
 152         const char            *lc_name;   /* must be static */
 153         const char            *lc_units;  /* must be static */
 154 };
 155
 156 struct lprocfs_percpu {
 157         struct lprocfs_counter lp_cntr[0];
 158 };
 159
 160 #define LPROCFS_GET_NUM_CPU 0x0001
 161 #define LPROCFS_GET_SMP_ID  0x0002
 162
 163 enum lprocfs_stats_flags {
 164         LPROCFS_STATS_FLAG_PERCPU   = 0x0000, /* per cpu counter */
 165         LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
 166                                                * area and need locking */
 167 };
 168
 169 enum lprocfs_fields_flags {
 170         LPROCFS_FIELDS_FLAGS_CONFIG     = 0x0001,
 171         LPROCFS_FIELDS_FLAGS_SUM        = 0x0002,
 172         LPROCFS_FIELDS_FLAGS_MIN        = 0x0003,
 173         LPROCFS_FIELDS_FLAGS_MAX        = 0x0004,
 174         LPROCFS_FIELDS_FLAGS_AVG        = 0x0005,
 175         LPROCFS_FIELDS_FLAGS_SUMSQUARE  = 0x0006,
 176         LPROCFS_FIELDS_FLAGS_COUNT      = 0x0007,
 177 };
 178
 179 struct lprocfs_stats {
 180         unsigned int           ls_num;     /* # of counters */
 181         int                    ls_flags; /* See LPROCFS_STATS_FLAG_* */
 182         spinlock_t             ls_lock;  /* Lock used only when there are
 183                                           * no percpu stats areas */
 184         struct lprocfs_percpu *ls_percpu[0];
 185 };
 186
 187 static inline int opcode_offset(__u32 opc) {
 188         if (opc < OST_LAST_OPC) {
 189                  /* OST opcode */
 190                 return (opc - OST_FIRST_OPC);
 191         } else if (opc < MDS_LAST_OPC) {
 192                 /* MDS opcode */
 193                 return (opc - MDS_FIRST_OPC +
 194                         (OST_LAST_OPC - OST_FIRST_OPC));
 195         } else if (opc < LDLM_LAST_OPC) {
 196                 /* LDLM Opcode */
 197                 return (opc - LDLM_FIRST_OPC +
 198                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 199                         (OST_LAST_OPC - OST_FIRST_OPC));
 200         } else if (opc < MGS_LAST_OPC) {
 201                 /* MGS Opcode */
 202                 return (opc - MGS_FIRST_OPC +
 203                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 204                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 205                         (OST_LAST_OPC - OST_FIRST_OPC));
 206         } else if (opc < OBD_LAST_OPC) {
 207                 /* OBD Ping */
 208                 return (opc - OBD_FIRST_OPC +
 209                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 210                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 211                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 212                         (OST_LAST_OPC - OST_FIRST_OPC));
 213         } else if (opc < LLOG_LAST_OPC) {
 214                 /* LLOG Opcode */
 215                 return (opc - LLOG_FIRST_OPC +
 216                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 217                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 218                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 219                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 220                         (OST_LAST_OPC - OST_FIRST_OPC));
 221 } else if (opc < FLD_LAST_OPC) {
 222                 /* FLD opcode */
 223                 return (opc - FLD_FIRST_OPC +
 224                         (LLOG_LAST_OPC - LLOG_FIRST_OPC) +
 225                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 226                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 227                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 228                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 229                         (OST_LAST_OPC - OST_FIRST_OPC));
 230         } else if (opc < SEQ_LAST_OPC) {
 231                 /* SEQ opcode */
 232                 return (opc - SEQ_FIRST_OPC +
 233                         (FLD_LAST_OPC - FLD_FIRST_OPC) +
 234                         (LLOG_LAST_OPC - LLOG_FIRST_OPC) +
 235                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 236                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 237                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 238                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 239                         (OST_LAST_OPC - OST_FIRST_OPC));
 240         } else if (opc < SEC_LAST_OPC) {
 241                 /* SEC opcode */
 242                 return (opc - SEC_FIRST_OPC +
 243                         (SEQ_LAST_OPC - SEQ_FIRST_OPC) +
 244                         (FLD_LAST_OPC - FLD_FIRST_OPC) +
 245                         (LLOG_LAST_OPC - LLOG_FIRST_OPC) +
 246                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 247                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 248                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 249                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 250                         (OST_LAST_OPC - OST_FIRST_OPC));
 251         } else {
 252                 /* Unknown Opcode */
 253                 return -1;
 254         }
 255 }
 256
 257 #define LUSTRE_MAX_OPCODES ((LDLM_LAST_OPC - LDLM_FIRST_OPC)   + \
 258                             (MDS_LAST_OPC - MDS_FIRST_OPC)     + \
 259                             (OST_LAST_OPC - OST_FIRST_OPC)     + \
 260                             (OBD_LAST_OPC - OBD_FIRST_OPC)     + \
 261                             (FLD_LAST_OPC - FLD_FIRST_OPC)     + \
 262                             (SEQ_LAST_OPC - SEQ_FIRST_OPC)     + \
 263                             (MGS_LAST_OPC - MGS_FIRST_OPC)     + \
 264                             (LLOG_LAST_OPC - LLOG_FIRST_OPC)   + \
 265                             (SEC_LAST_OPC - SEC_FIRST_OPC))
 266
 267 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR)  + \
 268                            (EXTRA_LAST_OPC - EXTRA_FIRST_OPC))
 269
 270 enum {
 271         PTLRPC_REQWAIT_CNTR = 0,
 272         PTLRPC_REQQDEPTH_CNTR,
 273         PTLRPC_REQACTIVE_CNTR,
 274         PTLRPC_TIMEOUT,
 275         PTLRPC_REQBUF_AVAIL_CNTR,
 276         PTLRPC_LAST_CNTR
 277 };
 278
 279 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
 280
 281 enum {
 282         LDLM_GLIMPSE_ENQUEUE = 0,
 283         LDLM_PLAIN_ENQUEUE,
 284         LDLM_EXTENT_ENQUEUE,
 285         LDLM_FLOCK_ENQUEUE,
 286         LDLM_IBITS_ENQUEUE,
 287         MDS_REINT_CREATE,
 288         MDS_REINT_LINK,
 289         MDS_REINT_OPEN,
 290         MDS_REINT_SETATTR,
 291         MDS_REINT_RENAME,
 292         MDS_REINT_UNLINK,
 293         EXTRA_LAST_OPC
 294 };
 295
 296 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
 297 /* class_obd.c */
 298 extern cfs_proc_dir_entry_t *proc_lustre_root;
 299
 300 struct obd_device;
 301 struct file;
 302 struct obd_histogram;
 303
 304 /* Days / hours / mins / seconds format */
 305 struct dhms {
 306         int d,h,m,s;
 307 };
 308 static inline void s2dhms(struct dhms *ts, time_t secs)
 309 {
 310         ts->d = secs / 86400;
 311         secs = secs % 86400;
 312         ts->h = secs / 3600;
 313         secs = secs % 3600;
 314         ts->m = secs / 60;
 315         ts->s = secs % 60;
 316 }
 317 #define DHMS_FMT "%dd%dh%02dm%02ds"
 318 #define DHMS_VARS(x) (x)->d, (x)->h, (x)->m, (x)->s
 319
 320
 321 #ifdef LPROCFS
 322
 323 static inline int lprocfs_stats_lock(struct lprocfs_stats *stats, int type)
 324 {
 325         int rc = 0;
 326
 327         if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
 328                 if (type & LPROCFS_GET_NUM_CPU)
 329                         rc = 1;
 330                 if (type & LPROCFS_GET_SMP_ID)
 331                         rc = 0;
 332                 spin_lock(&stats->ls_lock);
 333         } else {
 334                 if (type & LPROCFS_GET_NUM_CPU)
 335                         rc = num_possible_cpus();
 336                 if (type & LPROCFS_GET_SMP_ID)
 337                         rc = smp_processor_id();
 338         }
 339         return rc;
 340 }
 341
 342 static inline void lprocfs_stats_unlock(struct lprocfs_stats *stats)
 343 {
 344         if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU)
 345                 spin_unlock(&stats->ls_lock);
 346 }
 347
 348 /* Two optimized LPROCFS counter increment functions are provided:
 349  *     lprocfs_counter_incr(cntr, value) - optimized for by-one counters
 350  *     lprocfs_counter_add(cntr) - use for multi-valued counters
 351  * Counter data layout allows config flag, counter lock and the
 352  * count itself to reside within a single cache line.
 353  */
 354
 355 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
 356                                 long amount);
 357 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
 358                                 long amount);
 359
 360 #define lprocfs_counter_incr(stats, idx) \
 361         lprocfs_counter_add(stats, idx, 1)
 362 #define lprocfs_counter_decr(stats, idx) \
 363         lprocfs_counter_sub(stats, idx, 1)
 364
 365 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
 366                                  enum lprocfs_fields_flags field);
 367 static inline __u64 lprocfs_stats_collector(struct lprocfs_stats *stats,
 368                                             int idx,
 369                                             enum lprocfs_fields_flags field)
 370 {
 371         __u64 ret = 0;
 372         int i;
 373
 374         LASSERT(stats != NULL);
 375         for (i = 0; i < num_possible_cpus(); i++)
 376                 ret += lprocfs_read_helper(&(stats->ls_percpu[i]->lp_cntr[idx]),
 377                                            field);
 378         return ret;
 379 }
 380
 381 extern struct lprocfs_stats *lprocfs_alloc_stats(unsigned int num,
 382                                                  enum lprocfs_stats_flags flags);
 383 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
 384 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
 385 extern void lprocfs_init_ops_stats(int num_private_stats,
 386                                    struct lprocfs_stats *stats);
 387 extern int lprocfs_alloc_obd_stats(struct obd_device *obddev,
 388                                    unsigned int num_private_stats);
 389 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
 390                                  unsigned conf, const char *name,
 391                                  const char *units);
 392 extern void lprocfs_free_obd_stats(struct obd_device *obddev);
 393 struct obd_export;
 394 struct nid_stat;
 395 extern int lprocfs_add_clear_entry(struct obd_device * obd,
 396                                    cfs_proc_dir_entry_t *entry);
 397 extern int lprocfs_exp_setup(struct obd_export *exp,
 398                              lnet_nid_t *peer_nid, int *newnid);
 399 extern int lprocfs_exp_cleanup(struct obd_export *exp);
 400 extern int lprocfs_add_simple(struct proc_dir_entry *root,
 401                               char *name, cfs_read_proc_t *read_proc,
 402                               cfs_write_proc_t *write_proc, void *data);
 403 extern struct proc_dir_entry *lprocfs_add_symlink(const char *name,
 404                         struct proc_dir_entry *parent, const char *dest);
 405 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
 406 extern int lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
 407                                          unsigned long count, void *data);
 408 extern int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
 409                                         int count, int *eof,  void *data);
 410
 411 extern int lprocfs_register_stats(cfs_proc_dir_entry_t *root, const char *name,
 412                                   struct lprocfs_stats *stats);
 413
 414 /* lprocfs_status.c */
 415 extern int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
 416                             struct lprocfs_vars *var,
 417                             void *data);
 418
 419 extern cfs_proc_dir_entry_t *lprocfs_register(const char *name,
 420                                                cfs_proc_dir_entry_t *parent,
 421                                                struct lprocfs_vars *list,
 422                                                void *data);
 423
 424 extern void lprocfs_remove(cfs_proc_dir_entry_t **root);
 425 extern void lprocfs_remove_proc_entry(const char *name,
 426                                       struct proc_dir_entry *parent);
 427
 428 extern cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *root,
 429                                            const char *name);
 430
 431 extern int lprocfs_obd_setup(struct obd_device *obd, struct lprocfs_vars *list);
 432 extern int lprocfs_obd_cleanup(struct obd_device *obd);
 433 extern int lprocfs_add_simple(struct proc_dir_entry *root, char *name,
 434                               cfs_read_proc_t *read_proc,
 435                               cfs_write_proc_t *write_proc,
 436                               void *data);
 437 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
 438 extern struct file_operations lprocfs_evict_client_fops;
 439
 440 extern int lprocfs_seq_create(cfs_proc_dir_entry_t *parent, char *name,
 441                               mode_t mode, struct file_operations *seq_fops,
 442                               void *data);
 443 extern int lprocfs_obd_seq_create(struct obd_device *dev, char *name,
 444                                   mode_t mode, struct file_operations *seq_fops,
 445                                   void *data);
 446
 447 /* Generic callbacks */
 448
 449 extern int lprocfs_rd_u64(char *page, char **start, off_t off,
 450                           int count, int *eof, void *data);
 451 extern int lprocfs_rd_atomic(char *page, char **start, off_t off,
 452                              int count, int *eof, void *data);
 453 extern int lprocfs_wr_atomic(struct file *file, const char *buffer,
 454                              unsigned long count, void *data);
 455 extern int lprocfs_rd_uint(char *page, char **start, off_t off,
 456                            int count, int *eof, void *data);
 457 extern int lprocfs_wr_uint(struct file *file, const char *buffer,
 458                            unsigned long count, void *data);
 459 extern int lprocfs_rd_uuid(char *page, char **start, off_t off,
 460                            int count, int *eof, void *data);
 461 extern int lprocfs_rd_name(char *page, char **start, off_t off,
 462                            int count, int *eof, void *data);
 463 extern int lprocfs_rd_fstype(char *page, char **start, off_t off,
 464                              int count, int *eof, void *data);
 465 extern int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
 466                                   int count, int *eof, void *data);
 467 extern int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
 468                                 int count, int *eof, void *data);
 469 extern int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
 470                                     int count, int *eof, void *data);
 471 extern int lprocfs_rd_num_exports(char *page, char **start, off_t off,
 472                                   int count, int *eof, void *data);
 473 extern int lprocfs_rd_numrefs(char *page, char **start, off_t off,
 474                               int count, int *eof, void *data);
 475 struct adaptive_timeout;
 476 extern int lprocfs_at_hist_helper(char *page, int count, int rc,
 477                                   struct adaptive_timeout *at);
 478 extern int lprocfs_rd_timeouts(char *page, char **start, off_t off,
 479                                int count, int *eof, void *data);
 480 extern int lprocfs_wr_timeouts(struct file *file, const char *buffer,
 481                                unsigned long count, void *data);
 482 extern int lprocfs_wr_evict_client(struct file *file, const char *buffer,
 483                                    unsigned long count, void *data);
 484 extern int lprocfs_wr_ping(struct file *file, const char *buffer,
 485                            unsigned long count, void *data);
 486
 487 /* Statfs helpers */
 488 extern int lprocfs_rd_blksize(char *page, char **start, off_t off,
 489                               int count, int *eof, void *data);
 490 extern int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
 491                                   int count, int *eof, void *data);
 492 extern int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
 493                                  int count, int *eof, void *data);
 494 extern int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
 495                                  int count, int *eof, void *data);
 496 extern int lprocfs_rd_filestotal(char *page, char **start, off_t off,
 497                                  int count, int *eof, void *data);
 498 extern int lprocfs_rd_filesfree(char *page, char **start, off_t off,
 499                                 int count, int *eof, void *data);
 500 extern int lprocfs_rd_filegroups(char *page, char **start, off_t off,
 501                                  int count, int *eof, void *data);
 502
 503 extern int lprocfs_write_helper(const char *buffer, unsigned long count,
 504                                 int *val);
 505 extern int lprocfs_write_frac_helper(const char *buffer, unsigned long count,
 506                                      int *val, int mult);
 507 extern int lprocfs_read_frac_helper(char *buffer, unsigned long count,
 508                                     long val, int mult);
 509 extern int lprocfs_write_u64_helper(const char *buffer, unsigned long count,
 510                                     __u64 *val);
 511 extern int lprocfs_write_frac_u64_helper(const char *buffer, unsigned long count,
 512                                          __u64 *val, int mult);
 513 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
 514 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
 515 void lprocfs_oh_clear(struct obd_histogram *oh);
 516 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
 517
 518 /* lprocfs_status.c: counter read/write functions */
 519 extern int lprocfs_counter_read(char *page, char **start, off_t off,
 520                                 int count, int *eof, void *data);
 521 extern int lprocfs_counter_write(struct file *file, const char *buffer,
 522                                  unsigned long count, void *data);
 523
 524 /* lprocfs_status.c: recovery status */
 525 int lprocfs_obd_rd_recovery_status(char *page, char **start, off_t off,
 526                                    int count, int *eof, void *data);
 527
 528 extern int lprocfs_seq_release(struct inode *, struct file *);
 529
 530 /* in lprocfs_stat.c, to protect the private data for proc entries */
 531 extern struct rw_semaphore _lprocfs_lock;
 532 #define LPROCFS_ENTRY()           do {  \
 533         down_read(&_lprocfs_lock);      \
 534 } while(0)
 535 #define LPROCFS_EXIT()            do {  \
 536         up_read(&_lprocfs_lock);        \
 537 } while(0)
 538 #define LPROCFS_ENTRY_AND_CHECK(dp) do {        \
 539         typecheck(struct proc_dir_entry *, dp); \
 540         LPROCFS_ENTRY();                        \
 541         if ((dp)->deleted) {                    \
 542                 LPROCFS_EXIT();                 \
 543                 return -ENODEV;                 \
 544         }                                       \
 545 } while(0)
 546 #define LPROCFS_WRITE_ENTRY()     do {  \
 547         down_write(&_lprocfs_lock);     \
 548 } while(0)
 549 #define LPROCFS_WRITE_EXIT()      do {  \
 550         up_write(&_lprocfs_lock);       \
 551 } while(0)
 552
 553 /* You must use these macros when you want to refer to
 554  * the import in a client obd_device for a lprocfs entry */
 555 #define LPROCFS_CLIMP_CHECK(obd) do {           \
 556         typecheck(struct obd_device *, obd);    \
 557         down_read(&(obd)->u.cli.cl_sem);        \
 558         if ((obd)->u.cli.cl_import == NULL) {   \
 559              up_read(&(obd)->u.cli.cl_sem);     \
 560              return -ENODEV;                    \
 561         }                                       \
 562 } while(0)
 563 #define LPROCFS_CLIMP_EXIT(obd)                 \
 564         up_read(&(obd)->u.cli.cl_sem);
 565
 566
 567 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
 568   proc entries; otherwise, you will define name##_seq_write function also for
 569   a read-write proc entry, and then call LPROC_SEQ_SEQ instead. Finally,
 570   call lprocfs_obd_seq_create(obd, filename, 0444, &name#_fops, data); */
 571 #define __LPROC_SEQ_FOPS(name, custom_seq_write)                           \
 572 static int name##_seq_open(struct inode *inode, struct file *file) {       \
 573         struct proc_dir_entry *dp = PDE(inode);                            \
 574         int rc;                                                            \
 575         LPROCFS_ENTRY_AND_CHECK(dp);                                       \
 576         rc = single_open(file, name##_seq_show, dp->data);                 \
 577         if (rc) {                                                          \
 578                 LPROCFS_EXIT();                                            \
 579                 return rc;                                                 \
 580         }                                                                  \
 581         return 0;                                                          \
 582 }                                                                          \
 583 struct file_operations name##_fops = {                                     \
 584         .owner   = THIS_MODULE,                                            \
 585         .open    = name##_seq_open,                                        \
 586         .read    = seq_read,                                               \
 587         .write   = custom_seq_write,                                       \
 588         .llseek  = seq_lseek,                                              \
 589         .release = lprocfs_seq_release,                                    \
 590 }
 591
 592 #define LPROC_SEQ_FOPS_RO(name)         __LPROC_SEQ_FOPS(name, NULL)
 593 #define LPROC_SEQ_FOPS(name)            __LPROC_SEQ_FOPS(name, name##_seq_write)
 594
 595 /* lproc_ptlrpc.c */
 596 struct ptlrpc_request;
 597 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
 598
 599 /* lprocfs_status.c: read recovery max time bz13079 */
 600 int lprocfs_obd_rd_recovery_maxtime(char *page, char **start, off_t off,
 601                                     int count, int *eof, void *data);
 602
 603 /* lprocfs_status.c: write recovery max time bz13079 */
 604 int lprocfs_obd_wr_recovery_maxtime(struct file *file, const char *buffer,
 605                                     unsigned long count, void *data);
 606 #else
 607 /* LPROCFS is not defined */
 608 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
 609                                        int index, long amount) { return; }
 610 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
 611                                         int index) { return; }
 612 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
 613                                        int index, long amount) { return; }
 614 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
 615                                         int index, unsigned conf,
 616                                         const char *name, const char *units)
 617 { return; }
 618
 619 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
 620                                    enum lprocfs_fields_flags field)
 621 { return 0; }
 622
 623 static inline struct lprocfs_stats* lprocfs_alloc_stats(unsigned int num,
 624                                                         enum lprocfs_stats_flags flags)
 625 { return NULL; }
 626 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
 627 { return; }
 628 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
 629 { return; }
 630 static inline int lprocfs_register_stats(cfs_proc_dir_entry_t *root,
 631                                             const char *name,
 632                                             struct lprocfs_stats *stats)
 633 { return 0; }
 634 static inline void lprocfs_init_ops_stats(int num_private_stats,
 635                                           struct lprocfs_stats *stats)
 636 { return; }
 637 static inline int lprocfs_alloc_obd_stats(struct obd_device *obddev,
 638                                              unsigned int num_private_stats)
 639 { return 0; }
 640 static inline void lprocfs_free_obd_stats(struct obd_device *obddev)
 641 { return; }
 642
 643 struct obd_export;
 644 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
 645 { return 0; }
 646 static inline int lprocfs_exp_setup(struct obd_export *exp,
 647                                     lnet_nid_t *peer_nid, int *newnid)
 648 { return 0; }
 649 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
 650 { return 0; }
 651 static inline int lprocfs_add_simple(struct proc_dir_entry *root,
 652                                      char *name,
 653                                      cfs_read_proc_t *read_proc,
 654                                      cfs_write_proc_t *write_proc,
 655                                      void *data)
 656 {return 0; }
 657 static inline struct proc_dir_entry *lprocfs_add_symlink(const char *name,
 658                         struct proc_dir_entry *parent, const char *dest)
 659 {return NULL; }
 660 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
 661 {}
 662 static inline
 663 int lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
 664                                   unsigned long count, void *data)
 665 {return count;}
 666 static inline
 667 int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
 668                                  int count, int *eof,  void *data)
 669 {return count;}
 670
 671 static inline cfs_proc_dir_entry_t *
 672 lprocfs_register(const char *name, cfs_proc_dir_entry_t *parent,
 673                  struct lprocfs_vars *list, void *data) { return NULL; }
 674 static inline int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
 675                                    struct lprocfs_vars *var,
 676                                    void *data) { return 0; }
 677 static inline void lprocfs_remove(cfs_proc_dir_entry_t **root) {};
 678 static inline void lprocfs_remove_proc_entry(const char *name,
 679                                              struct proc_dir_entry *parent) {};
 680 static inline cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *head,
 681                                     const char *name) {return 0;}
 682 static inline int lprocfs_obd_setup(struct obd_device *dev,
 683                                     struct lprocfs_vars *list) { return 0; }
 684 static inline int lprocfs_obd_cleanup(struct obd_device *dev)  { return 0; }
 685 static inline int lprocfs_rd_u64(char *page, char **start, off_t off,
 686                                  int count, int *eof, void *data) { return 0; }
 687 static inline int lprocfs_rd_uuid(char *page, char **start, off_t off,
 688                                   int count, int *eof, void *data) { return 0; }
 689 static inline int lprocfs_rd_name(char *page, char **start, off_t off,
 690                                   int count, int *eof, void *data) { return 0; }
 691 static inline int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
 692                                          int count, int *eof, void *data)
 693 { return 0; }
 694 static inline int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
 695                                        int count, int *eof, void *data)
 696 { return 0; }
 697 static inline int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
 698                                            int count, int *eof, void *data)
 699 { return 0; }
 700 static inline int lprocfs_rd_num_exports(char *page, char **start, off_t off,
 701                                          int count, int *eof, void *data)
 702 { return 0; }
 703 static inline int lprocfs_rd_numrefs(char *page, char **start, off_t off,
 704                                      int count, int *eof, void *data)
 705 { return 0; }
 706 struct adaptive_timeout;
 707 static inline int lprocfs_at_hist_helper(char *page, int count, int rc,
 708                                          struct adaptive_timeout *at)
 709 { return 0; }
 710 static inline int lprocfs_rd_timeouts(char *page, char **start, off_t off,
 711                                       int count, int *eof, void *data)
 712 { return 0; }
 713 static inline int lprocfs_wr_timeouts(struct file *file, const char *buffer,
 714                                       unsigned long count, void *data)
 715 { return 0; }
 716 static inline int lprocfs_wr_evict_client(struct file *file, const char *buffer,
 717                                           unsigned long count, void *data)
 718 { return 0; }
 719 static inline int lprocfs_wr_ping(struct file *file, const char *buffer,
 720                                   unsigned long count, void *data)
 721 { return 0; }
 722
 723
 724 /* Statfs helpers */
 725 static inline
 726 int lprocfs_rd_blksize(char *page, char **start, off_t off,
 727                        int count, int *eof, void *data) { return 0; }
 728 static inline
 729 int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
 730                            int count, int *eof, void *data) { return 0; }
 731 static inline
 732 int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
 733                           int count, int *eof, void *data) { return 0; }
 734 static inline
 735 int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
 736                            int count, int *eof, void *data) { return 0; }
 737 static inline
 738 int lprocfs_rd_filestotal(char *page, char **start, off_t off,
 739                           int count, int *eof, void *data) { return 0; }
 740 static inline
 741 int lprocfs_rd_filesfree(char *page, char **start, off_t off,
 742                          int count, int *eof, void *data)  { return 0; }
 743 static inline
 744 int lprocfs_rd_filegroups(char *page, char **start, off_t off,
 745                           int count, int *eof, void *data) { return 0; }
 746 static inline
 747 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value) {}
 748 static inline
 749 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value) {}
 750 static inline
 751 void lprocfs_oh_clear(struct obd_histogram *oh) {}
 752 static inline
 753 unsigned long lprocfs_oh_sum(struct obd_histogram *oh) { return 0; }
 754 static inline
 755 int lprocfs_counter_read(char *page, char **start, off_t off,
 756                          int count, int *eof, void *data) { return 0; }
 757 static inline
 758 int lprocfs_counter_write(struct file *file, const char *buffer,
 759                           unsigned long count, void *data) { return 0; }
 760
 761 static inline
 762 __u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
 763                                enum lprocfs_fields_flags field)
 764 { return (__u64)0; }
 765
 766 #define LPROCFS_ENTRY()
 767 #define LPROCFS_EXIT()
 768 #define LPROCFS_ENTRY_AND_CHECK(dp)
 769 #define LPROC_SEQ_FOPS_RO(name)
 770 #define LPROC_SEQ_FOPS(name)
 771
 772 /* lproc_ptlrpc.c */
 773 #define target_print_req NULL
 774
 775 #endif /* LPROCFS */
 776
 777 #endif /* LPROCFS_SNMP_H */