lustre/doc/lustreapi.7

   1 .
   2 .TH LUSTREAPI 7 "2014-09-21" "" "The Lustre API library"
   3 .SH NAME
   4 lustreapi \- The Lustre API library
   5 .
   6 .SH SYNOPSIS
   7 .sp
   8 \fB#include <lustre/lustreapi.h>\fP
   9 .SH DESCRIPTION
  10 .sp
  11 The lustreapi library provides functions to access and/or modify
  12 settings specific to the Lustre filesystem (allocation policies,
  13 quotas, etc).
  14 .sp
  15 The library provides the following functions:
  16 .sp
  17 .SH HSM FUNCTIONS
  18 .sp
  19 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
  20 const char *mnt, int archive_count, int *archives,
  21 int rfd_flags)
  22 .sp
  23 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv)
  24 .sp
  25 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct)
  26 .sp
  27 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
  28 struct hsm_action_list **hal, int *msgsize)
  29 .sp
  30 struct hsm_action_item *hai_first(struct hsm_action_list *hal)
  31 .sp
  32 struct hsm_action_item *hai_next(struct hsm_action_item *hai)
  33 .sp
  34 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
  35 const struct hsm_copytool_private *ct, const struct
  36 hsm_action_item *hai, int restore_mdt_index, int
  37 restore_open_flags, bool is_error)
  38 .sp
  39 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
  40 const struct hsm_extent *he, int hp_flags, int errval)
  41 .sp
  42 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
  43 const struct hsm_extent *he, __u64 total, int hp_flags)
  44 .sp
  45 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
  46 lustre_fid *fid)
  47 .sp
  48 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp)
  49 .SH SEE ALSO
  50 .sp
  51 \fBlustre\fP(7),
  52 \fBllapi_file_create\fP(3),
  53 \fBllapi_file_open\fP(3),
  54 \fBllapi_file_get_stripe\fP(3),
  55 \fBllapi_layout\fP(3),
  56 \fBllapi_quotactl\fP(3),
  57 \fBllapi_hsm_action_begin\fP(3),
  58 \fBllapi_hsm_copytool_register\fP(3),
  59 \fBllapi_hsm_state_get\fP(3),
  60 \fBllapi_hsm_state_set\fP(3)
  61 .SH AUTHOR
  62 Lustre contributors
  63 .