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 #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          * /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_min;
 154         __s64                  lc_max;
 155         __s64                  lc_sumsquare;
 156         const char            *lc_name;   /* must be static */
 157         const char            *lc_units;  /* must be static */
 158 };
 159
 160 struct lprocfs_percpu {
 161         struct lprocfs_counter lp_cntr[0];
 162 };
 163
 164 #define LPROCFS_GET_NUM_CPU 0x0001
 165 #define LPROCFS_GET_SMP_ID  0x0002
 166
 167 enum lprocfs_stats_flags {
 168         LPROCFS_STATS_FLAG_PERCPU   = 0x0000, /* per cpu counter */
 169         LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
 170                                                * area and need locking */
 171 };
 172
 173 enum lprocfs_fields_flags {
 174         LPROCFS_FIELDS_FLAGS_CONFIG     = 0x0001,
 175         LPROCFS_FIELDS_FLAGS_SUM        = 0x0002,
 176         LPROCFS_FIELDS_FLAGS_MIN        = 0x0003,
 177         LPROCFS_FIELDS_FLAGS_MAX        = 0x0004,
 178         LPROCFS_FIELDS_FLAGS_AVG        = 0x0005,
 179         LPROCFS_FIELDS_FLAGS_SUMSQUARE  = 0x0006,
 180         LPROCFS_FIELDS_FLAGS_COUNT      = 0x0007,
 181 };
 182
 183 struct lprocfs_stats {
 184         unsigned int           ls_num;     /* # of counters */
 185         int                    ls_flags; /* See LPROCFS_STATS_FLAG_* */
 186         spinlock_t             ls_lock;  /* Lock used only when there are
 187                                           * no percpu stats areas */
 188         struct lprocfs_percpu *ls_percpu[0];
 189 };
 190
 191 static inline int opcode_offset(__u32 opc) {
 192         if (opc < OST_LAST_OPC) {
 193                  /* OST opcode */
 194                 return (opc - OST_FIRST_OPC);
 195         } else if (opc < MDS_LAST_OPC) {
 196                 /* MDS opcode */
 197                 return (opc - MDS_FIRST_OPC +
 198                         (OST_LAST_OPC - OST_FIRST_OPC));
 199         } else if (opc < LDLM_LAST_OPC) {
 200                 /* LDLM Opcode */
 201                 return (opc - LDLM_FIRST_OPC +
 202                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 203                         (OST_LAST_OPC - OST_FIRST_OPC));
 204         } else if (opc < MGS_LAST_OPC) {
 205                 /* MGS Opcode */
 206                 return (opc - MGS_FIRST_OPC +
 207                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 208                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 209                         (OST_LAST_OPC - OST_FIRST_OPC));
 210         } else if (opc < OBD_LAST_OPC) {
 211                 /* OBD Ping */
 212                 return (opc - OBD_FIRST_OPC +
 213                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 214                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 215                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 216                         (OST_LAST_OPC - OST_FIRST_OPC));
 217         } else if (opc < LLOG_LAST_OPC) {
 218                 /* LLOG Opcode */
 219                 return (opc - LLOG_FIRST_OPC +
 220                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 221                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 222                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 223                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 224                         (OST_LAST_OPC - OST_FIRST_OPC));
 225         } else if (opc < QUOTA_LAST_OPC) {
 226                 /* LQUOTA Opcode */
 227                 return (opc - QUOTA_FIRST_OPC +
 228                         (LLOG_LAST_OPC - LLOG_FIRST_OPC) +
 229                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 230                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 231                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 232                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 233                         (OST_LAST_OPC - OST_FIRST_OPC));
 234         } else if (opc < SEQ_LAST_OPC) {
 235                 /* SEQ opcode */
 236                 return (opc - SEQ_FIRST_OPC +
 237                         (QUOTA_LAST_OPC- QUOTA_FIRST_OPC) +
 238                         (LLOG_LAST_OPC - LLOG_FIRST_OPC) +
 239                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 240                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 241                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 242                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 243                         (OST_LAST_OPC - OST_FIRST_OPC));
 244         } else if (opc < SEC_LAST_OPC) {
 245                 /* SEC opcode */
 246                 return (opc - SEC_FIRST_OPC +
 247                         (SEQ_LAST_OPC - SEQ_FIRST_OPC) +
 248                         (QUOTA_LAST_OPC- QUOTA_FIRST_OPC) +
 249                         (LLOG_LAST_OPC - LLOG_FIRST_OPC) +
 250                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 251                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 252                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 253                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 254                         (OST_LAST_OPC - OST_FIRST_OPC));
 255         } else if (opc < FLD_LAST_OPC) {
 256                 /* FLD opcode */
 257                  return (opc - FLD_FIRST_OPC +
 258                         (SEC_LAST_OPC - SEC_FIRST_OPC) +
 259                         (SEQ_LAST_OPC - SEQ_FIRST_OPC) +
 260                         (QUOTA_LAST_OPC- QUOTA_FIRST_OPC) +
 261                         (LLOG_LAST_OPC - LLOG_FIRST_OPC) +
 262                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 263                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 264                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 265                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 266                         (OST_LAST_OPC - OST_FIRST_OPC));
 267         } else {
 268                 /* Unknown Opcode */
 269                 return -1;
 270         }
 271 }
 272
 273
 274 #define LUSTRE_MAX_OPCODES ((OST_LAST_OPC - OST_FIRST_OPC)     + \
 275                             (MDS_LAST_OPC - MDS_FIRST_OPC)     + \
 276                             (LDLM_LAST_OPC - LDLM_FIRST_OPC)   + \
 277                             (MGS_LAST_OPC - MGS_FIRST_OPC)     + \
 278                             (OBD_LAST_OPC - OBD_FIRST_OPC)     + \
 279                             (LLOG_LAST_OPC - LLOG_FIRST_OPC)   + \
 280                             (QUOTA_LAST_OPC - QUOTA_FIRST_OPC) + \
 281                             (SEQ_LAST_OPC - SEQ_FIRST_OPC)     + \
 282                             (SEC_LAST_OPC - SEC_FIRST_OPC)     + \
 283                             (FLD_LAST_OPC - FLD_FIRST_OPC))
 284
 285 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR)  + \
 286                            (EXTRA_LAST_OPC - EXTRA_FIRST_OPC))
 287
 288 enum {
 289         PTLRPC_REQWAIT_CNTR = 0,
 290         PTLRPC_REQQDEPTH_CNTR,
 291         PTLRPC_REQACTIVE_CNTR,
 292         PTLRPC_TIMEOUT,
 293         PTLRPC_REQBUF_AVAIL_CNTR,
 294         PTLRPC_LAST_CNTR
 295 };
 296
 297 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
 298
 299 enum {
 300         LDLM_GLIMPSE_ENQUEUE = 0,
 301         LDLM_PLAIN_ENQUEUE,
 302         LDLM_EXTENT_ENQUEUE,
 303         LDLM_FLOCK_ENQUEUE,
 304         LDLM_IBITS_ENQUEUE,
 305         MDS_REINT_SETATTR,
 306         MDS_REINT_CREATE,
 307         MDS_REINT_LINK,
 308         MDS_REINT_UNLINK,
 309         MDS_REINT_RENAME,
 310         MDS_REINT_OPEN,
 311         MDS_REINT_SETXATTR,
 312         BRW_READ_BYTES,
 313         BRW_WRITE_BYTES,
 314         EXTRA_LAST_OPC
 315 };
 316
 317 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
 318 /* class_obd.c */
 319 extern cfs_proc_dir_entry_t *proc_lustre_root;
 320
 321 struct obd_device;
 322 struct file;
 323 struct obd_histogram;
 324
 325 /* Days / hours / mins / seconds format */
 326 struct dhms {
 327         int d,h,m,s;
 328 };
 329 static inline void s2dhms(struct dhms *ts, time_t secs)
 330 {
 331         ts->d = secs / 86400;
 332         secs = secs % 86400;
 333         ts->h = secs / 3600;
 334         secs = secs % 3600;
 335         ts->m = secs / 60;
 336         ts->s = secs % 60;
 337 }
 338 #define DHMS_FMT "%dd%dh%02dm%02ds"
 339 #define DHMS_VARS(x) (x)->d, (x)->h, (x)->m, (x)->s
 340
 341
 342 #ifdef LPROCFS
 343
 344 static inline int lprocfs_stats_lock(struct lprocfs_stats *stats, int type)
 345 {
 346         int rc = 0;
 347
 348         if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
 349                 if (type & LPROCFS_GET_NUM_CPU)
 350                         rc = 1;
 351                 if (type & LPROCFS_GET_SMP_ID)
 352                         rc = 0;
 353                 spin_lock(&stats->ls_lock);
 354         } else {
 355                 if (type & LPROCFS_GET_NUM_CPU)
 356                         rc = num_possible_cpus();
 357                 if (type & LPROCFS_GET_SMP_ID)
 358                         rc = smp_processor_id();
 359         }
 360         return rc;
 361 }
 362
 363 static inline void lprocfs_stats_unlock(struct lprocfs_stats *stats)
 364 {
 365         if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU)
 366                 spin_unlock(&stats->ls_lock);
 367 }
 368
 369 /* Two optimized LPROCFS counter increment functions are provided:
 370  *     lprocfs_counter_incr(cntr, value) - optimized for by-one counters
 371  *     lprocfs_counter_add(cntr) - use for multi-valued counters
 372  * Counter data layout allows config flag, counter lock and the
 373  * count itself to reside within a single cache line.
 374  */
 375
 376 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
 377                                 long amount);
 378 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
 379                                 long amount);
 380
 381 #define lprocfs_counter_incr(stats, idx) \
 382         lprocfs_counter_add(stats, idx, 1)
 383 #define lprocfs_counter_decr(stats, idx) \
 384         lprocfs_counter_sub(stats, idx, 1)
 385
 386 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
 387                                  enum lprocfs_fields_flags field);
 388 static inline __u64 lprocfs_stats_collector(struct lprocfs_stats *stats,
 389                                             int idx,
 390                                             enum lprocfs_fields_flags field)
 391 {
 392         __u64 ret = 0;
 393         int i;
 394
 395         LASSERT(stats != NULL);
 396         for (i = 0; i < num_possible_cpus(); i++)
 397                 ret += lprocfs_read_helper(&(stats->ls_percpu[i]->lp_cntr[idx]),
 398                                            field);
 399         return ret;
 400 }
 401
 402 extern struct lprocfs_stats *lprocfs_alloc_stats(unsigned int num,
 403                                                  enum lprocfs_stats_flags flags);
 404 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
 405 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
 406 extern void lprocfs_init_ops_stats(int num_private_stats,
 407                                    struct lprocfs_stats *stats);
 408 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
 409 extern int lprocfs_alloc_obd_stats(struct obd_device *obddev,
 410                                    unsigned int num_private_stats);
 411 extern int lprocfs_alloc_md_stats(struct obd_device *obddev,
 412                                   unsigned int num_private_stats);
 413 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
 414                                  unsigned conf, const char *name,
 415                                  const char *units);
 416 extern void lprocfs_free_obd_stats(struct obd_device *obddev);
 417 struct obd_export;
 418 struct nid_stat;
 419 extern int lprocfs_add_clear_entry(struct obd_device * obd,
 420                                    cfs_proc_dir_entry_t *entry);
 421 extern int lprocfs_exp_setup(struct obd_export *exp,
 422                              lnet_nid_t *peer_nid, int *newnid);
 423 extern int lprocfs_exp_cleanup(struct obd_export *exp);
 424 extern cfs_proc_dir_entry_t *lprocfs_add_simple(struct proc_dir_entry *root,
 425                                                 char *name,
 426                                                 cfs_read_proc_t *read_proc,
 427                                                 cfs_write_proc_t *write_proc,
 428                                                 void *data,
 429                                                 struct file_operations *fops);
 430 extern struct proc_dir_entry *lprocfs_add_symlink(const char *name,
 431                         struct proc_dir_entry *parent, const char *dest);
 432 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
 433 extern int lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
 434                                          unsigned long count, void *data);
 435 extern int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
 436                                         int count, int *eof,  void *data);
 437
 438 extern int lprocfs_register_stats(cfs_proc_dir_entry_t *root, const char *name,
 439                                   struct lprocfs_stats *stats);
 440
 441 /* lprocfs_status.c */
 442 extern int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
 443                             struct lprocfs_vars *var,
 444                             void *data);
 445
 446 extern cfs_proc_dir_entry_t *lprocfs_register(const char *name,
 447                                                cfs_proc_dir_entry_t *parent,
 448                                                struct lprocfs_vars *list,
 449                                                void *data);
 450
 451 extern void lprocfs_remove(cfs_proc_dir_entry_t **root);
 452 extern void lprocfs_remove_proc_entry(const char *name,
 453                                       struct proc_dir_entry *parent);
 454
 455 extern cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *root,
 456                                            const char *name);
 457
 458 extern int lprocfs_obd_setup(struct obd_device *obd, struct lprocfs_vars *list);
 459 extern int lprocfs_obd_cleanup(struct obd_device *obd);
 460 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
 461 extern struct file_operations lprocfs_evict_client_fops;
 462
 463 extern int lprocfs_seq_create(cfs_proc_dir_entry_t *parent, char *name,
 464                               mode_t mode, struct file_operations *seq_fops,
 465                               void *data);
 466 extern int lprocfs_obd_seq_create(struct obd_device *dev, char *name,
 467                                   mode_t mode, struct file_operations *seq_fops,
 468                                   void *data);
 469
 470 /* Generic callbacks */
 471
 472 extern int lprocfs_rd_u64(char *page, char **start, off_t off,
 473                           int count, int *eof, void *data);
 474 extern int lprocfs_rd_atomic(char *page, char **start, off_t off,
 475                              int count, int *eof, void *data);
 476 extern int lprocfs_wr_atomic(struct file *file, const char *buffer,
 477                              unsigned long count, void *data);
 478 extern int lprocfs_rd_uint(char *page, char **start, off_t off,
 479                            int count, int *eof, void *data);
 480 extern int lprocfs_wr_uint(struct file *file, const char *buffer,
 481                            unsigned long count, void *data);
 482 extern int lprocfs_rd_uuid(char *page, char **start, off_t off,
 483                            int count, int *eof, void *data);
 484 extern int lprocfs_rd_name(char *page, char **start, off_t off,
 485                            int count, int *eof, void *data);
 486 extern int lprocfs_rd_fstype(char *page, char **start, off_t off,
 487                              int count, int *eof, void *data);
 488 extern int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
 489                                   int count, int *eof, void *data);
 490 extern int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
 491                                 int count, int *eof, void *data);
 492 extern int lprocfs_rd_import(char *page, char **start, off_t off, int count,
 493                              int *eof, void *data);
 494 extern int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
 495                                     int count, int *eof, void *data);
 496 extern int lprocfs_rd_num_exports(char *page, char **start, off_t off,
 497                                   int count, int *eof, void *data);
 498 extern int lprocfs_rd_numrefs(char *page, char **start, off_t off,
 499                               int count, int *eof, void *data);
 500 struct adaptive_timeout;
 501 extern int lprocfs_at_hist_helper(char *page, int count, int rc,
 502                                   struct adaptive_timeout *at);
 503 extern int lprocfs_rd_timeouts(char *page, char **start, off_t off,
 504                                int count, int *eof, void *data);
 505 extern int lprocfs_wr_timeouts(struct file *file, const char *buffer,
 506                                unsigned long count, void *data);
 507 extern int lprocfs_wr_evict_client(struct file *file, const char *buffer,
 508                                    unsigned long count, void *data);
 509 extern int lprocfs_wr_ping(struct file *file, const char *buffer,
 510                            unsigned long count, void *data);
 511
 512 /* Statfs helpers */
 513 extern int lprocfs_rd_blksize(char *page, char **start, off_t off,
 514                               int count, int *eof, void *data);
 515 extern int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
 516                                   int count, int *eof, void *data);
 517 extern int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
 518                                  int count, int *eof, void *data);
 519 extern int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
 520                                  int count, int *eof, void *data);
 521 extern int lprocfs_rd_filestotal(char *page, char **start, off_t off,
 522                                  int count, int *eof, void *data);
 523 extern int lprocfs_rd_filesfree(char *page, char **start, off_t off,
 524                                 int count, int *eof, void *data);
 525 extern int lprocfs_rd_filegroups(char *page, char **start, off_t off,
 526                                  int count, int *eof, void *data);
 527
 528 extern int lprocfs_write_helper(const char *buffer, unsigned long count,
 529                                 int *val);
 530 extern int lprocfs_write_frac_helper(const char *buffer, unsigned long count,
 531                                      int *val, int mult);
 532 extern int lprocfs_read_frac_helper(char *buffer, unsigned long count,
 533                                     long val, int mult);
 534 extern int lprocfs_write_u64_helper(const char *buffer, unsigned long count,
 535                                     __u64 *val);
 536 extern int lprocfs_write_frac_u64_helper(const char *buffer, unsigned long count,
 537                                          __u64 *val, int mult);
 538 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
 539 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
 540 void lprocfs_oh_clear(struct obd_histogram *oh);
 541 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
 542
 543 /* lprocfs_status.c: counter read/write functions */
 544 extern int lprocfs_counter_read(char *page, char **start, off_t off,
 545                                 int count, int *eof, void *data);
 546 extern int lprocfs_counter_write(struct file *file, const char *buffer,
 547                                  unsigned long count, void *data);
 548
 549 /* lprocfs_status.c: recovery status */
 550 int lprocfs_obd_rd_recovery_status(char *page, char **start, off_t off,
 551                                    int count, int *eof, void *data);
 552
 553 /* lprocfs_statuc.c: hash statistics */
 554 int lprocfs_obd_rd_hash(char *page, char **start, off_t off,
 555                         int count, int *eof, void *data);
 556
 557 extern int lprocfs_seq_release(struct inode *, struct file *);
 558
 559 /* in lprocfs_stat.c, to protect the private data for proc entries */
 560 extern struct rw_semaphore _lprocfs_lock;
 561 #define LPROCFS_ENTRY()           do {  \
 562         down_read(&_lprocfs_lock);      \
 563 } while(0)
 564 #define LPROCFS_EXIT()            do {  \
 565         up_read(&_lprocfs_lock);        \
 566 } while(0)
 567 #define LPROCFS_ENTRY_AND_CHECK(dp) do {        \
 568         typecheck(struct proc_dir_entry *, dp); \
 569         LPROCFS_ENTRY();                        \
 570         if ((dp)->deleted) {                    \
 571                 LPROCFS_EXIT();                 \
 572                 return -ENODEV;                 \
 573         }                                       \
 574 } while(0)
 575 #define LPROCFS_WRITE_ENTRY()     do {  \
 576         down_write(&_lprocfs_lock);     \
 577 } while(0)
 578 #define LPROCFS_WRITE_EXIT()      do {  \
 579         up_write(&_lprocfs_lock);       \
 580 } while(0)
 581
 582 /* You must use these macros when you want to refer to
 583  * the import in a client obd_device for a lprocfs entry */
 584 #define LPROCFS_CLIMP_CHECK(obd) do {           \
 585         typecheck(struct obd_device *, obd);    \
 586         down_read(&(obd)->u.cli.cl_sem);        \
 587         if ((obd)->u.cli.cl_import == NULL) {   \
 588              up_read(&(obd)->u.cli.cl_sem);     \
 589              return -ENODEV;                    \
 590         }                                       \
 591 } while(0)
 592 #define LPROCFS_CLIMP_EXIT(obd)                 \
 593         up_read(&(obd)->u.cli.cl_sem);
 594
 595
 596 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
 597   proc entries; otherwise, you will define name##_seq_write function also for
 598   a read-write proc entry, and then call LPROC_SEQ_SEQ instead. Finally,
 599   call lprocfs_obd_seq_create(obd, filename, 0444, &name#_fops, data); */
 600 #define __LPROC_SEQ_FOPS(name, custom_seq_write)                           \
 601 static int name##_seq_open(struct inode *inode, struct file *file) {       \
 602         struct proc_dir_entry *dp = PDE(inode);                            \
 603         int rc;                                                            \
 604         LPROCFS_ENTRY_AND_CHECK(dp);                                       \
 605         rc = single_open(file, name##_seq_show, dp->data);                 \
 606         if (rc) {                                                          \
 607                 LPROCFS_EXIT();                                            \
 608                 return rc;                                                 \
 609         }                                                                  \
 610         return 0;                                                          \
 611 }                                                                          \
 612 struct file_operations name##_fops = {                                     \
 613         .owner   = THIS_MODULE,                                            \
 614         .open    = name##_seq_open,                                        \
 615         .read    = seq_read,                                               \
 616         .write   = custom_seq_write,                                       \
 617         .llseek  = seq_lseek,                                              \
 618         .release = lprocfs_seq_release,                                    \
 619 }
 620
 621 #define LPROC_SEQ_FOPS_RO(name)         __LPROC_SEQ_FOPS(name, NULL)
 622 #define LPROC_SEQ_FOPS(name)            __LPROC_SEQ_FOPS(name, name##_seq_write)
 623
 624 /* lproc_ptlrpc.c */
 625 struct ptlrpc_request;
 626 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
 627
 628 /* lprocfs_status.c: read recovery max time bz13079 */
 629 int lprocfs_obd_rd_recovery_maxtime(char *page, char **start, off_t off,
 630                                     int count, int *eof, void *data);
 631
 632 /* lprocfs_status.c: write recovery max time bz13079 */
 633 int lprocfs_obd_wr_recovery_maxtime(struct file *file, const char *buffer,
 634                                     unsigned long count, void *data);
 635
 636 /* all quota proc functions */
 637 extern int lprocfs_quota_rd_bunit(char *page, char **start, off_t off, int count,
 638                                   int *eof, void *data);
 639 extern int lprocfs_quota_wr_bunit(struct file *file, const char *buffer,
 640                                   unsigned long count, void *data);
 641 extern int lprocfs_quota_rd_btune(char *page, char **start, off_t off, int count,
 642                                   int *eof, void *data);
 643 extern int lprocfs_quota_wr_btune(struct file *file, const char *buffer,
 644                                   unsigned long count, void *data);
 645 extern int lprocfs_quota_rd_iunit(char *page, char **start, off_t off, int count,
 646                                   int *eof, void *data);
 647 extern int lprocfs_quota_wr_iunit(struct file *file, const char *buffer,
 648                                   unsigned long count, void *data);
 649 extern int lprocfs_quota_rd_itune(char *page, char **start, off_t off, int count,
 650                                   int *eof, void *data);
 651 extern int lprocfs_quota_wr_itune(struct file *file, const char *buffer,
 652                                   unsigned long count, void *data);
 653 extern int lprocfs_quota_rd_type(char *page, char **start, off_t off, int count,
 654                                  int *eof, void *data);
 655 extern int lprocfs_quota_wr_type(struct file *file, const char *buffer,
 656                                  unsigned long count, void *data);
 657 extern int lprocfs_quota_rd_switch_seconds(char *page, char **start, off_t off,
 658                                            int count, int *eof, void *data);
 659 extern int lprocfs_quota_wr_switch_seconds(struct file *file, const char *buffer,
 660                                            unsigned long count, void *data);
 661 extern int lprocfs_quota_rd_sync_blk(char *page, char **start, off_t off,
 662                                      int count, int *eof, void *data);
 663 extern int lprocfs_quota_wr_sync_blk(struct file *file, const char *buffer,
 664                                      unsigned long count, void *data);
 665 extern int lprocfs_quota_rd_switch_qs(char *page, char **start, off_t off,
 666                                       int count, int *eof, void *data);
 667 extern int lprocfs_quota_wr_switch_qs(struct file *file, const char *buffer,
 668                                       unsigned long count, void *data);
 669 extern int lprocfs_quota_rd_boundary_factor(char *page, char **start, off_t off,
 670                                             int count, int *eof, void *data);
 671 extern int lprocfs_quota_wr_boundary_factor(struct file *file, const char *buffer,
 672                                             unsigned long count, void *data);
 673 extern int lprocfs_quota_rd_least_bunit(char *page, char **start, off_t off,
 674                                         int count, int *eof, void *data);
 675 extern int lprocfs_quota_wr_least_bunit(struct file *file, const char *buffer,
 676                                         unsigned long count, void *data);
 677 extern int lprocfs_quota_rd_least_iunit(char *page, char **start, off_t off,
 678                                         int count, int *eof, void *data);
 679 extern int lprocfs_quota_wr_least_iunit(struct file *file, const char *buffer,
 680                                         unsigned long count, void *data);
 681 extern int lprocfs_quota_rd_qs_factor(char *page, char **start, off_t off,
 682                                       int count, int *eof, void *data);
 683 extern int lprocfs_quota_wr_qs_factor(struct file *file, const char *buffer,
 684                                       unsigned long count, void *data);
 685 #else
 686 /* LPROCFS is not defined */
 687 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
 688                                        int index, long amount) { return; }
 689 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
 690                                         int index) { return; }
 691 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
 692                                        int index, long amount) { return; }
 693 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
 694                                         int index, unsigned conf,
 695                                         const char *name, const char *units)
 696 { return; }
 697
 698 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
 699                                    enum lprocfs_fields_flags field)
 700 { return 0; }
 701
 702 static inline struct lprocfs_stats* lprocfs_alloc_stats(unsigned int num,
 703                                                         enum lprocfs_stats_flags flags)
 704 { return NULL; }
 705 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
 706 { return; }
 707 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
 708 { return; }
 709 static inline int lprocfs_register_stats(cfs_proc_dir_entry_t *root,
 710                                             const char *name,
 711                                             struct lprocfs_stats *stats)
 712 { return 0; }
 713 static inline void lprocfs_init_ops_stats(int num_private_stats,
 714                                           struct lprocfs_stats *stats)
 715 { return; }
 716 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
 717 { return; }
 718 static inline int lprocfs_alloc_obd_stats(struct obd_device *obddev,
 719                                           unsigned int num_private_stats)
 720 { return 0; }
 721 static inline int lprocfs_alloc_md_stats(struct obd_device *obddev,
 722                                          unsigned int num_private_stats)
 723 { return 0; }
 724 static inline void lprocfs_free_obd_stats(struct obd_device *obddev)
 725 { return; }
 726
 727 struct obd_export;
 728 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
 729 { return 0; }
 730 static inline int lprocfs_exp_setup(struct obd_export *exp,
 731                                     lnet_nid_t *peer_nid, int *newnid)
 732 { return 0; }
 733 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
 734 { return 0; }
 735 static inline cfs_proc_dir_entry_t *lprocfs_add_simple(struct proc_dir_entry *root,
 736                                      char *name,
 737                                      cfs_read_proc_t *read_proc,
 738                                      cfs_write_proc_t *write_proc,
 739                                      void *data,
 740                                      struct file_operations *fops)
 741 {return 0; }
 742 static inline struct proc_dir_entry *lprocfs_add_symlink(const char *name,
 743                         struct proc_dir_entry *parent, const char *dest)
 744 {return NULL; }
 745 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
 746 {}
 747 static inline
 748 int lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
 749                                   unsigned long count, void *data)
 750 {return count;}
 751 static inline
 752 int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
 753                                  int count, int *eof,  void *data)
 754 {return count;}
 755
 756 static inline cfs_proc_dir_entry_t *
 757 lprocfs_register(const char *name, cfs_proc_dir_entry_t *parent,
 758                  struct lprocfs_vars *list, void *data) { return NULL; }
 759 static inline int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
 760                                    struct lprocfs_vars *var,
 761                                    void *data) { return 0; }
 762 static inline void lprocfs_remove(cfs_proc_dir_entry_t **root) {};
 763 static inline void lprocfs_remove_proc_entry(const char *name,
 764                                              struct proc_dir_entry *parent) {};
 765 static inline cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *head,
 766                                     const char *name) {return 0;}
 767 static inline int lprocfs_obd_setup(struct obd_device *dev,
 768                                     struct lprocfs_vars *list) { return 0; }
 769 static inline int lprocfs_obd_cleanup(struct obd_device *dev)  { return 0; }
 770 static inline int lprocfs_rd_u64(char *page, char **start, off_t off,
 771                                  int count, int *eof, void *data) { return 0; }
 772 static inline int lprocfs_rd_uuid(char *page, char **start, off_t off,
 773                                   int count, int *eof, void *data) { return 0; }
 774 static inline int lprocfs_rd_name(char *page, char **start, off_t off,
 775                                   int count, int *eof, void *data) { return 0; }
 776 static inline int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
 777                                          int count, int *eof, void *data)
 778 { return 0; }
 779 static inline int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
 780                                        int count, int *eof, void *data)
 781 { return 0; }
 782 static inline int lprocfs_rd_import(char *page, char **start, off_t off, int count,
 783                                     int *eof, void *data) { return 0; }
 784 static inline int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
 785                                            int count, int *eof, void *data)
 786 { return 0; }
 787 static inline int lprocfs_rd_num_exports(char *page, char **start, off_t off,
 788                                          int count, int *eof, void *data)
 789 { return 0; }
 790 static inline int lprocfs_rd_numrefs(char *page, char **start, off_t off,
 791                                      int count, int *eof, void *data)
 792 { return 0; }
 793 struct adaptive_timeout;
 794 static inline int lprocfs_at_hist_helper(char *page, int count, int rc,
 795                                          struct adaptive_timeout *at)
 796 { return 0; }
 797 static inline int lprocfs_rd_timeouts(char *page, char **start, off_t off,
 798                                       int count, int *eof, void *data)
 799 { return 0; }
 800 static inline int lprocfs_wr_timeouts(struct file *file, const char *buffer,
 801                                       unsigned long count, void *data)
 802 { return 0; }
 803 static inline int lprocfs_wr_evict_client(struct file *file, const char *buffer,
 804                                           unsigned long count, void *data)
 805 { return 0; }
 806 static inline int lprocfs_wr_ping(struct file *file, const char *buffer,
 807                                   unsigned long count, void *data)
 808 { return 0; }
 809
 810
 811 /* Statfs helpers */
 812 static inline
 813 int lprocfs_rd_blksize(char *page, char **start, off_t off,
 814                        int count, int *eof, void *data) { return 0; }
 815 static inline
 816 int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
 817                            int count, int *eof, void *data) { return 0; }
 818 static inline
 819 int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
 820                           int count, int *eof, void *data) { return 0; }
 821 static inline
 822 int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
 823                            int count, int *eof, void *data) { return 0; }
 824 static inline
 825 int lprocfs_rd_filestotal(char *page, char **start, off_t off,
 826                           int count, int *eof, void *data) { return 0; }
 827 static inline
 828 int lprocfs_rd_filesfree(char *page, char **start, off_t off,
 829                          int count, int *eof, void *data)  { return 0; }
 830 static inline
 831 int lprocfs_rd_filegroups(char *page, char **start, off_t off,
 832                           int count, int *eof, void *data) { return 0; }
 833 static inline
 834 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value) {}
 835 static inline
 836 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value) {}
 837 static inline
 838 void lprocfs_oh_clear(struct obd_histogram *oh) {}
 839 static inline
 840 unsigned long lprocfs_oh_sum(struct obd_histogram *oh) { return 0; }
 841 static inline
 842 int lprocfs_counter_read(char *page, char **start, off_t off,
 843                          int count, int *eof, void *data) { return 0; }
 844 static inline
 845 int lprocfs_counter_write(struct file *file, const char *buffer,
 846                           unsigned long count, void *data) { return 0; }
 847
 848 static inline
 849 __u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
 850                                enum lprocfs_fields_flags field)
 851 { return (__u64)0; }
 852
 853 #define LPROCFS_ENTRY()
 854 #define LPROCFS_EXIT()
 855 #define LPROCFS_ENTRY_AND_CHECK(dp)
 856 #define LPROC_SEQ_FOPS_RO(name)
 857 #define LPROC_SEQ_FOPS(name)
 858
 859 /* lproc_ptlrpc.c */
 860 #define target_print_req NULL
 861
 862 #endif /* LPROCFS */
 863
 864 #endif /* LPROCFS_SNMP_H */