4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 #define DEBUG_SUBSYSTEM S_CLASS
35 #include <obd_support.h>
37 #include <lprocfs_status.h>
38 #include <lustre_net.h>
39 #include <obd_class.h>
40 #include "ptlrpc_internal.h"
43 static struct ll_rpc_opcode {
46 } ll_rpc_opcode_table[LUSTRE_MAX_OPCODES] = {
47 { OST_REPLY, "ost_reply" },
48 { OST_GETATTR, "ost_getattr" },
49 { OST_SETATTR, "ost_setattr" },
50 { OST_READ, "ost_read" },
51 { OST_WRITE, "ost_write" },
52 { OST_CREATE , "ost_create" },
53 { OST_DESTROY, "ost_destroy" },
54 { OST_GET_INFO, "ost_get_info" },
55 { OST_CONNECT, "ost_connect" },
56 { OST_DISCONNECT, "ost_disconnect" },
57 { OST_PUNCH, "ost_punch" },
58 { OST_OPEN, "ost_open" },
59 { OST_CLOSE, "ost_close" },
60 { OST_STATFS, "ost_statfs" },
61 { 14, NULL }, /* formerly OST_SAN_READ */
62 { 15, NULL }, /* formerly OST_SAN_WRITE */
63 { OST_SYNC, "ost_sync" },
64 { OST_SET_INFO, "ost_set_info" },
65 { OST_QUOTACHECK, "ost_quotacheck" },
66 { OST_QUOTACTL, "ost_quotactl" },
67 { OST_QUOTA_ADJUST_QUNIT, "ost_quota_adjust_qunit" },
68 { OST_LADVISE, "ost_ladvise" },
69 { MDS_GETATTR, "mds_getattr" },
70 { MDS_GETATTR_NAME, "mds_getattr_lock" },
71 { MDS_CLOSE, "mds_close" },
72 { MDS_REINT, "mds_reint" },
73 { MDS_READPAGE, "mds_readpage" },
74 { MDS_CONNECT, "mds_connect" },
75 { MDS_DISCONNECT, "mds_disconnect" },
76 { MDS_GET_ROOT, "mds_get_root" },
77 { MDS_STATFS, "mds_statfs" },
78 { MDS_PIN, "mds_pin" },
79 { MDS_UNPIN, "mds_unpin" },
80 { MDS_SYNC, "mds_sync" },
81 { MDS_DONE_WRITING, "mds_done_writing" },
82 { MDS_SET_INFO, "mds_set_info" },
83 { MDS_QUOTACHECK, "mds_quotacheck" },
84 { MDS_QUOTACTL, "mds_quotactl" },
85 { MDS_GETXATTR, "mds_getxattr" },
86 { MDS_SETXATTR, "mds_setxattr" },
87 { MDS_WRITEPAGE, "mds_writepage" },
88 { MDS_IS_SUBDIR, "mds_is_subdir" },
89 { MDS_GET_INFO, "mds_get_info" },
90 { MDS_HSM_STATE_GET, "mds_hsm_state_get" },
91 { MDS_HSM_STATE_SET, "mds_hsm_state_set" },
92 { MDS_HSM_ACTION, "mds_hsm_action" },
93 { MDS_HSM_PROGRESS, "mds_hsm_progress" },
94 { MDS_HSM_REQUEST, "mds_hsm_request" },
95 { MDS_HSM_CT_REGISTER, "mds_hsm_ct_register" },
96 { MDS_HSM_CT_UNREGISTER, "mds_hsm_ct_unregister" },
97 { MDS_SWAP_LAYOUTS, "mds_swap_layouts" },
98 { MDS_RMFID, "mds_rmfid" },
99 { LDLM_ENQUEUE, "ldlm_enqueue" },
100 { LDLM_CONVERT, "ldlm_convert" },
101 { LDLM_CANCEL, "ldlm_cancel" },
102 { LDLM_BL_CALLBACK, "ldlm_bl_callback" },
103 { LDLM_CP_CALLBACK, "ldlm_cp_callback" },
104 { LDLM_GL_CALLBACK, "ldlm_gl_callback" },
105 { LDLM_SET_INFO, "ldlm_set_info" },
106 { MGS_CONNECT, "mgs_connect" },
107 { MGS_DISCONNECT, "mgs_disconnect" },
108 { MGS_EXCEPTION, "mgs_exception" },
109 { MGS_TARGET_REG, "mgs_target_reg" },
110 { MGS_TARGET_DEL, "mgs_target_del" },
111 { MGS_SET_INFO, "mgs_set_info" },
112 { MGS_CONFIG_READ, "mgs_config_read" },
113 { OBD_PING, "obd_ping" },
114 { 401, /* was OBD_LOG_CANCEL */ "llog_cancel" },
115 { 402, /* was OBD_QC_CALLBACK */ "obd_quota_callback" },
116 { OBD_IDX_READ, "dt_index_read" },
117 { LLOG_ORIGIN_HANDLE_CREATE, "llog_origin_handle_open" },
118 { LLOG_ORIGIN_HANDLE_NEXT_BLOCK, "llog_origin_handle_next_block" },
119 { LLOG_ORIGIN_HANDLE_READ_HEADER,"llog_origin_handle_read_header" },
120 { 504, /*LLOG_ORIGIN_HANDLE_WRITE_REC*/"llog_origin_handle_write_rec" },
121 { 505, /* was LLOG_ORIGIN_HANDLE_CLOSE */ "llog_origin_handle_close" },
122 { 506, /* was LLOG_ORIGIN_CONNECT */ "llog_origin_connect" },
123 { 507, /* was LLOG_CATINFO */ "llog_catinfo" },
124 { LLOG_ORIGIN_HANDLE_PREV_BLOCK, "llog_origin_handle_prev_block" },
125 { LLOG_ORIGIN_HANDLE_DESTROY, "llog_origin_handle_destroy" },
126 { QUOTA_DQACQ, "quota_acquire" },
127 { QUOTA_DQREL, "quota_release" },
128 { SEQ_QUERY, "seq_query" },
129 { SEC_CTX_INIT, "sec_ctx_init" },
130 { SEC_CTX_INIT_CONT,"sec_ctx_init_cont" },
131 { SEC_CTX_FINI, "sec_ctx_fini" },
132 { FLD_QUERY, "fld_query" },
133 { FLD_READ, "fld_read" },
134 { OUT_UPDATE, "out_update" },
135 { LFSCK_NOTIFY, "lfsck_notify" },
136 { LFSCK_QUERY, "lfsck_query" },
139 static struct ll_eopcode {
142 } ll_eopcode_table[EXTRA_LAST_OPC] = {
143 { LDLM_GLIMPSE_ENQUEUE, "ldlm_glimpse_enqueue" },
144 { LDLM_PLAIN_ENQUEUE, "ldlm_plain_enqueue" },
145 { LDLM_EXTENT_ENQUEUE, "ldlm_extent_enqueue" },
146 { LDLM_FLOCK_ENQUEUE, "ldlm_flock_enqueue" },
147 { LDLM_IBITS_ENQUEUE, "ldlm_ibits_enqueue" },
148 { MDS_REINT_SETATTR, "mds_reint_setattr" },
149 { MDS_REINT_CREATE, "mds_reint_create" },
150 { MDS_REINT_LINK, "mds_reint_link" },
151 { MDS_REINT_UNLINK, "mds_reint_unlink" },
152 { MDS_REINT_RENAME, "mds_reint_rename" },
153 { MDS_REINT_OPEN, "mds_reint_open" },
154 { MDS_REINT_SETXATTR, "mds_reint_setxattr" },
155 { MDS_REINT_RESYNC, "mds_reint_resync" },
156 { BRW_READ_BYTES, "read_bytes" },
157 { BRW_WRITE_BYTES, "write_bytes" },
160 const char *ll_opcode2str(__u32 opcode)
162 /* When one of the assertions below fail, chances are that:
163 * 1) A new opcode was added in include/lustre/lustre_idl.h,
164 * but is missing from the table above.
165 * or 2) The opcode space was renumbered or rearranged,
166 * and the opcode_offset() function in
167 * ptlrpc_internal.h needs to be modified.
169 __u32 offset = opcode_offset(opcode);
170 LASSERTF(offset < LUSTRE_MAX_OPCODES,
171 "offset %u >= LUSTRE_MAX_OPCODES %u\n",
172 offset, LUSTRE_MAX_OPCODES);
173 LASSERTF(ll_rpc_opcode_table[offset].opcode == opcode,
174 "ll_rpc_opcode_table[%u].opcode %u != opcode %u\n",
175 offset, ll_rpc_opcode_table[offset].opcode, opcode);
176 return ll_rpc_opcode_table[offset].opname;
179 const int ll_str2opcode(const char *ops)
183 for (i = 0; i < LUSTRE_MAX_OPCODES; i++) {
184 if (ll_rpc_opcode_table[i].opname != NULL &&
185 strcmp(ll_rpc_opcode_table[i].opname, ops) == 0)
186 return ll_rpc_opcode_table[i].opcode;
192 static const char *ll_eopcode2str(__u32 opcode)
194 LASSERT(ll_eopcode_table[opcode].opcode == opcode);
195 return ll_eopcode_table[opcode].opname;
199 ptlrpc_ldebugfs_register(struct dentry *root, char *dir, char *name,
200 struct dentry **debugfs_root_ret,
201 struct lprocfs_stats **stats_ret)
203 struct dentry *svc_debugfs_entry;
204 struct lprocfs_stats *svc_stats;
206 unsigned int svc_counter_config = LPROCFS_CNTR_AVGMINMAX |
209 LASSERT(!*debugfs_root_ret);
210 LASSERT(!*stats_ret);
212 svc_stats = lprocfs_alloc_stats(EXTRA_MAX_OPCODES + LUSTRE_MAX_OPCODES,
218 svc_debugfs_entry = ldebugfs_register(dir, root, NULL, NULL);
219 if (IS_ERR(svc_debugfs_entry)) {
220 lprocfs_free_stats(&svc_stats);
224 svc_debugfs_entry = root;
227 lprocfs_counter_init(svc_stats, PTLRPC_REQWAIT_CNTR,
228 svc_counter_config, "req_waittime", "usec");
229 lprocfs_counter_init(svc_stats, PTLRPC_REQQDEPTH_CNTR,
230 svc_counter_config, "req_qdepth", "reqs");
231 lprocfs_counter_init(svc_stats, PTLRPC_REQACTIVE_CNTR,
232 svc_counter_config, "req_active", "reqs");
233 lprocfs_counter_init(svc_stats, PTLRPC_TIMEOUT,
234 svc_counter_config, "req_timeout", "sec");
235 lprocfs_counter_init(svc_stats, PTLRPC_REQBUF_AVAIL_CNTR,
236 svc_counter_config, "reqbuf_avail", "bufs");
237 for (i = 0; i < EXTRA_LAST_OPC; i++) {
241 case BRW_WRITE_BYTES:
249 lprocfs_counter_init(svc_stats, PTLRPC_LAST_CNTR + i,
251 ll_eopcode2str(i), units);
253 for (i = 0; i < LUSTRE_MAX_OPCODES; i++) {
254 __u32 opcode = ll_rpc_opcode_table[i].opcode;
255 lprocfs_counter_init(svc_stats,
256 EXTRA_MAX_OPCODES + i, svc_counter_config,
257 ll_opcode2str(opcode), "usec");
260 rc = ldebugfs_register_stats(svc_debugfs_entry, name, svc_stats);
263 debugfs_remove_recursive(svc_debugfs_entry);
264 lprocfs_free_stats(&svc_stats);
267 *debugfs_root_ret = svc_debugfs_entry;
268 *stats_ret = svc_stats;
273 ptlrpc_lprocfs_req_history_len_seq_show(struct seq_file *m, void *v)
275 struct ptlrpc_service *svc = m->private;
276 struct ptlrpc_service_part *svcpt;
280 ptlrpc_service_for_each_part(svcpt, i, svc)
281 total += svcpt->scp_hist_nrqbds;
283 seq_printf(m, "%d\n", total);
288 LDEBUGFS_SEQ_FOPS_RO(ptlrpc_lprocfs_req_history_len);
291 ptlrpc_lprocfs_req_history_max_seq_show(struct seq_file *m, void *n)
293 struct ptlrpc_service *svc = m->private;
294 struct ptlrpc_service_part *svcpt;
298 ptlrpc_service_for_each_part(svcpt, i, svc)
299 total += svc->srv_hist_nrqbds_cpt_max;
301 seq_printf(m, "%d\n", total);
306 ptlrpc_lprocfs_req_history_max_seq_write(struct file *file,
307 const char __user *buffer,
308 size_t count, loff_t *off)
310 struct seq_file *m = file->private_data;
311 struct ptlrpc_service *svc = m->private;
312 unsigned long long val;
313 unsigned long long limit;
317 rc = kstrtoull_from_user(buffer, count, 0, &val);
321 if (val < 0 || val > INT_MAX)
324 /* This sanity check is more of an insanity check; we can still
325 * hose a kernel by allowing the request history to grow too
326 * far. The roundup to the next power of two is an empirical way
327 * to take care that request buffer is allocated in Slab and thus
328 * will be upgraded */
329 bufpages = (roundup_pow_of_two(svc->srv_buf_size) + PAGE_SIZE - 1) >>
331 limit = cfs_totalram_pages() / (2 * bufpages);
332 /* do not allow history to consume more than half max number of rqbds */
333 if ((svc->srv_nrqbds_max == 0 && val > limit) ||
334 (svc->srv_nrqbds_max != 0 && val > svc->srv_nrqbds_max / 2))
337 spin_lock(&svc->srv_lock);
340 svc->srv_hist_nrqbds_cpt_max = 0;
342 svc->srv_hist_nrqbds_cpt_max =
343 max(1, ((int)val / svc->srv_ncpts));
345 spin_unlock(&svc->srv_lock);
350 LDEBUGFS_SEQ_FOPS(ptlrpc_lprocfs_req_history_max);
353 ptlrpc_lprocfs_req_buffers_max_seq_show(struct seq_file *m, void *n)
355 struct ptlrpc_service *svc = m->private;
357 seq_printf(m, "%d\n", svc->srv_nrqbds_max);
362 ptlrpc_lprocfs_req_buffers_max_seq_write(struct file *file,
363 const char __user *buffer,
364 size_t count, loff_t *off)
366 struct seq_file *m = file->private_data;
367 struct ptlrpc_service *svc = m->private;
371 rc = kstrtoint_from_user(buffer, count, 0, &val);
375 if (val < svc->srv_nbuf_per_group && val != 0)
378 spin_lock(&svc->srv_lock);
380 svc->srv_nrqbds_max = (uint)val;
382 spin_unlock(&svc->srv_lock);
387 LDEBUGFS_SEQ_FOPS(ptlrpc_lprocfs_req_buffers_max);
389 static ssize_t threads_min_show(struct kobject *kobj, struct attribute *attr,
392 struct ptlrpc_service *svc = container_of(kobj, struct ptlrpc_service,
395 return sprintf(buf, "%d\n", svc->srv_nthrs_cpt_init * svc->srv_ncpts);
398 static ssize_t threads_min_store(struct kobject *kobj, struct attribute *attr,
399 const char *buffer, size_t count)
401 struct ptlrpc_service *svc = container_of(kobj, struct ptlrpc_service,
406 rc = kstrtoul(buffer, 10, &val);
410 if (val / svc->srv_ncpts < PTLRPC_NTHRS_INIT)
413 spin_lock(&svc->srv_lock);
414 if (val > svc->srv_nthrs_cpt_limit * svc->srv_ncpts) {
415 spin_unlock(&svc->srv_lock);
419 svc->srv_nthrs_cpt_init = (int)val / svc->srv_ncpts;
421 spin_unlock(&svc->srv_lock);
425 LUSTRE_RW_ATTR(threads_min);
427 static ssize_t threads_started_show(struct kobject *kobj,
428 struct attribute *attr,
431 struct ptlrpc_service *svc = container_of(kobj, struct ptlrpc_service,
433 struct ptlrpc_service_part *svcpt;
437 ptlrpc_service_for_each_part(svcpt, i, svc)
438 total += svcpt->scp_nthrs_running;
440 return sprintf(buf, "%d\n", total);
442 LUSTRE_RO_ATTR(threads_started);
444 static ssize_t threads_max_show(struct kobject *kobj, struct attribute *attr,
447 struct ptlrpc_service *svc = container_of(kobj, struct ptlrpc_service,
450 return sprintf(buf, "%d\n", svc->srv_nthrs_cpt_limit * svc->srv_ncpts);
453 static ssize_t threads_max_store(struct kobject *kobj, struct attribute *attr,
454 const char *buffer, size_t count)
456 struct ptlrpc_service *svc = container_of(kobj, struct ptlrpc_service,
461 rc = kstrtoul(buffer, 10, &val);
465 if (val / svc->srv_ncpts < PTLRPC_NTHRS_INIT)
468 spin_lock(&svc->srv_lock);
469 if (val < svc->srv_nthrs_cpt_init * svc->srv_ncpts) {
470 spin_unlock(&svc->srv_lock);
474 svc->srv_nthrs_cpt_limit = (int)val / svc->srv_ncpts;
476 spin_unlock(&svc->srv_lock);
480 LUSTRE_RW_ATTR(threads_max);
483 * Translates \e ptlrpc_nrs_pol_state values to human-readable strings.
485 * \param[in] state The policy state
487 static const char *nrs_state2str(enum ptlrpc_nrs_pol_state state)
492 case NRS_POL_STATE_INVALID:
494 case NRS_POL_STATE_STOPPED:
496 case NRS_POL_STATE_STOPPING:
498 case NRS_POL_STATE_STARTING:
500 case NRS_POL_STATE_STARTED:
506 * Obtains status information for \a policy.
508 * Information is copied in \a info.
510 * \param[in] policy The policy
511 * \param[out] info Holds returned status information
513 void nrs_policy_get_info_locked(struct ptlrpc_nrs_policy *policy,
514 struct ptlrpc_nrs_pol_info *info)
516 LASSERT(policy != NULL);
517 LASSERT(info != NULL);
518 assert_spin_locked(&policy->pol_nrs->nrs_lock);
520 BUILD_BUG_ON(sizeof(info->pi_arg) != sizeof(policy->pol_arg));
521 memcpy(info->pi_name, policy->pol_desc->pd_name, NRS_POL_NAME_MAX);
522 memcpy(info->pi_arg, policy->pol_arg, sizeof(policy->pol_arg));
524 info->pi_fallback = !!(policy->pol_flags & PTLRPC_NRS_FL_FALLBACK);
525 info->pi_state = policy->pol_state;
527 * XXX: These are accessed without holding
528 * ptlrpc_service_part::scp_req_lock.
530 info->pi_req_queued = policy->pol_req_queued;
531 info->pi_req_started = policy->pol_req_started;
535 * Reads and prints policy status information for all policies of a PTLRPC
538 static int ptlrpc_lprocfs_nrs_seq_show(struct seq_file *m, void *n)
540 struct ptlrpc_service *svc = m->private;
541 struct ptlrpc_service_part *svcpt;
542 struct ptlrpc_nrs *nrs;
543 struct ptlrpc_nrs_policy *policy;
544 struct ptlrpc_nrs_pol_info *infos;
545 struct ptlrpc_nrs_pol_info tmp;
547 unsigned pol_idx = 0;
554 * Serialize NRS core lprocfs operations with policy registration/
557 mutex_lock(&nrs_core.nrs_mutex);
560 * Use the first service partition's regular NRS head in order to obtain
561 * the number of policies registered with NRS heads of this service. All
562 * service partitions will have the same number of policies.
564 nrs = nrs_svcpt2nrs(svc->srv_parts[0], false);
566 spin_lock(&nrs->nrs_lock);
567 num_pols = svc->srv_parts[0]->scp_nrs_reg.nrs_num_pols;
568 spin_unlock(&nrs->nrs_lock);
570 OBD_ALLOC(infos, num_pols * sizeof(*infos));
572 GOTO(out, rc = -ENOMEM);
575 ptlrpc_service_for_each_part(svcpt, i, svc) {
576 nrs = nrs_svcpt2nrs(svcpt, hp);
577 spin_lock(&nrs->nrs_lock);
581 list_for_each_entry(policy, &nrs->nrs_policy_list,
583 LASSERT(pol_idx < num_pols);
585 nrs_policy_get_info_locked(policy, &tmp);
587 * Copy values when handling the first service
591 memcpy(infos[pol_idx].pi_name, tmp.pi_name,
593 memcpy(infos[pol_idx].pi_arg, tmp.pi_arg,
595 memcpy(&infos[pol_idx].pi_state, &tmp.pi_state,
596 sizeof(tmp.pi_state));
597 infos[pol_idx].pi_fallback = tmp.pi_fallback;
599 * For the rest of the service partitions
600 * sanity-check the values we get.
603 LASSERT(strncmp(infos[pol_idx].pi_name,
605 NRS_POL_NAME_MAX) == 0);
606 LASSERT(strncmp(infos[pol_idx].pi_arg,
608 sizeof(tmp.pi_arg)) == 0);
610 * Not asserting ptlrpc_nrs_pol_info::pi_state,
611 * because it may be different between
612 * instances of the same policy in different
613 * service partitions.
615 LASSERT(infos[pol_idx].pi_fallback ==
619 infos[pol_idx].pi_req_queued += tmp.pi_req_queued;
620 infos[pol_idx].pi_req_started += tmp.pi_req_started;
624 spin_unlock(&nrs->nrs_lock);
628 * Policy status information output is in YAML format.
644 * high_priority_requests:
657 seq_printf(m, "%s\n", !hp ? "\nregular_requests:" :
658 "high_priority_requests:");
660 for (pol_idx = 0; pol_idx < num_pols; pol_idx++) {
661 if (strlen(infos[pol_idx].pi_arg) > 0)
662 seq_printf(m, " - name: %s %s\n",
663 infos[pol_idx].pi_name,
664 infos[pol_idx].pi_arg);
666 seq_printf(m, " - name: %s\n",
667 infos[pol_idx].pi_name);
670 seq_printf(m, " state: %s\n"
673 " active: %-20d\n\n",
674 nrs_state2str(infos[pol_idx].pi_state),
675 infos[pol_idx].pi_fallback ? "yes" : "no",
676 (int)infos[pol_idx].pi_req_queued,
677 (int)infos[pol_idx].pi_req_started);
680 if (!hp && nrs_svc_has_hp(svc)) {
681 memset(infos, 0, num_pols * sizeof(*infos));
684 * Redo the processing for the service's HP NRS heads' policies.
692 OBD_FREE(infos, num_pols * sizeof(*infos));
694 mutex_unlock(&nrs_core.nrs_mutex);
700 #define LPROCFS_NRS_WR_MAX_ARG (1024)
702 * The longest valid command string is the maxium policy name size, plus the
703 * length of the " reg" substring, plus the lenght of argument
705 #define LPROCFS_NRS_WR_MAX_CMD (NRS_POL_NAME_MAX + sizeof(" reg") - 1 \
706 + LPROCFS_NRS_WR_MAX_ARG)
709 * Starts and stops a given policy on a PTLRPC service.
711 * Commands consist of the policy name, followed by an optional [reg|hp] token;
712 * if the optional token is omitted, the operation is performed on both the
713 * regular and high-priority (if the service has one) NRS head.
716 ptlrpc_lprocfs_nrs_seq_write(struct file *file, const char __user *buffer,
717 size_t count, loff_t *off)
719 struct seq_file *m = file->private_data;
720 struct ptlrpc_service *svc = m->private;
721 enum ptlrpc_nrs_queue_type queue = PTLRPC_NRS_QUEUE_BOTH;
723 char *cmd_copy = NULL;
729 if (count >= LPROCFS_NRS_WR_MAX_CMD)
730 GOTO(out, rc = -EINVAL);
732 OBD_ALLOC(cmd, LPROCFS_NRS_WR_MAX_CMD);
734 GOTO(out, rc = -ENOMEM);
736 * strsep() modifies its argument, so keep a copy
740 if (copy_from_user(cmd, buffer, count))
741 GOTO(out, rc = -EFAULT);
745 policy_name = strsep(&cmd, " ");
747 if (strlen(policy_name) > NRS_POL_NAME_MAX - 1)
748 GOTO(out, rc = -EINVAL);
751 * No [reg|hp] token has been specified
756 queue_name = strsep(&cmd, " ");
758 * The second token is either an optional [reg|hp] string,
761 if (strcmp(queue_name, "reg") == 0)
762 queue = PTLRPC_NRS_QUEUE_REG;
763 else if (strcmp(queue_name, "hp") == 0)
764 queue = PTLRPC_NRS_QUEUE_HP;
773 if (queue == PTLRPC_NRS_QUEUE_HP && !nrs_svc_has_hp(svc))
774 GOTO(out, rc = -ENODEV);
775 else if (queue == PTLRPC_NRS_QUEUE_BOTH && !nrs_svc_has_hp(svc))
776 queue = PTLRPC_NRS_QUEUE_REG;
779 * Serialize NRS core lprocfs operations with policy registration/
782 mutex_lock(&nrs_core.nrs_mutex);
784 rc = ptlrpc_nrs_policy_control(svc, queue, policy_name,
785 PTLRPC_NRS_CTL_START,
788 mutex_unlock(&nrs_core.nrs_mutex);
791 OBD_FREE(cmd_copy, LPROCFS_NRS_WR_MAX_CMD);
793 RETURN(rc < 0 ? rc : count);
796 LDEBUGFS_SEQ_FOPS(ptlrpc_lprocfs_nrs);
800 struct ptlrpc_srh_iterator {
803 struct ptlrpc_request *srhi_req;
807 ptlrpc_lprocfs_svc_req_history_seek(struct ptlrpc_service_part *svcpt,
808 struct ptlrpc_srh_iterator *srhi,
812 struct ptlrpc_request *req;
814 if (srhi->srhi_req != NULL &&
815 srhi->srhi_seq > svcpt->scp_hist_seq_culled &&
816 srhi->srhi_seq <= seq) {
817 /* If srhi_req was set previously, hasn't been culled and
818 * we're searching for a seq on or after it (i.e. more
819 * recent), search from it onwards.
820 * Since the service history is LRU (i.e. culled reqs will
821 * be near the head), we shouldn't have to do long
823 LASSERTF(srhi->srhi_seq == srhi->srhi_req->rq_history_seq,
824 "%s:%d: seek seq %llu, request seq %llu\n",
825 svcpt->scp_service->srv_name, svcpt->scp_cpt,
826 srhi->srhi_seq, srhi->srhi_req->rq_history_seq);
827 LASSERTF(!list_empty(&svcpt->scp_hist_reqs),
828 "%s:%d: seek offset %llu, request seq %llu, "
829 "last culled %llu\n",
830 svcpt->scp_service->srv_name, svcpt->scp_cpt,
831 seq, srhi->srhi_seq, svcpt->scp_hist_seq_culled);
832 e = &srhi->srhi_req->rq_history_list;
834 /* search from start */
835 e = svcpt->scp_hist_reqs.next;
838 while (e != &svcpt->scp_hist_reqs) {
839 req = list_entry(e, struct ptlrpc_request, rq_history_list);
841 if (req->rq_history_seq >= seq) {
842 srhi->srhi_seq = req->rq_history_seq;
843 srhi->srhi_req = req;
853 * ptlrpc history sequence is used as "position" of seq_file, in some case,
854 * seq_read() will increase "position" to indicate reading the next
855 * element, however, low bits of history sequence are reserved for CPT id
856 * (check the details from comments before ptlrpc_req_add_history), which
857 * means seq_read() might change CPT id of history sequence and never
858 * finish reading of requests on a CPT. To make it work, we have to shift
859 * CPT id to high bits and timestamp to low bits, so seq_read() will only
860 * increase timestamp which can correctly indicate the next position.
863 /* convert seq_file pos to cpt */
864 #define PTLRPC_REQ_POS2CPT(svc, pos) \
865 ((svc)->srv_cpt_bits == 0 ? 0 : \
866 (__u64)(pos) >> (64 - (svc)->srv_cpt_bits))
868 /* make up seq_file pos from cpt */
869 #define PTLRPC_REQ_CPT2POS(svc, cpt) \
870 ((svc)->srv_cpt_bits == 0 ? 0 : \
871 (cpt) << (64 - (svc)->srv_cpt_bits))
873 /* convert sequence to position */
874 #define PTLRPC_REQ_SEQ2POS(svc, seq) \
875 ((svc)->srv_cpt_bits == 0 ? (seq) : \
876 ((seq) >> (svc)->srv_cpt_bits) | \
877 ((seq) << (64 - (svc)->srv_cpt_bits)))
879 /* convert position to sequence */
880 #define PTLRPC_REQ_POS2SEQ(svc, pos) \
881 ((svc)->srv_cpt_bits == 0 ? (pos) : \
882 ((__u64)(pos) << (svc)->srv_cpt_bits) | \
883 ((__u64)(pos) >> (64 - (svc)->srv_cpt_bits)))
886 ptlrpc_lprocfs_svc_req_history_start(struct seq_file *s, loff_t *pos)
888 struct ptlrpc_service *svc = s->private;
889 struct ptlrpc_service_part *svcpt;
890 struct ptlrpc_srh_iterator *srhi;
895 if (sizeof(loff_t) != sizeof(__u64)) { /* can't support */
896 CWARN("Failed to read request history because size of loff_t "
897 "%d can't match size of u64\n", (int)sizeof(loff_t));
901 OBD_ALLOC(srhi, sizeof(*srhi));
906 srhi->srhi_req = NULL;
908 cpt = PTLRPC_REQ_POS2CPT(svc, *pos);
910 ptlrpc_service_for_each_part(svcpt, i, svc) {
911 if (i < cpt) /* skip */
913 if (i > cpt) /* make up the lowest position for this CPT */
914 *pos = PTLRPC_REQ_CPT2POS(svc, i);
916 mutex_lock(&svcpt->scp_mutex);
917 spin_lock(&svcpt->scp_lock);
918 rc = ptlrpc_lprocfs_svc_req_history_seek(svcpt, srhi,
919 PTLRPC_REQ_POS2SEQ(svc, *pos));
920 spin_unlock(&svcpt->scp_lock);
921 mutex_unlock(&svcpt->scp_mutex);
923 *pos = PTLRPC_REQ_SEQ2POS(svc, srhi->srhi_seq);
929 OBD_FREE(srhi, sizeof(*srhi));
934 ptlrpc_lprocfs_svc_req_history_stop(struct seq_file *s, void *iter)
936 struct ptlrpc_srh_iterator *srhi = iter;
939 OBD_FREE(srhi, sizeof(*srhi));
943 ptlrpc_lprocfs_svc_req_history_next(struct seq_file *s,
944 void *iter, loff_t *pos)
946 struct ptlrpc_service *svc = s->private;
947 struct ptlrpc_srh_iterator *srhi = iter;
948 struct ptlrpc_service_part *svcpt;
953 for (i = srhi->srhi_idx; i < svc->srv_ncpts; i++) {
954 svcpt = svc->srv_parts[i];
956 if (i > srhi->srhi_idx) { /* reset iterator for a new CPT */
957 srhi->srhi_req = NULL;
958 seq = srhi->srhi_seq = 0;
959 } else { /* the next sequence */
960 seq = srhi->srhi_seq + (1 << svc->srv_cpt_bits);
963 mutex_lock(&svcpt->scp_mutex);
964 spin_lock(&svcpt->scp_lock);
965 rc = ptlrpc_lprocfs_svc_req_history_seek(svcpt, srhi, seq);
966 spin_unlock(&svcpt->scp_lock);
967 mutex_unlock(&svcpt->scp_mutex);
969 *pos = PTLRPC_REQ_SEQ2POS(svc, srhi->srhi_seq);
975 OBD_FREE(srhi, sizeof(*srhi));
979 /* common ost/mdt so_req_printer */
980 void target_print_req(void *seq_file, struct ptlrpc_request *req)
982 /* Called holding srv_lock with irqs disabled.
983 * Print specific req contents and a newline.
984 * CAVEAT EMPTOR: check request message length before printing!!!
985 * You might have received any old crap so you must be just as
986 * careful here as the service's request parser!!! */
987 struct seq_file *sf = seq_file;
989 switch (req->rq_phase) {
991 /* still awaiting a service thread's attention, or rejected
992 * because the generic request message didn't unpack */
993 seq_printf(sf, "<not swabbed>\n");
995 case RQ_PHASE_INTERPRET:
996 /* being handled, so basic msg swabbed, and opc is valid
997 * but racing with mds_handle() */
998 case RQ_PHASE_COMPLETE:
999 /* been handled by mds_handle() reply state possibly still
1001 seq_printf(sf, "opc %d\n", lustre_msg_get_opc(req->rq_reqmsg));
1004 DEBUG_REQ(D_ERROR, req, "bad phase %d", req->rq_phase);
1007 EXPORT_SYMBOL(target_print_req);
1009 static int ptlrpc_lprocfs_svc_req_history_show(struct seq_file *s, void *iter)
1011 struct ptlrpc_service *svc = s->private;
1012 struct ptlrpc_srh_iterator *srhi = iter;
1013 struct ptlrpc_service_part *svcpt;
1014 struct ptlrpc_request *req;
1017 LASSERT(srhi->srhi_idx < svc->srv_ncpts);
1019 svcpt = svc->srv_parts[srhi->srhi_idx];
1021 mutex_lock(&svcpt->scp_mutex);
1022 spin_lock(&svcpt->scp_lock);
1024 rc = ptlrpc_lprocfs_svc_req_history_seek(svcpt, srhi, srhi->srhi_seq);
1027 struct timespec64 arrival, sent, arrivaldiff;
1028 char nidstr[LNET_NIDSTR_SIZE];
1030 req = srhi->srhi_req;
1032 arrival.tv_sec = req->rq_arrival_time.tv_sec;
1033 arrival.tv_nsec = req->rq_arrival_time.tv_nsec;
1034 sent.tv_sec = req->rq_sent;
1036 arrivaldiff = timespec64_sub(sent, arrival);
1038 /* Print common req fields.
1039 * CAVEAT EMPTOR: we're racing with the service handler
1040 * here. The request could contain any old crap, so you
1041 * must be just as careful as the service's request
1042 * parser. Currently I only print stuff here I know is OK
1043 * to look at coz it was set up in request_in_callback()!!!
1046 "%lld:%s:%s:x%llu:%d:%s:%lld.%06lld:%lld.%06llds(%+lld.0s) ",
1047 req->rq_history_seq,
1048 req->rq_export && req->rq_export->exp_obd ?
1049 req->rq_export->exp_obd->obd_name :
1050 libcfs_nid2str_r(req->rq_self, nidstr,
1052 libcfs_id2str(req->rq_peer), req->rq_xid,
1053 req->rq_reqlen, ptlrpc_rqphase2str(req),
1054 (s64)req->rq_arrival_time.tv_sec,
1055 (s64)(req->rq_arrival_time.tv_nsec / NSEC_PER_USEC),
1056 (s64)arrivaldiff.tv_sec,
1057 (s64)(arrivaldiff.tv_nsec / NSEC_PER_USEC),
1058 (s64)(req->rq_sent - req->rq_deadline));
1059 if (svc->srv_ops.so_req_printer == NULL)
1060 seq_printf(s, "\n");
1062 svc->srv_ops.so_req_printer(s, srhi->srhi_req);
1065 spin_unlock(&svcpt->scp_lock);
1066 mutex_unlock(&svcpt->scp_mutex);
1072 ptlrpc_lprocfs_svc_req_history_open(struct inode *inode, struct file *file)
1074 static struct seq_operations sops = {
1075 .start = ptlrpc_lprocfs_svc_req_history_start,
1076 .stop = ptlrpc_lprocfs_svc_req_history_stop,
1077 .next = ptlrpc_lprocfs_svc_req_history_next,
1078 .show = ptlrpc_lprocfs_svc_req_history_show,
1080 struct seq_file *seqf;
1083 rc = LPROCFS_ENTRY_CHECK(inode);
1087 rc = seq_open(file, &sops);
1091 seqf = file->private_data;
1092 seqf->private = inode->i_private;
1096 /* See also lprocfs_rd_timeouts */
1097 static int ptlrpc_lprocfs_timeouts_seq_show(struct seq_file *m, void *n)
1099 struct ptlrpc_service *svc = m->private;
1100 struct ptlrpc_service_part *svcpt;
1107 seq_printf(m, "adaptive timeouts off, using obd_timeout %u\n",
1112 ptlrpc_service_for_each_part(svcpt, i, svc) {
1113 cur = at_get(&svcpt->scp_at_estimate);
1114 worst = svcpt->scp_at_estimate.at_worst_ever;
1115 worstt = svcpt->scp_at_estimate.at_worst_time;
1117 seq_printf(m, "%10s : cur %3u worst %3u (at %lld, %llds ago) ",
1118 "service", cur, worst, (s64)worstt,
1119 (s64)(ktime_get_real_seconds() - worstt));
1121 lprocfs_at_hist_helper(m, &svcpt->scp_at_estimate);
1127 LDEBUGFS_SEQ_FOPS_RO(ptlrpc_lprocfs_timeouts);
1129 static ssize_t high_priority_ratio_show(struct kobject *kobj,
1130 struct attribute *attr,
1133 struct ptlrpc_service *svc = container_of(kobj, struct ptlrpc_service,
1136 return sprintf(buf, "%d\n", svc->srv_hpreq_ratio);
1139 static ssize_t high_priority_ratio_store(struct kobject *kobj,
1140 struct attribute *attr,
1144 struct ptlrpc_service *svc = container_of(kobj, struct ptlrpc_service,
1149 rc = kstrtoul(buffer, 10, &val);
1153 spin_lock(&svc->srv_lock);
1154 svc->srv_hpreq_ratio = val;
1155 spin_unlock(&svc->srv_lock);
1159 LUSTRE_RW_ATTR(high_priority_ratio);
1161 static struct attribute *ptlrpc_svc_attrs[] = {
1162 &lustre_attr_threads_min.attr,
1163 &lustre_attr_threads_started.attr,
1164 &lustre_attr_threads_max.attr,
1165 &lustre_attr_high_priority_ratio.attr,
1169 static void ptlrpc_sysfs_svc_release(struct kobject *kobj)
1171 struct ptlrpc_service *svc = container_of(kobj, struct ptlrpc_service,
1174 complete(&svc->srv_kobj_unregister);
1177 static struct kobj_type ptlrpc_svc_ktype = {
1178 .default_attrs = ptlrpc_svc_attrs,
1179 .sysfs_ops = &lustre_sysfs_ops,
1180 .release = ptlrpc_sysfs_svc_release,
1183 void ptlrpc_sysfs_unregister_service(struct ptlrpc_service *svc)
1185 /* Let's see if we had a chance at initialization first */
1186 if (svc->srv_kobj.kset) {
1187 kobject_put(&svc->srv_kobj);
1188 wait_for_completion(&svc->srv_kobj_unregister);
1192 int ptlrpc_sysfs_register_service(struct kset *parent,
1193 struct ptlrpc_service *svc)
1195 svc->srv_kobj.kset = parent;
1196 init_completion(&svc->srv_kobj_unregister);
1197 return kobject_init_and_add(&svc->srv_kobj, &ptlrpc_svc_ktype,
1198 &parent->kobj, "%s", svc->srv_name);
1201 void ptlrpc_ldebugfs_register_service(struct dentry *entry,
1202 struct ptlrpc_service *svc)
1204 struct lprocfs_vars lproc_vars[] = {
1205 { .name = "req_buffer_history_len",
1206 .fops = &ptlrpc_lprocfs_req_history_len_fops,
1208 { .name = "req_buffer_history_max",
1209 .fops = &ptlrpc_lprocfs_req_history_max_fops,
1211 { .name = "timeouts",
1212 .fops = &ptlrpc_lprocfs_timeouts_fops,
1214 { .name = "nrs_policies",
1215 .fops = &ptlrpc_lprocfs_nrs_fops,
1217 { .name = "req_buffers_max",
1218 .fops = &ptlrpc_lprocfs_req_buffers_max_fops,
1222 static struct file_operations req_history_fops = {
1223 .owner = THIS_MODULE,
1224 .open = ptlrpc_lprocfs_svc_req_history_open,
1226 .llseek = seq_lseek,
1227 .release = lprocfs_seq_release,
1232 ptlrpc_ldebugfs_register(entry, svc->srv_name, "stats",
1233 &svc->srv_debugfs_entry, &svc->srv_stats);
1234 if (!svc->srv_debugfs_entry)
1237 ldebugfs_add_vars(svc->srv_debugfs_entry, lproc_vars, NULL);
1239 rc = ldebugfs_seq_create(svc->srv_debugfs_entry, "req_history",
1240 0400, &req_history_fops, svc);
1242 CWARN("Error adding the req_history file\n");
1245 void ptlrpc_lprocfs_register_obd(struct obd_device *obddev)
1247 ptlrpc_ldebugfs_register(obddev->obd_debugfs_entry, NULL, "stats",
1248 &obddev->obd_svc_debugfs_entry,
1249 &obddev->obd_svc_stats);
1251 EXPORT_SYMBOL(ptlrpc_lprocfs_register_obd);
1253 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount)
1255 struct lprocfs_stats *svc_stats;
1256 __u32 op = lustre_msg_get_opc(req->rq_reqmsg);
1257 int opc = opcode_offset(op);
1259 svc_stats = req->rq_import->imp_obd->obd_svc_stats;
1260 if (svc_stats == NULL || opc <= 0)
1262 LASSERT(opc < LUSTRE_MAX_OPCODES);
1263 if (!(op == LDLM_ENQUEUE || op == MDS_REINT))
1264 lprocfs_counter_add(svc_stats, opc + EXTRA_MAX_OPCODES, amount);
1267 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes)
1269 struct lprocfs_stats *svc_stats;
1272 if (!req->rq_import)
1274 svc_stats = req->rq_import->imp_obd->obd_svc_stats;
1277 idx = lustre_msg_get_opc(req->rq_reqmsg);
1280 idx = BRW_READ_BYTES + PTLRPC_LAST_CNTR;
1283 idx = BRW_WRITE_BYTES + PTLRPC_LAST_CNTR;
1286 LASSERTF(0, "unsupported opcode %u\n", idx);
1290 lprocfs_counter_add(svc_stats, idx, bytes);
1293 EXPORT_SYMBOL(ptlrpc_lprocfs_brw);
1295 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc)
1297 debugfs_remove_recursive(svc->srv_debugfs_entry);
1300 lprocfs_free_stats(&svc->srv_stats);
1303 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd)
1305 /* cleanup first to allow concurrent access to device's
1306 * stats via debugfs to complete safely
1308 lprocfs_obd_cleanup(obd);
1310 debugfs_remove_recursive(obd->obd_svc_debugfs_entry);
1312 if (obd->obd_svc_stats)
1313 lprocfs_free_stats(&obd->obd_svc_stats);
1315 EXPORT_SYMBOL(ptlrpc_lprocfs_unregister_obd);
1317 ssize_t ping_show(struct kobject *kobj, struct attribute *attr,
1320 struct obd_device *obd = container_of(kobj, struct obd_device,
1322 struct ptlrpc_request *req;
1326 LPROCFS_CLIMP_CHECK(obd);
1327 req = ptlrpc_prep_ping(obd->u.cli.cl_import);
1328 LPROCFS_CLIMP_EXIT(obd);
1332 req->rq_send_state = LUSTRE_IMP_FULL;
1334 rc = ptlrpc_queue_wait(req);
1335 ptlrpc_req_finished(req);
1339 EXPORT_SYMBOL(ping_show);
1341 /* kept for older verison of tools. */
1342 ssize_t ping_store(struct kobject *kobj, struct attribute *attr,
1343 const char *buffer, size_t count)
1345 return ping_show(kobj, attr, (char *)buffer);
1347 EXPORT_SYMBOL(ping_store);
1349 /* Write the connection UUID to this file to attempt to connect to that node.
1350 * The connection UUID is a node's primary NID. For example,
1351 * "echo connection=192.168.0.1@tcp0::instance > .../import".
1354 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
1355 size_t count, loff_t *off)
1357 struct seq_file *m = file->private_data;
1358 struct obd_device *obd = m->private;
1359 struct obd_import *imp = obd->u.cli.cl_import;
1364 const char prefix[] = "connection=";
1365 const int prefix_len = sizeof(prefix) - 1;
1367 if (count > PAGE_SIZE - 1 || count <= prefix_len)
1370 OBD_ALLOC(kbuf, count + 1);
1374 if (copy_from_user(kbuf, buffer, count))
1375 GOTO(out, count = -EFAULT);
1379 /* only support connection=uuid::instance now */
1380 if (strncmp(prefix, kbuf, prefix_len) != 0)
1381 GOTO(out, count = -EINVAL);
1383 LPROCFS_CLIMP_CHECK(obd);
1385 uuid = kbuf + prefix_len;
1386 ptr = strstr(uuid, "::");
1393 ptr += 2; /* Skip :: */
1394 rc = kstrtouint(ptr, 10, &inst);
1396 CERROR("config: wrong instance # %s\n", ptr);
1397 } else if (inst != imp->imp_connect_data.ocd_instance) {
1398 CDEBUG(D_INFO, "IR: %s is connecting to an obsoleted "
1399 "target(%u/%u), reconnecting...\n",
1400 imp->imp_obd->obd_name,
1401 imp->imp_connect_data.ocd_instance, inst);
1404 CDEBUG(D_INFO, "IR: %s has already been connecting to "
1406 imp->imp_obd->obd_name, inst);
1410 LPROCFS_CLIMP_EXIT(obd);
1412 ptlrpc_recover_import(imp, uuid, 1);
1415 OBD_FREE(kbuf, count + 1);
1418 EXPORT_SYMBOL(lprocfs_import_seq_write);
1420 int lprocfs_pinger_recov_seq_show(struct seq_file *m, void *n)
1422 struct obd_device *obd = m->private;
1423 struct obd_import *imp = obd->u.cli.cl_import;
1425 LPROCFS_CLIMP_CHECK(obd);
1426 seq_printf(m, "%d\n", !imp->imp_no_pinger_recover);
1427 LPROCFS_CLIMP_EXIT(obd);
1430 EXPORT_SYMBOL(lprocfs_pinger_recov_seq_show);
1433 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
1434 size_t count, loff_t *off)
1436 struct seq_file *m = file->private_data;
1437 struct obd_device *obd = m->private;
1438 struct client_obd *cli = &obd->u.cli;
1439 struct obd_import *imp = cli->cl_import;
1443 rc = kstrtobool_from_user(buffer, count, &val);
1447 LPROCFS_CLIMP_CHECK(obd);
1448 spin_lock(&imp->imp_lock);
1449 imp->imp_no_pinger_recover = !val;
1450 spin_unlock(&imp->imp_lock);
1451 LPROCFS_CLIMP_EXIT(obd);
1454 EXPORT_SYMBOL(lprocfs_pinger_recov_seq_write);