chfs_inode.h revision 1.6 1 /* $NetBSD: chfs_inode.h,v 1.6 2012/10/19 12:44:39 ttoth Exp $ */
2
3 /*-
4 * Copyright (c) 2010 Department of Software Engineering,
5 * University of Szeged, Hungary
6 * Copyright (C) 2010 Tamas Toth <ttoth (at) inf.u-szeged.hu>
7 * Copyright (C) 2010 Adam Hoka <ahoka (at) NetBSD.org>
8 * All rights reserved.
9 *
10 * This code is derived from software contributed to The NetBSD Foundation
11 * by the Department of Software Engineering, University of Szeged, Hungary
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 */
34
35 #ifndef __CHFS_INODE_H__
36 #define __CHFS_INODE_H__
37
38 #ifdef _KERNEL
39 #include <sys/vnode.h>
40 #include <sys/stat.h>
41 #include <ufs/ufs/ufsmount.h>
42 #include <miscfs/genfs/genfs_node.h>
43 #endif /* _KERNEL */
44
45 #define CHFS_ROOTINO 2
46
47 /* chfs file types */
48 enum chtype {
49 CHT_BLANK, /* empty type */
50 CHT_REG, /* regular file */
51 CHT_DIR, /* directory */
52 CHT_BLK, /* block device */
53 CHT_CHR, /* character device */
54 CHT_LNK, /* link */
55 CHT_SOCK, /* socket */
56 CHT_FIFO, /* fifo */
57 CHT_BAD /* bad type */
58 };
59
60 /* these macros are needed because the compatibility */
61 #define CHTTOVT(ch_type) (enum vtype)(ch_type)
62 #define VTTOCHT(v_type) (enum chtype)(v_type)
63
64 /* vtype replaced with chtype, these are only for backward compatibility */
65 static const enum chtype iftocht_tab[16] = {
66 CHT_BLANK, CHT_FIFO, CHT_CHR, CHT_BLANK,
67 CHT_DIR, CHT_BLANK, CHT_BLK, CHT_BLANK,
68 CHT_REG, CHT_BLANK, CHT_LNK, CHT_BLANK,
69 CHT_SOCK, CHT_BLANK, CHT_BLANK, CHT_BAD,
70 };
71
72 #define IFTOCHT(mode) (iftocht_tab[((mode) & S_IFMT) >> 12])
73
74 #ifdef _KERNEL
75 struct chfs_inode
76 {
77 struct genfs_node gnode;
78 kmutex_t inode_lock; /* lock the fields of chfs_inode */
79
80 LIST_ENTRY(chfs_inode) hash_entry; /* hash chain */
81
82 struct ufsmount *ump; /* ufs mount - TODO we should remove it */
83 struct chfs_mount *chmp; /* chfs mount point - TODO we should remove it */
84
85 struct vnode *vp; /* vnode associated with this inode */
86 ino_t ino; /* vnode identifier number */
87
88 struct vnode *devvp; /* vnode for block I/O */
89 dev_t dev; /* device associated with the inode */
90
91 struct chfs_vnode_cache *chvc; /* vnode cache of this node */
92
93 struct chfs_dirent *fd; /* full dirent of this node */
94 struct chfs_dirent_list dents;
95
96 struct rb_tree fragtree; /* fragtree of inode */
97
98 uint64_t version; /* version number */
99
100 uint32_t mode; /* mode */
101 enum chtype ch_type; /* chfs file type */
102 uint64_t size; /* file byte count */
103 uint64_t write_size; /* increasing while write the file out to the flash */
104 uint32_t uid; /* file owner */
105 uint32_t gid; /* file group */
106 uint32_t atime; /* access time */
107 uint32_t mtime; /* modify time */
108 uint32_t ctime; /* creation time */
109
110 uint32_t iflag; /* flags, see below */
111 uint32_t flags; /* status flags (chflags) */
112
113 dev_t rdev; /* used if type is VCHR or VBLK or VFIFO*/
114 char *target; /* used if type is VLNK */
115 };
116
117 /* These flags are kept in chfs_inode->iflag. */
118 #define IN_ACCESS 0x0001 /* Access time update request. */
119 #define IN_CHANGE 0x0002 /* Inode change time update request. */
120 #define IN_UPDATE 0x0004 /* Inode was written to; update mtime. */
121 #define IN_MODIFY 0x2000 /* Modification time update request. */
122 #define IN_MODIFIED 0x0008 /* Inode has been modified. */
123 #define IN_ACCESSED 0x0010 /* Inode has been accessed. */
124 #define IN_RENAME 0x0020 /* Inode is being renamed. */
125 #define IN_SHLOCK 0x0040 /* File has shared lock. */
126 #define IN_EXLOCK 0x0080 /* File has exclusive lock. */
127 #define IN_CLEANING 0x0100 /* LFS: file is being cleaned */
128 #define IN_ADIROP 0x0200 /* LFS: dirop in progress */
129 #define IN_SPACECOUNTED 0x0400 /* Blocks to be freed in free count. */
130 #define IN_PAGING 0x1000 /* LFS: file is on paging queue */
131
132
133 #ifdef VTOI
134 # undef VTOI
135 #endif
136 #ifdef ITOV
137 # undef ITOV
138 #endif
139
140 /* struct vnode to struct chfs_inode */
141 #define VTOI(vp) ((struct chfs_inode *)(vp)->v_data)
142 /* struct chfs_inode to struct vnode */
143 #define ITOV(ip) ((ip)->vp)
144
145 /* copied from ufs_dinode.h */
146 #define NDADDR 12 /* Direct addresses in inode. */
147
148 #define ROOTINO ((ino_t)2)
149
150 /* File permissions. */
151 #define IEXEC 0000100 /* Executable. */
152 #define IWRITE 0000200 /* Writable. */
153 #define IREAD 0000400 /* Readable. */
154 #define ISVTX 0001000 /* Sticky bit. */
155 #define ISGID 0002000 /* Set-gid. */
156 #define ISUID 0004000 /* Set-uid. */
157
158 /* File types. */
159 #define IFMT 0170000 /* Mask of file type. */
160 #define IFIFO 0010000 /* Named pipe (fifo). */
161 #define IFCHR 0020000 /* Character device. */
162 #define IFDIR 0040000 /* Directory file. */
163 #define IFBLK 0060000 /* Block device. */
164 #define IFREG 0100000 /* Regular file. */
165 #define IFLNK 0120000 /* Symbolic link. */
166 #define IFSOCK 0140000 /* UNIX domain socket. */
167 #define IFWHT 0160000 /* Whiteout. */
168
169 #endif /* _KERNEL */
170 #endif /* __CHFS_INODE_H__ */
171