Whamcloud - gitweb
LU-6325 ptlrpc: make ptlrpcd threads cpt-aware
[fs/lustre-release.git] / lustre / ptlrpc / ptlrpc_internal.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2014, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36
37 /* Intramodule declarations for ptlrpc. */
38
39 #ifndef PTLRPC_INTERNAL_H
40 #define PTLRPC_INTERNAL_H
41
42 #include "../ldlm/ldlm_internal.h"
43
44 struct ldlm_namespace;
45 struct obd_import;
46 struct ldlm_res_id;
47 struct ptlrpc_request_set;
48 extern int test_req_buffer_pressure;
49 extern struct list_head ptlrpc_all_services;
50 extern struct mutex ptlrpc_all_services_mutex;
51 extern struct ptlrpc_nrs_pol_conf nrs_conf_fifo;
52
53 #ifdef HAVE_SERVER_SUPPORT
54 extern struct ptlrpc_nrs_pol_conf nrs_conf_crrn;
55 extern struct ptlrpc_nrs_pol_conf nrs_conf_orr;
56 extern struct ptlrpc_nrs_pol_conf nrs_conf_trr;
57 extern struct ptlrpc_nrs_pol_conf nrs_conf_tbf;
58 #endif /* HAVE_SERVER_SUPPORT */
59
60 /**
61  * \addtogoup nrs
62  * @{
63  */
64 extern struct nrs_core nrs_core;
65
66 extern struct mutex ptlrpcd_mutex;
67 extern struct mutex pinger_mutex;
68
69 int ptlrpc_start_thread(struct ptlrpc_service_part *svcpt, int wait);
70 /* ptlrpcd.c */
71 int ptlrpcd_start(struct ptlrpcd_ctl *pc);
72
73 /* client.c */
74 void ptlrpc_at_adj_net_latency(struct ptlrpc_request *req,
75                                unsigned int service_time);
76 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned npages, unsigned max_brw,
77                                          enum ptlrpc_bulk_op_type type,
78                                          unsigned portal,
79                                          const struct ptlrpc_bulk_frag_ops
80                                                 *ops);
81 int ptlrpc_request_cache_init(void);
82 void ptlrpc_request_cache_fini(void);
83 struct ptlrpc_request *ptlrpc_request_cache_alloc(gfp_t flags);
84 void ptlrpc_request_cache_free(struct ptlrpc_request *req);
85 void ptlrpc_init_xid(void);
86 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
87                             struct ptlrpc_request *req);
88 int ptlrpc_expired_set(void *data);
89 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
90 void ptlrpc_resend_req(struct ptlrpc_request *request);
91 void ptlrpc_set_bulk_mbits(struct ptlrpc_request *req);
92
93 /* events.c */
94 int ptlrpc_init_portals(void);
95 void ptlrpc_exit_portals(void);
96
97 void ptlrpc_request_handle_notconn(struct ptlrpc_request *);
98 void lustre_assert_wire_constants(void);
99 int ptlrpc_import_in_recovery(struct obd_import *imp);
100 int ptlrpc_set_import_discon(struct obd_import *imp, __u32 conn_cnt);
101 void ptlrpc_handle_failed_import(struct obd_import *imp);
102 int ptlrpc_replay_next(struct obd_import *imp, int *inflight);
103 void ptlrpc_initiate_recovery(struct obd_import *imp);
104
105 int lustre_unpack_req_ptlrpc_body(struct ptlrpc_request *req, int offset);
106 int lustre_unpack_rep_ptlrpc_body(struct ptlrpc_request *req, int offset);
107
108 #ifdef CONFIG_PROC_FS
109 void ptlrpc_lprocfs_register_service(struct proc_dir_entry *proc_entry,
110                                      struct ptlrpc_service *svc);
111 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc);
112 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount);
113 void ptlrpc_lprocfs_do_request_stat (struct ptlrpc_request *req,
114                                      long q_usec, long work_usec);
115 #else
116 #define ptlrpc_lprocfs_register_service(params...) do{}while(0)
117 #define ptlrpc_lprocfs_unregister_service(params...) do{}while(0)
118 #define ptlrpc_lprocfs_rpc_sent(params...) do{}while(0)
119 #define ptlrpc_lprocfs_do_request_stat(params...) do{}while(0)
120 #endif /* CONFIG_PROC_FS */
121
122 /* NRS */
123
124 /**
125  * NRS core object.
126  *
127  * Holds NRS core fields.
128  */
129 struct nrs_core {
130         /**
131          * Protects nrs_core::nrs_policies, serializes external policy
132          * registration/unregistration, and NRS core lprocfs operations.
133          */
134         struct mutex nrs_mutex;
135         /**
136          * List of all policy descriptors registered with NRS core; protected
137          * by nrs_core::nrs_mutex.
138          */
139         struct list_head nrs_policies;
140 };
141
142 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
143 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
144
145 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part *svcpt,
146                                struct ptlrpc_request *req, bool hp);
147 void ptlrpc_nrs_req_finalize(struct ptlrpc_request *req);
148 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request *req);
149 void ptlrpc_nrs_req_add(struct ptlrpc_service_part *svcpt,
150                         struct ptlrpc_request *req, bool hp);
151
152 struct ptlrpc_request *
153 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
154                            bool peek, bool force);
155
156 static inline struct ptlrpc_request *
157 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
158                           bool force)
159 {
160         return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
161 }
162
163 static inline struct ptlrpc_request *
164 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part *svcpt, bool hp)
165 {
166         return ptlrpc_nrs_req_get_nolock0(svcpt, hp, true, false);
167 }
168
169 void ptlrpc_nrs_req_del_nolock(struct ptlrpc_request *req);
170 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part *svcpt, bool hp);
171 bool ptlrpc_nrs_req_throttling_nolock(struct ptlrpc_service_part *svcpt,
172                                       bool hp);
173
174 int ptlrpc_nrs_policy_control(const struct ptlrpc_service *svc,
175                               enum ptlrpc_nrs_queue_type queue, char *name,
176                               enum ptlrpc_nrs_ctl opc, bool single, void *arg);
177
178 int ptlrpc_nrs_init(void);
179 void ptlrpc_nrs_fini(void);
180
181 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
182 {
183         return svcpt->scp_nrs_hp != NULL;
184 }
185
186 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
187 {
188         /**
189          * If the first service partition has an HP NRS head, all service
190          * partitions will.
191          */
192         return nrs_svcpt_has_hp(svc->srv_parts[0]);
193 }
194
195 static inline
196 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
197 {
198         LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
199         return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
200 }
201
202 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
203 {
204         return policy->pol_nrs->nrs_svcpt->scp_cpt;
205 }
206
207 static inline
208 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
209 {
210         return policy->pol_nrs->nrs_svcpt->scp_service;
211 }
212
213 static inline
214 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
215 {
216         return policy->pol_nrs->nrs_svcpt;
217 }
218
219 static inline
220 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
221 {
222         return nrs_pol2svc(policy)->srv_cptable;
223 }
224
225 static inline struct ptlrpc_nrs_resource *
226 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
227 {
228         LASSERT(nrq->nr_initialized);
229         LASSERT(!nrq->nr_finalized);
230
231         return nrq->nr_res_ptrs[nrq->nr_res_idx];
232 }
233
234 static inline
235 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
236 {
237         return nrs_request_resource(nrq)->res_policy;
238 }
239
240 #define NRS_LPROCFS_QUANTUM_NAME_REG    "reg_quantum:"
241 #define NRS_LPROCFS_QUANTUM_NAME_HP     "hp_quantum:"
242
243 /**
244  * the maximum size of nrs_crrn_client::cc_quantum and nrs_orr_data::od_quantum.
245  */
246 #define LPROCFS_NRS_QUANTUM_MAX         65535
247
248 /**
249  * Max valid command string is the size of the labels, plus "65535" twice, plus
250  * a separating space character.
251  */
252 #define LPROCFS_NRS_WR_QUANTUM_MAX_CMD                                         \
253  sizeof(NRS_LPROCFS_QUANTUM_NAME_REG __stringify(LPROCFS_NRS_QUANTUM_MAX) " "  \
254         NRS_LPROCFS_QUANTUM_NAME_HP __stringify(LPROCFS_NRS_QUANTUM_MAX))
255
256 /* recovd_thread.c */
257
258 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink);
259
260 /* pers.c */
261 void ptlrpc_fill_bulk_md(lnet_md_t *md, struct ptlrpc_bulk_desc *desc,
262                          int mdcnt);
263
264 /* pack_generic.c */
265 struct ptlrpc_reply_state *
266 lustre_get_emerg_rs(struct ptlrpc_service_part *svcpt);
267 void lustre_put_emerg_rs(struct ptlrpc_reply_state *rs);
268
269 /* pinger.c */
270 int ptlrpc_start_pinger(void);
271 int ptlrpc_stop_pinger(void);
272 void ptlrpc_pinger_sending_on_import(struct obd_import *imp);
273 void ptlrpc_pinger_commit_expected(struct obd_import *imp);
274 void ptlrpc_pinger_wake_up(void);
275 void ptlrpc_ping_import_soon(struct obd_import *imp);
276 int ping_evictor_wake(struct obd_export *exp);
277
278 /* sec_null.c */
279 int  sptlrpc_null_init(void);
280 void sptlrpc_null_fini(void);
281
282 /* sec_plain.c */
283 int  sptlrpc_plain_init(void);
284 void sptlrpc_plain_fini(void);
285
286 /* sec_bulk.c */
287 int  sptlrpc_enc_pool_init(void);
288 void sptlrpc_enc_pool_fini(void);
289 int sptlrpc_proc_enc_pool_seq_show(struct seq_file *m, void *v);
290
291 /* sec_lproc.c */
292 int  sptlrpc_lproc_init(void);
293 void sptlrpc_lproc_fini(void);
294
295 /* sec_gc.c */
296 int sptlrpc_gc_init(void);
297 void sptlrpc_gc_fini(void);
298
299 /* sec_config.c */
300 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
301                                 enum lustre_sec_part to,
302                                 struct obd_uuid *target,
303                                 lnet_nid_t nid,
304                                 struct sptlrpc_flavor *sf);
305 int  sptlrpc_conf_init(void);
306 void sptlrpc_conf_fini(void);
307
308 struct dentry;
309 struct vfsmount;
310 int lustre_rename(struct dentry *dir, struct vfsmount *mnt, char *old_name,
311                   char *new_name);
312
313 /* sec.c */
314 int  sptlrpc_init(void);
315 void sptlrpc_fini(void);
316
317 static inline bool ptlrpc_recoverable_error(int rc)
318 {
319         return (rc == -ENOTCONN || rc == -ENODEV);
320 }
321
322 #ifdef HAVE_SERVER_SUPPORT
323 int tgt_mod_init(void);
324 void tgt_mod_exit(void);
325 int nodemap_mod_init(void);
326 void nodemap_mod_exit(void);
327 #else /* HAVE_SERVER_SUPPORT */
328 static inline int tgt_mod_init(void)
329 {
330         return 0;
331 }
332
333 static inline void tgt_mod_exit(void)
334 {
335         return;
336 }
337
338 static inline int nodemap_mod_init(void)
339 {
340         return 0;
341 }
342
343 static inline void nodemap_mod_exit(void)
344 {
345         return;
346 }
347 #endif /* !HAVE_SERVER_SUPPORT */
348
349 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
350 {
351         if (atomic_dec_and_test(&set->set_refcount))
352                 OBD_FREE_PTR(set);
353 }
354
355 /** initialise ptlrpc common fields */
356 static inline void ptlrpc_req_comm_init(struct ptlrpc_request *req)
357 {
358         spin_lock_init(&req->rq_lock);
359         atomic_set(&req->rq_refcount, 1);
360         INIT_LIST_HEAD(&req->rq_list);
361         INIT_LIST_HEAD(&req->rq_replay_list);
362 }
363
364 /** initialise client side ptlrpc request */
365 static inline void ptlrpc_cli_req_init(struct ptlrpc_request *req)
366 {
367         struct ptlrpc_cli_req *cr = &req->rq_cli;
368
369         ptlrpc_req_comm_init(req);
370
371         req->rq_receiving_reply = 0;
372         req->rq_req_unlinked = req->rq_reply_unlinked = 1;
373
374         INIT_LIST_HEAD(&cr->cr_set_chain);
375         INIT_LIST_HEAD(&cr->cr_ctx_chain);
376         init_waitqueue_head(&cr->cr_reply_waitq);
377         init_waitqueue_head(&cr->cr_set_waitq);
378 }
379
380 /** initialise server side ptlrpc request */
381 static inline void ptlrpc_srv_req_init(struct ptlrpc_request *req)
382 {
383         struct ptlrpc_srv_req *sr = &req->rq_srv;
384
385         ptlrpc_req_comm_init(req);
386         req->rq_srv_req = 1;
387         INIT_LIST_HEAD(&sr->sr_exp_list);
388         INIT_LIST_HEAD(&sr->sr_timed_list);
389         INIT_LIST_HEAD(&sr->sr_hist_list);
390 }
391
392 #endif /* PTLRPC_INTERNAL_H */