lustre/doc/llapi_pcc_detach_fid_fd.3

   1 .TH llapi_pcc_detach_fid_fd 3 "2019 April 20" "Lustre User API"
   2 .SH NAME
   3 llapi_pcc_detach_fid_fd, llapi_pcc_detach_fid, llapi_pcc_detach_fid_str,
   4 llapi_pcc_detach_file \- detach the given file from PCC
   5 .SH SYNOPSIS
   6 .nf
   7 .B #include <lustre/lustreapi.h>
   8 .PP
   9 .BI "int llapi_pcc_detach_fid_fd(int " dirfd ", const struct lu_fid *" fid ");"
  10 .PP
  11 .BI "int llapi_pcc_detach_fid(const char *" mntpath ", const struct lu_fid *" fid ");"
  12 .PP
  13 .BI "int llapi_pcc_detach_fid_str(const char *" mntpath ", const char *" fidstr ");"
  14 .PP
  15 .BI "int llapi_pcc_detach_file(const char *" path ");"
  16 .fi
  17 .SH DESCRIPTION
  18 .PP
  19 .BR llapi_pcc_detach_fid_fd() ,
  20 .BR llapi_pcc_detach_fid() ,
  21 .BR llapi_pcc_detach_fid_str() ,
  22 and
  23 .BR llapi_pcc_detach_file()
  24 detaches a cached file from PCC by an ioctl on the dir. The file is referenced
  25 by
  26 .IR fid ,
  27 .IR fidstr ,
  28 or
  29 .IR path .
  30 The dir, which usually a mount point dir that the copytool already has opened,
  31 is referenced by
  32 .IR dirfd ,
  33 .IR mntpath ,
  34 .IR path .
  35 .SH RETURN VALUES
  36 .LP
  37 .BR llapi_pcc_detach_fid_fd() ,
  38 .BR llapi_pcc_detach_fid() ,
  39 .BR llapi_pcc_detach_fid_str() ,
  40 and
  41 .B llapi_pcc_detach_file()
  42 return 0 on success or a negative errno value on failure.
  43 .SH ERRORS
  44 .TP 15
  45 .SM -ENOMEM
  46 Insufficient memory to complete operation.
  47 .TP
  48 .SM -EFAULT
  49 Memory region is not properly mapped.
  50 .TP
  51 .SM -EINVAL
  52 One or more invalid arguments are given.
  53 .TP
  54 .SM -EOPNOTSUPP
  55 PCC state operation is not supported.
  56 .TP
  57 .SM -ENOTTY
  58 File does not reside on a Lustre filesystem.
  59 .TP
  60 .SM -ENOENT
  61 .I path
  62 does not exist.
  63 .SH "SEE ALSO"
  64 .BR llapi_pcc_attach (3),
  65 .BR lustreapi (7)