lustre/target/tgt_internal.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, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 021110-1307, USA
  20  *
  21  * GPL HEADER END
  22  */
  23 /*
  24  * Copyright (c) 2012, 2016, Intel Corporation.
  25  */
  26 /*
  27  * lustre/target/tgt_internal.h
  28  *
  29  * Lustre Unified Target header file
  30  *
  31  * Author: Mikhail Pershin <mike.pershin@intel.com>
  32  */
  33
  34 #ifndef _TG_INTERNAL_H
  35 #define _TG_INTERNAL_H
  36
  37 #include <lustre_net.h>
  38 #include <lustre/lustre_idl.h>
  39 #include <lu_target.h>
  40 #include <lustre_export.h>
  41 #include <lustre_fid.h>
  42 #include <lustre_fld.h>
  43 #include <lustre_req_layout.h>
  44 #include <lustre_sec.h>
  45
  46 extern int (*tgt_lfsck_in_notify_local)(const struct lu_env *env,
  47                                         struct dt_device *key,
  48                                         struct lfsck_req_local *lrl,
  49                                         struct thandle *th);
  50 /**
  51  * Common data shared by tg-level handlers. This is allocated per-thread to
  52  * reduce stack consumption.
  53  */
  54 struct tgt_thread_info {
  55         /* server and client data buffers */
  56         struct lr_server_data    tti_lsd;
  57         struct lsd_client_data   tti_lcd;
  58         struct lsd_reply_data    tti_lrd;
  59         struct lu_buf            tti_buf;
  60         loff_t                   tti_off;
  61
  62         struct lu_attr           tti_attr;
  63         struct lu_fid            tti_fid1;
  64
  65         /* transno storage during last_rcvd update */
  66         __u64                    tti_transno;
  67         __u32                    tti_has_trans:1,
  68                                  tti_mult_trans:1;
  69
  70         /* Updates data for OUT target */
  71         struct thandle_exec_args tti_tea;
  72         union {
  73                 struct {
  74                         /* for tgt_readpage()      */
  75                         struct lu_rdpg     tti_rdpg;
  76                         /* for tgt_sendpage()      */
  77                         struct l_wait_info tti_wait_info;
  78                 } rdpg;
  79                 struct {
  80                         struct dt_object_format    tti_update_dof;
  81                         struct object_update_reply *tti_update_reply;
  82                         struct object_update       *tti_update;
  83                         int                        tti_update_reply_index;
  84                         struct obdo                tti_obdo;
  85                         struct dt_object           *tti_dt_object;
  86                         struct l_wait_info tti_wait_info;
  87                 } update;
  88                 struct obd_statfs osfs; /* for obd_statfs() in OFD/MDT */
  89         } tti_u;
  90         struct lfsck_req_local tti_lrl;
  91         struct dt_insert_rec tti_rec;
  92 };
  93
  94 extern struct lu_context_key tgt_thread_key;
  95
  96 static inline struct tgt_thread_info *tgt_th_info(const struct lu_env *env)
  97 {
  98         struct tgt_thread_info *tti;
  99
 100         tti = lu_context_key_get(&env->le_ctx, &tgt_thread_key);
 101         LASSERT(tti);
 102         return tti;
 103 }
 104
 105 #define MGS_SERVICE_WATCHDOG_FACTOR      (2)
 106
 107 int tgt_request_handle(struct ptlrpc_request *req);
 108
 109 /* check if request's xid is equal to last one or not*/
 110 static inline int req_xid_is_last(struct ptlrpc_request *req)
 111 {
 112         struct lsd_client_data *lcd = req->rq_export->exp_target_data.ted_lcd;
 113
 114         LASSERT(lcd != NULL);
 115         return (req->rq_xid == lcd->lcd_last_xid ||
 116                 req->rq_xid == lcd->lcd_last_close_xid);
 117 }
 118
 119 static inline char *dt_obd_name(struct dt_device *dt)
 120 {
 121         return dt->dd_lu_dev.ld_obd->obd_name;
 122 }
 123
 124 /* out_lib.c */
 125 int out_tx_create_exec(const struct lu_env *env, struct thandle *th,
 126                        struct tx_arg *arg);
 127 struct tx_arg *tx_add_exec(struct thandle_exec_args *ta,
 128                            tx_exec_func_t func, tx_exec_func_t undo,
 129                            const char *file, int line);
 130
 131 int out_create_add_exec(const struct lu_env *env, struct dt_object *obj,
 132                         struct lu_attr *attr, struct lu_fid *parent_fid,
 133                         struct dt_object_format *dof,
 134                         struct thandle_exec_args *ta, struct thandle *th,
 135                         struct object_update_reply *reply,
 136                         int index, const char *file, int line);
 137
 138 int out_attr_set_add_exec(const struct lu_env *env, struct dt_object *dt_obj,
 139                           const struct lu_attr *attr,
 140                           struct thandle_exec_args *ta, struct thandle *th,
 141                           struct object_update_reply *reply, int index,
 142                           const char *file, int line);
 143
 144 int out_write_add_exec(const struct lu_env *env, struct dt_object *dt_obj,
 145                        const struct lu_buf *buf, loff_t pos,
 146                        struct thandle_exec_args *ta, struct thandle *th,
 147                        struct object_update_reply *reply, int index,
 148                        const char *file, int line);
 149
 150 int out_xattr_set_add_exec(const struct lu_env *env, struct dt_object *dt_obj,
 151                            const struct lu_buf *buf, const char *name,
 152                            int flags, struct thandle_exec_args *ta,
 153                            struct thandle *th,
 154                            struct object_update_reply *reply, int index,
 155                            const char *file, int line);
 156
 157 int out_xattr_del_add_exec(const struct lu_env *env, struct dt_object *dt_obj,
 158                            const char *name, struct thandle_exec_args *ta,
 159                            struct thandle *th,
 160                            struct object_update_reply *reply, int index,
 161                            const char *file, int line);
 162
 163 int out_ref_add_add_exec(const struct lu_env *env, struct dt_object *dt_obj,
 164                          struct thandle_exec_args *ta, struct thandle *th,
 165                          struct object_update_reply *reply, int index,
 166                          const char *file, int line);
 167
 168 int out_ref_del_add_exec(const struct lu_env *env, struct dt_object *dt_obj,
 169                          struct thandle_exec_args *ta, struct thandle *th,
 170                          struct object_update_reply *reply, int index,
 171                          const char *file, int line);
 172
 173 int out_index_insert_add_exec(const struct lu_env *env,
 174                               struct dt_object *dt_obj,
 175                               const struct dt_rec *rec,
 176                               const struct dt_key *key,
 177                               struct thandle_exec_args *ta,
 178                               struct thandle *th,
 179                               struct object_update_reply *reply,
 180                               int index, const char *file, int line);
 181
 182 int out_index_delete_add_exec(const struct lu_env *env,
 183                               struct dt_object *dt_obj,
 184                               const struct dt_key *key,
 185                               struct thandle_exec_args *ta,
 186                               struct thandle *th,
 187                               struct object_update_reply *reply,
 188                               int index, const char *file, int line);
 189
 190 int out_destroy_add_exec(const struct lu_env *env, struct dt_object *dt_obj,
 191                          struct thandle_exec_args *ta, struct thandle *th,
 192                          struct object_update_reply *reply,
 193                          int index, const char *file, int line);
 194
 195 /* Update handlers */
 196 int out_handle(struct tgt_session_info *tsi);
 197
 198 #define out_tx_create(env, obj, attr, fid, dof, ta, th, reply, idx) \
 199         out_create_add_exec(env, obj, attr, fid, dof, ta, th, reply, idx, \
 200                             __FILE__, __LINE__)
 201
 202 #define out_tx_attr_set(env, obj, attr, ta, th, reply, idx) \
 203         out_attr_set_add_exec(env, obj, attr, ta, th, reply, idx, \
 204                               __FILE__, __LINE__)
 205
 206 #define out_tx_xattr_set(env, obj, buf, name, fl, ta, th, reply, idx)   \
 207         out_xattr_set_add_exec(env, obj, buf, name, fl, ta, th, reply, idx, \
 208                                __FILE__, __LINE__)
 209
 210 #define out_tx_xattr_del(env, obj, name, ta, th, reply, idx)    \
 211         out_xattr_del_add_exec(env, obj, name, ta, th, reply, idx,      \
 212                                __FILE__, __LINE__)
 213
 214 #define out_tx_ref_add(env, obj, ta, th, reply, idx) \
 215         out_ref_add_add_exec(env, obj, ta, th, reply, idx,      \
 216                              __FILE__, __LINE__)
 217
 218 #define out_tx_ref_del(env, obj, ta, th, reply, idx) \
 219         out_ref_del_add_exec(env, obj, ta, th, reply, idx,      \
 220                              __FILE__, __LINE__)
 221
 222 #define out_tx_index_insert(env, obj, rec, key, ta, th, reply, idx) \
 223         out_index_insert_add_exec(env, obj, rec, key, ta, th, reply, idx, \
 224                                   __FILE__, __LINE__)
 225
 226 #define out_tx_index_delete(env, obj, key, ta, th, reply, idx) \
 227         out_index_delete_add_exec(env, obj, key, ta, th, reply, idx, \
 228                                   __FILE__, __LINE__)
 229
 230 #define out_tx_destroy(env, obj, ta, th, reply, idx) \
 231         out_destroy_add_exec(env, obj, ta, th, reply, idx,      \
 232                              __FILE__, __LINE__)
 233
 234 #define out_tx_write(env, obj, buf, pos, ta, th, reply, idx) \
 235         out_write_add_exec(env, obj, buf, pos, ta, th, reply, idx,\
 236                            __FILE__, __LINE__)
 237
 238 const char *update_op_str(__u16 opcode);
 239
 240 extern struct page *tgt_page_to_corrupt;
 241
 242 int tgt_server_data_init(const struct lu_env *env, struct lu_target *tgt);
 243 int tgt_txn_start_cb(const struct lu_env *env, struct thandle *th,
 244                      void *cookie);
 245 int tgt_txn_stop_cb(const struct lu_env *env, struct thandle *th,
 246                     void *cookie);
 247 int tgt_handle_received_xid(struct obd_export *exp, __u64 rcvd_xid);
 248 int tgt_handle_tag(struct obd_export *exp, __u16 tag);
 249
 250 void update_records_dump(const struct update_records *records,
 251                          unsigned int mask, bool dump_updates);
 252 int check_and_prepare_update_record(const struct lu_env *env,
 253                                     struct thandle_update_records *tur);
 254 struct update_thread_info {
 255         struct lu_attr                  uti_attr;
 256         struct lu_fid                   uti_fid;
 257         struct lu_buf                   uti_buf;
 258         struct thandle_update_records   uti_tur;
 259         struct obdo                     uti_obdo;
 260         struct thandle_exec_args        uti_tea;
 261         struct dt_insert_rec            uti_rec;
 262         struct distribute_txn_replay_req *uti_dtrq;
 263 };
 264
 265 extern struct lu_context_key update_thread_key;
 266
 267 static inline struct update_thread_info *
 268 update_env_info(const struct lu_env *env)
 269 {
 270         struct update_thread_info *uti;
 271
 272         uti = lu_context_key_get(&env->le_ctx, &update_thread_key);
 273         LASSERT(uti != NULL);
 274         return uti;
 275 }
 276
 277 void update_info_init(void);
 278 void update_info_fini(void);
 279 struct sub_thandle *create_sub_thandle(struct top_multiple_thandle *tmt,
 280                                        struct dt_device *dt_dev);
 281 int sub_thandle_trans_create(const struct lu_env *env,
 282                              struct top_thandle *top_th,
 283                              struct sub_thandle *st);
 284 void distribute_txn_insert_by_batchid(struct top_multiple_thandle *new);
 285 int top_trans_create_tmt(const struct lu_env *env,
 286                          struct top_thandle *top_th);
 287
 288 void tgt_cancel_slc_locks(struct lu_target *tgt, __u64 transno);
 289 void barrier_init(void);
 290 void barrier_fini(void);
 291 #endif /* _TG_INTERNAL_H */