Whamcloud - gitweb
LU-3467 mdt: call MDT handlers via unified request handler
[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
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         const struct mdt_body   *tsi_mdt_body;
99         struct lu_object        *tsi_corpus;
100
101         /*
102          * Additional fail id that can be set by handler.
103          */
104         int                      tsi_reply_fail_id;
105         int                      tsi_request_fail_id;
106
107         __u32                    tsi_has_trans:1; /* has txn already? */
108 };
109
110 static inline struct tgt_session_info *tgt_ses_info(const struct lu_env *env)
111 {
112         struct tgt_session_info *tsi;
113
114         LASSERT(env->le_ses != NULL);
115         tsi = lu_context_key_get(env->le_ses, &tgt_session_key);
116         LASSERT(tsi);
117         return tsi;
118 }
119
120 /*
121  * Generic unified target support.
122  */
123 enum tgt_handler_flags {
124         /*
125          * struct *_body is passed in the incoming message, and object
126          * identified by this fid exists on disk.
127          *                            *
128          * "habeo corpus" == "I have a body"
129          */
130         HABEO_CORPUS = (1 << 0),
131         /*
132          * struct ldlm_request is passed in the incoming message.
133          *
134          * "habeo clavis" == "I have a key"
135          *                                     */
136         HABEO_CLAVIS = (1 << 1),
137         /*
138          * this request has fixed reply format, so that reply message can be
139          * packed by generic code.
140          *
141          * "habeo refero" == "I have a reply"
142          */
143         HABEO_REFERO = (1 << 2),
144         /*
145          * this request will modify something, so check whether the file system
146          * is readonly or not, then return -EROFS to client asap if necessary.
147          *
148          * "mutabor" == "I shall modify"
149          */
150         MUTABOR      = (1 << 3)
151 };
152
153 struct tgt_handler {
154         /* The name of this handler. */
155         const char              *th_name;
156         /* Fail id, check at the beginning */
157         int                      th_fail_id;
158         /* Operation code */
159         __u32                    th_opc;
160         /* Flags in enum tgt_handler_flags */
161         __u32                    th_flags;
162         /* Request version for this opcode */
163         int                      th_version;
164         /* Handler function */
165         int                     (*th_act)(struct tgt_session_info *tti);
166         /* Request format for this request */
167         const struct req_format *th_fmt;
168 };
169
170 struct tgt_opc_slice {
171         __u32                    tos_opc_start; /* First op code */
172         __u32                    tos_opc_end; /* Last op code */
173         struct tgt_handler      *tos_hs; /* Registered handler */
174 };
175
176 static inline struct ptlrpc_request *tgt_ses_req(struct tgt_session_info *tsi)
177 {
178         return tsi->tsi_pill ? tsi->tsi_pill->rc_req : NULL;
179 }
180
181 static inline __u64 tgt_conn_flags(struct tgt_session_info *tsi)
182 {
183         LASSERT(tsi->tsi_exp);
184         return exp_connect_flags(tsi->tsi_exp);
185 }
186
187 static inline int req_is_replay(struct ptlrpc_request *req)
188 {
189         LASSERT(req->rq_reqmsg);
190         return !!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY);
191 }
192
193 /* target/tgt_handler.c */
194 int tgt_request_handle(struct ptlrpc_request *req);
195 char *tgt_name(struct lu_target *tgt);
196 void tgt_counter_incr(struct obd_export *exp, int opcode);
197 int tgt_connect_check_sptlrpc(struct ptlrpc_request *req,
198                               struct obd_export *exp);
199 int tgt_connect(struct tgt_session_info *tsi);
200 int tgt_disconnect(struct tgt_session_info *uti);
201 int tgt_obd_ping(struct tgt_session_info *tsi);
202 int tgt_enqueue(struct tgt_session_info *tsi);
203 int tgt_convert(struct tgt_session_info *tsi);
204 int tgt_bl_callback(struct tgt_session_info *tsi);
205 int tgt_cp_callback(struct tgt_session_info *tsi);
206 int tgt_llog_open(struct tgt_session_info *tsi);
207 int tgt_llog_close(struct tgt_session_info *tsi);
208 int tgt_llog_destroy(struct tgt_session_info *tsi);
209 int tgt_llog_read_header(struct tgt_session_info *tsi);
210 int tgt_llog_next_block(struct tgt_session_info *tsi);
211 int tgt_llog_prev_block(struct tgt_session_info *tsi);
212 int tgt_sec_ctx_init(struct tgt_session_info *tsi);
213 int tgt_sec_ctx_init_cont(struct tgt_session_info *tsi);
214 int tgt_sec_ctx_fini(struct tgt_session_info *tsi);
215 int tgt_sendpage(struct tgt_session_info *tsi, struct lu_rdpg *rdpg, int nob);
216
217 extern struct tgt_handler tgt_sec_ctx_handlers[];
218 extern struct tgt_handler tgt_obd_handlers[];
219 extern struct tgt_handler tgt_dlm_handlers[];
220 extern struct tgt_handler tgt_llog_handlers[];
221 extern struct tgt_handler tgt_out_handlers[];
222 extern struct tgt_handler fld_handlers[];
223 extern struct tgt_handler seq_handlers[];
224
225 typedef void (*tgt_cb_t)(struct lu_target *lut, __u64 transno,
226                          void *data, int err);
227 struct tgt_commit_cb {
228         tgt_cb_t  tgt_cb_func;
229         void     *tgt_cb_data;
230 };
231
232 /* target/tgt_main.c */
233 void tgt_boot_epoch_update(struct lu_target *lut);
234 int tgt_last_commit_cb_add(struct thandle *th, struct lu_target *lut,
235                            struct obd_export *exp, __u64 transno);
236 int tgt_new_client_cb_add(struct thandle *th, struct obd_export *exp);
237 int tgt_init(const struct lu_env *env, struct lu_target *lut,
238              struct obd_device *obd, struct dt_device *dt,
239              struct tgt_opc_slice *slice,
240              int request_fail_id, int reply_fail_id);
241 void tgt_fini(const struct lu_env *env, struct lu_target *lut);
242 int tgt_client_alloc(struct obd_export *exp);
243 void tgt_client_free(struct obd_export *exp);
244 int tgt_client_del(const struct lu_env *env, struct obd_export *exp);
245 int tgt_client_add(const struct lu_env *env, struct obd_export *exp, int);
246 int tgt_client_new(const struct lu_env *env, struct obd_export *exp);
247 int tgt_client_data_read(const struct lu_env *env, struct lu_target *tg,
248                          struct lsd_client_data *lcd, loff_t *off, int index);
249 int tgt_client_data_write(const struct lu_env *env, struct lu_target *tg,
250                           struct lsd_client_data *lcd, loff_t *off, struct thandle *th);
251 int tgt_server_data_read(const struct lu_env *env, struct lu_target *tg);
252 int tgt_server_data_write(const struct lu_env *env, struct lu_target *tg,
253                           struct thandle *th);
254 int tgt_server_data_update(const struct lu_env *env, struct lu_target *tg,
255                            int sync);
256 int tgt_truncate_last_rcvd(const struct lu_env *env, struct lu_target *tg,
257                            loff_t off);
258 int tgt_last_rcvd_update(const struct lu_env *env, struct lu_target *tgt,
259                          struct dt_object *obj, __u64 opdata,
260                          struct thandle *th, struct ptlrpc_request *req);
261 enum {
262         ESERIOUS = 0x0001000
263 };
264
265 static inline int err_serious(int rc)
266 {
267         LASSERT(rc < 0);
268         return -(-rc | ESERIOUS);
269 }
270
271 static inline int clear_serious(int rc)
272 {
273         if (rc < 0)
274                 rc = -(-rc & ~ESERIOUS);
275         return rc;
276 }
277
278 static inline int is_serious(int rc)
279 {
280         return (rc < 0 && -rc & ESERIOUS);
281 }
282
283 /*
284  * Unified target generic handers macros and generic functions.
285  */
286 #define TGT_RPC_HANDLER(base, flags, opc, fn, fmt, version)             \
287 [opc - base] = {                                                        \
288         .th_name        = #opc,                                         \
289         .th_fail_id     = OBD_FAIL_ ## opc ## _NET,                     \
290         .th_opc         = opc,                                          \
291         .th_flags       = flags,                                        \
292         .th_act         = fn,                                           \
293         .th_fmt         = fmt,                                          \
294         .th_version     = version                                       \
295 }
296
297 /* MDT Request with a format known in advance */
298 #define TGT_MDT_HDL(flags, name, fn)                                    \
299         TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
300                         LUSTRE_MDS_VERSION)
301 /* Request with a format we do not yet know */
302 #define TGT_MDT_HDL_VAR(flags, name, fn)                                \
303         TGT_RPC_HANDLER(MDS_FIRST_OPC, flags, name, fn, NULL,           \
304                         LUSTRE_MDS_VERSION)
305
306 /* MGS request with a format known in advance */
307 #define TGT_MGS_HDL(flags, name, fn)                                    \
308         TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
309                         LUSTRE_MGS_VERSION)
310 #define TGT_MGS_HDL_VAR(flags, name, fn)                                \
311         TGT_RPC_HANDLER(MGS_FIRST_OPC, flags, name, fn, NULL,           \
312                         LUSTRE_MGS_VERSION)
313
314 /*
315  * OBD handler macros and generic functions.
316  */
317 #define TGT_OBD_HDL(flags, name, fn)                                    \
318         TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, &RQF_ ## name,  \
319                         LUSTRE_OBD_VERSION)
320 #define TGT_OBD_HDL_VAR(flags, name, fn)                                \
321         TGT_RPC_HANDLER(OBD_FIRST_OPC, flags, name, fn, NULL,           \
322                         LUSTRE_OBD_VERSION)
323
324 /*
325  * DLM handler macros and generic functions.
326  */
327 #define TGT_DLM_HDL_VAR(flags, name, fn)                                \
328         TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, NULL,          \
329                         LUSTRE_DLM_VERSION)
330 #define TGT_DLM_HDL(flags, name, fn)                                    \
331         TGT_RPC_HANDLER(LDLM_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
332                         LUSTRE_DLM_VERSION)
333
334 /*
335  * LLOG handler macros and generic functions.
336  */
337 #define TGT_LLOG_HDL_VAR(flags, name, fn)                               \
338         TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, NULL,          \
339                         LUSTRE_LOG_VERSION)
340 #define TGT_LLOG_HDL(flags, name, fn)                                   \
341         TGT_RPC_HANDLER(LLOG_FIRST_OPC, flags, name, fn, &RQF_ ## name, \
342                         LUSTRE_LOG_VERSION)
343
344 /*
345  * Sec context handler macros and generic functions.
346  */
347 #define TGT_SEC_HDL_VAR(flags, name, fn)                                \
348         TGT_RPC_HANDLER(SEC_FIRST_OPC, flags, name, fn, NULL,           \
349                         LUSTRE_OBD_VERSION)
350
351 #define TGT_QUOTA_HDL(flags, name, fn)                                  \
352         TGT_RPC_HANDLER(QUOTA_DQACQ, flags, name, fn, &RQF_ ## name,    \
353                         LUSTRE_MDS_VERSION)
354
355 /* Sequence service handlers */
356 #define TGT_SEQ_HDL(flags, name, fn)                                    \
357         TGT_RPC_HANDLER(SEQ_QUERY, flags, name, fn, &RQF_ ## name,      \
358                         LUSTRE_MDS_VERSION)
359
360 /* FID Location Database handlers */
361 #define TGT_FLD_HDL(flags, name, fn)                                    \
362         TGT_RPC_HANDLER(FLD_QUERY, flags, name, fn, &RQF_ ## name,      \
363                         LUSTRE_MDS_VERSION)
364
365 /* Request with a format known in advance */
366 #define TGT_UPDATE_HDL(flags, name, fn)                                 \
367         TGT_RPC_HANDLER(UPDATE_OBJ, flags, name, fn, &RQF_ ## name,     \
368                         LUSTRE_MDS_VERSION)
369
370 #endif /* __LUSTRE_LU_TARGET_H */