Further extensions for VxWorks wrapper
[yaffs2.git] / direct / yaffsfs.h
index 18cc22f..3e0ddd0 100644 (file)
@@ -1,7 +1,7 @@
 /*
- * YAFFS: Yet another Flash File System . A NAND-flash specific file system. 
+ * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
  *
- * Copyright (C) 2002-2010 Aleph One Ltd.
+ * Copyright (C) 2002-2011 Aleph One Ltd.
  *   for Toby Churchill Ltd and Brightstar Engineering
  *
  * Created by Charles Manning <charles@aleph1.co.uk>
 #include "yportenv.h"
 
 
-//typedef long off_t;
-//typedef long dev_t;
-//typedef unsigned long mode_t;
-
-
 #ifndef NAME_MAX
 #define NAME_MAX       256
 #endif
 
+#define YAFFS_MAX_FILE_SIZE \
+       ( (sizeof(Y_LOFF_T) < 8) ? YAFFS_MAX_FILE_SIZE_32 : (0x800000000LL - 1) )
 
-#ifdef CONFIG_YAFFSFS_PROVIDE_VALUES
-
-#ifndef O_RDONLY
-#define O_RDONLY        00
-#endif
-
-#ifndef O_WRONLY
-#define O_WRONLY       01
-#endif
-
-#ifndef O_RDWR
-#define O_RDWR         02
-#endif
-
-#ifndef O_CREAT                
-#define O_CREAT        0100
-#endif
-
-#ifndef O_EXCL
-#define O_EXCL         0200
-#endif
-
-#ifndef O_TRUNC
-#define O_TRUNC                01000
-#endif
-
-#ifndef O_APPEND
-#define O_APPEND       02000
-#endif
-
-#ifndef SEEK_SET
-#define SEEK_SET       0
-#endif
-
-#ifndef SEEK_CUR
-#define SEEK_CUR       1
-#endif
-
-#ifndef SEEK_END
-#define SEEK_END       2
-#endif
-
-#ifndef EBUSY
-#define EBUSY  16
-#endif
-
-#ifndef ENODEV
-#define ENODEV 19
-#endif
-
-#ifndef EINVAL
-#define EINVAL 22
-#endif
 
-#ifndef EBADF
-#define EBADF  9
+#ifdef __cplusplus
+extern "C"
+{
 #endif
 
-#ifndef EACCES
-#define EACCES 13
-#endif
-
-#ifndef EXDEV  
-#define EXDEV  18
-#endif
-
-#ifndef ENOENT
-#define ENOENT 2
-#endif
-
-#ifndef ENOSPC
-#define ENOSPC 28
-#endif
-
-#ifndef ENOTEMPTY
-#define ENOTEMPTY 39
-#endif
-
-#ifndef ENAMETOOLONG
-#define ENAMETOOLONG 36
-#endif
-
-#ifndef ENOMEM
-#define ENOMEM 12
-#endif
-
-#ifndef EEXIST
-#define EEXIST 17
-#endif
-
-#ifndef ENOTDIR
-#define ENOTDIR 20
-#endif
-
-#ifndef EISDIR
-#define EISDIR 21
-#endif
-
-
-// Mode flags
-
-#ifndef S_IFMT
-#define S_IFMT         0170000
-#endif
-
-#ifndef S_IFLNK
-#define S_IFLNK                0120000
-#endif
-
-#ifndef S_IFDIR
-#define S_IFDIR                0040000
-#endif
 
-#ifndef S_IFREG
-#define S_IFREG                0100000
-#endif
-
-#ifndef S_IREAD 
-#define S_IREAD                0000400
-#endif
-
-#ifndef S_IWRITE
-#define        S_IWRITE        0000200
-#endif
-
-#ifndef S_IEXEC
-#define        S_IEXEC 0000100
-#endif
-
-#ifndef R_OK
-#define R_OK   4
-#define W_OK   2
-#define X_OK   1
-#define F_OK   0
-#endif
-
-#else
-#include <errno.h>
-#include <sys/stat.h>
-#include <fcntl.h>
-#endif
-
-
-struct yaffs_dirent{
-    long d_ino;                 /* inode number */
-    off_t d_off;                /* offset to this dirent */
-    unsigned short d_reclen;    /* length of this d_name */
-    YUCHAR  d_type;    /* type of this record */
-    YCHAR d_name [NAME_MAX+1];   /* file name (null-terminated) */
-    unsigned d_dont_use;       /* debug pointer, not for public consumption */
+struct yaffs_dirent {
+       long d_ino;                     /* inode number */
+       off_t d_off;                    /* offset to this dirent */
+       unsigned short d_reclen;        /* length of this dirent */
+       YUCHAR d_type;                  /* type of this record */
+       YCHAR d_name[NAME_MAX+1];       /* file name (null-terminated) */
+       unsigned d_dont_use;            /* debug: not for public consumption */
 };
 
-typedef struct yaffs_dirent yaffs_dirent;
+typedef struct opaque_structure yaffs_DIR;
 
 
-typedef struct __opaque yaffs_DIR;
 
-
-
-struct yaffs_stat{
-    int                      st_dev;      /* device */
-    int           st_ino;      /* inode */
-    unsigned      st_mode;     /* protection */
-    int           st_nlink;    /* number of hard links */
-    int           st_uid;      /* user ID of owner */
-    int           st_gid;      /* group ID of owner */
-    unsigned      st_rdev;     /* device type (if inode device) */
-    off_t         st_size;     /* total size, in bytes */
-    unsigned long st_blksize;  /* blocksize for filesystem I/O */
-    unsigned long st_blocks;   /* number of blocks allocated */
+struct yaffs_stat {
+       int             st_dev;         /* device */
+       int             st_ino;         /* inode */
+       unsigned        st_mode;        /* protection */
+       int             st_nlink;       /* number of hard links */
+       int             st_uid;         /* user ID of owner */
+       int             st_gid;         /* group ID of owner */
+       unsigned        st_rdev;        /* device type (if inode device) */
+       Y_LOFF_T                st_size;        /* total size, in bytes */
+       unsigned long   st_blksize;     /* blocksize for filesystem I/O */
+       unsigned long   st_blocks;      /* number of blocks allocated */
 #ifdef CONFIG_YAFFS_WINCE
        /* Special 64-bit times for WinCE */
-       unsigned long yst_wince_atime[2];
-       unsigned long yst_wince_mtime[2];
-       unsigned long yst_wince_ctime[2];
+       unsigned long   yst_wince_atime[2];
+       unsigned long   yst_wince_mtime[2];
+       unsigned long   yst_wince_ctime[2];
 #else
-       unsigned long yst_atime;    /* time of last access */
-    unsigned long yst_mtime;    /* time of last modification */
-    unsigned long yst_ctime;    /* time of last change */
+       unsigned long   yst_atime;      /* time of last access */
+       unsigned long   yst_mtime;      /* time of last modification */
+       unsigned long   yst_ctime;      /* time of last change */
 #endif
 };
 
+
+struct yaffs_utimbuf {
+       unsigned long actime;
+       unsigned long modtime;
+};
+
+/* Normal POSIX-style API functions */
+
 int yaffs_open(const YCHAR *path, int oflag, int mode) ;
+
 int yaffs_close(int fd) ;
 int yaffs_fsync(int fd) ;
 int yaffs_fdatasync(int fd) ;
@@ -228,46 +95,56 @@ int yaffs_access(const YCHAR *path, int amode);
 
 int yaffs_dup(int fd);
 
+int yaffs_fgetfl(int fd, int *flags);
+
 int yaffs_read(int fd, void *buf, unsigned int nbyte) ;
 int yaffs_write(int fd, const void *buf, unsigned int nbyte) ;
 
-int yaffs_pread(int fd, void *buf, unsigned int nbyte, unsigned int offset);
-int yaffs_pwrite(int fd, const void *buf, unsigned int nbyte, unsigned int offset);
+int yaffs_pread(int fd, void *buf, unsigned int nbyte, Y_LOFF_T offset);
+int yaffs_pwrite(int fd, const void *buf, unsigned int nbyte, Y_LOFF_T offset);
+
+Y_LOFF_T yaffs_lseek(int fd, Y_LOFF_T offset, int whence);
 
-off_t yaffs_lseek(int fd, off_t offset, int whence) ;
+int yaffs_truncate(const YCHAR *path, Y_LOFF_T new_size);
+int yaffs_ftruncate(int fd, Y_LOFF_T new_size);
 
-int yaffs_truncate(const YCHAR *path, off_t newSize);
-int yaffs_ftruncate(int fd, off_t newSize);
+int yaffs_unlink(const YCHAR *path);
+int yaffs_funlink(int fd);
 
-int yaffs_unlink(const YCHAR *path) ;
 int yaffs_rename(const YCHAR *oldPath, const YCHAR *newPath) ;
 
 int yaffs_stat(const YCHAR *path, struct yaffs_stat *buf) ;
 int yaffs_lstat(const YCHAR *path, struct yaffs_stat *buf) ;
 int yaffs_fstat(int fd, struct yaffs_stat *buf) ;
 
-int yaffs_setxattr(const char *path, const char *name, const void *data, int size, int flags);
-int yaffs_fsetxattr(int fd, const char *name, const void *data, int size, int flags);
+int yaffs_utime(const YCHAR *path, const struct yaffs_utimbuf *buf);
+int yaffs_futime(int fd, const struct yaffs_utimbuf *buf);
+
 
-int yaffs_getxattr(const char *path, const char *name, void *data, int size);
-int yaffs_fgetxattr(int fd, const char *name, void *data, int size);
+int yaffs_setxattr(const char *path, const char *name,
+                       const void *data, int size, int flags);
+int yaffs_lsetxattr(const char *path, const char *name,
+                       const void *data, int size, int flags);
+int yaffs_fsetxattr(int fd, const char *name,
+                       const void *data, int size, int flags);
+
+int yaffs_getxattr(const char *path, const char *name,
+                       void *data, int size);
+int yaffs_lgetxattr(const char *path, const char *name,
+                       void *data, int size);
+int yaffs_fgetxattr(int fd, const char *name,
+                       void *data, int size);
 
 int yaffs_removexattr(const char *path, const char *name);
+int yaffs_lremovexattr(const char *path, const char *name);
 int yaffs_fremovexattr(int fd, const char *name);
 
 int yaffs_listxattr(const char *path, char *list, int size);
+int yaffs_llistxattr(const char *path, char *list, int size);
 int yaffs_flistxattr(int fd, char *list, int size);
 
-
-#ifdef CONFIG_YAFFS_WINCE
-
-int yaffs_set_wince_times(int fd, const unsigned *wctime, const unsigned *watime, const unsigned *wmtime);
-int yaffs_get_wince_times(int fd, unsigned *wctime, unsigned *watime, unsigned *wmtime);
-
-#endif
-
-int yaffs_chmod(const YCHAR *path, mode_t mode); 
-int yaffs_fchmod(int fd, mode_t mode); 
+int yaffs_chmod(const YCHAR *path, mode_t mode);
+int yaffs_fchmod(int fd, mode_t mode);
 
 int yaffs_mkdir(const YCHAR *path, mode_t mode) ;
 int yaffs_rmdir(const YCHAR *path) ;
@@ -278,30 +155,196 @@ void yaffs_rewinddir(yaffs_DIR *dirp) ;
 int yaffs_closedir(yaffs_DIR *dirp) ;
 
 int yaffs_mount(const YCHAR *path) ;
-int yaffs_mount2(const YCHAR *path, int readOnly);
+int yaffs_mount2(const YCHAR *path, int read_only);
+int yaffs_mount3(const YCHAR *path, int read_only, int skip_checkpt);
+
 int yaffs_unmount(const YCHAR *path) ;
 int yaffs_unmount2(const YCHAR *path, int force);
-int yaffs_remount(const YCHAR *path, int force, int readOnly);
+int yaffs_remount(const YCHAR *path, int force, int read_only);
 
+int yaffs_format(const YCHAR *path,
+               int unmount_flag,
+               int force_unmount_flag,
+               int remount_flag);
 
-int yaffs_sync(const YCHAR *path) ;
+/*
+ * yaffs_sync() does a full sync, including checkpoint.
+ * yaffs_sync_files() just flushes the cache and does not write a checkpoint.
+ */
+int yaffs_sync(const YCHAR *path);
+int yaffs_sync_files(const YCHAR *path) ;
 
-int yaffs_symlink(const YCHAR *oldpath, const YCHAR *newpath); 
-int yaffs_readlink(const YCHAR *path, YCHAR *buf, int bufsiz); 
+int yaffs_symlink(const YCHAR *oldpath, const YCHAR *newpath);
+int yaffs_readlink(const YCHAR *path, YCHAR *buf, int bufsiz);
 
-int yaffs_link(const YCHAR *oldpath, const YCHAR *newpath); 
+int yaffs_link(const YCHAR *oldpath, const YCHAR *newpath);
 int yaffs_mknod(const YCHAR *pathname, mode_t mode, dev_t dev);
 
-loff_t yaffs_freespace(const YCHAR *path);
-loff_t yaffs_totalspace(const YCHAR *path);
+Y_LOFF_T yaffs_freespace(const YCHAR *path);
+Y_LOFF_T yaffs_totalspace(const YCHAR *path);
+
+/* Function variants that use a relative directory */
+struct yaffs_obj;
+int yaffs_open_sharing_reldir(struct yaffs_obj *reldir, const YCHAR *path, int oflag, int mode, int sharing);
+int yaffs_open_reldir(struct yaffs_obj *reldir,const YCHAR *path, int oflag, int mode);
+int yaffs_truncate_reldir(struct yaffs_obj *reldir, const YCHAR *path, Y_LOFF_T new_size);
+int yaffs_unlink_reldir(struct yaffs_obj *reldir, const YCHAR *path);
+int yaffs_rename_reldir(struct yaffs_obj *reldir,
+                       const YCHAR *oldPath, const YCHAR *newPath);
+int yaffs_stat_reldir(struct yaffs_obj *reldir, const YCHAR *path, struct yaffs_stat *buf);
+int yaffs_lstat_reldir(struct yaffs_obj *reldir, const YCHAR *path, struct yaffs_stat *buf);
+int yaffs_utime_reldir(struct yaffs_obj *reldir, const YCHAR *path, const struct yaffs_utimbuf *buf);
+int yaffs_setxattr_reldir(struct yaffs_obj *reldir, const YCHAR *path,
+                       const char *name, const void *data, int size, int flags);
+int yaffs_lsetxattr_reldir(struct yaffs_obj *reldir, const YCHAR *path,
+                       const char *name, const void *data, int size, int flags);
+int yaffs_getxattr_reldir(struct yaffs_obj *reldir, const YCHAR *path,
+                       const char *name, void *data, int size);
+int yaffs_lgetxattr_reldir(struct yaffs_obj *reldir, const YCHAR *path,
+                       const char *name, void *data, int size);
+int yaffs_listxattr_reldir(struct yaffs_obj *reldir, const YCHAR *path,
+                       char *data, int size);
+int yaffs_llistxattr_reldir(struct yaffs_obj *reldir, const YCHAR *path,
+                       char *data, int size);
+int yaffs_removexattr_reldir(struct yaffs_obj *reldir, const YCHAR *path,
+                       const char *name);
+int yaffs_lremovexattr_reldir(struct yaffs_obj *reldir, const YCHAR *path,
+                       const char *name);
+int yaffs_access_reldir(struct yaffs_obj *reldir, const YCHAR *path, int amode);
+int yaffs_chmod_reldir(struct yaffs_obj *reldir, const YCHAR *path, mode_t mode);
+int yaffs_mkdir_reldir(struct yaffs_obj *reldir, const YCHAR *path, mode_t mode);
+int yaffs_rmdir_reldir(struct yaffs_obj *reldir, const YCHAR *path);
+yaffs_DIR *yaffs_opendir_reldir(struct yaffs_obj *reldir, const YCHAR *dirname);
+int yaffs_symlink_reldir(struct yaffs_obj *reldir,
+                       const YCHAR *oldpath, const YCHAR *newpath);
+int yaffs_readlink_reldir(struct yaffs_obj *reldir,const YCHAR *path,
+                       YCHAR *buf, int bufsiz);
+int yaffs_link_reldir(struct yaffs_obj *reldir,
+                       const YCHAR *oldpath, const YCHAR *linkpath);
+int yaffs_mknod_reldir(struct yaffs_obj *reldir, const YCHAR *pathname,
+                    mode_t mode, dev_t dev);
+
+/* Function variants that use a relative device */
+struct yaffs_dev;
+int yaffs_mount_reldev(struct yaffs_dev *dev);
+int yaffs_open_sharing_reldev(struct yaffs_dev *dev, const YCHAR *path, int oflag, int mode, int sharing);
+int yaffs_open_reldev(struct yaffs_dev *dev,const YCHAR *path, int oflag, int mode);
+int yaffs_truncate_reldev(struct yaffs_dev *dev, const YCHAR *path, Y_LOFF_T new_size);
+int yaffs_unlink_reldev(struct yaffs_dev *dev, const YCHAR *path);
+int yaffs_rename_reldev(struct yaffs_dev *dev,
+                       const YCHAR *oldPath, const YCHAR *newPath);
+int yaffs_stat_reldev(struct yaffs_dev *dev, const YCHAR *path, struct yaffs_stat *buf);
+int yaffs_lstat_reldev(struct yaffs_dev *dev, const YCHAR *path, struct yaffs_stat *buf);
+int yaffs_utime_reldev(struct yaffs_dev *dev, const YCHAR *path, const struct yaffs_utimbuf *buf);
+int yaffs_setxattr_reldev(struct yaffs_dev *dev, const YCHAR *path,
+                       const char *name, const void *data, int size, int flags);
+int yaffs_lsetxattr_reldev(struct yaffs_dev *dev, const YCHAR *path,
+                       const char *name, const void *data, int size, int flags);
+int yaffs_getxattr_reldev(struct yaffs_dev *dev, const YCHAR *path,
+                       const char *name, void *data, int size);
+int yaffs_lgetxattr_reldev(struct yaffs_dev *dev, const YCHAR *path,
+                       const char *name, void *data, int size);
+int yaffs_listxattr_reldev(struct yaffs_dev *dev, const YCHAR *path,
+                       char *data, int size);
+int yaffs_llistxattr_reldev(struct yaffs_dev *dev, const YCHAR *path,
+                       char *data, int size);
+int yaffs_removexattr_reldev(struct yaffs_dev *dev, const YCHAR *path,
+                       const char *name);
+int yaffs_lremovexattr_reldev(struct yaffs_dev *dev, const YCHAR *path,
+                       const char *name);
+int yaffs_access_reldev(struct yaffs_dev *dev, const YCHAR *path, int amode);
+int yaffs_chmod_reldev(struct yaffs_dev *dev, const YCHAR *path, mode_t mode);
+int yaffs_mkdir_reldev(struct yaffs_dev *dev, const YCHAR *path, mode_t mode);
+int yaffs_rmdir_reldev(struct yaffs_dev *dev, const YCHAR *path);
+yaffs_DIR *yaffs_opendir_reldev(struct yaffs_dev *dev, const YCHAR *dirname);
+int yaffs_symlink_reldev(struct yaffs_dev *dev,
+                       const YCHAR *oldpath, const YCHAR *newpath);
+int yaffs_readlink_reldev(struct yaffs_dev *dev, const YCHAR *path,
+                       YCHAR *buf, int bufsiz);
+int yaffs_link_reldev(struct yaffs_dev *dev,
+                       const YCHAR *oldpath, const YCHAR *linkpath);
+int yaffs_mknod_reldev(struct yaffs_dev *dev, const YCHAR *pathname,
+                    mode_t mode, dev_t dev_val);
+Y_LOFF_T yaffs_freespace_reldev(struct yaffs_dev *dev);
+Y_LOFF_T yaffs_totalspace_reldev(struct yaffs_dev *dev);
+
+/*
+ * yaffs_sync_reldev() does a full sync, including checkpoint.
+ * yaffs_sync_files_reldev() just flushes the cache and does not write a checkpoint.
+ */
+int yaffs_sync_reldev(struct yaffs_dev *dev);
+int yaffs_sync_files_reldev(struct yaffs_dev *dev);
+
+int yaffs_unmount_reldev(struct yaffs_dev *dev);
+int yaffs_unmount2_reldev(struct yaffs_dev *dev, int force);
+int yaffs_remount_reldev(struct yaffs_dev *dev, int force, int read_only);
+
+/*
+ *  Non standard function to get at objects.
+ */
+struct yaffs_obj * yaffs_get_obj_from_fd(int handle);
 
+/* Some non-standard functions to use fds to access directories */
+struct yaffs_dirent *yaffs_readdir_fd(int fd);
+void yaffs_rewinddir_fd(int fd);
+
+/* Non-standard functions to pump garbage collection. */
+int yaffs_do_background_gc(const YCHAR *path, int urgency);
+int yaffs_do_background_gc_reldev(struct yaffs_dev *dev, int urgency);
+
+/* Non-standard functions to get usage info */
 int yaffs_inodecount(const YCHAR *path);
 
+int yaffs_n_handles(const YCHAR *path);
+
+int yaffs_n_handles_reldir(struct yaffs_obj *reldir, const YCHAR *path);
+int yaffs_dump_dev_reldir(struct yaffs_obj *reldir, const YCHAR *path);
+int yaffs_n_handles_reldev(struct yaffs_dev *dev, const YCHAR *path);
+int yaffs_dump_dev_reldev(struct yaffs_dev *dev, const YCHAR *path);
+
+#ifdef CONFIG_YAFFS_WINCE
+int yaffs_set_wince_times(int fd,
+                       const unsigned *wctime,
+                       const unsigned *watime,
+                       const unsigned *wmtime);
+int yaffs_get_wince_times(int fd,
+                       unsigned *wctime,
+                       unsigned *watime,
+                       unsigned *wmtime);
+#endif
+
 
+#define YAFFS_SHARE_READ  1
+#define YAFFS_SHARE_WRITE 2
+int yaffs_open_sharing(const YCHAR *path, int oflag, int mode, int shareMode);
 
+struct yaffs_dev;
+void yaffs_add_device(struct yaffs_dev *dev);
 
-int yaffs_StartUp(void);
+int yaffs_start_up(void);
+int yaffsfs_GetLastError(void);
 
+/* Functions to iterate through devices. NB Use with extreme care! */
+void yaffs_dev_rewind(void);
+struct yaffs_dev *yaffs_next_dev(void);
+
+/* Function to get the last error */
+int yaffs_get_error(void);
+const char *yaffs_error_to_str(int err);
+
+/* Function only for debugging */
+void *yaffs_getdev(const YCHAR *path);
+int yaffs_dump_dev(const YCHAR *path);
+int yaffs_set_error(int error);
+
+/* Trace control functions */
+unsigned  yaffs_set_trace(unsigned tm);
+unsigned  yaffs_get_trace(void);
+
+
+#ifdef __cplusplus
+}
 #endif
 
 
+#endif