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) 2011, 2012 Whamcloud, Inc.
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>
53 #include <sys/nvpair.h>
57 #define LUSTRE_ROOT_FID_SEQ 0
58 #define DMU_OSD_SVNAME "svname"
59 #define DMU_OSD_OI_NAME_BASE "oi"
61 #define OSD_GFP_IO (GFP_NOFS | __GFP_HIGHMEM)
64 * Iterator's in-memory data structure for quota file.
67 struct osd_object *oiq_obj;
68 /* DMU accounting object id */
72 /** identifier for current quota record */
74 unsigned oiq_reset:1; /* 1 -- no need to advance */
78 * Iterator's in-memory data structure for ZAPs
82 struct osd_object *ozi_obj;
83 struct lustre_capa *ozi_capa;
84 unsigned ozi_reset:1; /* 1 -- no need to advance */
86 char ozi_name[NAME_MAX + 1]; /* file name for dir */
87 __u64 ozi_key; /* binary key for index files */
90 #define DT_IT2DT(it) (&((struct osd_zap_it *)it)->ozi_obj->oo_dt)
93 * regular ZFS direntry
96 uint64_t zde_dnode:48,
99 } __attribute__((packed));
102 * lustre direntry adds a fid to regular ZFS direntry
104 struct luz_direntry {
105 struct zpl_direntry lzd_reg;
106 struct lu_fid lzd_fid;
107 } __attribute__((packed));
110 /* cached SA attributes */
124 struct osd_thread_info {
125 const struct lu_env *oti_env;
127 struct lu_fid oti_fid;
129 * XXX temporary: for ->i_op calls.
131 struct timespec oti_time;
133 * XXX temporary: for capa operations.
135 struct lustre_capa_key oti_capa_key;
136 struct lustre_capa oti_capa;
138 struct ost_id oti_ostid;
142 /** osd iterator context used for iterator session */
144 struct osd_zap_it oti_it_zap;
145 struct osd_it_quota oti_it_quota;
149 char oti_key[MAXNAMELEN + 1];
151 struct lu_attr oti_la;
152 struct osa_attr oti_osa;
153 zap_attribute_t oti_za;
154 dmu_object_info_t oti_doi;
155 struct luz_direntry oti_zde;
157 struct lquota_id_info oti_qi;
160 extern struct lu_context_key osd_key;
162 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
164 return lu_context_key_get(&env->le_ctx, &osd_key);
168 struct thandle ot_super;
169 cfs_list_t ot_dcb_list;
170 cfs_list_t ot_sa_list;
171 cfs_semaphore_t ot_sa_lock;
173 struct lquota_trans ot_quota_trans;
174 __u32 ot_write_commit:1,
178 #define OSD_OI_NAME_SIZE 16
181 * Object Index (OI) instance.
184 char oi_name[OSD_OI_NAME_SIZE]; /* unused */
188 #define OSD_OST_MAP_SIZE 32
195 struct dt_device od_dt_dev;
196 /* information about underlying file system */
197 udmu_objset_t od_objset;
202 unsigned int od_fl_capa:1;
203 unsigned long od_capa_timeout;
205 struct lustre_capa_key *od_capa_keys;
206 cfs_hlist_head_t *od_capa_hash;
208 cfs_proc_dir_entry_t *od_proc_entry;
209 struct lprocfs_stats *od_stats;
212 struct osd_oi **od_oi_table;
213 unsigned int od_oi_count;
214 uint64_t od_ost_compat_dirs[OSD_OST_MAP_SIZE];
215 uint64_t od_ost_compat_grp0;
217 unsigned int od_rdonly:1,
218 od_quota_iused_est:1;
223 struct lu_site od_site;
225 /* object IDs of the inode accounting indexes */
226 uint64_t od_iusr_oid;
227 uint64_t od_igrp_oid;
229 /* quota slave instance */
230 struct qsd_instance *od_quota_slave;
232 /* used to debug zerocopy logic: the fields track all
233 * allocated, loaned and referenced buffers in use.
234 * to be removed once the change is tested well. */
235 cfs_atomic_t od_zerocopy_alloc;
236 cfs_atomic_t od_zerocopy_loan;
237 cfs_atomic_t od_zerocopy_pin;
239 arc_prune_t *arc_prune_cb;
243 struct dt_object oo_dt;
245 * Inode for file system object represented by this osd_object. This
246 * inode is pinned for the whole duration of lu_object life.
248 * Not modified concurrently (either setup early during object
249 * creation, or assigned by osd_object_create() under write lock).
252 sa_handle_t *oo_sa_hdl;
253 nvlist_t *oo_sa_xattr;
254 cfs_list_t oo_sa_linkage;
256 cfs_rw_semaphore_t oo_sem;
258 /* cached attributes */
259 cfs_rwlock_t oo_attr_lock;
260 struct lu_attr oo_attr;
262 /* protects extended attributes */
263 cfs_semaphore_t oo_guard;
266 /* record size for index file */
270 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *);
271 extern const struct dt_index_operations osd_acct_index_ops;
272 uint64_t osd_quota_fid2dmu(const struct lu_fid *fid);
273 extern struct lu_device_operations osd_lu_ops;
274 int osd_declare_quota(const struct lu_env *env, struct osd_device *osd,
275 qid_t uid, qid_t gid, long long space,
276 struct osd_thandle *oh, bool is_blk, int *flags,
282 static inline int lu_device_is_osd(const struct lu_device *d)
284 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
287 static inline struct osd_object *osd_obj(const struct lu_object *o)
289 LASSERT(lu_device_is_osd(o->lo_dev));
290 return container_of0(o, struct osd_object, oo_dt.do_lu);
293 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
295 LASSERT(lu_device_is_osd(&d->dd_lu_dev));
296 return container_of0(d, struct osd_device, od_dt_dev);
299 static inline struct osd_device *osd_dev(const struct lu_device *d)
301 LASSERT(lu_device_is_osd(d));
302 return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
305 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
307 return osd_obj(&d->do_lu);
310 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
312 return osd_dev(o->oo_dt.do_lu.lo_dev);
315 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
317 return &osd->od_dt_dev.dd_lu_dev;
320 static inline struct objset * osd_dtobj2objset(struct dt_object *o)
322 return osd_dev(o->do_lu.lo_dev)->od_objset.os;
325 static inline int osd_invariant(const struct osd_object *obj)
330 static inline int osd_object_invariant(const struct lu_object *l)
332 return osd_invariant(osd_obj(l));
338 LPROC_OSD_READ_BYTES = 0,
339 LPROC_OSD_WRITE_BYTES = 1,
340 LPROC_OSD_GET_PAGE = 2,
341 LPROC_OSD_NO_PAGE = 3,
342 LPROC_OSD_CACHE_ACCESS = 4,
343 LPROC_OSD_CACHE_HIT = 5,
344 LPROC_OSD_CACHE_MISS = 6,
345 LPROC_OSD_COPY_IO = 7,
346 LPROC_OSD_ZEROCOPY_IO = 8,
347 LPROC_OSD_TAIL_IO = 9,
352 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
353 extern struct lprocfs_vars lprocfs_osd_module_vars[];
355 int osd_procfs_init(struct osd_device *osd, const char *name);
356 int osd_procfs_fini(struct osd_device *osd);
358 int udmu_zap_cursor_retrieve_key(const struct lu_env *env,
359 zap_cursor_t *zc, char *key, int max);
360 int udmu_zap_cursor_retrieve_value(const struct lu_env *env,
361 zap_cursor_t *zc, char *buf,
362 int buf_size, int *bytes_read);
365 void osd_object_sa_dirty_rele(struct osd_thandle *oh);
366 int __osd_obj2dbuf(const struct lu_env *env, objset_t *os,
367 uint64_t oid, dmu_buf_t **dbp, void *tag);
368 struct lu_object *osd_object_alloc(const struct lu_env *env,
369 const struct lu_object_header *hdr,
370 struct lu_device *d);
371 int osd_object_sa_update(struct osd_object *obj, sa_attr_type_t type,
372 void *buf, uint32_t buflen, struct osd_thandle *oh);
373 int __osd_zap_create(const struct lu_env *env, udmu_objset_t *uos,
374 dmu_buf_t **zap_dbp, dmu_tx_t *tx,
375 struct lu_attr *la, void *tag, zap_flags_t flags);
376 int __osd_object_create(const struct lu_env *env, udmu_objset_t *uos,
377 dmu_buf_t **dbp, dmu_tx_t *tx,
378 struct lu_attr *la, void *tag);
379 int __osd_object_free(udmu_objset_t *uos, uint64_t oid, dmu_tx_t *tx);
382 int osd_oi_init(const struct lu_env *env, struct osd_device *o);
383 void osd_oi_fini(const struct lu_env *env, struct osd_device *o);
384 int osd_fid_lookup(const struct lu_env *env,
385 struct osd_device *, const struct lu_fid *, uint64_t *);
386 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
387 const struct lu_fid *fid, char *buf);
388 int osd_options_init(void);
391 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
392 const struct dt_index_features *feat);
396 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
397 struct lu_buf *buf, const char *name,
398 struct lustre_capa *capa);
399 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
400 const struct lu_buf *buf, const char *name,
401 int fl, struct thandle *handle);
402 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
403 const struct lu_buf *buf, const char *name, int fl,
404 struct thandle *handle, struct lustre_capa *capa);
405 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
406 const char *name, struct thandle *handle);
407 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
408 const char *name, struct thandle *handle,
409 struct lustre_capa *capa);
410 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
411 struct lu_buf *lb, struct lustre_capa *capa);
414 #endif /* _OSD_INTERNAL_H */