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, 2014, 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>
44 #include <lustre_lfsck.h>
46 struct target_distribute_txn_data {
47 /* Distribution ID is used to identify updates log on different
48 * MDTs for one operation */
49 spinlock_t tdtd_batchid_lock;
51 struct lu_target *tdtd_lut;
52 struct dt_object *tdtd_batchid_obj;
54 /* Committed batchid for distribute transaction */
55 __u64 tdtd_committed_batchid;
57 /* List for distribute transaction */
58 struct list_head tdtd_list;
60 /* Threads to manage distribute transaction */
61 wait_queue_head_t tdtd_commit_thread_waitq;
62 atomic_t tdtd_refcount;
66 struct obd_device *lut_obd;
67 struct dt_device *lut_bottom;
69 struct target_distribute_txn_data *lut_tdtd;
70 struct ptlrpc_thread lut_tdtd_commit_thread;
72 /* supported opcodes and handlers for this target */
73 struct tgt_opc_slice *lut_slice;
74 __u32 lut_reply_fail_id;
75 __u32 lut_request_fail_id;
78 rwlock_t lut_sptlrpc_lock;
79 struct sptlrpc_rule_set lut_sptlrpc_rset;
80 spinlock_t lut_flags_lock;
82 unsigned int lut_syncjournal:1,
83 lut_sync_lock_cancel:2,
87 struct dt_object *lut_last_rcvd;
88 /* transaction callbacks */
89 struct dt_txn_callback lut_txn_cb;
90 /** server data in last_rcvd file */
91 struct lr_server_data lut_lsd;
92 /** Server last transaction number */
93 __u64 lut_last_transno;
94 /** Lock protecting last transaction number */
95 spinlock_t lut_translock;
96 /** Lock protecting client bitmap */
97 spinlock_t lut_client_bitmap_lock;
98 /** Bitmap of known clients */
99 unsigned long *lut_client_bitmap;
102 extern struct lu_context_key tgt_session_key;
104 struct tgt_session_info {
106 * The following members will be filled explicitly
107 * with specific data in tgt_ses_init().
109 struct req_capsule *tsi_pill;
112 * Lock request for "habeo clavis" operations.
114 struct ldlm_request *tsi_dlm_req;
116 /* although we have export in req, there are cases when it is not
117 * available, e.g. closing files upon export destroy */
118 struct obd_export *tsi_exp;
119 const struct lu_env *tsi_env;
120 struct lu_target *tsi_tgt;
122 const struct mdt_body *tsi_mdt_body;
123 struct ost_body *tsi_ost_body;
124 struct lu_object *tsi_corpus;
126 struct lu_fid tsi_fid;
127 struct ldlm_res_id tsi_resid;
129 /* object affected by VBR, for last_rcvd_update */
130 struct dt_object *tsi_vbr_obj;
131 /* opdata for mdt_reint_open(), has the same value as
132 * ldlm_reply:lock_policy_res1. The tgt_update_last_rcvd() stores
133 * this value onto disk for recovery when tgt_txn_stop_cb() is called.
138 * Additional fail id that can be set by handler.
140 int tsi_reply_fail_id;
141 bool tsi_preprocessed;
146 static inline struct tgt_session_info *tgt_ses_info(const struct lu_env *env)
148 struct tgt_session_info *tsi;
150 LASSERT(env->le_ses != NULL);
151 tsi = lu_context_key_get(env->le_ses, &tgt_session_key);
156 static inline void tgt_vbr_obj_set(const struct lu_env *env,
157 struct dt_object *obj)
159 struct tgt_session_info *tsi;
161 if (env->le_ses != NULL) {
162 tsi = tgt_ses_info(env);
163 tsi->tsi_vbr_obj = obj;
167 static inline void tgt_opdata_set(const struct lu_env *env, __u64 flags)
169 struct tgt_session_info *tsi;
171 if (env->le_ses != NULL) {
172 tsi = tgt_ses_info(env);
173 tsi->tsi_opdata |= flags;
177 static inline void tgt_opdata_clear(const struct lu_env *env, __u64 flags)
179 struct tgt_session_info *tsi;
181 if (env->le_ses != NULL) {
182 tsi = tgt_ses_info(env);
183 tsi->tsi_opdata &= ~flags;
188 * Generic unified target support.
190 enum tgt_handler_flags {
192 * struct *_body is passed in the incoming message, and object
193 * identified by this fid exists on disk.
195 * "habeo corpus" == "I have a body"
197 HABEO_CORPUS = (1 << 0),
199 * struct ldlm_request is passed in the incoming message.
201 * "habeo clavis" == "I have a key"
203 HABEO_CLAVIS = (1 << 1),
205 * this request has fixed reply format, so that reply message can be
206 * packed by generic code.
208 * "habeo refero" == "I have a reply"
210 HABEO_REFERO = (1 << 2),
212 * this request will modify something, so check whether the file system
213 * is readonly or not, then return -EROFS to client asap if necessary.
215 * "mutabor" == "I shall modify"
221 /* The name of this handler. */
223 /* Fail id, check at the beginning */
227 /* Flags in enum tgt_handler_flags */
229 /* Request version for this opcode */
231 /* Handler function */
232 int (*th_act)(struct tgt_session_info *tsi);
233 /* Handler function for high priority requests */
234 void (*th_hp)(struct tgt_session_info *tsi);
235 /* Request format for this request */
236 const struct req_format *th_fmt;
239 struct tgt_opc_slice {
240 __u32 tos_opc_start; /* First op code */
241 __u32 tos_opc_end; /* Last op code */
242 struct tgt_handler *tos_hs; /* Registered handler */
245 static inline struct ptlrpc_request *tgt_ses_req(struct tgt_session_info *tsi)
247 return tsi->tsi_pill ? tsi->tsi_pill->rc_req : NULL;
250 static inline __u64 tgt_conn_flags(struct tgt_session_info *tsi)
252 LASSERT(tsi->tsi_exp);
253 return exp_connect_flags(tsi->tsi_exp);
256 static inline int req_is_replay(struct ptlrpc_request *req)
258 LASSERT(req->rq_reqmsg);
259 return !!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY);
262 /* target/tgt_handler.c */
263 int tgt_request_handle(struct ptlrpc_request *req);
264 char *tgt_name(struct lu_target *tgt);
265 void tgt_counter_incr(struct obd_export *exp, int opcode);
266 int tgt_connect_check_sptlrpc(struct ptlrpc_request *req,
267 struct obd_export *exp);
268 int tgt_adapt_sptlrpc_conf(struct lu_target *tgt, int initial);
269 int tgt_connect(struct tgt_session_info *tsi);
270 int tgt_disconnect(struct tgt_session_info *uti);
271 int tgt_obd_ping(struct tgt_session_info *tsi);
272 int tgt_enqueue(struct tgt_session_info *tsi);
273 int tgt_convert(struct tgt_session_info *tsi);
274 int tgt_bl_callback(struct tgt_session_info *tsi);
275 int tgt_cp_callback(struct tgt_session_info *tsi);
276 int tgt_llog_open(struct tgt_session_info *tsi);
277 int tgt_llog_close(struct tgt_session_info *tsi);
278 int tgt_llog_destroy(struct tgt_session_info *tsi);
279 int tgt_llog_read_header(struct tgt_session_info *tsi);
280 int tgt_llog_next_block(struct tgt_session_info *tsi);
281 int tgt_llog_prev_block(struct tgt_session_info *tsi);
282 int tgt_sec_ctx_init(struct tgt_session_info *tsi);
283 int tgt_sec_ctx_init_cont(struct tgt_session_info *tsi);
284 int tgt_sec_ctx_fini(struct tgt_session_info *tsi);
285 int tgt_sendpage(struct tgt_session_info *tsi, struct lu_rdpg *rdpg, int nob);
286 int tgt_validate_obdo(struct tgt_session_info *tsi, struct obdo *oa);
287 int tgt_sync(const struct lu_env *env, struct lu_target *tgt,
288 struct dt_object *obj, __u64 start, __u64 end);
290 int tgt_io_thread_init(struct ptlrpc_thread *thread);
291 void tgt_io_thread_done(struct ptlrpc_thread *thread);
293 int tgt_extent_lock(struct ldlm_namespace *ns, struct ldlm_res_id *res_id,
294 __u64 start, __u64 end, struct lustre_handle *lh,
295 int mode, __u64 *flags);
296 void tgt_extent_unlock(struct lustre_handle *lh, ldlm_mode_t mode);
297 int tgt_brw_lock(struct ldlm_namespace *ns, struct ldlm_res_id *res_id,
298 struct obd_ioobj *obj, struct niobuf_remote *nb,
299 struct lustre_handle *lh, int mode);
300 void tgt_brw_unlock(struct obd_ioobj *obj, struct niobuf_remote *niob,
301 struct lustre_handle *lh, int mode);
302 int tgt_brw_read(struct tgt_session_info *tsi);
303 int tgt_brw_write(struct tgt_session_info *tsi);
304 int tgt_hpreq_handler(struct ptlrpc_request *req);
305 void tgt_register_lfsck_in_notify(int (*notify)(const struct lu_env *,
307 struct lfsck_request *,
309 void tgt_register_lfsck_query(int (*query)(const struct lu_env *,
311 struct lfsck_request *));
313 extern struct tgt_handler tgt_sec_ctx_handlers[];
314 extern struct tgt_handler tgt_lfsck_handlers[];
315 extern struct tgt_handler tgt_obd_handlers[];
316 extern struct tgt_handler tgt_dlm_handlers[];
317 extern struct tgt_handler tgt_llog_handlers[];
318 extern struct tgt_handler tgt_out_handlers[];
319 extern struct tgt_handler fld_handlers[];
320 extern struct tgt_handler seq_handlers[];
322 typedef void (*tgt_cb_t)(struct lu_target *lut, __u64 transno,
323 void *data, int err);
324 struct tgt_commit_cb {
325 tgt_cb_t tgt_cb_func;
329 int tgt_hpreq_handler(struct ptlrpc_request *req);
331 /* target/tgt_main.c */
332 void tgt_boot_epoch_update(struct lu_target *lut);
333 int tgt_last_commit_cb_add(struct thandle *th, struct lu_target *lut,
334 struct obd_export *exp, __u64 transno);
335 int tgt_new_client_cb_add(struct thandle *th, struct obd_export *exp);
336 int tgt_init(const struct lu_env *env, struct lu_target *lut,
337 struct obd_device *obd, struct dt_device *dt,
338 struct tgt_opc_slice *slice,
339 int request_fail_id, int reply_fail_id);
340 void tgt_fini(const struct lu_env *env, struct lu_target *lut);
341 int tgt_client_alloc(struct obd_export *exp);
342 void tgt_client_free(struct obd_export *exp);
343 int tgt_client_del(const struct lu_env *env, struct obd_export *exp);
344 int tgt_client_add(const struct lu_env *env, struct obd_export *exp, int);
345 int tgt_client_new(const struct lu_env *env, struct obd_export *exp);
346 int tgt_client_data_read(const struct lu_env *env, struct lu_target *tg,
347 struct lsd_client_data *lcd, loff_t *off, int index);
348 int tgt_client_data_write(const struct lu_env *env, struct lu_target *tg,
349 struct lsd_client_data *lcd, loff_t *off, struct thandle *th);
350 int tgt_server_data_read(const struct lu_env *env, struct lu_target *tg);
351 int tgt_server_data_write(const struct lu_env *env, struct lu_target *tg,
353 int tgt_server_data_update(const struct lu_env *env, struct lu_target *tg,
355 int tgt_truncate_last_rcvd(const struct lu_env *env, struct lu_target *tg,
358 /* target/update_trans.c */
359 int distribute_txn_init(const struct lu_env *env,
360 struct lu_target *lut,
361 struct target_distribute_txn_data *tdtd,
363 void distribute_txn_fini(const struct lu_env *env,
364 struct target_distribute_txn_data *tdtd);
371 static inline int err_serious(int rc)
374 return -(-rc | ESERIOUS);
377 static inline int clear_serious(int rc)
380 rc = -(-rc & ~ESERIOUS);
384 static inline int is_serious(int rc)
386 return (rc < 0 && -rc & ESERIOUS);
390 * Do not return server-side uid/gid to remote client
392 static inline void tgt_drop_id(struct obd_export *exp, struct obdo *oa)
394 if (unlikely(exp_connect_rmtclient(exp))) {
397 oa->o_valid &= ~(OBD_MD_FLUID | OBD_MD_FLGID);
402 * Unified target generic handers macros and generic functions.
404 #define TGT_RPC_HANDLER_HP(base, flags, opc, fn, hp, fmt, version) \
407 .th_fail_id = OBD_FAIL_ ## opc ## _NET, \
412 .th_version = version, \
415 #define TGT_RPC_HANDLER(base, flags, opc, fn, fmt, version) \
416 TGT_RPC_HANDLER_HP(base, flags, opc, fn, NULL, fmt, version)
418 /* MDT Request with a format known in advance */
419 #define TGT_MDT_HDL(flags, name, fn) \
420 TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
422 /* Request with a format we do not yet know */
423 #define TGT_MDT_HDL_VAR(flags, name, fn) \
424 TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, NULL, \
427 /* OST Request with a format known in advance */
428 #define TGT_OST_HDL(flags, name, fn) \
429 TGT_RPC_HANDLER(OST_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
431 #define TGT_OST_HDL_HP(flags, name, fn, hp) \
432 TGT_RPC_HANDLER_HP(OST_FIRST_OPC, flags, name, fn, hp, \
433 &RQF_ ## name, LUSTRE_OST_VERSION)
435 /* MGS request with a format known in advance */
436 #define TGT_MGS_HDL(flags, name, fn) \
437 TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
439 #define TGT_MGS_HDL_VAR(flags, name, fn) \
440 TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, NULL, \
444 * OBD handler macros and generic functions.
446 #define TGT_OBD_HDL(flags, name, fn) \
447 TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
449 #define TGT_OBD_HDL_VAR(flags, name, fn) \
450 TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, NULL, \
454 * DLM handler macros and generic functions.
456 #define TGT_DLM_HDL_VAR(flags, name, fn) \
457 TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, NULL, \
459 #define TGT_DLM_HDL(flags, name, fn) \
460 TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
464 * LLOG handler macros and generic functions.
466 #define TGT_LLOG_HDL_VAR(flags, name, fn) \
467 TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, NULL, \
469 #define TGT_LLOG_HDL(flags, name, fn) \
470 TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
474 * Sec context handler macros and generic functions.
476 #define TGT_SEC_HDL_VAR(flags, name, fn) \
477 TGT_RPC_HANDLER(SEC_FIRST_OPC, flags, name, fn, NULL, \
480 #define TGT_QUOTA_HDL(flags, name, fn) \
481 TGT_RPC_HANDLER(QUOTA_DQACQ, flags, name, fn, &RQF_ ## name, \
484 /* Sequence service handlers */
485 #define TGT_SEQ_HDL(flags, name, fn) \
486 TGT_RPC_HANDLER(SEQ_QUERY, flags, name, fn, &RQF_ ## name, \
489 /* FID Location Database handlers */
490 #define TGT_FLD_HDL_VAR(flags, name, fn) \
491 TGT_RPC_HANDLER(FLD_QUERY, flags, name, fn, NULL, \
495 #define TGT_LFSCK_HDL(flags, name, fn) \
496 TGT_RPC_HANDLER(LFSCK_FIRST_OPC, flags, name, fn, \
497 &RQF_ ## name, LUSTRE_OBD_VERSION)
499 /* Request with a format known in advance */
500 #define TGT_UPDATE_HDL(flags, name, fn) \
501 TGT_RPC_HANDLER(OUT_UPDATE, flags, name, fn, &RQF_ ## name, \
504 #endif /* __LUSTRE_LU_TARGET_H */