Whamcloud - gitweb
LU-3539 protocol: Change UPDATE_OBJ RPC format
[fs/lustre-release.git] / 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 #include <lustre_lfsck.h>
45
46 struct lu_target {
47         struct obd_device       *lut_obd;
48         struct dt_device        *lut_bottom;
49
50         /* supported opcodes and handlers for this target */
51         struct tgt_opc_slice    *lut_slice;
52         __u32                    lut_reply_fail_id;
53         __u32                    lut_request_fail_id;
54
55         /* sptlrpc rules */
56         rwlock_t                 lut_sptlrpc_lock;
57         struct sptlrpc_rule_set  lut_sptlrpc_rset;
58         spinlock_t               lut_flags_lock;
59         int                      lut_sec_level;
60         unsigned int             lut_mds_capa:1,
61                                  lut_oss_capa:1,
62                                  lut_syncjournal:1,
63                                  lut_sync_lock_cancel:2,
64                                  /* e.g. OST node */
65                                  lut_no_reconstruct:1;
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         /* object affected by VBR, for last_rcvd_update */
110         struct dt_object        *tsi_vbr_obj;
111         /* opdata for mdt_reint_open(), has the same value as
112          * ldlm_reply:lock_policy_res1.  The tgt_update_last_rcvd() stores
113          * this value onto disk for recovery when tgt_txn_stop_cb() is called.
114          */
115         __u64                    tsi_opdata;
116
117         /*
118          * Additional fail id that can be set by handler.
119          */
120         int                      tsi_reply_fail_id;
121         bool                     tsi_preprocessed;
122         /* request JobID */
123         char                    *tsi_jobid;
124 };
125
126 static inline struct tgt_session_info *tgt_ses_info(const struct lu_env *env)
127 {
128         struct tgt_session_info *tsi;
129
130         LASSERT(env->le_ses != NULL);
131         tsi = lu_context_key_get(env->le_ses, &tgt_session_key);
132         LASSERT(tsi);
133         return tsi;
134 }
135
136 static inline void tgt_vbr_obj_set(const struct lu_env *env,
137                                    struct dt_object *obj)
138 {
139         struct tgt_session_info *tsi;
140
141         if (env->le_ses != NULL) {
142                 tsi = tgt_ses_info(env);
143                 tsi->tsi_vbr_obj = obj;
144         }
145 }
146
147 static inline void tgt_opdata_set(const struct lu_env *env, __u64 flags)
148 {
149         struct tgt_session_info *tsi;
150
151         if (env->le_ses != NULL) {
152                 tsi = tgt_ses_info(env);
153                 tsi->tsi_opdata |= flags;
154         }
155 }
156
157 static inline void tgt_opdata_clear(const struct lu_env *env, __u64 flags)
158 {
159         struct tgt_session_info *tsi;
160
161         if (env->le_ses != NULL) {
162                 tsi = tgt_ses_info(env);
163                 tsi->tsi_opdata &= ~flags;
164         }
165 }
166
167 /*
168  * Generic unified target support.
169  */
170 enum tgt_handler_flags {
171         /*
172          * struct *_body is passed in the incoming message, and object
173          * identified by this fid exists on disk.
174          *                            *
175          * "habeo corpus" == "I have a body"
176          */
177         HABEO_CORPUS = (1 << 0),
178         /*
179          * struct ldlm_request is passed in the incoming message.
180          *
181          * "habeo clavis" == "I have a key"
182          *                                     */
183         HABEO_CLAVIS = (1 << 1),
184         /*
185          * this request has fixed reply format, so that reply message can be
186          * packed by generic code.
187          *
188          * "habeo refero" == "I have a reply"
189          */
190         HABEO_REFERO = (1 << 2),
191         /*
192          * this request will modify something, so check whether the file system
193          * is readonly or not, then return -EROFS to client asap if necessary.
194          *
195          * "mutabor" == "I shall modify"
196          */
197         MUTABOR      = (1 << 3)
198 };
199
200 struct tgt_handler {
201         /* The name of this handler. */
202         const char              *th_name;
203         /* Fail id, check at the beginning */
204         int                      th_fail_id;
205         /* Operation code */
206         __u32                    th_opc;
207         /* Flags in enum tgt_handler_flags */
208         __u32                    th_flags;
209         /* Request version for this opcode */
210         int                      th_version;
211         /* Handler function */
212         int                     (*th_act)(struct tgt_session_info *tsi);
213         /* Handler function for high priority requests */
214         void                    (*th_hp)(struct tgt_session_info *tsi);
215         /* Request format for this request */
216         const struct req_format *th_fmt;
217 };
218
219 struct tgt_opc_slice {
220         __u32                    tos_opc_start; /* First op code */
221         __u32                    tos_opc_end; /* Last op code */
222         struct tgt_handler      *tos_hs; /* Registered handler */
223 };
224
225 static inline struct ptlrpc_request *tgt_ses_req(struct tgt_session_info *tsi)
226 {
227         return tsi->tsi_pill ? tsi->tsi_pill->rc_req : NULL;
228 }
229
230 static inline __u64 tgt_conn_flags(struct tgt_session_info *tsi)
231 {
232         LASSERT(tsi->tsi_exp);
233         return exp_connect_flags(tsi->tsi_exp);
234 }
235
236 static inline int req_is_replay(struct ptlrpc_request *req)
237 {
238         LASSERT(req->rq_reqmsg);
239         return !!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY);
240 }
241
242 /* target/tgt_handler.c */
243 int tgt_request_handle(struct ptlrpc_request *req);
244 char *tgt_name(struct lu_target *tgt);
245 void tgt_counter_incr(struct obd_export *exp, int opcode);
246 int tgt_connect_check_sptlrpc(struct ptlrpc_request *req,
247                               struct obd_export *exp);
248 int tgt_adapt_sptlrpc_conf(struct lu_target *tgt, int initial);
249 int tgt_connect(struct tgt_session_info *tsi);
250 int tgt_disconnect(struct tgt_session_info *uti);
251 int tgt_obd_ping(struct tgt_session_info *tsi);
252 int tgt_enqueue(struct tgt_session_info *tsi);
253 int tgt_convert(struct tgt_session_info *tsi);
254 int tgt_bl_callback(struct tgt_session_info *tsi);
255 int tgt_cp_callback(struct tgt_session_info *tsi);
256 int tgt_llog_open(struct tgt_session_info *tsi);
257 int tgt_llog_close(struct tgt_session_info *tsi);
258 int tgt_llog_destroy(struct tgt_session_info *tsi);
259 int tgt_llog_read_header(struct tgt_session_info *tsi);
260 int tgt_llog_next_block(struct tgt_session_info *tsi);
261 int tgt_llog_prev_block(struct tgt_session_info *tsi);
262 int tgt_sec_ctx_init(struct tgt_session_info *tsi);
263 int tgt_sec_ctx_init_cont(struct tgt_session_info *tsi);
264 int tgt_sec_ctx_fini(struct tgt_session_info *tsi);
265 int tgt_sendpage(struct tgt_session_info *tsi, struct lu_rdpg *rdpg, int nob);
266 int tgt_validate_obdo(struct tgt_session_info *tsi, struct obdo *oa);
267 int tgt_sync(const struct lu_env *env, struct lu_target *tgt,
268              struct dt_object *obj);
269
270 int tgt_io_thread_init(struct ptlrpc_thread *thread);
271 void tgt_io_thread_done(struct ptlrpc_thread *thread);
272
273 int tgt_extent_lock(struct ldlm_namespace *ns, struct ldlm_res_id *res_id,
274                     __u64 start, __u64 end, struct lustre_handle *lh,
275                     int mode, __u64 *flags);
276 void tgt_extent_unlock(struct lustre_handle *lh, ldlm_mode_t mode);
277 int tgt_brw_lock(struct ldlm_namespace *ns, struct ldlm_res_id *res_id,
278                  struct obd_ioobj *obj, struct niobuf_remote *nb,
279                  struct lustre_handle *lh, int mode);
280 void tgt_brw_unlock(struct obd_ioobj *obj, struct niobuf_remote *niob,
281                     struct lustre_handle *lh, int mode);
282 int tgt_brw_read(struct tgt_session_info *tsi);
283 int tgt_brw_write(struct tgt_session_info *tsi);
284 int tgt_hpreq_handler(struct ptlrpc_request *req);
285 void tgt_register_lfsck_in_notify(int (*notify)(const struct lu_env *,
286                                                 struct dt_device *,
287                                                 struct lfsck_request *));
288 void tgt_register_lfsck_query(int (*query)(const struct lu_env *,
289                                            struct dt_device *,
290                                            struct lfsck_request *));
291
292 extern struct tgt_handler tgt_sec_ctx_handlers[];
293 extern struct tgt_handler tgt_lfsck_handlers[];
294 extern struct tgt_handler tgt_obd_handlers[];
295 extern struct tgt_handler tgt_dlm_handlers[];
296 extern struct tgt_handler tgt_llog_handlers[];
297 extern struct tgt_handler tgt_out_handlers[];
298 extern struct tgt_handler fld_handlers[];
299 extern struct tgt_handler seq_handlers[];
300
301 typedef void (*tgt_cb_t)(struct lu_target *lut, __u64 transno,
302                          void *data, int err);
303 struct tgt_commit_cb {
304         tgt_cb_t  tgt_cb_func;
305         void     *tgt_cb_data;
306 };
307
308 int tgt_hpreq_handler(struct ptlrpc_request *req);
309
310 /* target/tgt_main.c */
311 void tgt_boot_epoch_update(struct lu_target *lut);
312 int tgt_last_commit_cb_add(struct thandle *th, struct lu_target *lut,
313                            struct obd_export *exp, __u64 transno);
314 int tgt_new_client_cb_add(struct thandle *th, struct obd_export *exp);
315 int tgt_init(const struct lu_env *env, struct lu_target *lut,
316              struct obd_device *obd, struct dt_device *dt,
317              struct tgt_opc_slice *slice,
318              int request_fail_id, int reply_fail_id);
319 void tgt_fini(const struct lu_env *env, struct lu_target *lut);
320 int tgt_client_alloc(struct obd_export *exp);
321 void tgt_client_free(struct obd_export *exp);
322 int tgt_client_del(const struct lu_env *env, struct obd_export *exp);
323 int tgt_client_add(const struct lu_env *env, struct obd_export *exp, int);
324 int tgt_client_new(const struct lu_env *env, struct obd_export *exp);
325 int tgt_client_data_read(const struct lu_env *env, struct lu_target *tg,
326                          struct lsd_client_data *lcd, loff_t *off, int index);
327 int tgt_client_data_write(const struct lu_env *env, struct lu_target *tg,
328                           struct lsd_client_data *lcd, loff_t *off, struct thandle *th);
329 int tgt_server_data_read(const struct lu_env *env, struct lu_target *tg);
330 int tgt_server_data_write(const struct lu_env *env, struct lu_target *tg,
331                           struct thandle *th);
332 int tgt_server_data_update(const struct lu_env *env, struct lu_target *tg,
333                            int sync);
334 int tgt_truncate_last_rcvd(const struct lu_env *env, struct lu_target *tg,
335                            loff_t off);
336
337 /* target/out_lib.c */
338 struct dt_update_request *
339 out_find_update(struct thandle_update *tu, struct dt_device *dt_dev);
340 void out_destroy_update_req(struct dt_update_request *update);
341 struct dt_update_request *out_create_update_req(struct dt_device *dt);
342 struct dt_update_request *out_find_create_update_loc(struct thandle *th,
343                                                   struct dt_object *dt);
344 int out_prep_update_req(const struct lu_env *env, struct obd_import *imp,
345                         const struct object_update_request *ureq,
346                         struct ptlrpc_request **reqp);
347 int out_remote_sync(const struct lu_env *env, struct obd_import *imp,
348                     struct dt_update_request *update,
349                     struct ptlrpc_request **reqp);
350 int out_insert_update(const struct lu_env *env,
351                       struct dt_update_request *update,
352                       int op, const struct lu_fid *fid, int count,
353                       int *lens, const char **bufs);
354
355 enum {
356         ESERIOUS = 0x0001000
357 };
358
359 static inline int err_serious(int rc)
360 {
361         LASSERT(rc < 0);
362         return -(-rc | ESERIOUS);
363 }
364
365 static inline int clear_serious(int rc)
366 {
367         if (rc < 0)
368                 rc = -(-rc & ~ESERIOUS);
369         return rc;
370 }
371
372 static inline int is_serious(int rc)
373 {
374         return (rc < 0 && -rc & ESERIOUS);
375 }
376
377 /**
378  * Do not return server-side uid/gid to remote client
379  */
380 static inline void tgt_drop_id(struct obd_export *exp, struct obdo *oa)
381 {
382         if (unlikely(exp_connect_rmtclient(exp))) {
383                 oa->o_uid = -1;
384                 oa->o_gid = -1;
385                 oa->o_valid &= ~(OBD_MD_FLUID | OBD_MD_FLGID);
386         }
387 }
388
389 /*
390  * Unified target generic handers macros and generic functions.
391  */
392 #define TGT_RPC_HANDLER_HP(base, flags, opc, fn, hp, fmt, version)      \
393 [opc - base] = {                                                        \
394         .th_name        = #opc,                                         \
395         .th_fail_id     = OBD_FAIL_ ## opc ## _NET,                     \
396         .th_opc         = opc,                                          \
397         .th_flags       = flags,                                        \
398         .th_act         = fn,                                           \
399         .th_fmt         = fmt,                                          \
400         .th_version     = version,                                      \
401         .th_hp          = hp,                                           \
402 }
403 #define TGT_RPC_HANDLER(base, flags, opc, fn, fmt, version)             \
404         TGT_RPC_HANDLER_HP(base, flags, opc, fn, NULL, fmt, version)
405
406 /* MDT Request with a format known in advance */
407 #define TGT_MDT_HDL(flags, name, fn)                                    \
408         TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
409                         LUSTRE_MDS_VERSION)
410 /* Request with a format we do not yet know */
411 #define TGT_MDT_HDL_VAR(flags, name, fn)                                \
412         TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, NULL,           \
413                         LUSTRE_MDS_VERSION)
414
415 /* OST Request with a format known in advance */
416 #define TGT_OST_HDL(flags, name, fn)                                    \
417         TGT_RPC_HANDLER(OST_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
418                         LUSTRE_OST_VERSION)
419 #define TGT_OST_HDL_HP(flags, name, fn, hp)                             \
420         TGT_RPC_HANDLER_HP(OST_FIRST_OPC, flags, name, fn, hp,          \
421                            &RQF_ ## name, LUSTRE_OST_VERSION)
422
423 /* MGS request with a format known in advance */
424 #define TGT_MGS_HDL(flags, name, fn)                                    \
425         TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
426                         LUSTRE_MGS_VERSION)
427 #define TGT_MGS_HDL_VAR(flags, name, fn)                                \
428         TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, NULL,           \
429                         LUSTRE_MGS_VERSION)
430
431 /*
432  * OBD handler macros and generic functions.
433  */
434 #define TGT_OBD_HDL(flags, name, fn)                                    \
435         TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
436                         LUSTRE_OBD_VERSION)
437 #define TGT_OBD_HDL_VAR(flags, name, fn)                                \
438         TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, NULL,           \
439                         LUSTRE_OBD_VERSION)
440
441 /*
442  * DLM handler macros and generic functions.
443  */
444 #define TGT_DLM_HDL_VAR(flags, name, fn)                                \
445         TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, NULL,          \
446                         LUSTRE_DLM_VERSION)
447 #define TGT_DLM_HDL(flags, name, fn)                                    \
448         TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
449                         LUSTRE_DLM_VERSION)
450
451 /*
452  * LLOG handler macros and generic functions.
453  */
454 #define TGT_LLOG_HDL_VAR(flags, name, fn)                               \
455         TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, NULL,          \
456                         LUSTRE_LOG_VERSION)
457 #define TGT_LLOG_HDL(flags, name, fn)                                   \
458         TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
459                         LUSTRE_LOG_VERSION)
460
461 /*
462  * Sec context handler macros and generic functions.
463  */
464 #define TGT_SEC_HDL_VAR(flags, name, fn)                                \
465         TGT_RPC_HANDLER(SEC_FIRST_OPC, flags, name, fn, NULL,           \
466                         LUSTRE_OBD_VERSION)
467
468 #define TGT_QUOTA_HDL(flags, name, fn)                                  \
469         TGT_RPC_HANDLER(QUOTA_DQACQ, flags, name, fn, &RQF_ ## name,    \
470                         LUSTRE_MDS_VERSION)
471
472 /* Sequence service handlers */
473 #define TGT_SEQ_HDL(flags, name, fn)                                    \
474         TGT_RPC_HANDLER(SEQ_QUERY, flags, name, fn, &RQF_ ## name,      \
475                         LUSTRE_MDS_VERSION)
476
477 /* FID Location Database handlers */
478 #define TGT_FLD_HDL_VAR(flags, name, fn)                                \
479         TGT_RPC_HANDLER(FLD_QUERY, flags, name, fn, NULL,               \
480                         LUSTRE_MDS_VERSION)
481
482 /* LFSCK handlers */
483 #define TGT_LFSCK_HDL(flags, name, fn)                                  \
484         TGT_RPC_HANDLER(LFSCK_FIRST_OPC, flags, name, fn,               \
485                         &RQF_ ## name, LUSTRE_OBD_VERSION)
486
487 /* Request with a format known in advance */
488 #define TGT_UPDATE_HDL(flags, name, fn)                                 \
489         TGT_RPC_HANDLER(OUT_UPDATE, flags, name, fn, &RQF_ ## name,     \
490                         LUSTRE_MDS_VERSION)
491
492 #endif /* __LUSTRE_LU_TARGET_H */