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
63 #include <sys/nvpair.h>
65 #include <sys/zfs_znode.h>
68 #define LUSTRE_ROOT_FID_SEQ 0
69 #define DMU_OSD_SVNAME "svname"
70 #define DMU_OSD_OI_NAME_BASE "oi"
72 #define OSD_GFP_IO (GFP_NOFS | __GFP_HIGHMEM)
75 * Iterator's in-memory data structure for quota file.
78 struct osd_object *oiq_obj;
79 /* DMU accounting object id */
83 /** identifier for current quota record */
85 unsigned oiq_reset:1; /* 1 -- no need to advance */
89 * Iterator's in-memory data structure for ZAPs
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
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
104 * 3 - real records */
107 char ozi_name[NAME_MAX + 1]; /* file name for dir */
108 __u64 ozi_key; /* binary key for index files */
111 #define DT_IT2DT(it) (&((struct osd_zap_it *)it)->ozi_obj->oo_dt)
114 * regular ZFS direntry
116 struct zpl_direntry {
117 uint64_t zde_dnode:48,
120 } __attribute__((packed));
123 * lustre direntry adds a fid to regular ZFS direntry
125 struct luz_direntry {
126 struct zpl_direntry lzd_reg;
127 struct lu_fid lzd_fid;
128 } __attribute__((packed));
131 /* cached SA attributes */
145 struct osd_thread_info {
146 const struct lu_env *oti_env;
148 struct lu_fid oti_fid;
150 * XXX temporary: for ->i_op calls.
152 struct timespec oti_time;
154 * XXX temporary: for capa operations.
156 struct lustre_capa_key oti_capa_key;
157 struct lustre_capa oti_capa;
159 struct ost_id oti_ostid;
163 /** osd iterator context used for iterator session */
165 struct osd_zap_it oti_it_zap;
166 struct osd_it_quota oti_it_quota;
170 char oti_key[MAXNAMELEN + 1];
171 struct lustre_mdt_attrs oti_mdt_attrs;
173 struct lu_attr oti_la;
174 struct osa_attr oti_osa;
175 zap_attribute_t oti_za;
176 dmu_object_info_t oti_doi;
177 struct luz_direntry oti_zde;
179 struct lquota_id_info oti_qi;
180 struct lu_seq_range oti_seq_range;
183 extern struct lu_context_key osd_key;
185 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
187 return lu_context_key_get(&env->le_ctx, &osd_key);
191 struct thandle ot_super;
192 cfs_list_t ot_dcb_list;
193 cfs_list_t ot_sa_list;
194 struct semaphore ot_sa_lock;
196 struct lquota_trans ot_quota_trans;
197 __u32 ot_write_commit:1,
201 #define OSD_OI_NAME_SIZE 16
204 * Object Index (OI) instance.
207 char oi_name[OSD_OI_NAME_SIZE]; /* unused */
212 uint64_t *os_compat_dirs;
213 int os_subdir_count; /* subdir count for each seq */
214 obd_seq os_seq; /* seq number */
215 cfs_list_t os_seq_list; /* list to seq_list */
218 struct osd_seq_list {
219 rwlock_t osl_seq_list_lock; /* lock for seq_list */
220 cfs_list_t osl_seq_list; /* list head for seq */
221 struct semaphore osl_seq_init_sem;
224 #define OSD_OST_MAP_SIZE 32
231 struct dt_device od_dt_dev;
232 /* information about underlying file system */
233 udmu_objset_t od_objset;
238 unsigned int od_fl_capa:1;
239 unsigned long od_capa_timeout;
241 struct lustre_capa_key *od_capa_keys;
242 cfs_hlist_head_t *od_capa_hash;
244 cfs_proc_dir_entry_t *od_proc_entry;
245 struct lprocfs_stats *od_stats;
249 struct osd_oi **od_oi_table;
250 unsigned int od_oi_count;
251 struct osd_seq_list od_seq_list;
253 unsigned int od_rdonly:1,
255 od_quota_iused_est:1,
262 struct lu_site od_site;
264 /* object IDs of the inode accounting indexes */
265 uint64_t od_iusr_oid;
266 uint64_t od_igrp_oid;
268 /* quota slave instance */
269 struct qsd_instance *od_quota_slave;
271 /* used to debug zerocopy logic: the fields track all
272 * allocated, loaned and referenced buffers in use.
273 * to be removed once the change is tested well. */
274 cfs_atomic_t od_zerocopy_alloc;
275 cfs_atomic_t od_zerocopy_loan;
276 cfs_atomic_t od_zerocopy_pin;
278 arc_prune_t *arc_prune_cb;
282 struct dt_object oo_dt;
284 * Inode for file system object represented by this osd_object. This
285 * inode is pinned for the whole duration of lu_object life.
287 * Not modified concurrently (either setup early during object
288 * creation, or assigned by osd_object_create() under write lock).
291 sa_handle_t *oo_sa_hdl;
292 nvlist_t *oo_sa_xattr;
293 cfs_list_t oo_sa_linkage;
295 struct rw_semaphore oo_sem;
297 /* cached attributes */
298 rwlock_t oo_attr_lock;
299 struct lu_attr oo_attr;
301 /* protects extended attributes */
302 struct semaphore oo_guard;
305 /* record size for index file */
309 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *);
310 extern const struct dt_index_operations osd_acct_index_ops;
311 uint64_t osd_quota_fid2dmu(const struct lu_fid *fid);
312 extern struct lu_device_operations osd_lu_ops;
313 int osd_declare_quota(const struct lu_env *env, struct osd_device *osd,
314 qid_t uid, qid_t gid, long long space,
315 struct osd_thandle *oh, bool is_blk, int *flags,
321 static inline int lu_device_is_osd(const struct lu_device *d)
323 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
326 static inline struct osd_object *osd_obj(const struct lu_object *o)
328 LASSERT(lu_device_is_osd(o->lo_dev));
329 return container_of0(o, struct osd_object, oo_dt.do_lu);
332 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
334 LASSERT(lu_device_is_osd(&d->dd_lu_dev));
335 return container_of0(d, struct osd_device, od_dt_dev);
338 static inline struct osd_device *osd_dev(const struct lu_device *d)
340 LASSERT(lu_device_is_osd(d));
341 return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
344 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
346 return osd_obj(&d->do_lu);
349 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
351 return osd_dev(o->oo_dt.do_lu.lo_dev);
354 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
356 return &osd->od_dt_dev.dd_lu_dev;
359 static inline struct objset * osd_dtobj2objset(struct dt_object *o)
361 return osd_dev(o->do_lu.lo_dev)->od_objset.os;
364 static inline int osd_invariant(const struct osd_object *obj)
369 static inline int osd_object_invariant(const struct lu_object *l)
371 return osd_invariant(osd_obj(l));
374 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
376 return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
379 static inline char *osd_name(struct osd_device *osd)
381 return osd->od_dt_dev.dd_lu_dev.ld_obd->obd_name;
386 LPROC_OSD_READ_BYTES = 0,
387 LPROC_OSD_WRITE_BYTES = 1,
388 LPROC_OSD_GET_PAGE = 2,
389 LPROC_OSD_NO_PAGE = 3,
390 LPROC_OSD_CACHE_ACCESS = 4,
391 LPROC_OSD_CACHE_HIT = 5,
392 LPROC_OSD_CACHE_MISS = 6,
393 LPROC_OSD_COPY_IO = 7,
394 LPROC_OSD_ZEROCOPY_IO = 8,
395 LPROC_OSD_TAIL_IO = 9,
400 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
401 extern struct lprocfs_vars lprocfs_osd_module_vars[];
403 int osd_procfs_init(struct osd_device *osd, const char *name);
404 int osd_procfs_fini(struct osd_device *osd);
406 int udmu_zap_cursor_retrieve_key(const struct lu_env *env,
407 zap_cursor_t *zc, char *key, int max);
408 int udmu_zap_cursor_retrieve_value(const struct lu_env *env,
409 zap_cursor_t *zc, char *buf,
410 int buf_size, int *bytes_read);
413 void osd_object_sa_dirty_rele(struct osd_thandle *oh);
414 int __osd_obj2dbuf(const struct lu_env *env, objset_t *os,
415 uint64_t oid, dmu_buf_t **dbp, void *tag);
416 struct lu_object *osd_object_alloc(const struct lu_env *env,
417 const struct lu_object_header *hdr,
418 struct lu_device *d);
419 int osd_object_sa_update(struct osd_object *obj, sa_attr_type_t type,
420 void *buf, uint32_t buflen, struct osd_thandle *oh);
421 int __osd_zap_create(const struct lu_env *env, udmu_objset_t *uos,
422 dmu_buf_t **zap_dbp, dmu_tx_t *tx, struct lu_attr *la,
423 uint64_t parent, void *tag, zap_flags_t flags);
424 int __osd_object_create(const struct lu_env *env, udmu_objset_t *uos,
425 dmu_buf_t **dbp, dmu_tx_t *tx, struct lu_attr *la,
426 uint64_t parent, void *tag);
427 int __osd_object_free(udmu_objset_t *uos, uint64_t oid, dmu_tx_t *tx);
430 int osd_oi_init(const struct lu_env *env, struct osd_device *o);
431 void osd_oi_fini(const struct lu_env *env, struct osd_device *o);
432 int osd_fid_lookup(const struct lu_env *env,
433 struct osd_device *, const struct lu_fid *, uint64_t *);
434 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
435 const struct lu_fid *fid, char *buf);
436 int osd_options_init(void);
437 int osd_convert_root_to_new_seq(const struct lu_env *env,
438 struct osd_device *o);
439 int osd_ost_seq_exists(const struct lu_env *env, struct osd_device *osd,
442 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
443 const struct dt_index_features *feat);
444 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
445 obd_seq seq, struct lu_seq_range *range);
448 int __osd_xattr_load(udmu_objset_t *uos, uint64_t dnode, nvlist_t **sa_xattr);
449 int __osd_xattr_get_large(const struct lu_env *env, udmu_objset_t *uos,
450 uint64_t xattr, struct lu_buf *buf,
451 const char *name, int *sizep);
452 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
453 struct lu_buf *buf, const char *name,
454 struct lustre_capa *capa);
455 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
456 const struct lu_buf *buf, const char *name,
457 int fl, struct thandle *handle);
458 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
459 const struct lu_buf *buf, const char *name, int fl,
460 struct thandle *handle, struct lustre_capa *capa);
461 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
462 const char *name, struct thandle *handle);
463 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
464 const char *name, struct thandle *handle,
465 struct lustre_capa *capa);
466 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
467 struct lu_buf *lb, struct lustre_capa *capa);
468 void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
469 int vallen, const char *name, struct osd_thandle *oh);
470 int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
471 const struct lu_buf *buf, const char *name, int fl,
472 struct osd_thandle *oh);;
473 int __osd_xattr_set(const struct lu_env *env, struct osd_object *obj,
474 const struct lu_buf *buf, const char *name, int fl,
475 struct osd_thandle *oh);
477 osd_xattr_set_internal(const struct lu_env *env, struct osd_object *obj,
478 const struct lu_buf *buf, const char *name, int fl,
479 struct osd_thandle *oh, struct lustre_capa *capa)
483 if (osd_obj2dev(obj)->od_xattr_in_sa) {
484 rc = __osd_sa_xattr_set(env, obj, buf, name, fl, oh);
486 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
488 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
494 static inline uint64_t attrs_fs2zfs(const uint32_t flags)
496 return (((flags & FS_APPEND_FL) ? ZFS_APPENDONLY : 0) |
497 ((flags & FS_NODUMP_FL) ? ZFS_NODUMP : 0) |
498 ((flags & FS_IMMUTABLE_FL) ? ZFS_IMMUTABLE : 0));
501 static inline uint32_t attrs_zfs2fs(const uint64_t flags)
503 return (((flags & ZFS_APPENDONLY) ? FS_APPEND_FL : 0) |
504 ((flags & ZFS_NODUMP) ? FS_NODUMP_FL : 0) |
505 ((flags & ZFS_IMMUTABLE) ? FS_IMMUTABLE_FL : 0));
509 #endif /* _OSD_INTERNAL_H */