4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
31 * Copyright (c) 2012, 2013, Intel Corporation.
32 * Use is subject to license terms.
35 * This file is part of Lustre, http://www.lustre.org/
36 * Lustre is a trademark of Sun Microsystems, Inc.
38 * lustre/osd-zfs/osd_internal.h
39 * Shared definitions and declarations for zfs/dmu osd
41 * Author: Alex Zhuravlev <bzzz@whamcloud.com>
42 * Author: Mike Pershin <tappro@whamcloud.com>
43 * Author: Johann Lombardi <johann@whamcloud.com>
46 #ifndef _OSD_INTERNAL_H
47 #define _OSD_INTERNAL_H
49 #include <dt_object.h>
50 #include <md_object.h>
51 #include <lustre_quota.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))
58 #define KM_SLEEP GFP_KERNEL
62 #include <sys/nvpair.h>
63 #include <sys/zfs_znode.h>
66 #define LUSTRE_ROOT_FID_SEQ 0
67 #define DMU_OSD_SVNAME "svname"
68 #define DMU_OSD_OI_NAME_BASE "oi"
70 #define OSD_GFP_IO (GFP_NOFS | __GFP_HIGHMEM)
72 /* Statfs space reservation for grant, fragmentation, and unlink space. */
73 #define OSD_STATFS_RESERVED_BLKS (1ULL << (22 - SPA_MAXBLOCKSHIFT)) /* 4MB */
74 #define OSD_STATFS_RESERVED_SHIFT (7) /* reserve 0.78% of all space */
76 /* Statfs {minimum, safe estimate, and maximum} dnodes per block */
77 #define OSD_DNODE_MIN_BLKSHIFT (SPA_MAXBLOCKSHIFT - DNODE_SHIFT) /* 17-9 =8 */
78 #define OSD_DNODE_EST_BLKSHIFT (SPA_MAXBLOCKSHIFT - 12) /* 17-12=5 */
79 #define OSD_DNODE_EST_COUNT 1024
81 #define OSD_GRANT_FOR_LOCAL_OIDS (2ULL << 20) /* 2MB for last_rcvd, ... */
84 * Iterator's in-memory data structure for quota file.
87 struct osd_object *oiq_obj;
88 /* DMU accounting object id */
92 /** identifier for current quota record */
94 unsigned oiq_reset:1; /* 1 -- no need to advance */
98 * Iterator's in-memory data structure for ZAPs
100 * ZFS does not store . and .. on a disk, instead they are
101 * generated up on request
102 * to follow this format we do the same
105 zap_cursor_t *ozi_zc;
106 struct osd_object *ozi_obj;
107 struct lustre_capa *ozi_capa;
108 unsigned ozi_reset:1; /* 1 -- no need to advance */
109 /* ozi_pos - position of the cursor:
110 * 0 - before any record
113 * 3 - real records */
116 char ozi_name[MAXNAMELEN]; /* file name for dir */
117 __u64 ozi_key; /* binary key for index files */
120 #define DT_IT2DT(it) (&((struct osd_zap_it *)it)->ozi_obj->oo_dt)
123 * regular ZFS direntry
125 struct zpl_direntry {
126 uint64_t zde_dnode:48,
129 } __attribute__((packed));
132 * lustre direntry adds a fid to regular ZFS direntry
134 struct luz_direntry {
135 struct zpl_direntry lzd_reg;
136 struct lu_fid lzd_fid;
137 } __attribute__((packed));
140 /* cached SA attributes */
154 struct osd_thread_info {
155 const struct lu_env *oti_env;
157 struct lu_fid oti_fid;
159 * XXX temporary: for ->i_op calls.
161 struct timespec oti_time;
163 * XXX temporary: for capa operations.
165 struct lustre_capa_key oti_capa_key;
166 struct lustre_capa oti_capa;
168 struct ost_id oti_ostid;
172 /** osd iterator context used for iterator session */
174 struct osd_zap_it oti_it_zap;
175 struct osd_it_quota oti_it_quota;
180 char oti_key[MAXNAMELEN + 1];
181 __u64 oti_key64[(MAXNAMELEN + 1)/sizeof(__u64)];
183 struct lustre_mdt_attrs oti_mdt_attrs;
185 struct lu_attr oti_la;
186 struct osa_attr oti_osa;
187 zap_attribute_t oti_za;
188 dmu_object_info_t oti_doi;
189 struct luz_direntry oti_zde;
191 struct lquota_id_info oti_qi;
192 struct lu_seq_range oti_seq_range;
193 unsigned int oti_it_inline:1;
196 extern struct lu_context_key osd_key;
198 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
200 return lu_context_key_get(&env->le_ctx, &osd_key);
204 struct thandle ot_super;
205 struct list_head ot_dcb_list;
206 struct list_head ot_sa_list;
207 struct semaphore ot_sa_lock;
209 struct lquota_trans ot_quota_trans;
210 __u32 ot_write_commit:1,
214 #define OSD_OI_NAME_SIZE 16
217 * Object Index (OI) instance.
220 char oi_name[OSD_OI_NAME_SIZE]; /* unused */
225 uint64_t *os_compat_dirs;
226 int os_subdir_count; /* subdir count for each seq */
227 obd_seq os_seq; /* seq number */
228 struct list_head os_seq_list; /* list to seq_list */
231 struct osd_seq_list {
232 rwlock_t osl_seq_list_lock; /* lock for seq_list */
233 struct list_head osl_seq_list; /* list head for seq */
234 struct semaphore osl_seq_init_sem;
237 #define OSD_OST_MAP_SIZE 32
244 struct dt_device od_dt_dev;
245 /* information about underlying file system */
246 struct objset *od_os;
247 uint64_t od_rootid; /* id of root znode */
248 /* SA attr mapping->id,
249 * name is the same as in ZFS to use defines SA_ZPL_...*/
250 sa_attr_type_t *z_attr_table;
255 unsigned int od_fl_capa:1;
256 unsigned long od_capa_timeout;
258 struct lustre_capa_key *od_capa_keys;
259 struct hlist_head *od_capa_hash;
261 struct proc_dir_entry *od_proc_entry;
262 struct lprocfs_stats *od_stats;
266 struct osd_oi **od_oi_table;
267 unsigned int od_oi_count;
268 struct osd_seq_list od_seq_list;
270 unsigned int od_rdonly:1,
272 od_quota_iused_est:1,
280 struct lu_site od_site;
282 /* object IDs of the inode accounting indexes */
283 uint64_t od_iusr_oid;
284 uint64_t od_igrp_oid;
286 /* quota slave instance */
287 struct qsd_instance *od_quota_slave;
289 /* used to debug zerocopy logic: the fields track all
290 * allocated, loaned and referenced buffers in use.
291 * to be removed once the change is tested well. */
292 atomic_t od_zerocopy_alloc;
293 atomic_t od_zerocopy_loan;
294 atomic_t od_zerocopy_pin;
296 arc_prune_t *arc_prune_cb;
298 /* osd seq instance */
299 struct lu_client_seq *od_cl_seq;
303 struct dt_object oo_dt;
305 * Inode for file system object represented by this osd_object. This
306 * inode is pinned for the whole duration of lu_object life.
308 * Not modified concurrently (either setup early during object
309 * creation, or assigned by osd_object_create() under write lock).
312 sa_handle_t *oo_sa_hdl;
313 nvlist_t *oo_sa_xattr;
314 struct list_head oo_sa_linkage;
316 struct rw_semaphore oo_sem;
318 /* cached attributes */
319 rwlock_t oo_attr_lock;
320 struct lu_attr oo_attr;
322 /* protects extended attributes */
323 struct semaphore oo_guard;
326 /* record size for index file */
327 unsigned char oo_keysize;
328 unsigned char oo_recsize;
329 unsigned char oo_recusize; /* unit size */
332 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *);
333 extern const struct dt_index_operations osd_acct_index_ops;
334 uint64_t osd_quota_fid2dmu(const struct lu_fid *fid);
335 extern struct lu_device_operations osd_lu_ops;
336 extern struct dt_index_operations osd_dir_ops;
337 int osd_declare_quota(const struct lu_env *env, struct osd_device *osd,
338 qid_t uid, qid_t gid, long long space,
339 struct osd_thandle *oh, bool is_blk, int *flags,
341 uint64_t osd_objs_count_estimate(uint64_t refdbytes, uint64_t usedobjs,
347 static inline int lu_device_is_osd(const struct lu_device *d)
349 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
352 static inline struct osd_object *osd_obj(const struct lu_object *o)
354 LASSERT(lu_device_is_osd(o->lo_dev));
355 return container_of0(o, struct osd_object, oo_dt.do_lu);
358 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
360 LASSERT(lu_device_is_osd(&d->dd_lu_dev));
361 return container_of0(d, struct osd_device, od_dt_dev);
364 static inline struct osd_device *osd_dev(const struct lu_device *d)
366 LASSERT(lu_device_is_osd(d));
367 return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
370 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
372 return osd_obj(&d->do_lu);
375 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
377 return osd_dev(o->oo_dt.do_lu.lo_dev);
380 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
382 return &osd->od_dt_dev.dd_lu_dev;
385 static inline struct objset * osd_dtobj2objset(struct dt_object *o)
387 return osd_dev(o->do_lu.lo_dev)->od_os;
390 static inline int osd_invariant(const struct osd_object *obj)
395 static inline int osd_object_invariant(const struct lu_object *l)
397 return osd_invariant(osd_obj(l));
400 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
402 return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
405 static inline char *osd_name(struct osd_device *osd)
407 return osd->od_dt_dev.dd_lu_dev.ld_obd->obd_name;
412 LPROC_OSD_READ_BYTES = 0,
413 LPROC_OSD_WRITE_BYTES = 1,
414 LPROC_OSD_GET_PAGE = 2,
415 LPROC_OSD_NO_PAGE = 3,
416 LPROC_OSD_CACHE_ACCESS = 4,
417 LPROC_OSD_CACHE_HIT = 5,
418 LPROC_OSD_CACHE_MISS = 6,
419 LPROC_OSD_COPY_IO = 7,
420 LPROC_OSD_ZEROCOPY_IO = 8,
421 LPROC_OSD_TAIL_IO = 9,
426 extern struct lprocfs_seq_vars lprocfs_osd_obd_vars[];
428 int osd_procfs_init(struct osd_device *osd, const char *name);
429 int osd_procfs_fini(struct osd_device *osd);
432 extern char *osd_obj_tag;
433 void osd_object_sa_dirty_rele(struct osd_thandle *oh);
434 int __osd_obj2dbuf(const struct lu_env *env, objset_t *os,
435 uint64_t oid, dmu_buf_t **dbp);
436 struct lu_object *osd_object_alloc(const struct lu_env *env,
437 const struct lu_object_header *hdr,
438 struct lu_device *d);
439 int osd_object_sa_update(struct osd_object *obj, sa_attr_type_t type,
440 void *buf, uint32_t buflen, struct osd_thandle *oh);
441 int __osd_zap_create(const struct lu_env *env, struct osd_device *osd,
442 dmu_buf_t **zap_dbp, dmu_tx_t *tx, struct lu_attr *la,
443 uint64_t parent, zap_flags_t flags);
444 int __osd_object_create(const struct lu_env *env, struct osd_device *osd,
445 dmu_buf_t **dbp, dmu_tx_t *tx, struct lu_attr *la,
449 int osd_oi_init(const struct lu_env *env, struct osd_device *o);
450 void osd_oi_fini(const struct lu_env *env, struct osd_device *o);
451 int osd_fid_lookup(const struct lu_env *env,
452 struct osd_device *, const struct lu_fid *, uint64_t *);
453 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
454 const struct lu_fid *fid, char *buf);
455 int osd_options_init(void);
456 int osd_convert_root_to_new_seq(const struct lu_env *env,
457 struct osd_device *o);
458 int osd_ost_seq_exists(const struct lu_env *env, struct osd_device *osd,
461 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
462 const struct dt_index_features *feat);
463 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
464 obd_seq seq, struct lu_seq_range *range);
465 void osd_zap_cursor_init_serialized(zap_cursor_t *zc, struct objset *os,
466 uint64_t id, uint64_t dirhash);
467 int osd_zap_cursor_init(zap_cursor_t **zc, struct objset *os,
468 uint64_t id, uint64_t dirhash);
469 void osd_zap_cursor_fini(zap_cursor_t *zc);
470 uint64_t osd_zap_cursor_serialize(zap_cursor_t *zc);
473 int __osd_xattr_load(struct osd_device *osd, uint64_t dnode,
474 nvlist_t **sa_xattr);
475 int __osd_xattr_get_large(const struct lu_env *env, struct osd_device *osd,
476 uint64_t xattr, struct lu_buf *buf,
477 const char *name, int *sizep);
478 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
479 struct lu_buf *buf, const char *name,
480 struct lustre_capa *capa);
481 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
482 const struct lu_buf *buf, const char *name,
483 int fl, struct thandle *handle);
484 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
485 const struct lu_buf *buf, const char *name, int fl,
486 struct thandle *handle, struct lustre_capa *capa);
487 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
488 const char *name, struct thandle *handle);
489 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
490 const char *name, struct thandle *handle,
491 struct lustre_capa *capa);
492 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
493 struct lu_buf *lb, struct lustre_capa *capa);
494 void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
495 int vallen, const char *name, struct osd_thandle *oh);
496 int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
497 const struct lu_buf *buf, const char *name, int fl,
498 struct osd_thandle *oh);;
499 int __osd_xattr_set(const struct lu_env *env, struct osd_object *obj,
500 const struct lu_buf *buf, const char *name, int fl,
501 struct osd_thandle *oh);
503 osd_xattr_set_internal(const struct lu_env *env, struct osd_object *obj,
504 const struct lu_buf *buf, const char *name, int fl,
505 struct osd_thandle *oh, struct lustre_capa *capa)
509 if (osd_obj2dev(obj)->od_xattr_in_sa) {
510 rc = __osd_sa_xattr_set(env, obj, buf, name, fl, oh);
512 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
514 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
520 static inline uint64_t attrs_fs2zfs(const uint32_t flags)
522 return (((flags & FS_APPEND_FL) ? ZFS_APPENDONLY : 0) |
523 ((flags & FS_NODUMP_FL) ? ZFS_NODUMP : 0) |
524 ((flags & FS_IMMUTABLE_FL) ? ZFS_IMMUTABLE : 0));
527 static inline uint32_t attrs_zfs2fs(const uint64_t flags)
529 return (((flags & ZFS_APPENDONLY) ? FS_APPEND_FL : 0) |
530 ((flags & ZFS_NODUMP) ? FS_NODUMP_FL : 0) |
531 ((flags & ZFS_IMMUTABLE) ? FS_IMMUTABLE_FL : 0));
536 #ifndef HAVE_DSL_POOL_CONFIG
537 static inline void dsl_pool_config_enter(dsl_pool_t *dp, char *name)
541 static inline void dsl_pool_config_exit(dsl_pool_t *dp, char *name)
547 #endif /* _OSD_INTERNAL_H */