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.sun.com/software/products/lustre/docs/GPLv2.pdf
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
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 /* Intramodule declarations for ptlrpc. */
39 #ifndef PTLRPC_INTERNAL_H
40 #define PTLRPC_INTERNAL_H
42 #include "../ldlm/ldlm_internal.h"
44 struct ldlm_namespace;
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;
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 */
64 extern struct nrs_core nrs_core;
66 extern struct mutex ptlrpcd_mutex;
67 extern struct mutex pinger_mutex;
69 int ptlrpc_start_thread(struct ptlrpc_service_part *svcpt, int wait);
71 int ptlrpcd_start(int index, int max, const char *name, struct ptlrpcd_ctl *pc);
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 unsigned type, unsigned portal);
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);
85 int ptlrpc_init_portals(void);
86 void ptlrpc_exit_portals(void);
88 void ptlrpc_request_handle_notconn(struct ptlrpc_request *);
89 void lustre_assert_wire_constants(void);
90 int ptlrpc_import_in_recovery(struct obd_import *imp);
91 int ptlrpc_set_import_discon(struct obd_import *imp, __u32 conn_cnt);
92 void ptlrpc_handle_failed_import(struct obd_import *imp);
93 int ptlrpc_replay_next(struct obd_import *imp, int *inflight);
94 void ptlrpc_initiate_recovery(struct obd_import *imp);
96 int lustre_unpack_req_ptlrpc_body(struct ptlrpc_request *req, int offset);
97 int lustre_unpack_rep_ptlrpc_body(struct ptlrpc_request *req, int offset);
100 void ptlrpc_lprocfs_register_service(struct proc_dir_entry *proc_entry,
101 struct ptlrpc_service *svc);
102 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc);
103 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount);
104 void ptlrpc_lprocfs_do_request_stat (struct ptlrpc_request *req,
105 long q_usec, long work_usec);
107 #define ptlrpc_lprocfs_register_service(params...) do{}while(0)
108 #define ptlrpc_lprocfs_unregister_service(params...) do{}while(0)
109 #define ptlrpc_lprocfs_rpc_sent(params...) do{}while(0)
110 #define ptlrpc_lprocfs_do_request_stat(params...) do{}while(0)
118 * Holds NRS core fields.
122 * Protects nrs_core::nrs_policies, serializes external policy
123 * registration/unregistration, and NRS core lprocfs operations.
125 struct mutex nrs_mutex;
127 * List of all policy descriptors registered with NRS core; protected
128 * by nrs_core::nrs_mutex.
130 struct list_head nrs_policies;
133 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
134 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
136 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part *svcpt,
137 struct ptlrpc_request *req, bool hp);
138 void ptlrpc_nrs_req_finalize(struct ptlrpc_request *req);
139 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request *req);
140 void ptlrpc_nrs_req_add(struct ptlrpc_service_part *svcpt,
141 struct ptlrpc_request *req, bool hp);
143 struct ptlrpc_request *
144 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
145 bool peek, bool force);
147 static inline struct ptlrpc_request *
148 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
151 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
154 static inline struct ptlrpc_request *
155 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part *svcpt, bool hp)
157 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, true, false);
160 void ptlrpc_nrs_req_del_nolock(struct ptlrpc_request *req);
161 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part *svcpt, bool hp);
162 bool ptlrpc_nrs_req_throttling_nolock(struct ptlrpc_service_part *svcpt,
165 int ptlrpc_nrs_policy_control(const struct ptlrpc_service *svc,
166 enum ptlrpc_nrs_queue_type queue, char *name,
167 enum ptlrpc_nrs_ctl opc, bool single, void *arg);
169 int ptlrpc_nrs_init(void);
170 void ptlrpc_nrs_fini(void);
172 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
174 return svcpt->scp_nrs_hp != NULL;
177 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
180 * If the first service partition has an HP NRS head, all service
183 return nrs_svcpt_has_hp(svc->srv_parts[0]);
187 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
189 LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
190 return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
193 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
195 return policy->pol_nrs->nrs_svcpt->scp_cpt;
199 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
201 return policy->pol_nrs->nrs_svcpt->scp_service;
205 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
207 return policy->pol_nrs->nrs_svcpt;
211 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
213 return nrs_pol2svc(policy)->srv_cptable;
216 static inline struct ptlrpc_nrs_resource *
217 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
219 LASSERT(nrq->nr_initialized);
220 LASSERT(!nrq->nr_finalized);
222 return nrq->nr_res_ptrs[nrq->nr_res_idx];
226 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
228 return nrs_request_resource(nrq)->res_policy;
231 #define NRS_LPROCFS_QUANTUM_NAME_REG "reg_quantum:"
232 #define NRS_LPROCFS_QUANTUM_NAME_HP "hp_quantum:"
235 * the maximum size of nrs_crrn_client::cc_quantum and nrs_orr_data::od_quantum.
237 #define LPROCFS_NRS_QUANTUM_MAX 65535
240 * Max valid command string is the size of the labels, plus "65535" twice, plus
241 * a separating space character.
243 #define LPROCFS_NRS_WR_QUANTUM_MAX_CMD \
244 sizeof(NRS_LPROCFS_QUANTUM_NAME_REG __stringify(LPROCFS_NRS_QUANTUM_MAX) " " \
245 NRS_LPROCFS_QUANTUM_NAME_HP __stringify(LPROCFS_NRS_QUANTUM_MAX))
247 /* recovd_thread.c */
249 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink);
252 void ptlrpc_fill_bulk_md(lnet_md_t *md, struct ptlrpc_bulk_desc *desc,
254 void ptlrpc_add_bulk_page(struct ptlrpc_bulk_desc *desc, struct page *page,
255 int pageoffset, int len);
258 struct ptlrpc_reply_state *
259 lustre_get_emerg_rs(struct ptlrpc_service_part *svcpt);
260 void lustre_put_emerg_rs(struct ptlrpc_reply_state *rs);
263 int ptlrpc_start_pinger(void);
264 int ptlrpc_stop_pinger(void);
265 void ptlrpc_pinger_sending_on_import(struct obd_import *imp);
266 void ptlrpc_pinger_commit_expected(struct obd_import *imp);
267 void ptlrpc_pinger_wake_up(void);
268 void ptlrpc_ping_import_soon(struct obd_import *imp);
269 int ping_evictor_wake(struct obd_export *exp);
272 int sptlrpc_null_init(void);
273 void sptlrpc_null_fini(void);
276 int sptlrpc_plain_init(void);
277 void sptlrpc_plain_fini(void);
280 int sptlrpc_enc_pool_init(void);
281 void sptlrpc_enc_pool_fini(void);
282 int sptlrpc_proc_enc_pool_seq_show(struct seq_file *m, void *v);
285 int sptlrpc_lproc_init(void);
286 void sptlrpc_lproc_fini(void);
289 int sptlrpc_gc_init(void);
290 void sptlrpc_gc_fini(void);
293 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
294 enum lustre_sec_part to,
295 struct obd_uuid *target,
297 struct sptlrpc_flavor *sf);
298 int sptlrpc_conf_init(void);
299 void sptlrpc_conf_fini(void);
303 int lustre_rename(struct dentry *dir, struct vfsmount *mnt, char *old_name,
307 int sptlrpc_init(void);
308 void sptlrpc_fini(void);
310 static inline bool ptlrpc_recoverable_error(int rc)
312 return (rc == -ENOTCONN || rc == -ENODEV);
315 #ifdef HAVE_SERVER_SUPPORT
316 int tgt_mod_init(void);
317 void tgt_mod_exit(void);
318 int nodemap_mod_init(void);
319 void nodemap_mod_exit(void);
320 #else /* HAVE_SERVER_SUPPORT */
321 static inline int tgt_mod_init(void)
326 static inline void tgt_mod_exit(void)
331 static inline int nodemap_mod_init(void)
336 static inline void nodemap_mod_exit(void)
340 #endif /* !HAVE_SERVER_SUPPORT */
342 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
344 if (atomic_dec_and_test(&set->set_refcount))
348 /** initialise ptlrpc common fields */
349 static inline void ptlrpc_req_comm_init(struct ptlrpc_request *req)
351 spin_lock_init(&req->rq_lock);
352 atomic_set(&req->rq_refcount, 1);
353 INIT_LIST_HEAD(&req->rq_list);
354 INIT_LIST_HEAD(&req->rq_replay_list);
357 /** initialise client side ptlrpc request */
358 static inline void ptlrpc_cli_req_init(struct ptlrpc_request *req)
360 struct ptlrpc_cli_req *cr = &req->rq_cli;
362 ptlrpc_req_comm_init(req);
364 req->rq_receiving_reply = 0;
365 req->rq_req_unlinked = req->rq_reply_unlinked = 1;
367 INIT_LIST_HEAD(&cr->cr_set_chain);
368 INIT_LIST_HEAD(&cr->cr_ctx_chain);
369 init_waitqueue_head(&cr->cr_reply_waitq);
370 init_waitqueue_head(&cr->cr_set_waitq);
373 /** initialise server side ptlrpc request */
374 static inline void ptlrpc_srv_req_init(struct ptlrpc_request *req)
376 struct ptlrpc_srv_req *sr = &req->rq_srv;
378 ptlrpc_req_comm_init(req);
380 INIT_LIST_HEAD(&sr->sr_exp_list);
381 INIT_LIST_HEAD(&sr->sr_timed_list);
382 INIT_LIST_HEAD(&sr->sr_hist_list);
385 #endif /* PTLRPC_INTERNAL_H */