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
;
51 int ptlrpc_start_thread(struct ptlrpc_service_part
*svcpt
, int wait
);
53 int ptlrpcd_start(int index
, int max
, const char *name
, struct ptlrpcd_ctl
*pc
);
56 struct ptlrpc_bulk_desc
*ptlrpc_new_bulk(unsigned npages
, unsigned max_brw
,
57 unsigned type
, unsigned portal
);
58 int ptlrpc_request_cache_init(void);
59 void ptlrpc_request_cache_fini(void);
60 struct ptlrpc_request
*ptlrpc_request_cache_alloc(int flags
);
61 void ptlrpc_request_cache_free(struct ptlrpc_request
*req
);
62 void ptlrpc_init_xid(void);
65 int ptlrpc_init_portals(void);
66 void ptlrpc_exit_portals(void);
68 void ptlrpc_request_handle_notconn(struct ptlrpc_request
*);
69 void lustre_assert_wire_constants(void);
70 int ptlrpc_import_in_recovery(struct obd_import
*imp
);
71 int ptlrpc_set_import_discon(struct obd_import
*imp
, __u32 conn_cnt
);
72 void ptlrpc_handle_failed_import(struct obd_import
*imp
);
73 int ptlrpc_replay_next(struct obd_import
*imp
, int *inflight
);
74 void ptlrpc_initiate_recovery(struct obd_import
*imp
);
76 int lustre_unpack_req_ptlrpc_body(struct ptlrpc_request
*req
, int offset
);
77 int lustre_unpack_rep_ptlrpc_body(struct ptlrpc_request
*req
, int offset
);
79 #if defined (CONFIG_PROC_FS)
80 void ptlrpc_lprocfs_register_service(struct proc_dir_entry
*proc_entry
,
81 struct ptlrpc_service
*svc
);
82 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service
*svc
);
83 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request
*req
, long amount
);
84 void ptlrpc_lprocfs_do_request_stat(struct ptlrpc_request
*req
,
85 long q_usec
, long work_usec
);
87 #define ptlrpc_lprocfs_register_service(params...) do {} while (0)
88 #define ptlrpc_lprocfs_unregister_service(params...) do {} while (0)
89 #define ptlrpc_lprocfs_rpc_sent(params...) do {} while (0)
90 #define ptlrpc_lprocfs_do_request_stat(params...) do {} while (0)
91 #endif /* CONFIG_PROC_FS */
98 * Holds NRS core fields.
102 * Protects nrs_core::nrs_policies, serializes external policy
103 * registration/unregistration, and NRS core lprocfs operations.
105 struct mutex nrs_mutex
;
106 /* XXX: This is just for liblustre. Remove the #if defined directive
107 * when the * "cfs_" prefix is dropped from cfs_list_head. */
109 * List of all policy descriptors registered with NRS core; protected
110 * by nrs_core::nrs_mutex.
112 struct list_head nrs_policies
;
116 int ptlrpc_service_nrs_setup(struct ptlrpc_service
*svc
);
117 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service
*svc
);
119 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part
*svcpt
,
120 struct ptlrpc_request
*req
, bool hp
);
121 void ptlrpc_nrs_req_finalize(struct ptlrpc_request
*req
);
122 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request
*req
);
123 void ptlrpc_nrs_req_add(struct ptlrpc_service_part
*svcpt
,
124 struct ptlrpc_request
*req
, bool hp
);
126 struct ptlrpc_request
*
127 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part
*svcpt
, bool hp
,
128 bool peek
, bool force
);
130 static inline struct ptlrpc_request
*
131 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part
*svcpt
, bool hp
,
134 return ptlrpc_nrs_req_get_nolock0(svcpt
, hp
, false, force
);
137 static inline struct ptlrpc_request
*
138 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part
*svcpt
, bool hp
)
140 return ptlrpc_nrs_req_get_nolock0(svcpt
, hp
, true, false);
143 void ptlrpc_nrs_req_del_nolock(struct ptlrpc_request
*req
);
144 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part
*svcpt
, bool hp
);
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
);
250 int ping_evictor_wake(struct obd_export
*exp
);
253 int sptlrpc_null_init(void);
254 void sptlrpc_null_fini(void);
257 int sptlrpc_plain_init(void);
258 void sptlrpc_plain_fini(void);
261 int sptlrpc_enc_pool_init(void);
262 void sptlrpc_enc_pool_fini(void);
263 int sptlrpc_proc_enc_pool_seq_show(struct seq_file
*m
, void *v
);
266 #if defined (CONFIG_PROC_FS)
267 int sptlrpc_lproc_init(void);
268 void sptlrpc_lproc_fini(void);
270 static inline int sptlrpc_lproc_init(void)
272 static inline void sptlrpc_lproc_fini(void) {}
276 int sptlrpc_gc_init(void);
277 void sptlrpc_gc_fini(void);
280 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from
,
281 enum lustre_sec_part to
,
282 struct obd_uuid
*target
,
284 struct sptlrpc_flavor
*sf
);
285 int sptlrpc_conf_init(void);
286 void sptlrpc_conf_fini(void);
289 int sptlrpc_init(void);
290 void sptlrpc_fini(void);
292 static inline int ll_rpc_recoverable_error(int rc
)
294 return (rc
== -ENOTCONN
|| rc
== -ENODEV
);
297 static inline int tgt_mod_init(void)
302 static inline void tgt_mod_exit(void)
307 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set
*set
)
309 if (atomic_dec_and_test(&set
->set_refcount
))
312 #endif /* PTLRPC_INTERNAL_H */