The whole Storage Kit now uses syscalls directly. No further need of this abstraction layer.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@8693 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Ingo Weinhold
parent
5090f23182
commit
233e6dadef
|
|
@ -1,357 +0,0 @@
|
||||||
//----------------------------------------------------------------------
|
|
||||||
// This software is part of the OpenBeOS distribution and is covered
|
|
||||||
// by the OpenBeOS license.
|
|
||||||
//---------------------------------------------------------------------
|
|
||||||
/*!
|
|
||||||
\file kernel_interface.h
|
|
||||||
This is the private interface used by the Storage Kit
|
|
||||||
to communicate with the kernel
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef _STORAGE_KIT_KERNEL_INTERFACE_H
|
|
||||||
#define _STORAGE_KIT_KERNEL_INTERFACE_H
|
|
||||||
|
|
||||||
#include <SupportKit.h>
|
|
||||||
#include <StorageDefs.Private.h>
|
|
||||||
|
|
||||||
// For typedefs
|
|
||||||
#include <sys/dirent.h> // For dirent
|
|
||||||
#include <sys/stat.h> // For struct stat
|
|
||||||
#include <fcntl.h> // For flock
|
|
||||||
#include <fs_info.h> // File sytem information functions, structs, defines
|
|
||||||
|
|
||||||
// Forward Declarations
|
|
||||||
typedef struct attr_info;
|
|
||||||
typedef struct entry_ref;
|
|
||||||
|
|
||||||
//! Private Storage Kit Namespace
|
|
||||||
/*! Encompasses the functions used internally by the Storage Kit to
|
|
||||||
interface with the kernel, as well as various internal support functions,
|
|
||||||
data types, and type aliases. */
|
|
||||||
namespace BPrivate {
|
|
||||||
namespace Storage {
|
|
||||||
|
|
||||||
// Type aliases
|
|
||||||
typedef dirent DirEntry;
|
|
||||||
typedef struct flock FileLock;
|
|
||||||
typedef struct stat Stat;
|
|
||||||
typedef uint32 StatMember;
|
|
||||||
typedef attr_info AttrInfo;
|
|
||||||
typedef int OpenFlags; // open() flags
|
|
||||||
typedef mode_t CreationFlags; // open() mode
|
|
||||||
typedef int SeekMode; // lseek() mode
|
|
||||||
|
|
||||||
// For convenience:
|
|
||||||
struct LongDirEntry : DirEntry { char _buffer[B_FILE_NAME_LENGTH]; };
|
|
||||||
|
|
||||||
// Constants -- POSIX versions
|
|
||||||
const FileDescriptor NullFd = -1;
|
|
||||||
|
|
||||||
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
// Device Functions
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
/*! Returns information about the file system on the specified device. */
|
|
||||||
status_t stat_dev(dev_t dev, fs_info* info);
|
|
||||||
|
|
||||||
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
// File Functions
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
/*! \brief Opens the filesystem entry specified by path.
|
|
||||||
|
|
||||||
Returns a
|
|
||||||
new file descriptor if successful, -1 otherwise. This version
|
|
||||||
fails if the given file does not exist, or if you specify
|
|
||||||
O_CREAT as one of the flags (use the four argument version
|
|
||||||
of BPrivate::Storage::open() if you wish to create the file when
|
|
||||||
it doesn't already exist). */
|
|
||||||
status_t open(const char *path, OpenFlags flags, FileDescriptor &result);
|
|
||||||
|
|
||||||
/*! \brief Same as the first version, but tries to open read-only, if
|
|
||||||
first the attempt failed with B_READ_ONLY_DEVICE or
|
|
||||||
B_PERMISSION_DENIED and \a fallBackToReadOnly is \c true.
|
|
||||||
*/
|
|
||||||
status_t open(const char *path, OpenFlags flags, FileDescriptor &result,
|
|
||||||
bool fallBackToReadOnly);
|
|
||||||
|
|
||||||
/*! \brief Same as the first version of open() except the file is created with the
|
|
||||||
permissions given by creationFlags if it doesn't exist. */
|
|
||||||
status_t open(const char *path, OpenFlags flags, CreationFlags creationFlags,
|
|
||||||
FileDescriptor &result);
|
|
||||||
|
|
||||||
/*! \brief Same as the third version, but tries to open read-only, if
|
|
||||||
first the attempt failed with B_READ_ONLY_DEVICE or
|
|
||||||
B_PERMISSION_DENIED and \a fallBackToReadOnly is \c true.
|
|
||||||
*/
|
|
||||||
status_t open(const char *path, OpenFlags flags, CreationFlags creationFlags,
|
|
||||||
FileDescriptor &result, bool fallBackToReadOnly);
|
|
||||||
|
|
||||||
/*! \brief Closes a previously open()ed file. */
|
|
||||||
status_t close( FileDescriptor file );
|
|
||||||
|
|
||||||
//! Reads data from a file into a buffer.
|
|
||||||
ssize_t read(FileDescriptor fd, void *buf, size_t len);
|
|
||||||
|
|
||||||
//! Reads data from a certain position in a file into a buffer.
|
|
||||||
ssize_t read(FileDescriptor fd, void *buf, off_t pos, size_t len);
|
|
||||||
|
|
||||||
//! Writes data from a buffer into a file.
|
|
||||||
ssize_t write(FileDescriptor fd, const void *buf, size_t len);
|
|
||||||
|
|
||||||
//! Writes data from a buffer to a certain position in a file.
|
|
||||||
ssize_t write(FileDescriptor fd, const void *buf, off_t pos, size_t len);
|
|
||||||
|
|
||||||
//! Moves a file's read/write pointer.
|
|
||||||
off_t seek(FileDescriptor fd, off_t pos, SeekMode mode);
|
|
||||||
|
|
||||||
//! Returns the position of a file's read/write pointer.
|
|
||||||
off_t get_position(FileDescriptor fd);
|
|
||||||
|
|
||||||
/*! \brief Returns a new file descriptor that refers to the same file as
|
|
||||||
that specified, or -1 if unsuccessful. Remember to call close
|
|
||||||
on the file descriptor when through with it. */
|
|
||||||
FileDescriptor dup(FileDescriptor file);
|
|
||||||
|
|
||||||
/*! \brief Similar to the first version, aside from that an error code is
|
|
||||||
returned and the resulting file descriptor is passed back via a reference
|
|
||||||
parameter. */
|
|
||||||
status_t dup(FileDescriptor file, FileDescriptor& result);
|
|
||||||
|
|
||||||
/*! \brief Flushes any buffers associated with the given file to disk
|
|
||||||
and then returns. */
|
|
||||||
status_t sync(FileDescriptor file);
|
|
||||||
|
|
||||||
//! Locks the given file so it may not be accessed by anyone else.
|
|
||||||
status_t lock(FileDescriptor file, OpenFlags mode, FileLock *lock);
|
|
||||||
|
|
||||||
//! Unlocks a file previously locked with lock().
|
|
||||||
status_t unlock(FileDescriptor file, FileLock *lock);
|
|
||||||
|
|
||||||
//! Returns statistical information for the given file.
|
|
||||||
status_t get_stat(const char *path, Stat *s);
|
|
||||||
status_t get_stat(FileDescriptor file, Stat *s);
|
|
||||||
status_t get_stat(entry_ref &ref, Stat *s);
|
|
||||||
|
|
||||||
//! Modifies a given portion of the file's statistical information.
|
|
||||||
status_t set_stat(FileDescriptor file, Stat &s, StatMember what);
|
|
||||||
|
|
||||||
//! Same as the other version of set_stat(), except the file is specified by name.
|
|
||||||
status_t set_stat(const char *filename, Stat &s, StatMember what);
|
|
||||||
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
// Attribute Functions
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
/*! \brief Reads the data from the specified attribute into the given buffer of size
|
|
||||||
count. Returns the number of bytes actually read. */
|
|
||||||
ssize_t read_attr(FileDescriptor file, const char *attribute, uint32 type,
|
|
||||||
off_t pos, void *buf, size_t count );
|
|
||||||
|
|
||||||
//! Write count bytes from the given data buffer into the specified attribute.
|
|
||||||
ssize_t write_attr(FileDescriptor file, const char *attribute, uint32 type,
|
|
||||||
off_t pos, const void *buf, size_t count);
|
|
||||||
|
|
||||||
//! Renames the specified attribute.
|
|
||||||
status_t rename_attr(FileDescriptor file, const char *oldName,
|
|
||||||
const char *newName);
|
|
||||||
|
|
||||||
//! Removes the specified attribute and any data associated with it.
|
|
||||||
status_t remove_attr(FileDescriptor file, const char *attr);
|
|
||||||
|
|
||||||
//! Returns statistical information about the given attribute. */
|
|
||||||
status_t stat_attr(FileDescriptor file, const char *name, AttrInfo *ai);
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
// Attribute Directory Functions
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
/*! Opens the attribute directory of a given file. */
|
|
||||||
status_t open_attr_dir(FileDescriptor file, FileDescriptor &result);
|
|
||||||
|
|
||||||
/*! Rewinds the given attribute directory. */
|
|
||||||
status_t rewind_attr_dir(FileDescriptor dir);
|
|
||||||
|
|
||||||
/*! Returns the next item in the given attribute directory, or
|
|
||||||
B_ENTRY_NOT_FOUND if at the end of the list. */
|
|
||||||
status_t read_attr_dir(FileDescriptor dir, DirEntry &buffer);
|
|
||||||
|
|
||||||
/*! Closes an attribute directory previously opened with open_attr_dir(). */
|
|
||||||
status_t close_attr_dir(FileDescriptor dir);
|
|
||||||
|
|
||||||
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
// Directory Functions
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
/*! \brief Opens the given directory. Sets result to a properly "unitialized" directory
|
|
||||||
if the function fails. */
|
|
||||||
status_t open_dir(const char *path, FileDescriptor &result);
|
|
||||||
|
|
||||||
//! Creates a new directory.
|
|
||||||
status_t create_dir(const char *path,
|
|
||||||
mode_t mode = S_IRWXU | S_IRWXG | S_IRWXU);
|
|
||||||
|
|
||||||
//! Creates a new directory and opens it.
|
|
||||||
status_t create_dir(const char *path, FileDescriptor &result,
|
|
||||||
mode_t mode = S_IRWXU | S_IRWXG | S_IRWXU);
|
|
||||||
|
|
||||||
//! Returns the next entries in the given directory.
|
|
||||||
int32 read_dir(FileDescriptor dir, DirEntry *buffer, size_t length,
|
|
||||||
int32 count = INT_MAX);
|
|
||||||
|
|
||||||
/*! Rewindes the directory to the first entry in the list. */
|
|
||||||
status_t rewind_dir(FileDescriptor dir);
|
|
||||||
|
|
||||||
/*! Iterates through the given directory searching for an entry whose name
|
|
||||||
matches that given by name. On success, places the DirEntry in result
|
|
||||||
and returns B_OK. On failures, returns an error code and sets result to
|
|
||||||
BPrivate::Storage::NullDir.
|
|
||||||
|
|
||||||
<b>Note:</b> This call modifies the internal position marker of dir. */
|
|
||||||
status_t find_dir(FileDescriptor dir, const char *name, DirEntry *result,
|
|
||||||
size_t length);
|
|
||||||
|
|
||||||
/*! Calls the other version of BPrivate::Storage::find_dir() and stores the results
|
|
||||||
in the given entry_ref. */
|
|
||||||
status_t find_dir(FileDescriptor dir, const char *name, entry_ref *result);
|
|
||||||
|
|
||||||
/*! Creates a duplicated of the given directory and places it in result if successful,
|
|
||||||
returning B_OK. Returns an error code and sets result to -1 if
|
|
||||||
unsuccessful. */
|
|
||||||
status_t dup_dir(FileDescriptor dir, FileDescriptor &result);
|
|
||||||
|
|
||||||
/*! Closes the given directory. */
|
|
||||||
status_t close_dir(FileDescriptor dir);
|
|
||||||
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
// SymLink functions
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
//! Creates a new symbolic link.
|
|
||||||
status_t create_link(const char *path, const char *linkToPath);
|
|
||||||
|
|
||||||
//! Creates a new symbolic link and opens it.
|
|
||||||
status_t create_link(const char *path, const char *linkToPath,
|
|
||||||
FileDescriptor &result);
|
|
||||||
|
|
||||||
/*! If path refers to a symlink, the pathname of the target to which path
|
|
||||||
is linked is copied into result and NULL terminated, if the buffer is
|
|
||||||
long enough, the path is being truncated at size chars if necessary
|
|
||||||
(a buffer of size B_PATH_NAME_LENGTH is a good idea), and the number of
|
|
||||||
chars in the target pathname is returned. If size is less than 1 or result
|
|
||||||
is NULL, B_BAD_VALUE will be returned and result will remain unmodified.
|
|
||||||
For any other error, result is set to an empty string and an error code
|
|
||||||
is returned. */
|
|
||||||
ssize_t read_link(const char *path, char *result, size_t size);
|
|
||||||
|
|
||||||
/*! Similar to the first version. Instead of a path name, a file descriptor
|
|
||||||
of the symbolic link is supplied.
|
|
||||||
*/
|
|
||||||
ssize_t read_link(FileDescriptor fd, char *result, size_t size);
|
|
||||||
|
|
||||||
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
// Query Functions
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
/*! \brief Opens a query. Sets result to a properly "unitialized" query
|
|
||||||
if the function fails. */
|
|
||||||
status_t open_query(dev_t device, const char *query, uint32 flags,
|
|
||||||
FileDescriptor &result);
|
|
||||||
|
|
||||||
/*! \brief Opens a live query. Sets result to a properly "unitialized" query
|
|
||||||
if the function fails. */
|
|
||||||
status_t open_live_query(dev_t device, const char *query, uint32 flags,
|
|
||||||
port_id port, int32 token, FileDescriptor &result);
|
|
||||||
|
|
||||||
//! Returns the next entries in the given query.
|
|
||||||
int32 read_query(FileDescriptor query, DirEntry *buffer, size_t length,
|
|
||||||
int32 count = INT_MAX);
|
|
||||||
|
|
||||||
/*! Closes the given query. */
|
|
||||||
status_t close_query(FileDescriptor dir);
|
|
||||||
|
|
||||||
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
// Miscellaneous Functions
|
|
||||||
//------------------------------------------------------------------------------
|
|
||||||
/*! Converts the given entry_ref into an absolute pathname, returning
|
|
||||||
the result in the string of length size pointed to by result (a size
|
|
||||||
of B_PATH_NAME_LENGTH is a good idea).
|
|
||||||
|
|
||||||
Returns B_OK if successful.
|
|
||||||
|
|
||||||
If ref or result is NULL, B_BAD_VALUE is returned. Otherwise,
|
|
||||||
an error code is returned. The state of result after an error is undefined.
|
|
||||||
*/
|
|
||||||
status_t entry_ref_to_path(const struct entry_ref *ref, char *result,
|
|
||||||
size_t size);
|
|
||||||
|
|
||||||
/*! See the other definition of entry_ref_to_path() */
|
|
||||||
status_t entry_ref_to_path(dev_t device, ino_t directory, const char *name,
|
|
||||||
char *result, size_t size);
|
|
||||||
|
|
||||||
/*! Converts the given directory into an entry_ref. Note that the entry_ref is
|
|
||||||
actually a reference to the file "." in the given directory.
|
|
||||||
|
|
||||||
Returns B_OK if successful.
|
|
||||||
|
|
||||||
If dir is < 0 or result is NULL, B_BAD_VALUE is returned.
|
|
||||||
Otherwise, an appropriate error code is returned.
|
|
||||||
*/
|
|
||||||
status_t dir_to_self_entry_ref(FileDescriptor dir, entry_ref *result);
|
|
||||||
|
|
||||||
|
|
||||||
/*! Converts the given directory into an absolute pathname, returning the
|
|
||||||
result in the string of length size pointed to by result (a size of
|
|
||||||
B_PATH_NAME_LENGTH is a good idea).
|
|
||||||
|
|
||||||
Returns B_OK if successful.
|
|
||||||
|
|
||||||
If dir is < 0 or result is NULL, B_BAD_VALUE
|
|
||||||
is returned. Otherwise, an error code is returned. The state of result after
|
|
||||||
an error is undefined.
|
|
||||||
*/
|
|
||||||
status_t dir_to_path( FileDescriptor dir, char *result, size_t size );
|
|
||||||
|
|
||||||
/*! \brief Returns the canonical representation of a given path referring to an
|
|
||||||
potentially abstract entry in an existing directory. */
|
|
||||||
status_t get_canonical_path(const char *path, char *result, size_t size);
|
|
||||||
|
|
||||||
/*! \brief Returns the canonical representation of a given path referring to an
|
|
||||||
potentially abstract entry in an existing directory. */
|
|
||||||
status_t get_canonical_path(const char *path, char *&result);
|
|
||||||
|
|
||||||
/*! \brief Returns the canonical representation of a given path referring to an
|
|
||||||
existing directory. */
|
|
||||||
status_t get_canonical_dir_path(const char *path, char *result, size_t size);
|
|
||||||
|
|
||||||
/*! \brief Returns the canonical representation of a given path referring to an
|
|
||||||
existing directory. */
|
|
||||||
status_t get_canonical_dir_path(const char *path, char *&result);
|
|
||||||
|
|
||||||
/*! \brief Returns the path of this application.
|
|
||||||
The supplied buffer must be at least B_PATH_NAME_LENGTH + 1 bytes long.
|
|
||||||
The result will be null terminated.
|
|
||||||
*/
|
|
||||||
status_t get_app_path(char *buffer);
|
|
||||||
|
|
||||||
/*! Returns true if the given entry_ref represents the root directory, false otherwise. */
|
|
||||||
bool entry_ref_is_root_dir(const entry_ref *ref);
|
|
||||||
|
|
||||||
//! Returns true if the given device is the root device, false otherwise
|
|
||||||
bool device_is_root_device(dev_t device);
|
|
||||||
|
|
||||||
/*! Renames oldPath to newPath, replacing newPath if it exists. */
|
|
||||||
status_t rename(const char *oldPath, const char *newPath);
|
|
||||||
|
|
||||||
/*! Removes path from the filesystem. */
|
|
||||||
status_t remove(const char *path);
|
|
||||||
|
|
||||||
//! Sets the name of a volume.
|
|
||||||
status_t set_volume_name(dev_t device, const char *name);
|
|
||||||
|
|
||||||
}; // namespace Storage
|
|
||||||
}; // namespace BPrivate
|
|
||||||
|
|
||||||
#endif // _STORAGE_KIT_KERNEL_INTERFACE_H
|
|
||||||
|
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue