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, 2015, 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 /* Each one represents a distribute transaction replay
47 * operation, and updates on each MDTs are linked to
49 struct distribute_txn_replay_req {
50 /* update record, may be vmalloc'd */
51 struct llog_update_record *dtrq_lur;
54 /* linked to the distribute transaction replay
55 * list (tdtd_replay_list) */
56 struct list_head dtrq_list;
57 __u64 dtrq_master_transno;
61 /* all of sub updates are linked here */
62 struct list_head dtrq_sub_list;
63 spinlock_t dtrq_sub_list_lock;
65 /* If the local update has been executed during replay */
66 __u32 dtrq_local_update_executed:1;
69 /* Each one represents a sub replay item under a distribute
70 * transaction. A distribute transaction will be operated in
71 * two or more MDTs, and updates on each MDT will be represented
72 * by this structure */
73 struct distribute_txn_replay_req_sub {
74 __u32 dtrqs_mdt_index;
76 /* All of cookies for the update will be linked here */
77 spinlock_t dtrqs_cookie_list_lock;
78 struct list_head dtrqs_cookie_list;
79 struct list_head dtrqs_list;
82 struct target_distribute_txn_data;
83 typedef int (*distribute_txn_replay_handler_t)(struct lu_env *env,
84 struct target_distribute_txn_data *tdtd,
85 struct distribute_txn_replay_req *dtrq);
86 struct target_distribute_txn_data {
87 /* Distribution ID is used to identify updates log on different
88 * MDTs for one operation */
89 spinlock_t tdtd_batchid_lock;
91 struct lu_target *tdtd_lut;
92 struct dt_object *tdtd_batchid_obj;
93 struct dt_device *tdtd_dt;
95 /* Committed batchid for distribute transaction */
96 __u64 tdtd_committed_batchid;
98 /* List for distribute transaction */
99 struct list_head tdtd_list;
101 /* Threads to manage distribute transaction */
102 wait_queue_head_t tdtd_commit_thread_waitq;
103 atomic_t tdtd_refcount;
105 /* recovery update */
106 distribute_txn_replay_handler_t tdtd_replay_handler;
107 struct list_head tdtd_replay_list;
108 struct list_head tdtd_replay_finish_list;
109 spinlock_t tdtd_replay_list_lock;
110 /* last replay update transno */
111 __u32 tdtd_replay_ready:1;
113 /* Manage the llog recovery threads */
114 atomic_t tdtd_recovery_threads_count;
115 wait_queue_head_t tdtd_recovery_threads_waitq;
119 struct obd_device *lut_obd;
120 struct dt_device *lut_bottom;
122 struct target_distribute_txn_data *lut_tdtd;
123 struct ptlrpc_thread lut_tdtd_commit_thread;
125 /* supported opcodes and handlers for this target */
126 struct tgt_opc_slice *lut_slice;
127 __u32 lut_reply_fail_id;
128 __u32 lut_request_fail_id;
131 rwlock_t lut_sptlrpc_lock;
132 struct sptlrpc_rule_set lut_sptlrpc_rset;
133 spinlock_t lut_flags_lock;
135 unsigned int lut_syncjournal:1,
136 lut_sync_lock_cancel:2,
138 lut_no_reconstruct:1;
139 /** last_rcvd file */
140 struct dt_object *lut_last_rcvd;
141 /* transaction callbacks */
142 struct dt_txn_callback lut_txn_cb;
143 /** server data in last_rcvd file */
144 struct lr_server_data lut_lsd;
145 /** Server last transaction number */
146 __u64 lut_last_transno;
147 /** Lock protecting last transaction number */
148 spinlock_t lut_translock;
149 /** Lock protecting client bitmap */
150 spinlock_t lut_client_bitmap_lock;
151 /** Bitmap of known clients */
152 unsigned long *lut_client_bitmap;
153 /* Number of clients supporting multiple modify RPCs
154 * recorded in the bitmap */
155 atomic_t lut_num_clients;
156 /* Client generation to identify client slot reuse */
157 atomic_t lut_client_generation;
158 /** reply_data file */
159 struct dt_object *lut_reply_data;
160 /** Bitmap of used slots in the reply data file */
161 unsigned long **lut_reply_bitmap;
162 /** target sync count, used for debug & test */
163 atomic_t lut_sync_count;
166 /* number of slots in reply bitmap */
167 #define LUT_REPLY_SLOTS_PER_CHUNK (1<<20)
168 #define LUT_REPLY_SLOTS_MAX_CHUNKS 16
173 struct tg_reply_data {
174 /** chain of reply data anchored in tg_export_data */
175 struct list_head trd_list;
176 /** copy of on-disk reply data */
177 struct lsd_reply_data trd_reply;
178 /** versions for Version Based Recovery */
179 __u64 trd_pre_versions[4];
180 /** slot index in reply_data file */
182 /** tag the client used */
186 extern struct lu_context_key tgt_session_key;
188 struct tgt_session_info {
190 * The following members will be filled explicitly
191 * with specific data in tgt_ses_init().
193 struct req_capsule *tsi_pill;
196 * Lock request for "habeo clavis" operations.
198 struct ldlm_request *tsi_dlm_req;
200 /* although we have export in req, there are cases when it is not
201 * available, e.g. closing files upon export destroy */
202 struct obd_export *tsi_exp;
203 const struct lu_env *tsi_env;
204 struct lu_target *tsi_tgt;
206 const struct mdt_body *tsi_mdt_body;
207 struct ost_body *tsi_ost_body;
208 struct lu_object *tsi_corpus;
210 struct lu_fid tsi_fid;
211 struct ldlm_res_id tsi_resid;
213 /* object affected by VBR, for last_rcvd_update */
214 struct dt_object *tsi_vbr_obj;
215 /* opdata for mdt_reint_open(), has the same value as
216 * ldlm_reply:lock_policy_res1. The tgt_update_last_rcvd() stores
217 * this value onto disk for recovery when tgt_txn_stop_cb() is called.
222 * Additional fail id that can be set by handler.
224 int tsi_reply_fail_id;
225 bool tsi_preprocessed;
232 __u32 tsi_client_gen;
235 static inline struct tgt_session_info *tgt_ses_info(const struct lu_env *env)
237 struct tgt_session_info *tsi;
239 LASSERT(env->le_ses != NULL);
240 tsi = lu_context_key_get(env->le_ses, &tgt_session_key);
245 static inline void tgt_vbr_obj_set(const struct lu_env *env,
246 struct dt_object *obj)
248 struct tgt_session_info *tsi;
250 if (env->le_ses != NULL) {
251 tsi = tgt_ses_info(env);
252 tsi->tsi_vbr_obj = obj;
256 static inline void tgt_opdata_set(const struct lu_env *env, __u64 flags)
258 struct tgt_session_info *tsi;
260 if (env->le_ses != NULL) {
261 tsi = tgt_ses_info(env);
262 tsi->tsi_opdata |= flags;
266 static inline void tgt_opdata_clear(const struct lu_env *env, __u64 flags)
268 struct tgt_session_info *tsi;
270 if (env->le_ses != NULL) {
271 tsi = tgt_ses_info(env);
272 tsi->tsi_opdata &= ~flags;
277 * Generic unified target support.
279 enum tgt_handler_flags {
281 * struct *_body is passed in the incoming message, and object
282 * identified by this fid exists on disk.
284 * "habeo corpus" == "I have a body"
286 HABEO_CORPUS = (1 << 0),
288 * struct ldlm_request is passed in the incoming message.
290 * "habeo clavis" == "I have a key"
292 HABEO_CLAVIS = (1 << 1),
294 * this request has fixed reply format, so that reply message can be
295 * packed by generic code.
297 * "habeo refero" == "I have a reply"
299 HABEO_REFERO = (1 << 2),
301 * this request will modify something, so check whether the file system
302 * is readonly or not, then return -EROFS to client asap if necessary.
304 * "mutabor" == "I shall modify"
310 /* The name of this handler. */
312 /* Fail id, check at the beginning */
316 /* Flags in enum tgt_handler_flags */
318 /* Request version for this opcode */
320 /* Handler function */
321 int (*th_act)(struct tgt_session_info *tsi);
322 /* Handler function for high priority requests */
323 void (*th_hp)(struct tgt_session_info *tsi);
324 /* Request format for this request */
325 const struct req_format *th_fmt;
328 struct tgt_opc_slice {
329 __u32 tos_opc_start; /* First op code */
330 __u32 tos_opc_end; /* Last op code */
331 struct tgt_handler *tos_hs; /* Registered handler */
334 static inline struct ptlrpc_request *tgt_ses_req(struct tgt_session_info *tsi)
336 return tsi->tsi_pill ? tsi->tsi_pill->rc_req : NULL;
339 static inline __u64 tgt_conn_flags(struct tgt_session_info *tsi)
341 LASSERT(tsi->tsi_exp);
342 return exp_connect_flags(tsi->tsi_exp);
345 static inline int req_is_replay(struct ptlrpc_request *req)
347 LASSERT(req->rq_reqmsg);
348 return !!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY);
351 static inline bool tgt_is_multimodrpcs_client(struct obd_export *exp)
353 return exp_connect_flags(exp) & OBD_CONNECT_MULTIMODRPCS;
357 /* target/tgt_handler.c */
358 int tgt_request_handle(struct ptlrpc_request *req);
359 char *tgt_name(struct lu_target *tgt);
360 void tgt_counter_incr(struct obd_export *exp, int opcode);
361 int tgt_connect_check_sptlrpc(struct ptlrpc_request *req,
362 struct obd_export *exp);
363 int tgt_adapt_sptlrpc_conf(struct lu_target *tgt, int initial);
364 int tgt_connect(struct tgt_session_info *tsi);
365 int tgt_disconnect(struct tgt_session_info *uti);
366 int tgt_obd_ping(struct tgt_session_info *tsi);
367 int tgt_enqueue(struct tgt_session_info *tsi);
368 int tgt_convert(struct tgt_session_info *tsi);
369 int tgt_bl_callback(struct tgt_session_info *tsi);
370 int tgt_cp_callback(struct tgt_session_info *tsi);
371 int tgt_llog_open(struct tgt_session_info *tsi);
372 int tgt_llog_close(struct tgt_session_info *tsi);
373 int tgt_llog_destroy(struct tgt_session_info *tsi);
374 int tgt_llog_read_header(struct tgt_session_info *tsi);
375 int tgt_llog_next_block(struct tgt_session_info *tsi);
376 int tgt_llog_prev_block(struct tgt_session_info *tsi);
377 int tgt_sec_ctx_init(struct tgt_session_info *tsi);
378 int tgt_sec_ctx_init_cont(struct tgt_session_info *tsi);
379 int tgt_sec_ctx_fini(struct tgt_session_info *tsi);
380 int tgt_sendpage(struct tgt_session_info *tsi, struct lu_rdpg *rdpg, int nob);
381 int tgt_send_buffer(struct tgt_session_info *tsi, struct lu_rdbuf *rdbuf);
382 int tgt_validate_obdo(struct tgt_session_info *tsi, struct obdo *oa);
383 int tgt_sync(const struct lu_env *env, struct lu_target *tgt,
384 struct dt_object *obj, __u64 start, __u64 end);
386 int tgt_io_thread_init(struct ptlrpc_thread *thread);
387 void tgt_io_thread_done(struct ptlrpc_thread *thread);
389 int tgt_extent_lock(struct ldlm_namespace *ns, struct ldlm_res_id *res_id,
390 __u64 start, __u64 end, struct lustre_handle *lh,
391 int mode, __u64 *flags);
392 void tgt_extent_unlock(struct lustre_handle *lh, enum ldlm_mode mode);
393 int tgt_brw_lock(struct ldlm_namespace *ns, struct ldlm_res_id *res_id,
394 struct obd_ioobj *obj, struct niobuf_remote *nb,
395 struct lustre_handle *lh, enum ldlm_mode mode);
396 void tgt_brw_unlock(struct obd_ioobj *obj, struct niobuf_remote *niob,
397 struct lustre_handle *lh, enum ldlm_mode mode);
398 int tgt_brw_read(struct tgt_session_info *tsi);
399 int tgt_brw_write(struct tgt_session_info *tsi);
400 int tgt_hpreq_handler(struct ptlrpc_request *req);
401 void tgt_register_lfsck_in_notify(int (*notify)(const struct lu_env *,
403 struct lfsck_request *,
405 void tgt_register_lfsck_query(int (*query)(const struct lu_env *,
407 struct lfsck_request *,
408 struct lfsck_reply *,
409 struct lfsck_query *));
410 bool req_can_reconstruct(struct ptlrpc_request *req, struct tg_reply_data *trd);
412 extern struct tgt_handler tgt_sec_ctx_handlers[];
413 extern struct tgt_handler tgt_lfsck_handlers[];
414 extern struct tgt_handler tgt_obd_handlers[];
415 extern struct tgt_handler tgt_dlm_handlers[];
416 extern struct tgt_handler tgt_llog_handlers[];
417 extern struct tgt_handler tgt_out_handlers[];
418 extern struct tgt_handler fld_handlers[];
419 extern struct tgt_handler seq_handlers[];
421 typedef void (*tgt_cb_t)(struct lu_target *lut, __u64 transno,
422 void *data, int err);
423 struct tgt_commit_cb {
424 tgt_cb_t tgt_cb_func;
428 int tgt_hpreq_handler(struct ptlrpc_request *req);
430 /* target/tgt_main.c */
431 void tgt_boot_epoch_update(struct lu_target *lut);
432 void tgt_save_slc_lock(struct ldlm_lock *lock, __u64 transno);
433 void tgt_discard_slc_lock(struct ldlm_lock *lock);
434 int tgt_last_commit_cb_add(struct thandle *th, struct lu_target *lut,
435 struct obd_export *exp, __u64 transno);
436 int tgt_new_client_cb_add(struct thandle *th, struct obd_export *exp);
437 int tgt_init(const struct lu_env *env, struct lu_target *lut,
438 struct obd_device *obd, struct dt_device *dt,
439 struct tgt_opc_slice *slice,
440 int request_fail_id, int reply_fail_id);
441 void tgt_fini(const struct lu_env *env, struct lu_target *lut);
442 int tgt_client_alloc(struct obd_export *exp);
443 void tgt_client_free(struct obd_export *exp);
444 int tgt_client_del(const struct lu_env *env, struct obd_export *exp);
445 int tgt_client_add(const struct lu_env *env, struct obd_export *exp, int);
446 int tgt_client_new(const struct lu_env *env, struct obd_export *exp);
447 int tgt_client_data_read(const struct lu_env *env, struct lu_target *tg,
448 struct lsd_client_data *lcd, loff_t *off, int index);
449 int tgt_client_data_write(const struct lu_env *env, struct lu_target *tg,
450 struct lsd_client_data *lcd, loff_t *off, struct thandle *th);
451 int tgt_server_data_read(const struct lu_env *env, struct lu_target *tg);
452 int tgt_server_data_write(const struct lu_env *env, struct lu_target *tg,
454 int tgt_server_data_update(const struct lu_env *env, struct lu_target *tg,
456 int tgt_truncate_last_rcvd(const struct lu_env *env, struct lu_target *tg,
458 int tgt_reply_data_init(const struct lu_env *env, struct lu_target *tgt);
459 bool tgt_lookup_reply(struct ptlrpc_request *req, struct tg_reply_data *trd);
460 int tgt_add_reply_data(const struct lu_env *env, struct lu_target *tgt,
461 struct tg_export_data *ted, struct tg_reply_data *trd,
462 struct thandle *th, bool update_lrd_file);
463 struct tg_reply_data *tgt_lookup_reply_by_xid(struct tg_export_data *ted,
466 /* target/update_trans.c */
467 int distribute_txn_init(const struct lu_env *env,
468 struct lu_target *lut,
469 struct target_distribute_txn_data *tdtd,
471 void distribute_txn_fini(const struct lu_env *env,
472 struct target_distribute_txn_data *tdtd);
474 /* target/update_recovery.c */
475 int insert_update_records_to_replay_list(struct target_distribute_txn_data *,
476 struct llog_update_record *,
477 struct llog_cookie *, __u32);
478 void dtrq_list_dump(struct target_distribute_txn_data *tdtd,
480 void dtrq_list_destroy(struct target_distribute_txn_data *tdtd);
481 int distribute_txn_replay_handle(struct lu_env *env,
482 struct target_distribute_txn_data *tdtd,
483 struct distribute_txn_replay_req *dtrq);
484 __u64 distribute_txn_get_next_transno(struct target_distribute_txn_data *tdtd);
485 struct distribute_txn_replay_req *
486 distribute_txn_get_next_req(struct target_distribute_txn_data *tdtd);
487 void dtrq_destroy(struct distribute_txn_replay_req *dtrq);
488 struct distribute_txn_replay_req_sub *
489 dtrq_sub_lookup(struct distribute_txn_replay_req *dtrq, __u32 mdt_index);
490 struct distribute_txn_replay_req *
491 distribute_txn_lookup_finish_list(struct target_distribute_txn_data *tdtd,
493 bool is_req_replayed_by_update(struct ptlrpc_request *req);
498 static inline int err_serious(int rc)
501 return -(-rc | ESERIOUS);
504 static inline int clear_serious(int rc)
507 rc = -(-rc & ~ESERIOUS);
511 static inline int is_serious(int rc)
513 return (rc < 0 && -rc & ESERIOUS);
517 * Do not return server-side uid/gid to remote client
519 static inline void tgt_drop_id(struct obd_export *exp, struct obdo *oa)
521 if (unlikely(exp_connect_rmtclient(exp))) {
524 oa->o_valid &= ~(OBD_MD_FLUID | OBD_MD_FLGID);
529 * Unified target generic handers macros and generic functions.
531 #define TGT_RPC_HANDLER_HP(base, flags, opc, fn, hp, fmt, version) \
534 .th_fail_id = OBD_FAIL_ ## opc ## _NET, \
539 .th_version = version, \
542 #define TGT_RPC_HANDLER(base, flags, opc, fn, fmt, version) \
543 TGT_RPC_HANDLER_HP(base, flags, opc, fn, NULL, fmt, version)
545 /* MDT Request with a format known in advance */
546 #define TGT_MDT_HDL(flags, name, fn) \
547 TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
549 /* Request with a format we do not yet know */
550 #define TGT_MDT_HDL_VAR(flags, name, fn) \
551 TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, NULL, \
554 /* OST Request with a format known in advance */
555 #define TGT_OST_HDL(flags, name, fn) \
556 TGT_RPC_HANDLER(OST_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
558 #define TGT_OST_HDL_HP(flags, name, fn, hp) \
559 TGT_RPC_HANDLER_HP(OST_FIRST_OPC, flags, name, fn, hp, \
560 &RQF_ ## name, LUSTRE_OST_VERSION)
562 /* MGS request with a format known in advance */
563 #define TGT_MGS_HDL(flags, name, fn) \
564 TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
566 #define TGT_MGS_HDL_VAR(flags, name, fn) \
567 TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, NULL, \
571 * OBD handler macros and generic functions.
573 #define TGT_OBD_HDL(flags, name, fn) \
574 TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
576 #define TGT_OBD_HDL_VAR(flags, name, fn) \
577 TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, NULL, \
581 * DLM handler macros and generic functions.
583 #define TGT_DLM_HDL_VAR(flags, name, fn) \
584 TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, NULL, \
586 #define TGT_DLM_HDL(flags, name, fn) \
587 TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
591 * LLOG handler macros and generic functions.
593 #define TGT_LLOG_HDL_VAR(flags, name, fn) \
594 TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, NULL, \
596 #define TGT_LLOG_HDL(flags, name, fn) \
597 TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
601 * Sec context handler macros and generic functions.
603 #define TGT_SEC_HDL_VAR(flags, name, fn) \
604 TGT_RPC_HANDLER(SEC_FIRST_OPC, flags, name, fn, NULL, \
607 #define TGT_QUOTA_HDL(flags, name, fn) \
608 TGT_RPC_HANDLER(QUOTA_DQACQ, flags, name, fn, &RQF_ ## name, \
611 /* Sequence service handlers */
612 #define TGT_SEQ_HDL(flags, name, fn) \
613 TGT_RPC_HANDLER(SEQ_QUERY, flags, name, fn, &RQF_ ## name, \
616 /* FID Location Database handlers */
617 #define TGT_FLD_HDL_VAR(flags, name, fn) \
618 TGT_RPC_HANDLER(FLD_QUERY, flags, name, fn, NULL, \
622 #define TGT_LFSCK_HDL(flags, name, fn) \
623 TGT_RPC_HANDLER(LFSCK_FIRST_OPC, flags, name, fn, \
624 &RQF_ ## name, LUSTRE_OBD_VERSION)
626 /* Request with a format known in advance */
627 #define TGT_UPDATE_HDL(flags, name, fn) \
628 TGT_RPC_HANDLER(OUT_UPDATE, flags, name, fn, &RQF_ ## name, \
631 #endif /* __LUSTRE_LU_TARGET_H */