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