1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2002, 2003 Cluster File Systems, Inc.
5 * Author: Hariharan Thantry <thantry@users.sourceforge.net>
7 * This file is part of Lustre, http://www.lustre.org.
9 * Lustre is free software; you can redistribute it and/or
10 * modify it under the terms of version 2 of the GNU General Public
11 * License as published by the Free Software Foundation.
13 * Lustre is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with Lustre; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #define DEBUG_SUBSYSTEM S_CLASS
26 #include <linux/config.h>
27 #include <linux/module.h>
28 #include <linux/version.h>
29 #include <linux/slab.h>
30 #include <linux/types.h>
31 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0))
32 #include <asm/statfs.h>
34 #include <linux/seq_file.h>
37 #include <liblustre.h>
40 #include <linux/obd_class.h>
41 #include <linux/lprocfs_status.h>
45 struct proc_dir_entry *lprocfs_srch(struct proc_dir_entry *head,
48 struct proc_dir_entry* temp;
54 while (temp != NULL) {
55 if (!strcmp(temp->name, name))
63 /* lprocfs API calls */
65 int lprocfs_add_vars(struct proc_dir_entry *root, struct lprocfs_vars *list,
68 if ((root == NULL) || (list == NULL))
72 struct proc_dir_entry *cur_root, *proc;
73 char *pathcopy, *cur, *next;
74 int pathsize = strlen(list->name)+1;
79 /* need copy of path for strsep */
80 OBD_ALLOC(pathcopy, pathsize);
85 strcpy(pathcopy, list->name);
87 while (cur_root && (cur = strsep(&next, "/"))) {
88 if (*cur =='\0') /* skip double/trailing "/" */
91 proc = lprocfs_srch(cur_root, cur);
92 CDEBUG(D_OTHER, "cur_root=%s, cur=%s, next=%s, (%s)\n",
93 cur_root->name, cur, next,
94 (proc ? "exists" : "new"));
96 cur_root = (proc ? proc :
97 proc_mkdir(cur, cur_root));
100 if (list->write_fptr)
102 proc = create_proc_entry(cur, mode, cur_root);
106 OBD_FREE(pathcopy, pathsize);
108 if ((cur_root == NULL) || (proc == NULL)) {
109 CERROR("LprocFS: No memory to create /proc entry %s",
114 proc->read_proc = list->read_fptr;
115 proc->write_proc = list->write_fptr;
116 proc->data = (list->data ? list->data : data);
122 void lprocfs_remove(struct proc_dir_entry* root)
124 struct proc_dir_entry *temp = root;
125 struct proc_dir_entry *rm_entry;
126 struct proc_dir_entry *parent;
128 LASSERT(root != NULL);
129 parent = root->parent;
130 LASSERT(parent != NULL);
138 remove_proc_entry(rm_entry->name, rm_entry->parent);
144 struct proc_dir_entry *lprocfs_register(const char *name,
145 struct proc_dir_entry *parent,
146 struct lprocfs_vars *list, void *data)
148 struct proc_dir_entry *newchild;
150 newchild = lprocfs_srch(parent, name);
152 CERROR(" Lproc: Attempting to register %s more than once \n",
154 return ERR_PTR(-EALREADY);
157 newchild = proc_mkdir(name, parent);
158 if (newchild && list) {
159 int rc = lprocfs_add_vars(newchild, list, data);
161 lprocfs_remove(newchild);
168 /* Generic callbacks */
170 int lprocfs_rd_u64(char *page, char **start, off_t off,
171 int count, int *eof, void *data)
173 LASSERT(data != NULL);
175 return snprintf(page, count, LPU64"\n", *(__u64 *)data);
178 int lprocfs_rd_uuid(char* page, char **start, off_t off, int count,
179 int *eof, void *data)
181 struct obd_device* dev = (struct obd_device*)data;
183 LASSERT(dev != NULL);
185 return snprintf(page, count, "%s\n", dev->obd_uuid.uuid);
188 int lprocfs_rd_name(char *page, char **start, off_t off, int count,
189 int *eof, void *data)
191 struct obd_device* dev = (struct obd_device *)data;
193 LASSERT(dev != NULL);
194 LASSERT(dev->obd_name != NULL);
196 return snprintf(page, count, "%s\n", dev->obd_name);
199 int lprocfs_rd_blksize(char* page, char **start, off_t off, int count,
200 int *eof, struct statfs *sfs)
202 LASSERT(sfs != NULL);
204 return snprintf(page, count, "%lu\n", sfs->f_bsize);
207 int lprocfs_rd_kbytestotal(char* page, char **start, off_t off, int count,
208 int *eof, struct statfs *sfs)
213 LASSERT(sfs != NULL);
214 blk_size = sfs->f_bsize >> 10;
215 result = sfs->f_blocks;
217 while (blk_size >>= 1)
221 return snprintf(page, count, LPU64"\n", result);
224 int lprocfs_rd_kbytesfree(char* page, char **start, off_t off, int count,
225 int *eof, struct statfs *sfs)
230 LASSERT(sfs != NULL);
231 blk_size = sfs->f_bsize >> 10;
232 result = sfs->f_bfree;
234 while (blk_size >>= 1)
238 return snprintf(page, count, LPU64"\n", result);
241 int lprocfs_rd_filestotal(char* page, char **start, off_t off, int count,
242 int *eof, struct statfs *sfs)
244 LASSERT(sfs != NULL);
246 return snprintf(page, count, "%ld\n", sfs->f_files);
249 int lprocfs_rd_filesfree(char* page, char **start, off_t off, int count,
250 int *eof, struct statfs *sfs)
252 LASSERT(sfs != NULL);
254 return snprintf(page, count, "%ld\n", sfs->f_ffree);
257 int lprocfs_rd_filegroups(char* page, char **start, off_t off, int count,
258 int *eof, struct statfs *sfs)
261 return snprintf(page, count, "unimplemented\n");
264 int lprocfs_rd_server_uuid(char* page, char **start, off_t off, int count,
265 int *eof, void *data)
267 struct obd_device *obd = (struct obd_device *)data;
268 struct client_obd *cli;
270 LASSERT(obd != NULL);
273 return snprintf(page, count, "%s\n",
274 cli->cl_import->imp_target_uuid.uuid);
277 int lprocfs_rd_conn_uuid(char *page, char **start, off_t off, int count,
278 int *eof, void *data)
280 struct obd_device *obd = (struct obd_device*)data;
281 struct ptlrpc_connection *conn;
283 LASSERT(obd != NULL);
284 conn = obd->u.cli.cl_import->imp_connection;
285 LASSERT(conn != NULL);
287 return snprintf(page, count, "%s\n", conn->c_remote_uuid.uuid);
290 int lprocfs_rd_numrefs(char *page, char **start, off_t off, int count,
291 int *eof, void *data)
293 struct obd_type* class = (struct obd_type*) data;
295 LASSERT(class != NULL);
297 return snprintf(page, count, "%d\n", class->typ_refcnt);
300 int lprocfs_obd_attach(struct obd_device *dev, struct lprocfs_vars *list)
304 LASSERT(dev != NULL);
305 LASSERT(dev->obd_type != NULL);
306 LASSERT(dev->obd_type->typ_procroot != NULL);
308 dev->obd_proc_entry = lprocfs_register(dev->obd_name,
309 dev->obd_type->typ_procroot,
311 if (IS_ERR(dev->obd_proc_entry)) {
312 rc = PTR_ERR(dev->obd_proc_entry);
313 dev->obd_proc_entry = NULL;
318 int lprocfs_obd_detach(struct obd_device *dev)
320 if (dev && dev->obd_proc_entry) {
321 lprocfs_remove(dev->obd_proc_entry);
322 dev->obd_proc_entry = NULL;
327 struct lprocfs_stats *lprocfs_alloc_stats(unsigned int num)
329 struct lprocfs_stats *stats;
330 struct lprocfs_percpu *percpu;
331 unsigned int percpusize;
337 OBD_ALLOC(stats, offsetof(typeof(*stats), ls_percpu[smp_num_cpus]));
341 percpusize = L1_CACHE_ALIGN(offsetof(typeof(*percpu), lp_cntr[num]));
342 stats->ls_percpu_size = smp_num_cpus * percpusize;
343 OBD_ALLOC(stats->ls_percpu[0], stats->ls_percpu_size);
344 if (stats->ls_percpu[0] == NULL) {
345 OBD_FREE(stats, offsetof(typeof(*stats),
346 ls_percpu[smp_num_cpus]));
351 for (i = 1; i < smp_num_cpus; i++)
352 stats->ls_percpu[i] = (void *)(stats->ls_percpu[i - 1]) +
358 void lprocfs_free_stats(struct lprocfs_stats *stats)
360 if (stats->ls_num == 0)
363 OBD_FREE(stats->ls_percpu[0], stats->ls_percpu_size);
364 OBD_FREE(stats, offsetof(typeof(*stats), ls_percpu[smp_num_cpus]));
367 /* Reset counter under lock */
368 int lprocfs_counter_write(struct file *file, const char *buffer,
369 unsigned long count, void *data)
375 static void *lprocfs_stats_seq_start(struct seq_file *p, loff_t *pos)
377 struct lprocfs_stats *stats = p->private;
378 /* return 1st cpu location */
379 return (*pos >= stats->ls_num) ? NULL :
380 &(stats->ls_percpu[0]->lp_cntr[*pos]);
383 static void lprocfs_stats_seq_stop(struct seq_file *p, void *v)
387 static void *lprocfs_stats_seq_next(struct seq_file *p, void *v, loff_t *pos)
389 struct lprocfs_stats *stats = p->private;
391 return (*pos >= stats->ls_num) ? NULL :
392 &(stats->ls_percpu[0]->lp_cntr[*pos]);
395 /* seq file export of one lprocfs counter */
396 static int lprocfs_stats_seq_show(struct seq_file *p, void *v)
398 struct lprocfs_stats *stats = p->private;
399 struct lprocfs_counter *cntr = v;
400 struct lprocfs_counter t, ret = { .lc_min = ~(__u64)0 };
403 if (cntr == &(stats->ls_percpu[0])->lp_cntr[0]) {
405 do_gettimeofday(&now);
406 rc = seq_printf(p, "%-25s %lu.%lu secs.usecs\n",
407 "snapshot_time", now.tv_sec, now.tv_usec);
411 idx = cntr - &(stats->ls_percpu[0])->lp_cntr[0];
413 for (i = 0; i < smp_num_cpus; i++) {
414 struct lprocfs_counter *percpu_cntr =
415 &(stats->ls_percpu[i])->lp_cntr[idx];
418 centry = atomic_read(&percpu_cntr->lc_cntl.la_entry);
419 t.lc_count = percpu_cntr->lc_count;
420 t.lc_sum = percpu_cntr->lc_sum;
421 t.lc_min = percpu_cntr->lc_min;
422 t.lc_max = percpu_cntr->lc_max;
423 t.lc_sumsquare = percpu_cntr->lc_sumsquare;
424 } while (centry != atomic_read(&percpu_cntr->lc_cntl.la_entry) &&
425 centry != atomic_read(&percpu_cntr->lc_cntl.la_exit));
426 ret.lc_count += t.lc_count;
427 ret.lc_sum += t.lc_sum;
428 if (t.lc_min < ret.lc_min)
429 ret.lc_min = t.lc_min;
430 if (t.lc_max > ret.lc_max)
431 ret.lc_max = t.lc_max;
432 ret.lc_sumsquare += t.lc_sumsquare;
435 rc = seq_printf(p, "%-25s "LPU64" samples [%s]", cntr->lc_name,
436 ret.lc_count, cntr->lc_units);
440 if ((cntr->lc_config & LPROCFS_CNTR_AVGMINMAX) && (ret.lc_count > 0)) {
441 rc = seq_printf(p, " "LPU64" "LPU64" "LPU64,
442 ret.lc_min, ret.lc_max, ret.lc_sum);
445 if (cntr->lc_config & LPROCFS_CNTR_STDDEV)
446 rc = seq_printf(p, " "LPU64, ret.lc_sumsquare);
450 rc = seq_printf(p, "\n");
452 return (rc < 0) ? rc : 0;
455 struct seq_operations lprocfs_stats_seq_sops = {
456 .start = lprocfs_stats_seq_start,
457 .stop = lprocfs_stats_seq_stop,
458 .next = lprocfs_stats_seq_next,
459 .show = lprocfs_stats_seq_show,
462 static int lprocfs_stats_seq_open(struct inode *inode, struct file *file)
464 struct proc_dir_entry *dp = inode->u.generic_ip;
465 struct seq_file *seq;
468 rc = seq_open(file, &lprocfs_stats_seq_sops);
471 seq = file->private_data;
472 seq->private = dp->data;
476 struct file_operations lprocfs_stats_seq_fops = {
477 .open = lprocfs_stats_seq_open,
480 .release = seq_release,
483 int lprocfs_register_stats(struct proc_dir_entry *root, const char* name,
484 struct lprocfs_stats *stats)
486 struct proc_dir_entry *entry;
487 LASSERT(root != NULL);
489 entry = create_proc_entry(name, 0444, root);
492 entry->proc_fops = &lprocfs_stats_seq_fops;
493 entry->data = (void *)stats;
494 entry->write_proc = lprocfs_counter_write;
498 void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
499 unsigned conf, const char *name, const char *units)
501 struct lprocfs_counter *c;
504 LASSERT(stats != NULL);
505 for (i = 0; i < smp_num_cpus; i++) {
506 c = &(stats->ls_percpu[i]->lp_cntr[index]);
508 c->lc_min = ~(__u64)0;
513 EXPORT_SYMBOL(lprocfs_counter_init);
515 #define LPROCFS_OBD_OP_INIT(base, stats, op) \
517 unsigned int coffset = base + OBD_COUNTER_OFFSET(op); \
518 LASSERT(coffset < stats->ls_num); \
519 lprocfs_counter_init(stats, coffset, 0, #op, "reqs"); \
522 int lprocfs_alloc_obd_stats(struct obd_device *obd, unsigned num_private_stats)
524 struct lprocfs_stats *stats;
525 unsigned int num_stats;
528 LASSERT(obd->obd_stats == NULL);
529 LASSERT(obd->obd_proc_entry != NULL);
530 LASSERT(obd->obd_cntr_base == 0);
532 num_stats = 1 + OBD_COUNTER_OFFSET(destroy_export) +
534 stats = lprocfs_alloc_stats(num_stats);
538 LPROCFS_OBD_OP_INIT(num_private_stats, stats, iocontrol);
539 LPROCFS_OBD_OP_INIT(num_private_stats, stats, get_info);
540 LPROCFS_OBD_OP_INIT(num_private_stats, stats, set_info);
541 LPROCFS_OBD_OP_INIT(num_private_stats, stats, attach);
542 LPROCFS_OBD_OP_INIT(num_private_stats, stats, detach);
543 LPROCFS_OBD_OP_INIT(num_private_stats, stats, setup);
544 LPROCFS_OBD_OP_INIT(num_private_stats, stats, cleanup);
545 LPROCFS_OBD_OP_INIT(num_private_stats, stats, connect);
546 LPROCFS_OBD_OP_INIT(num_private_stats, stats, disconnect);
547 LPROCFS_OBD_OP_INIT(num_private_stats, stats, statfs);
548 LPROCFS_OBD_OP_INIT(num_private_stats, stats, syncfs);
549 LPROCFS_OBD_OP_INIT(num_private_stats, stats, packmd);
550 LPROCFS_OBD_OP_INIT(num_private_stats, stats, unpackmd);
551 LPROCFS_OBD_OP_INIT(num_private_stats, stats, preallocate);
552 LPROCFS_OBD_OP_INIT(num_private_stats, stats, create);
553 LPROCFS_OBD_OP_INIT(num_private_stats, stats, destroy);
554 LPROCFS_OBD_OP_INIT(num_private_stats, stats, setattr);
555 LPROCFS_OBD_OP_INIT(num_private_stats, stats, getattr);
556 LPROCFS_OBD_OP_INIT(num_private_stats, stats, getattr_async);
557 LPROCFS_OBD_OP_INIT(num_private_stats, stats, open);
558 LPROCFS_OBD_OP_INIT(num_private_stats, stats, close);
559 LPROCFS_OBD_OP_INIT(num_private_stats, stats, brw);
560 LPROCFS_OBD_OP_INIT(num_private_stats, stats, brw_async);
561 LPROCFS_OBD_OP_INIT(num_private_stats, stats, punch);
562 LPROCFS_OBD_OP_INIT(num_private_stats, stats, sync);
563 LPROCFS_OBD_OP_INIT(num_private_stats, stats, migrate);
564 LPROCFS_OBD_OP_INIT(num_private_stats, stats, copy);
565 LPROCFS_OBD_OP_INIT(num_private_stats, stats, iterate);
566 LPROCFS_OBD_OP_INIT(num_private_stats, stats, preprw);
567 LPROCFS_OBD_OP_INIT(num_private_stats, stats, commitrw);
568 LPROCFS_OBD_OP_INIT(num_private_stats, stats, enqueue);
569 LPROCFS_OBD_OP_INIT(num_private_stats, stats, match);
570 LPROCFS_OBD_OP_INIT(num_private_stats, stats, cancel);
571 LPROCFS_OBD_OP_INIT(num_private_stats, stats, cancel_unused);
572 LPROCFS_OBD_OP_INIT(num_private_stats, stats, san_preprw);
573 LPROCFS_OBD_OP_INIT(num_private_stats, stats, destroy_export);
575 for (i = num_private_stats; i < num_stats; i++) {
576 /* If this assertion failed, it is likely that an obd
577 * operation was added to struct obd_ops in
578 * <linux/obd.h>, and that the corresponding line item
579 * LPROCFS_OBD_OP_INIT(.., .., opname)
580 * is missing from the list above. */
581 LASSERT(&(stats->ls_percpu[0])->lp_cntr[i].lc_name != NULL);
583 rc = lprocfs_register_stats(obd->obd_proc_entry, "stats", stats);
585 lprocfs_free_stats(stats);
587 obd->obd_stats = stats;
588 obd->obd_cntr_base = num_private_stats;
593 void lprocfs_free_obd_stats(struct obd_device *obd)
595 struct lprocfs_stats *stats = obd->obd_stats;
598 obd->obd_stats = NULL;
599 lprocfs_free_stats(stats);
605 EXPORT_SYMBOL(lprocfs_register);
606 EXPORT_SYMBOL(lprocfs_srch);
607 EXPORT_SYMBOL(lprocfs_remove);
608 EXPORT_SYMBOL(lprocfs_add_vars);
609 EXPORT_SYMBOL(lprocfs_obd_attach);
610 EXPORT_SYMBOL(lprocfs_obd_detach);
611 EXPORT_SYMBOL(lprocfs_alloc_stats);
612 EXPORT_SYMBOL(lprocfs_free_stats);
613 EXPORT_SYMBOL(lprocfs_register_stats);
614 EXPORT_SYMBOL(lprocfs_alloc_obd_stats);
615 EXPORT_SYMBOL(lprocfs_free_obd_stats);
617 EXPORT_SYMBOL(lprocfs_rd_u64);
618 EXPORT_SYMBOL(lprocfs_rd_uuid);
619 EXPORT_SYMBOL(lprocfs_rd_name);
620 EXPORT_SYMBOL(lprocfs_rd_server_uuid);
621 EXPORT_SYMBOL(lprocfs_rd_conn_uuid);
622 EXPORT_SYMBOL(lprocfs_rd_numrefs);
624 EXPORT_SYMBOL(lprocfs_rd_blksize);
625 EXPORT_SYMBOL(lprocfs_rd_kbytestotal);
626 EXPORT_SYMBOL(lprocfs_rd_kbytesfree);
627 EXPORT_SYMBOL(lprocfs_rd_filestotal);
628 EXPORT_SYMBOL(lprocfs_rd_filesfree);
629 EXPORT_SYMBOL(lprocfs_rd_filegroups);