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, 2013, 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;
52 int ptlrpc_start_thread(struct ptlrpc_service_part *svcpt, int wait);
54 int ptlrpcd_start(int index, int max, const char *name, struct ptlrpcd_ctl *pc);
57 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned npages, unsigned max_brw,
58 unsigned type, unsigned portal);
59 int ptlrpc_request_cache_init(void);
60 void ptlrpc_request_cache_fini(void);
61 struct ptlrpc_request *ptlrpc_request_cache_alloc(int flags);
62 void ptlrpc_request_cache_free(struct ptlrpc_request *req);
63 void ptlrpc_init_xid(void);
66 int ptlrpc_init_portals(void);
67 void ptlrpc_exit_portals(void);
69 void ptlrpc_request_handle_notconn(struct ptlrpc_request *);
70 void lustre_assert_wire_constants(void);
71 int ptlrpc_import_in_recovery(struct obd_import *imp);
72 int ptlrpc_set_import_discon(struct obd_import *imp, __u32 conn_cnt);
73 void ptlrpc_handle_failed_import(struct obd_import *imp);
74 int ptlrpc_replay_next(struct obd_import *imp, int *inflight);
75 void ptlrpc_initiate_recovery(struct obd_import *imp);
77 int lustre_unpack_req_ptlrpc_body(struct ptlrpc_request *req, int offset);
78 int lustre_unpack_rep_ptlrpc_body(struct ptlrpc_request *req, int offset);
81 void ptlrpc_lprocfs_register_service(struct proc_dir_entry *proc_entry,
82 struct ptlrpc_service *svc);
83 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc);
84 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount);
85 void ptlrpc_lprocfs_do_request_stat (struct ptlrpc_request *req,
86 long q_usec, long work_usec);
88 #define ptlrpc_lprocfs_register_service(params...) do{}while(0)
89 #define ptlrpc_lprocfs_unregister_service(params...) do{}while(0)
90 #define ptlrpc_lprocfs_rpc_sent(params...) do{}while(0)
91 #define ptlrpc_lprocfs_do_request_stat(params...) do{}while(0)
99 * Holds NRS core fields.
103 * Protects nrs_core::nrs_policies, serializes external policy
104 * registration/unregistration, and NRS core lprocfs operations.
106 struct mutex nrs_mutex;
108 * List of all policy descriptors registered with NRS core; protected
109 * by nrs_core::nrs_mutex.
111 struct list_head nrs_policies;
114 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
115 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
117 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part *svcpt,
118 struct ptlrpc_request *req, bool hp);
119 void ptlrpc_nrs_req_finalize(struct ptlrpc_request *req);
120 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request *req);
121 void ptlrpc_nrs_req_add(struct ptlrpc_service_part *svcpt,
122 struct ptlrpc_request *req, bool hp);
124 struct ptlrpc_request *
125 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
126 bool peek, bool force);
128 static inline struct ptlrpc_request *
129 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
132 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
135 static inline struct ptlrpc_request *
136 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part *svcpt, bool hp)
138 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, true, false);
141 void ptlrpc_nrs_req_del_nolock(struct ptlrpc_request *req);
142 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part *svcpt, bool hp);
143 bool ptlrpc_nrs_req_throttling_nolock(struct ptlrpc_service_part *svcpt,
146 int ptlrpc_nrs_policy_control(const struct ptlrpc_service *svc,
147 enum ptlrpc_nrs_queue_type queue, char *name,
148 enum ptlrpc_nrs_ctl opc, bool single, void *arg);
150 int ptlrpc_nrs_init(void);
151 void ptlrpc_nrs_fini(void);
153 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
155 return svcpt->scp_nrs_hp != NULL;
158 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
161 * If the first service partition has an HP NRS head, all service
164 return nrs_svcpt_has_hp(svc->srv_parts[0]);
168 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
170 LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
171 return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
174 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
176 return policy->pol_nrs->nrs_svcpt->scp_cpt;
180 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
182 return policy->pol_nrs->nrs_svcpt->scp_service;
186 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
188 return policy->pol_nrs->nrs_svcpt;
192 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
194 return nrs_pol2svc(policy)->srv_cptable;
197 static inline struct ptlrpc_nrs_resource *
198 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
200 LASSERT(nrq->nr_initialized);
201 LASSERT(!nrq->nr_finalized);
203 return nrq->nr_res_ptrs[nrq->nr_res_idx];
207 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
209 return nrs_request_resource(nrq)->res_policy;
212 #define NRS_LPROCFS_QUANTUM_NAME_REG "reg_quantum:"
213 #define NRS_LPROCFS_QUANTUM_NAME_HP "hp_quantum:"
216 * the maximum size of nrs_crrn_client::cc_quantum and nrs_orr_data::od_quantum.
218 #define LPROCFS_NRS_QUANTUM_MAX 65535
221 * Max valid command string is the size of the labels, plus "65535" twice, plus
222 * a separating space character.
224 #define LPROCFS_NRS_WR_QUANTUM_MAX_CMD \
225 sizeof(NRS_LPROCFS_QUANTUM_NAME_REG __stringify(LPROCFS_NRS_QUANTUM_MAX) " " \
226 NRS_LPROCFS_QUANTUM_NAME_HP __stringify(LPROCFS_NRS_QUANTUM_MAX))
228 /* recovd_thread.c */
230 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink);
233 void ptlrpc_fill_bulk_md(lnet_md_t *md, struct ptlrpc_bulk_desc *desc,
235 void ptlrpc_add_bulk_page(struct ptlrpc_bulk_desc *desc, struct page *page,
236 int pageoffset, int len);
239 struct ptlrpc_reply_state *
240 lustre_get_emerg_rs(struct ptlrpc_service_part *svcpt);
241 void lustre_put_emerg_rs(struct ptlrpc_reply_state *rs);
244 int ptlrpc_start_pinger(void);
245 int ptlrpc_stop_pinger(void);
246 void ptlrpc_pinger_sending_on_import(struct obd_import *imp);
247 void ptlrpc_pinger_commit_expected(struct obd_import *imp);
248 void ptlrpc_pinger_wake_up(void);
249 void ptlrpc_ping_import_soon(struct obd_import *imp);
251 int ping_evictor_wake(struct obd_export *exp);
253 #define ping_evictor_wake(exp) 1
257 int sptlrpc_null_init(void);
258 void sptlrpc_null_fini(void);
261 int sptlrpc_plain_init(void);
262 void sptlrpc_plain_fini(void);
265 int sptlrpc_enc_pool_init(void);
266 void sptlrpc_enc_pool_fini(void);
267 int sptlrpc_proc_enc_pool_seq_show(struct seq_file *m, void *v);
270 int sptlrpc_lproc_init(void);
271 void sptlrpc_lproc_fini(void);
274 int sptlrpc_gc_init(void);
275 void sptlrpc_gc_fini(void);
278 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
279 enum lustre_sec_part to,
280 struct obd_uuid *target,
282 struct sptlrpc_flavor *sf);
283 int sptlrpc_conf_init(void);
284 void sptlrpc_conf_fini(void);
288 int lustre_rename(struct dentry *dir, struct vfsmount *mnt, char *old_name,
292 int sptlrpc_init(void);
293 void sptlrpc_fini(void);
295 static inline int ll_rpc_recoverable_error(int rc)
297 return (rc == -ENOTCONN || rc == -ENODEV);
300 #if defined HAVE_SERVER_SUPPORT && defined(__KERNEL__)
301 int tgt_mod_init(void);
302 void tgt_mod_exit(void);
304 static inline int tgt_mod_init(void)
309 static inline void tgt_mod_exit(void)
315 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
317 if (atomic_dec_and_test(&set->set_refcount))
320 #endif /* PTLRPC_INTERNAL_H */