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