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 #endif /* HAVE_SERVER_SUPPORT */
60 extern struct nrs_core nrs_core;
62 extern struct mutex ptlrpcd_mutex;
63 extern struct mutex pinger_mutex;
65 int ptlrpc_start_thread(struct ptlrpc_service_part *svcpt, int wait);
67 int ptlrpcd_start(struct ptlrpcd_ctl *pc);
70 void ptlrpc_at_adj_net_latency(struct ptlrpc_request *req,
71 unsigned int service_time);
72 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned npages, unsigned max_brw,
73 enum ptlrpc_bulk_op_type type,
75 const struct ptlrpc_bulk_frag_ops
77 int ptlrpc_request_cache_init(void);
78 void ptlrpc_request_cache_fini(void);
79 struct ptlrpc_request *ptlrpc_request_cache_alloc(gfp_t flags);
80 void ptlrpc_request_cache_free(struct ptlrpc_request *req);
81 void ptlrpc_init_xid(void);
82 void ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
83 struct ptlrpc_request *req);
84 int ptlrpc_expired_set(void *data);
85 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
86 void ptlrpc_resend_req(struct ptlrpc_request *request);
87 void ptlrpc_set_bulk_mbits(struct ptlrpc_request *req);
88 void ptlrpc_assign_next_xid_nolock(struct ptlrpc_request *req);
89 __u64 ptlrpc_known_replied_xid(struct obd_import *imp);
90 void ptlrpc_add_unreplied(struct ptlrpc_request *req);
93 int ptlrpc_init_portals(void);
94 void ptlrpc_exit_portals(void);
96 void ptlrpc_request_handle_notconn(struct ptlrpc_request *);
97 void lustre_assert_wire_constants(void);
98 int ptlrpc_import_in_recovery(struct obd_import *imp);
99 int ptlrpc_set_import_discon(struct obd_import *imp, __u32 conn_cnt);
100 void ptlrpc_handle_failed_import(struct obd_import *imp);
101 int ptlrpc_replay_next(struct obd_import *imp, int *inflight);
102 void ptlrpc_initiate_recovery(struct obd_import *imp);
104 int lustre_unpack_req_ptlrpc_body(struct ptlrpc_request *req, int offset);
105 int lustre_unpack_rep_ptlrpc_body(struct ptlrpc_request *req, int offset);
107 #ifdef CONFIG_PROC_FS
108 void ptlrpc_lprocfs_register_service(struct proc_dir_entry *proc_entry,
109 struct ptlrpc_service *svc);
110 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc);
111 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount);
112 void ptlrpc_lprocfs_do_request_stat (struct ptlrpc_request *req,
113 long q_usec, long work_usec);
115 #define ptlrpc_lprocfs_register_service(params...) do{}while(0)
116 #define ptlrpc_lprocfs_unregister_service(params...) do{}while(0)
117 #define ptlrpc_lprocfs_rpc_sent(params...) do{}while(0)
118 #define ptlrpc_lprocfs_do_request_stat(params...) do{}while(0)
119 #endif /* CONFIG_PROC_FS */
126 * Holds NRS core fields.
130 * Protects nrs_core::nrs_policies, serializes external policy
131 * registration/unregistration, and NRS core lprocfs operations.
133 struct mutex nrs_mutex;
135 * List of all policy descriptors registered with NRS core; protected
136 * by nrs_core::nrs_mutex.
138 struct list_head nrs_policies;
141 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
142 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
144 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part *svcpt,
145 struct ptlrpc_request *req, bool hp);
146 void ptlrpc_nrs_req_finalize(struct ptlrpc_request *req);
147 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request *req);
148 void ptlrpc_nrs_req_add(struct ptlrpc_service_part *svcpt,
149 struct ptlrpc_request *req, bool hp);
151 struct ptlrpc_request *
152 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
153 bool peek, bool force);
155 static inline struct ptlrpc_request *
156 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
159 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
162 static inline struct ptlrpc_request *
163 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part *svcpt, bool hp)
165 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, true, false);
168 void ptlrpc_nrs_req_del_nolock(struct ptlrpc_request *req);
169 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part *svcpt, bool hp);
170 bool ptlrpc_nrs_req_throttling_nolock(struct ptlrpc_service_part *svcpt,
173 int ptlrpc_nrs_policy_control(const struct ptlrpc_service *svc,
174 enum ptlrpc_nrs_queue_type queue, char *name,
175 enum ptlrpc_nrs_ctl opc, bool single, void *arg);
177 int ptlrpc_nrs_init(void);
178 void ptlrpc_nrs_fini(void);
180 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
182 return svcpt->scp_nrs_hp != NULL;
185 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
188 * If the first service partition has an HP NRS head, all service
191 return nrs_svcpt_has_hp(svc->srv_parts[0]);
195 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
197 LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
198 return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
201 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
203 return policy->pol_nrs->nrs_svcpt->scp_cpt;
207 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
209 return policy->pol_nrs->nrs_svcpt->scp_service;
213 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
215 return policy->pol_nrs->nrs_svcpt;
219 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
221 return nrs_pol2svc(policy)->srv_cptable;
224 static inline struct ptlrpc_nrs_resource *
225 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
227 LASSERT(nrq->nr_initialized);
228 LASSERT(!nrq->nr_finalized);
230 return nrq->nr_res_ptrs[nrq->nr_res_idx];
234 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
236 return nrs_request_resource(nrq)->res_policy;
239 #define NRS_LPROCFS_QUANTUM_NAME_REG "reg_quantum:"
240 #define NRS_LPROCFS_QUANTUM_NAME_HP "hp_quantum:"
243 * the maximum size of nrs_crrn_client::cc_quantum and nrs_orr_data::od_quantum.
245 #define LPROCFS_NRS_QUANTUM_MAX 65535
248 * Max valid command string is the size of the labels, plus "65535" twice, plus
249 * a separating space character.
251 #define LPROCFS_NRS_WR_QUANTUM_MAX_CMD \
252 sizeof(NRS_LPROCFS_QUANTUM_NAME_REG __stringify(LPROCFS_NRS_QUANTUM_MAX) " " \
253 NRS_LPROCFS_QUANTUM_NAME_HP __stringify(LPROCFS_NRS_QUANTUM_MAX))
255 /* recovd_thread.c */
257 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink);
260 void ptlrpc_fill_bulk_md(lnet_md_t *md, struct ptlrpc_bulk_desc *desc,
264 struct ptlrpc_reply_state *
265 lustre_get_emerg_rs(struct ptlrpc_service_part *svcpt);
266 void lustre_put_emerg_rs(struct ptlrpc_reply_state *rs);
269 int ptlrpc_start_pinger(void);
270 int ptlrpc_stop_pinger(void);
271 void ptlrpc_pinger_sending_on_import(struct obd_import *imp);
272 void ptlrpc_pinger_commit_expected(struct obd_import *imp);
273 void ptlrpc_pinger_wake_up(void);
274 void ptlrpc_ping_import_soon(struct obd_import *imp);
275 int ping_evictor_wake(struct obd_export *exp);
278 int sptlrpc_null_init(void);
279 void sptlrpc_null_fini(void);
282 int sptlrpc_plain_init(void);
283 void sptlrpc_plain_fini(void);
286 int sptlrpc_enc_pool_init(void);
287 void sptlrpc_enc_pool_fini(void);
288 int sptlrpc_proc_enc_pool_seq_show(struct seq_file *m, void *v);
291 int sptlrpc_lproc_init(void);
292 void sptlrpc_lproc_fini(void);
295 int sptlrpc_gc_init(void);
296 void sptlrpc_gc_fini(void);
299 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
300 enum lustre_sec_part to,
301 struct obd_uuid *target,
303 struct sptlrpc_flavor *sf);
304 int sptlrpc_conf_init(void);
305 void sptlrpc_conf_fini(void);
309 int lustre_rename(struct dentry *dir, struct vfsmount *mnt, char *old_name,
313 int sptlrpc_init(void);
314 void sptlrpc_fini(void);
316 static inline bool ptlrpc_recoverable_error(int rc)
318 return (rc == -ENOTCONN || rc == -ENODEV);
321 #ifdef HAVE_SERVER_SUPPORT
322 int tgt_mod_init(void);
323 void tgt_mod_exit(void);
324 int nodemap_mod_init(void);
325 void nodemap_mod_exit(void);
326 #else /* HAVE_SERVER_SUPPORT */
327 static inline int tgt_mod_init(void)
332 static inline void tgt_mod_exit(void)
337 static inline int nodemap_mod_init(void)
342 static inline void nodemap_mod_exit(void)
346 #endif /* !HAVE_SERVER_SUPPORT */
348 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
350 if (atomic_dec_and_test(&set->set_refcount))
354 /** initialise ptlrpc common fields */
355 static inline void ptlrpc_req_comm_init(struct ptlrpc_request *req)
357 spin_lock_init(&req->rq_lock);
358 atomic_set(&req->rq_refcount, 1);
359 INIT_LIST_HEAD(&req->rq_list);
360 INIT_LIST_HEAD(&req->rq_replay_list);
363 /** initialise client side ptlrpc request */
364 static inline void ptlrpc_cli_req_init(struct ptlrpc_request *req)
366 struct ptlrpc_cli_req *cr = &req->rq_cli;
368 ptlrpc_req_comm_init(req);
370 req->rq_receiving_reply = 0;
371 req->rq_req_unlinked = req->rq_reply_unlinked = 1;
373 INIT_LIST_HEAD(&cr->cr_set_chain);
374 INIT_LIST_HEAD(&cr->cr_ctx_chain);
375 INIT_LIST_HEAD(&cr->cr_unreplied_list);
376 init_waitqueue_head(&cr->cr_reply_waitq);
377 init_waitqueue_head(&cr->cr_set_waitq);
380 /** initialise server side ptlrpc request */
381 static inline void ptlrpc_srv_req_init(struct ptlrpc_request *req)
383 struct ptlrpc_srv_req *sr = &req->rq_srv;
385 ptlrpc_req_comm_init(req);
387 INIT_LIST_HEAD(&sr->sr_exp_list);
388 INIT_LIST_HEAD(&sr->sr_timed_list);
389 INIT_LIST_HEAD(&sr->sr_hist_list);
392 static inline bool ptlrpc_req_is_connect(struct ptlrpc_request *req)
394 if (lustre_msg_get_opc(req->rq_reqmsg) == MDS_CONNECT ||
395 lustre_msg_get_opc(req->rq_reqmsg) == OST_CONNECT ||
396 lustre_msg_get_opc(req->rq_reqmsg) == MGS_CONNECT)
402 static inline bool ptlrpc_req_is_disconnect(struct ptlrpc_request *req)
404 if (lustre_msg_get_opc(req->rq_reqmsg) == MDS_DISCONNECT ||
405 lustre_msg_get_opc(req->rq_reqmsg) == OST_DISCONNECT ||
406 lustre_msg_get_opc(req->rq_reqmsg) == MGS_DISCONNECT)
412 #endif /* PTLRPC_INTERNAL_H */