lustre/include/lu_target.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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
  19  *
  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
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2012, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef _LUSTRE_LU_TARGET_H
  38 #define _LUSTRE_LU_TARGET_H
  39
  40 #include <dt_object.h>
  41 #include <lustre_export.h>
  42 #include <lustre_update.h>
  43 #include <lustre_disk.h>
  44
  45 struct lu_target {
  46         struct obd_device       *lut_obd;
  47         struct dt_device        *lut_bottom;
  48
  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;
  53
  54         /* sptlrpc rules */
  55         rwlock_t                 lut_sptlrpc_lock;
  56         struct sptlrpc_rule_set  lut_sptlrpc_rset;
  57         int                      lut_sec_level;
  58         unsigned int             lut_mds_capa:1,
  59                                  lut_oss_capa:1;
  60
  61         /* LAST_RCVD parameters */
  62         /** last_rcvd file */
  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;
  76 };
  77
  78 extern struct lu_context_key tgt_session_key;
  79
  80 struct tgt_session_info {
  81         /*
  82          * The following members will be filled explicitly
  83          * with specific data in tgt_ses_init().
  84          */
  85         struct req_capsule      *tsi_pill;
  86
  87         /*
  88          * Lock request for "habeo clavis" operations.
  89          */
  90         struct ldlm_request     *tsi_dlm_req;
  91
  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;
  97         /*
  98          * Additional fail id that can be set by handler.
  99          */
 100         int                      tsi_reply_fail_id;
 101         int                      tsi_request_fail_id;
 102 };
 103
 104 static inline struct tgt_session_info *tgt_ses_info(const struct lu_env *env)
 105 {
 106         struct tgt_session_info *tsi;
 107
 108         LASSERT(env->le_ses != NULL);
 109         tsi = lu_context_key_get(env->le_ses, &tgt_session_key);
 110         LASSERT(tsi);
 111         return tsi;
 112 }
 113
 114 /*
 115  * Generic unified target support.
 116  */
 117 enum tgt_handler_flags {
 118         /*
 119          * struct *_body is passed in the incoming message, and object
 120          * identified by this fid exists on disk.
 121          *                            *
 122          * "habeo corpus" == "I have a body"
 123          */
 124         HABEO_CORPUS = (1 << 0),
 125         /*
 126          * struct ldlm_request is passed in the incoming message.
 127          *
 128          * "habeo clavis" == "I have a key"
 129          *                                     */
 130         HABEO_CLAVIS = (1 << 1),
 131         /*
 132          * this request has fixed reply format, so that reply message can be
 133          * packed by generic code.
 134          *
 135          * "habeo refero" == "I have a reply"
 136          */
 137         HABEO_REFERO = (1 << 2),
 138         /*
 139          * this request will modify something, so check whether the file system
 140          * is readonly or not, then return -EROFS to client asap if necessary.
 141          *
 142          * "mutabor" == "I shall modify"
 143          */
 144         MUTABOR      = (1 << 3)
 145 };
 146
 147 struct tgt_handler {
 148         /* The name of this handler. */
 149         const char              *th_name;
 150         /* Fail id, check at the beginning */
 151         int                      th_fail_id;
 152         /* Operation code */
 153         __u32                    th_opc;
 154         /* Flags in enum tgt_handler_flags */
 155         __u32                    th_flags;
 156         /* Request version for this opcode */
 157         int                      th_version;
 158         /* Handler function */
 159         int                     (*th_act)(struct tgt_session_info *tti);
 160         /* Request format for this request */
 161         const struct req_format *th_fmt;
 162 };
 163
 164 struct tgt_opc_slice {
 165         __u32                    tos_opc_start; /* First op code */
 166         __u32                    tos_opc_end; /* Last op code */
 167         struct tgt_handler      *tos_hs; /* Registered handler */
 168 };
 169
 170 static inline struct ptlrpc_request *tgt_ses_req(struct tgt_session_info *tsi)
 171 {
 172         return tsi->tsi_pill ? tsi->tsi_pill->rc_req : NULL;
 173 }
 174
 175 static inline __u64 tgt_conn_flags(struct tgt_session_info *tsi)
 176 {
 177         LASSERT(tsi->tsi_exp);
 178         return exp_connect_flags(tsi->tsi_exp);
 179 }
 180
 181 static inline int req_is_replay(struct ptlrpc_request *req)
 182 {
 183         LASSERT(req->rq_reqmsg);
 184         return !!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY);
 185 }
 186
 187 /* target/tgt_handler.c */
 188 int tgt_request_handle(struct ptlrpc_request *req);
 189 char *tgt_name(struct lu_target *tgt);
 190 void tgt_counter_incr(struct obd_export *exp, int opcode);
 191 int tgt_connect_check_sptlrpc(struct ptlrpc_request *req,
 192                               struct obd_export *exp);
 193 int tgt_connect(struct tgt_session_info *tsi);
 194 int tgt_disconnect(struct tgt_session_info *uti);
 195 int tgt_obd_ping(struct tgt_session_info *tsi);
 196 int tgt_enqueue(struct tgt_session_info *tsi);
 197 int tgt_convert(struct tgt_session_info *tsi);
 198 int tgt_bl_callback(struct tgt_session_info *tsi);
 199 int tgt_cp_callback(struct tgt_session_info *tsi);
 200 int tgt_llog_open(struct tgt_session_info *tsi);
 201 int tgt_llog_close(struct tgt_session_info *tsi);
 202 int tgt_llog_destroy(struct tgt_session_info *tsi);
 203 int tgt_llog_read_header(struct tgt_session_info *tsi);
 204 int tgt_llog_next_block(struct tgt_session_info *tsi);
 205 int tgt_llog_prev_block(struct tgt_session_info *tsi);
 206 int tgt_sec_ctx_init(struct tgt_session_info *tsi);
 207 int tgt_sec_ctx_init_cont(struct tgt_session_info *tsi);
 208 int tgt_sec_ctx_fini(struct tgt_session_info *tsi);
 209
 210 extern struct tgt_handler tgt_sec_ctx_handlers[];
 211 extern struct tgt_handler tgt_obd_handlers[];
 212 extern struct tgt_handler tgt_dlm_handlers[];
 213 extern struct tgt_handler tgt_llog_handlers[];
 214 extern struct tgt_handler tgt_out_handlers[];
 215 extern struct tgt_handler fld_handlers[];
 216 extern struct tgt_handler seq_handlers[];
 217
 218 typedef void (*tgt_cb_t)(struct lu_target *lut, __u64 transno,
 219                          void *data, int err);
 220 struct tgt_commit_cb {
 221         tgt_cb_t  tgt_cb_func;
 222         void     *tgt_cb_data;
 223 };
 224
 225 /* target/tgt_main.c */
 226 void tgt_boot_epoch_update(struct lu_target *lut);
 227 int tgt_last_commit_cb_add(struct thandle *th, struct lu_target *lut,
 228                            struct obd_export *exp, __u64 transno);
 229 int tgt_new_client_cb_add(struct thandle *th, struct obd_export *exp);
 230 int tgt_init(const struct lu_env *env, struct lu_target *lut,
 231              struct obd_device *obd, struct dt_device *dt,
 232              struct tgt_opc_slice *slice,
 233              int request_fail_id, int reply_fail_id);
 234 void tgt_fini(const struct lu_env *env, struct lu_target *lut);
 235 int tgt_client_alloc(struct obd_export *exp);
 236 void tgt_client_free(struct obd_export *exp);
 237 int tgt_client_del(const struct lu_env *env, struct obd_export *exp);
 238 int tgt_client_add(const struct lu_env *env, struct obd_export *exp, int);
 239 int tgt_client_new(const struct lu_env *env, struct obd_export *exp);
 240 int tgt_client_data_read(const struct lu_env *env, struct lu_target *tg,
 241                          struct lsd_client_data *lcd, loff_t *off, int index);
 242 int tgt_client_data_write(const struct lu_env *env, struct lu_target *tg,
 243                           struct lsd_client_data *lcd, loff_t *off, struct thandle *th);
 244 int tgt_server_data_read(const struct lu_env *env, struct lu_target *tg);
 245 int tgt_server_data_write(const struct lu_env *env, struct lu_target *tg,
 246                           struct thandle *th);
 247 int tgt_server_data_update(const struct lu_env *env, struct lu_target *tg,
 248                            int sync);
 249 int tgt_truncate_last_rcvd(const struct lu_env *env, struct lu_target *tg,
 250                            loff_t off);
 251 int tgt_last_rcvd_update(const struct lu_env *env, struct lu_target *tgt,
 252                          struct dt_object *obj, __u64 opdata,
 253                          struct thandle *th, struct ptlrpc_request *req);
 254
 255 enum {
 256         ESERIOUS = 0x0001000
 257 };
 258
 259 static inline int err_serious(int rc)
 260 {
 261         LASSERT(rc < 0);
 262         return -(-rc | ESERIOUS);
 263 }
 264
 265 static inline int clear_serious(int rc)
 266 {
 267         if (rc < 0)
 268                 rc = -(-rc & ~ESERIOUS);
 269         return rc;
 270 }
 271
 272 static inline int is_serious(int rc)
 273 {
 274         return (rc < 0 && -rc & ESERIOUS);
 275 }
 276
 277 /*
 278  * Unified target generic handers macros and generic functions.
 279  */
 280 #define TGT_RPC_HANDLER(base, flags, opc, fn, fmt, version)             \
 281 [opc - base] = {                                                        \
 282         .th_name        = #opc,                                         \
 283         .th_fail_id     = OBD_FAIL_ ## opc ## _NET,                     \
 284         .th_opc         = opc,                                          \
 285         .th_flags       = flags,                                        \
 286         .th_act         = fn,                                           \
 287         .th_fmt         = fmt,                                          \
 288         .th_version     = version                                       \
 289 }
 290
 291 /* MDT Request with a format known in advance */
 292 #define TGT_MDT_HDL(flags, name, fn)                                    \
 293         TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
 294                         LUSTRE_MDS_VERSION)
 295 /* Request with a format we do not yet know */
 296 #define TGT_MDT_HDL_VAR(flags, name, fn)                                \
 297         TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, NULL,           \
 298                         LUSTRE_MDS_VERSION)
 299
 300 /* MGS request with a format known in advance */
 301 #define TGT_MGS_HDL(flags, name, fn)                                    \
 302         TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
 303                         LUSTRE_MGS_VERSION)
 304 #define TGT_MGS_HDL_VAR(flags, name, fn)                                \
 305         TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, NULL,           \
 306                         LUSTRE_MGS_VERSION)
 307
 308 /*
 309  * OBD handler macros and generic functions.
 310  */
 311 #define TGT_OBD_HDL(flags, name, fn)                                    \
 312         TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
 313                         LUSTRE_OBD_VERSION)
 314 #define TGT_OBD_HDL_VAR(flags, name, fn)                                \
 315         TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, NULL,           \
 316                         LUSTRE_OBD_VERSION)
 317
 318 /*
 319  * DLM handler macros and generic functions.
 320  */
 321 #define TGT_DLM_HDL_VAR(flags, name, fn)                                \
 322         TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, NULL,          \
 323                         LUSTRE_DLM_VERSION)
 324 #define TGT_DLM_HDL(flags, name, fn)                                    \
 325         TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
 326                         LUSTRE_DLM_VERSION)
 327
 328 /*
 329  * LLOG handler macros and generic functions.
 330  */
 331 #define TGT_LLOG_HDL_VAR(flags, name, fn)                               \
 332         TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, NULL,          \
 333                         LUSTRE_LOG_VERSION)
 334 #define TGT_LLOG_HDL(flags, name, fn)                                   \
 335         TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
 336                         LUSTRE_LOG_VERSION)
 337
 338 /*
 339  * Sec context handler macros and generic functions.
 340  */
 341 #define TGT_SEC_HDL_VAR(flags, name, fn)                                \
 342         TGT_RPC_HANDLER(SEC_FIRST_OPC, flags, name, fn, NULL,           \
 343                         LUSTRE_OBD_VERSION)
 344
 345 #define TGT_QUOTA_HDL(flags, name, fn)                                  \
 346         TGT_RPC_HANDLER(QUOTA_DQACQ, flags, name, fn, &RQF_ ## name,    \
 347                         LUSTRE_MDS_VERSION)
 348
 349 /* Sequence service handlers */
 350 #define TGT_SEQ_HDL(flags, name, fn)                                    \
 351         TGT_RPC_HANDLER(SEQ_QUERY, flags, name, fn, &RQF_ ## name,      \
 352                         LUSTRE_MDS_VERSION)
 353
 354 /* FID Location Database handlers */
 355 #define TGT_FLD_HDL(flags, name, fn)                                    \
 356         TGT_RPC_HANDLER(FLD_QUERY, flags, name, fn, &RQF_ ## name,      \
 357                         LUSTRE_MDS_VERSION)
 358
 359 /* Request with a format known in advance */
 360 #define TGT_UPDATE_HDL(flags, name, fn)                                 \
 361         TGT_RPC_HANDLER(UPDATE_OBJ, flags, name, fn, &RQF_ ## name,     \
 362                         LUSTRE_MDS_VERSION)
 363
 364 #endif /* __LUSTRE_LU_TARGET_H */