UIO: Documentation
[pv_ops_mirror.git] / fs / ocfs2 / inode.h
bloba41d0817121b21ed35e73def7ec91a5e603b7dec
1 /* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
4 * inode.h
6 * Function prototypes
8 * Copyright (C) 2002, 2004 Oracle. All rights reserved.
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public
21 * License along with this program; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 021110-1307, USA.
26 #ifndef OCFS2_INODE_H
27 #define OCFS2_INODE_H
29 #include "extent_map.h"
31 /* OCFS2 Inode Private Data */
32 struct ocfs2_inode_info
34 u64 ip_blkno;
36 struct ocfs2_lock_res ip_rw_lockres;
37 struct ocfs2_lock_res ip_meta_lockres;
38 struct ocfs2_lock_res ip_data_lockres;
39 struct ocfs2_lock_res ip_open_lockres;
41 /* protects allocation changes on this inode. */
42 struct rw_semaphore ip_alloc_sem;
44 /* These fields are protected by ip_lock */
45 spinlock_t ip_lock;
46 u32 ip_open_count;
47 u32 ip_clusters;
48 struct list_head ip_io_markers;
50 struct mutex ip_io_mutex;
52 u32 ip_flags; /* see below */
53 u32 ip_attr; /* inode attributes */
55 /* protected by recovery_lock. */
56 struct inode *ip_next_orphan;
58 u32 ip_dir_start_lookup;
60 /* next two are protected by trans_inc_lock */
61 /* which transaction were we created on? Zero if none. */
62 unsigned long ip_created_trans;
63 /* last transaction we were a part of. */
64 unsigned long ip_last_trans;
66 struct ocfs2_caching_info ip_metadata_cache;
68 struct ocfs2_extent_map ip_extent_map;
70 struct inode vfs_inode;
74 * Flags for the ip_flags field
76 /* System file inodes */
77 #define OCFS2_INODE_SYSTEM_FILE 0x00000001
78 #define OCFS2_INODE_JOURNAL 0x00000002
79 #define OCFS2_INODE_BITMAP 0x00000004
80 /* This inode has been wiped from disk */
81 #define OCFS2_INODE_DELETED 0x00000008
82 /* Another node is deleting, so our delete is a nop */
83 #define OCFS2_INODE_SKIP_DELETE 0x00000010
84 /* Has the inode been orphaned on another node?
86 * This hints to ocfs2_drop_inode that it should clear i_nlink before
87 * continuing.
89 * We *only* set this on unlink vote from another node. If the inode
90 * was locally orphaned, then we're sure of the state and don't need
91 * to twiddle i_nlink later - it's either zero or not depending on
92 * whether our unlink succeeded. Otherwise we got this from a node
93 * whose intention was to orphan the inode, however he may have
94 * crashed, failed etc, so we let ocfs2_drop_inode zero the value and
95 * rely on ocfs2_delete_inode to sort things out under the proper
96 * cluster locks.
98 #define OCFS2_INODE_MAYBE_ORPHANED 0x00000020
99 /* Does someone have the file open O_DIRECT */
100 #define OCFS2_INODE_OPEN_DIRECT 0x00000040
101 /* Indicates that the metadata cache should be used as an array. */
102 #define OCFS2_INODE_CACHE_INLINE 0x00000080
104 static inline struct ocfs2_inode_info *OCFS2_I(struct inode *inode)
106 return container_of(inode, struct ocfs2_inode_info, vfs_inode);
109 #define INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags & OCFS2_INODE_JOURNAL)
110 #define SET_INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags |= OCFS2_INODE_JOURNAL)
112 extern struct kmem_cache *ocfs2_inode_cache;
114 extern const struct address_space_operations ocfs2_aops;
116 struct buffer_head *ocfs2_bread(struct inode *inode, int block,
117 int *err, int reada);
118 void ocfs2_clear_inode(struct inode *inode);
119 void ocfs2_delete_inode(struct inode *inode);
120 void ocfs2_drop_inode(struct inode *inode);
122 /* Flags for ocfs2_iget() */
123 #define OCFS2_FI_FLAG_SYSFILE 0x4
124 #define OCFS2_FI_FLAG_ORPHAN_RECOVERY 0x8
125 struct inode *ocfs2_iget(struct ocfs2_super *osb, u64 feoff, int flags);
126 int ocfs2_inode_init_private(struct inode *inode);
127 int ocfs2_inode_revalidate(struct dentry *dentry);
128 int ocfs2_populate_inode(struct inode *inode, struct ocfs2_dinode *fe,
129 int create_ino);
130 void ocfs2_read_inode(struct inode *inode);
131 void ocfs2_read_inode2(struct inode *inode, void *opaque);
132 ssize_t ocfs2_rw_direct(int rw, struct file *filp, char *buf,
133 size_t size, loff_t *offp);
134 void ocfs2_sync_blockdev(struct super_block *sb);
135 void ocfs2_refresh_inode(struct inode *inode,
136 struct ocfs2_dinode *fe);
137 int ocfs2_mark_inode_dirty(handle_t *handle,
138 struct inode *inode,
139 struct buffer_head *bh);
140 int ocfs2_aio_read(struct file *file, struct kiocb *req, struct iocb *iocb);
141 int ocfs2_aio_write(struct file *file, struct kiocb *req, struct iocb *iocb);
143 void ocfs2_set_inode_flags(struct inode *inode);
144 void ocfs2_get_inode_flags(struct ocfs2_inode_info *oi);
146 static inline blkcnt_t ocfs2_inode_sector_count(struct inode *inode)
148 int c_to_s_bits = OCFS2_SB(inode->i_sb)->s_clustersize_bits - 9;
150 return (blkcnt_t)(OCFS2_I(inode)->ip_clusters << c_to_s_bits);
153 #endif /* OCFS2_INODE_H */