Whamcloud - gitweb
LU-3660 acl: support mount option "noacl" for zfs
[fs/lustre-release.git] / lustre / osd-zfs / osd_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.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 /*
31  * Copyright (c) 2012, 2013, Intel Corporation.
32  * Use is subject to license terms.
33  */
34 /*
35  * This file is part of Lustre, http://www.lustre.org/
36  * Lustre is a trademark of Sun Microsystems, Inc.
37  *
38  * lustre/osd-zfs/osd_internal.h
39  * Shared definitions and declarations for zfs/dmu osd
40  *
41  * Author: Alex Zhuravlev <bzzz@whamcloud.com>
42  * Author: Mike Pershin <tappro@whamcloud.com>
43  * Author: Johann Lombardi <johann@whamcloud.com>
44  */
45
46 #ifndef _OSD_INTERNAL_H
47 #define _OSD_INTERNAL_H
48
49 #include <dt_object.h>
50 #include <md_object.h>
51 #include <lustre_quota.h>
52
53 #define _SPL_KMEM_H
54 #include <sys/kstat.h>
55 #define kmem_zalloc(a, b)       kzalloc(a, b)
56 #define kmem_free(ptr, sz)      ((void)(sz), kfree(ptr))
57 #ifndef KM_SLEEP
58 #define KM_SLEEP                GFP_KERNEL
59 #endif
60
61 #include <sys/arc.h>
62
63 #include <sys/nvpair.h>
64
65 #include <sys/zfs_znode.h>
66 #include "udmu.h"
67
68 #define LUSTRE_ROOT_FID_SEQ     0
69 #define DMU_OSD_SVNAME          "svname"
70 #define DMU_OSD_OI_NAME_BASE    "oi"
71
72 #define OSD_GFP_IO              (GFP_NOFS | __GFP_HIGHMEM)
73
74 /**
75  * Iterator's in-memory data structure for quota file.
76  */
77 struct osd_it_quota {
78         struct osd_object       *oiq_obj;
79         /* DMU accounting object id */
80         uint64_t                 oiq_oid;
81         /* ZAP cursor */
82         zap_cursor_t            *oiq_zc;
83         /** identifier for current quota record */
84         __u64                    oiq_id;
85         unsigned                 oiq_reset:1; /* 1 -- no need to advance */
86 };
87
88 /**
89  * Iterator's in-memory data structure for ZAPs
90  *
91  * ZFS does not store . and .. on a disk, instead they are
92  * generated up on request
93  * to follow this format we do the same
94  */
95 struct osd_zap_it {
96         zap_cursor_t            *ozi_zc;
97         struct osd_object       *ozi_obj;
98         struct lustre_capa      *ozi_capa;
99         unsigned                 ozi_reset:1;   /* 1 -- no need to advance */
100         /* ozi_pos - position of the cursor:
101          * 0 - before any record
102          * 1 - "."
103          * 2 - ".."
104          * 3 - real records */
105         unsigned                 ozi_pos:3;
106         union {
107                 char             ozi_name[MAXNAMELEN]; /* file name for dir */
108                 __u64            ozi_key; /* binary key for index files */
109         };
110 };
111 #define DT_IT2DT(it) (&((struct osd_zap_it *)it)->ozi_obj->oo_dt)
112
113 /*
114  * regular ZFS direntry
115  */
116 struct zpl_direntry {
117         uint64_t        zde_dnode:48,
118                         zde_pad:12,
119                         zde_type:4;
120 } __attribute__((packed));
121
122 /*
123  * lustre direntry adds a fid to regular ZFS direntry
124  */
125 struct luz_direntry {
126         struct zpl_direntry     lzd_reg;
127         struct lu_fid           lzd_fid;
128 } __attribute__((packed));
129
130
131 /* cached SA attributes */
132 struct osa_attr {
133         uint64_t        mode;
134         uint64_t        gid;
135         uint64_t        uid;
136         uint64_t        nlink;
137         uint64_t        rdev;
138         uint64_t        flags;
139         uint64_t        size;
140         uint64_t        atime[2];
141         uint64_t        mtime[2];
142         uint64_t        ctime[2];
143 };
144
145 struct osd_thread_info {
146         const struct lu_env     *oti_env;
147
148         struct lu_fid            oti_fid;
149         /*
150          * XXX temporary: for ->i_op calls.
151          */
152         struct timespec          oti_time;
153         /*
154          * XXX temporary: for capa operations.
155          */
156         struct lustre_capa_key   oti_capa_key;
157         struct lustre_capa       oti_capa;
158
159         struct ost_id            oti_ostid;
160
161         char                     oti_buf[64];
162
163         /** osd iterator context used for iterator session */
164         union {
165                 struct osd_zap_it       oti_it_zap;
166                 struct osd_it_quota     oti_it_quota;
167         };
168
169         char                     oti_str[64];
170         union {
171                 char             oti_key[MAXNAMELEN + 1];
172                 __u64            oti_key64[(MAXNAMELEN + 1)/sizeof(__u64)];
173         };
174         struct lustre_mdt_attrs oti_mdt_attrs;
175
176         struct lu_attr           oti_la;
177         struct osa_attr          oti_osa;
178         zap_attribute_t          oti_za;
179         dmu_object_info_t        oti_doi;
180         struct luz_direntry      oti_zde;
181
182         struct lquota_id_info    oti_qi;
183         struct lu_seq_range      oti_seq_range;
184 };
185
186 extern struct lu_context_key osd_key;
187
188 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
189 {
190         return lu_context_key_get(&env->le_ctx, &osd_key);
191 }
192
193 struct osd_thandle {
194         struct thandle           ot_super;
195         struct list_head         ot_dcb_list;
196         struct list_head         ot_sa_list;
197         struct semaphore         ot_sa_lock;
198         dmu_tx_t                *ot_tx;
199         struct lquota_trans      ot_quota_trans;
200         __u32                    ot_write_commit:1,
201                                  ot_assigned:1;
202 };
203
204 #define OSD_OI_NAME_SIZE        16
205
206 /*
207  * Object Index (OI) instance.
208  */
209 struct osd_oi {
210         char                    oi_name[OSD_OI_NAME_SIZE]; /* unused */
211         uint64_t                oi_zapid;
212 };
213
214 struct osd_seq {
215         uint64_t         *os_compat_dirs;
216         int              os_subdir_count; /* subdir count for each seq */
217         obd_seq          os_seq;          /* seq number */
218         struct list_head os_seq_list;     /* list to seq_list */
219 };
220
221 struct osd_seq_list {
222         rwlock_t         osl_seq_list_lock;     /* lock for seq_list */
223         struct list_head osl_seq_list;          /* list head for seq */
224         struct semaphore osl_seq_init_sem;
225 };
226
227 #define OSD_OST_MAP_SIZE        32
228
229 /*
230  * osd device.
231  */
232 struct osd_device {
233         /* super-class */
234         struct dt_device         od_dt_dev;
235         /* information about underlying file system */
236         udmu_objset_t            od_objset;
237
238         /*
239          * Fid Capability
240          */
241         unsigned int             od_fl_capa:1;
242         unsigned long            od_capa_timeout;
243         __u32                    od_capa_alg;
244         struct lustre_capa_key  *od_capa_keys;
245         struct hlist_head       *od_capa_hash;
246
247         cfs_proc_dir_entry_t    *od_proc_entry;
248         struct lprocfs_stats    *od_stats;
249
250         uint64_t                 od_root;
251         uint64_t                 od_O_id;
252         struct osd_oi           **od_oi_table;
253         unsigned int             od_oi_count;
254         struct osd_seq_list     od_seq_list;
255
256         unsigned int             od_rdonly:1,
257                                  od_xattr_in_sa:1,
258                                  od_quota_iused_est:1,
259                                  od_is_ost:1,
260                                  od_posix_acl:1;
261
262         char                     od_mntdev[128];
263         char                     od_svname[128];
264
265         int                      od_connects;
266         struct lu_site           od_site;
267
268         /* object IDs of the inode accounting indexes */
269         uint64_t                 od_iusr_oid;
270         uint64_t                 od_igrp_oid;
271
272         /* quota slave instance */
273         struct qsd_instance     *od_quota_slave;
274
275         /* used to debug zerocopy logic: the fields track all
276          * allocated, loaned and referenced buffers in use.
277          * to be removed once the change is tested well. */
278         atomic_t                 od_zerocopy_alloc;
279         atomic_t                 od_zerocopy_loan;
280         atomic_t                 od_zerocopy_pin;
281
282         arc_prune_t             *arc_prune_cb;
283
284         /* osd seq instance */
285         struct lu_client_seq    *od_cl_seq;
286 };
287
288 struct osd_object {
289         struct dt_object         oo_dt;
290         /*
291          * Inode for file system object represented by this osd_object. This
292          * inode is pinned for the whole duration of lu_object life.
293          *
294          * Not modified concurrently (either setup early during object
295          * creation, or assigned by osd_object_create() under write lock).
296          */
297         dmu_buf_t               *oo_db;
298         sa_handle_t             *oo_sa_hdl;
299         nvlist_t                *oo_sa_xattr;
300         struct list_head         oo_sa_linkage;
301
302         struct rw_semaphore      oo_sem;
303
304         /* cached attributes */
305         rwlock_t                 oo_attr_lock;
306         struct lu_attr           oo_attr;
307
308         /* protects extended attributes */
309         struct semaphore         oo_guard;
310         uint64_t                 oo_xattr;
311
312         /* record size for index file */
313         unsigned char            oo_keysize;
314         unsigned char            oo_recsize;
315         unsigned char            oo_recusize;   /* unit size */
316 };
317
318 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *);
319 extern const struct dt_index_operations osd_acct_index_ops;
320 uint64_t osd_quota_fid2dmu(const struct lu_fid *fid);
321 extern struct lu_device_operations  osd_lu_ops;
322 int osd_declare_quota(const struct lu_env *env, struct osd_device *osd,
323                       qid_t uid, qid_t gid, long long space,
324                       struct osd_thandle *oh, bool is_blk, int *flags,
325                       bool force);
326
327 /*
328  * Helpers.
329  */
330 static inline int lu_device_is_osd(const struct lu_device *d)
331 {
332         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
333 }
334
335 static inline struct osd_object *osd_obj(const struct lu_object *o)
336 {
337         LASSERT(lu_device_is_osd(o->lo_dev));
338         return container_of0(o, struct osd_object, oo_dt.do_lu);
339 }
340
341 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
342 {
343         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
344         return container_of0(d, struct osd_device, od_dt_dev);
345 }
346
347 static inline struct osd_device *osd_dev(const struct lu_device *d)
348 {
349         LASSERT(lu_device_is_osd(d));
350         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
351 }
352
353 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
354 {
355         return osd_obj(&d->do_lu);
356 }
357
358 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
359 {
360         return osd_dev(o->oo_dt.do_lu.lo_dev);
361 }
362
363 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
364 {
365         return &osd->od_dt_dev.dd_lu_dev;
366 }
367
368 static inline struct objset * osd_dtobj2objset(struct dt_object *o)
369 {
370         return osd_dev(o->do_lu.lo_dev)->od_objset.os;
371 }
372
373 static inline int osd_invariant(const struct osd_object *obj)
374 {
375         return 1;
376 }
377
378 static inline int osd_object_invariant(const struct lu_object *l)
379 {
380         return osd_invariant(osd_obj(l));
381 }
382
383 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
384 {
385         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
386 }
387
388 static inline char *osd_name(struct osd_device *osd)
389 {
390         return osd->od_dt_dev.dd_lu_dev.ld_obd->obd_name;
391 }
392
393 #ifdef LPROCFS
394 enum {
395         LPROC_OSD_READ_BYTES = 0,
396         LPROC_OSD_WRITE_BYTES = 1,
397         LPROC_OSD_GET_PAGE = 2,
398         LPROC_OSD_NO_PAGE = 3,
399         LPROC_OSD_CACHE_ACCESS = 4,
400         LPROC_OSD_CACHE_HIT = 5,
401         LPROC_OSD_CACHE_MISS = 6,
402         LPROC_OSD_COPY_IO = 7,
403         LPROC_OSD_ZEROCOPY_IO = 8,
404         LPROC_OSD_TAIL_IO = 9,
405         LPROC_OSD_LAST,
406 };
407
408 /* osd_lproc.c */
409 extern struct lprocfs_seq_vars lprocfs_osd_obd_vars[];
410
411 int osd_procfs_init(struct osd_device *osd, const char *name);
412 int osd_procfs_fini(struct osd_device *osd);
413
414 int udmu_zap_cursor_retrieve_key(const struct lu_env *env,
415                                  zap_cursor_t *zc, char *key, int max);
416 int udmu_zap_cursor_retrieve_value(const struct lu_env *env,
417                                    zap_cursor_t *zc,  char *buf,
418                                    int buf_size, int *bytes_read);
419
420 /* osd_object.c */
421 void osd_object_sa_dirty_rele(struct osd_thandle *oh);
422 int __osd_obj2dbuf(const struct lu_env *env, objset_t *os,
423                    uint64_t oid, dmu_buf_t **dbp, void *tag);
424 struct lu_object *osd_object_alloc(const struct lu_env *env,
425                                    const struct lu_object_header *hdr,
426                                    struct lu_device *d);
427 int osd_object_sa_update(struct osd_object *obj, sa_attr_type_t type,
428                          void *buf, uint32_t buflen, struct osd_thandle *oh);
429 int __osd_zap_create(const struct lu_env *env, udmu_objset_t *uos,
430                      dmu_buf_t **zap_dbp, dmu_tx_t *tx, struct lu_attr *la,
431                      uint64_t parent, void *tag, zap_flags_t flags);
432 int __osd_object_create(const struct lu_env *env, udmu_objset_t *uos,
433                         dmu_buf_t **dbp, dmu_tx_t *tx, struct lu_attr *la,
434                         uint64_t parent, void *tag);
435 int __osd_object_free(udmu_objset_t *uos, uint64_t oid, dmu_tx_t *tx);
436
437 /* osd_oi.c */
438 int osd_oi_init(const struct lu_env *env, struct osd_device *o);
439 void osd_oi_fini(const struct lu_env *env, struct osd_device *o);
440 int osd_fid_lookup(const struct lu_env *env,
441                    struct osd_device *, const struct lu_fid *, uint64_t *);
442 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
443                             const struct lu_fid *fid, char *buf);
444 int osd_options_init(void);
445 int osd_convert_root_to_new_seq(const struct lu_env *env,
446                                 struct osd_device *o);
447 int osd_ost_seq_exists(const struct lu_env *env, struct osd_device *osd,
448                        __u64 seq);
449 /* osd_index.c */
450 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
451                   const struct dt_index_features *feat);
452 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
453                    obd_seq seq, struct lu_seq_range *range);
454
455 /* osd_xattr.c */
456 int __osd_xattr_load(udmu_objset_t *uos, uint64_t dnode, nvlist_t **sa_xattr);
457 int __osd_xattr_get_large(const struct lu_env *env, udmu_objset_t *uos,
458                           uint64_t xattr, struct lu_buf *buf,
459                           const char *name, int *sizep);
460 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
461                   struct lu_buf *buf, const char *name,
462                   struct lustre_capa *capa);
463 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
464                           const struct lu_buf *buf, const char *name,
465                           int fl, struct thandle *handle);
466 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
467                   const struct lu_buf *buf, const char *name, int fl,
468                   struct thandle *handle, struct lustre_capa *capa);
469 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
470                           const char *name, struct thandle *handle);
471 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
472                   const char *name, struct thandle *handle,
473                   struct lustre_capa *capa);
474 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
475                    struct lu_buf *lb, struct lustre_capa *capa);
476 void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
477                         int vallen, const char *name, struct osd_thandle *oh);
478 int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
479                        const struct lu_buf *buf, const char *name, int fl,
480                        struct osd_thandle *oh);;
481 int __osd_xattr_set(const struct lu_env *env, struct osd_object *obj,
482                     const struct lu_buf *buf, const char *name, int fl,
483                     struct osd_thandle *oh);
484 static inline int
485 osd_xattr_set_internal(const struct lu_env *env, struct osd_object *obj,
486                        const struct lu_buf *buf, const char *name, int fl,
487                        struct osd_thandle *oh, struct lustre_capa *capa)
488 {
489         int rc;
490
491         if (osd_obj2dev(obj)->od_xattr_in_sa) {
492                 rc = __osd_sa_xattr_set(env, obj, buf, name, fl, oh);
493                 if (rc == -EFBIG)
494                         rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
495         } else {
496                 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
497         }
498
499         return rc;
500 }
501
502 static inline uint64_t attrs_fs2zfs(const uint32_t flags)
503 {
504         return (((flags & FS_APPEND_FL)         ? ZFS_APPENDONLY        : 0) |
505                 ((flags & FS_NODUMP_FL)         ? ZFS_NODUMP            : 0) |
506                 ((flags & FS_IMMUTABLE_FL)      ? ZFS_IMMUTABLE         : 0));
507 }
508
509 static inline uint32_t attrs_zfs2fs(const uint64_t flags)
510 {
511         return (((flags & ZFS_APPENDONLY)       ? FS_APPEND_FL          : 0) |
512                 ((flags & ZFS_NODUMP)           ? FS_NODUMP_FL          : 0) |
513                 ((flags & ZFS_IMMUTABLE)        ? FS_IMMUTABLE_FL       : 0));
514 }
515
516 #endif
517
518 #ifndef HAVE_DSL_POOL_CONFIG
519 static inline void dsl_pool_config_enter(dsl_pool_t *dp, char *name)
520 {
521 }
522
523 static inline void dsl_pool_config_exit(dsl_pool_t *dp, char *name)
524 {
525 }
526
527 #endif
528
529 #endif /* _OSD_INTERNAL_H */