gmc.git - Gluster Management Console

path: root/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_charts_prefs.html

diff options

author	Shireesh Anjal <shireesh@gluster.com>	2011-08-24 16:07:25 +0530
committer	Shireesh Anjal <shireesh@gluster.com>	2011-08-24 16:07:25 +0530
commit	9f70d6a534e74739de4affa261ca9137784f9a12 (patch)
tree	f5695feb4482301f64021e89f41daa7e523eaa44 /src/com.gluster.storage.management.console.help/html/gettingstarted/setting_charts_prefs.html
parent	c0a91164dbc80e4d5259c02f169bf8020fc85c39 (diff)

Updated help contents - added note about GlusterFS minumum version (3.2.3) required

Diffstat (limited to 'src/com.gluster.storage.management.console.help/html/gettingstarted/setting_charts_prefs.html')

0 files changed, 0 insertions, 0 deletions

HROW GFAPI_PUBLIC(glfs_init, 3.4.0); /* SYNOPSIS glfs_fini: Cleanup and destroy the 'virtual mount' DESCRIPTION This function attempts to gracefully destroy glfs_t object. An attempt is made to wait for all background processing to complete before returning. glfs_fini() must be called after all operations on glfs_t is finished. IMPORTANT IT IS NECESSARY TO CALL glfs_fini() ON ALL THE INITIALIZED glfs_t OBJECTS BEFORE TERMINATING THE PROGRAM. THERE MAY BE CACHED AND UNWRITTEN / INCOMPLETE OPERATIONS STILL IN PROGRESS EVEN THOUGH THE API CALLS HAVE RETURNED. glfs_fini() WILL WAIT FOR BACKGROUND OPERATIONS TO COMPLETE BEFORE RETURNING, THEREBY MAKING IT SAFE FOR THE PROGRAM TO EXIT. PARAMETERS @fs: The 'virtual mount' object to be destroyed. RETURN VALUES 0 : Success. */ int glfs_fini(glfs_t *fs) __THROW GFAPI_PUBLIC(glfs_fini, 3.4.0); /* SYNOPSIS glfs_getvol: Get the volfile associated with a 'virtual mount' DESCRIPTION Sometimes it's useful e.g. for scripts to see the volfile, so that they can parse it and find subvolumes to do things like split-brain resolution or custom layouts. The API here was specifically intended to make access e.g. from Python as simple as possible. Note that the volume must be started (not necessarily mounted) for this to work. PARAMETERS @fs: The 'virtual mount' object for which a volfile is desired @buf: Pointer to a place for the volfile length to be stored @len: Length of @buf RETURN VALUES >0: filled N bytes of buffer 0: no volfile available <0: volfile length exceeds @len by N bytes (@buf unchanged) */ ssize_t glfs_get_volfile(glfs_t *fs, void *buf, size_t len) __THROW GFAPI_PUBLIC(glfs_get_volfile, 3.6.0); /* SYNOPSIS glfs_get_volumeid: Copy the Volume UUID stored in the glfs object fs. DESCRIPTION This function when invoked for the first time sends RPC call to the the management server (glusterd) to fetch volume uuid and stores it in the glusterfs_context linked to the glfs object fs which can be used in the subsequent calls. Later it parses that UUID to convert it from canonical string format into an opaque byte array and copy it into the volid array. In case if either of the input parameters, volid or size, is NULL, number of bytes required to copy the volume UUID is returned. PARAMETERS @fs: The 'virtual mount' object to be used to retrieve and store volume's UUID. @volid: Pointer to a place for the volume UUID to be stored @size: Length of @volid RETURN VALUES -1 : Failure. @errno will be set with the type of failure. Others : length of the volume UUID stored. */ int glfs_get_volumeid(glfs_t *fs, char *volid, size_t size) __THROW GFAPI_PUBLIC(glfs_get_volumeid, 3.5.0); /* * FILE OPERATION * * What follows are filesystem operations performed on the * 'virtual mount'. The calls here are kept as close to * the POSIX system calls as possible. * * Notes: * * - All paths specified, even if absolute, are relative to the * root of the virtual mount and not the system root (/). * */ /* The file descriptor object. One per open file/directory. */ struct glfs_fd; typedef struct glfs_fd glfs_fd_t; #define GLFS_LEASE_ID_SIZE 16 /* 128bits */ typedef char glfs_leaseid_t[GLFS_LEASE_ID_SIZE]; /* * PER THREAD IDENTITY MODIFIERS * * The following operations enable to set a per thread identity context * for the glfs APIs to perform operations as. The calls here are kept as close * to POSIX equivalents as possible. * * NOTES: * * - setgroups is a per thread setting, hence this is named as fsgroups to be * close in naming to the fs(u/g)id APIs * - Typical mode of operation is to set the IDs as required, with the * supplementary groups being optionally set, make the glfs call and post the * glfs operation set them back to eu/gid or uid/gid as appropriate to the * caller * - The groups once set, need to be unset by setting the size to 0 (in which * case the list argument is a do not care) * - In case of leases feature enables, setfsleaseid is used to set and reset * leaseid before and after every I/O operation. * - Once a process for a thread of operation choses to set the IDs, all glfs * calls made from that thread would default to the IDs set for the thread. * As a result use these APIs with care and ensure that the set IDs are * reverted to global process defaults as required. * */ int glfs_setfsuid(uid_t fsuid) __THROW GFAPI_PUBLIC(glfs_setfsuid, 3.4.2); int glfs_setfsgid(gid_t fsgid) __THROW GFAPI_PUBLIC(glfs_setfsgid, 3.4.2); int glfs_setfsgroups(size_t size, const gid_t *list) __THROW GFAPI_PUBLIC(glfs_setfsgroups, 3.4.2); int glfs_setfsleaseid(glfs_leaseid_t leaseid) __THROW GFAPI_PUBLIC(glfs_setfsleaseid, 4.0.0); /* SYNOPSIS glfs_open: Open a file. DESCRIPTION This function opens a file on a virtual mount. PARAMETERS @fs: The 'virtual mount' object to be initialized. @path: Path of the file within the virtual mount. @flags: Open flags. See open(2). O_CREAT is not supported. Use glfs_creat() for creating files. RETURN VALUES NULL : Failure. @errno will be set with the type of failure. Others : Pointer to the opened glfs_fd_t. */ glfs_fd_t * glfs_open(glfs_t *fs, const char *path, int flags) __THROW GFAPI_PUBLIC(glfs_open, 3.4.0); /* SYNOPSIS glfs_creat: Create a file. DESCRIPTION This function opens a file on a virtual mount. PARAMETERS @fs: The 'virtual mount' object to be initialized. @path: Path of the file within the virtual mount. @mode: Permission of the file to be created. @flags: Create flags. See open(2). O_EXCL is supported. RETURN VALUES NULL : Failure. @errno will be set with the type of failure. Others : Pointer to the opened glfs_fd_t. */ glfs_fd_t * glfs_creat(glfs_t *fs, const char *path, int flags, mode_t mode) __THROW GFAPI_PUBLIC(glfs_creat, 3.4.0); int glfs_close(glfs_fd_t *fd) __THROW GFAPI_PUBLIC(glfs_close, 3.4.0); glfs_t * glfs_from_glfd(glfs_fd_t *fd) __THROW GFAPI_PUBLIC(glfs_from_glfd, 3.4.0); int glfs_set_xlator_option(glfs_t *fs, const char *xlator, const char *key, const char *value) __THROW GFAPI_PUBLIC(glfs_set_xlator_option, 3.4.0); /* glfs_io_cbk The following is the function type definition of the callback function pointer which has to be provided by the caller to the *_async() versions of the IO calls. The callback function is called on completion of the requested IO, and the appropriate return value is returned in @ret. In case of an error in completing the IO, @ret will be -1 and @errno will be set with the appropriate error. @ret will be same as the return value of the non _async() variant of the particular call @data is the same context pointer provided by the caller at the time of issuing the async IO call. This can be used by the caller to differentiate different instances of the async requests in a common callback function. */ typedef void (*glfs_io_cbk)(glfs_fd_t *fd, ssize_t ret, struct stat *prestat, struct stat *poststat, void *data); // glfs_{read,write}[_async] ssize_t glfs_read(glfs_fd_t *fd, void *buf, size_t count, int flags) __THROW GFAPI_PUBLIC(glfs_read, 3.4.0); ssize_t glfs_write(glfs_fd_t *fd, const void *buf, size_t count, int flags) __THROW GFAPI_PUBLIC(glfs_write, 3.4.0); int glfs_read_async(glfs_fd_t *fd, void *buf, size_t count, int flags, glfs_io_cbk fn, void *data) __THROW GFAPI_PUBLIC(glfs_read_async, future); int glfs_write_async(glfs_fd_t *fd, const void *buf, size_t count, int flags, glfs_io_cbk fn, void *data) __THROW GFAPI_PUBLIC(glfs_write_async, future); // glfs_{read,write}v[_async] ssize_t glfs_readv(glfs_fd_t *fd, const struct iovec *iov, int iovcnt, int flags) __THROW GFAPI_PUBLIC(glfs_readv, 3.4.0); ssize_t glfs_writev(glfs_fd_t *fd, const struct iovec *iov, int iovcnt, int flags) __THROW GFAPI_PUBLIC(glfs_writev, 3.4.0); int glfs_readv_async(glfs_fd_t *fd, const struct iovec *iov, int count, int flags, glfs_io_cbk fn, void *data) __THROW GFAPI_PUBLIC(glfs_readv_async, future); int glfs_writev_async(glfs_fd_t *fd, const struct iovec *iov, int count, int flags, glfs_io_cbk fn, void *data) __THROW GFAPI_PUBLIC(glfs_writev_async, future); // glfs_p{read,write}[_async] ssize_t glfs_pread(glfs_fd_t *fd, void *buf, size_t count, off_t offset, int flags, struct stat *poststat) __THROW GFAPI_PUBLIC(glfs_pread, future); ssize_t glfs_pwrite(glfs_fd_t *fd, const void *buf, size_t count, off_t offset, int flags, struct stat *prestat, struct stat *poststat) __THROW GFAPI_PUBLIC(glfs_pwrite, future); int glfs_pread_async(glfs_fd_t *fd, void *buf, size_t count, off_t offset, int flags, glfs_io_cbk fn, void *data) __THROW GFAPI_PUBLIC(glfs_pread_async, future); int glfs_pwrite_async(glfs_fd_t *fd, const void *buf, int count, off_t offset, int flags, glfs_io_cbk fn, void *data) __THROW GFAPI_PUBLIC(glfs_pwrite_async, future); // glfs_p{read,write}v[_async] ssize_t glfs_preadv(glfs_fd_t *fd, const struct iovec *iov, int iovcnt, off_t offset, int flags) __THROW GFAPI_PUBLIC(glfs_preadv, 3.4.0); ssize_t glfs_pwritev(glfs_fd_t *fd, const struct iovec *iov, int iovcnt, off_t offset, int flags) __THROW GFAPI_PUBLIC(glfs_pwritev, 3.4.0); int glfs_preadv_async(glfs_fd_t *fd, const struct iovec *iov, int count, off_t offset, int flags, glfs_io_cbk fn, void *data) __THROW GFAPI_PUBLIC(glfs_preadv_async, future); int glfs_pwritev_async(glfs_fd_t *fd, const struct iovec *iov, int count, off_t offset, int flags, glfs_io_cbk fn, void *data) __THROW GFAPI_PUBLIC(glfs_pwritev_async, future); off_t glfs_lseek(glfs_fd_t *fd, off_t offset, int whence) __THROW GFAPI_PUBLIC(glfs_lseek, 3.4.0); int glfs_truncate(glfs_t *fs, const char *path, off_t length) __THROW GFAPI_PUBLIC(glfs_truncate, 3.7.15); int glfs_ftruncate(glfs_fd_t *fd, off_t length, struct stat *prestat, struct stat *poststat) __THROW GFAPI_PUBLIC(glfs_ftruncate, future); int glfs_ftruncate_async(glfs_fd_t *fd, off_t length, glfs_io_cbk fn, void *data) __THROW GFAPI_PUBLIC(glfs_ftruncate_async, future); int glfs_lstat(glfs_t *fs, const char *path, struct stat *buf) __THROW GFAPI_PUBLIC(glfs_lstat, 3.4.0); int glfs_stat(glfs_t *fs, const char *path, struct stat *buf) __THROW GFAPI_PUBLIC(glfs_stat, 3.4.0); int glfs_fstat(glfs_fd_t *fd, struct stat *buf) __THROW GFAPI_PUBLIC(glfs_fstat, 3.4.0); int glfs_fsync(glfs_fd_t *fd, struct stat *prestat, struct stat *poststat) __THROW GFAPI_PUBLIC(glfs_fsync, future); int glfs_fsync_async(glfs_fd_t *fd, glfs_io_cbk fn, void *data) __THROW GFAPI_PUBLIC(glfs_fsync_async, future); int glfs_fdatasync(glfs_fd_t *fd, struct stat *prestat, struct stat *poststat) __THROW GFAPI_PUBLIC(glfs_fdatasync, future); int glfs_fdatasync_async(glfs_fd_t *fd, glfs_io_cbk fn, void *data) __THROW GFAPI_PUBLIC(glfs_fdatasync_async, future); int glfs_access(glfs_t *fs, const char *path, int mode) __THROW GFAPI_PUBLIC(glfs_access, 3.4.0); int glfs_symlink(glfs_t *fs, const char *oldpath, const char *newpath) __THROW GFAPI_PUBLIC(glfs_symlink, 3.4.0); int glfs_readlink(glfs_t *fs, const char *path, char *buf, size_t bufsiz) __THROW GFAPI_PUBLIC(glfs_readlink, 3.4.0); int glfs_mknod(glfs_t *fs, const char *path, mode_t mode, dev_t dev) __THROW GFAPI_PUBLIC(glfs_mknod, 3.4.0); int glfs_mkdir(glfs_t *fs, const char *path, mode_t mode) __THROW GFAPI_PUBLIC(glfs_mkdir, 3.4.0); int glfs_unlink(glfs_t *fs, const char *path) __THROW GFAPI_PUBLIC(glfs_unlink, 3.4.0); int glfs_rmdir(glfs_t *fs, const char *path) __THROW GFAPI_PUBLIC(glfs_rmdir, 3.4.0); int glfs_rename(glfs_t *fs, const char *oldpath, const char *newpath) __THROW GFAPI_PUBLIC(glfs_rename, 3.4.0); int glfs_link(glfs_t *fs, const char *oldpath, const char *newpath) __THROW GFAPI_PUBLIC(glfs_link, 3.4.0); glfs_fd_t * glfs_opendir(glfs_t *fs, const char *path) __THROW GFAPI_PUBLIC(glfs_opendir, 3.4.0); /* * @glfs_readdir_r and @glfs_readdirplus_r ARE thread safe AND re-entrant, * but the interface has ambiguity about the size of @dirent to be allocated * before calling the APIs. 512 byte buffer (for @dirent) is sufficient for * all known systems which are tested againt glusterfs/gfapi, but may be * insufficient in the future. */ int glfs_readdir_r(glfs_fd_t *fd, struct dirent *dirent, struct dirent **result) __THROW GFAPI_PUBLIC(glfs_readdir_r, 3.4.0); int glfs_readdirplus_r(glfs_fd_t *fd, struct stat *stat, struct dirent *dirent, struct dirent **result) __THROW GFAPI_PUBLIC(glfs_readdirplus_r, 3.4.0); /* * @glfs_readdir and @glfs_readdirplus are NEITHER thread safe NOR re-entrant * when called on the same directory handle. However they ARE thread safe * AND re-entrant when called on different directory handles (which may be * referring to the same directory too.) */ struct dirent * glfs_readdir(glfs_fd_t *fd) __THROW GFAPI_PUBLIC(glfs_readdir, 3.5.0); struct dirent * glfs_readdirplus(glfs_fd_t *fd, struct stat *stat) __THROW GFAPI_PUBLIC(glfs_readdirplus, 3.5.0); long glfs_telldir(glfs_fd_t *fd) __THROW GFAPI_PUBLIC(glfs_telldir, 3.4.0); void glfs_seekdir(glfs_fd_t *fd, long offset) __THROW GFAPI_PUBLIC(glfs_seekdir, 3.4.0); int glfs_closedir(glfs_fd_t *fd) __THROW GFAPI_PUBLIC(glfs_closedir, 3.4.0); int glfs_statvfs(glfs_t *fs, const char *path, struct statvfs *buf) __THROW GFAPI_PUBLIC(glfs_statvfs, 3.4.0); int glfs_chmod(glfs_t *fs, const char *path, mode_t mode) __THROW GFAPI_PUBLIC(glfs_chmod, 3.4.0); int glfs_fchmod(glfs_fd_t *fd, mode_t mode) __THROW GFAPI_PUBLIC(glfs_fchmod, 3.4.0); int glfs_chown(glfs_t *fs, const char *path, uid_t uid, gid_t gid) __THROW GFAPI_PUBLIC(glfs_chown, 3.4.0); int glfs_lchown(glfs_t *fs, const char *path, uid_t uid, gid_t gid) __THROW GFAPI_PUBLIC(glfs_lchown, 3.4.0); int glfs_fchown(glfs_fd_t *fd, uid_t uid, gid_t gid) __THROW GFAPI_PUBLIC(glfs_fchown, 3.4.0); int glfs_utimens(glfs_t *fs, const char *path, const struct timespec times[2]) __THROW GFAPI_PUBLIC(glfs_utimens, 3.4.0); int glfs_lutimens(glfs_t *fs, const char *path, const struct timespec times[2]) __THROW GFAPI_PUBLIC(glfs_lutimens, 3.4.0); int glfs_futimens(glfs_fd_t *fd, const struct timespec times[2]) __THROW GFAPI_PUBLIC(glfs_futimens, 3.4.0); ssize_t glfs_getxattr(glfs_t *fs, const char *path, const char *name, void *value, size_t size) __THROW GFAPI_PUBLIC(glfs_getxattr, 3.4.0); ssize_t glfs_lgetxattr(glfs_t *fs, const char *path, const char *name, void *value, size_t size) __THROW GFAPI_PUBLIC(glfs_lgetxattr, 3.4.0); ssize_t glfs_fgetxattr(glfs_fd_t *fd, const char *name, void *value, size_t size) __THROW GFAPI_PUBLIC(glfs_fgetxattr, 3.4.0); ssize_t glfs_listxattr(glfs_t *fs, const char *path, void *value, size_t size) __THROW GFAPI_PUBLIC(glfs_listxattr, 3.4.0); ssize_t glfs_llistxattr(glfs_t *fs, const char *path, void *value, size_t size) __THROW GFAPI_PUBLIC(glfs_llistxattr, 3.4.0); ssize_t glfs_flistxattr(glfs_fd_t *fd, void *value, size_t size) __THROW GFAPI_PUBLIC(glfs_flistxattr, 3.4.0); int glfs_setxattr(glfs_t *fs, const char *path, const char *name, const void *value, size_t size, int flags) __THROW GFAPI_PUBLIC(glfs_setxattr, 3.4.0); int glfs_lsetxattr(glfs_t *fs, const char *path, const char *name, const void *value, size_t size, int flags) __THROW GFAPI_PUBLIC(glfs_lsetxattr, 3.4.0); int glfs_fsetxattr(glfs_fd_t *fd, const char *name, const void *value, size_t size, int flags) __THROW GFAPI_PUBLIC(glfs_fsetxattr, 3.4.0); int glfs_removexattr(glfs_t *fs, const char *path, const char *name) __THROW GFAPI_PUBLIC(glfs_removexattr, 3.4.0); int glfs_lremovexattr(glfs_t *fs, const char *path, const char *name) __THROW GFAPI_PUBLIC(glfs_lremovexattr, 3.4.0); int glfs_fremovexattr(glfs_fd_t *fd, const char *name) __THROW GFAPI_PUBLIC(glfs_fremovexattr, 3.4.0); int glfs_fallocate(glfs_fd_t *fd, int keep_size, off_t offset, size_t len) __THROW GFAPI_PUBLIC(glfs_fallocate, 3.5.0); int glfs_discard(glfs_fd_t


context:
space:
mode: