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 nrs->nrs_throttling = 0;
77 wake_up(&svcpt->scp_waitq);
79 return HRTIMER_NORESTART;
82 #define NRS_TBF_DEFAULT_RULE "default"
84 static void nrs_tbf_rule_fini(struct nrs_tbf_rule *rule)
86 LASSERT(atomic_read(&rule->tr_ref) == 0);
87 LASSERT(list_empty(&rule->tr_cli_list));
88 LASSERT(list_empty(&rule->tr_linkage));
90 rule->tr_head->th_ops->o_rule_fini(rule);
95 * Decreases the rule's usage reference count, and stops the rule in case it
96 * was already stopping and have no more outstanding usage references (which
97 * indicates it has no more queued or started requests, and can be safely
100 static void nrs_tbf_rule_put(struct nrs_tbf_rule *rule)
102 if (atomic_dec_and_test(&rule->tr_ref))
103 nrs_tbf_rule_fini(rule);
107 * Increases the rule's usage reference count.
109 static inline void nrs_tbf_rule_get(struct nrs_tbf_rule *rule)
111 atomic_inc(&rule->tr_ref);
115 nrs_tbf_cli_rule_put(struct nrs_tbf_client *cli)
117 LASSERT(!list_empty(&cli->tc_linkage));
118 LASSERT(cli->tc_rule);
119 spin_lock(&cli->tc_rule->tr_rule_lock);
120 list_del_init(&cli->tc_linkage);
121 spin_unlock(&cli->tc_rule->tr_rule_lock);
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 spin_lock(&cli->tc_rule_lock);
152 if (cli->tc_rule != NULL && !list_empty(&cli->tc_linkage)) {
153 LASSERT(rule != cli->tc_rule);
154 nrs_tbf_cli_rule_put(cli);
156 LASSERT(cli->tc_rule == NULL);
157 LASSERT(list_empty(&cli->tc_linkage));
158 /* Rule's ref is added before called */
160 spin_lock(&rule->tr_rule_lock);
161 list_add_tail(&cli->tc_linkage, &rule->tr_cli_list);
162 spin_unlock(&rule->tr_rule_lock);
163 spin_unlock(&cli->tc_rule_lock);
164 nrs_tbf_cli_reset_value(head, cli);
168 nrs_tbf_rule_dump(struct nrs_tbf_rule *rule, struct seq_file *m)
170 return rule->tr_head->th_ops->o_rule_dump(rule, m);
174 nrs_tbf_rule_dump_all(struct nrs_tbf_head *head, struct seq_file *m)
176 struct nrs_tbf_rule *rule;
179 LASSERT(head != NULL);
180 spin_lock(&head->th_rule_lock);
181 /* List the rules from newest to oldest */
182 list_for_each_entry(rule, &head->th_list, tr_linkage) {
183 LASSERT((rule->tr_flags & NTRS_STOPPING) == 0);
184 rc = nrs_tbf_rule_dump(rule, m);
190 spin_unlock(&head->th_rule_lock);
195 static struct nrs_tbf_rule *
196 nrs_tbf_rule_find_nolock(struct nrs_tbf_head *head,
199 struct nrs_tbf_rule *rule;
201 LASSERT(head != NULL);
202 list_for_each_entry(rule, &head->th_list, tr_linkage) {
203 LASSERT((rule->tr_flags & NTRS_STOPPING) == 0);
204 if (strcmp(rule->tr_name, name) == 0) {
205 nrs_tbf_rule_get(rule);
212 static struct nrs_tbf_rule *
213 nrs_tbf_rule_find(struct nrs_tbf_head *head,
216 struct nrs_tbf_rule *rule;
218 LASSERT(head != NULL);
219 spin_lock(&head->th_rule_lock);
220 rule = nrs_tbf_rule_find_nolock(head, name);
221 spin_unlock(&head->th_rule_lock);
225 static struct nrs_tbf_rule *
226 nrs_tbf_rule_match(struct nrs_tbf_head *head,
227 struct nrs_tbf_client *cli)
229 struct nrs_tbf_rule *rule = NULL;
230 struct nrs_tbf_rule *tmp_rule;
232 spin_lock(&head->th_rule_lock);
233 /* Match the newest rule in the list */
234 list_for_each_entry(tmp_rule, &head->th_list, tr_linkage) {
235 LASSERT((tmp_rule->tr_flags & NTRS_STOPPING) == 0);
236 if (head->th_ops->o_rule_match(tmp_rule, cli)) {
243 rule = head->th_rule;
245 nrs_tbf_rule_get(rule);
246 spin_unlock(&head->th_rule_lock);
251 nrs_tbf_cli_init(struct nrs_tbf_head *head,
252 struct nrs_tbf_client *cli,
253 struct ptlrpc_request *req)
255 struct nrs_tbf_rule *rule;
257 cli->tc_in_heap = false;
258 head->th_ops->o_cli_init(cli, req);
259 INIT_LIST_HEAD(&cli->tc_list);
260 INIT_LIST_HEAD(&cli->tc_linkage);
261 spin_lock_init(&cli->tc_rule_lock);
262 atomic_set(&cli->tc_ref, 1);
263 rule = nrs_tbf_rule_match(head, cli);
264 nrs_tbf_cli_reset(head, rule, cli);
268 nrs_tbf_cli_fini(struct nrs_tbf_client *cli)
270 LASSERT(list_empty(&cli->tc_list));
271 LASSERT(!cli->tc_in_heap);
272 LASSERT(atomic_read(&cli->tc_ref) == 0);
273 spin_lock(&cli->tc_rule_lock);
274 nrs_tbf_cli_rule_put(cli);
275 spin_unlock(&cli->tc_rule_lock);
280 nrs_tbf_rule_start(struct ptlrpc_nrs_policy *policy,
281 struct nrs_tbf_head *head,
282 struct nrs_tbf_cmd *start)
284 struct nrs_tbf_rule *rule, *tmp_rule;
287 rule = nrs_tbf_rule_find(head, start->tc_name);
289 nrs_tbf_rule_put(rule);
293 OBD_CPT_ALLOC_PTR(rule, nrs_pol2cptab(policy), nrs_pol2cptid(policy));
297 memcpy(rule->tr_name, start->tc_name, strlen(start->tc_name));
298 rule->tr_rpc_rate = start->tc_rpc_rate;
299 rule->tr_nsecs = NSEC_PER_SEC / rule->tr_rpc_rate;
300 rule->tr_depth = tbf_depth;
301 atomic_set(&rule->tr_ref, 1);
302 INIT_LIST_HEAD(&rule->tr_cli_list);
303 INIT_LIST_HEAD(&rule->tr_nids);
304 INIT_LIST_HEAD(&rule->tr_linkage);
305 spin_lock_init(&rule->tr_rule_lock);
306 rule->tr_head = head;
308 rc = head->th_ops->o_rule_init(policy, rule, start);
314 /* Add as the newest rule */
315 spin_lock(&head->th_rule_lock);
316 tmp_rule = nrs_tbf_rule_find_nolock(head, start->tc_name);
318 spin_unlock(&head->th_rule_lock);
319 nrs_tbf_rule_put(tmp_rule);
320 nrs_tbf_rule_put(rule);
323 list_add(&rule->tr_linkage, &head->th_list);
324 spin_unlock(&head->th_rule_lock);
325 atomic_inc(&head->th_rule_sequence);
326 if (start->tc_rule_flags & NTRS_DEFAULT) {
327 rule->tr_flags |= NTRS_DEFAULT;
328 LASSERT(head->th_rule == NULL);
329 head->th_rule = rule;
336 nrs_tbf_rule_change(struct ptlrpc_nrs_policy *policy,
337 struct nrs_tbf_head *head,
338 struct nrs_tbf_cmd *change)
340 struct nrs_tbf_rule *rule;
342 assert_spin_locked(&policy->pol_nrs->nrs_lock);
344 rule = nrs_tbf_rule_find(head, change->tc_name);
348 rule->tr_rpc_rate = change->tc_rpc_rate;
349 rule->tr_nsecs = NSEC_PER_SEC / rule->tr_rpc_rate;
350 rule->tr_generation++;
351 nrs_tbf_rule_put(rule);
357 nrs_tbf_rule_stop(struct ptlrpc_nrs_policy *policy,
358 struct nrs_tbf_head *head,
359 struct nrs_tbf_cmd *stop)
361 struct nrs_tbf_rule *rule;
363 assert_spin_locked(&policy->pol_nrs->nrs_lock);
365 if (strcmp(stop->tc_name, NRS_TBF_DEFAULT_RULE) == 0)
368 rule = nrs_tbf_rule_find(head, stop->tc_name);
372 list_del_init(&rule->tr_linkage);
373 rule->tr_flags |= NTRS_STOPPING;
374 nrs_tbf_rule_put(rule);
375 nrs_tbf_rule_put(rule);
381 nrs_tbf_command(struct ptlrpc_nrs_policy *policy,
382 struct nrs_tbf_head *head,
383 struct nrs_tbf_cmd *cmd)
387 assert_spin_locked(&policy->pol_nrs->nrs_lock);
389 switch (cmd->tc_cmd) {
390 case NRS_CTL_TBF_START_RULE:
391 if (!(cmd->tc_valid_types & head->th_type_flag))
394 spin_unlock(&policy->pol_nrs->nrs_lock);
395 rc = nrs_tbf_rule_start(policy, head, cmd);
396 spin_lock(&policy->pol_nrs->nrs_lock);
398 case NRS_CTL_TBF_CHANGE_RATE:
399 rc = nrs_tbf_rule_change(policy, head, cmd);
401 case NRS_CTL_TBF_STOP_RULE:
402 rc = nrs_tbf_rule_stop(policy, head, cmd);
403 /* Take it as a success, if not exists at all */
404 return rc == -ENOENT ? 0 : rc;
411 * Binary heap predicate.
413 * \param[in] e1 the first binheap node to compare
414 * \param[in] e2 the second binheap node to compare
420 tbf_cli_compare(struct cfs_binheap_node *e1, struct cfs_binheap_node *e2)
422 struct nrs_tbf_client *cli1;
423 struct nrs_tbf_client *cli2;
425 cli1 = container_of(e1, struct nrs_tbf_client, tc_node);
426 cli2 = container_of(e2, struct nrs_tbf_client, tc_node);
428 if (cli1->tc_check_time + cli1->tc_nsecs <
429 cli2->tc_check_time + cli2->tc_nsecs)
431 else if (cli1->tc_check_time + cli1->tc_nsecs >
432 cli2->tc_check_time + cli2->tc_nsecs)
435 if (cli1->tc_check_time < cli2->tc_check_time)
437 else if (cli1->tc_check_time > cli2->tc_check_time)
440 /* Maybe need more comparasion, e.g. request number in the rules */
445 * TBF binary heap operations
447 static struct cfs_binheap_ops nrs_tbf_heap_ops = {
450 .hop_compare = tbf_cli_compare,
453 static unsigned nrs_tbf_jobid_hop_hash(struct cfs_hash *hs, const void *key,
456 return cfs_hash_djb2_hash(key, strlen(key), mask);
459 static int nrs_tbf_jobid_hop_keycmp(const void *key, struct hlist_node *hnode)
461 struct nrs_tbf_client *cli = hlist_entry(hnode,
462 struct nrs_tbf_client,
465 return (strcmp(cli->tc_jobid, key) == 0);
468 static void *nrs_tbf_jobid_hop_key(struct hlist_node *hnode)
470 struct nrs_tbf_client *cli = hlist_entry(hnode,
471 struct nrs_tbf_client,
474 return cli->tc_jobid;
477 static void *nrs_tbf_jobid_hop_object(struct hlist_node *hnode)
479 return hlist_entry(hnode, struct nrs_tbf_client, tc_hnode);
482 static void nrs_tbf_jobid_hop_get(struct cfs_hash *hs, struct hlist_node *hnode)
484 struct nrs_tbf_client *cli = hlist_entry(hnode,
485 struct nrs_tbf_client,
488 atomic_inc(&cli->tc_ref);
491 static void nrs_tbf_jobid_hop_put(struct cfs_hash *hs, struct hlist_node *hnode)
493 struct nrs_tbf_client *cli = hlist_entry(hnode,
494 struct nrs_tbf_client,
497 atomic_dec(&cli->tc_ref);
501 nrs_tbf_jobid_hop_exit(struct cfs_hash *hs, struct hlist_node *hnode)
504 struct nrs_tbf_client *cli = hlist_entry(hnode,
505 struct nrs_tbf_client,
508 LASSERT(atomic_read(&cli->tc_ref) == 0);
509 nrs_tbf_cli_fini(cli);
512 static struct cfs_hash_ops nrs_tbf_jobid_hash_ops = {
513 .hs_hash = nrs_tbf_jobid_hop_hash,
514 .hs_keycmp = nrs_tbf_jobid_hop_keycmp,
515 .hs_key = nrs_tbf_jobid_hop_key,
516 .hs_object = nrs_tbf_jobid_hop_object,
517 .hs_get = nrs_tbf_jobid_hop_get,
518 .hs_put = nrs_tbf_jobid_hop_put,
519 .hs_put_locked = nrs_tbf_jobid_hop_put,
520 .hs_exit = nrs_tbf_jobid_hop_exit,
523 #define NRS_TBF_JOBID_HASH_FLAGS (CFS_HASH_SPIN_BKTLOCK | \
524 CFS_HASH_NO_ITEMREF | \
527 static struct nrs_tbf_client *
528 nrs_tbf_jobid_hash_lookup(struct cfs_hash *hs,
529 struct cfs_hash_bd *bd,
532 struct hlist_node *hnode;
533 struct nrs_tbf_client *cli;
535 /* cfs_hash_bd_peek_locked is a somehow "internal" function
536 * of cfs_hash, it doesn't add refcount on object. */
537 hnode = cfs_hash_bd_peek_locked(hs, bd, (void *)jobid);
541 cfs_hash_get(hs, hnode);
542 cli = container_of0(hnode, struct nrs_tbf_client, tc_hnode);
543 if (!list_empty(&cli->tc_lru))
544 list_del_init(&cli->tc_lru);
548 #define NRS_TBF_JOBID_NULL ""
550 static struct nrs_tbf_client *
551 nrs_tbf_jobid_cli_find(struct nrs_tbf_head *head,
552 struct ptlrpc_request *req)
555 struct nrs_tbf_client *cli;
556 struct cfs_hash *hs = head->th_cli_hash;
557 struct cfs_hash_bd bd;
559 jobid = lustre_msg_get_jobid(req->rq_reqmsg);
561 jobid = NRS_TBF_JOBID_NULL;
562 cfs_hash_bd_get_and_lock(hs, (void *)jobid, &bd, 1);
563 cli = nrs_tbf_jobid_hash_lookup(hs, &bd, jobid);
564 cfs_hash_bd_unlock(hs, &bd, 1);
569 static struct nrs_tbf_client *
570 nrs_tbf_jobid_cli_findadd(struct nrs_tbf_head *head,
571 struct nrs_tbf_client *cli)
574 struct nrs_tbf_client *ret;
575 struct cfs_hash *hs = head->th_cli_hash;
576 struct cfs_hash_bd bd;
578 jobid = cli->tc_jobid;
579 cfs_hash_bd_get_and_lock(hs, (void *)jobid, &bd, 1);
580 ret = nrs_tbf_jobid_hash_lookup(hs, &bd, jobid);
582 cfs_hash_bd_add_locked(hs, &bd, &cli->tc_hnode);
585 cfs_hash_bd_unlock(hs, &bd, 1);
591 nrs_tbf_jobid_cli_put(struct nrs_tbf_head *head,
592 struct nrs_tbf_client *cli)
594 struct cfs_hash_bd bd;
595 struct cfs_hash *hs = head->th_cli_hash;
596 struct nrs_tbf_bucket *bkt;
598 struct list_head zombies;
600 INIT_LIST_HEAD(&zombies);
601 cfs_hash_bd_get(hs, &cli->tc_jobid, &bd);
602 bkt = cfs_hash_bd_extra_get(hs, &bd);
603 if (!cfs_hash_bd_dec_and_lock(hs, &bd, &cli->tc_ref))
605 LASSERT(list_empty(&cli->tc_lru));
606 list_add_tail(&cli->tc_lru, &bkt->ntb_lru);
609 * Check and purge the LRU, there is at least one client in the LRU.
611 hw = tbf_jobid_cache_size >>
612 (hs->hs_cur_bits - hs->hs_bkt_bits);
613 while (cfs_hash_bd_count_get(&bd) > hw) {
614 if (unlikely(list_empty(&bkt->ntb_lru)))
616 cli = list_entry(bkt->ntb_lru.next,
617 struct nrs_tbf_client,
619 LASSERT(atomic_read(&cli->tc_ref) == 0);
620 cfs_hash_bd_del_locked(hs, &bd, &cli->tc_hnode);
621 list_move(&cli->tc_lru, &zombies);
623 cfs_hash_bd_unlock(head->th_cli_hash, &bd, 1);
625 while (!list_empty(&zombies)) {
626 cli = container_of0(zombies.next,
627 struct nrs_tbf_client, tc_lru);
628 list_del_init(&cli->tc_lru);
629 nrs_tbf_cli_fini(cli);
634 nrs_tbf_jobid_cli_init(struct nrs_tbf_client *cli,
635 struct ptlrpc_request *req)
637 char *jobid = lustre_msg_get_jobid(req->rq_reqmsg);
640 jobid = NRS_TBF_JOBID_NULL;
641 LASSERT(strlen(jobid) < LUSTRE_JOBID_SIZE);
642 INIT_LIST_HEAD(&cli->tc_lru);
643 memcpy(cli->tc_jobid, jobid, strlen(jobid));
646 static int nrs_tbf_jobid_hash_order(void)
650 for (bits = 1; (1 << bits) < tbf_jobid_cache_size; ++bits)
656 #define NRS_TBF_JOBID_BKT_BITS 10
659 nrs_tbf_jobid_startup(struct ptlrpc_nrs_policy *policy,
660 struct nrs_tbf_head *head)
662 struct nrs_tbf_cmd start;
663 struct nrs_tbf_bucket *bkt;
667 struct cfs_hash_bd bd;
669 bits = nrs_tbf_jobid_hash_order();
670 if (bits < NRS_TBF_JOBID_BKT_BITS)
671 bits = NRS_TBF_JOBID_BKT_BITS;
672 head->th_cli_hash = cfs_hash_create("nrs_tbf_hash",
675 NRS_TBF_JOBID_BKT_BITS,
679 &nrs_tbf_jobid_hash_ops,
680 NRS_TBF_JOBID_HASH_FLAGS);
681 if (head->th_cli_hash == NULL)
684 cfs_hash_for_each_bucket(head->th_cli_hash, &bd, i) {
685 bkt = cfs_hash_bd_extra_get(head->th_cli_hash, &bd);
686 INIT_LIST_HEAD(&bkt->ntb_lru);
689 memset(&start, 0, sizeof(start));
690 start.tc_jobids_str = "*";
692 start.tc_rpc_rate = tbf_rate;
693 start.tc_rule_flags = NTRS_DEFAULT;
694 start.tc_name = NRS_TBF_DEFAULT_RULE;
695 INIT_LIST_HEAD(&start.tc_jobids);
696 rc = nrs_tbf_rule_start(policy, head, &start);
702 * Frees jobid of \a list.
706 nrs_tbf_jobid_list_free(struct list_head *jobid_list)
708 struct nrs_tbf_jobid *jobid, *n;
710 list_for_each_entry_safe(jobid, n, jobid_list, tj_linkage) {
711 OBD_FREE(jobid->tj_id, strlen(jobid->tj_id) + 1);
712 list_del(&jobid->tj_linkage);
713 OBD_FREE(jobid, sizeof(struct nrs_tbf_jobid));
718 nrs_tbf_jobid_list_add(const struct cfs_lstr *id, struct list_head *jobid_list)
720 struct nrs_tbf_jobid *jobid;
722 OBD_ALLOC(jobid, sizeof(struct nrs_tbf_jobid));
726 OBD_ALLOC(jobid->tj_id, id->ls_len + 1);
727 if (jobid->tj_id == NULL) {
728 OBD_FREE(jobid, sizeof(struct nrs_tbf_jobid));
732 memcpy(jobid->tj_id, id->ls_str, id->ls_len);
733 list_add_tail(&jobid->tj_linkage, jobid_list);
738 nrs_tbf_jobid_list_match(struct list_head *jobid_list, char *id)
740 struct nrs_tbf_jobid *jobid;
742 list_for_each_entry(jobid, jobid_list, tj_linkage) {
743 if (strcmp(id, jobid->tj_id) == 0)
750 nrs_tbf_jobid_list_parse(char *str, int len, struct list_head *jobid_list)
759 INIT_LIST_HEAD(jobid_list);
761 rc = cfs_gettok(&src, ' ', &res);
766 rc = nrs_tbf_jobid_list_add(&res, jobid_list);
771 nrs_tbf_jobid_list_free(jobid_list);
775 static void nrs_tbf_jobid_cmd_fini(struct nrs_tbf_cmd *cmd)
777 if (!list_empty(&cmd->tc_jobids))
778 nrs_tbf_jobid_list_free(&cmd->tc_jobids);
779 if (cmd->tc_jobids_str)
780 OBD_FREE(cmd->tc_jobids_str, strlen(cmd->tc_jobids_str) + 1);
783 static int nrs_tbf_jobid_parse(struct nrs_tbf_cmd *cmd, const char *id)
787 OBD_ALLOC(cmd->tc_jobids_str, strlen(id) + 1);
788 if (cmd->tc_jobids_str == NULL)
791 memcpy(cmd->tc_jobids_str, id, strlen(id));
793 /* parse jobid list */
794 rc = nrs_tbf_jobid_list_parse(cmd->tc_jobids_str,
795 strlen(cmd->tc_jobids_str),
798 nrs_tbf_jobid_cmd_fini(cmd);
803 static int nrs_tbf_jobid_rule_init(struct ptlrpc_nrs_policy *policy,
804 struct nrs_tbf_rule *rule,
805 struct nrs_tbf_cmd *start)
809 LASSERT(start->tc_jobids_str);
810 OBD_ALLOC(rule->tr_jobids_str,
811 strlen(start->tc_jobids_str) + 1);
812 if (rule->tr_jobids_str == NULL)
815 memcpy(rule->tr_jobids_str,
816 start->tc_jobids_str,
817 strlen(start->tc_jobids_str));
819 INIT_LIST_HEAD(&rule->tr_jobids);
820 if (!list_empty(&start->tc_jobids)) {
821 rc = nrs_tbf_jobid_list_parse(rule->tr_jobids_str,
822 strlen(rule->tr_jobids_str),
825 CERROR("jobids {%s} illegal\n", rule->tr_jobids_str);
828 OBD_FREE(rule->tr_jobids_str,
829 strlen(start->tc_jobids_str) + 1);
834 nrs_tbf_jobid_rule_dump(struct nrs_tbf_rule *rule, struct seq_file *m)
836 seq_printf(m, "%s {%s} %llu, ref %d\n", rule->tr_name,
837 rule->tr_jobids_str, rule->tr_rpc_rate,
838 atomic_read(&rule->tr_ref) - 1);
843 nrs_tbf_jobid_rule_match(struct nrs_tbf_rule *rule,
844 struct nrs_tbf_client *cli)
846 return nrs_tbf_jobid_list_match(&rule->tr_jobids, cli->tc_jobid);
849 static void nrs_tbf_jobid_rule_fini(struct nrs_tbf_rule *rule)
851 if (!list_empty(&rule->tr_jobids))
852 nrs_tbf_jobid_list_free(&rule->tr_jobids);
853 LASSERT(rule->tr_jobids_str != NULL);
854 OBD_FREE(rule->tr_jobids_str, strlen(rule->tr_jobids_str) + 1);
857 static struct nrs_tbf_ops nrs_tbf_jobid_ops = {
858 .o_name = NRS_TBF_TYPE_JOBID,
859 .o_startup = nrs_tbf_jobid_startup,
860 .o_cli_find = nrs_tbf_jobid_cli_find,
861 .o_cli_findadd = nrs_tbf_jobid_cli_findadd,
862 .o_cli_put = nrs_tbf_jobid_cli_put,
863 .o_cli_init = nrs_tbf_jobid_cli_init,
864 .o_rule_init = nrs_tbf_jobid_rule_init,
865 .o_rule_dump = nrs_tbf_jobid_rule_dump,
866 .o_rule_match = nrs_tbf_jobid_rule_match,
867 .o_rule_fini = nrs_tbf_jobid_rule_fini,
871 * libcfs_hash operations for nrs_tbf_net::cn_cli_hash
873 * This uses ptlrpc_request::rq_peer.nid as its key, in order to hash
874 * nrs_tbf_client objects.
876 #define NRS_TBF_NID_BKT_BITS 8
877 #define NRS_TBF_NID_BITS 16
879 static unsigned nrs_tbf_nid_hop_hash(struct cfs_hash *hs, const void *key,
882 return cfs_hash_djb2_hash(key, sizeof(lnet_nid_t), mask);
885 static int nrs_tbf_nid_hop_keycmp(const void *key, struct hlist_node *hnode)
887 lnet_nid_t *nid = (lnet_nid_t *)key;
888 struct nrs_tbf_client *cli = hlist_entry(hnode,
889 struct nrs_tbf_client,
892 return *nid == cli->tc_nid;
895 static void *nrs_tbf_nid_hop_key(struct hlist_node *hnode)
897 struct nrs_tbf_client *cli = hlist_entry(hnode,
898 struct nrs_tbf_client,
904 static void *nrs_tbf_nid_hop_object(struct hlist_node *hnode)
906 return hlist_entry(hnode, struct nrs_tbf_client, tc_hnode);
909 static void nrs_tbf_nid_hop_get(struct cfs_hash *hs, struct hlist_node *hnode)
911 struct nrs_tbf_client *cli = hlist_entry(hnode,
912 struct nrs_tbf_client,
915 atomic_inc(&cli->tc_ref);
918 static void nrs_tbf_nid_hop_put(struct cfs_hash *hs, struct hlist_node *hnode)
920 struct nrs_tbf_client *cli = hlist_entry(hnode,
921 struct nrs_tbf_client,
924 atomic_dec(&cli->tc_ref);
927 static void nrs_tbf_nid_hop_exit(struct cfs_hash *hs, struct hlist_node *hnode)
929 struct nrs_tbf_client *cli = hlist_entry(hnode,
930 struct nrs_tbf_client,
933 LASSERTF(atomic_read(&cli->tc_ref) == 0,
934 "Busy TBF object from client with NID %s, with %d refs\n",
935 libcfs_nid2str(cli->tc_nid), atomic_read(&cli->tc_ref));
937 nrs_tbf_cli_fini(cli);
940 static struct cfs_hash_ops nrs_tbf_nid_hash_ops = {
941 .hs_hash = nrs_tbf_nid_hop_hash,
942 .hs_keycmp = nrs_tbf_nid_hop_keycmp,
943 .hs_key = nrs_tbf_nid_hop_key,
944 .hs_object = nrs_tbf_nid_hop_object,
945 .hs_get = nrs_tbf_nid_hop_get,
946 .hs_put = nrs_tbf_nid_hop_put,
947 .hs_put_locked = nrs_tbf_nid_hop_put,
948 .hs_exit = nrs_tbf_nid_hop_exit,
951 static struct nrs_tbf_client *
952 nrs_tbf_nid_cli_find(struct nrs_tbf_head *head,
953 struct ptlrpc_request *req)
955 return cfs_hash_lookup(head->th_cli_hash, &req->rq_peer.nid);
958 static struct nrs_tbf_client *
959 nrs_tbf_nid_cli_findadd(struct nrs_tbf_head *head,
960 struct nrs_tbf_client *cli)
962 return cfs_hash_findadd_unique(head->th_cli_hash, &cli->tc_nid,
967 nrs_tbf_nid_cli_put(struct nrs_tbf_head *head,
968 struct nrs_tbf_client *cli)
970 cfs_hash_put(head->th_cli_hash, &cli->tc_hnode);
974 nrs_tbf_nid_startup(struct ptlrpc_nrs_policy *policy,
975 struct nrs_tbf_head *head)
977 struct nrs_tbf_cmd start;
980 head->th_cli_hash = cfs_hash_create("nrs_tbf_hash",
983 NRS_TBF_NID_BKT_BITS, 0,
986 &nrs_tbf_nid_hash_ops,
987 CFS_HASH_RW_BKTLOCK);
988 if (head->th_cli_hash == NULL)
991 memset(&start, 0, sizeof(start));
992 start.tc_nids_str = "*";
994 start.tc_rpc_rate = tbf_rate;
995 start.tc_rule_flags = NTRS_DEFAULT;
996 start.tc_name = NRS_TBF_DEFAULT_RULE;
997 INIT_LIST_HEAD(&start.tc_nids);
998 rc = nrs_tbf_rule_start(policy, head, &start);
1004 nrs_tbf_nid_cli_init(struct nrs_tbf_client *cli,
1005 struct ptlrpc_request *req)
1007 cli->tc_nid = req->rq_peer.nid;
1010 static int nrs_tbf_nid_rule_init(struct ptlrpc_nrs_policy *policy,
1011 struct nrs_tbf_rule *rule,
1012 struct nrs_tbf_cmd *start)
1014 LASSERT(start->tc_nids_str);
1015 OBD_ALLOC(rule->tr_nids_str,
1016 strlen(start->tc_nids_str) + 1);
1017 if (rule->tr_nids_str == NULL)
1020 memcpy(rule->tr_nids_str,
1022 strlen(start->tc_nids_str));
1024 INIT_LIST_HEAD(&rule->tr_nids);
1025 if (!list_empty(&start->tc_nids)) {
1026 if (cfs_parse_nidlist(rule->tr_nids_str,
1027 strlen(rule->tr_nids_str),
1028 &rule->tr_nids) <= 0) {
1029 CERROR("nids {%s} illegal\n",
1031 OBD_FREE(rule->tr_nids_str,
1032 strlen(start->tc_nids_str) + 1);
1040 nrs_tbf_nid_rule_dump(struct nrs_tbf_rule *rule, struct seq_file *m)
1042 seq_printf(m, "%s {%s} %llu, ref %d\n", rule->tr_name,
1043 rule->tr_nids_str, rule->tr_rpc_rate,
1044 atomic_read(&rule->tr_ref) - 1);
1049 nrs_tbf_nid_rule_match(struct nrs_tbf_rule *rule,
1050 struct nrs_tbf_client *cli)
1052 return cfs_match_nid(cli->tc_nid, &rule->tr_nids);
1055 static void nrs_tbf_nid_rule_fini(struct nrs_tbf_rule *rule)
1057 if (!list_empty(&rule->tr_nids))
1058 cfs_free_nidlist(&rule->tr_nids);
1059 LASSERT(rule->tr_nids_str != NULL);
1060 OBD_FREE(rule->tr_nids_str, strlen(rule->tr_nids_str) + 1);
1063 static void nrs_tbf_nid_cmd_fini(struct nrs_tbf_cmd *cmd)
1065 if (!list_empty(&cmd->tc_nids))
1066 cfs_free_nidlist(&cmd->tc_nids);
1067 if (cmd->tc_nids_str)
1068 OBD_FREE(cmd->tc_nids_str, strlen(cmd->tc_nids_str) + 1);
1071 static int nrs_tbf_nid_parse(struct nrs_tbf_cmd *cmd, const char *id)
1073 OBD_ALLOC(cmd->tc_nids_str, strlen(id) + 1);
1074 if (cmd->tc_nids_str == NULL)
1077 memcpy(cmd->tc_nids_str, id, strlen(id));
1079 /* parse NID list */
1080 if (cfs_parse_nidlist(cmd->tc_nids_str,
1081 strlen(cmd->tc_nids_str),
1082 &cmd->tc_nids) <= 0) {
1083 nrs_tbf_nid_cmd_fini(cmd);
1090 static struct nrs_tbf_ops nrs_tbf_nid_ops = {
1091 .o_name = NRS_TBF_TYPE_NID,
1092 .o_startup = nrs_tbf_nid_startup,
1093 .o_cli_find = nrs_tbf_nid_cli_find,
1094 .o_cli_findadd = nrs_tbf_nid_cli_findadd,
1095 .o_cli_put = nrs_tbf_nid_cli_put,
1096 .o_cli_init = nrs_tbf_nid_cli_init,
1097 .o_rule_init = nrs_tbf_nid_rule_init,
1098 .o_rule_dump = nrs_tbf_nid_rule_dump,
1099 .o_rule_match = nrs_tbf_nid_rule_match,
1100 .o_rule_fini = nrs_tbf_nid_rule_fini,
1104 * Is called before the policy transitions into
1105 * ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED; allocates and initializes a
1106 * policy-specific private data structure.
1108 * \param[in] policy The policy to start
1110 * \retval -ENOMEM OOM error
1113 * \see nrs_policy_register()
1114 * \see nrs_policy_ctl()
1116 static int nrs_tbf_start(struct ptlrpc_nrs_policy *policy, char *arg)
1118 struct nrs_tbf_head *head;
1119 struct nrs_tbf_ops *ops;
1123 if (arg == NULL || strlen(arg) > NRS_TBF_TYPE_MAX_LEN)
1124 GOTO(out, rc = -EINVAL);
1126 if (strcmp(arg, NRS_TBF_TYPE_NID) == 0) {
1127 ops = &nrs_tbf_nid_ops;
1128 type = NRS_TBF_FLAG_NID;
1129 } else if (strcmp(arg, NRS_TBF_TYPE_JOBID) == 0) {
1130 ops = &nrs_tbf_jobid_ops;
1131 type = NRS_TBF_FLAG_JOBID;
1133 GOTO(out, rc = -ENOTSUPP);
1135 OBD_CPT_ALLOC_PTR(head, nrs_pol2cptab(policy), nrs_pol2cptid(policy));
1137 GOTO(out, rc = -ENOMEM);
1139 memcpy(head->th_type, arg, strlen(arg));
1140 head->th_type[strlen(arg)] = '\0';
1142 head->th_type_flag = type;
1144 head->th_binheap = cfs_binheap_create(&nrs_tbf_heap_ops,
1145 CBH_FLAG_ATOMIC_GROW, 4096, NULL,
1146 nrs_pol2cptab(policy),
1147 nrs_pol2cptid(policy));
1148 if (head->th_binheap == NULL)
1149 GOTO(out_free_head, rc = -ENOMEM);
1151 atomic_set(&head->th_rule_sequence, 0);
1152 spin_lock_init(&head->th_rule_lock);
1153 INIT_LIST_HEAD(&head->th_list);
1154 hrtimer_init(&head->th_timer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
1155 head->th_timer.function = nrs_tbf_timer_cb;
1156 rc = head->th_ops->o_startup(policy, head);
1158 GOTO(out_free_heap, rc);
1160 policy->pol_private = head;
1163 cfs_binheap_destroy(head->th_binheap);
1171 * Is called before the policy transitions into
1172 * ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPED; deallocates the policy-specific
1173 * private data structure.
1175 * \param[in] policy The policy to stop
1177 * \see nrs_policy_stop0()
1179 static void nrs_tbf_stop(struct ptlrpc_nrs_policy *policy)
1181 struct nrs_tbf_head *head = policy->pol_private;
1182 struct ptlrpc_nrs *nrs = policy->pol_nrs;
1183 struct nrs_tbf_rule *rule, *n;
1185 LASSERT(head != NULL);
1186 LASSERT(head->th_cli_hash != NULL);
1187 hrtimer_cancel(&head->th_timer);
1188 /* Should cleanup hash first before free rules */
1189 cfs_hash_putref(head->th_cli_hash);
1190 list_for_each_entry_safe(rule, n, &head->th_list, tr_linkage) {
1191 list_del_init(&rule->tr_linkage);
1192 nrs_tbf_rule_put(rule);
1194 LASSERT(list_empty(&head->th_list));
1195 LASSERT(head->th_binheap != NULL);
1196 LASSERT(cfs_binheap_is_empty(head->th_binheap));
1197 cfs_binheap_destroy(head->th_binheap);
1199 nrs->nrs_throttling = 0;
1200 wake_up(&policy->pol_nrs->nrs_svcpt->scp_waitq);
1204 * Performs a policy-specific ctl function on TBF policy instances; similar
1207 * \param[in] policy the policy instance
1208 * \param[in] opc the opcode
1209 * \param[in,out] arg used for passing parameters and information
1211 * \pre assert_spin_locked(&policy->pol_nrs->->nrs_lock)
1212 * \post assert_spin_locked(&policy->pol_nrs->->nrs_lock)
1214 * \retval 0 operation carried out successfully
1217 static int nrs_tbf_ctl(struct ptlrpc_nrs_policy *policy,
1218 enum ptlrpc_nrs_ctl opc,
1224 assert_spin_locked(&policy->pol_nrs->nrs_lock);
1226 switch ((enum nrs_ctl_tbf)opc) {
1231 * Read RPC rate size of a policy instance.
1233 case NRS_CTL_TBF_RD_RULE: {
1234 struct nrs_tbf_head *head = policy->pol_private;
1235 struct seq_file *m = (struct seq_file *) arg;
1236 struct ptlrpc_service_part *svcpt;
1238 svcpt = policy->pol_nrs->nrs_svcpt;
1239 seq_printf(m, "CPT %d:\n", svcpt->scp_cpt);
1241 rc = nrs_tbf_rule_dump_all(head, m);
1246 * Write RPC rate of a policy instance.
1248 case NRS_CTL_TBF_WR_RULE: {
1249 struct nrs_tbf_head *head = policy->pol_private;
1250 struct nrs_tbf_cmd *cmd;
1252 cmd = (struct nrs_tbf_cmd *)arg;
1253 rc = nrs_tbf_command(policy,
1264 * Is called for obtaining a TBF policy resource.
1266 * \param[in] policy The policy on which the request is being asked for
1267 * \param[in] nrq The request for which resources are being taken
1268 * \param[in] parent Parent resource, unused in this policy
1269 * \param[out] resp Resources references are placed in this array
1270 * \param[in] moving_req Signifies limited caller context; unused in this
1274 * \see nrs_resource_get_safe()
1276 static int nrs_tbf_res_get(struct ptlrpc_nrs_policy *policy,
1277 struct ptlrpc_nrs_request *nrq,
1278 const struct ptlrpc_nrs_resource *parent,
1279 struct ptlrpc_nrs_resource **resp,
1282 struct nrs_tbf_head *head;
1283 struct nrs_tbf_client *cli;
1284 struct nrs_tbf_client *tmp;
1285 struct ptlrpc_request *req;
1287 if (parent == NULL) {
1288 *resp = &((struct nrs_tbf_head *)policy->pol_private)->th_res;
1292 head = container_of(parent, struct nrs_tbf_head, th_res);
1293 req = container_of(nrq, struct ptlrpc_request, rq_nrq);
1294 cli = head->th_ops->o_cli_find(head, req);
1296 spin_lock(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1297 LASSERT(cli->tc_rule);
1298 if (cli->tc_rule_sequence !=
1299 atomic_read(&head->th_rule_sequence) ||
1300 cli->tc_rule->tr_flags & NTRS_STOPPING) {
1301 struct nrs_tbf_rule *rule;
1303 rule = nrs_tbf_rule_match(head, cli);
1304 if (rule != cli->tc_rule)
1305 nrs_tbf_cli_reset(head, rule, cli);
1307 nrs_tbf_rule_put(rule);
1308 } else if (cli->tc_rule_generation !=
1309 cli->tc_rule->tr_generation) {
1310 nrs_tbf_cli_reset_value(head, cli);
1312 spin_unlock(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1316 OBD_CPT_ALLOC_GFP(cli, nrs_pol2cptab(policy), nrs_pol2cptid(policy),
1317 sizeof(*cli), moving_req ? GFP_ATOMIC : __GFP_IO);
1320 nrs_tbf_cli_init(head, cli, req);
1321 tmp = head->th_ops->o_cli_findadd(head, cli);
1323 atomic_dec(&cli->tc_ref);
1324 nrs_tbf_cli_fini(cli);
1328 *resp = &cli->tc_res;
1334 * Called when releasing references to the resource hierachy obtained for a
1335 * request for scheduling using the TBF policy.
1337 * \param[in] policy the policy the resource belongs to
1338 * \param[in] res the resource to be released
1340 static void nrs_tbf_res_put(struct ptlrpc_nrs_policy *policy,
1341 const struct ptlrpc_nrs_resource *res)
1343 struct nrs_tbf_head *head;
1344 struct nrs_tbf_client *cli;
1347 * Do nothing for freeing parent, nrs_tbf_net resources
1349 if (res->res_parent == NULL)
1352 cli = container_of(res, struct nrs_tbf_client, tc_res);
1353 head = container_of(res->res_parent, struct nrs_tbf_head, th_res);
1355 head->th_ops->o_cli_put(head, cli);
1359 * Called when getting a request from the TBF policy for handling, or just
1360 * peeking; removes the request from the policy when it is to be handled.
1362 * \param[in] policy The policy
1363 * \param[in] peek When set, signifies that we just want to examine the
1364 * request, and not handle it, so the request is not removed
1366 * \param[in] force Force the policy to return a request; unused in this
1369 * \retval The request to be handled; this is the next request in the TBF
1372 * \see ptlrpc_nrs_req_get_nolock()
1373 * \see nrs_request_get()
1376 struct ptlrpc_nrs_request *nrs_tbf_req_get(struct ptlrpc_nrs_policy *policy,
1377 bool peek, bool force)
1379 struct nrs_tbf_head *head = policy->pol_private;
1380 struct ptlrpc_nrs_request *nrq = NULL;
1381 struct nrs_tbf_client *cli;
1382 struct cfs_binheap_node *node;
1384 assert_spin_locked(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1386 if (!peek && policy->pol_nrs->nrs_throttling)
1389 node = cfs_binheap_root(head->th_binheap);
1390 if (unlikely(node == NULL))
1393 cli = container_of(node, struct nrs_tbf_client, tc_node);
1394 LASSERT(cli->tc_in_heap);
1396 nrq = list_entry(cli->tc_list.next,
1397 struct ptlrpc_nrs_request,
1400 __u64 now = ktime_to_ns(ktime_get());
1405 deadline = cli->tc_check_time +
1407 LASSERT(now >= cli->tc_check_time);
1408 passed = now - cli->tc_check_time;
1409 ntoken = (passed * cli->tc_rpc_rate) / NSEC_PER_SEC;
1410 ntoken += cli->tc_ntoken;
1411 if (ntoken > cli->tc_depth)
1412 ntoken = cli->tc_depth;
1414 struct ptlrpc_request *req;
1415 nrq = list_entry(cli->tc_list.next,
1416 struct ptlrpc_nrs_request,
1418 req = container_of(nrq,
1419 struct ptlrpc_request,
1422 cli->tc_ntoken = ntoken;
1423 cli->tc_check_time = now;
1424 list_del_init(&nrq->nr_u.tbf.tr_list);
1425 if (list_empty(&cli->tc_list)) {
1426 cfs_binheap_remove(head->th_binheap,
1428 cli->tc_in_heap = false;
1430 cfs_binheap_relocate(head->th_binheap,
1434 "NRS start %s request from %s, "
1436 policy->pol_desc->pd_name,
1437 libcfs_id2str(req->rq_peer),
1438 nrq->nr_u.tbf.tr_sequence);
1442 policy->pol_nrs->nrs_throttling = 1;
1443 head->th_deadline = deadline;
1444 time = ktime_set(0, 0);
1445 time = ktime_add_ns(time, deadline);
1446 hrtimer_start(&head->th_timer, time, HRTIMER_MODE_ABS);
1454 * Adds request \a nrq to \a policy's list of queued requests
1456 * \param[in] policy The policy
1457 * \param[in] nrq The request to add
1459 * \retval 0 success; nrs_request_enqueue() assumes this function will always
1462 static int nrs_tbf_req_add(struct ptlrpc_nrs_policy *policy,
1463 struct ptlrpc_nrs_request *nrq)
1465 struct nrs_tbf_head *head;
1466 struct nrs_tbf_client *cli;
1469 assert_spin_locked(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1471 cli = container_of(nrs_request_resource(nrq),
1472 struct nrs_tbf_client, tc_res);
1473 head = container_of(nrs_request_resource(nrq)->res_parent,
1474 struct nrs_tbf_head, th_res);
1475 if (list_empty(&cli->tc_list)) {
1476 LASSERT(!cli->tc_in_heap);
1477 rc = cfs_binheap_insert(head->th_binheap, &cli->tc_node);
1479 cli->tc_in_heap = true;
1480 nrq->nr_u.tbf.tr_sequence = head->th_sequence++;
1481 list_add_tail(&nrq->nr_u.tbf.tr_list,
1483 if (policy->pol_nrs->nrs_throttling) {
1484 __u64 deadline = cli->tc_check_time +
1486 if ((head->th_deadline > deadline) &&
1487 (hrtimer_try_to_cancel(&head->th_timer)
1490 head->th_deadline = deadline;
1491 time = ktime_set(0, 0);
1492 time = ktime_add_ns(time, deadline);
1493 hrtimer_start(&head->th_timer, time,
1499 LASSERT(cli->tc_in_heap);
1500 nrq->nr_u.tbf.tr_sequence = head->th_sequence++;
1501 list_add_tail(&nrq->nr_u.tbf.tr_list,
1508 * Removes request \a nrq from \a policy's list of queued requests.
1510 * \param[in] policy The policy
1511 * \param[in] nrq The request to remove
1513 static void nrs_tbf_req_del(struct ptlrpc_nrs_policy *policy,
1514 struct ptlrpc_nrs_request *nrq)
1516 struct nrs_tbf_head *head;
1517 struct nrs_tbf_client *cli;
1519 assert_spin_locked(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1521 cli = container_of(nrs_request_resource(nrq),
1522 struct nrs_tbf_client, tc_res);
1523 head = container_of(nrs_request_resource(nrq)->res_parent,
1524 struct nrs_tbf_head, th_res);
1526 LASSERT(!list_empty(&nrq->nr_u.tbf.tr_list));
1527 list_del_init(&nrq->nr_u.tbf.tr_list);
1528 if (list_empty(&cli->tc_list)) {
1529 cfs_binheap_remove(head->th_binheap,
1531 cli->tc_in_heap = false;
1533 cfs_binheap_relocate(head->th_binheap,
1539 * Prints a debug statement right before the request \a nrq stops being
1542 * \param[in] policy The policy handling the request
1543 * \param[in] nrq The request being handled
1545 * \see ptlrpc_server_finish_request()
1546 * \see ptlrpc_nrs_req_stop_nolock()
1548 static void nrs_tbf_req_stop(struct ptlrpc_nrs_policy *policy,
1549 struct ptlrpc_nrs_request *nrq)
1551 struct ptlrpc_request *req = container_of(nrq, struct ptlrpc_request,
1554 assert_spin_locked(&policy->pol_nrs->nrs_svcpt->scp_req_lock);
1556 CDEBUG(D_RPCTRACE, "NRS stop %s request from %s, seq: "LPU64"\n",
1557 policy->pol_desc->pd_name, libcfs_id2str(req->rq_peer),
1558 nrq->nr_u.tbf.tr_sequence);
1561 #ifdef CONFIG_PROC_FS
1568 * The maximum RPC rate.
1570 #define LPROCFS_NRS_RATE_MAX 65535
1573 ptlrpc_lprocfs_nrs_tbf_rule_seq_show(struct seq_file *m, void *data)
1575 struct ptlrpc_service *svc = m->private;
1578 seq_printf(m, "regular_requests:\n");
1580 * Perform two separate calls to this as only one of the NRS heads'
1581 * policies may be in the ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED or
1582 * ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPING state.
1584 rc = ptlrpc_nrs_policy_control(svc, PTLRPC_NRS_QUEUE_REG,
1586 NRS_CTL_TBF_RD_RULE,
1590 * -ENOSPC means buf in the parameter m is overflow, return 0
1591 * here to let upper layer function seq_read alloc a larger
1592 * memory area and do this process again.
1594 } else if (rc == -ENOSPC) {
1598 * Ignore -ENODEV as the regular NRS head's policy may be in the
1599 * ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPED state.
1601 } else if (rc != -ENODEV) {
1605 if (!nrs_svc_has_hp(svc))
1608 seq_printf(m, "high_priority_requests:\n");
1609 rc = ptlrpc_nrs_policy_control(svc, PTLRPC_NRS_QUEUE_HP,
1611 NRS_CTL_TBF_RD_RULE,
1615 * -ENOSPC means buf in the parameter m is overflow, return 0
1616 * here to let upper layer function seq_read alloc a larger
1617 * memory area and do this process again.
1619 } else if (rc == -ENOSPC) {
1628 static int nrs_tbf_id_parse(struct nrs_tbf_cmd *cmd, char **val)
1633 token = strsep(val, "}");
1635 GOTO(out, rc = -EINVAL);
1637 if (strlen(token) <= 1 ||
1639 GOTO(out, rc = -EINVAL);
1643 /* Should be followed by ' ' or nothing */
1644 if ((*val)[0] == '\0')
1646 else if ((*val)[0] == ' ')
1649 GOTO(out, rc = -EINVAL);
1651 rc = nrs_tbf_jobid_parse(cmd, token);
1653 cmd->tc_valid_types |= NRS_TBF_FLAG_JOBID;
1655 rc = nrs_tbf_nid_parse(cmd, token);
1657 cmd->tc_valid_types |= NRS_TBF_FLAG_NID;
1659 if (!cmd->tc_valid_types)
1668 static void nrs_tbf_cmd_fini(struct nrs_tbf_cmd *cmd)
1670 if (cmd->tc_valid_types & NRS_TBF_FLAG_JOBID)
1671 nrs_tbf_jobid_cmd_fini(cmd);
1672 if (cmd->tc_valid_types & NRS_TBF_FLAG_NID)
1673 nrs_tbf_nid_cmd_fini(cmd);
1676 static struct nrs_tbf_cmd *
1677 nrs_tbf_parse_cmd(char *buffer, unsigned long count)
1679 static struct nrs_tbf_cmd *cmd;
1687 GOTO(out, rc = -ENOMEM);
1690 token = strsep(&val, " ");
1691 if (val == NULL || strlen(val) == 0)
1692 GOTO(out_free_cmd, rc = -EINVAL);
1694 /* Type of the command */
1695 if (strcmp(token, "start") == 0)
1696 cmd->tc_cmd = NRS_CTL_TBF_START_RULE;
1697 else if (strcmp(token, "stop") == 0)
1698 cmd->tc_cmd = NRS_CTL_TBF_STOP_RULE;
1699 else if (strcmp(token, "change") == 0)
1700 cmd->tc_cmd = NRS_CTL_TBF_CHANGE_RATE;
1702 GOTO(out_free_cmd, rc = -EINVAL);
1704 /* Name of the rule */
1705 token = strsep(&val, " ");
1708 * Stop comand only need name argument,
1709 * But other commands need ID or rate argument.
1711 if (cmd->tc_cmd != NRS_CTL_TBF_STOP_RULE)
1712 GOTO(out_free_cmd, rc = -EINVAL);
1715 for (i = 0; i < strlen(token); i++) {
1716 if ((!isalnum(token[i])) &&
1718 GOTO(out_free_cmd, rc = -EINVAL);
1720 cmd->tc_name = token;
1722 if (cmd->tc_cmd == NRS_CTL_TBF_START_RULE) {
1725 rc = nrs_tbf_id_parse(cmd, &val);
1727 GOTO(out_free_cmd, rc);
1731 if (cmd->tc_cmd == NRS_CTL_TBF_STOP_RULE ||
1732 strlen(val) == 0 || !isdigit(val[0]))
1733 GOTO(out_free_nid, rc = -EINVAL);
1735 cmd->tc_rpc_rate = simple_strtoull(val, NULL, 10);
1736 if (cmd->tc_rpc_rate <= 0 ||
1737 cmd->tc_rpc_rate >= LPROCFS_NRS_RATE_MAX)
1738 GOTO(out_free_nid, rc = -EINVAL);
1740 if (cmd->tc_cmd == NRS_CTL_TBF_CHANGE_RATE)
1741 GOTO(out_free_nid, rc = -EINVAL);
1742 /* No RPC rate given */
1743 cmd->tc_rpc_rate = tbf_rate;
1747 nrs_tbf_cmd_fini(cmd);
1756 extern struct nrs_core nrs_core;
1757 #define LPROCFS_WR_NRS_TBF_MAX_CMD (4096)
1759 ptlrpc_lprocfs_nrs_tbf_rule_seq_write(struct file *file,
1760 const char __user *buffer,
1761 size_t count, loff_t *off)
1763 struct seq_file *m = file->private_data;
1764 struct ptlrpc_service *svc = m->private;
1768 static struct nrs_tbf_cmd *cmd;
1769 enum ptlrpc_nrs_queue_type queue = PTLRPC_NRS_QUEUE_BOTH;
1770 unsigned long length;
1773 OBD_ALLOC(kernbuf, LPROCFS_WR_NRS_TBF_MAX_CMD);
1774 if (kernbuf == NULL)
1775 GOTO(out, rc = -ENOMEM);
1777 if (count > LPROCFS_WR_NRS_TBF_MAX_CMD - 1)
1778 GOTO(out_free_kernbuff, rc = -EINVAL);
1780 if (copy_from_user(kernbuf, buffer, count))
1781 GOTO(out_free_kernbuff, rc = -EFAULT);
1784 token = strsep(&val, " ");
1786 GOTO(out_free_kernbuff, rc = -EINVAL);
1788 if (strcmp(token, "reg") == 0) {
1789 queue = PTLRPC_NRS_QUEUE_REG;
1790 } else if (strcmp(token, "hp") == 0) {
1791 queue = PTLRPC_NRS_QUEUE_HP;
1793 kernbuf[strlen(token)] = ' ';
1796 length = strlen(val);
1799 GOTO(out_free_kernbuff, rc = -EINVAL);
1801 if (queue == PTLRPC_NRS_QUEUE_HP && !nrs_svc_has_hp(svc))
1802 GOTO(out_free_kernbuff, rc = -ENODEV);
1803 else if (queue == PTLRPC_NRS_QUEUE_BOTH && !nrs_svc_has_hp(svc))
1804 queue = PTLRPC_NRS_QUEUE_REG;
1806 cmd = nrs_tbf_parse_cmd(val, length);
1808 GOTO(out_free_kernbuff, rc = PTR_ERR(cmd));
1811 * Serialize NRS core lprocfs operations with policy registration/
1814 mutex_lock(&nrs_core.nrs_mutex);
1815 rc = ptlrpc_nrs_policy_control(svc, queue,
1817 NRS_CTL_TBF_WR_RULE,
1819 mutex_unlock(&nrs_core.nrs_mutex);
1821 nrs_tbf_cmd_fini(cmd);
1824 OBD_FREE(kernbuf, LPROCFS_WR_NRS_TBF_MAX_CMD);
1826 return rc ? rc : count;
1828 LPROC_SEQ_FOPS(ptlrpc_lprocfs_nrs_tbf_rule);
1831 * Initializes a TBF policy's lprocfs interface for service \a svc
1833 * \param[in] svc the service
1836 * \retval != 0 error
1838 static int nrs_tbf_lprocfs_init(struct ptlrpc_service *svc)
1840 struct lprocfs_vars nrs_tbf_lprocfs_vars[] = {
1841 { .name = "nrs_tbf_rule",
1842 .fops = &ptlrpc_lprocfs_nrs_tbf_rule_fops,
1847 if (svc->srv_procroot == NULL)
1850 return lprocfs_add_vars(svc->srv_procroot, nrs_tbf_lprocfs_vars, NULL);
1854 * Cleans up a TBF policy's lprocfs interface for service \a svc
1856 * \param[in] svc the service
1858 static void nrs_tbf_lprocfs_fini(struct ptlrpc_service *svc)
1860 if (svc->srv_procroot == NULL)
1863 lprocfs_remove_proc_entry("nrs_tbf_rule", svc->srv_procroot);
1866 #endif /* CONFIG_PROC_FS */
1869 * TBF policy operations
1871 static const struct ptlrpc_nrs_pol_ops nrs_tbf_ops = {
1872 .op_policy_start = nrs_tbf_start,
1873 .op_policy_stop = nrs_tbf_stop,
1874 .op_policy_ctl = nrs_tbf_ctl,
1875 .op_res_get = nrs_tbf_res_get,
1876 .op_res_put = nrs_tbf_res_put,
1877 .op_req_get = nrs_tbf_req_get,
1878 .op_req_enqueue = nrs_tbf_req_add,
1879 .op_req_dequeue = nrs_tbf_req_del,
1880 .op_req_stop = nrs_tbf_req_stop,
1881 #ifdef CONFIG_PROC_FS
1882 .op_lprocfs_init = nrs_tbf_lprocfs_init,
1883 .op_lprocfs_fini = nrs_tbf_lprocfs_fini,
1888 * TBF policy configuration
1890 struct ptlrpc_nrs_pol_conf nrs_conf_tbf = {
1891 .nc_name = NRS_POL_NAME_TBF,
1892 .nc_ops = &nrs_tbf_ops,
1893 .nc_compat = nrs_policy_compat_all,
1900 #endif /* HAVE_SERVER_SUPPORT */