Whamcloud - gitweb
LU-3467 target: move OUT to the unified target code
[fs/lustre-release.git] / lustre / include / lu_target.h
index 1b41913..114073b 100644 (file)
@@ -27,7 +27,7 @@
  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
  *
- * Copyright (c) 2011, Whamcloud, Inc.
+ * Copyright (c) 2011, 2012, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
 #define _LUSTRE_LU_TARGET_H
 
 #include <dt_object.h>
+#include <lustre_export.h>
+#include <lustre_update.h>
 #include <lustre_disk.h>
 
 struct lu_target {
-        struct obd_device       *lut_obd;
-        struct dt_device        *lut_bottom;
-        /** last_rcvd file */
-        struct dt_object        *lut_last_rcvd;
-        /* transaction callbacks */
-        struct dt_txn_callback   lut_txn_cb;
-        /** server data in last_rcvd file */
-        struct lr_server_data    lut_lsd;
-        /** Server last transaction number */
-        __u64                    lut_last_transno;
-        /** Lock protecting last transaction number */
-        cfs_spinlock_t           lut_translock;
-        /** Lock protecting client bitmap */
-        cfs_spinlock_t           lut_client_bitmap_lock;
-        /** Bitmap of known clients */
-        unsigned long           *lut_client_bitmap;
+       struct obd_device       *lut_obd;
+       struct dt_device        *lut_bottom;
+
+       /* supported opcodes and handlers for this target */
+       struct tgt_opc_slice    *lut_slice;
+       __u32                    lut_reply_fail_id;
+       __u32                    lut_request_fail_id;
+
+       /* sptlrpc rules */
+       rwlock_t                 lut_sptlrpc_lock;
+       struct sptlrpc_rule_set  lut_sptlrpc_rset;
+       int                      lut_sec_level;
+       unsigned int             lut_mds_capa:1,
+                                lut_oss_capa:1;
+
+       /* LAST_RCVD parameters */
+       /** last_rcvd file */
+       struct dt_object        *lut_last_rcvd;
+       /* transaction callbacks */
+       struct dt_txn_callback   lut_txn_cb;
+       /** server data in last_rcvd file */
+       struct lr_server_data    lut_lsd;
+       /** Server last transaction number */
+       __u64                    lut_last_transno;
+       /** Lock protecting last transaction number */
+       spinlock_t               lut_translock;
+       /** Lock protecting client bitmap */
+       spinlock_t               lut_client_bitmap_lock;
+       /** Bitmap of known clients */
+       unsigned long           *lut_client_bitmap;
 };
 
-typedef void (*lut_cb_t)(struct lu_target *lut, __u64 transno,
-                         void *data, int err);
-struct lut_commit_cb {
-        lut_cb_t  lut_cb_func;
-        void     *lut_cb_data;
+extern struct lu_context_key tgt_session_key;
+
+struct tgt_session_info {
+       /*
+        * The following members will be filled explicitly
+        * with specific data in tgt_ses_init().
+        */
+       struct req_capsule      *tsi_pill;
+
+       /*
+        * Lock request for "habeo clavis" operations.
+        */
+       struct ldlm_request     *tsi_dlm_req;
+
+       /* although we have export in req, there are cases when it is not
+        * available, e.g. closing files upon export destroy */
+       struct obd_export       *tsi_exp;
+       const struct lu_env     *tsi_env;
+       struct lu_target        *tsi_tgt;
+       /*
+        * Additional fail id that can be set by handler.
+        */
+       int                      tsi_reply_fail_id;
+       int                      tsi_request_fail_id;
 };
 
-void lut_boot_epoch_update(struct lu_target *lut);
-int lut_last_commit_cb_add(struct thandle *th, struct lu_target *lut,
+static inline struct tgt_session_info *tgt_ses_info(const struct lu_env *env)
+{
+       struct tgt_session_info *tsi;
+
+       LASSERT(env->le_ses != NULL);
+       tsi = lu_context_key_get(env->le_ses, &tgt_session_key);
+       LASSERT(tsi);
+       return tsi;
+}
+
+/*
+ * Generic unified target support.
+ */
+enum tgt_handler_flags {
+       /*
+        * struct *_body is passed in the incoming message, and object
+        * identified by this fid exists on disk.
+        *                            *
+        * "habeo corpus" == "I have a body"
+        */
+       HABEO_CORPUS = (1 << 0),
+       /*
+        * struct ldlm_request is passed in the incoming message.
+        *
+        * "habeo clavis" == "I have a key"
+        *                                     */
+       HABEO_CLAVIS = (1 << 1),
+       /*
+        * this request has fixed reply format, so that reply message can be
+        * packed by generic code.
+        *
+        * "habeo refero" == "I have a reply"
+        */
+       HABEO_REFERO = (1 << 2),
+       /*
+        * this request will modify something, so check whether the file system
+        * is readonly or not, then return -EROFS to client asap if necessary.
+        *
+        * "mutabor" == "I shall modify"
+        */
+       MUTABOR      = (1 << 3)
+};
+
+struct tgt_handler {
+       /* The name of this handler. */
+       const char              *th_name;
+       /* Fail id, check at the beginning */
+       int                      th_fail_id;
+       /* Operation code */
+       __u32                    th_opc;
+       /* Flags in enum tgt_handler_flags */
+       __u32                    th_flags;
+       /* Request version for this opcode */
+       int                      th_version;
+       /* Handler function */
+       int                     (*th_act)(struct tgt_session_info *tti);
+       /* Request format for this request */
+       const struct req_format *th_fmt;
+};
+
+struct tgt_opc_slice {
+       __u32                    tos_opc_start; /* First op code */
+       __u32                    tos_opc_end; /* Last op code */
+       struct tgt_handler      *tos_hs; /* Registered handler */
+};
+
+static inline struct ptlrpc_request *tgt_ses_req(struct tgt_session_info *tsi)
+{
+       return tsi->tsi_pill ? tsi->tsi_pill->rc_req : NULL;
+}
+
+static inline __u64 tgt_conn_flags(struct tgt_session_info *tsi)
+{
+       LASSERT(tsi->tsi_exp);
+       return exp_connect_flags(tsi->tsi_exp);
+}
+
+static inline int req_is_replay(struct ptlrpc_request *req)
+{
+       LASSERT(req->rq_reqmsg);
+       return !!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY);
+}
+
+/* target/tgt_handler.c */
+int tgt_request_handle(struct ptlrpc_request *req);
+char *tgt_name(struct lu_target *tgt);
+void tgt_counter_incr(struct obd_export *exp, int opcode);
+int tgt_connect_check_sptlrpc(struct ptlrpc_request *req,
+                             struct obd_export *exp);
+int tgt_connect(struct tgt_session_info *tsi);
+int tgt_disconnect(struct tgt_session_info *uti);
+int tgt_obd_ping(struct tgt_session_info *tsi);
+int tgt_enqueue(struct tgt_session_info *tsi);
+int tgt_convert(struct tgt_session_info *tsi);
+int tgt_bl_callback(struct tgt_session_info *tsi);
+int tgt_cp_callback(struct tgt_session_info *tsi);
+int tgt_llog_open(struct tgt_session_info *tsi);
+int tgt_llog_close(struct tgt_session_info *tsi);
+int tgt_llog_destroy(struct tgt_session_info *tsi);
+int tgt_llog_read_header(struct tgt_session_info *tsi);
+int tgt_llog_next_block(struct tgt_session_info *tsi);
+int tgt_llog_prev_block(struct tgt_session_info *tsi);
+int tgt_sec_ctx_init(struct tgt_session_info *tsi);
+int tgt_sec_ctx_init_cont(struct tgt_session_info *tsi);
+int tgt_sec_ctx_fini(struct tgt_session_info *tsi);
+
+extern struct tgt_handler tgt_sec_ctx_handlers[];
+extern struct tgt_handler tgt_obd_handlers[];
+extern struct tgt_handler tgt_dlm_handlers[];
+extern struct tgt_handler tgt_llog_handlers[];
+extern struct tgt_handler tgt_out_handlers[];
+
+typedef void (*tgt_cb_t)(struct lu_target *lut, __u64 transno,
+                        void *data, int err);
+struct tgt_commit_cb {
+       tgt_cb_t  tgt_cb_func;
+       void     *tgt_cb_data;
+};
+
+/* target/tgt_main.c */
+void tgt_boot_epoch_update(struct lu_target *lut);
+int tgt_last_commit_cb_add(struct thandle *th, struct lu_target *lut,
                           struct obd_export *exp, __u64 transno);
-int lut_new_client_cb_add(struct thandle *th, struct obd_export *exp);
+int tgt_new_client_cb_add(struct thandle *th, struct obd_export *exp);
 int tgt_init(const struct lu_env *env, struct lu_target *lut,
-            struct obd_device *obd, struct dt_device *dt);
+            struct obd_device *obd, struct dt_device *dt,
+            struct tgt_opc_slice *slice,
+            int request_fail_id, int reply_fail_id);
 void tgt_fini(const struct lu_env *env, struct lu_target *lut);
-int lut_client_alloc(struct obd_export *exp);
-void lut_client_free(struct obd_export *exp);
-int lut_client_del(const struct lu_env *env, struct obd_export *exp);
-int lut_client_add(const struct lu_env *env, struct obd_export *exp, int);
-int lut_client_new(const struct lu_env *env, struct obd_export *exp);
-int lut_client_data_read(const struct lu_env *env, struct lu_target *tg,
+int tgt_client_alloc(struct obd_export *exp);
+void tgt_client_free(struct obd_export *exp);
+int tgt_client_del(const struct lu_env *env, struct obd_export *exp);
+int tgt_client_add(const struct lu_env *env, struct obd_export *exp, int);
+int tgt_client_new(const struct lu_env *env, struct obd_export *exp);
+int tgt_client_data_read(const struct lu_env *env, struct lu_target *tg,
                         struct lsd_client_data *lcd, loff_t *off, int index);
-int lut_client_data_write(const struct lu_env *env, struct lu_target *tg,
+int tgt_client_data_write(const struct lu_env *env, struct lu_target *tg,
                          struct lsd_client_data *lcd, loff_t *off, struct thandle *th);
-int lut_server_data_read(const struct lu_env *env, struct lu_target *tg);
-int lut_server_data_write(const struct lu_env *env, struct lu_target *tg,
+int tgt_server_data_read(const struct lu_env *env, struct lu_target *tg);
+int tgt_server_data_write(const struct lu_env *env, struct lu_target *tg,
                          struct thandle *th);
-int lut_server_data_update(const struct lu_env *env, struct lu_target *tg, int sync);
-int lut_truncate_last_rcvd(const struct lu_env *env, struct lu_target *tg, loff_t off);
+int tgt_server_data_update(const struct lu_env *env, struct lu_target *tg,
+                          int sync);
+int tgt_truncate_last_rcvd(const struct lu_env *env, struct lu_target *tg,
+                          loff_t off);
+int tgt_last_rcvd_update(const struct lu_env *env, struct lu_target *tgt,
+                        struct dt_object *obj, __u64 opdata,
+                        struct thandle *th, struct ptlrpc_request *req);
+
+enum {
+       ESERIOUS = 0x0001000
+};
+
+static inline int err_serious(int rc)
+{
+       LASSERT(rc < 0);
+       return -(-rc | ESERIOUS);
+}
+
+static inline int clear_serious(int rc)
+{
+       if (rc < 0)
+               rc = -(-rc & ~ESERIOUS);
+       return rc;
+}
+
+static inline int is_serious(int rc)
+{
+       return (rc < 0 && -rc & ESERIOUS);
+}
+
+/*
+ * Unified target generic handers macros and generic functions.
+ */
+#define TGT_RPC_HANDLER(base, flags, opc, fn, fmt, version)            \
+[opc - base] = {                                                       \
+       .th_name        = #opc,                                         \
+       .th_fail_id     = OBD_FAIL_ ## opc ## _NET,                     \
+       .th_opc         = opc,                                          \
+       .th_flags       = flags,                                        \
+       .th_act         = fn,                                           \
+       .th_fmt         = fmt,                                          \
+       .th_version     = version                                       \
+}
+
+/* MDT Request with a format known in advance */
+#define TGT_MDT_HDL(flags, name, fn)                                   \
+       TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
+                       LUSTRE_MDS_VERSION)
+/* Request with a format we do not yet know */
+#define TGT_MDT_HDL_VAR(flags, name, fn)                               \
+       TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, NULL,           \
+                       LUSTRE_MDS_VERSION)
+
+/* MGS request with a format known in advance */
+#define TGT_MGS_HDL(flags, name, fn)                                   \
+       TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
+                       LUSTRE_MGS_VERSION)
+#define TGT_MGS_HDL_VAR(flags, name, fn)                               \
+       TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, NULL,           \
+                       LUSTRE_MGS_VERSION)
+
+/*
+ * OBD handler macros and generic functions.
+ */
+#define TGT_OBD_HDL(flags, name, fn)                                   \
+       TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
+                       LUSTRE_OBD_VERSION)
+#define TGT_OBD_HDL_VAR(flags, name, fn)                               \
+       TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, NULL,           \
+                       LUSTRE_OBD_VERSION)
+
+/*
+ * DLM handler macros and generic functions.
+ */
+#define TGT_DLM_HDL_VAR(flags, name, fn)                               \
+       TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, NULL,          \
+                       LUSTRE_DLM_VERSION)
+#define TGT_DLM_HDL(flags, name, fn)                                   \
+       TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
+                       LUSTRE_DLM_VERSION)
+
+/*
+ * LLOG handler macros and generic functions.
+ */
+#define TGT_LLOG_HDL_VAR(flags, name, fn)                              \
+       TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, NULL,          \
+                       LUSTRE_LOG_VERSION)
+#define TGT_LLOG_HDL(flags, name, fn)                                  \
+       TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
+                       LUSTRE_LOG_VERSION)
+
+/*
+ * Sec context handler macros and generic functions.
+ */
+#define TGT_SEC_HDL_VAR(flags, name, fn)                               \
+       TGT_RPC_HANDLER(SEC_FIRST_OPC, flags, name, fn, NULL,           \
+                       LUSTRE_OBD_VERSION)
+
+#define TGT_QUOTA_HDL(flags, name, fn)                                 \
+       TGT_RPC_HANDLER(QUOTA_DQACQ, flags, name, fn, &RQF_ ## name,    \
+                       LUSTRE_MDS_VERSION)
+
+/* Sequence service handlers */
+#define TGT_SEQ_HDL(flags, name, fn)                                   \
+       TGT_RPC_HANDLER(SEQ_QUERY, flags, name, fn, &RQF_ ## name,      \
+                       LUSTRE_MDS_VERSION)
+
+/* FID Location Database handlers */
+#define TGT_FLD_HDL(flags, name, fn)                                   \
+       TGT_RPC_HANDLER(FLD_QUERY, flags, name, fn, &RQF_ ## name,      \
+                       LUSTRE_MDS_VERSION)
+
+/* Request with a format known in advance */
+#define TGT_UPDATE_HDL(flags, name, fn)                                        \
+       TGT_RPC_HANDLER(UPDATE_OBJ, flags, name, fn, &RQF_ ## name,     \
+                       LUSTRE_MDS_VERSION)
 
 #endif /* __LUSTRE_LU_TARGET_H */