Whamcloud - gitweb
LU-12616 obclass: fix MDS start/stop race
[fs/lustre-release.git] / lustre / ofd / ofd_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, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  */
32
33 #ifndef _OFD_INTERNAL_H
34 #define _OFD_INTERNAL_H
35
36 #include <obd.h>
37 #include <obd_class.h>
38 #include <dt_object.h>
39 #include <md_object.h>
40 #include <lustre_fid.h>
41
42 #define OFD_INIT_OBJID  0
43 #define OFD_PRECREATE_BATCH_DEFAULT (OBJ_SUBDIR_COUNT * 4)
44
45 /* on small filesystems we should not precreate too many objects in
46  * a single transaction, otherwise we can overflow transactions */
47 #define OFD_PRECREATE_SMALL_FS          (1024ULL * 1024 * 1024)
48 #define OFD_PRECREATE_BATCH_SMALL       8
49
50 /* Limit the returned fields marked valid to those that we actually might set */
51 #define OFD_VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
52                          LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
53
54 #define OFD_SOFT_SYNC_LIMIT_DEFAULT 16
55
56 /* request stats */
57 enum {
58         LPROC_OFD_STATS_READ = 0,
59         LPROC_OFD_STATS_WRITE,
60         LPROC_OFD_STATS_GETATTR,
61         LPROC_OFD_STATS_SETATTR,
62         LPROC_OFD_STATS_PUNCH,
63         LPROC_OFD_STATS_SYNC,
64         LPROC_OFD_STATS_DESTROY,
65         LPROC_OFD_STATS_CREATE,
66         LPROC_OFD_STATS_STATFS,
67         LPROC_OFD_STATS_GET_INFO,
68         LPROC_OFD_STATS_SET_INFO,
69         LPROC_OFD_STATS_QUOTACTL,
70         LPROC_OFD_STATS_LAST,
71 };
72
73 static inline void ofd_counter_incr(struct obd_export *exp, int opcode,
74                                     char *jobid, long amount)
75 {
76         if (exp->exp_obd && exp->exp_obd->obd_stats)
77                 lprocfs_counter_add(exp->exp_obd->obd_stats, opcode, amount);
78
79         if (exp->exp_obd && exp->exp_obd->u.obt.obt_jobstats.ojs_hash &&
80             (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS))
81                 lprocfs_job_stats_log(exp->exp_obd, jobid, opcode, amount);
82
83         if (exp->exp_nid_stats != NULL &&
84             exp->exp_nid_stats->nid_stats != NULL) {
85                 lprocfs_counter_add(exp->exp_nid_stats->nid_stats, opcode,
86                                     amount);
87         }
88 }
89
90 struct ofd_seq {
91         struct list_head        os_list;
92         struct ost_id           os_oi;
93         spinlock_t              os_last_oid_lock;
94         struct mutex            os_create_lock;
95         atomic_t                os_refc;
96         atomic_t                os_precreate_in_progress;
97         struct dt_object        *os_lastid_obj;
98         unsigned long           os_destroys_in_progress:1,
99                                 os_last_id_synced:1;
100 };
101
102 struct ofd_device {
103         struct dt_device         ofd_dt_dev;
104         struct dt_device        *ofd_osd;
105         struct obd_export       *ofd_osd_exp;
106         /* DLM name-space for meta-data locks maintained by this server */
107         struct ldlm_namespace   *ofd_namespace;
108
109         /* last_rcvd file */
110         struct lu_target         ofd_lut;
111         struct dt_object        *ofd_health_check_file;
112         struct local_oid_storage *ofd_los;
113
114         __u64                    ofd_inconsistency_self_detected;
115         __u64                    ofd_inconsistency_self_repaired;
116
117         struct list_head        ofd_seq_list;
118         rwlock_t                ofd_seq_list_lock;
119         int                     ofd_seq_count;
120         int                     ofd_precreate_batch;
121         spinlock_t              ofd_batch_lock;
122
123         /* preferred BRW size, decided by storage type and capability */
124         __u32                    ofd_brw_size;
125         /* checksum types supported on this node */
126         enum cksum_types         ofd_cksum_types_supported;
127
128         spinlock_t               ofd_flags_lock;
129         unsigned long            ofd_raid_degraded:1,
130                                  /* sync journal on writes */
131                                  ofd_sync_journal:1,
132                                  /* Protected by ofd_lastid_rwsem. */
133                                  ofd_lastid_rebuilding:1,
134                                  ofd_record_fid_accessed:1,
135                                  ofd_lfsck_verify_pfid:1,
136                                  ofd_skip_lfsck:1,
137                                  /* Whether to enforce T10PI checksum of RPC */
138                                  ofd_checksum_t10pi_enforce:1;
139         struct seq_server_site   ofd_seq_site;
140         /* the limit of SOFT_SYNC RPCs that will trigger a soft sync */
141         unsigned int             ofd_soft_sync_limit;
142         /* Protect ::ofd_lastid_rebuilding */
143         struct rw_semaphore      ofd_lastid_rwsem;
144         __u64                    ofd_lastid_gen;
145         struct ptlrpc_thread     ofd_inconsistency_thread;
146         struct list_head         ofd_inconsistency_list;
147         spinlock_t               ofd_inconsistency_lock;
148         /* Backwards compatibility */
149         struct attribute        *ofd_read_cache_enable;
150         struct attribute        *ofd_read_cache_max_filesize;
151         struct attribute        *ofd_write_cache_enable;
152 };
153
154 static inline struct ofd_device *ofd_dev(struct lu_device *d)
155 {
156         return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
157 }
158
159 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
160 {
161         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
162 }
163
164 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
165 {
166         return ofd_dev(exp->exp_obd->obd_lu_dev);
167 }
168
169 static inline char *ofd_name(struct ofd_device *ofd)
170 {
171         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
172 }
173
174 struct ofd_object {
175         struct lu_object_header ofo_header;
176         struct dt_object        ofo_obj;
177         struct filter_fid       ofo_ff;
178         unsigned int            ofo_pfid_checking:1,
179                                 ofo_pfid_verified:1;
180 };
181
182 static inline struct ofd_object *ofd_obj(struct lu_object *o)
183 {
184         return container_of0(o, struct ofd_object, ofo_obj.do_lu);
185 }
186
187 static inline int ofd_object_exists(struct ofd_object *obj)
188 {
189         LASSERT(obj != NULL);
190         if (lu_object_is_dying(obj->ofo_obj.do_lu.lo_header))
191                 return 0;
192         return lu_object_exists(&obj->ofo_obj.do_lu);
193 }
194
195 static inline struct dt_object *fo2dt(struct ofd_object *obj)
196 {
197         return &obj->ofo_obj;
198 }
199
200 static inline struct dt_object *ofd_object_child(struct ofd_object *_obj)
201 {
202         struct lu_object *lu = &(_obj)->ofo_obj.do_lu;
203
204         return container_of0(lu_object_next(lu), struct dt_object, do_lu);
205 }
206
207 static inline struct ofd_device *ofd_obj2dev(const struct ofd_object *fo)
208 {
209         return ofd_dev(fo->ofo_obj.do_lu.lo_dev);
210 }
211
212 static inline void ofd_read_lock(const struct lu_env *env,
213                                  struct ofd_object *fo)
214 {
215         struct dt_object  *next = ofd_object_child(fo);
216
217         next->do_ops->do_read_lock(env, next, 0);
218 }
219
220 static inline void ofd_read_unlock(const struct lu_env *env,
221                                    struct ofd_object *fo)
222 {
223         struct dt_object  *next = ofd_object_child(fo);
224
225         next->do_ops->do_read_unlock(env, next);
226 }
227
228 static inline void ofd_write_lock(const struct lu_env *env,
229                                   struct ofd_object *fo)
230 {
231         struct dt_object *next = ofd_object_child(fo);
232
233         next->do_ops->do_write_lock(env, next, 0);
234 }
235
236 static inline void ofd_write_unlock(const struct lu_env *env,
237                                     struct ofd_object *fo)
238 {
239         struct dt_object  *next = ofd_object_child(fo);
240
241         next->do_ops->do_write_unlock(env, next);
242 }
243
244 /*
245  * Common data shared by obdofd-level handlers. This is allocated per-thread
246  * to reduce stack consumption.
247  */
248 struct ofd_thread_info {
249         const struct lu_env             *fti_env;
250
251         struct obd_export               *fti_exp;
252         __u64                            fti_xid;
253         __u64                            fti_pre_version;
254
255         struct lu_fid                    fti_fid;
256         struct lu_attr                   fti_attr;
257         struct lu_attr                   fti_attr2;
258         struct ldlm_res_id               fti_resid;
259         struct filter_fid                fti_mds_fid;
260         struct ost_id                    fti_ostid;
261         struct ofd_object               *fti_obj;
262         union {
263                 char                     name[64]; /* for ofd_init0() */
264                 struct obd_statfs        osfs;    /* for obdofd_statfs() */
265         } fti_u;
266
267         /* Ops object filename */
268         struct lu_name                   fti_name;
269         struct dt_object_format          fti_dof;
270         struct lu_buf                    fti_buf;
271         loff_t                           fti_off;
272
273         struct ost_lvb                   fti_lvb;
274         union {
275                 struct lfsck_req_local   fti_lrl;
276                 struct obd_connect_data  fti_ocd;
277         };
278 };
279
280 extern void target_recovery_fini(struct obd_device *obd);
281 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
282
283 /* ofd_dev.c */
284 extern struct lu_context_key ofd_thread_key;
285 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd);
286 int ofd_fiemap_get(const struct lu_env *env, struct ofd_device *ofd,
287                    struct lu_fid *fid, struct fiemap *fiemap);
288
289 /* ofd_obd.c */
290 extern struct obd_ops ofd_obd_ops;
291 int ofd_destroy_by_fid(const struct lu_env *env, struct ofd_device *ofd,
292                        const struct lu_fid *fid, int orphan);
293 int ofd_statfs(const struct lu_env *env,  struct obd_export *exp,
294                struct obd_statfs *osfs, time64_t max_age, __u32 flags);
295 int ofd_obd_disconnect(struct obd_export *exp);
296
297 /* ofd_fs.c */
298 u64 ofd_seq_last_oid(struct ofd_seq *oseq);
299 void ofd_seq_last_oid_set(struct ofd_seq *oseq, u64 id);
300 int ofd_seq_last_oid_write(const struct lu_env *env, struct ofd_device *ofd,
301                            struct ofd_seq *oseq);
302 int ofd_seqs_init(const struct lu_env *env, struct ofd_device *ofd);
303 struct ofd_seq *ofd_seq_get(struct ofd_device *ofd, u64 seq);
304 void ofd_seq_put(const struct lu_env *env, struct ofd_seq *oseq);
305
306 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
307                  struct obd_device *obd);
308 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
309 int ofd_precreate_batch(struct ofd_device *ofd, int batch);
310 struct ofd_seq *ofd_seq_load(const struct lu_env *env, struct ofd_device *ofd,
311                              u64 seq);
312 void ofd_seqs_fini(const struct lu_env *env, struct ofd_device *ofd);
313 void ofd_seqs_free(const struct lu_env *env, struct ofd_device *ofd);
314
315 /* ofd_io.c */
316 int ofd_start_inconsistency_verification_thread(struct ofd_device *ofd);
317 int ofd_stop_inconsistency_verification_thread(struct ofd_device *ofd);
318 int ofd_verify_ff(const struct lu_env *env, struct ofd_object *fo,
319                   struct obdo *oa);
320 int ofd_verify_layout_version(const struct lu_env *env,
321                               struct ofd_object *fo, const struct obdo *oa);
322 int ofd_preprw(const struct lu_env *env,int cmd, struct obd_export *exp,
323                struct obdo *oa, int objcount, struct obd_ioobj *obj,
324                struct niobuf_remote *rnb, int *nr_local,
325                struct niobuf_local *lnb);
326 int ofd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
327                  struct obdo *oa, int objcount, struct obd_ioobj *obj,
328                  struct niobuf_remote *rnb, int npages,
329                  struct niobuf_local *lnb, int old_rc);
330
331 /* ofd_trans.c */
332 struct thandle *ofd_trans_create(const struct lu_env *env,
333                                  struct ofd_device *ofd);
334 int ofd_trans_start(const struct lu_env *env,
335                     struct ofd_device *ofd, struct ofd_object *fo,
336                     struct thandle *th);
337 int ofd_trans_stop(const struct lu_env *env, struct ofd_device *ofd,
338                     struct thandle *th, int rc);
339 int ofd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
340                     void *cookie);
341
342 /* lproc_ofd.c */
343 int ofd_tunables_init(struct ofd_device *ofd);
344 #ifdef CONFIG_PROC_FS
345 void ofd_stats_counter_init(struct lprocfs_stats *stats);
346 #else
347 static inline void ofd_stats_counter_init(struct lprocfs_stats *stats) {}
348 #endif
349
350 /* ofd_objects.c */
351 struct ofd_object *ofd_object_find(const struct lu_env *env,
352                                    struct ofd_device *ofd,
353                                    const struct lu_fid *fid);
354 int ofd_object_ff_load(const struct lu_env *env, struct ofd_object *fo);
355 int ofd_object_ff_update(const struct lu_env *env, struct ofd_object *fo,
356                          const struct obdo *oa, struct filter_fid *ff);
357 int ofd_precreate_objects(const struct lu_env *env, struct ofd_device *ofd,
358                           u64 id, struct ofd_seq *oseq, int nr, int sync);
359
360 static inline void ofd_object_put(const struct lu_env *env,
361                                   struct ofd_object *fo)
362 {
363         dt_object_put(env, &fo->ofo_obj);
364 }
365 int ofd_attr_set(const struct lu_env *env, struct ofd_object *fo,
366                  struct lu_attr *la, struct obdo *oa);
367 int ofd_object_punch(const struct lu_env *env, struct ofd_object *fo,
368                      __u64 start, __u64 end, struct lu_attr *la,
369                      struct obdo *oa);
370 int ofd_destroy(const struct lu_env *, struct ofd_object *, int);
371 int ofd_attr_get(const struct lu_env *env, struct ofd_object *fo,
372                  struct lu_attr *la);
373 int ofd_attr_handle_id(const struct lu_env *env, struct ofd_object *fo,
374                          struct lu_attr *la, int is_setattr);
375
376 static inline
377 struct ofd_object *ofd_object_find_exists(const struct lu_env *env,
378                                           struct ofd_device *ofd,
379                                           const struct lu_fid *fid)
380 {
381         struct ofd_object *fo;
382
383         fo = ofd_object_find(env, ofd, fid);
384         if (!IS_ERR(fo) && !ofd_object_exists(fo)) {
385                 ofd_object_put(env, fo);
386                 fo = ERR_PTR(-ENOENT);
387         }
388         return fo;
389 }
390
391 /* ofd_dev.c */
392 int ofd_fid_set_index(const struct lu_env *env, struct ofd_device *ofd,
393                       int index);
394 int ofd_fid_init(const struct lu_env *env, struct ofd_device *ofd);
395 int ofd_fid_fini(const struct lu_env *env, struct ofd_device *ofd);
396
397 /* ofd_lvb.c */
398 extern struct ldlm_valblock_ops ofd_lvbo;
399
400 /* ofd_dlm.c */
401 extern struct kmem_cache *ldlm_glimpse_work_kmem;
402
403 int ofd_intent_policy(const struct lu_env *env, struct ldlm_namespace *ns,
404                       struct ldlm_lock **lockp, void *req_cookie,
405                       enum ldlm_mode mode, __u64 flags, void *data);
406
407 static inline struct ofd_thread_info *ofd_info(const struct lu_env *env)
408 {
409         struct ofd_thread_info *info;
410
411         lu_env_refill((void *)env);
412         info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
413         LASSERT(info);
414         return info;
415 }
416
417 static inline struct ofd_thread_info *ofd_info_init(const struct lu_env *env,
418                                                     struct obd_export *exp)
419 {
420         struct ofd_thread_info *info;
421
422         info = ofd_info(env);
423         LASSERT(info->fti_exp == NULL);
424         LASSERT(info->fti_env == NULL);
425         LASSERT(info->fti_attr.la_valid == 0);
426
427         info->fti_env = env;
428         info->fti_exp = exp;
429         info->fti_pre_version = 0;
430         return info;
431 }
432
433 static inline struct ofd_thread_info *tsi2ofd_info(struct tgt_session_info *tsi)
434 {
435         struct ptlrpc_request   *req = tgt_ses_req(tsi);
436         struct ofd_thread_info  *info;
437
438         info = ofd_info(tsi->tsi_env);
439         LASSERT(info->fti_exp == NULL);
440         LASSERT(info->fti_env == NULL);
441         LASSERT(info->fti_attr.la_valid == 0);
442
443         info->fti_env = tsi->tsi_env;
444         info->fti_exp = tsi->tsi_exp;
445
446         info->fti_xid = req->rq_xid;
447         /** VBR: take versions from request */
448         if (req->rq_reqmsg != NULL &&
449             lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY) {
450                 __u64 *pre_version = lustre_msg_get_versions(req->rq_reqmsg);
451
452                 info->fti_pre_version = pre_version ? pre_version[0] : 0;
453         }
454         return info;
455 }
456
457 /* sync on lock cancel is useless when we force a journal flush,
458  * and if we enable async journal commit, we should also turn on
459  * sync on lock cancel if it is not enabled already. */
460 static inline void ofd_slc_set(struct ofd_device *ofd)
461 {
462         if (ofd->ofd_sync_journal == 1)
463                 ofd->ofd_lut.lut_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
464         else if (ofd->ofd_lut.lut_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
465                 ofd->ofd_lut.lut_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
466 }
467
468 static inline int ofd_validate_seq(struct obd_export *exp, __u64 seq)
469 {
470         struct filter_export_data *fed = &exp->exp_filter_data;
471
472         if (unlikely(seq == FID_SEQ_OST_MDT0 && fed->fed_group != 0)) {
473                 /* IDIF request only operates on MDT0 group */
474                 CERROR("%s: Invalid sequence %#llx for group %u\n",
475                        exp->exp_obd->obd_name, seq, fed->fed_group);
476                 RETURN(-EINVAL);
477         }
478
479         return 0;
480 }
481
482 #endif /* _OFD_INTERNAL_H */