Whamcloud - gitweb
LU-911 osd: zerocopy methods in ldiskfs osd
[fs/lustre-release.git] / lustre / osd-ldiskfs / osd_internal.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30  * Use is subject to license terms.
31  *
32  * Copyright (c) 2011, 2012, Whamcloud, Inc.
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/osd_internal.h
39  *
40  * Shared definitions and declarations for osd module
41  *
42  * Author: Nikita Danilov <nikita@clusterfs.com>
43  */
44
45 #ifndef _OSD_INTERNAL_H
46 #define _OSD_INTERNAL_H
47
48 #if defined(__KERNEL__)
49
50 /* struct rw_semaphore */
51 #include <linux/rwsem.h>
52 /* struct dentry */
53 #include <linux/dcache.h>
54 /* struct dirent64 */
55 #include <linux/dirent.h>
56
57 #include <ldiskfs/ldiskfs.h>
58 #include <ldiskfs/ldiskfs_jbd2.h>
59 #ifdef HAVE_LDISKFS_JOURNAL_CALLBACK_ADD
60 # define journal_callback ldiskfs_journal_cb_entry
61 # define osd_journal_callback_set(handle, func, jcb) \
62          ldiskfs_journal_callback_add(handle, func, jcb)
63 #else
64 # define osd_journal_callback_set(handle, func, jcb) \
65          jbd2_journal_callback_set(handle, func, jcb)
66 #endif
67
68 /* fsfilt_{get|put}_ops */
69 #include <lustre_fsfilt.h>
70
71 /* LUSTRE_OSD_NAME */
72 #include <obd.h>
73 /* class_register_type(), class_unregister_type(), class_get_type() */
74 #include <obd_class.h>
75 #include <lustre_disk.h>
76 #include <dt_object.h>
77
78 #include "osd_oi.h"
79 #include "osd_iam.h"
80
81 struct inode;
82
83 #define OSD_OII_NOGEN (0)
84 #define OSD_COUNTERS (0)
85
86 /** Enable thandle usage statistics */
87 #define OSD_THANDLE_STATS (0)
88
89 #ifdef HAVE_QUOTA_SUPPORT
90 struct osd_ctxt {
91         __u32 oc_uid;
92         __u32 oc_gid;
93         cfs_kernel_cap_t oc_cap;
94 };
95 #endif
96
97 struct osd_directory {
98         struct iam_container od_container;
99         struct iam_descr     od_descr;
100 };
101
102 struct osd_object {
103         struct dt_object        oo_dt;
104         /**
105          * Inode for file system object represented by this osd_object. This
106          * inode is pinned for the whole duration of lu_object life.
107          *
108          * Not modified concurrently (either setup early during object
109          * creation, or assigned by osd_object_create() under write lock).
110          */
111         struct inode           *oo_inode;
112         /**
113          * to protect index ops.
114          */
115         struct htree_lock_head *oo_hl_head;
116         cfs_rw_semaphore_t      oo_ext_idx_sem;
117         cfs_rw_semaphore_t      oo_sem;
118         struct osd_directory   *oo_dir;
119         /** protects inode attributes. */
120         cfs_spinlock_t          oo_guard;
121         /**
122          * Following two members are used to indicate the presence of dot and
123          * dotdot in the given directory. This is required for interop mode
124          * (b11826).
125          */
126         int                     oo_compat_dot_created;
127         int                     oo_compat_dotdot_created;
128
129         const struct lu_env    *oo_owner;
130 #ifdef CONFIG_LOCKDEP
131         struct lockdep_map      oo_dep_map;
132 #endif
133 };
134
135 #ifdef HAVE_LDISKFS_PDO
136
137 #define osd_ldiskfs_find_entry(dir, dentry, de, lock)   \
138         ll_ldiskfs_find_entry(dir, dentry, de, lock)
139 #define osd_ldiskfs_add_entry(handle, child, cinode, hlock) \
140         ldiskfs_add_entry(handle, child, cinode, hlock)
141
142 #else /* HAVE_LDISKFS_PDO */
143
144 struct htree_lock {
145         int     dummy;
146 };
147
148 struct htree_lock_head {
149         int     dummy;
150 };
151
152 #define ldiskfs_htree_lock(lock, head, inode, op)  do { LBUG(); } while (0)
153 #define ldiskfs_htree_unlock(lock)                 do { LBUG(); } while (0)
154
155 static inline struct htree_lock_head *ldiskfs_htree_lock_head_alloc(int dep)
156 {
157         LBUG();
158         return NULL;
159 }
160
161 #define ldiskfs_htree_lock_head_free(lh)           do { LBUG(); } while (0)
162
163 #define LDISKFS_DUMMY_HTREE_LOCK        0xbabecafe
164
165 static inline struct htree_lock *ldiskfs_htree_lock_alloc(void)
166 {
167         return (struct htree_lock *)LDISKFS_DUMMY_HTREE_LOCK;
168 }
169
170 static inline void ldiskfs_htree_lock_free(struct htree_lock *lk)
171 {
172         LASSERT((unsigned long)lk == LDISKFS_DUMMY_HTREE_LOCK);
173 }
174
175 #define HTREE_HBITS_DEF         0
176
177 #define osd_ldiskfs_find_entry(dir, dentry, de, lock)   \
178         ll_ldiskfs_find_entry(dir, dentry, de)
179 #define osd_ldiskfs_add_entry(handle, child, cinode, lock) \
180         ldiskfs_add_entry(handle, child, cinode)
181
182 #endif /* HAVE_LDISKFS_PDO */
183
184 extern const int osd_dto_credits_noquota[];
185
186 /*
187  * osd device.
188  */
189 struct osd_device {
190         /* super-class */
191         struct dt_device          od_dt_dev;
192         /* information about underlying file system */
193         struct lustre_mount_info *od_mount;
194         /*
195          * XXX temporary stuff for object index: directory where every object
196          * is named by its fid.
197          */
198         struct dt_object         *od_obj_area;
199         /* object index */
200         struct osd_oi            *od_oi_table;
201         /* total number of OI containers */
202         int                       od_oi_count;
203         /*
204          * Fid Capability
205          */
206         unsigned int              od_fl_capa:1;
207         unsigned long             od_capa_timeout;
208         __u32                     od_capa_alg;
209         struct lustre_capa_key   *od_capa_keys;
210         cfs_hlist_head_t         *od_capa_hash;
211
212         cfs_proc_dir_entry_t     *od_proc_entry;
213         struct lprocfs_stats     *od_stats;
214         /*
215          * statfs optimization: we cache a bit.
216          */
217         cfs_time_t                od_osfs_age;
218         cfs_kstatfs_t             od_kstatfs;
219         cfs_spinlock_t            od_osfs_lock;
220
221         /**
222          * The following flag indicates, if it is interop mode or not.
223          * It will be initialized, using mount param.
224          */
225         __u32                     od_iop_mode;
226
227         struct fsfilt_operations *od_fsops;
228
229         unsigned long long        od_readcache_max_filesize;
230         int                       od_read_cache;
231         int                       od_writethrough_cache;
232
233         struct brw_stats          od_brw_stats;
234         cfs_atomic_t              od_r_in_flight;
235         cfs_atomic_t              od_w_in_flight;
236 };
237
238 #define OSD_TRACK_DECLARES
239 #ifdef OSD_TRACK_DECLARES
240 #define OSD_DECLARE_OP(oh, op)   {                               \
241         LASSERT(oh->ot_handle == NULL);                          \
242         ((oh)->ot_declare_ ##op)++; }
243 #define OSD_EXEC_OP(handle, op)     {                            \
244         struct osd_thandle *oh;                                  \
245         oh = container_of0(handle, struct osd_thandle, ot_super);\
246         LASSERT((oh)->ot_declare_ ##op > 0);                     \
247         ((oh)->ot_declare_ ##op)--; }
248 #else
249 #define OSD_DECLARE_OP(oh, op)
250 #define OSD_EXEC_OP(oh, op)
251 #endif
252
253 /* There are at most 10 uid/gids are affected in a transaction, and
254  * that's rename case:
255  * - 2 for source parent uid & gid;
256  * - 2 for source child uid & gid ('..' entry update when the child
257  *   is directory);
258  * - 2 for target parent uid & gid;
259  * - 2 for target child uid & gid (if the target child exists);
260  * - 2 for root uid & gid (last_rcvd, llog, etc);
261  *
262  * The 0 to (OSD_MAX_UGID_CNT - 1) bits of ot_id_type is for indicating
263  * the id type of each id in the ot_id_array.
264  */
265 #define OSD_MAX_UGID_CNT        10
266
267 struct osd_thandle {
268         struct thandle          ot_super;
269         handle_t               *ot_handle;
270         struct journal_callback ot_jcb;
271         cfs_list_t              ot_dcb_list;
272         /* Link to the device, for debugging. */
273         struct lu_ref_link     *ot_dev_link;
274         unsigned short          ot_credits;
275         unsigned short          ot_id_cnt;
276         unsigned short          ot_id_type;
277         uid_t                   ot_id_array[OSD_MAX_UGID_CNT];
278
279 #ifdef OSD_TRACK_DECLARES
280         unsigned char           ot_declare_attr_set;
281         unsigned char           ot_declare_punch;
282         unsigned char           ot_declare_xattr_set;
283         unsigned char           ot_declare_create;
284         unsigned char           ot_declare_destroy;
285         unsigned char           ot_declare_ref_add;
286         unsigned char           ot_declare_ref_del;
287         unsigned char           ot_declare_write;
288         unsigned char           ot_declare_insert;
289         unsigned char           ot_declare_delete;
290 #endif
291
292 #if OSD_THANDLE_STATS
293         /** time when this handle was allocated */
294         cfs_time_t oth_alloced;
295
296         /** time when this thanle was started */
297         cfs_time_t oth_started;
298 #endif
299 };
300
301 /**
302  * Basic transaction credit op
303  */
304 enum dt_txn_op {
305         DTO_INDEX_INSERT,
306         DTO_INDEX_DELETE,
307         DTO_INDEX_UPDATE,
308         DTO_OBJECT_CREATE,
309         DTO_OBJECT_DELETE,
310         DTO_ATTR_SET_BASE,
311         DTO_XATTR_SET,
312         DTO_LOG_REC, /**< XXX temporary: dt layer knows nothing about llog. */
313         DTO_WRITE_BASE,
314         DTO_WRITE_BLOCK,
315         DTO_ATTR_SET_CHOWN,
316
317         DTO_NR
318 };
319
320 /*
321  * osd dev stats
322  */
323
324 #ifdef LPROCFS
325 enum {
326         LPROC_OSD_READ_BYTES    = 0,
327         LPROC_OSD_WRITE_BYTES   = 1,
328         LPROC_OSD_GET_PAGE      = 2,
329         LPROC_OSD_NO_PAGE       = 3,
330         LPROC_OSD_CACHE_ACCESS  = 4,
331         LPROC_OSD_CACHE_HIT     = 5,
332         LPROC_OSD_CACHE_MISS    = 6,
333
334 #if OSD_THANDLE_STATS
335         LPROC_OSD_THANDLE_STARTING,
336         LPROC_OSD_THANDLE_OPEN,
337         LPROC_OSD_THANDLE_CLOSING,
338 #endif
339         LPROC_OSD_LAST,
340 };
341 #endif
342
343 /**
344  * Storage representation for fids.
345  *
346  * Variable size, first byte contains the length of the whole record.
347  */
348 struct osd_fid_pack {
349         unsigned char fp_len;
350         char fp_area[sizeof(struct lu_fid)];
351 };
352
353 struct osd_it_ea_dirent {
354         struct lu_fid   oied_fid;
355         __u64           oied_ino;
356         __u64           oied_off;
357         unsigned short  oied_namelen;
358         unsigned int    oied_type;
359         char            oied_name[0];
360 } __attribute__((packed));
361
362 /**
363  * as osd_it_ea_dirent (in memory dirent struct for osd) is greater
364  * than lu_dirent struct. osd readdir reads less number of dirent than
365  * required for mdd dir page. so buffer size need to be increased so that
366  * there  would be one ext3 readdir for every mdd readdir page.
367  */
368
369 #define OSD_IT_EA_BUFSIZE       (CFS_PAGE_SIZE + CFS_PAGE_SIZE/4)
370
371 /**
372  * This is iterator's in-memory data structure in interoperability
373  * mode (i.e. iterator over ldiskfs style directory)
374  */
375 struct osd_it_ea {
376         struct osd_object   *oie_obj;
377         /** used in ldiskfs iterator, to stored file pointer */
378         struct file          oie_file;
379         /** how many entries have been read-cached from storage */
380         int                  oie_rd_dirent;
381         /** current entry is being iterated by caller */
382         int                  oie_it_dirent;
383         /** current processing entry */
384         struct osd_it_ea_dirent *oie_dirent;
385         /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
386         void                *oie_buf;
387 };
388
389 /**
390  * Iterator's in-memory data structure for IAM mode.
391  */
392 struct osd_it_iam {
393         struct osd_object     *oi_obj;
394         struct iam_path_descr *oi_ipd;
395         struct iam_iterator    oi_it;
396 };
397
398 #define MAX_BLOCKS_PER_PAGE (CFS_PAGE_SIZE / 512)
399
400 struct osd_iobuf {
401         cfs_waitq_t        dr_wait;
402         cfs_atomic_t       dr_numreqs;  /* number of reqs being processed */
403         int                dr_max_pages;
404         int                dr_npages;
405         int                dr_error;
406         int                dr_frags;
407         unsigned int       dr_ignore_quota:1;
408         unsigned int       dr_elapsed_valid:1; /* we really did count time */
409         unsigned int       dr_rw:1;
410         struct page       *dr_pages[PTLRPC_MAX_BRW_PAGES];
411         unsigned long      dr_blocks[PTLRPC_MAX_BRW_PAGES*MAX_BLOCKS_PER_PAGE];
412         unsigned long      dr_start_time;
413         unsigned long      dr_elapsed;  /* how long io took */
414         struct osd_device *dr_dev;
415 };
416
417 struct osd_thread_info {
418         const struct lu_env   *oti_env;
419         /**
420          * used for index operations.
421          */
422         struct dentry          oti_obj_dentry;
423         struct dentry          oti_child_dentry;
424
425         /** dentry for Iterator context. */
426         struct dentry          oti_it_dentry;
427         struct htree_lock     *oti_hlock;
428
429         struct lu_fid          oti_fid;
430         struct osd_inode_id    oti_id;
431         /*
432          * XXX temporary: for ->i_op calls.
433          */
434         struct timespec        oti_time;
435         /*
436          * XXX temporary: fake struct file for osd_object_sync
437          */
438         struct file            oti_file;
439         /*
440          * XXX temporary: for capa operations.
441          */
442         struct lustre_capa_key oti_capa_key;
443         struct lustre_capa     oti_capa;
444
445         /** osd_device reference, initialized in osd_trans_start() and
446             used in osd_trans_stop() */
447         struct osd_device     *oti_dev;
448
449         /**
450          * following ipd and it structures are used for osd_index_iam_lookup()
451          * these are defined separately as we might do index operation
452          * in open iterator session.
453          */
454
455         /** osd iterator context used for iterator session */
456
457         union {
458                 struct osd_it_iam      oti_it;
459                 /** ldiskfs iterator data structure, see osd_it_ea_{init, fini} */
460                 struct osd_it_ea       oti_it_ea;
461         };
462
463         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
464         void                  *oti_it_ea_buf;
465
466         /** IAM iterator for index operation. */
467         struct iam_iterator    oti_idx_it;
468
469         /** union to guarantee that ->oti_ipd[] has proper alignment. */
470         union {
471                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
472                 long long      oti_alignment_lieutenant;
473         };
474
475         union {
476                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
477                 long long      oti_alignment_lieutenant_colonel;
478         };
479
480
481         int                    oti_r_locks;
482         int                    oti_w_locks;
483         int                    oti_txns;
484         /** used in osd_fid_set() to put xattr */
485         struct lu_buf          oti_buf;
486         /** used in osd_ea_fid_set() to set fid into common ea */
487         struct lustre_mdt_attrs oti_mdt_attrs;
488         /** 0-copy IO */
489         struct osd_iobuf       oti_iobuf;
490         struct inode           oti_inode;
491         int                    oti_created[PTLRPC_MAX_BRW_PAGES];
492 #ifdef HAVE_QUOTA_SUPPORT
493         struct osd_ctxt        oti_ctxt;
494 #endif
495         struct lu_env          oti_obj_delete_tx_env;
496 #define OSD_FID_REC_SZ 32
497         char                   oti_ldp[OSD_FID_REC_SZ];
498         char                   oti_ldp2[OSD_FID_REC_SZ];
499 };
500
501 extern int ldiskfs_pdo;
502
503 #ifdef LPROCFS
504 /* osd_lproc.c */
505 void lprocfs_osd_init_vars(struct lprocfs_static_vars *lvars);
506 int osd_procfs_init(struct osd_device *osd, const char *name);
507 int osd_procfs_fini(struct osd_device *osd);
508 void osd_lprocfs_time_start(const struct lu_env *env);
509 void osd_lprocfs_time_end(const struct lu_env *env,
510                           struct osd_device *osd, int op);
511 void osd_brw_stats_update(struct osd_device *osd, struct osd_iobuf *iobuf);
512
513 #endif
514 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
515                cfs_kstatfs_t *sfs);
516 int osd_object_auth(const struct lu_env *env, struct dt_object *dt,
517                     struct lustre_capa *capa, __u64 opc);
518 void osd_declare_qid(struct dt_object *dt, struct osd_thandle *oh,
519                      int type, uid_t id, struct inode *inode);
520 int generic_error_remove_page(struct address_space *mapping,
521                                      struct page *page);
522
523 /*
524  * Invariants, assertions.
525  */
526
527 /*
528  * XXX: do not enable this, until invariant checking code is made thread safe
529  * in the face of pdirops locking.
530  */
531 #define OSD_INVARIANT_CHECKS (0)
532
533 #if OSD_INVARIANT_CHECKS
534 static inline int osd_invariant(const struct osd_object *obj)
535 {
536         return
537                 obj != NULL &&
538                 ergo(obj->oo_inode != NULL,
539                      obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
540                      atomic_read(&obj->oo_inode->i_count) > 0) &&
541                 ergo(obj->oo_dir != NULL &&
542                      obj->oo_dir->od_conationer.ic_object != NULL,
543                      obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
544 }
545 #else
546 #define osd_invariant(obj) (1)
547 #endif
548
549 /* The on-disk extN format reserves inodes 0-11 for internal filesystem
550  * use, and these inodes will be invisible on client side, so the valid
551  * sequence for IGIF fid is 12-0xffffffff. But root inode (2#) will be seen
552  * on server side (osd), and it should be valid too here.
553  */
554 #define OSD_ROOT_SEQ            2
555 static inline int osd_fid_is_root(const struct lu_fid *fid)
556 {
557         return fid_seq(fid) == OSD_ROOT_SEQ;
558 }
559
560 static inline int osd_fid_is_igif(const struct lu_fid *fid)
561 {
562         return fid_is_igif(fid) || osd_fid_is_root(fid);
563 }
564
565 static inline struct osd_oi *
566 osd_fid2oi(struct osd_device *osd, const struct lu_fid *fid)
567 {
568         if (!fid_is_norm(fid))
569                 return NULL;
570
571         LASSERT(osd->od_oi_table != NULL && osd->od_oi_count >= 1);
572         /* It can work even od_oi_count equals to 1 although it's unexpected,
573          * the only reason we set it to 1 is for performance measurement */
574         return &osd->od_oi_table[fid->f_seq & (osd->od_oi_count - 1)];
575 }
576
577 /*
578  * Helpers.
579  */
580 extern const struct lu_device_operations  osd_lu_ops;
581
582 static inline int lu_device_is_osd(const struct lu_device *d)
583 {
584         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
585 }
586
587 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
588 {
589         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
590         return container_of0(d, struct osd_device, od_dt_dev);
591 }
592
593 static inline struct osd_device *osd_dev(const struct lu_device *d)
594 {
595         LASSERT(lu_device_is_osd(d));
596         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
597 }
598
599 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
600 {
601         return osd_dev(o->oo_dt.do_lu.lo_dev);
602 }
603
604 static inline struct super_block *osd_sb(const struct osd_device *dev)
605 {
606         return dev->od_mount->lmi_mnt->mnt_sb;
607 }
608
609 static inline int osd_object_is_root(const struct osd_object *obj)
610 {
611         return osd_sb(osd_obj2dev(obj))->s_root->d_inode == obj->oo_inode;
612 }
613
614 static inline struct osd_object *osd_obj(const struct lu_object *o)
615 {
616         LASSERT(lu_device_is_osd(o->lo_dev));
617         return container_of0(o, struct osd_object, oo_dt.do_lu);
618 }
619
620 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
621 {
622         return osd_obj(&d->do_lu);
623 }
624
625 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
626 {
627         return &osd->od_dt_dev.dd_lu_dev;
628 }
629
630 static inline journal_t *osd_journal(const struct osd_device *dev)
631 {
632         return LDISKFS_SB(osd_sb(dev))->s_journal;
633 }
634
635 extern const struct dt_body_operations osd_body_ops;
636 extern struct lu_context_key osd_key;
637
638 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
639 {
640         return lu_context_key_get(&env->le_ctx, &osd_key);
641 }
642
643 extern const struct dt_body_operations osd_body_ops_new;
644
645 #endif /* __KERNEL__ */
646 #endif /* _OSD_INTERNAL_H */