4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
32 /* Intramodule declarations for ptlrpc. */
34 #ifndef PTLRPC_INTERNAL_H
35 #define PTLRPC_INTERNAL_H
37 #include "../ldlm/ldlm_internal.h"
40 struct ldlm_namespace;
43 struct ptlrpc_request_set;
44 extern int test_req_buffer_pressure;
45 extern struct list_head ptlrpc_all_services;
46 extern struct mutex ptlrpc_all_services_mutex;
47 extern struct ptlrpc_nrs_pol_conf nrs_conf_fifo;
48 extern struct ptlrpc_nrs_pol_conf nrs_conf_delay;
50 #ifdef HAVE_SERVER_SUPPORT
51 extern struct ptlrpc_nrs_pol_conf nrs_conf_crrn;
52 extern struct ptlrpc_nrs_pol_conf nrs_conf_orr;
53 extern struct ptlrpc_nrs_pol_conf nrs_conf_trr;
54 extern struct ptlrpc_nrs_pol_conf nrs_conf_tbf;
55 #endif /* HAVE_SERVER_SUPPORT */
61 extern struct nrs_core nrs_core;
63 extern struct mutex ptlrpcd_mutex;
64 extern struct mutex pinger_mutex;
66 extern lnet_handler_t ptlrpc_handler;
67 extern struct percpu_ref ptlrpc_pending;
70 int ptlrpcd_start(struct ptlrpcd_ctl *pc);
73 void ptlrpc_at_adj_net_latency(struct ptlrpc_request *req,
74 timeout_t service_timeout);
75 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned npages, unsigned max_brw,
76 enum ptlrpc_bulk_op_type type,
78 const struct ptlrpc_bulk_frag_ops
80 int ptlrpc_request_cache_init(void);
81 void ptlrpc_request_cache_fini(void);
82 struct ptlrpc_request *ptlrpc_request_cache_alloc(gfp_t flags);
83 void ptlrpc_request_cache_free(struct ptlrpc_request *req);
84 void ptlrpc_init_xid(void);
85 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
86 struct ptlrpc_request *req);
87 void ptlrpc_expired_set(struct ptlrpc_request_set *set);
88 time64_t ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
89 void ptlrpc_resend_req(struct ptlrpc_request *request);
90 void ptlrpc_set_mbits(struct ptlrpc_request *req);
91 void ptlrpc_assign_next_xid_nolock(struct ptlrpc_request *req);
92 __u64 ptlrpc_known_replied_xid(struct obd_import *imp);
93 void ptlrpc_add_unreplied(struct ptlrpc_request *req);
96 int ptlrpc_init_portals(void);
97 void ptlrpc_exit_portals(void);
99 void ptlrpc_request_handle_notconn(struct ptlrpc_request *);
100 void lustre_assert_wire_constants(void);
101 bool ptlrpc_import_in_recovery(struct obd_import *imp);
102 bool ptlrpc_import_in_recovery_disconnect(struct obd_import *imp, bool d);
103 int ptlrpc_set_import_discon(struct obd_import *imp, __u32 conn_cnt,
105 void ptlrpc_handle_failed_import(struct obd_import *imp);
106 int ptlrpc_replay_next(struct obd_import *imp, int *inflight);
108 int lustre_unpack_req_ptlrpc_body(struct ptlrpc_request *req, int offset);
109 int lustre_unpack_rep_ptlrpc_body(struct ptlrpc_request *req, int offset);
111 int ptlrpc_sysfs_register_service(struct kset *parent,
112 struct ptlrpc_service *svc);
113 void ptlrpc_sysfs_unregister_service(struct ptlrpc_service *svc);
115 void ptlrpc_ldebugfs_register_service(struct dentry *debugfs_entry,
116 struct ptlrpc_service *svc);
117 #ifdef CONFIG_PROC_FS
118 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc);
119 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount);
120 void ptlrpc_lprocfs_do_request_stat (struct ptlrpc_request *req,
121 long q_usec, long work_usec);
123 #define ptlrpc_lprocfs_unregister_service(params...) do{}while(0)
124 #define ptlrpc_lprocfs_rpc_sent(params...) do{}while(0)
125 #define ptlrpc_lprocfs_do_request_stat(params...) do{}while(0)
126 #endif /* CONFIG_PROC_FS */
133 * Holds NRS core fields.
137 * Protects nrs_core::nrs_policies, serializes external policy
138 * registration/unregistration, and NRS core lprocfs operations.
140 struct mutex nrs_mutex;
142 * List of all policy descriptors registered with NRS core; protected
143 * by nrs_core::nrs_mutex.
145 struct list_head nrs_policies;
148 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
149 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
151 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part *svcpt,
152 struct ptlrpc_request *req, bool hp);
153 void ptlrpc_nrs_req_finalize(struct ptlrpc_request *req);
154 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request *req);
155 void ptlrpc_nrs_req_add(struct ptlrpc_service_part *svcpt,
156 struct ptlrpc_request *req, bool hp);
158 struct ptlrpc_request *
159 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
160 bool peek, bool force);
162 static inline struct ptlrpc_request *
163 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
166 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
169 static inline struct ptlrpc_request *
170 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part *svcpt, bool hp)
172 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, true, false);
175 void ptlrpc_nrs_req_del_nolock(struct ptlrpc_request *req);
176 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part *svcpt, bool hp);
177 bool ptlrpc_nrs_req_throttling_nolock(struct ptlrpc_service_part *svcpt,
180 int ptlrpc_nrs_policy_control(const struct ptlrpc_service *svc,
181 enum ptlrpc_nrs_queue_type queue, char *name,
182 enum ptlrpc_nrs_ctl opc, bool single, void *arg);
184 int ptlrpc_nrs_init(void);
185 void ptlrpc_nrs_fini(void);
187 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
189 return svcpt->scp_nrs_hp != NULL;
192 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
195 * If the first service partition has an HP NRS head, all service
198 return nrs_svcpt_has_hp(svc->srv_parts[0]);
202 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
204 LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
205 return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
208 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
210 return policy->pol_nrs->nrs_svcpt->scp_cpt;
214 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
216 return policy->pol_nrs->nrs_svcpt->scp_service;
220 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
222 return policy->pol_nrs->nrs_svcpt;
226 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
228 return nrs_pol2svc(policy)->srv_cptable;
231 static inline struct ptlrpc_nrs_resource *
232 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
234 LASSERT(nrq->nr_initialized);
235 LASSERT(!nrq->nr_finalized);
237 return nrq->nr_res_ptrs[nrq->nr_res_idx];
241 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
243 return nrs_request_resource(nrq)->res_policy;
246 #define NRS_LPROCFS_QUANTUM_NAME_REG "reg_quantum:"
247 #define NRS_LPROCFS_QUANTUM_NAME_HP "hp_quantum:"
250 * the maximum size of nrs_crrn_client::cc_quantum and nrs_orr_data::od_quantum.
252 #define LPROCFS_NRS_QUANTUM_MAX 65535
255 * Max valid command string is the size of the labels, plus "65535" twice, plus
256 * a separating space character.
258 #define LPROCFS_NRS_WR_QUANTUM_MAX_CMD \
259 sizeof(NRS_LPROCFS_QUANTUM_NAME_REG __stringify(LPROCFS_NRS_QUANTUM_MAX) " " \
260 NRS_LPROCFS_QUANTUM_NAME_HP __stringify(LPROCFS_NRS_QUANTUM_MAX))
262 /* recovd_thread.c */
264 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink);
267 void ptlrpc_fill_bulk_md(struct lnet_md *md, struct ptlrpc_bulk_desc *desc,
271 struct ptlrpc_reply_state *
272 lustre_get_emerg_rs(struct ptlrpc_service_part *svcpt);
273 void lustre_put_emerg_rs(struct ptlrpc_reply_state *rs);
274 void lustre_msg_early_size_init(void); /* just for init */
277 int ptlrpc_start_pinger(void);
278 int ptlrpc_stop_pinger(void);
279 void ptlrpc_pinger_sending_on_import(struct obd_import *imp);
280 void ptlrpc_pinger_commit_expected(struct obd_import *imp);
281 void ptlrpc_pinger_wake_up(void);
282 void ptlrpc_ping_import_soon(struct obd_import *imp);
283 int ping_evictor_wake(struct obd_export *exp);
286 int sptlrpc_null_init(void);
287 void sptlrpc_null_fini(void);
290 int sptlrpc_plain_init(void);
291 void sptlrpc_plain_fini(void);
294 int sptlrpc_enc_pool_init(void);
295 void sptlrpc_enc_pool_fini(void);
296 int encrypt_page_pools_seq_show(struct seq_file *m, void *v);
297 int page_pools_seq_show(struct seq_file *m, void *v);
300 int sptlrpc_lproc_init(void);
301 void sptlrpc_lproc_fini(void);
304 int sptlrpc_gc_init(void);
305 void sptlrpc_gc_fini(void);
308 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
309 enum lustre_sec_part to,
310 struct obd_uuid *target,
311 struct lnet_nid *nid,
312 struct sptlrpc_flavor *sf);
313 int sptlrpc_conf_init(void);
314 void sptlrpc_conf_fini(void);
317 int sptlrpc_init(void);
318 void sptlrpc_fini(void);
321 __u32 __req_capsule_offset(const struct req_capsule *pill,
322 const struct req_msg_field *field,
323 enum req_location loc);
325 static inline bool ptlrpc_recoverable_error(int rc)
327 return (rc == -ENOTCONN || rc == -ENODEV);
330 #ifdef HAVE_SERVER_SUPPORT
331 int tgt_mod_init(void);
332 void tgt_mod_exit(void);
333 int nodemap_mod_init(void);
334 void nodemap_mod_exit(void);
335 #endif /* HAVE_SERVER_SUPPORT */
337 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
339 if (atomic_dec_and_test(&set->set_refcount))
343 /** initialise ptlrpc common fields */
344 static inline void ptlrpc_req_comm_init(struct ptlrpc_request *req)
346 spin_lock_init(&req->rq_lock);
347 spin_lock_init(&req->rq_early_free_lock);
348 atomic_set(&req->rq_refcount, 1);
349 INIT_LIST_HEAD(&req->rq_list);
350 INIT_LIST_HEAD(&req->rq_replay_list);
353 /** initialise client side ptlrpc request */
354 static inline void ptlrpc_cli_req_init(struct ptlrpc_request *req)
356 struct ptlrpc_cli_req *cr = &req->rq_cli;
358 ptlrpc_req_comm_init(req);
360 req->rq_receiving_reply = 0;
361 req->rq_req_unlinked = req->rq_reply_unlinked = 1;
364 INIT_LIST_HEAD(&cr->cr_set_chain);
365 INIT_LIST_HEAD(&cr->cr_ctx_chain);
366 INIT_LIST_HEAD(&cr->cr_unreplied_list);
367 init_waitqueue_head(&cr->cr_reply_waitq);
368 init_waitqueue_head(&cr->cr_set_waitq);
371 /** initialise server side ptlrpc request */
372 static inline void ptlrpc_srv_req_init(struct ptlrpc_request *req)
374 struct ptlrpc_srv_req *sr = &req->rq_srv;
376 ptlrpc_req_comm_init(req);
378 INIT_LIST_HEAD(&sr->sr_exp_list);
379 INIT_LIST_HEAD(&sr->sr_timed_list);
380 INIT_LIST_HEAD(&sr->sr_hist_list);
383 static inline bool ptlrpc_req_is_connect(struct ptlrpc_request *req)
385 if (lustre_msg_get_opc(req->rq_reqmsg) == MDS_CONNECT ||
386 lustre_msg_get_opc(req->rq_reqmsg) == OST_CONNECT ||
387 lustre_msg_get_opc(req->rq_reqmsg) == MGS_CONNECT)
393 static inline bool ptlrpc_req_is_disconnect(struct ptlrpc_request *req)
395 if (lustre_msg_get_opc(req->rq_reqmsg) == MDS_DISCONNECT ||
396 lustre_msg_get_opc(req->rq_reqmsg) == OST_DISCONNECT ||
397 lustre_msg_get_opc(req->rq_reqmsg) == MGS_DISCONNECT)
403 static inline void do_pack_body(struct ptlrpc_request *req)
405 struct mdt_body *b = req_capsule_client_get(&req->rq_pill,
412 b->mbo_eadatasize = 0;
415 b->mbo_uid = from_kuid(&init_user_ns, current_uid());
416 b->mbo_gid = from_kgid(&init_user_ns, current_gid());
417 b->mbo_fsuid = from_kuid(&init_user_ns, current_fsuid());
418 b->mbo_fsgid = from_kgid(&init_user_ns, current_fsgid());
419 b->mbo_capability = ll_capability_u32(current_cap());
422 #endif /* PTLRPC_INTERNAL_H */