xref: /haiku/src/add-ons/kernel/file_systems/ntfs/libntfs/dir.h (revision a30a4a41f948ebb03b95dab065a27a584ac0c97a)
1 /*
2  * dir.h - Exports for directory handling. Originated from the Linux-NTFS project.
3  *
4  * Copyright (c) 2002      Anton Altaparmakov
5  * Copyright (c) 2005-2006 Yura Pakhuchiy
6  * Copyright (c) 2004-2005 Richard Russon
7  * Copyright (c) 2005-2008 Szabolcs Szakacsits
8  *
9  * This program/include file is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License as published
11  * by the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program/include file is distributed in the hope that it will be
15  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
16  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program (in the main directory of the NTFS-3G
21  * distribution in the file COPYING); if not, write to the Free Software
22  * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23  */
24 
25 #ifndef _NTFS_DIR_H
26 #define _NTFS_DIR_H
27 
28 #include "types.h"
29 
30 #define PATH_SEP '/'
31 
32 #ifdef __HAIKU__
33 #ifndef MAX_PATH
34 #define MAX_PATH 1024
35 #endif
36 #endif
37 
38 /*
39  * We do not have these under DJGPP, so define our version that do not conflict
40  * with other S_IFs defined under DJGPP.
41  */
42 #ifdef DJGPP
43 #ifndef S_IFLNK
44 #define S_IFLNK  0120000
45 #endif
46 #ifndef S_ISLNK
47 #define S_ISLNK(m)  (((m) & S_IFMT) == S_IFLNK)
48 #endif
49 #ifndef S_IFSOCK
50 #define S_IFSOCK 0140000
51 #endif
52 #ifndef S_ISSOCK
53 #define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
54 #endif
55 #endif
56 
57 /*
58  * The little endian Unicode strings $I30, $SII, $SDH, $O, $Q, $R
59  * as a global constant.
60  */
61 extern ntfschar NTFS_INDEX_I30[5];
62 extern ntfschar NTFS_INDEX_SII[5];
63 extern ntfschar NTFS_INDEX_SDH[5];
64 extern ntfschar NTFS_INDEX_O[3];
65 extern ntfschar NTFS_INDEX_Q[3];
66 extern ntfschar NTFS_INDEX_R[3];
67 
68 extern u64 ntfs_inode_lookup_by_name(ntfs_inode *dir_ni,
69 		const ntfschar *uname, const int uname_len);
70 extern u64 ntfs_inode_lookup_by_mbsname(ntfs_inode *dir_ni, const char *name);
71 extern void ntfs_inode_update_mbsname(ntfs_inode *dir_ni, const char *name,
72 				u64 inum);
73 
74 extern ntfs_inode *ntfs_pathname_to_inode(ntfs_volume *vol, ntfs_inode *parent,
75 		const char *pathname);
76 extern ntfs_inode *ntfs_create(ntfs_inode *dir_ni, le32 securid,
77 		const ntfschar *name, u8 name_len, mode_t type);
78 extern ntfs_inode *ntfs_create_device(ntfs_inode *dir_ni, le32 securid,
79 		const ntfschar *name, u8 name_len, mode_t type, dev_t dev);
80 extern ntfs_inode *ntfs_create_symlink(ntfs_inode *dir_ni, le32 securid,
81 		const ntfschar *name, u8 name_len, const ntfschar *target,
82 		int target_len);
83 extern int ntfs_check_empty_dir(ntfs_inode *ni);
84 extern int ntfs_delete(ntfs_volume *vol, const char *path,
85 		ntfs_inode *ni, ntfs_inode *dir_ni, const ntfschar *name,
86 		u8 name_len);
87 
88 extern int ntfs_link(ntfs_inode *ni, ntfs_inode *dir_ni, const ntfschar *name,
89 		u8 name_len);
90 
91 /*
92  * File types (adapted from include <linux/fs.h>)
93  */
94 #define NTFS_DT_UNKNOWN		0
95 #define NTFS_DT_FIFO		1
96 #define NTFS_DT_CHR		2
97 #define NTFS_DT_DIR		4
98 #define NTFS_DT_BLK		6
99 #define NTFS_DT_REG		8
100 #define NTFS_DT_LNK		10
101 #define NTFS_DT_SOCK		12
102 #define NTFS_DT_WHT		14
103 
104 /*
105  * This is the "ntfs_filldir" function type, used by ntfs_readdir() to let
106  * the caller specify what kind of dirent layout it wants to have.
107  * This allows the caller to read directories into their application or
108  * to have different dirent layouts depending on the binary type.
109  */
110 typedef int (*ntfs_filldir_t)(void *dirent, const ntfschar *name,
111 		const int name_len, const int name_type, const s64 pos,
112 		const MFT_REF mref, const unsigned dt_type);
113 
114 extern int ntfs_readdir(ntfs_inode *dir_ni, s64 *pos,
115 		void *dirent, ntfs_filldir_t filldir);
116 
117 ntfs_inode *ntfs_dir_parent_inode(ntfs_inode *ni);
118 
119 #ifdef __HAIKU__
120 MFT_REF ntfs_mft_get_parent_ref(ntfs_inode *ni);
121 #endif
122 
123 int ntfs_get_ntfs_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni,
124 			char *value, size_t size);
125 int ntfs_set_ntfs_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni,
126 			const char *value, size_t size,	int flags);
127 int ntfs_remove_ntfs_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni);
128 
129 #if CACHE_INODE_SIZE
130 
131 struct CACHED_GENERIC;
132 
133 extern int ntfs_dir_inode_hash(const struct CACHED_GENERIC *cached);
134 extern int ntfs_dir_lookup_hash(const struct CACHED_GENERIC *cached);
135 
136 #endif
137 
138 #endif /* defined _NTFS_DIR_H */
139 
140