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));
99 proc = create_proc_entry(cur, 0444, cur_root);
102 OBD_FREE(pathcopy, pathsize);
104 if ((cur_root == NULL) || (proc == NULL)) {
105 CERROR("LprocFS: No memory to create /proc entry %s",
110 proc->read_proc = list->read_fptr;
111 proc->write_proc = list->write_fptr;
112 proc->data = (list->data ? list->data : data);
118 void lprocfs_remove(struct proc_dir_entry* root)
120 struct proc_dir_entry *temp = root;
121 struct proc_dir_entry *rm_entry;
122 struct proc_dir_entry *parent;
124 LASSERT(root != NULL);
125 parent = root->parent;
126 LASSERT(parent != NULL);
134 remove_proc_entry(rm_entry->name, rm_entry->parent);
140 struct proc_dir_entry *lprocfs_register(const char *name,
141 struct proc_dir_entry *parent,
142 struct lprocfs_vars *list, void *data)
144 struct proc_dir_entry *newchild;
146 newchild = lprocfs_srch(parent, name);
148 CERROR(" Lproc: Attempting to register %s more than once \n",
150 return ERR_PTR(-EALREADY);
153 newchild = proc_mkdir(name, parent);
154 if (newchild && list) {
155 int rc = lprocfs_add_vars(newchild, list, data);
157 lprocfs_remove(newchild);
164 /* Generic callbacks */
166 int lprocfs_rd_u64(char *page, char **start, off_t off,
167 int count, int *eof, void *data)
169 LASSERT(data != NULL);
171 return snprintf(page, count, LPU64"\n", *(__u64 *)data);
174 int lprocfs_rd_uuid(char* page, char **start, off_t off, int count,
175 int *eof, void *data)
177 struct obd_device* dev = (struct obd_device*)data;
179 LASSERT(dev != NULL);
181 return snprintf(page, count, "%s\n", dev->obd_uuid.uuid);
184 int lprocfs_rd_name(char *page, char **start, off_t off, int count,
185 int *eof, void *data)
187 struct obd_device* dev = (struct obd_device *)data;
189 LASSERT(dev != NULL);
190 LASSERT(dev->obd_name != NULL);
192 return snprintf(page, count, "%s\n", dev->obd_name);
195 int lprocfs_rd_blksize(char* page, char **start, off_t off, int count,
196 int *eof, struct statfs *sfs)
198 LASSERT(sfs != NULL);
200 return snprintf(page, count, "%lu\n", sfs->f_bsize);
203 int lprocfs_rd_kbytestotal(char* page, char **start, off_t off, int count,
204 int *eof, struct statfs *sfs)
209 LASSERT(sfs != NULL);
210 blk_size = sfs->f_bsize >> 10;
211 result = sfs->f_blocks;
213 while (blk_size >>= 1)
217 return snprintf(page, count, LPU64"\n", result);
220 int lprocfs_rd_kbytesfree(char* page, char **start, off_t off, int count,
221 int *eof, struct statfs *sfs)
226 LASSERT(sfs != NULL);
227 blk_size = sfs->f_bsize >> 10;
228 result = sfs->f_bfree;
230 while (blk_size >>= 1)
234 return snprintf(page, count, LPU64"\n", result);
237 int lprocfs_rd_filestotal(char* page, char **start, off_t off, int count,
238 int *eof, struct statfs *sfs)
240 LASSERT(sfs != NULL);
242 return snprintf(page, count, "%ld\n", sfs->f_files);
245 int lprocfs_rd_filesfree(char* page, char **start, off_t off, int count,
246 int *eof, struct statfs *sfs)
248 LASSERT(sfs != NULL);
250 return snprintf(page, count, "%ld\n", sfs->f_ffree);
253 int lprocfs_rd_filegroups(char* page, char **start, off_t off, int count,
254 int *eof, struct statfs *sfs)
257 return snprintf(page, count, "unimplemented\n");
260 int lprocfs_rd_server_uuid(char* page, char **start, off_t off, int count,
261 int *eof, void *data)
263 struct obd_device *obd = (struct obd_device *)data;
264 struct client_obd *cli;
266 LASSERT(obd != NULL);
269 return snprintf(page, count, "%s\n",
270 cli->cl_import->imp_target_uuid.uuid);
273 int lprocfs_rd_conn_uuid(char *page, char **start, off_t off, int count,
274 int *eof, void *data)
276 struct obd_device *obd = (struct obd_device*)data;
277 struct ptlrpc_connection *conn;
279 LASSERT(obd != NULL);
280 conn = obd->u.cli.cl_import->imp_connection;
281 LASSERT(conn != NULL);
283 return snprintf(page, count, "%s\n", conn->c_remote_uuid.uuid);
286 int lprocfs_rd_numrefs(char *page, char **start, off_t off, int count,
287 int *eof, void *data)
289 struct obd_type* class = (struct obd_type*) data;
291 LASSERT(class != NULL);
293 return snprintf(page, count, "%d\n", class->typ_refcnt);
296 int lprocfs_obd_attach(struct obd_device *dev, struct lprocfs_vars *list)
300 LASSERT(dev != NULL);
301 LASSERT(dev->obd_type != NULL);
302 LASSERT(dev->obd_type->typ_procroot != NULL);
304 dev->obd_proc_entry = lprocfs_register(dev->obd_name,
305 dev->obd_type->typ_procroot,
307 if (IS_ERR(dev->obd_proc_entry)) {
308 rc = PTR_ERR(dev->obd_proc_entry);
309 dev->obd_proc_entry = NULL;
314 int lprocfs_obd_detach(struct obd_device *dev)
316 if (dev && dev->obd_proc_entry) {
317 lprocfs_remove(dev->obd_proc_entry);
318 dev->obd_proc_entry = NULL;
323 struct lprocfs_stats *lprocfs_alloc_stats(unsigned int num)
325 struct lprocfs_stats *stats;
326 struct lprocfs_percpu *percpu;
327 unsigned int percpusize;
333 OBD_ALLOC(stats, offsetof(typeof(*stats), ls_percpu[smp_num_cpus]));
337 percpusize = L1_CACHE_ALIGN(offsetof(typeof(*percpu), lp_cntr[num]));
338 stats->ls_percpu_size = smp_num_cpus * percpusize;
339 OBD_ALLOC(stats->ls_percpu[0], stats->ls_percpu_size);
340 if (stats->ls_percpu[0] == NULL) {
341 OBD_FREE(stats, offsetof(typeof(*stats),
342 ls_percpu[smp_num_cpus]));
347 for (i = 1; i < smp_num_cpus; i++)
348 stats->ls_percpu[i] = (void *)(stats->ls_percpu[i - 1]) +
354 void lprocfs_free_stats(struct lprocfs_stats *stats)
356 if (stats->ls_num == 0)
359 OBD_FREE(stats->ls_percpu[0], stats->ls_percpu_size);
360 OBD_FREE(stats, offsetof(typeof(*stats), ls_percpu[smp_num_cpus]));
363 /* Reset counter under lock */
364 int lprocfs_counter_write(struct file *file, const char *buffer,
365 unsigned long count, void *data)
371 static void *lprocfs_stats_seq_start(struct seq_file *p, loff_t *pos)
373 struct lprocfs_stats *stats = p->private;
374 /* return 1st cpu location */
375 return (*pos >= stats->ls_num) ? NULL :
376 &(stats->ls_percpu[0]->lp_cntr[*pos]);
379 static void lprocfs_stats_seq_stop(struct seq_file *p, void *v)
383 static void *lprocfs_stats_seq_next(struct seq_file *p, void *v, loff_t *pos)
385 struct lprocfs_stats *stats = p->private;
387 return (*pos >= stats->ls_num) ? NULL :
388 &(stats->ls_percpu[0]->lp_cntr[*pos]);
391 /* seq file export of one lprocfs counter */
392 static int lprocfs_stats_seq_show(struct seq_file *p, void *v)
394 struct lprocfs_stats *stats = p->private;
395 struct lprocfs_counter *cntr = v;
396 struct lprocfs_counter t, ret = { .lc_min = ~(__u64)0 };
399 if (cntr == &(stats->ls_percpu[0])->lp_cntr[0]) {
401 do_gettimeofday(&now);
402 rc = seq_printf(p, "%-25s %lu.%lu secs.usecs\n",
403 "snapshot_time", now.tv_sec, now.tv_usec);
407 idx = cntr - &(stats->ls_percpu[0])->lp_cntr[0];
409 for (i = 0; i < smp_num_cpus; i++) {
410 struct lprocfs_counter *percpu_cntr =
411 &(stats->ls_percpu[i])->lp_cntr[idx];
414 centry = atomic_read(&percpu_cntr->lc_cntl.la_entry);
415 t.lc_count = percpu_cntr->lc_count;
416 t.lc_sum = percpu_cntr->lc_sum;
417 t.lc_min = percpu_cntr->lc_min;
418 t.lc_max = percpu_cntr->lc_max;
419 t.lc_sumsquare = percpu_cntr->lc_sumsquare;
420 } while (centry != atomic_read(&percpu_cntr->lc_cntl.la_entry) &&
421 centry != atomic_read(&percpu_cntr->lc_cntl.la_exit));
422 ret.lc_count += t.lc_count;
423 ret.lc_sum += t.lc_sum;
424 if (t.lc_min < ret.lc_min)
425 ret.lc_min = t.lc_min;
426 if (t.lc_max > ret.lc_max)
427 ret.lc_max = t.lc_max;
428 ret.lc_sumsquare += t.lc_sumsquare;
431 rc = seq_printf(p, "%-25s "LPU64" samples [%s]", cntr->lc_name,
432 ret.lc_count, cntr->lc_units);
436 if ((cntr->lc_config & LPROCFS_CNTR_AVGMINMAX) && (ret.lc_count > 0)) {
437 rc = seq_printf(p, " "LPU64" "LPU64" "LPU64,
438 ret.lc_min, ret.lc_max, ret.lc_sum);
441 if (cntr->lc_config & LPROCFS_CNTR_STDDEV)
442 rc = seq_printf(p, " "LPU64, ret.lc_sumsquare);
446 rc = seq_printf(p, "\n");
448 return (rc < 0) ? rc : 0;
451 struct seq_operations lprocfs_stats_seq_sops = {
452 .start = lprocfs_stats_seq_start,
453 .stop = lprocfs_stats_seq_stop,
454 .next = lprocfs_stats_seq_next,
455 .show = lprocfs_stats_seq_show,
458 static int lprocfs_stats_seq_open(struct inode *inode, struct file *file)
460 struct proc_dir_entry *dp = inode->u.generic_ip;
461 struct seq_file *seq;
464 rc = seq_open(file, &lprocfs_stats_seq_sops);
467 seq = file->private_data;
468 seq->private = dp->data;
472 struct file_operations lprocfs_stats_seq_fops = {
473 .open = lprocfs_stats_seq_open,
476 .release = seq_release,
479 int lprocfs_register_stats(struct proc_dir_entry *root, const char* name,
480 struct lprocfs_stats *stats)
482 struct proc_dir_entry *entry;
483 LASSERT(root != NULL);
485 entry = create_proc_entry(name, 0444, root);
488 entry->proc_fops = &lprocfs_stats_seq_fops;
489 entry->data = (void *)stats;
490 entry->write_proc = lprocfs_counter_write;
494 void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
495 unsigned conf, const char *name, const char *units)
497 struct lprocfs_counter *c;
500 LASSERT(stats != NULL);
501 for (i = 0; i < smp_num_cpus; i++) {
502 c = &(stats->ls_percpu[i]->lp_cntr[index]);
504 c->lc_min = ~(__u64)0;
509 EXPORT_SYMBOL(lprocfs_counter_init);
511 #define LPROCFS_OBD_OP_INIT(base, stats, op) \
513 unsigned int coffset = base + OBD_COUNTER_OFFSET(op); \
514 LASSERT(coffset < stats->ls_num); \
515 lprocfs_counter_init(stats, coffset, 0, #op, "reqs"); \
518 int lprocfs_alloc_obd_stats(struct obd_device *obd, unsigned num_private_stats)
520 struct lprocfs_stats *stats;
521 unsigned int num_stats;
524 LASSERT(obd->obd_stats == NULL);
525 LASSERT(obd->obd_proc_entry != NULL);
526 LASSERT(obd->obd_cntr_base == 0);
528 num_stats = 1 + OBD_COUNTER_OFFSET(destroy_export) +
530 stats = lprocfs_alloc_stats(num_stats);
534 LPROCFS_OBD_OP_INIT(num_private_stats, stats, iocontrol);
535 LPROCFS_OBD_OP_INIT(num_private_stats, stats, get_info);
536 LPROCFS_OBD_OP_INIT(num_private_stats, stats, set_info);
537 LPROCFS_OBD_OP_INIT(num_private_stats, stats, attach);
538 LPROCFS_OBD_OP_INIT(num_private_stats, stats, detach);
539 LPROCFS_OBD_OP_INIT(num_private_stats, stats, setup);
540 LPROCFS_OBD_OP_INIT(num_private_stats, stats, cleanup);
541 LPROCFS_OBD_OP_INIT(num_private_stats, stats, connect);
542 LPROCFS_OBD_OP_INIT(num_private_stats, stats, disconnect);
543 LPROCFS_OBD_OP_INIT(num_private_stats, stats, statfs);
544 LPROCFS_OBD_OP_INIT(num_private_stats, stats, syncfs);
545 LPROCFS_OBD_OP_INIT(num_private_stats, stats, packmd);
546 LPROCFS_OBD_OP_INIT(num_private_stats, stats, unpackmd);
547 LPROCFS_OBD_OP_INIT(num_private_stats, stats, preallocate);
548 LPROCFS_OBD_OP_INIT(num_private_stats, stats, create);
549 LPROCFS_OBD_OP_INIT(num_private_stats, stats, destroy);
550 LPROCFS_OBD_OP_INIT(num_private_stats, stats, setattr);
551 LPROCFS_OBD_OP_INIT(num_private_stats, stats, getattr);
552 LPROCFS_OBD_OP_INIT(num_private_stats, stats, getattr_async);
553 LPROCFS_OBD_OP_INIT(num_private_stats, stats, open);
554 LPROCFS_OBD_OP_INIT(num_private_stats, stats, close);
555 LPROCFS_OBD_OP_INIT(num_private_stats, stats, brw);
556 LPROCFS_OBD_OP_INIT(num_private_stats, stats, brw_async);
557 LPROCFS_OBD_OP_INIT(num_private_stats, stats, punch);
558 LPROCFS_OBD_OP_INIT(num_private_stats, stats, sync);
559 LPROCFS_OBD_OP_INIT(num_private_stats, stats, migrate);
560 LPROCFS_OBD_OP_INIT(num_private_stats, stats, copy);
561 LPROCFS_OBD_OP_INIT(num_private_stats, stats, iterate);
562 LPROCFS_OBD_OP_INIT(num_private_stats, stats, preprw);
563 LPROCFS_OBD_OP_INIT(num_private_stats, stats, commitrw);
564 LPROCFS_OBD_OP_INIT(num_private_stats, stats, enqueue);
565 LPROCFS_OBD_OP_INIT(num_private_stats, stats, match);
566 LPROCFS_OBD_OP_INIT(num_private_stats, stats, cancel);
567 LPROCFS_OBD_OP_INIT(num_private_stats, stats, cancel_unused);
568 LPROCFS_OBD_OP_INIT(num_private_stats, stats, san_preprw);
569 LPROCFS_OBD_OP_INIT(num_private_stats, stats, destroy_export);
571 for (i = num_private_stats; i < num_stats; i++) {
572 /* If this assertion failed, it is likely that an obd
573 * operation was added to struct obd_ops in
574 * <linux/obd.h>, and that the corresponding line item
575 * LPROCFS_OBD_OP_INIT(.., .., opname)
576 * is missing from the list above. */
577 LASSERT(&(stats->ls_percpu[0])->lp_cntr[i].lc_name != NULL);
579 rc = lprocfs_register_stats(obd->obd_proc_entry, "stats", stats);
581 lprocfs_free_stats(stats);
583 obd->obd_stats = stats;
584 obd->obd_cntr_base = num_private_stats;
589 void lprocfs_free_obd_stats(struct obd_device *obd)
591 struct lprocfs_stats *stats = obd->obd_stats;
594 obd->obd_stats = NULL;
595 lprocfs_free_stats(stats);
601 EXPORT_SYMBOL(lprocfs_register);
602 EXPORT_SYMBOL(lprocfs_srch);
603 EXPORT_SYMBOL(lprocfs_remove);
604 EXPORT_SYMBOL(lprocfs_add_vars);
605 EXPORT_SYMBOL(lprocfs_obd_attach);
606 EXPORT_SYMBOL(lprocfs_obd_detach);
607 EXPORT_SYMBOL(lprocfs_alloc_stats);
608 EXPORT_SYMBOL(lprocfs_free_stats);
609 EXPORT_SYMBOL(lprocfs_register_stats);
610 EXPORT_SYMBOL(lprocfs_alloc_obd_stats);
611 EXPORT_SYMBOL(lprocfs_free_obd_stats);
613 EXPORT_SYMBOL(lprocfs_rd_u64);
614 EXPORT_SYMBOL(lprocfs_rd_uuid);
615 EXPORT_SYMBOL(lprocfs_rd_name);
616 EXPORT_SYMBOL(lprocfs_rd_server_uuid);
617 EXPORT_SYMBOL(lprocfs_rd_conn_uuid);
618 EXPORT_SYMBOL(lprocfs_rd_numrefs);
620 EXPORT_SYMBOL(lprocfs_rd_blksize);
621 EXPORT_SYMBOL(lprocfs_rd_kbytestotal);
622 EXPORT_SYMBOL(lprocfs_rd_kbytesfree);
623 EXPORT_SYMBOL(lprocfs_rd_filestotal);
624 EXPORT_SYMBOL(lprocfs_rd_filesfree);
625 EXPORT_SYMBOL(lprocfs_rd_filegroups);