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,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License version 2 for more details. A copy is
14 * included in the COPYING file that accompanied this code.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 * Copyright (C) 2013 DataDirect Networks, Inc.
25 * Copyright (c) 2014, Intel Corporation.
28 * lustre/ptlrpc/nrs_tbf.c
30 * Network Request Scheduler (NRS) Token Bucket Filter(TBF) policy
34 #ifdef HAVE_SERVER_SUPPORT
41 #define DEBUG_SUBSYSTEM S_RPC
42 #include <obd_support.h>
43 #include <obd_class.h>
44 #include <libcfs/libcfs.h>
45 #include "ptlrpc_internal.h"
50 * Token Bucket Filter over client NIDs
55 #define NRS_POL_NAME_TBF "tbf"
57 static int tbf_jobid_cache_size = 8192;
58 CFS_MODULE_PARM(tbf_jobid_cache_size, "i", int, 0644,
59 "The size of jobid cache");
61 static int tbf_rate = 10000;
62 CFS_MODULE_PARM(tbf_rate, "i", int, 0644,
63 "Default rate limit in RPCs/s");
65 static int tbf_depth = 3;
66 CFS_MODULE_PARM(tbf_depth, "i", int, 0644,
67 "How many tokens that a client can save up");
69 static enum hrtimer_restart nrs_tbf_timer_cb(struct hrtimer *timer)
71 struct nrs_tbf_head *head = container_of(timer, struct nrs_tbf_head,
73 struct ptlrpc_nrs *nrs = head->th_res.res_policy->pol_nrs;
74 struct ptlrpc_service_part *svcpt = nrs->nrs_svcpt;
76 spin_lock(&nrs->nrs_lock);
77 nrs->nrs_throttling = 0;
78 spin_unlock(&nrs->nrs_lock);
79 wake_up(&svcpt->scp_waitq);
81 return HRTIMER_NORESTART;
84 #define NRS_TBF_DEFAULT_RULE "default"
86 static void nrs_tbf_rule_fini(struct nrs_tbf_rule *rule)
88 LASSERT(atomic_read(&rule->tr_ref) == 0);
89 LASSERT(list_empty(&rule->tr_cli_list));
90 LASSERT(list_empty(&rule->tr_linkage));
92 rule->tr_head->th_ops->o_rule_fini(rule);
97 * Decreases the rule's usage reference count, and stops the rule in case it
98 * was already stopping and have no more outstanding usage references (which
99 * indicates it has no more queued or started requests, and can be safely
102 static void nrs_tbf_rule_put(struct nrs_tbf_rule *rule)
104 if (atomic_dec_and_test(&rule->tr_ref))
105 nrs_tbf_rule_fini(rule);
109 * Increases the rule's usage reference count.
111 static inline void nrs_tbf_rule_get(struct nrs_tbf_rule *rule)
113 atomic_inc(&rule->tr_ref);
117 nrs_tbf_cli_rule_put(struct nrs_tbf_client *cli)
119 LASSERT(!list_empty(&cli->tc_linkage));
120 LASSERT(cli->tc_rule);
121 list_del_init(&cli->tc_linkage);
122 nrs_tbf_rule_put(cli->tc_rule);
127 nrs_tbf_cli_reset_value(struct nrs_tbf_head *head,
128 struct nrs_tbf_client *cli)
131 struct nrs_tbf_rule *rule = cli->tc_rule;
133 cli->tc_rpc_rate = rule->tr_rpc_rate;
134 cli->tc_nsecs = rule->tr_nsecs;
135 cli->tc_depth = rule->tr_depth;
136 cli->tc_ntoken = rule->tr_depth;
137 cli->tc_check_time = ktime_to_ns(ktime_get());
138 cli->tc_rule_sequence = atomic_read(&head->th_rule_sequence);
139 cli->tc_rule_generation = rule->tr_generation;
142 cfs_binheap_relocate(head->th_binheap,
147 nrs_tbf_cli_reset(struct nrs_tbf_head *head,
148 struct nrs_tbf_rule *rule,
149 struct nrs_tbf_client *cli)
151 if (!list_empty(&cli->tc_linkage)) {
152 LASSERT(rule != cli->tc_rule);
153 nrs_tbf_cli_rule_put(cli);
155 LASSERT(cli->tc_rule == NULL);
156 LASSERT(list_empty(&cli->tc_linkage));
157 /* Rule's ref is added before called */
159 list_add_tail(&cli->tc_linkage, &rule->tr_cli_list);
160 nrs_tbf_cli_reset_value(head, cli);
164 nrs_tbf_rule_dump(struct nrs_tbf_rule *rule, struct seq_file *m)
166 return rule->tr_head->th_ops->o_rule_dump(rule, m);
170 nrs_tbf_rule_dump_all(struct nrs_tbf_head *head, struct seq_file *m)
172 struct nrs_tbf_rule *rule;
175 LASSERT(head != NULL);
176 spin_lock(&head->th_rule_lock);
177 /* List the rules from newest to oldest */
178 list_for_each_entry(rule, &head->th_list, tr_linkage) {
179 LASSERT((rule->tr_flags & NTRS_STOPPING) == 0);
180 rc = nrs_tbf_rule_dump(rule, m);
186 spin_unlock(&head->th_rule_lock);
191 static struct nrs_tbf_rule *
192 nrs_tbf_rule_find_nolock(struct nrs_tbf_head *head,
195 struct nrs_tbf_rule *rule;
197 LASSERT(head != NULL);
198 list_for_each_entry(rule, &head->th_list, tr_linkage) {
199 LASSERT((rule->tr_flags & NTRS_STOPPING) == 0);
200 if (strcmp(rule->tr_name, name) == 0) {
201 nrs_tbf_rule_get(rule);
208 static struct nrs_tbf_rule *
209 nrs_tbf_rule_find(struct nrs_tbf_head *head,
212 struct nrs_tbf_rule *rule;
214 LASSERT(head != NULL);
215 spin_lock(&head->th_rule_lock);
216 rule = nrs_tbf_rule_find_nolock(head, name);
217 spin_unlock(&head->th_rule_lock);
221 static struct nrs_tbf_rule *
222 nrs_tbf_rule_match(struct nrs_tbf_head *head,
223 struct nrs_tbf_client *cli)
225 struct nrs_tbf_rule *rule = NULL;
226 struct nrs_tbf_rule *tmp_rule;
228 spin_lock(&head->th_rule_lock);
229 /* Match the newest rule in the list */
230 list_for_each_entry(tmp_rule, &head->th_list, tr_linkage) {
231 LASSERT((tmp_rule->tr_flags & NTRS_STOPPING) == 0);
232 if (head->th_ops->o_rule_match(tmp_rule, cli)) {
239 rule = head->th_rule;
241 nrs_tbf_rule_get(rule);
242 spin_unlock(&head->th_rule_lock);
247 nrs_tbf_cli_init(struct nrs_tbf_head *head,
248 struct nrs_tbf_client *cli,
249 struct ptlrpc_request *req)
251 struct nrs_tbf_rule *rule;
253 cli->tc_in_heap = false;
254 head->th_ops->o_cli_init(cli, req);
255 INIT_LIST_HEAD(&cli->tc_list);
256 INIT_LIST_HEAD(&cli->tc_linkage);
257 atomic_set(&cli->tc_ref, 1);
258 rule = nrs_tbf_rule_match(head, cli);
259 nrs_tbf_cli_reset(head, rule, cli);
263 nrs_tbf_cli_fini(struct nrs_tbf_client *cli)
265 LASSERT(list_empty(&cli->tc_list));
266 LASSERT(!cli->tc_in_heap);
267 LASSERT(atomic_read(&cli->tc_ref) == 0);
268 nrs_tbf_cli_rule_put(cli);
273 nrs_tbf_rule_start(struct ptlrpc_nrs_policy *policy,
274 struct nrs_tbf_head *head,
275 struct nrs_tbf_cmd *start)
277 struct nrs_tbf_rule *rule, *tmp_rule;
280 rule = nrs_tbf_rule_find(head, start->tc_name);
282 nrs_tbf_rule_put(rule);
286 OBD_CPT_ALLOC_PTR(rule, nrs_pol2cptab(policy), nrs_pol2cptid(policy));
290 memcpy(rule->tr_name, start->tc_name, strlen(start->tc_name));
291 rule->tr_rpc_rate = start->tc_rpc_rate;
292 rule->tr_nsecs = NSEC_PER_SEC / rule->tr_rpc_rate;
293 rule->tr_depth = tbf_depth;
294 atomic_set(&rule->tr_ref, 1);
295 INIT_LIST_HEAD(&rule->tr_cli_list);
296 INIT_LIST_HEAD(&rule->tr_nids);
298 rc = head->th_ops->o_rule_init(policy, rule, start);
304 /* Add as the newest rule */
305 spin_lock(&head->th_rule_lock);
306 tmp_rule = nrs_tbf_rule_find_nolock(head, start->tc_name);
308 spin_unlock(&head->th_rule_lock);
309 nrs_tbf_rule_put(tmp_rule);
310 nrs_tbf_rule_put(rule);
313 list_add(&rule->tr_linkage, &head->th_list);
314 rule->tr_head = head;
315 spin_unlock(&head->th_rule_lock);
316 atomic_inc(&head->th_rule_sequence);
317 if (start->tc_rule_flags & NTRS_DEFAULT) {
318 rule->tr_flags |= NTRS_DEFAULT;
319 LASSERT(head->th_rule == NULL);
320 head->th_rule = rule;
327 nrs_tbf_rule_change(struct ptlrpc_nrs_policy *policy,
328 struct nrs_tbf_head *head,
329 struct nrs_tbf_cmd *change)
331 struct nrs_tbf_rule *rule;
333 assert_spin_locked(&policy->pol_nrs->nrs_lock);
335 rule = nrs_tbf_rule_find(head, change->tc_name);
339 rule->tr_rpc_rate = change->tc_rpc_rate;
340 rule->tr_nsecs = NSEC_PER_SEC / rule->tr_rpc_rate;
341 rule->tr_generation++;
342 nrs_tbf_rule_put(rule);
348 nrs_tbf_rule_stop(struct ptlrpc_nrs_policy *policy,
349 struct nrs_tbf_head *head,
350 struct nrs_tbf_cmd *stop)
352 struct nrs_tbf_rule *rule;
354 assert_spin_locked(&policy->pol_nrs->nrs_lock);
356 if (strcmp(stop->tc_name, NRS_TBF_DEFAULT_RULE) == 0)
359 rule = nrs_tbf_rule_find(head, stop->tc_name);
363 list_del_init(&rule->tr_linkage);
364 rule->tr_flags |= NTRS_STOPPING;
365 nrs_tbf_rule_put(rule);
366 nrs_tbf_rule_put(rule);
372 nrs_tbf_command(struct ptlrpc_nrs_policy *policy,
373 struct nrs_tbf_head *head,
374 struct nrs_tbf_cmd *cmd)
378 assert_spin_locked(&policy->pol_nrs->nrs_lock);
380 switch (cmd->tc_cmd) {
381 case NRS_CTL_TBF_START_RULE:
382 if (!(cmd->tc_valid_types & head->th_type_flag))
385 spin_unlock(&policy->pol_nrs->nrs_lock);
386 rc = nrs_tbf_rule_start(policy, head, cmd);
387 spin_lock(&policy->pol_nrs->nrs_lock);
389 case NRS_CTL_TBF_CHANGE_RATE:
390 rc = nrs_tbf_rule_change(policy, head, cmd);
392 case NRS_CTL_TBF_STOP_RULE:
393 rc = nrs_tbf_rule_stop(policy, head, cmd);
394 /* Take it as a success, if not exists at all */
395 return rc == -ENOENT ? 0 : rc;
402 * Binary heap predicate.
404 * \param[in] e1 the first binheap node to compare
405 * \param[in] e2 the second binheap node to compare
410 static int tbf_cli_compare(cfs_binheap_node_t *e1, cfs_binheap_node_t *e2)
412 struct nrs_tbf_client *cli1;
413 struct nrs_tbf_client *cli2;
415 cli1 = container_of(e1, struct nrs_tbf_client, tc_node);
416 cli2 = container_of(e2, struct nrs_tbf_client, tc_node);
418 if (cli1->tc_check_time + cli1->tc_nsecs <
419 cli2->tc_check_time + cli2->tc_nsecs)
421 else if (cli1->tc_check_time + cli1->tc_nsecs >
422 cli2->tc_check_time + cli2->tc_nsecs)
425 if (cli1->tc_check_time < cli2->tc_check_time)
427 else if (cli1->tc_check_time > cli2->tc_check_time)
430 /* Maybe need more comparasion, e.g. request number in the rules */
435 * TBF binary heap operations
437 static cfs_binheap_ops_t nrs_tbf_heap_ops = {
440 .hop_compare = tbf_cli_compare,
443 static unsigned nrs_tbf_jobid_hop_hash(struct cfs_hash *hs, const void *key,
446 return cfs_hash_djb2_hash(key, strlen(key), mask);
449 static int nrs_tbf_jobid_hop_keycmp(const void *key, struct hlist_node *hnode)
451 struct nrs_tbf_client *cli = hlist_entry(hnode,
452 struct nrs_tbf_client,
455 return (strcmp(cli->tc_jobid, key) == 0);
458 static void *nrs_tbf_jobid_hop_key(struct hlist_node *hnode)
460 struct nrs_tbf_client *cli = hlist_entry(hnode,
461 struct nrs_tbf_client,
464 return cli->tc_jobid;
467 static void *nrs_tbf_jobid_hop_object(struct hlist_node *hnode)
469 return hlist_entry(hnode, struct nrs_tbf_client, tc_hnode);
472 static void nrs_tbf_jobid_hop_get(struct cfs_hash *hs, struct hlist_node *hnode)
474 struct nrs_tbf_client *cli = hlist_entry(hnode,
475 struct nrs_tbf_client,
478 atomic_inc(&cli->tc_ref);
481 static void nrs_tbf_jobid_hop_put(struct cfs_hash *hs, struct hlist_node *hnode)
483 struct nrs_tbf_client *cli = hlist_entry(hnode,
484 struct nrs_tbf_client,
487 atomic_dec(&cli->tc_ref);
491 nrs_tbf_jobid_hop_exit(struct cfs_hash *hs, struct hlist_node *hnode)
494 struct nrs_tbf_client *cli = hlist_entry(hnode,
495 struct nrs_tbf_client,
498 LASSERT(atomic_read(&cli->tc_ref) == 0);
499 nrs_tbf_cli_fini(cli);
502 static struct cfs_hash_ops nrs_tbf_jobid_hash_ops = {
503 .hs_hash = nrs_tbf_jobid_hop_hash,
504 .hs_keycmp = nrs_tbf_jobid_hop_keycmp,
505 .hs_key = nrs_tbf_jobid_hop_key,
506 .hs_object = nrs_tbf_jobid_hop_object,
507 .hs_get = nrs_tbf_jobid_hop_get,
508 .hs_put = nrs_tbf_jobid_hop_put,
509 .hs_put_locked = nrs_tbf_jobid_hop_put,
510 .hs_exit = nrs_tbf_jobid_hop_exit,
513 #define NRS_TBF_JOBID_HASH_FLAGS (CFS_HASH_SPIN_BKTLOCK | \
514 CFS_HASH_NO_ITEMREF | \
517 static struct nrs_tbf_client *
518 nrs_tbf_jobid_hash_lookup(struct cfs_hash *hs,
519 struct cfs_hash_bd *bd,
522 struct hlist_node *hnode;
523 struct nrs_tbf_client *cli;
525 /* cfs_hash_bd_peek_locked is a somehow "internal" function
526 * of cfs_hash, it doesn't add refcount on object. */
527 hnode = cfs_hash_bd_peek_locked(hs, bd, (void *)jobid);
531 cfs_hash_get(hs, hnode);
532 cli = container_of0(hnode, struct nrs_tbf_client, tc_hnode);
533 if (!list_empty(&cli->tc_lru))
534 list_del_init(&cli->tc_lru);
538 #define NRS_TBF_JOBID_NULL ""
540 static struct nrs_tbf_client *
541 nrs_tbf_jobid_cli_find(struct nrs_tbf_head *head,
542 struct ptlrpc_request *req)
545 struct nrs_tbf_client *cli;
546 struct cfs_hash *hs = head->th_cli_hash;
547 struct cfs_hash_bd bd;
549 jobid = lustre_msg_get_jobid(req->rq_reqmsg);
551 jobid = NRS_TBF_JOBID_NULL;
552 cfs_hash_bd_get_and_lock(hs, (void *)jobid, &bd, 1);
553 cli = nrs_tbf_jobid_hash_lookup(hs, &bd, jobid);
554 cfs_hash_bd_unlock(hs, &bd, 1);
559 static struct nrs_tbf_client *
560 nrs_tbf_jobid_cli_findadd(struct nrs_tbf_head *head,
561 struct nrs_tbf_client *cli)
564 struct nrs_tbf_client *ret;
565 struct cfs_hash *hs = head->th_cli_hash;
566 struct cfs_hash_bd bd;
568 jobid = cli->tc_jobid;
569 cfs_hash_bd_get_and_lock(hs, (void *)jobid, &bd, 1);
570 ret = nrs_tbf_jobid_hash_lookup(hs, &bd, jobid);
572 cfs_hash_bd_add_locked(hs, &bd, &cli->tc_hnode);
575 cfs_hash_bd_unlock(hs, &bd, 1);
581 nrs_tbf_jobid_cli_put(struct nrs_tbf_head *head,
582 struct nrs_tbf_client *cli)
584 struct cfs_hash_bd bd;
585 struct cfs_hash *hs = head->th_cli_hash;
586 struct nrs_tbf_bucket *bkt;
588 struct list_head zombies;
590 INIT_LIST_HEAD(&zombies);
591 cfs_hash_bd_get(hs, &cli->tc_jobid, &bd);
592 bkt = cfs_hash_bd_extra_get(hs, &bd);
593 if (!cfs_hash_bd_dec_and_lock(hs, &bd, &cli->tc_ref))
595 LASSERT(list_empty(&cli->tc_lru));
596 list_add_tail(&cli->tc_lru, &bkt->ntb_lru);
599 * Check and purge the LRU, there is at least one client in the LRU.
601 hw = tbf_jobid_cache_size >>
602 (hs->hs_cur_bits - hs->hs_bkt_bits);
603 while (cfs_hash_bd_count_get(&bd) > hw) {
604 if (unlikely(list_empty(&bkt->ntb_lru)))
606 cli = list_entry(bkt->ntb_lru.next,
607 struct nrs_tbf_client,
609 LASSERT(atomic_read(&cli->tc_ref) == 0);
610 cfs_hash_bd_del_locked(hs, &bd, &cli->tc_hnode);
611 list_move(&cli->tc_lru, &zombies);
613 cfs_hash_bd_unlock(head->th_cli_hash, &bd, 1);
615 while (!list_empty(&zombies)) {
616 cli = container_of0(zombies.next,
617 struct nrs_tbf_client, tc_lru);
618 list_del_init(&cli->tc_lru);
619 nrs_tbf_cli_fini(cli);
624 nrs_tbf_jobid_cli_init(struct nrs_tbf_client *cli,
625 struct ptlrpc_request *req)
627 char *jobid = lustre_msg_get_jobid(req->rq_reqmsg);
630 jobid = NRS_TBF_JOBID_NULL;
631 LASSERT(strlen(jobid) < LUSTRE_JOBID_SIZE);
632 INIT_LIST_HEAD(&cli->tc_lru);
633 memcpy(cli->tc_jobid, jobid, strlen(jobid));
636 static int nrs_tbf_jobid_hash_order(void)
640 for (bits = 1; (1 << bits) < tbf_jobid_cache_size; ++bits)
646 #define NRS_TBF_JOBID_BKT_BITS 10
649 nrs_tbf_jobid_startup(struct ptlrpc_nrs_policy *policy,
650 struct nrs_tbf_head *head)
652 struct nrs_tbf_cmd start;
653 struct nrs_tbf_bucket *bkt;
657 struct cfs_hash_bd bd;
659 bits = nrs_tbf_jobid_hash_order();
660 if (bits < NRS_TBF_JOBID_BKT_BITS)
661 bits = NRS_TBF_JOBID_BKT_BITS;
662 head->th_cli_hash = cfs_hash_create("nrs_tbf_hash",
665 NRS_TBF_JOBID_BKT_BITS,
669 &nrs_tbf_jobid_hash_ops,
670 NRS_TBF_JOBID_HASH_FLAGS);
671 if (head->th_cli_hash == NULL)
674 cfs_hash_for_each_bucket(head->th_cli_hash, &bd, i) {
675 bkt = cfs_hash_bd_extra_get(head->th_cli_hash, &bd);
676 INIT_LIST_HEAD(&bkt->ntb_lru);
679 memset(&start, 0, sizeof(start));
680 start.tc_jobids_str = "*";
682 start.tc_rpc_rate = tbf_rate;
683 start.tc_rule_flags = NTRS_DEFAULT;
684 start.tc_name = NRS_TBF_DEFAULT_RULE;
685 INIT_LIST_HEAD(&start.tc_jobids);
686 rc = nrs_tbf_rule_start(policy, head, &start);
692 * Frees jobid of \a list.
696 nrs_tbf_jobid_list_free(struct list_head *jobid_list)
698 struct nrs_tbf_jobid *jobid, *n;
700 list_for_each_entry_safe(jobid, n, jobid_list, tj_linkage) {
701 OBD_FREE(jobid->tj_id, strlen(jobid->tj_id) + 1);
702 list_del(&jobid->tj_linkage);
703 OBD_FREE(jobid, sizeof(struct nrs_tbf_jobid));
708 nrs_tbf_jobid_list_add(const struct cfs_lstr *id, struct list_head *jobid_list)
710 struct nrs_tbf_jobid *jobid;
712 OBD_ALLOC(jobid, sizeof(struct nrs_tbf_jobid));
716 OBD_ALLOC(jobid->tj_id, id->ls_len + 1);
717 if (jobid->tj_id == NULL) {
718 OBD_FREE(jobid, sizeof(struct nrs_tbf_jobid));
722 memcpy(jobid->tj_id, id->ls_str, id->ls_len);
723 list_add_tail(&jobid->tj_linkage, jobid_list);
728 nrs_tbf_jobid_list_match(struct list_head *jobid_list, char *id)
730 struct nrs_tbf_jobid *jobid;
732 list_for_each_entry(jobid, jobid_list, tj_linkage) {
733 if (strcmp(id, jobid->tj_id) == 0)
740 nrs_tbf_jobid_list_parse(char *str, int len, struct list_head *jobid_list)
749 INIT_LIST_HEAD(jobid_list);
751 rc = cfs_gettok(&src, ' ', &res);
756 rc = nrs_tbf_jobid_list_add(&res, jobid_list);
761 nrs_tbf_jobid_list_free(jobid_list);
765 static void nrs_tbf_jobid_cmd_fini(struct nrs_tbf_cmd *cmd)
767 if (!list_empty(&cmd->tc_jobids))
768 nrs_tbf_jobid_list_free(&cmd->tc_jobids);
769 if (cmd->tc_jobids_str)
770 OBD_FREE(cmd->tc_jobids_str, strlen(cmd->tc_jobids_str) + 1);
773 static int nrs_tbf_jobid_parse(struct nrs_tbf_cmd *cmd, const char *id)
777 OBD_ALLOC(cmd->tc_jobids_str, strlen(id) + 1);
778 if (cmd->tc_jobids_str == NULL)
781 memcpy(cmd->tc_jobids_str, id, strlen(id));
783 /* parse jobid list */
784 rc = nrs_tbf_jobid_list_parse(cmd->tc_jobids_str,
785 strlen(cmd->tc_jobids_str),
788 nrs_tbf_jobid_cmd_fini(cmd);
793 static int nrs_tbf_jobid_rule_init(struct ptlrpc_nrs_policy *policy,
794 struct nrs_tbf_rule *rule,
795 struct nrs_tbf_cmd *start)
799 LASSERT(start->tc_jobids_str);
800 OBD_ALLOC(rule->tr_jobids_str,
801 strlen(start->tc_jobids_str) + 1);
802 if (rule->tr_jobids_str == NULL)
805 memcpy(rule->tr_jobids_str,
806 start->tc_jobids_str,
807 strlen(start->tc_jobids_str));
809 INIT_LIST_HEAD(&rule->tr_jobids);
810 if (!list_empty(&start->tc_jobids)) {
811 rc = nrs_tbf_jobid_list_parse(rule->tr_jobids_str,
812 strlen(rule->tr_jobids_str),
815 CERROR("jobids {%s} illegal\n", rule->tr_jobids_str);
818 OBD_FREE(rule->tr_jobids_str,
819 strlen(start->tc_jobids_str) + 1);
824 nrs_tbf_jobid_rule_dump(struct nrs_tbf_rule *rule, struct seq_file *m)
826 return seq_printf(m, "%s {%s} %llu, ref %d\n", rule->tr_name,
827 rule->tr_jobids_str, rule->tr_rpc_rate,
828 atomic_read(&rule->tr_ref) - 1);
832 nrs_tbf_jobid_rule_match(struct nrs_tbf_rule *rule,
833 struct nrs_tbf_client *cli)
835 return nrs_tbf_jobid_list_match(&rule->tr_jobids, cli->tc_jobid);
838 static void nrs_tbf_jobid_rule_fini(struct nrs_tbf_rule *rule)
840 if (!list_empty(&rule->tr_jobids))
841 nrs_tbf_jobid_list_free(&rule->tr_jobids);
842 LASSERT(rule->tr_jobids_str != NULL);
843 OBD_FREE(rule->tr_jobids_str, strlen(rule->tr_jobids_str) + 1);
846 static struct nrs_tbf_ops nrs_tbf_jobid_ops = {
847 .o_name = NRS_TBF_TYPE_JOBID,
848 .o_startup = nrs_tbf_jobid_startup,
849 .o_cli_find = nrs_tbf_jobid_cli_find,
850 .o_cli_findadd = nrs_tbf_jobid_cli_findadd,
851 .o_cli_put = nrs_tbf_jobid_cli_put,
852 .o_cli_init = nrs_tbf_jobid_cli_init,
853 .o_rule_init = nrs_tbf_jobid_rule_init,
854 .o_rule_dump = nrs_tbf_jobid_rule_dump,
855 .o_rule_match = nrs_tbf_jobid_rule_match,
856 .o_rule_fini = nrs_tbf_jobid_rule_fini,
860 * libcfs_hash operations for nrs_tbf_net::cn_cli_hash
862 * This uses ptlrpc_request::rq_peer.nid as its key, in order to hash
863 * nrs_tbf_client objects.
865 #define NRS_TBF_NID_BKT_BITS 8
866 #define NRS_TBF_NID_BITS 16
868 static unsigned nrs_tbf_nid_hop_hash(struct cfs_hash *hs, const void *key,
871 return cfs_hash_djb2_hash(key, sizeof(lnet_nid_t), mask);
874 static int nrs_tbf_nid_hop_keycmp(const void *key, struct hlist_node *hnode)
876 lnet_nid_t *nid = (lnet_nid_t *)key;
877 struct nrs_tbf_client *cli = hlist_entry(hnode,
878 struct nrs_tbf_client,
881 return *nid == cli->tc_nid;
884 static void *nrs_tbf_nid_hop_key(struct hlist_node *hnode)
886 struct nrs_tbf_client *cli = hlist_entry(hnode,
887 struct nrs_tbf_client,
893 static void *nrs_tbf_nid_hop_object(struct hlist_node *hnode)
895 return hlist_entry(hnode, struct nrs_tbf_client, tc_hnode);
898 static void nrs_tbf_nid_hop_get(struct cfs_hash *hs, struct hlist_node *hnode)
900 struct nrs_tbf_client *cli = hlist_entry(hnode,
901 struct nrs_tbf_client,
904 atomic_inc(&cli->tc_ref);
907 static void nrs_tbf_nid_hop_put(struct cfs_hash *hs, struct hlist_node *hnode)
909 struct nrs_tbf_client *cli = hlist_entry(hnode,
910 struct nrs_tbf_client,
913 atomic_dec(&cli->tc_ref);
916 static void nrs_tbf_nid_hop_exit(struct cfs_hash *hs, struct hlist_node *hnode)
918 struct nrs_tbf_client *cli = hlist_entry(hnode,
919 struct nrs_tbf_client,
922 LASSERTF(atomic_read(&cli->tc_ref) == 0,
923 "Busy TBF object from client with NID %s, with %d refs\n",
924 libcfs_nid2str(cli->tc_nid), atomic_read(&cli->tc_ref));
926 nrs_tbf_cli_fini(cli);
929 static struct cfs_hash_ops nrs_tbf_nid_hash_ops = {
930 .hs_hash = nrs_tbf_nid_hop_hash,
931 .hs_keycmp = nrs_tbf_nid_hop_keycmp,
932 .hs_key = nrs_tbf_nid_hop_key,
933 .hs_object = nrs_tbf_nid_hop_object,
934 .hs_get = nrs_tbf_nid_hop_get,
935 .hs_put = nrs_tbf_nid_hop_put,
936 .hs_put_locked = nrs_tbf_nid_hop_put,
937 .hs_exit = nrs_tbf_nid_hop_exit,
940 static struct nrs_tbf_client *
941 nrs_tbf_nid_cli_find(struct nrs_tbf_head *head,
942 struct ptlrpc_request *req)
944 return cfs_hash_lookup(head->th_cli_hash, &req->rq_peer.nid);
947 static struct nrs_tbf_client *
948 nrs_tbf_nid_cli_findadd(struct nrs_tbf_head *head,
949 struct nrs_tbf_client *cli)
951 return cfs_hash_findadd_unique(head->th_cli_hash, &cli->tc_nid,
956 nrs_tbf_nid_cli_put(struct nrs_tbf_head *head,
957 struct nrs_tbf_client *cli)
959 cfs_hash_put(head->th_cli_hash, &cli->tc_hnode);
963 nrs_tbf_nid_startup(struct ptlrpc_nrs_policy *policy,
964 struct nrs_tbf_head *head)
966 struct nrs_tbf_cmd start;
969 head->th_cli_hash = cfs_hash_create("nrs_tbf_hash",
972 NRS_TBF_NID_BKT_BITS, 0,
975 &nrs_tbf_nid_hash_ops,
976 CFS_HASH_RW_BKTLOCK);
977 if (head->th_cli_hash == NULL)
980 memset(&start, 0, sizeof(start));
981 start.tc_nids_str = "*";
983 start.tc_rpc_rate = tbf_rate;
984 start.tc_rule_flags = NTRS_DEFAULT;
985 start.tc_name = NRS_TBF_DEFAULT_RULE;
986 INIT_LIST_HEAD(&start.tc_nids);
987 rc = nrs_tbf_rule_start(policy, head, &start);
993 nrs_tbf_nid_cli_init(struct nrs_tbf_client *cli,
994 struct ptlrpc_request *req)
996 cli->tc_nid = req->rq_peer.nid;
999 static int nrs_tbf_nid_rule_init(struct ptlrpc_nrs_policy *policy,
1000 struct nrs_tbf_rule *rule,
1001 struct nrs_tbf_cmd *start)
1003 LASSERT(start->tc_nids_str);
1004 OBD_ALLOC(rule->tr_nids_str,
1005 strlen(start->tc_nids_str) + 1);
1006 if (rule->tr_nids_str == NULL)
1009 memcpy(rule->tr_nids_str,
1011 strlen(start->tc_nids_str));
1013 INIT_LIST_HEAD(&rule->tr_nids);
1014 if (!list_empty(&start->tc_nids)) {
1015 if (cfs_parse_nidlist(rule->tr_nids_str,
1016 strlen(rule->tr_nids_str),
1017 &rule->tr_nids) <= 0) {
1018 CERROR("nids {%s} illegal\n",
1020 OBD_FREE(rule->tr_nids_str,
1021 strlen(start->tc_nids_str) + 1);
1029 nrs_tbf_nid_rule_dump(struct nrs_tbf_rule *rule, struct seq_file *m)
1031 return seq_printf(m, "%s {%s} %llu, ref %d\n", rule->tr_name,
1032 rule->tr_nids_str, rule->tr_rpc_rate,
1033 atomic_read(&rule->tr_ref) - 1);
1037 nrs_tbf_nid_rule_match(struct nrs_tbf_rule *rule,
1038 struct nrs_tbf_client *cli)
1040 return cfs_match_nid(cli->tc_nid, &rule->tr_nids);
1043 static void nrs_tbf_nid_rule_fini(struct nrs_tbf_rule *rule)
1045 if (!list_empty(&rule->tr_nids))
1046 cfs_free_nidlist(&rule->tr_nids);
1047 LASSERT(rule->tr_nids_str != NULL);
1048 OBD_FREE(rule->tr_nids_str, strlen(rule->tr_nids_str) + 1);
1051 static void nrs_tbf_nid_cmd_fini(struct nrs_tbf_cmd *cmd)
1053 if (!list_empty(&cmd->tc_nids))
1054 cfs_free_nidlist(&cmd->tc_nids);
1055 if (cmd->tc_nids_str)
1056 OBD_FREE(cmd->tc_nids_str, strlen(cmd->tc_nids_str) + 1);
1059 static int nrs_tbf_nid_parse(struct nrs_tbf_cmd *cmd, const char *id)
1061 OBD_ALLOC(cmd->tc_nids_str, strlen(id) + 1);
1062 if (cmd->tc_nids_str == NULL)
1065 memcpy(cmd->tc_nids_str, id, strlen(id));
1067 /* parse NID list */
1068 if (cfs_parse_nidlist(cmd->tc_nids_str,
1069 strlen(cmd->tc_nids_str),
1070 &cmd->tc_nids) <= 0) {
1071 nrs_tbf_nid_cmd_fini(cmd);
1078 static struct nrs_tbf_ops nrs_tbf_nid_ops = {
1079 .o_name = NRS_TBF_TYPE_NID,
1080 .o_startup = nrs_tbf_nid_startup,
1081 .o_cli_find = nrs_tbf_nid_cli_find,
1082 .o_cli_findadd = nrs_tbf_nid_cli_findadd,
1083 .o_cli_put = nrs_tbf_nid_cli_put,
1084 .o_cli_init = nrs_tbf_nid_cli_init,
1085 .o_rule_init = nrs_tbf_nid_rule_init,
1086 .o_rule_dump = nrs_tbf_nid_rule_dump,
1087 .o_rule_match = nrs_tbf_nid_rule_match,
1088 .o_rule_fini = nrs_tbf_nid_rule_fini,
1092 * Is called before the policy transitions into
1093 * ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED; allocates and initializes a
1094 * policy-specific private data structure.
1096 * \param[in] policy The policy to start
1098 * \retval -ENOMEM OOM error
1101 * \see nrs_policy_register()
1102 * \see nrs_policy_ctl()
1104 static int nrs_tbf_start(struct ptlrpc_nrs_policy *policy, char *arg)
1106 struct nrs_tbf_head *head;
1107 struct nrs_tbf_ops *ops;
1111 if (arg == NULL || strlen(arg) > NRS_TBF_TYPE_MAX_LEN)
1112 GOTO(out, rc = -EINVAL);
1114 if (strcmp(arg, NRS_TBF_TYPE_NID) == 0) {
1115 ops = &nrs_tbf_nid_ops;
1116 type = NRS_TBF_FLAG_NID;
1117 } else if (strcmp(arg, NRS_TBF_TYPE_JOBID) == 0) {
1118 ops = &nrs_tbf_jobid_ops;
1119 type = NRS_TBF_FLAG_JOBID;
1121 GOTO(out, rc = -ENOTSUPP);
1123 OBD_CPT_ALLOC_PTR(head, nrs_pol2cptab(policy), nrs_pol2cptid(policy));
1125 GOTO(out, rc = -ENOMEM);
1127 memcpy(head->th_type, arg, strlen(arg));
1128 head->th_type[strlen(arg)] = '\0';
1130 head->th_type_flag = type;
1132 head->th_binheap = cfs_binheap_create(&nrs_tbf_heap_ops,
1133 CBH_FLAG_ATOMIC_GROW, 4096, NULL,
1134 nrs_pol2cptab(policy),
1135 nrs_pol2cptid(policy));
1136 if (head->th_binheap == NULL)
1137 GOTO(out_free_head, rc = -ENOMEM);
1139 atomic_set(&head->th_rule_sequence, 0);
1140 spin_lock_init(&head->th_rule_lock);
1141 INIT_LIST_HEAD(&head->th_list);
1142 hrtimer_init(&head->th_timer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
1143 head->th_timer.function = nrs_tbf_timer_cb;
1144 rc = head->th_ops->o_startup(policy, head);
1146 GOTO(out_free_heap, rc);
1148 policy->pol_private = head;
1151 cfs_binheap_destroy(head->th_binheap);
1159 * Is called before the policy transitions into
1160 * ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPED; deallocates the policy-specific
1161 * private data structure.
1163 * \param[in] policy The policy to stop
1165 * \see nrs_policy_stop0()
1167 static void nrs_tbf_stop(struct ptlrpc_nrs_policy *policy)
1169 struct nrs_tbf_head *head = policy->pol_private;
1170 struct ptlrpc_nrs *nrs = policy->pol_nrs;
1171 struct nrs_tbf_rule *rule, *n;
1173 LASSERT(head != NULL);
1174 LASSERT(head->th_cli_hash != NULL);
1175 hrtimer_cancel(&head->th_timer);
1176 /* Should cleanup hash first before free rules */
1177 cfs_hash_putref(head->th_cli_hash);
1178 list_for_each_entry_safe(rule, n, &head->th_list, tr_linkage) {
1179 list_del_init(&rule->tr_linkage);
1180 nrs_tbf_rule_put(rule);
1182 LASSERT(list_empty(&head->th_list));
1183 LASSERT(head->th_binheap != NULL);
1184 LASSERT(cfs_binheap_is_empty(head->th_binheap));
1185 cfs_binheap_destroy(head->th_binheap);
1187 spin_lock(&nrs->nrs_lock);
1188 nrs->nrs_throttling = 0;
1189 spin_unlock(&nrs->nrs_lock);
1190 wake_up(&policy->pol_nrs->nrs_svcpt->scp_waitq);
1194 * Performs a policy-specific ctl function on TBF policy instances; similar
1197 * \param[in] policy the policy instance
1198 * \param[in] opc the opcode
1199 * \param[in,out] arg used for passing parameters and information
1201 * \pre assert_spin_locked(&policy->pol_nrs->->nrs_lock)
1202 * \post assert_spin_locked(&policy->pol_nrs->->nrs_lock)
1204 * \retval 0 operation carried out successfully
1207 static int nrs_tbf_ctl(struct ptlrpc_nrs_policy *policy,
1208 enum ptlrpc_nrs_ctl opc,
1214 assert_spin_locked(&policy->pol_nrs->nrs_lock);
1216 switch ((enum nrs_ctl_tbf)opc) {
1221 * Read RPC rate size of a policy instance.
1223 case NRS_CTL_TBF_RD_RULE: {
1224 struct nrs_tbf_head *head = policy->pol_private;
1225 struct seq_file *m = (struct seq_file *) arg;
1226 struct ptlrpc_service_part *svcpt;
1228 svcpt = policy->pol_nrs->nrs_svcpt;
1229 seq_printf(m, "CPT %d:\n", svcpt->scp_cpt);
1231 rc = nrs_tbf_rule_dump_all(head, m);
1236 * Write RPC rate of a policy instance.
1238 case NRS_CTL_TBF_WR_RULE: {
1239 struct nrs_tbf_head *head = policy->pol_private;
1240 struct nrs_tbf_cmd *cmd;
1242 cmd = (struct nrs_tbf_cmd *)arg;
1243 rc = nrs_tbf_command(policy,
1254 * Is called for obtaining a TBF policy resource.
1256 * \param[in] policy The policy on which the request is being asked for
1257 * \param[in] nrq The request for which resources are being taken
1258 * \param[in] parent Parent resource, unused in this policy
1259 * \param[out] resp Resources references are placed in this array
1260 * \param[in] moving_req Signifies limited caller context; unused in this
1264 * \see nrs_resource_get_safe()
1266 static int nrs_tbf_res_get(struct ptlrpc_nrs_policy *policy,
1267 struct ptlrpc_nrs_request *nrq,
1268 const struct ptlrpc_nrs_resource *parent,
1269 struct ptlrpc_nrs_resource **resp,
1272 struct nrs_tbf_head *head;
1273 struct nrs_tbf_client *cli;
1274 struct nrs_tbf_client *tmp;
1275 struct ptlrpc_request *req;
1277 if (parent == NULL) {
1278 *resp = &((struct nrs_tbf_head *)policy->pol_private)->th_res;
1282 head = container_of(parent, struct nrs_tbf_head, th_res);
1283 req = container_of(nrq, struct ptlrpc_request, rq_nrq);
1284 cli = head->th_ops->o_cli_find(head, req);
1286 spin_lock(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1287 LASSERT(cli->tc_rule);
1288 if (cli->tc_rule_sequence !=
1289 atomic_read(&head->th_rule_sequence) ||
1290 cli->tc_rule->tr_flags & NTRS_STOPPING) {
1291 struct nrs_tbf_rule *rule;
1293 rule = nrs_tbf_rule_match(head, cli);
1294 if (rule != cli->tc_rule)
1295 nrs_tbf_cli_reset(head, rule, cli);
1297 nrs_tbf_rule_put(rule);
1298 } else if (cli->tc_rule_generation !=
1299 cli->tc_rule->tr_generation) {
1300 nrs_tbf_cli_reset_value(head, cli);
1302 spin_unlock(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1306 OBD_CPT_ALLOC_GFP(cli, nrs_pol2cptab(policy), nrs_pol2cptid(policy),
1307 sizeof(*cli), moving_req ? GFP_ATOMIC : __GFP_IO);
1310 nrs_tbf_cli_init(head, cli, req);
1311 tmp = head->th_ops->o_cli_findadd(head, cli);
1313 atomic_dec(&cli->tc_ref);
1314 nrs_tbf_cli_fini(cli);
1318 *resp = &cli->tc_res;
1324 * Called when releasing references to the resource hierachy obtained for a
1325 * request for scheduling using the TBF policy.
1327 * \param[in] policy the policy the resource belongs to
1328 * \param[in] res the resource to be released
1330 static void nrs_tbf_res_put(struct ptlrpc_nrs_policy *policy,
1331 const struct ptlrpc_nrs_resource *res)
1333 struct nrs_tbf_head *head;
1334 struct nrs_tbf_client *cli;
1337 * Do nothing for freeing parent, nrs_tbf_net resources
1339 if (res->res_parent == NULL)
1342 cli = container_of(res, struct nrs_tbf_client, tc_res);
1343 head = container_of(res->res_parent, struct nrs_tbf_head, th_res);
1345 head->th_ops->o_cli_put(head, cli);
1349 * Called when getting a request from the TBF policy for handling, or just
1350 * peeking; removes the request from the policy when it is to be handled.
1352 * \param[in] policy The policy
1353 * \param[in] peek When set, signifies that we just want to examine the
1354 * request, and not handle it, so the request is not removed
1356 * \param[in] force Force the policy to return a request; unused in this
1359 * \retval The request to be handled; this is the next request in the TBF
1362 * \see ptlrpc_nrs_req_get_nolock()
1363 * \see nrs_request_get()
1366 struct ptlrpc_nrs_request *nrs_tbf_req_get(struct ptlrpc_nrs_policy *policy,
1367 bool peek, bool force)
1369 struct nrs_tbf_head *head = policy->pol_private;
1370 struct ptlrpc_nrs_request *nrq = NULL;
1371 struct nrs_tbf_client *cli;
1372 cfs_binheap_node_t *node;
1374 assert_spin_locked(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1376 if (!peek && policy->pol_nrs->nrs_throttling)
1379 node = cfs_binheap_root(head->th_binheap);
1380 if (unlikely(node == NULL))
1383 cli = container_of(node, struct nrs_tbf_client, tc_node);
1384 LASSERT(cli->tc_in_heap);
1386 nrq = list_entry(cli->tc_list.next,
1387 struct ptlrpc_nrs_request,
1390 __u64 now = ktime_to_ns(ktime_get());
1395 deadline = cli->tc_check_time +
1397 LASSERT(now >= cli->tc_check_time);
1398 passed = now - cli->tc_check_time;
1399 ntoken = (passed * cli->tc_rpc_rate) / NSEC_PER_SEC;
1400 ntoken += cli->tc_ntoken;
1401 if (ntoken > cli->tc_depth)
1402 ntoken = cli->tc_depth;
1404 struct ptlrpc_request *req;
1405 nrq = list_entry(cli->tc_list.next,
1406 struct ptlrpc_nrs_request,
1408 req = container_of(nrq,
1409 struct ptlrpc_request,
1412 cli->tc_ntoken = ntoken;
1413 cli->tc_check_time = now;
1414 list_del_init(&nrq->nr_u.tbf.tr_list);
1415 if (list_empty(&cli->tc_list)) {
1416 cfs_binheap_remove(head->th_binheap,
1418 cli->tc_in_heap = false;
1420 cfs_binheap_relocate(head->th_binheap,
1424 "NRS start %s request from %s, "
1426 policy->pol_desc->pd_name,
1427 libcfs_id2str(req->rq_peer),
1428 nrq->nr_u.tbf.tr_sequence);
1432 spin_lock(&policy->pol_nrs->nrs_lock);
1433 policy->pol_nrs->nrs_throttling = 1;
1434 spin_unlock(&policy->pol_nrs->nrs_lock);
1435 head->th_deadline = deadline;
1436 time = ktime_set(0, 0);
1437 time = ktime_add_ns(time, deadline);
1438 hrtimer_start(&head->th_timer, time, HRTIMER_MODE_ABS);
1446 * Adds request \a nrq to \a policy's list of queued requests
1448 * \param[in] policy The policy
1449 * \param[in] nrq The request to add
1451 * \retval 0 success; nrs_request_enqueue() assumes this function will always
1454 static int nrs_tbf_req_add(struct ptlrpc_nrs_policy *policy,
1455 struct ptlrpc_nrs_request *nrq)
1457 struct nrs_tbf_head *head;
1458 struct nrs_tbf_client *cli;
1461 assert_spin_locked(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1463 cli = container_of(nrs_request_resource(nrq),
1464 struct nrs_tbf_client, tc_res);
1465 head = container_of(nrs_request_resource(nrq)->res_parent,
1466 struct nrs_tbf_head, th_res);
1467 if (list_empty(&cli->tc_list)) {
1468 LASSERT(!cli->tc_in_heap);
1469 rc = cfs_binheap_insert(head->th_binheap, &cli->tc_node);
1471 cli->tc_in_heap = true;
1472 nrq->nr_u.tbf.tr_sequence = head->th_sequence++;
1473 list_add_tail(&nrq->nr_u.tbf.tr_list,
1475 if (policy->pol_nrs->nrs_throttling) {
1476 __u64 deadline = cli->tc_check_time +
1478 if ((head->th_deadline > deadline) &&
1479 (hrtimer_try_to_cancel(&head->th_timer)
1482 head->th_deadline = deadline;
1483 time = ktime_set(0, 0);
1484 time = ktime_add_ns(time, deadline);
1485 hrtimer_start(&head->th_timer, time,
1491 LASSERT(cli->tc_in_heap);
1492 nrq->nr_u.tbf.tr_sequence = head->th_sequence++;
1493 list_add_tail(&nrq->nr_u.tbf.tr_list,
1500 * Removes request \a nrq from \a policy's list of queued requests.
1502 * \param[in] policy The policy
1503 * \param[in] nrq The request to remove
1505 static void nrs_tbf_req_del(struct ptlrpc_nrs_policy *policy,
1506 struct ptlrpc_nrs_request *nrq)
1508 struct nrs_tbf_head *head;
1509 struct nrs_tbf_client *cli;
1511 assert_spin_locked(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1513 cli = container_of(nrs_request_resource(nrq),
1514 struct nrs_tbf_client, tc_res);
1515 head = container_of(nrs_request_resource(nrq)->res_parent,
1516 struct nrs_tbf_head, th_res);
1518 LASSERT(!list_empty(&nrq->nr_u.tbf.tr_list));
1519 list_del_init(&nrq->nr_u.tbf.tr_list);
1520 if (list_empty(&cli->tc_list)) {
1521 cfs_binheap_remove(head->th_binheap,
1523 cli->tc_in_heap = false;
1525 cfs_binheap_relocate(head->th_binheap,
1531 * Prints a debug statement right before the request \a nrq stops being
1534 * \param[in] policy The policy handling the request
1535 * \param[in] nrq The request being handled
1537 * \see ptlrpc_server_finish_request()
1538 * \see ptlrpc_nrs_req_stop_nolock()
1540 static void nrs_tbf_req_stop(struct ptlrpc_nrs_policy *policy,
1541 struct ptlrpc_nrs_request *nrq)
1543 struct ptlrpc_request *req = container_of(nrq, struct ptlrpc_request,
1546 assert_spin_locked(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1548 CDEBUG(D_RPCTRACE, "NRS stop %s request from %s, seq: "LPU64"\n",
1549 policy->pol_desc->pd_name, libcfs_id2str(req->rq_peer),
1550 nrq->nr_u.tbf.tr_sequence);
1553 #ifdef CONFIG_PROC_FS
1560 * The maximum RPC rate.
1562 #define LPROCFS_NRS_RATE_MAX 65535
1565 ptlrpc_lprocfs_nrs_tbf_rule_seq_show(struct seq_file *m, void *data)
1567 struct ptlrpc_service *svc = m->private;
1570 seq_printf(m, "regular_requests:\n");
1572 * Perform two separate calls to this as only one of the NRS heads'
1573 * policies may be in the ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED or
1574 * ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPING state.
1576 rc = ptlrpc_nrs_policy_control(svc, PTLRPC_NRS_QUEUE_REG,
1578 NRS_CTL_TBF_RD_RULE,
1582 * -ENOSPC means buf in the parameter m is overflow, return 0
1583 * here to let upper layer function seq_read alloc a larger
1584 * memory area and do this process again.
1586 } else if (rc == -ENOSPC) {
1590 * Ignore -ENODEV as the regular NRS head's policy may be in the
1591 * ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPED state.
1593 } else if (rc != -ENODEV) {
1597 if (!nrs_svc_has_hp(svc))
1600 seq_printf(m, "high_priority_requests:\n");
1601 rc = ptlrpc_nrs_policy_control(svc, PTLRPC_NRS_QUEUE_HP,
1603 NRS_CTL_TBF_RD_RULE,
1607 * -ENOSPC means buf in the parameter m is overflow, return 0
1608 * here to let upper layer function seq_read alloc a larger
1609 * memory area and do this process again.
1611 } else if (rc == -ENOSPC) {
1620 static int nrs_tbf_id_parse(struct nrs_tbf_cmd *cmd, char **val)
1625 token = strsep(val, "}");
1627 GOTO(out, rc = -EINVAL);
1629 if (strlen(token) <= 1 ||
1631 GOTO(out, rc = -EINVAL);
1635 /* Should be followed by ' ' or nothing */
1636 if ((*val)[0] == '\0')
1638 else if ((*val)[0] == ' ')
1641 GOTO(out, rc = -EINVAL);
1643 rc = nrs_tbf_jobid_parse(cmd, token);
1645 cmd->tc_valid_types |= NRS_TBF_FLAG_JOBID;
1647 rc = nrs_tbf_nid_parse(cmd, token);
1649 cmd->tc_valid_types |= NRS_TBF_FLAG_NID;
1651 if (!cmd->tc_valid_types)
1660 static void nrs_tbf_cmd_fini(struct nrs_tbf_cmd *cmd)
1662 if (cmd->tc_valid_types & NRS_TBF_FLAG_JOBID)
1663 nrs_tbf_jobid_cmd_fini(cmd);
1664 if (cmd->tc_valid_types & NRS_TBF_FLAG_NID)
1665 nrs_tbf_nid_cmd_fini(cmd);
1668 static struct nrs_tbf_cmd *
1669 nrs_tbf_parse_cmd(char *buffer, unsigned long count)
1671 static struct nrs_tbf_cmd *cmd;
1679 GOTO(out, rc = -ENOMEM);
1682 token = strsep(&val, " ");
1683 if (val == NULL || strlen(val) == 0)
1684 GOTO(out_free_cmd, rc = -EINVAL);
1686 /* Type of the command */
1687 if (strcmp(token, "start") == 0)
1688 cmd->tc_cmd = NRS_CTL_TBF_START_RULE;
1689 else if (strcmp(token, "stop") == 0)
1690 cmd->tc_cmd = NRS_CTL_TBF_STOP_RULE;
1691 else if (strcmp(token, "change") == 0)
1692 cmd->tc_cmd = NRS_CTL_TBF_CHANGE_RATE;
1694 GOTO(out_free_cmd, rc = -EINVAL);
1696 /* Name of the rule */
1697 token = strsep(&val, " ");
1700 * Stop comand only need name argument,
1701 * But other commands need ID or rate argument.
1703 if (cmd->tc_cmd != NRS_CTL_TBF_STOP_RULE)
1704 GOTO(out_free_cmd, rc = -EINVAL);
1707 for (i = 0; i < strlen(token); i++) {
1708 if ((!isalnum(token[i])) &&
1710 GOTO(out_free_cmd, rc = -EINVAL);
1712 cmd->tc_name = token;
1714 if (cmd->tc_cmd == NRS_CTL_TBF_START_RULE) {
1717 rc = nrs_tbf_id_parse(cmd, &val);
1719 GOTO(out_free_cmd, rc);
1723 if (cmd->tc_cmd == NRS_CTL_TBF_STOP_RULE ||
1724 strlen(val) == 0 || !isdigit(val[0]))
1725 GOTO(out_free_nid, rc = -EINVAL);
1727 cmd->tc_rpc_rate = simple_strtoull(val, NULL, 10);
1728 if (cmd->tc_rpc_rate <= 0 ||
1729 cmd->tc_rpc_rate >= LPROCFS_NRS_RATE_MAX)
1730 GOTO(out_free_nid, rc = -EINVAL);
1732 if (cmd->tc_cmd == NRS_CTL_TBF_CHANGE_RATE)
1733 GOTO(out_free_nid, rc = -EINVAL);
1734 /* No RPC rate given */
1735 cmd->tc_rpc_rate = tbf_rate;
1739 nrs_tbf_cmd_fini(cmd);
1748 extern struct nrs_core nrs_core;
1749 #define LPROCFS_WR_NRS_TBF_MAX_CMD (4096)
1751 ptlrpc_lprocfs_nrs_tbf_rule_seq_write(struct file *file, const char *buffer,
1752 size_t count, loff_t *off)
1754 struct seq_file *m = file->private_data;
1755 struct ptlrpc_service *svc = m->private;
1759 static struct nrs_tbf_cmd *cmd;
1760 enum ptlrpc_nrs_queue_type queue = PTLRPC_NRS_QUEUE_BOTH;
1761 unsigned long length;
1764 OBD_ALLOC(kernbuf, LPROCFS_WR_NRS_TBF_MAX_CMD);
1765 if (kernbuf == NULL)
1766 GOTO(out, rc = -ENOMEM);
1768 if (count > LPROCFS_WR_NRS_TBF_MAX_CMD - 1)
1769 GOTO(out_free_kernbuff, rc = -EINVAL);
1771 if (copy_from_user(kernbuf, buffer, count))
1772 GOTO(out_free_kernbuff, rc = -EFAULT);
1775 token = strsep(&val, " ");
1777 GOTO(out_free_kernbuff, rc = -EINVAL);
1779 if (strcmp(token, "reg") == 0) {
1780 queue = PTLRPC_NRS_QUEUE_REG;
1781 } else if (strcmp(token, "hp") == 0) {
1782 queue = PTLRPC_NRS_QUEUE_HP;
1784 kernbuf[strlen(token)] = ' ';
1787 length = strlen(val);
1790 GOTO(out_free_kernbuff, rc = -EINVAL);
1792 if (queue == PTLRPC_NRS_QUEUE_HP && !nrs_svc_has_hp(svc))
1793 GOTO(out_free_kernbuff, rc = -ENODEV);
1794 else if (queue == PTLRPC_NRS_QUEUE_BOTH && !nrs_svc_has_hp(svc))
1795 queue = PTLRPC_NRS_QUEUE_REG;
1797 cmd = nrs_tbf_parse_cmd(val, length);
1799 GOTO(out_free_kernbuff, rc = PTR_ERR(cmd));
1802 * Serialize NRS core lprocfs operations with policy registration/
1805 mutex_lock(&nrs_core.nrs_mutex);
1806 rc = ptlrpc_nrs_policy_control(svc, queue,
1808 NRS_CTL_TBF_WR_RULE,
1810 mutex_unlock(&nrs_core.nrs_mutex);
1812 nrs_tbf_cmd_fini(cmd);
1815 OBD_FREE(kernbuf, LPROCFS_WR_NRS_TBF_MAX_CMD);
1817 return rc ? rc : count;
1819 LPROC_SEQ_FOPS(ptlrpc_lprocfs_nrs_tbf_rule);
1822 * Initializes a TBF policy's lprocfs interface for service \a svc
1824 * \param[in] svc the service
1827 * \retval != 0 error
1829 static int nrs_tbf_lprocfs_init(struct ptlrpc_service *svc)
1831 struct lprocfs_vars nrs_tbf_lprocfs_vars[] = {
1832 { .name = "nrs_tbf_rule",
1833 .fops = &ptlrpc_lprocfs_nrs_tbf_rule_fops,
1838 if (svc->srv_procroot == NULL)
1841 return lprocfs_add_vars(svc->srv_procroot, nrs_tbf_lprocfs_vars, NULL);
1845 * Cleans up a TBF policy's lprocfs interface for service \a svc
1847 * \param[in] svc the service
1849 static void nrs_tbf_lprocfs_fini(struct ptlrpc_service *svc)
1851 if (svc->srv_procroot == NULL)
1854 lprocfs_remove_proc_entry("nrs_tbf_rule", svc->srv_procroot);
1857 #endif /* CONFIG_PROC_FS */
1860 * TBF policy operations
1862 static const struct ptlrpc_nrs_pol_ops nrs_tbf_ops = {
1863 .op_policy_start = nrs_tbf_start,
1864 .op_policy_stop = nrs_tbf_stop,
1865 .op_policy_ctl = nrs_tbf_ctl,
1866 .op_res_get = nrs_tbf_res_get,
1867 .op_res_put = nrs_tbf_res_put,
1868 .op_req_get = nrs_tbf_req_get,
1869 .op_req_enqueue = nrs_tbf_req_add,
1870 .op_req_dequeue = nrs_tbf_req_del,
1871 .op_req_stop = nrs_tbf_req_stop,
1872 #ifdef CONFIG_PROC_FS
1873 .op_lprocfs_init = nrs_tbf_lprocfs_init,
1874 .op_lprocfs_fini = nrs_tbf_lprocfs_fini,
1879 * TBF policy configuration
1881 struct ptlrpc_nrs_pol_conf nrs_conf_tbf = {
1882 .nc_name = NRS_POL_NAME_TBF,
1883 .nc_ops = &nrs_tbf_ops,
1884 .nc_compat = nrs_policy_compat_all,
1891 #endif /* HAVE_SERVER_SUPPORT */