llapi_pool_unpin_fd(3)

NAME

llapi_pool_unpin_fd, llapi_pool_unpin_file, llapi_pool_unpin_fid - remove pool pinning from a Lustre file

SYNOPSIS

#include <lustre/lustreapi.h>

int llapi_pool_unpin_fd(int fd, const char *pool_name);

int llapi_pool_unpin_file(const char *path, const char *pool_name);

int llapi_pool_unpin_fid(const char *lustre_dir, const struct lu_fid *fid,
                         const char *pool_name);

DESCRIPTION

The llapi_pool_unpin_*(3) functions manipulate the Lustre lustre.pin extended attribute of a file in order to remove any pin for a particular OST pool.

Pool pins are stored as YAML entries of the form

pool: pool_name

The llapi_pool_unpin_fd(), llapi_pool_unpin_file() and llapi_pool_unpin_fid() functions remove the pool entry for pool_name from the lustre.pin attribute of the referenced file. If no matching entry is found, or if the lustre.pin attribute is missing, the call fails with ENOENT and the file is not modified. When the last entry is removed from lustre.pin , the attribute itself is deleted.

The pool_name parameter may optionally be qualified with a filesystem name using the "fsname.pool" notation commonly used by Lustre tools. In this case the "fsname." prefix is silently discarded before the pool name is stored or compared, and only the unqualified pool name is recorded in the lustre.pin attribute.

RETURN VALUES

The llapi_pool_unpin_*() functions return 0 on success. On failure they return a negative errno value and set errno to the corresponding error code.

ERRORS

Errors from llapi_pool_name_validate(3) will be returned on malformed pool names.

EINVAL

An invalid argument was specified.

ENOENT

No pool entry for the specified pool_name was found in the lustre.pin attribute when calling one of the llapi_pool_unpin_*() functions, or the attribute itself was missing.

EXAMPLES

#include <lustre/lustreapi.h>
if (llapi_pool_unpin_file(path, pool_name) < 0) {
	if (errno == ENOENT) {
		/* file was not pinned to this pool */
	} else {
		perror("llapi_pool_unpin_file");
	}
}

AVAILABILITY

The llapi_pool_unpin_fd(), llapi_pool_unpin_file(), and llapi_pool_unpin_fid() functions are part of the lustre(7) user application interface library since release 2.18.0.

SEE ALSO

llapi_pool_is_pinned_file(3), llapi_pool_name_validate(3), llapi_pool_pin_file(3), lustre(7), lustreapi(7)