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, 2015, 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 int 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 #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);
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 */
127 * Holds NRS core fields.
131 * Protects nrs_core::nrs_policies, serializes external policy
132 * registration/unregistration, and NRS core lprocfs operations.
134 struct mutex nrs_mutex;
136 * List of all policy descriptors registered with NRS core; protected
137 * by nrs_core::nrs_mutex.
139 struct list_head nrs_policies;
142 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
143 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
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);
152 struct ptlrpc_request *
153 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
154 bool peek, bool force);
156 static inline struct ptlrpc_request *
157 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
160 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
163 static inline struct ptlrpc_request *
164 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part *svcpt, bool hp)
166 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, true, false);
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,
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);
178 int ptlrpc_nrs_init(void);
179 void ptlrpc_nrs_fini(void);
181 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
183 return svcpt->scp_nrs_hp != NULL;
186 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
189 * If the first service partition has an HP NRS head, all service
192 return nrs_svcpt_has_hp(svc->srv_parts[0]);
196 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
198 LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
199 return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
202 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
204 return policy->pol_nrs->nrs_svcpt->scp_cpt;
208 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
210 return policy->pol_nrs->nrs_svcpt->scp_service;
214 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
216 return policy->pol_nrs->nrs_svcpt;
220 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
222 return nrs_pol2svc(policy)->srv_cptable;
225 static inline struct ptlrpc_nrs_resource *
226 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
228 LASSERT(nrq->nr_initialized);
229 LASSERT(!nrq->nr_finalized);
231 return nrq->nr_res_ptrs[nrq->nr_res_idx];
235 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
237 return nrs_request_resource(nrq)->res_policy;
240 #define NRS_LPROCFS_QUANTUM_NAME_REG "reg_quantum:"
241 #define NRS_LPROCFS_QUANTUM_NAME_HP "hp_quantum:"
244 * the maximum size of nrs_crrn_client::cc_quantum and nrs_orr_data::od_quantum.
246 #define LPROCFS_NRS_QUANTUM_MAX 65535
249 * Max valid command string is the size of the labels, plus "65535" twice, plus
250 * a separating space character.
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))
256 /* recovd_thread.c */
258 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink);
261 void ptlrpc_fill_bulk_md(struct lnet_md *md, struct ptlrpc_bulk_desc *desc,
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);
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);
279 int sptlrpc_null_init(void);
280 void sptlrpc_null_fini(void);
283 int sptlrpc_plain_init(void);
284 void sptlrpc_plain_fini(void);
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);
292 int sptlrpc_lproc_init(void);
293 void sptlrpc_lproc_fini(void);
296 int sptlrpc_gc_init(void);
297 void sptlrpc_gc_fini(void);
300 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
301 enum lustre_sec_part to,
302 struct obd_uuid *target,
304 struct sptlrpc_flavor *sf);
305 int sptlrpc_conf_init(void);
306 void sptlrpc_conf_fini(void);
309 int sptlrpc_init(void);
310 void sptlrpc_fini(void);
313 __u32 __req_capsule_offset(const struct req_capsule *pill,
314 const struct req_msg_field *field,
315 enum req_location loc);
317 static inline bool ptlrpc_recoverable_error(int rc)
319 return (rc == -ENOTCONN || rc == -ENODEV);
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)
333 static inline void tgt_mod_exit(void)
338 static inline int nodemap_mod_init(void)
343 static inline void nodemap_mod_exit(void)
347 #endif /* !HAVE_SERVER_SUPPORT */
349 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
351 if (atomic_dec_and_test(&set->set_refcount))
355 /** initialise ptlrpc common fields */
356 static inline void ptlrpc_req_comm_init(struct ptlrpc_request *req)
358 spin_lock_init(&req->rq_lock);
359 spin_lock_init(&req->rq_early_free_lock);
360 atomic_set(&req->rq_refcount, 1);
361 INIT_LIST_HEAD(&req->rq_list);
362 INIT_LIST_HEAD(&req->rq_replay_list);
365 /** initialise client side ptlrpc request */
366 static inline void ptlrpc_cli_req_init(struct ptlrpc_request *req)
368 struct ptlrpc_cli_req *cr = &req->rq_cli;
370 ptlrpc_req_comm_init(req);
372 req->rq_receiving_reply = 0;
373 req->rq_req_unlinked = req->rq_reply_unlinked = 1;
375 INIT_LIST_HEAD(&cr->cr_set_chain);
376 INIT_LIST_HEAD(&cr->cr_ctx_chain);
377 INIT_LIST_HEAD(&cr->cr_unreplied_list);
378 init_waitqueue_head(&cr->cr_reply_waitq);
379 init_waitqueue_head(&cr->cr_set_waitq);
382 /** initialise server side ptlrpc request */
383 static inline void ptlrpc_srv_req_init(struct ptlrpc_request *req)
385 struct ptlrpc_srv_req *sr = &req->rq_srv;
387 ptlrpc_req_comm_init(req);
389 INIT_LIST_HEAD(&sr->sr_exp_list);
390 INIT_LIST_HEAD(&sr->sr_timed_list);
391 INIT_LIST_HEAD(&sr->sr_hist_list);
394 static inline bool ptlrpc_req_is_connect(struct ptlrpc_request *req)
396 if (lustre_msg_get_opc(req->rq_reqmsg) == MDS_CONNECT ||
397 lustre_msg_get_opc(req->rq_reqmsg) == OST_CONNECT ||
398 lustre_msg_get_opc(req->rq_reqmsg) == MGS_CONNECT)
404 static inline bool ptlrpc_req_is_disconnect(struct ptlrpc_request *req)
406 if (lustre_msg_get_opc(req->rq_reqmsg) == MDS_DISCONNECT ||
407 lustre_msg_get_opc(req->rq_reqmsg) == OST_DISCONNECT ||
408 lustre_msg_get_opc(req->rq_reqmsg) == MGS_DISCONNECT)
414 #endif /* PTLRPC_INTERNAL_H */