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.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; If not, see
17 * http://www.gnu.org/licenses/gpl-2.0.html
22 * Copyright (C) 2013 DataDirect Networks, Inc.
24 * Copyright (c) 2014, Intel Corporation.
28 * Network Request Scheduler (NRS) Token Bucket Filter(TBF) policy
32 #ifndef _LUSTRE_NRS_TBF_H
33 #define _LUSTRE_NRS_TBF_H
45 struct nrs_tbf_jobid {
47 struct list_head tj_linkage;
50 struct nrs_tbf_client {
51 /** Resource object for policy instance. */
52 struct ptlrpc_nrs_resource tc_res;
53 /** Node in the hash table. */
54 struct hlist_node tc_hnode;
55 /** NID of the client. */
57 /** Jobid of the client. */
58 char tc_jobid[LUSTRE_JOBID_SIZE];
59 /** Reference number of the client. */
61 /** Lock to protect rule and linkage. */
62 spinlock_t tc_rule_lock;
63 /** Linkage to rule. */
64 struct list_head tc_linkage;
65 /** Pointer to rule. */
66 struct nrs_tbf_rule *tc_rule;
67 /** Generation of the rule matched. */
68 __u64 tc_rule_generation;
69 /** Limit of RPC rate. */
71 /** Time to wait for next token. */
73 /** RPC token number. */
75 /** Token bucket depth. */
77 /** Time check-point. */
79 /** List of queued requests. */
80 struct list_head tc_list;
81 /** Node in binary heap. */
82 struct cfs_binheap_node tc_node;
83 /** Whether the client is in heap. */
85 /** Sequence of the newest rule. */
86 __u32 tc_rule_sequence;
88 * Linkage into LRU list. Protected bucket lock of
89 * nrs_tbf_head::th_cli_hash.
91 struct list_head tc_lru;
94 #define MAX_TBF_NAME (16)
96 #define NTRS_STOPPING 0x0000001
97 #define NTRS_DEFAULT 0x0000002
100 /** Name of the rule. */
101 char tr_name[MAX_TBF_NAME];
102 /** Head belongs to. */
103 struct nrs_tbf_head *tr_head;
104 /** Likage to head. */
105 struct list_head tr_linkage;
106 /** Nid list of the rule. */
107 struct list_head tr_nids;
108 /** Nid list string of the rule.*/
110 /** Jobid list of the rule. */
111 struct list_head tr_jobids;
112 /** Jobid list string of the rule.*/
116 /** Time to wait for next token. */
118 /** Token bucket depth. */
120 /** Lock to protect the list of clients. */
121 spinlock_t tr_rule_lock;
122 /** List of client. */
123 struct list_head tr_cli_list;
124 /** Flags of the rule. */
126 /** Usage Reference count taken on the rule. */
128 /** Generation of the rule. */
134 int (*o_startup)(struct ptlrpc_nrs_policy *, struct nrs_tbf_head *);
135 struct nrs_tbf_client *(*o_cli_find)(struct nrs_tbf_head *,
136 struct ptlrpc_request *);
137 struct nrs_tbf_client *(*o_cli_findadd)(struct nrs_tbf_head *,
138 struct nrs_tbf_client *);
139 void (*o_cli_put)(struct nrs_tbf_head *, struct nrs_tbf_client *);
140 void (*o_cli_init)(struct nrs_tbf_client *, struct ptlrpc_request *);
141 int (*o_rule_init)(struct ptlrpc_nrs_policy *,
142 struct nrs_tbf_rule *,
143 struct nrs_tbf_cmd *);
144 int (*o_rule_dump)(struct nrs_tbf_rule *, struct seq_file *);
145 int (*o_rule_match)(struct nrs_tbf_rule *,
146 struct nrs_tbf_client *);
147 void (*o_rule_fini)(struct nrs_tbf_rule *);
150 #define NRS_TBF_TYPE_JOBID "jobid"
151 #define NRS_TBF_TYPE_NID "nid"
152 #define NRS_TBF_TYPE_MAX_LEN 20
153 #define NRS_TBF_FLAG_INVALID 0
154 #define NRS_TBF_FLAG_JOBID 0x0000001
155 #define NRS_TBF_FLAG_NID 0x0000002
157 struct nrs_tbf_bucket {
159 * LRU list, updated on each access to client. Protected by
160 * bucket lock of nrs_tbf_head::th_cli_hash.
162 struct list_head ntb_lru;
166 * Private data structure for the TBF policy
168 struct nrs_tbf_head {
170 * Resource object for policy instance.
172 struct ptlrpc_nrs_resource th_res;
176 struct list_head th_list;
178 * Lock to protect the list of rules.
180 spinlock_t th_rule_lock;
182 * Generation of rules.
184 atomic_t th_rule_sequence;
188 struct nrs_tbf_rule *th_rule;
190 * Timer for next token.
192 struct hrtimer th_timer;
194 * Deadline of the timer.
198 * Sequence of requests.
204 struct cfs_binheap *th_binheap;
208 struct cfs_hash *th_cli_hash;
210 * Type of TBF policy.
212 char th_type[NRS_TBF_TYPE_MAX_LEN + 1];
216 struct nrs_tbf_ops *th_ops;
222 * Index of bucket on hash table while purging.
227 enum nrs_tbf_cmd_type {
228 NRS_CTL_TBF_START_RULE = 0,
229 NRS_CTL_TBF_STOP_RULE,
230 NRS_CTL_TBF_CHANGE_RULE,
234 enum nrs_tbf_cmd_type tc_cmd;
237 struct nrs_tbf_cmd_start {
239 struct list_head ts_nids;
241 struct list_head ts_jobids;
246 struct nrs_tbf_cmd_change {
256 struct list_head tr_list;
258 * Sequence of the request.
264 * TBF policy operations.
268 * Read the the data of a TBF policy.
270 NRS_CTL_TBF_RD_RULE = PTLRPC_NRS_CTL_1ST_POL_SPEC,
272 * Write the the data of a TBF policy.
276 * Read the TBF policy type preset by proc entry "nrs_policies".
278 NRS_CTL_TBF_RD_TYPE_FLAG,