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/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 /* Intramodule declarations for ptlrpc. */
35 #ifndef PTLRPC_INTERNAL_H
36 #define PTLRPC_INTERNAL_H
38 #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;
49 #ifdef HAVE_SERVER_SUPPORT
50 extern struct ptlrpc_nrs_pol_conf nrs_conf_crrn;
51 extern struct ptlrpc_nrs_pol_conf nrs_conf_orr;
52 extern struct ptlrpc_nrs_pol_conf nrs_conf_trr;
53 extern struct ptlrpc_nrs_pol_conf nrs_conf_tbf;
54 extern struct ptlrpc_nrs_pol_conf nrs_conf_delay;
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 int ptlrpc_start_thread(struct ptlrpc_service_part *svcpt, int wait);
68 int ptlrpcd_start(struct ptlrpcd_ctl *pc);
71 void ptlrpc_at_adj_net_latency(struct ptlrpc_request *req,
72 unsigned int service_time);
73 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned npages, unsigned max_brw,
74 enum ptlrpc_bulk_op_type type,
76 const struct ptlrpc_bulk_frag_ops
78 int ptlrpc_request_cache_init(void);
79 void ptlrpc_request_cache_fini(void);
80 struct ptlrpc_request *ptlrpc_request_cache_alloc(gfp_t flags);
81 void ptlrpc_request_cache_free(struct ptlrpc_request *req);
82 void ptlrpc_init_xid(void);
83 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
84 struct ptlrpc_request *req);
85 int ptlrpc_expired_set(void *data);
86 time64_t ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
87 void ptlrpc_resend_req(struct ptlrpc_request *request);
88 void ptlrpc_set_bulk_mbits(struct ptlrpc_request *req);
89 void ptlrpc_assign_next_xid_nolock(struct ptlrpc_request *req);
90 __u64 ptlrpc_known_replied_xid(struct obd_import *imp);
91 void ptlrpc_add_unreplied(struct ptlrpc_request *req);
94 int ptlrpc_init_portals(void);
95 void ptlrpc_exit_portals(void);
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);
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);
108 int ptlrpc_sysfs_register_service(struct kset *parent,
109 struct ptlrpc_service *svc);
110 void ptlrpc_sysfs_unregister_service(struct ptlrpc_service *svc);
112 void ptlrpc_ldebugfs_register_service(struct dentry *debugfs_entry,
113 struct ptlrpc_service *svc);
114 #ifdef CONFIG_PROC_FS
115 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc);
116 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount);
117 void ptlrpc_lprocfs_do_request_stat (struct ptlrpc_request *req,
118 long q_usec, long work_usec);
120 #define ptlrpc_lprocfs_unregister_service(params...) do{}while(0)
121 #define ptlrpc_lprocfs_rpc_sent(params...) do{}while(0)
122 #define ptlrpc_lprocfs_do_request_stat(params...) do{}while(0)
123 #endif /* CONFIG_PROC_FS */
130 * Holds NRS core fields.
134 * Protects nrs_core::nrs_policies, serializes external policy
135 * registration/unregistration, and NRS core lprocfs operations.
137 struct mutex nrs_mutex;
139 * List of all policy descriptors registered with NRS core; protected
140 * by nrs_core::nrs_mutex.
142 struct list_head nrs_policies;
145 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
146 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
148 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part *svcpt,
149 struct ptlrpc_request *req, bool hp);
150 void ptlrpc_nrs_req_finalize(struct ptlrpc_request *req);
151 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request *req);
152 void ptlrpc_nrs_req_add(struct ptlrpc_service_part *svcpt,
153 struct ptlrpc_request *req, bool hp);
155 struct ptlrpc_request *
156 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
157 bool peek, bool force);
159 static inline struct ptlrpc_request *
160 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
163 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
166 static inline struct ptlrpc_request *
167 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part *svcpt, bool hp)
169 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, true, false);
172 void ptlrpc_nrs_req_del_nolock(struct ptlrpc_request *req);
173 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part *svcpt, bool hp);
174 bool ptlrpc_nrs_req_throttling_nolock(struct ptlrpc_service_part *svcpt,
177 int ptlrpc_nrs_policy_control(const struct ptlrpc_service *svc,
178 enum ptlrpc_nrs_queue_type queue, char *name,
179 enum ptlrpc_nrs_ctl opc, bool single, void *arg);
181 int ptlrpc_nrs_init(void);
182 void ptlrpc_nrs_fini(void);
184 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
186 return svcpt->scp_nrs_hp != NULL;
189 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
192 * If the first service partition has an HP NRS head, all service
195 return nrs_svcpt_has_hp(svc->srv_parts[0]);
199 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
201 LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
202 return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
205 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
207 return policy->pol_nrs->nrs_svcpt->scp_cpt;
211 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
213 return policy->pol_nrs->nrs_svcpt->scp_service;
217 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
219 return policy->pol_nrs->nrs_svcpt;
223 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
225 return nrs_pol2svc(policy)->srv_cptable;
228 static inline struct ptlrpc_nrs_resource *
229 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
231 LASSERT(nrq->nr_initialized);
232 LASSERT(!nrq->nr_finalized);
234 return nrq->nr_res_ptrs[nrq->nr_res_idx];
238 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
240 return nrs_request_resource(nrq)->res_policy;
243 #define NRS_LPROCFS_QUANTUM_NAME_REG "reg_quantum:"
244 #define NRS_LPROCFS_QUANTUM_NAME_HP "hp_quantum:"
247 * the maximum size of nrs_crrn_client::cc_quantum and nrs_orr_data::od_quantum.
249 #define LPROCFS_NRS_QUANTUM_MAX 65535
252 * Max valid command string is the size of the labels, plus "65535" twice, plus
253 * a separating space character.
255 #define LPROCFS_NRS_WR_QUANTUM_MAX_CMD \
256 sizeof(NRS_LPROCFS_QUANTUM_NAME_REG __stringify(LPROCFS_NRS_QUANTUM_MAX) " " \
257 NRS_LPROCFS_QUANTUM_NAME_HP __stringify(LPROCFS_NRS_QUANTUM_MAX))
259 /* recovd_thread.c */
261 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink);
264 void ptlrpc_fill_bulk_md(struct lnet_md *md, struct ptlrpc_bulk_desc *desc,
268 struct ptlrpc_reply_state *
269 lustre_get_emerg_rs(struct ptlrpc_service_part *svcpt);
270 void lustre_put_emerg_rs(struct ptlrpc_reply_state *rs);
273 int ptlrpc_start_pinger(void);
274 int ptlrpc_stop_pinger(void);
275 void ptlrpc_pinger_sending_on_import(struct obd_import *imp);
276 void ptlrpc_pinger_commit_expected(struct obd_import *imp);
277 void ptlrpc_pinger_wake_up(void);
278 void ptlrpc_ping_import_soon(struct obd_import *imp);
279 int ping_evictor_wake(struct obd_export *exp);
282 int sptlrpc_null_init(void);
283 void sptlrpc_null_fini(void);
286 int sptlrpc_plain_init(void);
287 void sptlrpc_plain_fini(void);
290 int sptlrpc_enc_pool_init(void);
291 void sptlrpc_enc_pool_fini(void);
292 int sptlrpc_proc_enc_pool_seq_show(struct seq_file *m, void *v);
295 int sptlrpc_lproc_init(void);
296 void sptlrpc_lproc_fini(void);
299 int sptlrpc_gc_init(void);
300 void sptlrpc_gc_fini(void);
303 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
304 enum lustre_sec_part to,
305 struct obd_uuid *target,
307 struct sptlrpc_flavor *sf);
308 int sptlrpc_conf_init(void);
309 void sptlrpc_conf_fini(void);
312 int sptlrpc_init(void);
313 void sptlrpc_fini(void);
316 __u32 __req_capsule_offset(const struct req_capsule *pill,
317 const struct req_msg_field *field,
318 enum req_location loc);
320 static inline bool ptlrpc_recoverable_error(int rc)
322 return (rc == -ENOTCONN || rc == -ENODEV);
325 #ifdef HAVE_SERVER_SUPPORT
326 int tgt_mod_init(void);
327 void tgt_mod_exit(void);
328 int nodemap_mod_init(void);
329 void nodemap_mod_exit(void);
330 #else /* HAVE_SERVER_SUPPORT */
331 static inline int tgt_mod_init(void)
336 static inline void tgt_mod_exit(void)
341 static inline int nodemap_mod_init(void)
346 static inline void nodemap_mod_exit(void)
350 #endif /* !HAVE_SERVER_SUPPORT */
352 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
354 if (atomic_dec_and_test(&set->set_refcount))
358 /** initialise ptlrpc common fields */
359 static inline void ptlrpc_req_comm_init(struct ptlrpc_request *req)
361 spin_lock_init(&req->rq_lock);
362 spin_lock_init(&req->rq_early_free_lock);
363 atomic_set(&req->rq_refcount, 1);
364 INIT_LIST_HEAD(&req->rq_list);
365 INIT_LIST_HEAD(&req->rq_replay_list);
368 /** initialise client side ptlrpc request */
369 static inline void ptlrpc_cli_req_init(struct ptlrpc_request *req)
371 struct ptlrpc_cli_req *cr = &req->rq_cli;
373 ptlrpc_req_comm_init(req);
375 req->rq_receiving_reply = 0;
376 req->rq_req_unlinked = req->rq_reply_unlinked = 1;
378 INIT_LIST_HEAD(&cr->cr_set_chain);
379 INIT_LIST_HEAD(&cr->cr_ctx_chain);
380 INIT_LIST_HEAD(&cr->cr_unreplied_list);
381 init_waitqueue_head(&cr->cr_reply_waitq);
382 init_waitqueue_head(&cr->cr_set_waitq);
385 /** initialise server side ptlrpc request */
386 static inline void ptlrpc_srv_req_init(struct ptlrpc_request *req)
388 struct ptlrpc_srv_req *sr = &req->rq_srv;
390 ptlrpc_req_comm_init(req);
392 INIT_LIST_HEAD(&sr->sr_exp_list);
393 INIT_LIST_HEAD(&sr->sr_timed_list);
394 INIT_LIST_HEAD(&sr->sr_hist_list);
397 static inline bool ptlrpc_req_is_connect(struct ptlrpc_request *req)
399 if (lustre_msg_get_opc(req->rq_reqmsg) == MDS_CONNECT ||
400 lustre_msg_get_opc(req->rq_reqmsg) == OST_CONNECT ||
401 lustre_msg_get_opc(req->rq_reqmsg) == MGS_CONNECT)
407 static inline bool ptlrpc_req_is_disconnect(struct ptlrpc_request *req)
409 if (lustre_msg_get_opc(req->rq_reqmsg) == MDS_DISCONNECT ||
410 lustre_msg_get_opc(req->rq_reqmsg) == OST_DISCONNECT ||
411 lustre_msg_get_opc(req->rq_reqmsg) == MGS_DISCONNECT)
417 #endif /* PTLRPC_INTERNAL_H */