mirror of
https://github.com/ceph/ceph
synced 2025-04-01 23:02:17 +00:00
doc: Add doxygen style documentation for libcephfs
As well as doxygen doc, we document a few parts of the interface that are otherwise undocumented and don't match the standard calls. Signed-off-by: Sam Lang <sam.lang@inktank.com>
This commit is contained in:
Sam Lang
parent
9da5b537f2
commit
b83d38a16b
@ -53,141 +53,799 @@ struct CephContext;
|
||||
# define CEPH_SETATTR_CTIME 64
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @defgroup libcephfs_h_init Setup and Teardown
|
||||
* These are the first and last functions that should be called
|
||||
* when using libcephfs.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Get the version of libcephfs.
|
||||
*
|
||||
* The version number is major.minor.patch.
|
||||
*
|
||||
* @param major where to store the major version number
|
||||
* @param minor where to store the minor version number
|
||||
* @param extra where to store the extra version number
|
||||
*/
|
||||
const char *ceph_version(int *major, int *minor, int *patch);
|
||||
|
||||
/* initialization */
|
||||
/**
|
||||
* Create a mount handle for interacting with Ceph. All libcephfs
|
||||
* functions operate on a mount info handle.
|
||||
*
|
||||
* @param cmount the mount info handle to initialize
|
||||
* @param id the id of the client. This can be a unique id that identifies
|
||||
* this client, and will get appended onto "client.". Callers can
|
||||
* pass in NULL, and the id will be the process id of the client.
|
||||
* @returns 0 on success, negative error code on failure
|
||||
*/
|
||||
int ceph_create(struct ceph_mount_info **cmount, const char * const id);
|
||||
|
||||
/* initialization with an existing configuration */
|
||||
/**
|
||||
* Create a mount handle from a CephContext, which holds the configuration
|
||||
* for the ceph cluster. A CephContext can be acquired from an existing ceph_mount_info
|
||||
* handle, using the @ref ceph_get_mount_context call. Note that using the same CephContext
|
||||
* for two different mount handles results in the same client entity id being used.
|
||||
*
|
||||
* @param cmount the mount info handle to initialize
|
||||
* @param conf reuse this pre-existing CephContext config
|
||||
* @returns 0 on success, negative error code on failure
|
||||
*/
|
||||
int ceph_create_with_context(struct ceph_mount_info **cmount, struct CephContext *conf);
|
||||
|
||||
/* Activate the mount */
|
||||
/**
|
||||
* Perform a mount using the path for the root of the mount.
|
||||
*
|
||||
* @param cmount the mount info handle
|
||||
* @param root the path for the root of the mount. This can be an existing
|
||||
* directory within the ceph cluster, but most likely it will
|
||||
* be "/". Passing in NULL is equivalent to "/".
|
||||
* @returns 0 on success, negative error code on failure
|
||||
*/
|
||||
int ceph_mount(struct ceph_mount_info *cmount, const char *root);
|
||||
|
||||
/* Destroy the ceph mount instance */
|
||||
/**
|
||||
* Destroy the ceph mount handle. This should be called on completion of all
|
||||
* libcephfs functions.
|
||||
*
|
||||
* @param cmount the mount handle to shutdown
|
||||
*/
|
||||
void ceph_shutdown(struct ceph_mount_info *cmount);
|
||||
|
||||
/* Config
|
||||
/**
|
||||
* Extract the CephContext from the mount point handle.
|
||||
*
|
||||
* @param cmount the ceph mount handle to get the context from.
|
||||
* @returns the CephContext associated with the mount handle.
|
||||
*/
|
||||
struct CephContext *ceph_get_mount_context(struct ceph_mount_info *cmount);
|
||||
|
||||
/** @} init */
|
||||
|
||||
/**
|
||||
* @defgroup libcephfs_h_config Config
|
||||
* Functions for manipulating the Ceph configuration at runtime.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Load the ceph configuration from the specified config file.
|
||||
*
|
||||
* @param cmount the mount handle to load the configuration into.
|
||||
* @param path_list the configuration file path
|
||||
* @returns 0 on success, negative error code on failure
|
||||
*/
|
||||
int ceph_conf_read_file(struct ceph_mount_info *cmount, const char *path_list);
|
||||
|
||||
/**
|
||||
* Parse the command line arguments and load the configuration parameters.
|
||||
*
|
||||
* @param cmount the mount handle to load the configuration parameters into.
|
||||
* @param argc count of the arguments in argv
|
||||
* @param argv the argument list
|
||||
* @returns 0 on success, negative error code on failure
|
||||
*/
|
||||
int ceph_conf_parse_argv(struct ceph_mount_info *cmount, int argc, const char **argv);
|
||||
|
||||
/* Sets a configuration value from a string.
|
||||
* Returns 0 on success, error code otherwise. */
|
||||
/** Sets a configuration value from a string.
|
||||
*
|
||||
* @param cmount the mount handle to set the configuration value on
|
||||
* @param option the configuration option to set
|
||||
* @param value the value of the configuration option to set
|
||||
*
|
||||
* @returns 0 on success, negative error code otherwise.
|
||||
*/
|
||||
int ceph_conf_set(struct ceph_mount_info *cmount, const char *option, const char *value);
|
||||
|
||||
/* Returns a configuration value as a string.
|
||||
* If len is positive, that is the maximum number of bytes we'll write into the
|
||||
* buffer. If len == -1, we'll call malloc() and set *buf.
|
||||
* Returns 0 on success, error code otherwise. Returns ENAMETOOLONG if the
|
||||
* buffer is too short. */
|
||||
/**
|
||||
* Gets the configuration value as a string.
|
||||
*
|
||||
* @param cmount the mount handle to set the configuration value on
|
||||
* @param option the config option to get
|
||||
* @param buf the buffer to fill with the value
|
||||
* @param len the length of the buffer.
|
||||
* @returns the size of the buffer filled in with the value, or negative error code on failure
|
||||
*/
|
||||
int ceph_conf_get(struct ceph_mount_info *cmount, const char *option, char *buf, size_t len);
|
||||
|
||||
/** @} config */
|
||||
|
||||
/**
|
||||
* @defgroup libcephfs_h_fsops File System Operations.
|
||||
* Functions for getting/setting file system wide information specific to a particular
|
||||
* mount handle.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Perform a statfs on the ceph file system. This call fills in file system wide statistics
|
||||
* into the passed in buffer.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the statfs.
|
||||
* @param path can be any path within the mounted filesystem
|
||||
* @param stbuf the file system statistics filled in by this function.
|
||||
* @return 0 on success, negative error code otherwise.
|
||||
*/
|
||||
int ceph_statfs(struct ceph_mount_info *cmount, const char *path, struct statvfs *stbuf);
|
||||
|
||||
/* Get the current working directory.
|
||||
/**
|
||||
* Synchronize all filesystem data to persistent media.
|
||||
*
|
||||
* The pointer you get back from this function will continue to be valid until
|
||||
* the *next* call you make to ceph_getcwd, at which point it will be invalidated.
|
||||
* @param cmount the ceph mount handle to use for performing the sync_fs.
|
||||
* @returns 0 on success or negative error code on failure.
|
||||
*/
|
||||
int ceph_sync_fs(struct ceph_mount_info *cmount);
|
||||
|
||||
/**
|
||||
* Get the current working directory.
|
||||
*
|
||||
* @param cmount the ceph mount to get the current working directory for.
|
||||
* @returns the path to the current working directory
|
||||
*/
|
||||
const char* ceph_getcwd(struct ceph_mount_info *cmount);
|
||||
|
||||
/**
|
||||
* Change the current working directory.
|
||||
*
|
||||
* @param cmount the ceph mount to change the current working directory for.
|
||||
* @param path the path to the working directory to change into.
|
||||
* @returns 0 on success, negative error code otherwise.
|
||||
*/
|
||||
int ceph_chdir(struct ceph_mount_info *cmount, const char *s);
|
||||
|
||||
/** @} fsops */
|
||||
|
||||
/**
|
||||
* @defgroup libcephfs_h_dir Directory Operations.
|
||||
* Functions for manipulating and listing directories.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Open the given directory.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use to open the directory
|
||||
* @param name the path name of the directory to open. Must be either an absolute path
|
||||
* or a path relative to the current working directory.
|
||||
* @param dirpp the directory result pointer structure to fill in.
|
||||
* @returns 0 on success or negative error code otherwise.
|
||||
*/
|
||||
int ceph_opendir(struct ceph_mount_info *cmount, const char *name, struct ceph_dir_result **dirpp);
|
||||
|
||||
/**
|
||||
* Close the open directory.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for closing the directory
|
||||
* @param dirp the directory result pointer (set by ceph_opendir) to close
|
||||
* @returns 0 on success or negative error code on failure.
|
||||
*/
|
||||
int ceph_closedir(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp);
|
||||
|
||||
/**
|
||||
* Get the next entry in an open directory.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the readdir.
|
||||
* @param dirp the directory stream pointer from an opendir holding the state of the
|
||||
* next entry to return.
|
||||
* @returns the next directory entry or NULL if at the end of the directory (or the directory
|
||||
* is empty. This pointer should not be freed by the caller, and is only safe to
|
||||
* access between return and the next call to ceph_readdir or ceph_closedir.
|
||||
*/
|
||||
struct dirent * ceph_readdir(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp);
|
||||
|
||||
/**
|
||||
* A safe version of ceph_readdir, where the directory entry struct is allocated by the caller.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the readdir.
|
||||
* @param dirp the directory stream pointer from an opendir holding the state of the
|
||||
* next entry to return.
|
||||
* @param de the directory entry pointer filled in with the next directory entry of the dirp state.
|
||||
* @returns 1 if the next entry was filled in, 0 if the end of the directory stream was reached,
|
||||
* and a negative error code on failure.
|
||||
*/
|
||||
int ceph_readdir_r(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp, struct dirent *de);
|
||||
|
||||
/**
|
||||
* A safe version of ceph_readdir that also returns the file statistics (readdir+stat).
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the readdir_plus_r.
|
||||
* @param dirp the directory stream pointer from an opendir holding the state of the
|
||||
* next entry to return.
|
||||
* @param de the directory entry pointer filled in with the next directory entry of the dirp state.
|
||||
* @param st the stats of the file/directory of the entry returned
|
||||
* @param stmask a mask that gets filled in with the stats fields that are being set in the st parameter.
|
||||
* @returns 1 if the next entry was filled in, 0 if the end of the directory stream was reached,
|
||||
* and a negative error code on failure.
|
||||
*/
|
||||
int ceph_readdirplus_r(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp, struct dirent *de,
|
||||
struct stat *st, int *stmask);
|
||||
int ceph_getdents(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp, char *name, int buflen);
|
||||
|
||||
/**
|
||||
* This returns the used buffer space on success, -ERANGE if the buffer
|
||||
* is not large enough to hold a name, or -errno on other issues.
|
||||
* Gets multiple directory entries.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the getdents.
|
||||
* @param dirp the directory stream pointer from an opendir holding the state of the
|
||||
* next entry/entries to return.
|
||||
* @param name an array of struct dirent that gets filled in with the to fill returned directory entries into.
|
||||
* @param buflen the length of the buffer, which should be the number of dirent structs * sizeof(struct dirent).
|
||||
* @returns the length of the buffer that was filled in, will always be multiples of sizeof(struct dirent), or a
|
||||
* negative error code. If the buffer is not large enough for a single entry, -ERANGE is returned.
|
||||
*/
|
||||
int ceph_getdents(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp, char *name, int buflen);
|
||||
|
||||
/**
|
||||
* Gets multiple directory names.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the getdents.
|
||||
* @param dirp the directory stream pointer from an opendir holding the state of the
|
||||
* next entry/entries to return.
|
||||
* @param name a buffer to fill in with directory entry names.
|
||||
* @param buflen the length of the buffer that can be filled in.
|
||||
* @returns the length of the buffer filled in with entry names, or a negative error code on failure.
|
||||
* If the buffer isn't large enough for a single entry, -ERANGE is returned.
|
||||
*/
|
||||
int ceph_getdnames(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp, char *name, int buflen);
|
||||
|
||||
/**
|
||||
* Rewind the directory stream to the beginning of the directory.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the rewinddir.
|
||||
* @param dirp the directory stream pointer to rewind.
|
||||
*/
|
||||
void ceph_rewinddir(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp);
|
||||
|
||||
/**
|
||||
* Get the current position of a directory stream.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the telldir.
|
||||
* @param dirp the directory stream pointer to get the current position of.
|
||||
* @returns the position of the directory stream. Note that the offsets returned
|
||||
* by ceph_telldir do not have a particular order (cannot be compared with
|
||||
* inequality).
|
||||
*/
|
||||
loff_t ceph_telldir(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp);
|
||||
|
||||
/**
|
||||
* Move the directory stream to a position specified by the given offset.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the seekdir.
|
||||
* @param dirp the directory stream pointer to move.
|
||||
* @param offset the position to move the directory stream to. This offset should be
|
||||
* a value returned by seekdir. Note that this value does not refer to the nth
|
||||
* entry in a directory, and can not be manipulated with plus or minus.
|
||||
*/
|
||||
void ceph_seekdir(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp, loff_t offset);
|
||||
|
||||
int ceph_link(struct ceph_mount_info *cmount, const char *existing, const char *newname);
|
||||
int ceph_unlink(struct ceph_mount_info *cmount, const char *path);
|
||||
int ceph_rename(struct ceph_mount_info *cmount, const char *from, const char *to);
|
||||
|
||||
/* dirs */
|
||||
/**
|
||||
* Create a directory.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for making the directory.
|
||||
* @param path the path of the directory to create. This must be either an
|
||||
* absolute path or a relative path off of the current working directory.
|
||||
* @param mode the permissions the directory should have once created.
|
||||
* @returns 0 on success or a negative return code on error.
|
||||
*/
|
||||
int ceph_mkdir(struct ceph_mount_info *cmount, const char *path, mode_t mode);
|
||||
|
||||
/**
|
||||
* Create multiple directories at once.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for making the directories.
|
||||
* @param path the full path of directories and sub-directories that should
|
||||
* be created.
|
||||
* @param mode the permissions the directory should have once created.
|
||||
* @returns 0 on success or a negative return code on error.
|
||||
*/
|
||||
int ceph_mkdirs(struct ceph_mount_info *cmount, const char *path, mode_t mode);
|
||||
|
||||
/**
|
||||
* Remove a directory.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for removing directories.
|
||||
* @param path the path of the directory to remove.
|
||||
* @returns 0 on success or a negative return code on error.
|
||||
*/
|
||||
int ceph_rmdir(struct ceph_mount_info *cmount, const char *path);
|
||||
|
||||
/* symlinks */
|
||||
/** @} dir */
|
||||
|
||||
/**
|
||||
* @defgroup libcephfs_h_links Links and Link Handling.
|
||||
* Functions for creating and manipulating hard links and symbolic inks.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Create a link.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for creating the link.
|
||||
* @param existing the path to the existing file/directory to link to.
|
||||
* @param newname the path to the new file/directory to link from.
|
||||
* @returns 0 on success or a negative return code on error.
|
||||
*/
|
||||
int ceph_link(struct ceph_mount_info *cmount, const char *existing, const char *newname);
|
||||
|
||||
/**
|
||||
* Read a symbolic link.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for creating the link.
|
||||
* @param path the path to the symlink to read
|
||||
* @param buf the buffer to hold the the path of the file that the symlink points to.
|
||||
* @param size the length of the buffer
|
||||
* @returns 0 on success or negative error code on failure
|
||||
*/
|
||||
int ceph_readlink(struct ceph_mount_info *cmount, const char *path, char *buf, loff_t size);
|
||||
|
||||
/**
|
||||
* Creates a symbolic link.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for creating the symbolic link.
|
||||
* @param existing the path to the existing file/directory to link to.
|
||||
* @param newname the path to the new file/directory to link from.
|
||||
* @returns 0 on success or a negative return code on failure.
|
||||
*/
|
||||
int ceph_symlink(struct ceph_mount_info *cmount, const char *existing, const char *newname);
|
||||
|
||||
/* inode stuff */
|
||||
/** @} links */
|
||||
|
||||
/**
|
||||
* @defgroup libcephfs_h_files File manipulation and handling.
|
||||
* Functions for creating and manipulating files.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Removes a file, link, or symbolic link. If the file/link has multiple links to it, the
|
||||
* file will not disappear from the namespace until all references to it are removed.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the unlink.
|
||||
* @param path the path of the file or link to unlink.
|
||||
* @returns 0 on success or negative error code on failure.
|
||||
*/
|
||||
int ceph_unlink(struct ceph_mount_info *cmount, const char *path);
|
||||
|
||||
/**
|
||||
* Rename a file or directory.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the rename.
|
||||
* @param from the path to the existing file or directory.
|
||||
* @param to the new name of the file or directory
|
||||
* @returns 0 on success or negative error code on failure.
|
||||
*/
|
||||
int ceph_rename(struct ceph_mount_info *cmount, const char *from, const char *to);
|
||||
|
||||
/**
|
||||
* Get a file's statistics and attributes.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the stat.
|
||||
* @param path the file or directory to get the statistics of.
|
||||
* @param stbuf the stat struct that will be filled in with the file's statistics.
|
||||
* @returns 0 on success or negative error code on failure.
|
||||
*/
|
||||
int ceph_lstat(struct ceph_mount_info *cmount, const char *path, struct stat *stbuf);
|
||||
|
||||
/**
|
||||
* Set a file's attributes.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the setattr.
|
||||
* @param relpath the path to the file/directory to set the attributes of.
|
||||
* @param attr the stat struct that must include attribute values to set on the file.
|
||||
* @param mask a mask of all the stat values that have been set on the stat struct.
|
||||
* @returns 0 on success or negative error code on failure.
|
||||
*/
|
||||
int ceph_setattr(struct ceph_mount_info *cmount, const char *relpath, struct stat *attr, int mask);
|
||||
/**
|
||||
* Change the mode bits (permissions) of a file/directory.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the chmod.
|
||||
* @param path the path to the file/directory to change the mode bits on.
|
||||
* @param mode the new permissions to set.
|
||||
* @returns 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_chmod(struct ceph_mount_info *cmount, const char *path, mode_t mode);
|
||||
|
||||
/**
|
||||
* Change the ownership of a file/directory.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the chown.
|
||||
* @param path the path of the file/directory to change the ownership of.
|
||||
* @param uid the user id to set on the file/directory.
|
||||
* @param gid the group id to set on the file/directory.
|
||||
* @returns 0 on success or negative error code on failure.
|
||||
*/
|
||||
int ceph_chown(struct ceph_mount_info *cmount, const char *path, uid_t uid, gid_t gid);
|
||||
|
||||
/**
|
||||
* Change file/directory last access and modification times.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the utime.
|
||||
* @param path the path to the file/directory to set the time values of.
|
||||
* @param buf holding the access and modification times to set on the file.
|
||||
* @returns 0 on success or negative error code on failure.
|
||||
*/
|
||||
int ceph_utime(struct ceph_mount_info *cmount, const char *path, struct utimbuf *buf);
|
||||
|
||||
/**
|
||||
* Truncate the file to the given size. If this operation causes the
|
||||
* file to expand, the empty bytes will be filled in with zeros.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the truncate.
|
||||
* @param path the path to the file to truncate.
|
||||
* @param size the new size of the file.
|
||||
* @returns 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_truncate(struct ceph_mount_info *cmount, const char *path, loff_t size);
|
||||
|
||||
/* file ops */
|
||||
/**
|
||||
* Make a block or character special file.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the mknod.
|
||||
* @param path the path to the special file.
|
||||
* @param mode the permissions to use and the type of special file. The type can be
|
||||
* one of S_IFREG, S_IFCHR, S_IFBLK, S_IFIFO.
|
||||
* @param rdev If the file type is S_IFCHR or S_IFBLK then this parameter specifies the
|
||||
* major and minor numbers of the newly created device special file. Otherwise,
|
||||
* it is ignored.
|
||||
* @returns 0 on success or negative error code on failure.
|
||||
*/
|
||||
int ceph_mknod(struct ceph_mount_info *cmount, const char *path, mode_t mode, dev_t rdev);
|
||||
/**
|
||||
* Create and/or open a file.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the open.
|
||||
* @param path the path of the file to open. If the flags parameter includes O_CREAT,
|
||||
* the file will first be created before opening.
|
||||
* @param flags a set of option masks that control how the file is created/opened.
|
||||
* @param mode the permissions to place on the file if the file does not exist and O_CREAT
|
||||
* is specified in the flags.
|
||||
* @returns a non-negative file descriptor number on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_open(struct ceph_mount_info *cmount, const char *path, int flags, mode_t mode);
|
||||
|
||||
/**
|
||||
* Close the open file.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the close.
|
||||
* @param fd the file descriptor referring to the open file.
|
||||
* @returns 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_close(struct ceph_mount_info *cmount, int fd);
|
||||
|
||||
/**
|
||||
* Reposition the open file stream based on the given offset.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the lseek.
|
||||
* @param fd the open file descriptor referring to the open file and holding the
|
||||
* current position of the stream.
|
||||
* @param offset the offset to set the stream to
|
||||
* @param whence the flag to indicate what type of seeking to perform:
|
||||
* SEEK_SET: the offset is set to the given offset in the file.
|
||||
* SEEK_CUR: the offset is set to the current location plus @ref offset bytes.
|
||||
* SEEK_END: the offset is set to the end of the file plus @ref offset bytes.
|
||||
* @returns 0 on success or a negative error code on failure.
|
||||
*/
|
||||
loff_t ceph_lseek(struct ceph_mount_info *cmount, int fd, loff_t offset, int whence);
|
||||
/**
|
||||
* Read data from the file.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the read.
|
||||
* @param fd the file descriptor of the open file to read from.
|
||||
* @param buf the buffer to read data into
|
||||
* @param the initial size of the buffer
|
||||
* @param offset the offset in the file to read from. If this value is negative, the
|
||||
* function reads from the current offset of the file descriptor.
|
||||
* @returns the number of bytes read into buf, or a negative error code on failure.
|
||||
*/
|
||||
int ceph_read(struct ceph_mount_info *cmount, int fd, char *buf, loff_t size, loff_t offset);
|
||||
|
||||
/**
|
||||
* Write data to a file.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the write.
|
||||
* @param fd the file descriptor of the open file to write to
|
||||
* @param buf the bytes to write to the file
|
||||
* @param size the size of the buf array
|
||||
* @param offset the offset of the file write into. If this value is negative, the
|
||||
* function writes to the current offset of the file descriptor.
|
||||
* @returns the number of bytes written, or a negative error code
|
||||
*/
|
||||
int ceph_write(struct ceph_mount_info *cmount, int fd, const char *buf, loff_t size,
|
||||
loff_t offset);
|
||||
|
||||
/**
|
||||
* Truncate a file to the given size.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the ftruncate.
|
||||
* @param fd the file descriptor of the file to truncate
|
||||
* @param size the new size of the file
|
||||
* @returns 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_ftruncate(struct ceph_mount_info *cmount, int fd, loff_t size);
|
||||
|
||||
/**
|
||||
* Synchronize an open file to persistent media.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the fsync.
|
||||
* @param fd the file descriptor of the file to sync.
|
||||
* @param syncdataonly a boolean whether to synchronize metadata and data (0)
|
||||
* or just data (1).
|
||||
* @return 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_fsync(struct ceph_mount_info *cmount, int fd, int syncdataonly);
|
||||
|
||||
/**
|
||||
* Get the open file's statistics.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the fstat.
|
||||
* @param fd the file descriptor of the file to get statistics of.
|
||||
* @param stbuf the stat struct of the file's statistics, filled in by the
|
||||
* function.
|
||||
* @returns 0 on success or a negative error code on failure
|
||||
*/
|
||||
int ceph_fstat(struct ceph_mount_info *cmount, int fd, struct stat *stbuf);
|
||||
|
||||
int ceph_sync_fs(struct ceph_mount_info *cmount);
|
||||
/** @} file */
|
||||
|
||||
/* xattr support */
|
||||
/**
|
||||
* @defgroup libcephfs_h_xattr Extended Attribute manipulation and handling.
|
||||
* Functions for creating and manipulating extended attributes on files.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Get an extended attribute.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the getxattr.
|
||||
* @param path the path to the file
|
||||
* @param name the name of the extended attribute to get
|
||||
* @param value a pre-allocated buffer to hold the xattr's value
|
||||
* @param size the size of the pre-allocated buffer
|
||||
* @returns the size of the value or a negative error code on failure.
|
||||
*/
|
||||
int ceph_getxattr(struct ceph_mount_info *cmount, const char *path, const char *name,
|
||||
void *value, size_t size);
|
||||
|
||||
/**
|
||||
* Get an extended attribute and follow symbolic links. This function is
|
||||
* identical to ceph_getxattr, but if the path refers to a symbolic link,
|
||||
* we get the extended attributes of the link target rather than the attributes
|
||||
* of the link itself.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the lgetxattr.
|
||||
* @param path the path to the file
|
||||
* @param name the name of the extended attribute to get
|
||||
* @param value a pre-allocated buffer to hold the xattr's value
|
||||
* @param size the size of the pre-allocated buffer
|
||||
* @returns the size of the value or a negative error code on failure.
|
||||
*/
|
||||
int ceph_lgetxattr(struct ceph_mount_info *cmount, const char *path, const char *name,
|
||||
void *value, size_t size);
|
||||
|
||||
/**
|
||||
* List the extended attribute keys on a file.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the listxattr.
|
||||
* @param path the path to the file.
|
||||
* @param list a buffer to be filled in with the list of extended attributes keys.
|
||||
* @param size the size of the list buffer.
|
||||
* @returns the size of the resulting list filled in.
|
||||
*/
|
||||
int ceph_listxattr(struct ceph_mount_info *cmount, const char *path, char *list, size_t size);
|
||||
|
||||
/**
|
||||
* Get the list of extended attribute keys on a file, following symbolic links.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the llistxattr.
|
||||
* @param path the path to the file.
|
||||
* @param list a buffer to be filled in with the list of extended attributes keys.
|
||||
* @param size the size of the list buffer.
|
||||
* @returns the size of the resulting list filled in.
|
||||
*/
|
||||
int ceph_llistxattr(struct ceph_mount_info *cmount, const char *path, char *list, size_t size);
|
||||
|
||||
/**
|
||||
* Remove an extended attribute from a file.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the removexattr.
|
||||
* @param path the path to the file.
|
||||
* @param name the name of the extended attribute to remove.
|
||||
* @returns 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_removexattr(struct ceph_mount_info *cmount, const char *path, const char *name);
|
||||
|
||||
/**
|
||||
* Remove the extended attribute from a file, following symbolic links.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the lremovexattr.
|
||||
* @param path the path to the file.
|
||||
* @param name the name of the extended attribute to remove.
|
||||
* @returns 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_lremovexattr(struct ceph_mount_info *cmount, const char *path, const char *name);
|
||||
|
||||
/**
|
||||
* Set an extended attribute on a file.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the setxattr.
|
||||
* @param path the path to the file.
|
||||
* @param name the name of the extended attribute to set.
|
||||
* @param value the bytes of the extended attribute value
|
||||
* @param size the size of the extended attribute value
|
||||
* @param flags the flags can be:
|
||||
* CEPH_XATTR_CREATE: create the extended attribute. Must not exist.
|
||||
* CEPH_XATTR_REPLACE: replace the extended attribute, Must already exist.
|
||||
* @returns 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_setxattr(struct ceph_mount_info *cmount, const char *path, const char *name,
|
||||
const void *value, size_t size, int flags);
|
||||
|
||||
/**
|
||||
* Set an extended attribute on a file, following symbolic links.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use for performing the lsetxattr.
|
||||
* @param path the path to the file.
|
||||
* @param name the name of the extended attribute to set.
|
||||
* @param value the bytes of the extended attribute value
|
||||
* @param size the size of the extended attribute value
|
||||
* @param flags the flags can be:
|
||||
* CEPH_XATTR_CREATE: create the extended attribute. Must not exist.
|
||||
* CEPH_XATTR_REPLACE: replace the extended attribute, Must already exist.
|
||||
* @returns 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_lsetxattr(struct ceph_mount_info *cmount, const char *path, const char *name,
|
||||
const void *value, size_t size, int flags);
|
||||
|
||||
/** @} xattr */
|
||||
|
||||
/**
|
||||
* @defgroup libcephfs_h_filelayout Control File Layout.
|
||||
* Functions for setting and getting the file layout of existing files.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/* expose file layout */
|
||||
/**
|
||||
* Get the file striping unit.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use.
|
||||
* @param fh the open file descriptor referring to the file to get the striping unit of.
|
||||
* @returns the striping unit of the file or a negative error code on failure.
|
||||
*/
|
||||
int ceph_get_file_stripe_unit(struct ceph_mount_info *cmount, int fh);
|
||||
|
||||
/**
|
||||
* Get the file pool information.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use.
|
||||
* @param fh the open file descriptor referring to the file to get the striping unit of.
|
||||
* @returns the ceph pool id that the file is in
|
||||
*/
|
||||
int ceph_get_file_pool(struct ceph_mount_info *cmount, int fh);
|
||||
|
||||
/**
|
||||
* Get the file replication information.
|
||||
* @param cmount the ceph mount handle to use.
|
||||
* @param fh the open file descriptor referring to the file to get the striping unit of.
|
||||
* @returns the replication factor of the file.
|
||||
*/
|
||||
int ceph_get_file_replication(struct ceph_mount_info *cmount, int fh);
|
||||
|
||||
/**
|
||||
* Get the OSD address where the primary copy of a file stripe is located.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use.
|
||||
* @param fd the open file descriptor referring to the file to get the striping unit of.
|
||||
* @param offset the offset into the file to specify the stripe. The offset can be
|
||||
* anywhere within the stripe unit.
|
||||
* @param addr the address of the OSD holding that stripe
|
||||
* @param naddr the capacity of the address passed in.
|
||||
* @returns the size of the addressed filled into the @ref addr parameter, or a negative
|
||||
* error code on failure.
|
||||
*/
|
||||
int ceph_get_file_stripe_address(struct ceph_mount_info *cmount, int fd, loff_t offset,
|
||||
struct sockaddr_storage *addr, int naddr);
|
||||
|
||||
/* set default layout for new files */
|
||||
/** @} filelayout */
|
||||
|
||||
/**
|
||||
* @defgroup libcephfs_h_default_filelayout Control the Default File Layout.
|
||||
* Functions for setting and getting the default file layout for new files.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Set the default stripe unit of files created in this mount.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use.
|
||||
* @param stripe the stripe size to use
|
||||
* @returns 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_set_default_file_stripe_unit(struct ceph_mount_info *cmount, int stripe);
|
||||
|
||||
/**
|
||||
* Set the default stripe count of files created in this mount.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use.
|
||||
* @param count the stripe count to use
|
||||
* @returns 0 on success or a negative error code on failure.
|
||||
*/
|
||||
int ceph_set_default_file_stripe_count(struct ceph_mount_info *cmount, int count);
|
||||
|
||||
/**
|
||||
* Set the default object size to use for striping.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use.
|
||||
* @param size the default size for objects
|
||||
* @returns 0 on success or a negative error code on failure
|
||||
*/
|
||||
int ceph_set_default_object_size(struct ceph_mount_info *cmount, int size);
|
||||
|
||||
/**
|
||||
* No longer available. Do not use.
|
||||
* Set the default preferred placement group. This option will return
|
||||
* -EOPNOTSUPP as it is no longer supported.
|
||||
*/
|
||||
int ceph_set_default_preferred_pg(struct ceph_mount_info *cmount, int osd);
|
||||
|
||||
/**
|
||||
* Set the default file replication factor.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use.
|
||||
* @param replication the default replication factor for files in this filesystem.
|
||||
* @returns 0 on success or negative error code on failure.
|
||||
*/
|
||||
int ceph_set_default_file_replication(struct ceph_mount_info *cmount, int replication);
|
||||
|
||||
/* read from local replicas when possible */
|
||||
/**
|
||||
* Read from local replicas when possible.
|
||||
*
|
||||
* @param cmount the ceph mount handle to use.
|
||||
* @param val a boolean to set (1) or clear (0) the option to favor local objects
|
||||
* for reads.
|
||||
* @returns 0
|
||||
*/
|
||||
int ceph_localize_reads(struct ceph_mount_info *cmount, int val);
|
||||
|
||||
/* return osd on local node, if any */
|
||||
/**
|
||||
* Get the osd id of the local osd (if any)
|
||||
*
|
||||
* @param cmount the ceph mount handle to use.
|
||||
* @returns the osd (if any) local to the node where this call is made, otherwise
|
||||
* -1 is returned.
|
||||
*/
|
||||
int ceph_get_local_osd(struct ceph_mount_info *cmount);
|
||||
|
||||
/* Get the CephContext of this mount */
|
||||
struct CephContext *ceph_get_mount_context(struct ceph_mount_info *cmount);
|
||||
/** @} default_filelayout */
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user