1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 #define DEBUG_SUBSYSTEM S_CLASS
39 # include <liblustre.h>
42 #include <obd_support.h>
44 #include <lprocfs_status.h>
45 #include <lustre/lustre_idl.h>
46 #include <lustre_net.h>
47 #include <obd_class.h>
48 #include "ptlrpc_internal.h"
51 struct ll_rpc_opcode {
54 } ll_rpc_opcode_table[LUSTRE_MAX_OPCODES] = {
55 { OST_REPLY, "ost_reply" },
56 { OST_GETATTR, "ost_getattr" },
57 { OST_SETATTR, "ost_setattr" },
58 { OST_READ, "ost_read" },
59 { OST_WRITE, "ost_write" },
60 { OST_CREATE , "ost_create" },
61 { OST_DESTROY, "ost_destroy" },
62 { OST_GET_INFO, "ost_get_info" },
63 { OST_CONNECT, "ost_connect" },
64 { OST_DISCONNECT, "ost_disconnect" },
65 { OST_PUNCH, "ost_punch" },
66 { OST_OPEN, "ost_open" },
67 { OST_CLOSE, "ost_close" },
68 { OST_STATFS, "ost_statfs" },
69 { 14, NULL }, /* formerly OST_SAN_READ */
70 { 15, NULL }, /* formerly OST_SAN_WRITE */
71 { OST_SYNC, "ost_sync" },
72 { OST_SET_INFO, "ost_set_info" },
73 { OST_QUOTACHECK, "ost_quotacheck" },
74 { OST_QUOTACTL, "ost_quotactl" },
75 { OST_QUOTA_ADJUST_QUNIT, "ost_quota_adjust_qunit" },
76 { MDS_GETATTR, "mds_getattr" },
77 { MDS_GETATTR_NAME, "mds_getattr_lock" },
78 { MDS_CLOSE, "mds_close" },
79 { MDS_REINT, "mds_reint" },
80 { MDS_READPAGE, "mds_readpage" },
81 { MDS_CONNECT, "mds_connect" },
82 { MDS_DISCONNECT, "mds_disconnect" },
83 { MDS_GETSTATUS, "mds_getstatus" },
84 { MDS_STATFS, "mds_statfs" },
85 { MDS_PIN, "mds_pin" },
86 { MDS_UNPIN, "mds_unpin" },
87 { MDS_SYNC, "mds_sync" },
88 { MDS_DONE_WRITING, "mds_done_writing" },
89 { MDS_SET_INFO, "mds_set_info" },
90 { MDS_QUOTACHECK, "mds_quotacheck" },
91 { MDS_QUOTACTL, "mds_quotactl" },
92 { MDS_GETXATTR, "mds_getxattr" },
93 { MDS_SETXATTR, "mds_setxattr" },
94 { LDLM_ENQUEUE, "ldlm_enqueue" },
95 { LDLM_CONVERT, "ldlm_convert" },
96 { LDLM_CANCEL, "ldlm_cancel" },
97 { LDLM_BL_CALLBACK, "ldlm_bl_callback" },
98 { LDLM_CP_CALLBACK, "ldlm_cp_callback" },
99 { LDLM_GL_CALLBACK, "ldlm_gl_callback" },
100 { MGS_CONNECT, "mgs_connect" },
101 { MGS_DISCONNECT, "mgs_disconnect" },
102 { MGS_EXCEPTION, "mgs_exception" },
103 { MGS_TARGET_REG, "mgs_target_reg" },
104 { MGS_TARGET_DEL, "mgs_target_del" },
105 { MGS_SET_INFO, "mgs_set_info" },
106 { OBD_PING, "obd_ping" },
107 { OBD_LOG_CANCEL, "llog_origin_handle_cancel" },
108 { OBD_QC_CALLBACK, "obd_quota_callback" },
109 { LLOG_ORIGIN_HANDLE_CREATE, "llog_origin_handle_create" },
110 { LLOG_ORIGIN_HANDLE_NEXT_BLOCK, "llog_origin_handle_next_block"},
111 { LLOG_ORIGIN_HANDLE_READ_HEADER,"llog_origin_handle_read_header" },
112 { LLOG_ORIGIN_HANDLE_WRITE_REC, "llog_origin_handle_write_rec" },
113 { LLOG_ORIGIN_HANDLE_CLOSE, "llog_origin_handle_close" },
114 { LLOG_ORIGIN_CONNECT, "llog_origin_connect" },
115 { LLOG_CATINFO, "llog_catinfo" },
116 { LLOG_ORIGIN_HANDLE_PREV_BLOCK, "llog_origin_handle_prev_block" },
117 { LLOG_ORIGIN_HANDLE_DESTROY, "llog_origin_handle_destroy" },
118 { QUOTA_DQACQ, "quota_acquire" },
119 { QUOTA_DQREL, "quota_release" },
120 { SEQ_QUERY, "seq_query" },
126 } ll_eopcode_table[EXTRA_LAST_OPC] = {
127 { LDLM_GLIMPSE_ENQUEUE, "ldlm_glimpse_enqueue" },
128 { LDLM_PLAIN_ENQUEUE, "ldlm_plain_enqueue" },
129 { LDLM_EXTENT_ENQUEUE, "ldlm_extent_enqueue" },
130 { LDLM_FLOCK_ENQUEUE, "ldlm_flock_enqueue" },
131 { LDLM_IBITS_ENQUEUE, "ldlm_ibits_enqueue" },
132 { MDS_REINT_SETATTR, "mds_reint_setattr" },
133 { MDS_REINT_CREATE, "mds_reint_create" },
134 { MDS_REINT_LINK, "mds_reint_link" },
135 { MDS_REINT_UNLINK, "mds_reint_unlink" },
136 { MDS_REINT_RENAME, "mds_reint_rename" },
137 { MDS_REINT_OPEN, "mds_reint_open" },
138 { BRW_READ_BYTES, "read_bytes" },
139 { BRW_WRITE_BYTES, "write_bytes" },
142 const char *ll_opcode2str(__u32 opcode)
144 /* When one of the assertions below fail, chances are that:
145 * 1) A new opcode was added in include/lustre/lustre_idl.h,
146 * but is missing from the table above.
147 * or 2) The opcode space was renumbered or rearranged,
148 * and the opcode_offset() function in
149 * ptlrpc_internal.h needs to be modified.
151 __u32 offset = opcode_offset(opcode);
152 LASSERTF(offset < LUSTRE_MAX_OPCODES,
153 "offset %u >= LUSTRE_MAX_OPCODES %u\n",
154 offset, LUSTRE_MAX_OPCODES);
155 LASSERTF(ll_rpc_opcode_table[offset].opcode == opcode,
156 "ll_rpc_opcode_table[%u].opcode %u != opcode %u\n",
157 offset, ll_rpc_opcode_table[offset].opcode, opcode);
158 return ll_rpc_opcode_table[offset].opname;
161 const char* ll_eopcode2str(__u32 opcode)
163 LASSERT(ll_eopcode_table[opcode].opcode == opcode);
164 return ll_eopcode_table[opcode].opname;
168 void ptlrpc_lprocfs_register(struct proc_dir_entry *root, char *dir,
169 char *name, struct proc_dir_entry **procroot_ret,
170 struct lprocfs_stats **stats_ret)
172 struct proc_dir_entry *svc_procroot;
173 struct lprocfs_stats *svc_stats;
175 unsigned int svc_counter_config = LPROCFS_CNTR_AVGMINMAX |
178 LASSERT(*procroot_ret == NULL);
179 LASSERT(*stats_ret == NULL);
181 svc_stats = lprocfs_alloc_stats(EXTRA_MAX_OPCODES + LUSTRE_MAX_OPCODES, 0);
182 if (svc_stats == NULL)
186 svc_procroot = lprocfs_register(dir, root, NULL, NULL);
187 if (IS_ERR(svc_procroot)) {
188 lprocfs_free_stats(&svc_stats);
195 lprocfs_counter_init(svc_stats, PTLRPC_REQWAIT_CNTR,
196 svc_counter_config, "req_waittime", "usec");
197 lprocfs_counter_init(svc_stats, PTLRPC_REQQDEPTH_CNTR,
198 svc_counter_config, "req_qdepth", "reqs");
199 lprocfs_counter_init(svc_stats, PTLRPC_REQACTIVE_CNTR,
200 svc_counter_config, "req_active", "reqs");
201 lprocfs_counter_init(svc_stats, PTLRPC_TIMEOUT,
202 svc_counter_config, "req_timeout", "sec");
203 lprocfs_counter_init(svc_stats, PTLRPC_REQBUF_AVAIL_CNTR,
204 svc_counter_config, "reqbuf_avail", "bufs");
205 for (i = 0; i < EXTRA_LAST_OPC; i++) {
209 case BRW_WRITE_BYTES:
217 lprocfs_counter_init(svc_stats, PTLRPC_LAST_CNTR + i,
219 ll_eopcode2str(i), units);
221 for (i = 0; i < LUSTRE_MAX_OPCODES; i++) {
222 __u32 opcode = ll_rpc_opcode_table[i].opcode;
223 lprocfs_counter_init(svc_stats,
224 EXTRA_MAX_OPCODES + i, svc_counter_config,
225 ll_opcode2str(opcode), "usec");
228 rc = lprocfs_register_stats(svc_procroot, name, svc_stats);
231 lprocfs_remove(&svc_procroot);
232 lprocfs_free_stats(&svc_stats);
235 *procroot_ret = svc_procroot;
236 *stats_ret = svc_stats;
241 ptlrpc_lprocfs_read_req_history_len(char *page, char **start, off_t off,
242 int count, int *eof, void *data)
244 struct ptlrpc_service *svc = data;
247 return snprintf(page, count, "%d\n", svc->srv_n_history_rqbds);
251 ptlrpc_lprocfs_read_req_history_max(char *page, char **start, off_t off,
252 int count, int *eof, void *data)
254 struct ptlrpc_service *svc = data;
257 return snprintf(page, count, "%d\n", svc->srv_max_history_rqbds);
261 ptlrpc_lprocfs_write_req_history_max(struct file *file, const char *buffer,
262 unsigned long count, void *data)
264 struct ptlrpc_service *svc = data;
267 int rc = lprocfs_write_helper(buffer, count, &val);
275 /* This sanity check is more of an insanity check; we can still
276 * hose a kernel by allowing the request history to grow too
278 bufpages = (svc->srv_buf_size + CFS_PAGE_SIZE - 1) >> CFS_PAGE_SHIFT;
279 if (val > num_physpages/(2*bufpages))
282 spin_lock(&svc->srv_lock);
283 svc->srv_max_history_rqbds = val;
284 spin_unlock(&svc->srv_lock);
289 struct ptlrpc_srh_iterator {
291 struct ptlrpc_request *srhi_req;
295 ptlrpc_lprocfs_svc_req_history_seek(struct ptlrpc_service *svc,
296 struct ptlrpc_srh_iterator *srhi,
300 struct ptlrpc_request *req;
302 if (srhi->srhi_req != NULL &&
303 srhi->srhi_seq > svc->srv_request_max_cull_seq &&
304 srhi->srhi_seq <= seq) {
305 /* If srhi_req was set previously, hasn't been culled and
306 * we're searching for a seq on or after it (i.e. more
307 * recent), search from it onwards.
308 * Since the service history is LRU (i.e. culled reqs will
309 * be near the head), we shouldn't have to do long
311 LASSERT (srhi->srhi_seq == srhi->srhi_req->rq_history_seq);
312 LASSERT (!list_empty(&svc->srv_request_history));
313 e = &srhi->srhi_req->rq_history_list;
315 /* search from start */
316 e = svc->srv_request_history.next;
319 while (e != &svc->srv_request_history) {
320 req = list_entry(e, struct ptlrpc_request, rq_history_list);
322 if (req->rq_history_seq >= seq) {
323 srhi->srhi_seq = req->rq_history_seq;
324 srhi->srhi_req = req;
334 ptlrpc_lprocfs_svc_req_history_start(struct seq_file *s, loff_t *pos)
336 struct ptlrpc_service *svc = s->private;
337 struct ptlrpc_srh_iterator *srhi;
340 OBD_ALLOC(srhi, sizeof(*srhi));
345 srhi->srhi_req = NULL;
347 spin_lock(&svc->srv_lock);
348 rc = ptlrpc_lprocfs_svc_req_history_seek(svc, srhi, *pos);
349 spin_unlock(&svc->srv_lock);
352 *pos = srhi->srhi_seq;
356 OBD_FREE(srhi, sizeof(*srhi));
361 ptlrpc_lprocfs_svc_req_history_stop(struct seq_file *s, void *iter)
363 struct ptlrpc_srh_iterator *srhi = iter;
366 OBD_FREE(srhi, sizeof(*srhi));
370 ptlrpc_lprocfs_svc_req_history_next(struct seq_file *s,
371 void *iter, loff_t *pos)
373 struct ptlrpc_service *svc = s->private;
374 struct ptlrpc_srh_iterator *srhi = iter;
377 spin_lock(&svc->srv_lock);
378 rc = ptlrpc_lprocfs_svc_req_history_seek(svc, srhi, *pos + 1);
379 spin_unlock(&svc->srv_lock);
382 OBD_FREE(srhi, sizeof(*srhi));
386 *pos = srhi->srhi_seq;
390 /* common ost/mdt srv_request_history_print_fn */
391 void target_print_req(void *seq_file, struct ptlrpc_request *req)
393 /* Called holding srv_lock with irqs disabled.
394 * Print specific req contents and a newline.
395 * CAVEAT EMPTOR: check request message length before printing!!!
396 * You might have received any old crap so you must be just as
397 * careful here as the service's request parser!!! */
398 struct seq_file *sf = seq_file;
400 switch (req->rq_phase) {
402 /* still awaiting a service thread's attention, or rejected
403 * because the generic request message didn't unpack */
404 seq_printf(sf, "<not swabbed>\n");
406 case RQ_PHASE_INTERPRET:
407 /* being handled, so basic msg swabbed, and opc is valid
408 * but racing with mds_handle() */
409 case RQ_PHASE_COMPLETE:
410 /* been handled by mds_handle() reply state possibly still
412 seq_printf(sf, "opc %d\n", lustre_msg_get_opc(req->rq_reqmsg));
415 DEBUG_REQ(D_ERROR, req, "bad phase %d", req->rq_phase);
418 EXPORT_SYMBOL(target_print_req);
420 static int ptlrpc_lprocfs_svc_req_history_show(struct seq_file *s, void *iter)
422 struct ptlrpc_service *svc = s->private;
423 struct ptlrpc_srh_iterator *srhi = iter;
424 struct ptlrpc_request *req;
427 spin_lock(&svc->srv_lock);
429 rc = ptlrpc_lprocfs_svc_req_history_seek(svc, srhi, srhi->srhi_seq);
432 req = srhi->srhi_req;
434 /* Print common req fields.
435 * CAVEAT EMPTOR: we're racing with the service handler
436 * here. The request could contain any old crap, so you
437 * must be just as careful as the service's request
438 * parser. Currently I only print stuff here I know is OK
439 * to look at coz it was set up in request_in_callback()!!! */
440 seq_printf(s, LPD64":%s:%s:x"LPD64":%d:%s:%ld:%lds(%+lds) ",
441 req->rq_history_seq, libcfs_nid2str(req->rq_self),
442 libcfs_id2str(req->rq_peer), req->rq_xid,
443 req->rq_reqlen, ptlrpc_rqphase2str(req),
444 req->rq_arrival_time.tv_sec,
445 req->rq_sent - req->rq_arrival_time.tv_sec,
446 req->rq_sent - req->rq_deadline);
447 if (svc->srv_request_history_print_fn == NULL)
450 svc->srv_request_history_print_fn(s, srhi->srhi_req);
453 spin_unlock(&svc->srv_lock);
459 ptlrpc_lprocfs_svc_req_history_open(struct inode *inode, struct file *file)
461 static struct seq_operations sops = {
462 .start = ptlrpc_lprocfs_svc_req_history_start,
463 .stop = ptlrpc_lprocfs_svc_req_history_stop,
464 .next = ptlrpc_lprocfs_svc_req_history_next,
465 .show = ptlrpc_lprocfs_svc_req_history_show,
467 struct proc_dir_entry *dp = PDE(inode);
468 struct seq_file *seqf;
471 LPROCFS_ENTRY_AND_CHECK(dp);
472 rc = seq_open(file, &sops);
478 seqf = file->private_data;
479 seqf->private = dp->data;
483 /* See also lprocfs_rd_timeouts */
484 static int ptlrpc_lprocfs_rd_timeouts(char *page, char **start, off_t off,
485 int count, int *eof, void *data)
487 struct ptlrpc_service *svc = data;
488 unsigned int cur, worst;
494 cur = at_get(&svc->srv_at_estimate);
495 worst = svc->srv_at_estimate.at_worst_ever;
496 worstt = svc->srv_at_estimate.at_worst_time;
497 s2dhms(&ts, cfs_time_current_sec() - worstt);
499 rc += snprintf(page + rc, count - rc,
500 "adaptive timeouts off, using obd_timeout %u\n",
502 rc += snprintf(page + rc, count - rc,
503 "%10s : cur %3u worst %3u (at %ld, "DHMS_FMT" ago) ",
504 "service", cur, worst, worstt,
506 rc = lprocfs_at_hist_helper(page, count, rc,
507 &svc->srv_at_estimate);
511 static int ptlrpc_lprocfs_rd_hp_ratio(char *page, char **start, off_t off,
512 int count, int *eof, void *data)
514 struct ptlrpc_service *svc = data;
515 int rc = snprintf(page, count, "%d", svc->srv_hpreq_ratio);
519 static int ptlrpc_lprocfs_wr_hp_ratio(struct file *file, const char *buffer,
520 unsigned long count, void *data)
522 struct ptlrpc_service *svc = data;
525 rc = lprocfs_write_helper(buffer, count, &val);
531 spin_lock(&svc->srv_lock);
532 svc->srv_hpreq_ratio = val;
533 spin_unlock(&svc->srv_lock);
537 void ptlrpc_lprocfs_register_service(struct proc_dir_entry *entry,
538 struct ptlrpc_service *svc)
540 struct lprocfs_vars lproc_vars[] = {
541 {.name = "req_buffer_history_len",
543 .read_fptr = ptlrpc_lprocfs_read_req_history_len,
545 {.name = "req_buffer_history_max",
546 .write_fptr = ptlrpc_lprocfs_write_req_history_max,
547 .read_fptr = ptlrpc_lprocfs_read_req_history_max,
550 .read_fptr = ptlrpc_lprocfs_rd_timeouts,
552 {.name = "high_priority_ratio",
553 .read_fptr = ptlrpc_lprocfs_rd_hp_ratio,
554 .write_fptr = ptlrpc_lprocfs_wr_hp_ratio,
558 static struct file_operations req_history_fops = {
559 .owner = THIS_MODULE,
560 .open = ptlrpc_lprocfs_svc_req_history_open,
563 .release = lprocfs_seq_release,
565 struct proc_dir_entry *req_history;
567 ptlrpc_lprocfs_register(entry, svc->srv_name,
568 "stats", &svc->srv_procroot,
571 if (svc->srv_procroot == NULL)
574 lprocfs_add_vars(svc->srv_procroot, lproc_vars, NULL);
576 req_history = create_proc_entry("req_history", 0400,
578 if (req_history != NULL) {
579 req_history->data = svc;
580 req_history->proc_fops = &req_history_fops;
584 void ptlrpc_lprocfs_register_obd(struct obd_device *obddev)
586 ptlrpc_lprocfs_register(obddev->obd_proc_entry, NULL, "stats",
587 &obddev->obd_svc_procroot,
588 &obddev->obd_svc_stats);
590 EXPORT_SYMBOL(ptlrpc_lprocfs_register_obd);
592 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req)
594 struct lprocfs_stats *svc_stats;
595 __u32 op = lustre_msg_get_opc(req->rq_reqmsg);
596 int opc = opcode_offset(op);
598 svc_stats = req->rq_import->imp_obd->obd_svc_stats;
599 if (svc_stats == NULL || opc <= 0)
601 LASSERT(opc < LUSTRE_MAX_OPCODES);
602 if (!(op == LDLM_ENQUEUE || op == MDS_REINT))
603 lprocfs_counter_add(svc_stats, opc + EXTRA_MAX_OPCODES, 0);
606 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes)
608 struct lprocfs_stats *svc_stats;
613 svc_stats = req->rq_import->imp_obd->obd_svc_stats;
616 idx = lustre_msg_get_opc(req->rq_reqmsg);
619 idx = BRW_READ_BYTES + PTLRPC_LAST_CNTR;
622 idx = BRW_WRITE_BYTES + PTLRPC_LAST_CNTR;
625 LASSERTF(0, "unsupported opcode %u\n", idx);
629 lprocfs_counter_add(svc_stats, idx, bytes);
632 EXPORT_SYMBOL(ptlrpc_lprocfs_brw);
634 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc)
636 if (svc->srv_procroot != NULL)
637 lprocfs_remove(&svc->srv_procroot);
639 lprocfs_free_stats(&svc->srv_stats);
642 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd)
644 if (obd->obd_svc_procroot)
645 lprocfs_remove(&obd->obd_svc_procroot);
646 if (obd->obd_svc_stats)
647 lprocfs_free_stats(&obd->obd_svc_stats);
649 EXPORT_SYMBOL(ptlrpc_lprocfs_unregister_obd);
652 int lprocfs_wr_evict_client(struct file *file, const char *buffer,
653 unsigned long count, void *data)
655 struct obd_device *obd = data;
656 char tmpbuf[sizeof(struct obd_uuid)];
658 /* Kludge code(deadlock situation): the lprocfs lock has been held
659 * since the client is evicted by writting client's
660 * uuid/nid to procfs "evict_client" entry. However,
661 * obd_export_evict_by_uuid() will call lprocfs_remove() to destroy
662 * the proc entries under the being destroyed export{}, so I have
663 * to drop the lock at first here.
664 * - jay, jxiong@clusterfs.com */
668 sscanf(buffer, "%40s", tmpbuf);
669 if (strncmp(tmpbuf, "nid:", 4) == 0)
670 obd_export_evict_by_nid(obd, tmpbuf + 4);
671 else if (strncmp(tmpbuf, "uuid:", 5) == 0)
672 obd_export_evict_by_uuid(obd, tmpbuf + 5);
674 obd_export_evict_by_uuid(obd, tmpbuf);
681 EXPORT_SYMBOL(lprocfs_wr_evict_client);
683 int lprocfs_wr_ping(struct file *file, const char *buffer,
684 unsigned long count, void *data)
686 struct obd_device *obd = data;
687 struct ptlrpc_request *req;
691 LPROCFS_CLIMP_CHECK(obd);
692 req = ptlrpc_prep_ping(obd->u.cli.cl_import);
693 LPROCFS_CLIMP_EXIT(obd);
697 req->rq_send_state = LUSTRE_IMP_FULL;
699 rc = ptlrpc_queue_wait(req);
701 ptlrpc_req_finished(req);
706 EXPORT_SYMBOL(lprocfs_wr_ping);