blob: 68e8cf9bda973d0446d3dbc2c70f68603b95c8e8 [file] [log] [blame]
Mark Fashehccd979b2005-12-15 14:31:24 -08001/* -*- 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
Mark Fasheh83418972007-04-23 18:53:12 -070029#include "extent_map.h"
30
Mark Fashehccd979b2005-12-15 14:31:24 -080031/* OCFS2 Inode Private Data */
32struct ocfs2_inode_info
33{
34 u64 ip_blkno;
35
36 struct ocfs2_lock_res ip_rw_lockres;
Mark Fashehe63aecb62007-10-18 15:30:42 -070037 struct ocfs2_lock_res ip_inode_lockres;
Tiger Yang50008632007-03-20 16:01:38 -070038 struct ocfs2_lock_res ip_open_lockres;
Mark Fashehccd979b2005-12-15 14:31:24 -080039
40 /* protects allocation changes on this inode. */
41 struct rw_semaphore ip_alloc_sem;
42
Tiger Yangcf1d6c72008-08-18 17:11:00 +080043 /* protects extended attribute changes on this inode */
44 struct rw_semaphore ip_xattr_sem;
45
Mark Fasheha11f7e62011-06-22 14:23:38 -070046 /* Number of outstanding AIO's which are not page aligned */
Wengang Wangc18ceab2014-04-03 14:46:46 -070047 struct mutex ip_unaligned_aio;
Mark Fasheha11f7e62011-06-22 14:23:38 -070048
Mark Fashehccd979b2005-12-15 14:31:24 -080049 /* These fields are protected by ip_lock */
50 spinlock_t ip_lock;
51 u32 ip_open_count;
Mark Fashehccd979b2005-12-15 14:31:24 -080052 struct list_head ip_io_markers;
Goldwyn Rodrigues83fd9c72010-06-10 17:21:36 -050053 u32 ip_clusters;
Mark Fashehccd979b2005-12-15 14:31:24 -080054
Goldwyn Rodrigues83fd9c72010-06-10 17:21:36 -050055 u16 ip_dyn_features;
Mark Fasheh251b6ec2006-01-10 15:41:43 -080056 struct mutex ip_io_mutex;
Mark Fashehccd979b2005-12-15 14:31:24 -080057 u32 ip_flags; /* see below */
Herbert Poetzlca4d1472006-07-03 17:27:12 -070058 u32 ip_attr; /* inode attributes */
Mark Fashehccd979b2005-12-15 14:31:24 -080059
Ryan Ding4506cfb2016-03-25 14:21:06 -070060 /* Record unwritten extents during direct io. */
61 struct list_head ip_unwritten_list;
62
Mark Fashehccd979b2005-12-15 14:31:24 -080063 /* protected by recovery_lock. */
64 struct inode *ip_next_orphan;
65
Mark Fashehccd979b2005-12-15 14:31:24 -080066 struct ocfs2_caching_info ip_metadata_cache;
Mark Fasheh83418972007-04-23 18:53:12 -070067 struct ocfs2_extent_map ip_extent_map;
Mark Fashehccd979b2005-12-15 14:31:24 -080068 struct inode vfs_inode;
Joel Becker2b4e30f2008-09-03 20:03:41 -070069 struct jbd2_inode ip_jinode;
Tao Ma13821152009-02-25 00:53:23 +080070
Goldwyn Rodrigues83fd9c72010-06-10 17:21:36 -050071 u32 ip_dir_start_lookup;
72
Tao Ma13821152009-02-25 00:53:23 +080073 /* Only valid if the inode is the dir. */
74 u32 ip_last_used_slot;
75 u64 ip_last_used_group;
Goldwyn Rodrigues5e98d492010-06-28 10:04:32 -050076 u32 ip_dir_lock_gen;
Mark Fasheh4fe370a2009-12-07 13:15:40 -080077
78 struct ocfs2_alloc_reservation ip_la_data_resv;
Darrick J. Wong2931cdc2014-04-03 14:46:48 -070079
80 /*
81 * Transactions that contain inode's metadata needed to complete
82 * fsync and fdatasync, respectively.
83 */
84 tid_t i_sync_tid;
85 tid_t i_datasync_tid;
Jan Kara1c92ec62014-09-29 15:02:51 +020086
87 struct dquot *i_dquot[MAXQUOTAS];
Mark Fashehccd979b2005-12-15 14:31:24 -080088};
89
90/*
91 * Flags for the ip_flags field
92 */
93/* System file inodes */
94#define OCFS2_INODE_SYSTEM_FILE 0x00000001
95#define OCFS2_INODE_JOURNAL 0x00000002
96#define OCFS2_INODE_BITMAP 0x00000004
97/* This inode has been wiped from disk */
98#define OCFS2_INODE_DELETED 0x00000008
Mark Fashehccd979b2005-12-15 14:31:24 -080099/* Has the inode been orphaned on another node?
100 *
101 * This hints to ocfs2_drop_inode that it should clear i_nlink before
102 * continuing.
103 *
104 * We *only* set this on unlink vote from another node. If the inode
105 * was locally orphaned, then we're sure of the state and don't need
106 * to twiddle i_nlink later - it's either zero or not depending on
107 * whether our unlink succeeded. Otherwise we got this from a node
108 * whose intention was to orphan the inode, however he may have
109 * crashed, failed etc, so we let ocfs2_drop_inode zero the value and
110 * rely on ocfs2_delete_inode to sort things out under the proper
111 * cluster locks.
112 */
Jan Kara7bf619c2014-04-03 14:46:53 -0700113#define OCFS2_INODE_MAYBE_ORPHANED 0x00000010
Mark Fashehccd979b2005-12-15 14:31:24 -0800114/* Does someone have the file open O_DIRECT */
Jan Kara7bf619c2014-04-03 14:46:53 -0700115#define OCFS2_INODE_OPEN_DIRECT 0x00000020
Li Dongyangd4cd1872010-04-22 16:11:19 +0800116/* Tell the inode wipe code it's not in orphan dir */
Jan Kara7bf619c2014-04-03 14:46:53 -0700117#define OCFS2_INODE_SKIP_ORPHAN_DIR 0x00000040
Joseph Qi93d911f2015-11-05 18:44:04 -0800118/* Entry in orphan dir with 'dio-' prefix */
119#define OCFS2_INODE_DIO_ORPHAN_ENTRY 0x00000080
Mark Fashehccd979b2005-12-15 14:31:24 -0800120
121static inline struct ocfs2_inode_info *OCFS2_I(struct inode *inode)
122{
123 return container_of(inode, struct ocfs2_inode_info, vfs_inode);
124}
125
126#define INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags & OCFS2_INODE_JOURNAL)
127#define SET_INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags |= OCFS2_INODE_JOURNAL)
128
Christoph Lametere18b8902006-12-06 20:33:20 -0800129extern struct kmem_cache *ocfs2_inode_cache;
Mark Fashehccd979b2005-12-15 14:31:24 -0800130
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700131extern const struct address_space_operations ocfs2_aops;
Joel Becker6e5a3d72009-02-10 19:00:37 -0800132extern const struct ocfs2_caching_operations ocfs2_inode_caching_ops;
Mark Fashehccd979b2005-12-15 14:31:24 -0800133
Joel Becker8cb471e2009-02-10 20:00:41 -0800134static inline struct ocfs2_caching_info *INODE_CACHE(struct inode *inode)
135{
136 return &OCFS2_I(inode)->ip_metadata_cache;
137}
138
Al Viro066d92d2010-06-08 21:28:10 -0400139void ocfs2_evict_inode(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -0400140int ocfs2_drop_inode(struct inode *inode);
Mark Fasheh24c19ef2006-09-22 17:28:19 -0700141
142/* Flags for ocfs2_iget() */
Jan Kara5fa06132008-01-11 00:11:45 +0100143#define OCFS2_FI_FLAG_SYSFILE 0x1
144#define OCFS2_FI_FLAG_ORPHAN_RECOVERY 0x2
Gang Hea860f6e2016-03-22 14:24:24 -0700145#define OCFS2_FI_FLAG_FILECHECK_CHK 0x4
146#define OCFS2_FI_FLAG_FILECHECK_FIX 0x8
147
wengang wang6ca497a2009-03-06 21:29:10 +0800148struct inode *ocfs2_ilookup(struct super_block *sb, u64 feoff);
Jan Kara5fa06132008-01-11 00:11:45 +0100149struct inode *ocfs2_iget(struct ocfs2_super *osb, u64 feoff, unsigned flags,
150 int sysfile_type);
Mark Fashehccd979b2005-12-15 14:31:24 -0800151int ocfs2_inode_init_private(struct inode *inode);
152int ocfs2_inode_revalidate(struct dentry *dentry);
Joel Beckerb657c952008-11-13 14:49:11 -0800153void ocfs2_populate_inode(struct inode *inode, struct ocfs2_dinode *fe,
154 int create_ino);
Mark Fashehccd979b2005-12-15 14:31:24 -0800155void ocfs2_read_inode(struct inode *inode);
156void ocfs2_read_inode2(struct inode *inode, void *opaque);
157ssize_t ocfs2_rw_direct(int rw, struct file *filp, char *buf,
158 size_t size, loff_t *offp);
159void ocfs2_sync_blockdev(struct super_block *sb);
160void ocfs2_refresh_inode(struct inode *inode,
161 struct ocfs2_dinode *fe);
Mark Fasheh1fabe142006-10-09 18:11:45 -0700162int ocfs2_mark_inode_dirty(handle_t *handle,
Mark Fashehccd979b2005-12-15 14:31:24 -0800163 struct inode *inode,
164 struct buffer_head *bh);
Jan Kara9e33d692008-08-25 19:56:50 +0200165struct buffer_head *ocfs2_bread(struct inode *inode,
166 int block, int *err, int reada);
Mark Fashehccd979b2005-12-15 14:31:24 -0800167
Herbert Poetzlca4d1472006-07-03 17:27:12 -0700168void ocfs2_set_inode_flags(struct inode *inode);
Jan Kara6e4b0d52007-04-27 11:08:01 -0700169void ocfs2_get_inode_flags(struct ocfs2_inode_info *oi);
Herbert Poetzlca4d1472006-07-03 17:27:12 -0700170
Mark Fasheh8110b072007-03-22 16:53:23 -0700171static inline blkcnt_t ocfs2_inode_sector_count(struct inode *inode)
172{
173 int c_to_s_bits = OCFS2_SB(inode->i_sb)->s_clustersize_bits - 9;
174
Joseph Qi7fa05c62014-10-09 15:24:56 -0700175 return (blkcnt_t)OCFS2_I(inode)->ip_clusters << c_to_s_bits;
Mark Fasheh8110b072007-03-22 16:53:23 -0700176}
177
Joel Beckerb657c952008-11-13 14:49:11 -0800178/* Validate that a bh contains a valid inode */
179int ocfs2_validate_inode_block(struct super_block *sb,
180 struct buffer_head *bh);
181/*
182 * Read an inode block into *bh. If *bh is NULL, a bh will be allocated.
183 * This is a cached read. The inode will be validated with
184 * ocfs2_validate_inode_block().
185 */
186int ocfs2_read_inode_block(struct inode *inode, struct buffer_head **bh);
187/* The same, but can be passed OCFS2_BH_* flags */
188int ocfs2_read_inode_block_full(struct inode *inode, struct buffer_head **bh,
189 int flags);
Joel Becker6136ca52009-02-12 19:32:43 -0800190
191static inline struct ocfs2_inode_info *cache_info_to_inode(struct ocfs2_caching_info *ci)
192{
193 return container_of(ci, struct ocfs2_inode_info, ip_metadata_cache);
194}
195
Mark Fashehccd979b2005-12-15 14:31:24 -0800196#endif /* OCFS2_INODE_H */