lustre/doc/lustreapi.rst

   1 =========
   2 lustreapi
   3 =========
   4
   5 ----------------------
   6 The Lustre API library
   7 ----------------------
   8
   9 :Author: Lustre contributors
  10 :Date:   2014-09-21
  11 :Manual section: 7
  12 :Manual group: The Lustre API library
  13
  14 SYNOPSIS
  15 ========
  16
  17 **#include <lustre/lustreapi.h>**
  18
  19 DESCRIPTION
  20 ===========
  21
  22 The lustreapi library provides functions to access and/or modify
  23 settings specific to the Lustre filesystem (allocation policies,
  24 quotas, etc).
  25
  26 The library provides the following functions:
  27
  28 **HSM**
  29
  30   int llapi_hsm_copytool_register(struct hsm_copytool_private \*\*priv,
  31   const char \*mnt, int archive_count, int \*archives,
  32   int rfd_flags)
  33
  34   int llapi_hsm_copytool_unregister(struct hsm_copytool_private \*\*priv)
  35
  36   int llapi_hsm_copytool_get_fd(struct hsm_copytool_private \*ct)
  37
  38   int llapi_hsm_copytool_recv(struct hsm_copytool_private \*priv,
  39   struct hsm_action_list \*\*hal, int \*msgsize)
  40
  41   struct hsm_action_item \*hai_first(struct hsm_action_list \*hal)
  42
  43   struct hsm_action_item \*hai_next(struct hsm_action_item \*hai)
  44
  45   int llapi_hsm_action_begin(struct hsm_copyaction_private \*\*phcp,
  46   const struct hsm_copytool_private \*ct, const struct
  47   hsm_action_item \*hai, int restore_mdt_index, int
  48   restore_open_flags, bool is_error)
  49
  50   int llapi_hsm_action_end(struct hsm_copyaction_private \*\*phcp,
  51   const struct hsm_extent \*he, int hp_flags, int errval)
  52
  53   int llapi_hsm_action_progress(struct hsm_copyaction_private \*hcp,
  54   const struct hsm_extent \*he, __u64 total, int hp_flags)
  55
  56   int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private \*hcp,
  57   lustre_fid \*fid)
  58
  59   int llapi_hsm_action_get_fd(const struct hsm_copyaction_private \*hcp)
  60
  61
  62 SEE ALSO
  63 ========
  64
  65 **lustre**\ (7),
  66 **llapi_file_create**\ (3),
  67 **llapi_file_open**\ (3),
  68 **llapi_file_get_stripe**\ (3),
  69 **llapi_layout**\ (3),
  70 **llapi_quotactl**\ (3),
  71 **llapi_hsm_state_get**\ (3),
  72 **llapi_hsm_state_set**\ (3)