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, 2012, 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 mutex ptlrpc_all_services_mutex;
50 extern struct list_head ptlrpc_all_services;
52 extern struct mutex ptlrpcd_mutex;
53 extern struct mutex pinger_mutex;
55 int ptlrpc_start_thread(struct ptlrpc_service_part *svcpt, int wait);
57 int ptlrpcd_start(struct ptlrpcd_ctl *pc);
60 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned npages, unsigned max_brw,
61 unsigned type, unsigned portal);
62 int ptlrpc_request_cache_init(void);
63 void ptlrpc_request_cache_fini(void);
64 struct ptlrpc_request *ptlrpc_request_cache_alloc(gfp_t flags);
65 void ptlrpc_request_cache_free(struct ptlrpc_request *req);
66 void ptlrpc_init_xid(void);
69 int ptlrpc_init_portals(void);
70 void ptlrpc_exit_portals(void);
72 void ptlrpc_request_handle_notconn(struct ptlrpc_request *);
73 void lustre_assert_wire_constants(void);
74 int ptlrpc_import_in_recovery(struct obd_import *imp);
75 int ptlrpc_set_import_discon(struct obd_import *imp, __u32 conn_cnt);
76 void ptlrpc_handle_failed_import(struct obd_import *imp);
77 int ptlrpc_replay_next(struct obd_import *imp, int *inflight);
78 void ptlrpc_initiate_recovery(struct obd_import *imp);
80 int lustre_unpack_req_ptlrpc_body(struct ptlrpc_request *req, int offset);
81 int lustre_unpack_rep_ptlrpc_body(struct ptlrpc_request *req, int offset);
83 int ptlrpc_sysfs_register_service(struct kset *parent,
84 struct ptlrpc_service *svc);
85 void ptlrpc_sysfs_unregister_service(struct ptlrpc_service *svc);
87 void ptlrpc_ldebugfs_register_service(struct dentry *debugfs_entry,
88 struct ptlrpc_service *svc);
89 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc);
90 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount);
91 void ptlrpc_lprocfs_do_request_stat(struct ptlrpc_request *req,
92 long q_usec, long work_usec);
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;
107 /* XXX: This is just for liblustre. Remove the #if defined directive
108 * when the * "cfs_" prefix is dropped from cfs_list_head. */
110 * List of all policy descriptors registered with NRS core; protected
111 * by nrs_core::nrs_mutex.
113 struct list_head nrs_policies;
117 extern struct nrs_core nrs_core;
119 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
120 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
122 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part *svcpt,
123 struct ptlrpc_request *req, bool hp);
124 void ptlrpc_nrs_req_finalize(struct ptlrpc_request *req);
125 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request *req);
126 void ptlrpc_nrs_req_add(struct ptlrpc_service_part *svcpt,
127 struct ptlrpc_request *req, bool hp);
129 struct ptlrpc_request *
130 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
131 bool peek, bool force);
133 static inline struct ptlrpc_request *
134 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
137 return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
140 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part *svcpt, bool hp);
142 int ptlrpc_nrs_policy_control(const struct ptlrpc_service *svc,
143 enum ptlrpc_nrs_queue_type queue, char *name,
144 enum ptlrpc_nrs_ctl opc, bool single, void *arg);
146 int ptlrpc_nrs_init(void);
147 void ptlrpc_nrs_fini(void);
149 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
151 return svcpt->scp_nrs_hp != NULL;
154 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
157 * If the first service partition has an HP NRS head, all service
160 return nrs_svcpt_has_hp(svc->srv_parts[0]);
164 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
166 LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
167 return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
170 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
172 return policy->pol_nrs->nrs_svcpt->scp_cpt;
176 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
178 return policy->pol_nrs->nrs_svcpt->scp_service;
182 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
184 return policy->pol_nrs->nrs_svcpt;
188 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
190 return nrs_pol2svc(policy)->srv_cptable;
193 static inline struct ptlrpc_nrs_resource *
194 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
196 LASSERT(nrq->nr_initialized);
197 LASSERT(!nrq->nr_finalized);
199 return nrq->nr_res_ptrs[nrq->nr_res_idx];
203 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
205 return nrs_request_resource(nrq)->res_policy;
208 #define NRS_LPROCFS_QUANTUM_NAME_REG "reg_quantum:"
209 #define NRS_LPROCFS_QUANTUM_NAME_HP "hp_quantum:"
212 * the maximum size of nrs_crrn_client::cc_quantum and nrs_orr_data::od_quantum.
214 #define LPROCFS_NRS_QUANTUM_MAX 65535
217 * Max valid command string is the size of the labels, plus "65535" twice, plus
218 * a separating space character.
220 #define LPROCFS_NRS_WR_QUANTUM_MAX_CMD \
221 sizeof(NRS_LPROCFS_QUANTUM_NAME_REG __stringify(LPROCFS_NRS_QUANTUM_MAX) " " \
222 NRS_LPROCFS_QUANTUM_NAME_HP __stringify(LPROCFS_NRS_QUANTUM_MAX))
224 /* recovd_thread.c */
226 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink);
229 void ptlrpc_fill_bulk_md(lnet_md_t *md, struct ptlrpc_bulk_desc *desc,
231 void ptlrpc_add_bulk_page(struct ptlrpc_bulk_desc *desc, struct page *page,
232 int pageoffset, int len);
235 struct ptlrpc_reply_state *
236 lustre_get_emerg_rs(struct ptlrpc_service_part *svcpt);
237 void lustre_put_emerg_rs(struct ptlrpc_reply_state *rs);
240 int ptlrpc_start_pinger(void);
241 int ptlrpc_stop_pinger(void);
242 void ptlrpc_pinger_sending_on_import(struct obd_import *imp);
243 void ptlrpc_pinger_commit_expected(struct obd_import *imp);
244 void ptlrpc_pinger_wake_up(void);
247 int sptlrpc_null_init(void);
248 void sptlrpc_null_fini(void);
251 int sptlrpc_plain_init(void);
252 void sptlrpc_plain_fini(void);
255 int sptlrpc_enc_pool_init(void);
256 void sptlrpc_enc_pool_fini(void);
257 int sptlrpc_proc_enc_pool_seq_show(struct seq_file *m, void *v);
260 int sptlrpc_lproc_init(void);
261 void sptlrpc_lproc_fini(void);
264 int sptlrpc_gc_init(void);
265 void sptlrpc_gc_fini(void);
268 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
269 enum lustre_sec_part to,
270 struct obd_uuid *target,
272 struct sptlrpc_flavor *sf);
273 int sptlrpc_conf_init(void);
274 void sptlrpc_conf_fini(void);
277 int sptlrpc_init(void);
278 void sptlrpc_fini(void);
280 static inline int ll_rpc_recoverable_error(int rc)
282 return (rc == -ENOTCONN || rc == -ENODEV);
285 static inline int tgt_mod_init(void)
290 static inline void tgt_mod_exit(void)
295 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
297 if (atomic_dec_and_test(&set->set_refcount))
300 #endif /* PTLRPC_INTERNAL_H */