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) 2009, 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 #ifndef _LUSTRE_LU_TARGET_H
38 #define _LUSTRE_LU_TARGET_H
40 #include <dt_object.h>
41 #include <lustre_export.h>
42 #include <lustre_update.h>
43 #include <lustre_disk.h>
46 struct obd_device *lut_obd;
47 struct dt_device *lut_bottom;
49 /* supported opcodes and handlers for this target */
50 struct tgt_opc_slice *lut_slice;
51 __u32 lut_reply_fail_id;
52 __u32 lut_request_fail_id;
55 rwlock_t lut_sptlrpc_lock;
56 struct sptlrpc_rule_set lut_sptlrpc_rset;
58 unsigned int lut_mds_capa:1,
61 /* LAST_RCVD parameters */
63 struct dt_object *lut_last_rcvd;
64 /* transaction callbacks */
65 struct dt_txn_callback lut_txn_cb;
66 /** server data in last_rcvd file */
67 struct lr_server_data lut_lsd;
68 /** Server last transaction number */
69 __u64 lut_last_transno;
70 /** Lock protecting last transaction number */
71 spinlock_t lut_translock;
72 /** Lock protecting client bitmap */
73 spinlock_t lut_client_bitmap_lock;
74 /** Bitmap of known clients */
75 unsigned long *lut_client_bitmap;
78 extern struct lu_context_key tgt_session_key;
80 struct tgt_session_info {
82 * The following members will be filled explicitly
83 * with specific data in tgt_ses_init().
85 struct req_capsule *tsi_pill;
88 * Lock request for "habeo clavis" operations.
90 struct ldlm_request *tsi_dlm_req;
92 /* although we have export in req, there are cases when it is not
93 * available, e.g. closing files upon export destroy */
94 struct obd_export *tsi_exp;
95 const struct lu_env *tsi_env;
96 struct lu_target *tsi_tgt;
98 * Additional fail id that can be set by handler.
100 int tsi_reply_fail_id;
101 int tsi_request_fail_id;
103 __u32 tsi_has_trans:1; /* has txn already? */
106 static inline struct tgt_session_info *tgt_ses_info(const struct lu_env *env)
108 struct tgt_session_info *tsi;
110 LASSERT(env->le_ses != NULL);
111 tsi = lu_context_key_get(env->le_ses, &tgt_session_key);
117 * Generic unified target support.
119 enum tgt_handler_flags {
121 * struct *_body is passed in the incoming message, and object
122 * identified by this fid exists on disk.
124 * "habeo corpus" == "I have a body"
126 HABEO_CORPUS = (1 << 0),
128 * struct ldlm_request is passed in the incoming message.
130 * "habeo clavis" == "I have a key"
132 HABEO_CLAVIS = (1 << 1),
134 * this request has fixed reply format, so that reply message can be
135 * packed by generic code.
137 * "habeo refero" == "I have a reply"
139 HABEO_REFERO = (1 << 2),
141 * this request will modify something, so check whether the file system
142 * is readonly or not, then return -EROFS to client asap if necessary.
144 * "mutabor" == "I shall modify"
150 /* The name of this handler. */
152 /* Fail id, check at the beginning */
156 /* Flags in enum tgt_handler_flags */
158 /* Request version for this opcode */
160 /* Handler function */
161 int (*th_act)(struct tgt_session_info *tti);
162 /* Request format for this request */
163 const struct req_format *th_fmt;
166 struct tgt_opc_slice {
167 __u32 tos_opc_start; /* First op code */
168 __u32 tos_opc_end; /* Last op code */
169 struct tgt_handler *tos_hs; /* Registered handler */
172 static inline struct ptlrpc_request *tgt_ses_req(struct tgt_session_info *tsi)
174 return tsi->tsi_pill ? tsi->tsi_pill->rc_req : NULL;
177 static inline __u64 tgt_conn_flags(struct tgt_session_info *tsi)
179 LASSERT(tsi->tsi_exp);
180 return exp_connect_flags(tsi->tsi_exp);
183 static inline int req_is_replay(struct ptlrpc_request *req)
185 LASSERT(req->rq_reqmsg);
186 return !!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY);
189 /* target/tgt_handler.c */
190 int tgt_request_handle(struct ptlrpc_request *req);
191 char *tgt_name(struct lu_target *tgt);
192 void tgt_counter_incr(struct obd_export *exp, int opcode);
193 int tgt_connect_check_sptlrpc(struct ptlrpc_request *req,
194 struct obd_export *exp);
195 int tgt_connect(struct tgt_session_info *tsi);
196 int tgt_disconnect(struct tgt_session_info *uti);
197 int tgt_obd_ping(struct tgt_session_info *tsi);
198 int tgt_enqueue(struct tgt_session_info *tsi);
199 int tgt_convert(struct tgt_session_info *tsi);
200 int tgt_bl_callback(struct tgt_session_info *tsi);
201 int tgt_cp_callback(struct tgt_session_info *tsi);
202 int tgt_llog_open(struct tgt_session_info *tsi);
203 int tgt_llog_close(struct tgt_session_info *tsi);
204 int tgt_llog_destroy(struct tgt_session_info *tsi);
205 int tgt_llog_read_header(struct tgt_session_info *tsi);
206 int tgt_llog_next_block(struct tgt_session_info *tsi);
207 int tgt_llog_prev_block(struct tgt_session_info *tsi);
208 int tgt_sec_ctx_init(struct tgt_session_info *tsi);
209 int tgt_sec_ctx_init_cont(struct tgt_session_info *tsi);
210 int tgt_sec_ctx_fini(struct tgt_session_info *tsi);
212 extern struct tgt_handler tgt_sec_ctx_handlers[];
213 extern struct tgt_handler tgt_obd_handlers[];
214 extern struct tgt_handler tgt_dlm_handlers[];
215 extern struct tgt_handler tgt_llog_handlers[];
216 extern struct tgt_handler tgt_out_handlers[];
217 extern struct tgt_handler fld_handlers[];
218 extern struct tgt_handler seq_handlers[];
220 typedef void (*tgt_cb_t)(struct lu_target *lut, __u64 transno,
221 void *data, int err);
222 struct tgt_commit_cb {
223 tgt_cb_t tgt_cb_func;
227 /* target/tgt_main.c */
228 void tgt_boot_epoch_update(struct lu_target *lut);
229 int tgt_last_commit_cb_add(struct thandle *th, struct lu_target *lut,
230 struct obd_export *exp, __u64 transno);
231 int tgt_new_client_cb_add(struct thandle *th, struct obd_export *exp);
232 int tgt_init(const struct lu_env *env, struct lu_target *lut,
233 struct obd_device *obd, struct dt_device *dt,
234 struct tgt_opc_slice *slice,
235 int request_fail_id, int reply_fail_id);
236 void tgt_fini(const struct lu_env *env, struct lu_target *lut);
237 int tgt_client_alloc(struct obd_export *exp);
238 void tgt_client_free(struct obd_export *exp);
239 int tgt_client_del(const struct lu_env *env, struct obd_export *exp);
240 int tgt_client_add(const struct lu_env *env, struct obd_export *exp, int);
241 int tgt_client_new(const struct lu_env *env, struct obd_export *exp);
242 int tgt_client_data_read(const struct lu_env *env, struct lu_target *tg,
243 struct lsd_client_data *lcd, loff_t *off, int index);
244 int tgt_client_data_write(const struct lu_env *env, struct lu_target *tg,
245 struct lsd_client_data *lcd, loff_t *off, struct thandle *th);
246 int tgt_server_data_read(const struct lu_env *env, struct lu_target *tg);
247 int tgt_server_data_write(const struct lu_env *env, struct lu_target *tg,
249 int tgt_server_data_update(const struct lu_env *env, struct lu_target *tg,
251 int tgt_truncate_last_rcvd(const struct lu_env *env, struct lu_target *tg,
253 int tgt_last_rcvd_update(const struct lu_env *env, struct lu_target *tgt,
254 struct dt_object *obj, __u64 opdata,
255 struct thandle *th, struct ptlrpc_request *req);
260 static inline int err_serious(int rc)
263 return -(-rc | ESERIOUS);
266 static inline int clear_serious(int rc)
269 rc = -(-rc & ~ESERIOUS);
273 static inline int is_serious(int rc)
275 return (rc < 0 && -rc & ESERIOUS);
279 * Unified target generic handers macros and generic functions.
281 #define TGT_RPC_HANDLER(base, flags, opc, fn, fmt, version) \
284 .th_fail_id = OBD_FAIL_ ## opc ## _NET, \
289 .th_version = version \
292 /* MDT Request with a format known in advance */
293 #define TGT_MDT_HDL(flags, name, fn) \
294 TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
296 /* Request with a format we do not yet know */
297 #define TGT_MDT_HDL_VAR(flags, name, fn) \
298 TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, NULL, \
301 /* MGS request with a format known in advance */
302 #define TGT_MGS_HDL(flags, name, fn) \
303 TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
305 #define TGT_MGS_HDL_VAR(flags, name, fn) \
306 TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, NULL, \
310 * OBD handler macros and generic functions.
312 #define TGT_OBD_HDL(flags, name, fn) \
313 TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
315 #define TGT_OBD_HDL_VAR(flags, name, fn) \
316 TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, NULL, \
320 * DLM handler macros and generic functions.
322 #define TGT_DLM_HDL_VAR(flags, name, fn) \
323 TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, NULL, \
325 #define TGT_DLM_HDL(flags, name, fn) \
326 TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
330 * LLOG handler macros and generic functions.
332 #define TGT_LLOG_HDL_VAR(flags, name, fn) \
333 TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, NULL, \
335 #define TGT_LLOG_HDL(flags, name, fn) \
336 TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
340 * Sec context handler macros and generic functions.
342 #define TGT_SEC_HDL_VAR(flags, name, fn) \
343 TGT_RPC_HANDLER(SEC_FIRST_OPC, flags, name, fn, NULL, \
346 #define TGT_QUOTA_HDL(flags, name, fn) \
347 TGT_RPC_HANDLER(QUOTA_DQACQ, flags, name, fn, &RQF_ ## name, \
350 /* Sequence service handlers */
351 #define TGT_SEQ_HDL(flags, name, fn) \
352 TGT_RPC_HANDLER(SEQ_QUERY, flags, name, fn, &RQF_ ## name, \
355 /* FID Location Database handlers */
356 #define TGT_FLD_HDL(flags, name, fn) \
357 TGT_RPC_HANDLER(FLD_QUERY, flags, name, fn, &RQF_ ## name, \
360 /* Request with a format known in advance */
361 #define TGT_UPDATE_HDL(flags, name, fn) \
362 TGT_RPC_HANDLER(UPDATE_OBJ, flags, name, fn, &RQF_ ## name, \
365 #endif /* __LUSTRE_LU_TARGET_H */