Whamcloud - gitweb
LU-1943 zfs-osd: different fixes 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) 2011, 2012 Whamcloud, Inc.
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 <lquota.h>
51 #include <sys/arc.h>
52
53 #include <sys/nvpair.h>
54
55 #include "udmu.h"
56
57 #define LUSTRE_ROOT_FID_SEQ     0
58 #define DMU_OSD_SVNAME          "svname"
59 #define DMU_OSD_OI_NAME_BASE    "oi"
60
61 #define OSD_GFP_IO              (GFP_NOFS | __GFP_HIGHMEM)
62
63 /**
64  * Iterator's in-memory data structure for quota file.
65  */
66 struct osd_it_quota {
67         struct osd_object       *oiq_obj;
68         /* DMU accounting object id */
69         uint64_t                 oiq_oid;
70         /* ZAP cursor */
71         zap_cursor_t            *oiq_zc;
72         /** identifier for current quota record */
73         __u64                    oiq_id;
74         unsigned                 oiq_reset:1; /* 1 -- no need to advance */
75 };
76
77 /**
78  * Iterator's in-memory data structure for ZAPs
79  */
80 struct osd_zap_it {
81         zap_cursor_t            *ozi_zc;
82         struct osd_object       *ozi_obj;
83         struct lustre_capa      *ozi_capa;
84         unsigned                 ozi_reset:1;     /* 1 -- no need to advance */
85         union {
86                 char             ozi_name[NAME_MAX + 1]; /* file name for dir */
87                 __u64            ozi_key; /* binary key for index files */
88         };
89 };
90 #define DT_IT2DT(it) (&((struct osd_zap_it *)it)->ozi_obj->oo_dt)
91
92 /*
93  * regular ZFS direntry
94  */
95 struct zpl_direntry {
96         uint64_t        zde_dnode:48,
97                         zde_pad:12,
98                         zde_type:4;
99 } __attribute__((packed));
100
101 /*
102  * lustre direntry adds a fid to regular ZFS direntry
103  */
104 struct luz_direntry {
105         struct zpl_direntry     lzd_reg;
106         struct lu_fid           lzd_fid;
107 } __attribute__((packed));
108
109
110 /* cached SA attributes */
111 struct osa_attr {
112         uint64_t        mode;
113         uint64_t        gid;
114         uint64_t        uid;
115         uint64_t        nlink;
116         uint64_t        rdev;
117         uint64_t        flags;
118         uint64_t        size;
119         uint64_t        atime[2];
120         uint64_t        mtime[2];
121         uint64_t        ctime[2];
122 };
123
124 struct osd_thread_info {
125         const struct lu_env     *oti_env;
126
127         struct lu_fid            oti_fid;
128         /*
129          * XXX temporary: for ->i_op calls.
130          */
131         struct timespec          oti_time;
132         /*
133          * XXX temporary: for capa operations.
134          */
135         struct lustre_capa_key   oti_capa_key;
136         struct lustre_capa       oti_capa;
137
138         struct ost_id            oti_ostid;
139
140         char                     oti_buf[64];
141
142         /** osd iterator context used for iterator session */
143         union {
144                 struct osd_zap_it       oti_it_zap;
145                 struct osd_it_quota     oti_it_quota;
146         };
147
148         char                     oti_str[64];
149         char                     oti_key[MAXNAMELEN + 1];
150         struct lustre_mdt_attrs oti_mdt_attrs;
151
152         struct lu_attr           oti_la;
153         struct osa_attr          oti_osa;
154         zap_attribute_t          oti_za;
155         dmu_object_info_t        oti_doi;
156         struct luz_direntry      oti_zde;
157
158         struct lquota_id_info    oti_qi;
159 };
160
161 extern struct lu_context_key osd_key;
162
163 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
164 {
165         return lu_context_key_get(&env->le_ctx, &osd_key);
166 }
167
168 struct osd_thandle {
169         struct thandle           ot_super;
170         cfs_list_t               ot_dcb_list;
171         cfs_list_t               ot_sa_list;
172         cfs_semaphore_t          ot_sa_lock;
173         dmu_tx_t                *ot_tx;
174         struct lquota_trans      ot_quota_trans;
175         __u32                    ot_write_commit:1,
176                                  ot_assigned:1;
177 };
178
179 #define OSD_OI_NAME_SIZE        16
180
181 /*
182  * Object Index (OI) instance.
183  */
184 struct osd_oi {
185         char                    oi_name[OSD_OI_NAME_SIZE]; /* unused */
186         uint64_t                oi_zapid;
187 };
188
189 #define OSD_OST_MAP_SIZE        32
190
191 /*
192  * osd device.
193  */
194 struct osd_device {
195         /* super-class */
196         struct dt_device         od_dt_dev;
197         /* information about underlying file system */
198         udmu_objset_t            od_objset;
199
200         /*
201          * Fid Capability
202          */
203         unsigned int             od_fl_capa:1;
204         unsigned long            od_capa_timeout;
205         __u32                    od_capa_alg;
206         struct lustre_capa_key  *od_capa_keys;
207         cfs_hlist_head_t        *od_capa_hash;
208
209         cfs_proc_dir_entry_t    *od_proc_entry;
210         struct lprocfs_stats    *od_stats;
211
212         uint64_t                 od_root;
213         struct osd_oi           **od_oi_table;
214         unsigned int             od_oi_count;
215         uint64_t                 od_ost_compat_dirs[OSD_OST_MAP_SIZE];
216         uint64_t                 od_ost_compat_grp0;
217
218         unsigned int             od_rdonly:1,
219                                  od_xattr_in_sa:1,
220                                  od_quota_iused_est:1;
221         char                     od_mntdev[128];
222         char                     od_svname[128];
223
224         int                      od_connects;
225         struct lu_site           od_site;
226
227         /* object IDs of the inode accounting indexes */
228         uint64_t                 od_iusr_oid;
229         uint64_t                 od_igrp_oid;
230
231         /* quota slave instance */
232         struct qsd_instance     *od_quota_slave;
233
234         /* used to debug zerocopy logic: the fields track all
235          * allocated, loaned and referenced buffers in use.
236          * to be removed once the change is tested well. */
237         cfs_atomic_t             od_zerocopy_alloc;
238         cfs_atomic_t             od_zerocopy_loan;
239         cfs_atomic_t             od_zerocopy_pin;
240
241         arc_prune_t             *arc_prune_cb;
242 };
243
244 struct osd_object {
245         struct dt_object         oo_dt;
246         /*
247          * Inode for file system object represented by this osd_object. This
248          * inode is pinned for the whole duration of lu_object life.
249          *
250          * Not modified concurrently (either setup early during object
251          * creation, or assigned by osd_object_create() under write lock).
252          */
253         dmu_buf_t               *oo_db;
254         sa_handle_t             *oo_sa_hdl;
255         nvlist_t                *oo_sa_xattr;
256         cfs_list_t               oo_sa_linkage;
257
258         cfs_rw_semaphore_t       oo_sem;
259
260         /* cached attributes */
261         cfs_rwlock_t             oo_attr_lock;
262         struct lu_attr           oo_attr;
263
264         /* protects extended attributes */
265         cfs_semaphore_t          oo_guard;
266         uint64_t                 oo_xattr;
267
268         /* record size for index file */
269         int                      oo_recsize;
270 };
271
272 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *);
273 extern const struct dt_index_operations osd_acct_index_ops;
274 uint64_t osd_quota_fid2dmu(const struct lu_fid *fid);
275 extern struct lu_device_operations  osd_lu_ops;
276 int osd_declare_quota(const struct lu_env *env, struct osd_device *osd,
277                       qid_t uid, qid_t gid, long long space,
278                       struct osd_thandle *oh, bool is_blk, int *flags,
279                       bool force);
280
281 /*
282  * Helpers.
283  */
284 static inline int lu_device_is_osd(const struct lu_device *d)
285 {
286         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
287 }
288
289 static inline struct osd_object *osd_obj(const struct lu_object *o)
290 {
291         LASSERT(lu_device_is_osd(o->lo_dev));
292         return container_of0(o, struct osd_object, oo_dt.do_lu);
293 }
294
295 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
296 {
297         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
298         return container_of0(d, struct osd_device, od_dt_dev);
299 }
300
301 static inline struct osd_device *osd_dev(const struct lu_device *d)
302 {
303         LASSERT(lu_device_is_osd(d));
304         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
305 }
306
307 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
308 {
309         return osd_obj(&d->do_lu);
310 }
311
312 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
313 {
314         return osd_dev(o->oo_dt.do_lu.lo_dev);
315 }
316
317 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
318 {
319         return &osd->od_dt_dev.dd_lu_dev;
320 }
321
322 static inline struct objset * osd_dtobj2objset(struct dt_object *o)
323 {
324         return osd_dev(o->do_lu.lo_dev)->od_objset.os;
325 }
326
327 static inline int osd_invariant(const struct osd_object *obj)
328 {
329         return 1;
330 }
331
332 static inline int osd_object_invariant(const struct lu_object *l)
333 {
334         return osd_invariant(osd_obj(l));
335 }
336
337
338 #ifdef LPROCFS
339 enum {
340         LPROC_OSD_READ_BYTES = 0,
341         LPROC_OSD_WRITE_BYTES = 1,
342         LPROC_OSD_GET_PAGE = 2,
343         LPROC_OSD_NO_PAGE = 3,
344         LPROC_OSD_CACHE_ACCESS = 4,
345         LPROC_OSD_CACHE_HIT = 5,
346         LPROC_OSD_CACHE_MISS = 6,
347         LPROC_OSD_COPY_IO = 7,
348         LPROC_OSD_ZEROCOPY_IO = 8,
349         LPROC_OSD_TAIL_IO = 9,
350         LPROC_OSD_LAST,
351 };
352
353 /* osd_lproc.c */
354 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
355 extern struct lprocfs_vars lprocfs_osd_module_vars[];
356
357 int osd_procfs_init(struct osd_device *osd, const char *name);
358 int osd_procfs_fini(struct osd_device *osd);
359
360 int udmu_zap_cursor_retrieve_key(const struct lu_env *env,
361                                  zap_cursor_t *zc, char *key, int max);
362 int udmu_zap_cursor_retrieve_value(const struct lu_env *env,
363                                    zap_cursor_t *zc,  char *buf,
364                                    int buf_size, int *bytes_read);
365
366 /* osd_object.c */
367 void osd_object_sa_dirty_rele(struct osd_thandle *oh);
368 int __osd_obj2dbuf(const struct lu_env *env, objset_t *os,
369                    uint64_t oid, dmu_buf_t **dbp, void *tag);
370 struct lu_object *osd_object_alloc(const struct lu_env *env,
371                                    const struct lu_object_header *hdr,
372                                    struct lu_device *d);
373 int osd_object_sa_update(struct osd_object *obj, sa_attr_type_t type,
374                          void *buf, uint32_t buflen, struct osd_thandle *oh);
375 int __osd_zap_create(const struct lu_env *env, udmu_objset_t *uos,
376                      dmu_buf_t **zap_dbp, dmu_tx_t *tx,
377                      struct lu_attr *la, void *tag, zap_flags_t flags);
378 int __osd_object_create(const struct lu_env *env, udmu_objset_t *uos,
379                         dmu_buf_t **dbp, dmu_tx_t *tx,
380                         struct lu_attr *la, void *tag);
381 int __osd_object_free(udmu_objset_t *uos, uint64_t oid, dmu_tx_t *tx);
382
383 /* osd_oi.c */
384 int osd_oi_init(const struct lu_env *env, struct osd_device *o);
385 void osd_oi_fini(const struct lu_env *env, struct osd_device *o);
386 int osd_fid_lookup(const struct lu_env *env,
387                    struct osd_device *, const struct lu_fid *, uint64_t *);
388 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
389                             const struct lu_fid *fid, char *buf);
390 int osd_options_init(void);
391
392 /* osd_index.c */
393 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
394                   const struct dt_index_features *feat);
395
396
397 /* osd_xattr.c */
398 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
399                   struct lu_buf *buf, const char *name,
400                   struct lustre_capa *capa);
401 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
402                           const struct lu_buf *buf, const char *name,
403                           int fl, struct thandle *handle);
404 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
405                   const struct lu_buf *buf, const char *name, int fl,
406                   struct thandle *handle, struct lustre_capa *capa);
407 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
408                           const char *name, struct thandle *handle);
409 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
410                   const char *name, struct thandle *handle,
411                   struct lustre_capa *capa);
412 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
413                    struct lu_buf *lb, struct lustre_capa *capa);
414 void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
415                         int vallen, const char *name, struct osd_thandle *oh);
416 int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
417                        const struct lu_buf *buf, const char *name, int fl,
418                        struct osd_thandle *oh);;
419 int __osd_xattr_set(const struct lu_env *env, struct osd_object *obj,
420                     const struct lu_buf *buf, const char *name, int fl,
421                     struct osd_thandle *oh);
422 static inline int
423 osd_xattr_set_internal(const struct lu_env *env, struct osd_object *obj,
424                        const struct lu_buf *buf, const char *name, int fl,
425                        struct osd_thandle *oh, struct lustre_capa *capa)
426 {
427         int rc;
428
429         if (osd_obj2dev(obj)->od_xattr_in_sa) {
430                 rc = __osd_sa_xattr_set(env, obj, buf, name, fl, oh);
431                 if (rc == -EFBIG)
432                         rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
433         } else {
434                 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
435         }
436
437         return rc;
438 }
439
440 #endif
441 #endif /* _OSD_INTERNAL_H */