GPFS programming interfaces
A list of all the GPFS programming interfaces and a short description of each is presented in this topic.
The GPFS APIs are not supported on Windows.
Table 1 summarizes
the GPFS programming interfaces.
| Interface | Purpose |
|---|---|
| gpfs_acl_t structure | Contains buffer mapping for the gpfs_getacl() and gpfs_putacl() subroutines. |
| gpfs_clone_copy() subroutine | Creates a file clone of a read-only clone parent file. |
| gpfs_clone_snap() subroutine | Creates a read-only clone parent from a source file. |
| gpfs_clone_split() subroutine | Splits a file clone from its clone parent. |
| gpfs_clone_unsnap() subroutine | Changes a clone parent with no file clones back to a regular file. |
| gpfs_close_inodescan() subroutine | Closes an inode scan. |
| gpfs_cmp_fssnapid() subroutine | Compares two file system snapshot IDs. |
| gpfs_declone() subroutine | Removes file clone references to clone parent blocks. |
| gpfs_direntx_t structure | Contains attributes of a GPFS directory entry. |
| gpfs_direntx64_t structure | Contains attributes of a GPFS directory entry. |
| gpfs_fcntl() subroutine | Performs operations on an open file. |
| gpfs_fgetattrs() subroutine | Retrieves all extended file attributes in opaque format. |
| gpfs_fputattrs() subroutine | Sets all the extended file attributes for a file. |
| gpfs_fputattrswithpathname() subroutine | Sets all of the extended file attributes for a file and invokes the policy engine for RESTORE rules. |
| gpfs_free_fssnaphandle() subroutine | Frees a GPFS file system snapshot handle. |
| gpfs_fssnap_handle_t structure | Contains a handle for a GPFS file system or snapshot. |
| gpfs_fssnap_id_t structure | Contains a permanent identifier for a GPFS file system or snapshot. |
| gpfs_fstat() subroutine | Returns exact file status for a GPFS file. |
| gpfs_fstat_x() subroutine | Returns extended status information for a GPFS file with specified accuracy. |
| gpfs_get_fsname_from_fssnaphandle() subroutine | Obtains a file system name from its snapshot handle. |
| gpfs_get_fssnaphandle_by_fssnapid() subroutine | Obtains a file system snapshot handle using its snapshot ID. |
| gpfs_get_fssnaphandle_by_name() subroutine | Obtains a file system snapshot handle using its name. |
| gpfs_get_fssnaphandle_by_path() subroutine | Obtains a file system snapshot handle using its path name. |
| gpfs_get_fssnapid_from_fssnaphandle() subroutine | Obtains a file system snapshot ID using its handle. |
| gpfs_get_pathname_from_fssnaphandle() subroutine | Obtains a file system path name using its snapshot handle. |
| gpfs_get_snapdirname() subroutine | Obtains the name of the directory containing global snapshots. |
| gpfs_get_snapname_from_fssnaphandle() subroutine | Obtains a snapshot name using its file system snapshot handle. |
| gpfs_getacl() subroutine | Retrieves the access control information for a GPFS file. |
| gpfs_getacl_fd() subroutine | Retrieves the access control information for a GPFS file. |
| gpfs_iattr_t structure | Contains attributes of a GPFS inode. |
| gpfs_iattr64_t structure | Contains attributes of a GPFS inode. |
| gpfs_iclose() subroutine | Closes a file given its inode file handle. |
| gpfs_ifile_t structure | Contains a handle for a GPFS inode. |
| gpfs_igetattrs() subroutine | Retrieves extended file attributes in opaque format. |
| gpfs_igetattrsx() subroutine | Retrieves extended file attributes; provides an option to include DMAPI attributes. |
| gpfs_igetfilesetname() subroutine | Returns the name of the fileset defined by a fileset ID. |
| gpfs_igetstoragepool() subroutine | Returns the name of the storage pool for the given storage pool ID. |
| gpfs_iopen() subroutine | Opens a file or directory by inode number. |
| gpfs_iopen64() subroutine | Opens a file or directory by inode number. |
| gpfs_iputattrsx() subroutine | Sets the extended file attributes for a file. |
| gpfs_iread() subroutine | Reads a file opened by gpfs_iopen(). |
| gpfs_ireaddir() subroutine | Reads the next directory entry. |
| gpfs_ireaddir64() subroutine | Reads the next directory entry. |
| gpfs_ireadlink() subroutine | Reads a symbolic link by inode number. |
| gpfs_ireadlink64() subroutine | Reads a symbolic link by inode number. |
| gpfs_ireadx() subroutine | Performs block level incremental read of a file within an incremental inode scan. |
| gpfs_iscan_t structure | Contains a handle for an inode scan of a GPFS file system or snapshot. |
| gpfs_lib_init() subroutine | Sets up a GPFS interface for additional calls. |
| gpfs_lib_term() subroutine | Cleans up after GPFS interface calls have been completed. |
| gpfs_linkat() subroutine | Links file to a directory name. |
| gpfs_next_inode() subroutine | Retrieves the next inode from the inode scan. |
| gpfs_next_inode64() subroutine | Retrieves the next inode from the inode scan. |
| gpfs_next_inode_with_xattrs() subroutine | Retrieves the next inode and its extended attributes from the inode scan. |
| gpfs_next_inode_with_xattrs64() subroutine | Retrieves the next inode and its extended attributes from the inode scan. |
| gpfs_next_xattr() subroutine | Returns individual attributes and their values. |
| gpfs_opaque_acl_t structure | Contains buffer mapping for the gpfs_getacl() and gpfs_putacl() subroutines. |
| gpfs_open_inodescan() subroutine | Opens an inode scan of a file system or snapshot. |
| gpfs_open_inodescan64() subroutine | Opens an inode scan of a file system or snapshot. |
| gpfs_open_inodescan_with_xattrs() subroutine | Opens an inode file and extended attributes for an inode scan. |
| gpfs_open_inodescan_with_xattrs64() subroutine | Opens an inode file and extended attributes for an inode scan. |
| gpfs_prealloc() subroutine | Preallocates storage for a regular file or preallocates directory entries for a directory. |
| gpfs_putacl() subroutine | Restores the access control information for a GPFS file. |
| gpfs_putacl_fd() subroutine | Restores the access control information for a GPFS file |
| gpfs_quotactl() subroutine | Manipulates disk quotas on file systems. |
| gpfs_quotaInfo_t structure | Contains buffer mapping for the gpfs_quotactl() subroutine. |
| gpfs_seek_inode() subroutine | Advances an inode scan to the specified inode number. |
| gpfs_seek_inode64() subroutine | Advances an inode scan to the specified inode number. |
| gpfs_stat() subroutine | Returns exact file status for a GPFS file. |
| gpfs_stat_inode() subroutine | Seeks the specified inode and retrieves that inode and its extended attributes from the inode scan. |
| gpfs_stat_inode64() subroutine | Seeks the specified inode and retrieves that inode and its extended attributes from the inode scan. |
| gpfs_stat_inode_with_xattrs() subroutine | Seeks the specified inode and retrieves that inode and its extended attributes from the inode scan. |
| gpfs_stat_inode_with_xattrs64() subroutine | Seeks the specified inode and retrieves that inode and its extended attributes from the inode scan. |
| gpfs_stat_x() subroutine | Returns extended status information for a GPFS file with specified accuracy. |
| gpfsFcntlHeader_t structure | Contains declaration information for the gpfs_fcntl() subroutine. |
| gpfsGetDataBlkDiskIdx_t structure | Obtains the FPO data block location of a file. |
| gpfsGetFilesetName_t structure | Obtains the fileset name of a file. |
| gpfsGetReplication_t structure | Obtains the replication factors of a file. |
| gpfsGetSetXAttr_t structure | Obtains or sets extended attribute values. |
| gpfsGetSnapshotName_t structure | Obtains the snapshot name of a file. |
| gpfsGetStoragePool_t structure | Obtains the storage pool name of a file. |
| gpfsListXAttr_t structure | Lists extended attributes. |
| gpfsRestripeData_t structure | Restripes the data blocks of a file. |
| gpfsSetReplication_t structure | Sets the replication factors of a file. |
| gpfsSetStoragePool_t structure | Sets the assigned storage pool of a file. |