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         spinlock_t               lut_flags_lock;
  58         int                      lut_sec_level;
  59         unsigned int             lut_mds_capa:1,
  60                                  lut_oss_capa:1,
  61                                  lut_syncjournal:1,
  62                                  lut_sync_lock_cancel:2,
  63                                  /* e.g. OST node */
  64                                  lut_no_reconstruct:1;
  65         /** last_rcvd file */
  66         struct dt_object        *lut_last_rcvd;
  67         /* transaction callbacks */
  68         struct dt_txn_callback   lut_txn_cb;
  69         /** server data in last_rcvd file */
  70         struct lr_server_data    lut_lsd;
  71         /** Server last transaction number */
  72         __u64                    lut_last_transno;
  73         /** Lock protecting last transaction number */
  74         spinlock_t               lut_translock;
  75         /** Lock protecting client bitmap */
  76         spinlock_t               lut_client_bitmap_lock;
  77         /** Bitmap of known clients */
  78         unsigned long           *lut_client_bitmap;
  79 };
  80
  81 extern struct lu_context_key tgt_session_key;
  82
  83 struct tgt_session_info {
  84         /*
  85          * The following members will be filled explicitly
  86          * with specific data in tgt_ses_init().
  87          */
  88         struct req_capsule      *tsi_pill;
  89
  90         /*
  91          * Lock request for "habeo clavis" operations.
  92          */
  93         struct ldlm_request     *tsi_dlm_req;
  94
  95         /* although we have export in req, there are cases when it is not
  96          * available, e.g. closing files upon export destroy */
  97         struct obd_export       *tsi_exp;
  98         const struct lu_env     *tsi_env;
  99         struct lu_target        *tsi_tgt;
 100
 101         const struct mdt_body   *tsi_mdt_body;
 102         struct ost_body         *tsi_ost_body;
 103         struct lu_object        *tsi_corpus;
 104
 105         struct lu_fid            tsi_fid;
 106         struct ldlm_res_id       tsi_resid;
 107
 108         /* object affected by VBR, for last_rcvd_update */
 109         struct dt_object        *tsi_vbr_obj;
 110         /* opdata for mdt_reint_open(), has the same value as
 111          * ldlm_reply:lock_policy_res1.  The tgt_update_last_rcvd() stores
 112          * this value onto disk for recovery when tgt_txn_stop_cb() is called.
 113          */
 114         __u64                    tsi_opdata;
 115
 116         /*
 117          * Additional fail id that can be set by handler.
 118          */
 119         int                      tsi_reply_fail_id;
 120         bool                     tsi_preprocessed;
 121         /* request JobID */
 122         char                    *tsi_jobid;
 123 };
 124
 125 static inline struct tgt_session_info *tgt_ses_info(const struct lu_env *env)
 126 {
 127         struct tgt_session_info *tsi;
 128
 129         LASSERT(env->le_ses != NULL);
 130         tsi = lu_context_key_get(env->le_ses, &tgt_session_key);
 131         LASSERT(tsi);
 132         return tsi;
 133 }
 134
 135 static inline void tgt_vbr_obj_set(const struct lu_env *env,
 136                                    struct dt_object *obj)
 137 {
 138         struct tgt_session_info *tsi;
 139
 140         if (env->le_ses != NULL) {
 141                 tsi = tgt_ses_info(env);
 142                 tsi->tsi_vbr_obj = obj;
 143         }
 144 }
 145
 146 static inline void tgt_opdata_set(const struct lu_env *env, __u64 flags)
 147 {
 148         struct tgt_session_info *tsi;
 149
 150         if (env->le_ses != NULL) {
 151                 tsi = tgt_ses_info(env);
 152                 tsi->tsi_opdata |= flags;
 153         }
 154 }
 155
 156 static inline void tgt_opdata_clear(const struct lu_env *env, __u64 flags)
 157 {
 158         struct tgt_session_info *tsi;
 159
 160         if (env->le_ses != NULL) {
 161                 tsi = tgt_ses_info(env);
 162                 tsi->tsi_opdata &= ~flags;
 163         }
 164 }
 165
 166 /*
 167  * Generic unified target support.
 168  */
 169 enum tgt_handler_flags {
 170         /*
 171          * struct *_body is passed in the incoming message, and object
 172          * identified by this fid exists on disk.
 173          *                            *
 174          * "habeo corpus" == "I have a body"
 175          */
 176         HABEO_CORPUS = (1 << 0),
 177         /*
 178          * struct ldlm_request is passed in the incoming message.
 179          *
 180          * "habeo clavis" == "I have a key"
 181          *                                     */
 182         HABEO_CLAVIS = (1 << 1),
 183         /*
 184          * this request has fixed reply format, so that reply message can be
 185          * packed by generic code.
 186          *
 187          * "habeo refero" == "I have a reply"
 188          */
 189         HABEO_REFERO = (1 << 2),
 190         /*
 191          * this request will modify something, so check whether the file system
 192          * is readonly or not, then return -EROFS to client asap if necessary.
 193          *
 194          * "mutabor" == "I shall modify"
 195          */
 196         MUTABOR      = (1 << 3)
 197 };
 198
 199 struct tgt_handler {
 200         /* The name of this handler. */
 201         const char              *th_name;
 202         /* Fail id, check at the beginning */
 203         int                      th_fail_id;
 204         /* Operation code */
 205         __u32                    th_opc;
 206         /* Flags in enum tgt_handler_flags */
 207         __u32                    th_flags;
 208         /* Request version for this opcode */
 209         int                      th_version;
 210         /* Handler function */
 211         int                     (*th_act)(struct tgt_session_info *tsi);
 212         /* Handler function for high priority requests */
 213         void                    (*th_hp)(struct tgt_session_info *tsi);
 214         /* Request format for this request */
 215         const struct req_format *th_fmt;
 216 };
 217
 218 struct tgt_opc_slice {
 219         __u32                    tos_opc_start; /* First op code */
 220         __u32                    tos_opc_end; /* Last op code */
 221         struct tgt_handler      *tos_hs; /* Registered handler */
 222 };
 223
 224 static inline struct ptlrpc_request *tgt_ses_req(struct tgt_session_info *tsi)
 225 {
 226         return tsi->tsi_pill ? tsi->tsi_pill->rc_req : NULL;
 227 }
 228
 229 static inline __u64 tgt_conn_flags(struct tgt_session_info *tsi)
 230 {
 231         LASSERT(tsi->tsi_exp);
 232         return exp_connect_flags(tsi->tsi_exp);
 233 }
 234
 235 static inline int req_is_replay(struct ptlrpc_request *req)
 236 {
 237         LASSERT(req->rq_reqmsg);
 238         return !!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY);
 239 }
 240
 241 /* target/tgt_handler.c */
 242 int tgt_request_handle(struct ptlrpc_request *req);
 243 char *tgt_name(struct lu_target *tgt);
 244 void tgt_counter_incr(struct obd_export *exp, int opcode);
 245 int tgt_connect_check_sptlrpc(struct ptlrpc_request *req,
 246                               struct obd_export *exp);
 247 int tgt_adapt_sptlrpc_conf(struct lu_target *tgt, int initial);
 248 int tgt_connect(struct tgt_session_info *tsi);
 249 int tgt_disconnect(struct tgt_session_info *uti);
 250 int tgt_obd_ping(struct tgt_session_info *tsi);
 251 int tgt_enqueue(struct tgt_session_info *tsi);
 252 int tgt_convert(struct tgt_session_info *tsi);
 253 int tgt_bl_callback(struct tgt_session_info *tsi);
 254 int tgt_cp_callback(struct tgt_session_info *tsi);
 255 int tgt_llog_open(struct tgt_session_info *tsi);
 256 int tgt_llog_close(struct tgt_session_info *tsi);
 257 int tgt_llog_destroy(struct tgt_session_info *tsi);
 258 int tgt_llog_read_header(struct tgt_session_info *tsi);
 259 int tgt_llog_next_block(struct tgt_session_info *tsi);
 260 int tgt_llog_prev_block(struct tgt_session_info *tsi);
 261 int tgt_sec_ctx_init(struct tgt_session_info *tsi);
 262 int tgt_sec_ctx_init_cont(struct tgt_session_info *tsi);
 263 int tgt_sec_ctx_fini(struct tgt_session_info *tsi);
 264 int tgt_sendpage(struct tgt_session_info *tsi, struct lu_rdpg *rdpg, int nob);
 265 int tgt_validate_obdo(struct tgt_session_info *tsi, struct obdo *oa);
 266 int tgt_sync(const struct lu_env *env, struct lu_target *tgt,
 267              struct dt_object *obj);
 268
 269 int tgt_io_thread_init(struct ptlrpc_thread *thread);
 270 void tgt_io_thread_done(struct ptlrpc_thread *thread);
 271
 272 int tgt_extent_lock(struct ldlm_namespace *ns, struct ldlm_res_id *res_id,
 273                     __u64 start, __u64 end, struct lustre_handle *lh,
 274                     int mode, __u64 *flags);
 275 void tgt_extent_unlock(struct lustre_handle *lh, ldlm_mode_t mode);
 276 int tgt_brw_lock(struct ldlm_namespace *ns, struct ldlm_res_id *res_id,
 277                  struct obd_ioobj *obj, struct niobuf_remote *nb,
 278                  struct lustre_handle *lh, int mode);
 279 void tgt_brw_unlock(struct obd_ioobj *obj, struct niobuf_remote *niob,
 280                     struct lustre_handle *lh, int mode);
 281 int tgt_brw_read(struct tgt_session_info *tsi);
 282 int tgt_brw_write(struct tgt_session_info *tsi);
 283 int tgt_hpreq_handler(struct ptlrpc_request *req);
 284
 285 extern struct tgt_handler tgt_sec_ctx_handlers[];
 286 extern struct tgt_handler tgt_obd_handlers[];
 287 extern struct tgt_handler tgt_dlm_handlers[];
 288 extern struct tgt_handler tgt_llog_handlers[];
 289 extern struct tgt_handler tgt_out_handlers[];
 290 extern struct tgt_handler fld_handlers[];
 291 extern struct tgt_handler seq_handlers[];
 292
 293 typedef void (*tgt_cb_t)(struct lu_target *lut, __u64 transno,
 294                          void *data, int err);
 295 struct tgt_commit_cb {
 296         tgt_cb_t  tgt_cb_func;
 297         void     *tgt_cb_data;
 298 };
 299
 300 int tgt_hpreq_handler(struct ptlrpc_request *req);
 301
 302 /* target/tgt_main.c */
 303 void tgt_boot_epoch_update(struct lu_target *lut);
 304 int tgt_last_commit_cb_add(struct thandle *th, struct lu_target *lut,
 305                            struct obd_export *exp, __u64 transno);
 306 int tgt_new_client_cb_add(struct thandle *th, struct obd_export *exp);
 307 int tgt_init(const struct lu_env *env, struct lu_target *lut,
 308              struct obd_device *obd, struct dt_device *dt,
 309              struct tgt_opc_slice *slice,
 310              int request_fail_id, int reply_fail_id);
 311 void tgt_fini(const struct lu_env *env, struct lu_target *lut);
 312 int tgt_client_alloc(struct obd_export *exp);
 313 void tgt_client_free(struct obd_export *exp);
 314 int tgt_client_del(const struct lu_env *env, struct obd_export *exp);
 315 int tgt_client_add(const struct lu_env *env, struct obd_export *exp, int);
 316 int tgt_client_new(const struct lu_env *env, struct obd_export *exp);
 317 int tgt_client_data_read(const struct lu_env *env, struct lu_target *tg,
 318                          struct lsd_client_data *lcd, loff_t *off, int index);
 319 int tgt_client_data_write(const struct lu_env *env, struct lu_target *tg,
 320                           struct lsd_client_data *lcd, loff_t *off, struct thandle *th);
 321 int tgt_server_data_read(const struct lu_env *env, struct lu_target *tg);
 322 int tgt_server_data_write(const struct lu_env *env, struct lu_target *tg,
 323                           struct thandle *th);
 324 int tgt_server_data_update(const struct lu_env *env, struct lu_target *tg,
 325                            int sync);
 326 int tgt_truncate_last_rcvd(const struct lu_env *env, struct lu_target *tg,
 327                            loff_t off);
 328
 329 enum {
 330         ESERIOUS = 0x0001000
 331 };
 332
 333 static inline int err_serious(int rc)
 334 {
 335         LASSERT(rc < 0);
 336         return -(-rc | ESERIOUS);
 337 }
 338
 339 static inline int clear_serious(int rc)
 340 {
 341         if (rc < 0)
 342                 rc = -(-rc & ~ESERIOUS);
 343         return rc;
 344 }
 345
 346 static inline int is_serious(int rc)
 347 {
 348         return (rc < 0 && -rc & ESERIOUS);
 349 }
 350
 351 /**
 352  * Do not return server-side uid/gid to remote client
 353  */
 354 static inline void tgt_drop_id(struct obd_export *exp, struct obdo *oa)
 355 {
 356         if (unlikely(exp_connect_rmtclient(exp))) {
 357                 oa->o_uid = -1;
 358                 oa->o_gid = -1;
 359                 oa->o_valid &= ~(OBD_MD_FLUID | OBD_MD_FLGID);
 360         }
 361 }
 362
 363 /*
 364  * Unified target generic handers macros and generic functions.
 365  */
 366 #define TGT_RPC_HANDLER_HP(base, flags, opc, fn, hp, fmt, version)      \
 367 [opc - base] = {                                                        \
 368         .th_name        = #opc,                                         \
 369         .th_fail_id     = OBD_FAIL_ ## opc ## _NET,                     \
 370         .th_opc         = opc,                                          \
 371         .th_flags       = flags,                                        \
 372         .th_act         = fn,                                           \
 373         .th_fmt         = fmt,                                          \
 374         .th_version     = version,                                      \
 375         .th_hp          = hp,                                           \
 376 }
 377 #define TGT_RPC_HANDLER(base, flags, opc, fn, fmt, version)             \
 378         TGT_RPC_HANDLER_HP(base, flags, opc, fn, NULL, fmt, version)
 379
 380 /* MDT Request with a format known in advance */
 381 #define TGT_MDT_HDL(flags, name, fn)                                    \
 382         TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
 383                         LUSTRE_MDS_VERSION)
 384 /* Request with a format we do not yet know */
 385 #define TGT_MDT_HDL_VAR(flags, name, fn)                                \
 386         TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, NULL,           \
 387                         LUSTRE_MDS_VERSION)
 388
 389 /* OST Request with a format known in advance */
 390 #define TGT_OST_HDL(flags, name, fn)                                    \
 391         TGT_RPC_HANDLER(OST_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
 392                         LUSTRE_OST_VERSION)
 393 #define TGT_OST_HDL_HP(flags, name, fn, hp)                             \
 394         TGT_RPC_HANDLER_HP(OST_FIRST_OPC, flags, name, fn, hp,          \
 395                            &RQF_ ## name, LUSTRE_OST_VERSION)
 396
 397 /* MGS request with a format known in advance */
 398 #define TGT_MGS_HDL(flags, name, fn)                                    \
 399         TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
 400                         LUSTRE_MGS_VERSION)
 401 #define TGT_MGS_HDL_VAR(flags, name, fn)                                \
 402         TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, NULL,           \
 403                         LUSTRE_MGS_VERSION)
 404
 405 /*
 406  * OBD handler macros and generic functions.
 407  */
 408 #define TGT_OBD_HDL(flags, name, fn)                                    \
 409         TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
 410                         LUSTRE_OBD_VERSION)
 411 #define TGT_OBD_HDL_VAR(flags, name, fn)                                \
 412         TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, NULL,           \
 413                         LUSTRE_OBD_VERSION)
 414
 415 /*
 416  * DLM handler macros and generic functions.
 417  */
 418 #define TGT_DLM_HDL_VAR(flags, name, fn)                                \
 419         TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, NULL,          \
 420                         LUSTRE_DLM_VERSION)
 421 #define TGT_DLM_HDL(flags, name, fn)                                    \
 422         TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
 423                         LUSTRE_DLM_VERSION)
 424
 425 /*
 426  * LLOG handler macros and generic functions.
 427  */
 428 #define TGT_LLOG_HDL_VAR(flags, name, fn)                               \
 429         TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, NULL,          \
 430                         LUSTRE_LOG_VERSION)
 431 #define TGT_LLOG_HDL(flags, name, fn)                                   \
 432         TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
 433                         LUSTRE_LOG_VERSION)
 434
 435 /*
 436  * Sec context handler macros and generic functions.
 437  */
 438 #define TGT_SEC_HDL_VAR(flags, name, fn)                                \
 439         TGT_RPC_HANDLER(SEC_FIRST_OPC, flags, name, fn, NULL,           \
 440                         LUSTRE_OBD_VERSION)
 441
 442 #define TGT_QUOTA_HDL(flags, name, fn)                                  \
 443         TGT_RPC_HANDLER(QUOTA_DQACQ, flags, name, fn, &RQF_ ## name,    \
 444                         LUSTRE_MDS_VERSION)
 445
 446 /* Sequence service handlers */
 447 #define TGT_SEQ_HDL(flags, name, fn)                                    \
 448         TGT_RPC_HANDLER(SEQ_QUERY, flags, name, fn, &RQF_ ## name,      \
 449                         LUSTRE_MDS_VERSION)
 450
 451 /* FID Location Database handlers */
 452 #define TGT_FLD_HDL_VAR(flags, name, fn)                                \
 453         TGT_RPC_HANDLER(FLD_QUERY, flags, name, fn, NULL,               \
 454                         LUSTRE_MDS_VERSION)
 455
 456 /* Request with a format known in advance */
 457 #define TGT_UPDATE_HDL(flags, name, fn)                                 \
 458         TGT_RPC_HANDLER(UPDATE_OBJ, flags, name, fn, &RQF_ ## name,     \
 459                         LUSTRE_MDS_VERSION)
 460
 461 #endif /* __LUSTRE_LU_TARGET_H */