1/* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
3 *
4 * inode.h
5 *
6 * Function prototypes
7 *
8 * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
9 *
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.
14 *
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.
19 *
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.
24 */
25
26#ifndef OCFS2_INODE_H
27#define OCFS2_INODE_H
28
29#include "extent_map.h"
30
31/* OCFS2 Inode Private Data */
32struct ocfs2_inode_info
33{
34	u64			ip_blkno;
35
36	struct ocfs2_lock_res		ip_rw_lockres;
37	struct ocfs2_lock_res		ip_inode_lockres;
38	struct ocfs2_lock_res		ip_open_lockres;
39
40	/* protects allocation changes on this inode. */
41	struct rw_semaphore		ip_alloc_sem;
42
43	/* protects extended attribute changes on this inode */
44	struct rw_semaphore		ip_xattr_sem;
45
46	/* These fields are protected by ip_lock */
47	spinlock_t			ip_lock;
48	u32				ip_open_count;
49	u32				ip_clusters;
50	struct list_head		ip_io_markers;
51
52	struct mutex			ip_io_mutex;
53
54	u32				ip_flags; /* see below */
55	u32				ip_attr; /* inode attributes */
56	u16				ip_dyn_features;
57
58	/* protected by recovery_lock. */
59	struct inode			*ip_next_orphan;
60
61	u32				ip_dir_start_lookup;
62
63	struct ocfs2_caching_info	ip_metadata_cache;
64
65	struct ocfs2_extent_map		ip_extent_map;
66
67	struct inode			vfs_inode;
68	struct jbd2_inode		ip_jinode;
69
70	/* Only valid if the inode is the dir. */
71	u32				ip_last_used_slot;
72	u64				ip_last_used_group;
73
74	struct ocfs2_alloc_reservation	ip_la_data_resv;
75};
76
77/*
78 * Flags for the ip_flags field
79 */
80/* System file inodes  */
81#define OCFS2_INODE_SYSTEM_FILE		0x00000001
82#define OCFS2_INODE_JOURNAL		0x00000002
83#define OCFS2_INODE_BITMAP		0x00000004
84/* This inode has been wiped from disk */
85#define OCFS2_INODE_DELETED		0x00000008
86/* Another node is deleting, so our delete is a nop */
87#define OCFS2_INODE_SKIP_DELETE		0x00000010
88/* Has the inode been orphaned on another node?
89 *
90 * This hints to ocfs2_drop_inode that it should clear i_nlink before
91 * continuing.
92 *
93 * We *only* set this on unlink vote from another node. If the inode
94 * was locally orphaned, then we're sure of the state and don't need
95 * to twiddle i_nlink later - it's either zero or not depending on
96 * whether our unlink succeeded. Otherwise we got this from a node
97 * whose intention was to orphan the inode, however he may have
98 * crashed, failed etc, so we let ocfs2_drop_inode zero the value and
99 * rely on ocfs2_delete_inode to sort things out under the proper
100 * cluster locks.
101 */
102#define OCFS2_INODE_MAYBE_ORPHANED	0x00000020
103/* Does someone have the file open O_DIRECT */
104#define OCFS2_INODE_OPEN_DIRECT		0x00000040
105/* Tell the inode wipe code it's not in orphan dir */
106#define OCFS2_INODE_SKIP_ORPHAN_DIR     0x00000080
107
108static inline struct ocfs2_inode_info *OCFS2_I(struct inode *inode)
109{
110	return container_of(inode, struct ocfs2_inode_info, vfs_inode);
111}
112
113#define INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags & OCFS2_INODE_JOURNAL)
114#define SET_INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags |= OCFS2_INODE_JOURNAL)
115
116extern struct kmem_cache *ocfs2_inode_cache;
117
118extern const struct address_space_operations ocfs2_aops;
119extern const struct ocfs2_caching_operations ocfs2_inode_caching_ops;
120
121static inline struct ocfs2_caching_info *INODE_CACHE(struct inode *inode)
122{
123	return &OCFS2_I(inode)->ip_metadata_cache;
124}
125
126void ocfs2_evict_inode(struct inode *inode);
127int ocfs2_drop_inode(struct inode *inode);
128
129/* Flags for ocfs2_iget() */
130#define OCFS2_FI_FLAG_SYSFILE		0x1
131#define OCFS2_FI_FLAG_ORPHAN_RECOVERY	0x2
132struct inode *ocfs2_ilookup(struct super_block *sb, u64 feoff);
133struct inode *ocfs2_iget(struct ocfs2_super *osb, u64 feoff, unsigned flags,
134			 int sysfile_type);
135int ocfs2_inode_init_private(struct inode *inode);
136int ocfs2_inode_revalidate(struct dentry *dentry);
137void ocfs2_populate_inode(struct inode *inode, struct ocfs2_dinode *fe,
138			  int create_ino);
139void ocfs2_read_inode(struct inode *inode);
140void ocfs2_read_inode2(struct inode *inode, void *opaque);
141ssize_t ocfs2_rw_direct(int rw, struct file *filp, char *buf,
142			size_t size, loff_t *offp);
143void ocfs2_sync_blockdev(struct super_block *sb);
144void ocfs2_refresh_inode(struct inode *inode,
145			 struct ocfs2_dinode *fe);
146int ocfs2_mark_inode_dirty(handle_t *handle,
147			   struct inode *inode,
148			   struct buffer_head *bh);
149int ocfs2_aio_read(struct file *file, struct kiocb *req, struct iocb *iocb);
150int ocfs2_aio_write(struct file *file, struct kiocb *req, struct iocb *iocb);
151struct buffer_head *ocfs2_bread(struct inode *inode,
152				int block, int *err, int reada);
153
154void ocfs2_set_inode_flags(struct inode *inode);
155void ocfs2_get_inode_flags(struct ocfs2_inode_info *oi);
156
157static inline blkcnt_t ocfs2_inode_sector_count(struct inode *inode)
158{
159	int c_to_s_bits = OCFS2_SB(inode->i_sb)->s_clustersize_bits - 9;
160
161	return (blkcnt_t)(OCFS2_I(inode)->ip_clusters << c_to_s_bits);
162}
163
164/* Validate that a bh contains a valid inode */
165int ocfs2_validate_inode_block(struct super_block *sb,
166			       struct buffer_head *bh);
167/*
168 * Read an inode block into *bh.  If *bh is NULL, a bh will be allocated.
169 * This is a cached read.  The inode will be validated with
170 * ocfs2_validate_inode_block().
171 */
172int ocfs2_read_inode_block(struct inode *inode, struct buffer_head **bh);
173/* The same, but can be passed OCFS2_BH_* flags */
174int ocfs2_read_inode_block_full(struct inode *inode, struct buffer_head **bh,
175				int flags);
176
177static inline struct ocfs2_inode_info *cache_info_to_inode(struct ocfs2_caching_info *ci)
178{
179	return container_of(ci, struct ocfs2_inode_info, ip_metadata_cache);
180}
181
182#endif /* OCFS2_INODE_H */
183