Fix problem where symllink alias pointer was being used after free
[yaffs2.git] / direct / yaffsfs.h
1 /*
2  * YAFFS: Yet another Flash File System . A NAND-flash specific file system. 
3  *
4  * Copyright (C) 2002-2007 Aleph One Ltd.
5  *   for Toby Churchill Ltd and Brightstar Engineering
6  *
7  * Created by Charles Manning <charles@aleph1.co.uk>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU Lesser General Public License version 2.1 as
11  * published by the Free Software Foundation.
12  *
13  * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
14  */
15
16 /*
17  * Header file for using yaffs in an application via
18  * a direct interface.
19  */
20
21
22 #ifndef __YAFFSFS_H__
23 #define __YAFFSFS_H__
24
25 #include "yaffscfg.h"
26 #include "yportenv.h"
27
28
29 //typedef long off_t;
30 //typedef long dev_t;
31 //typedef unsigned long mode_t;
32
33
34 #ifndef NAME_MAX
35 #define NAME_MAX        256
36 #endif
37
38
39 #ifdef CONFIG_YAFFSFS_PROVIDE_VALUES
40
41 #ifndef O_RDONLY
42 #define O_RDONLY        00
43 #endif
44
45 #ifndef O_WRONLY
46 #define O_WRONLY        01
47 #endif
48
49 #ifndef O_RDWR
50 #define O_RDWR          02
51 #endif
52
53 #ifndef O_CREAT         
54 #define O_CREAT         0100
55 #endif
56
57 #ifndef O_EXCL
58 #define O_EXCL          0200
59 #endif
60
61 #ifndef O_TRUNC
62 #define O_TRUNC         01000
63 #endif
64
65 #ifndef O_APPEND
66 #define O_APPEND        02000
67 #endif
68
69 #ifndef SEEK_SET
70 #define SEEK_SET        0
71 #endif
72
73 #ifndef SEEK_CUR
74 #define SEEK_CUR        1
75 #endif
76
77 #ifndef SEEK_END
78 #define SEEK_END        2
79 #endif
80
81 #ifndef EBUSY
82 #define EBUSY   16
83 #endif
84
85 #ifndef ENODEV
86 #define ENODEV  19
87 #endif
88
89 #ifndef EINVAL
90 #define EINVAL  22
91 #endif
92
93 #ifndef EBADF
94 #define EBADF   9
95 #endif
96
97 #ifndef EACCES
98 #define EACCES  13
99 #endif
100
101 #ifndef EXDEV   
102 #define EXDEV   18
103 #endif
104
105 #ifndef ENOENT
106 #define ENOENT  2
107 #endif
108
109 #ifndef ENOSPC
110 #define ENOSPC  28
111 #endif
112
113 #ifndef ENOTEMPTY
114 #define ENOTEMPTY 39
115 #endif
116
117 #ifndef ENOMEM
118 #define ENOMEM 12
119 #endif
120
121 #ifndef EEXIST
122 #define EEXIST 17
123 #endif
124
125 #ifndef ENOTDIR
126 #define ENOTDIR 20
127 #endif
128
129 #ifndef EISDIR
130 #define EISDIR 21
131 #endif
132
133
134 // Mode flags
135
136 #ifndef S_IFMT
137 #define S_IFMT          0170000
138 #endif
139
140 #ifndef S_IFLNK
141 #define S_IFLNK         0120000
142 #endif
143
144 #ifndef S_IFDIR
145 #define S_IFDIR         0040000
146 #endif
147
148 #ifndef S_IFREG
149 #define S_IFREG         0100000
150 #endif
151
152 #ifndef S_IREAD 
153 #define S_IREAD         0000400
154 #endif
155
156 #ifndef S_IWRITE
157 #define S_IWRITE        0000200
158 #endif
159
160 #ifndef S_IEXEC
161 #define S_IEXEC 0000100
162 #endif
163
164 #ifndef R_OK
165 #define R_OK    4
166 #define W_OK    2
167 #define X_OK    1
168 #define F_OK    0
169 #endif
170
171 #else
172 #include <errno.h>
173 #include <sys/stat.h>
174 #include <fcntl.h>
175 #endif
176
177
178 struct yaffs_dirent{
179     long d_ino;                 /* inode number */
180     off_t d_off;                /* offset to this dirent */
181     unsigned short d_reclen;    /* length of this d_name */
182     YUCHAR  d_type;     /* type of this record */
183     YCHAR d_name [NAME_MAX+1];   /* file name (null-terminated) */
184     unsigned d_dont_use;        /* debug pointer, not for public consumption */
185 };
186
187 typedef struct yaffs_dirent yaffs_dirent;
188
189
190 typedef struct __opaque yaffs_DIR;
191
192
193
194 struct yaffs_stat{
195     int               st_dev;      /* device */
196     int           st_ino;      /* inode */
197     unsigned      st_mode;     /* protection */
198     int           st_nlink;    /* number of hard links */
199     int           st_uid;      /* user ID of owner */
200     int           st_gid;      /* group ID of owner */
201     unsigned      st_rdev;     /* device type (if inode device) */
202     off_t         st_size;     /* total size, in bytes */
203     unsigned long st_blksize;  /* blocksize for filesystem I/O */
204     unsigned long st_blocks;   /* number of blocks allocated */
205 #ifdef CONFIG_YAFFS_WINCE
206         /* Special 64-bit times for WinCE */
207         unsigned long yst_wince_atime[2];
208         unsigned long yst_wince_mtime[2];
209         unsigned long yst_wince_ctime[2];
210 #else
211         unsigned long yst_atime;    /* time of last access */
212     unsigned long yst_mtime;    /* time of last modification */
213     unsigned long yst_ctime;    /* time of last change */
214 #endif
215 };
216
217 int yaffs_open(const YCHAR *path, int oflag, int mode) ;
218 int yaffs_close(int fd) ;
219 int yaffs_fsync(int fd) ;
220 int yaffs_fdatasync(int fd) ;
221 int yaffs_flush(int fd) ; /* same as yaffs_fsync() */
222
223 int yaffs_access(const YCHAR *path, int amode);
224
225 int yaffs_dup(int fd);
226
227 int yaffs_read(int fd, void *buf, unsigned int nbyte) ;
228 int yaffs_write(int fd, const void *buf, unsigned int nbyte) ;
229
230 int yaffs_pread(int fd, void *buf, unsigned int nbyte, unsigned int offset);
231 int yaffs_pwrite(int fd, const void *buf, unsigned int nbyte, unsigned int offset);
232
233 off_t yaffs_lseek(int fd, off_t offset, int whence) ;
234
235 int yaffs_truncate(const YCHAR *path, off_t newSize);
236 int yaffs_ftruncate(int fd, off_t newSize);
237
238 int yaffs_unlink(const YCHAR *path) ;
239 int yaffs_rename(const YCHAR *oldPath, const YCHAR *newPath) ;
240
241 int yaffs_stat(const YCHAR *path, struct yaffs_stat *buf) ;
242 int yaffs_lstat(const YCHAR *path, struct yaffs_stat *buf) ;
243 int yaffs_fstat(int fd, struct yaffs_stat *buf) ;
244
245 #ifdef CONFIG_YAFFS_WINCE
246
247 int yaffs_set_wince_times(int fd, const unsigned *wctime, const unsigned *watime, const unsigned *wmtime);
248 int yaffs_get_wince_times(int fd, unsigned *wctime, unsigned *watime, unsigned *wmtime);
249
250 #endif
251
252 int yaffs_chmod(const YCHAR *path, mode_t mode); 
253 int yaffs_fchmod(int fd, mode_t mode); 
254
255 int yaffs_mkdir(const YCHAR *path, mode_t mode) ;
256 int yaffs_rmdir(const YCHAR *path) ;
257
258 yaffs_DIR *yaffs_opendir(const YCHAR *dirname) ;
259 struct yaffs_dirent *yaffs_readdir(yaffs_DIR *dirp) ;
260 void yaffs_rewinddir(yaffs_DIR *dirp) ;
261 int yaffs_closedir(yaffs_DIR *dirp) ;
262
263 int yaffs_mount(const YCHAR *path) ;
264 int yaffs_unmount(const YCHAR *path) ;
265
266 int yaffs_sync(const YCHAR *path) ;
267
268 int yaffs_symlink(const YCHAR *oldpath, const YCHAR *newpath); 
269 int yaffs_readlink(const YCHAR *path, YCHAR *buf, int bufsiz); 
270
271 int yaffs_link(const YCHAR *oldpath, const YCHAR *newpath); 
272 int yaffs_mknod(const YCHAR *pathname, mode_t mode, dev_t dev);
273
274 loff_t yaffs_freespace(const YCHAR *path);
275 loff_t yaffs_totalspace(const YCHAR *path);
276
277 int yaffs_inodecount(const YCHAR *path);
278
279
280 void yaffs_initialise(yaffsfs_DeviceConfiguration *configList);
281
282 int yaffs_StartUp(void);
283
284 #endif
285
286