fs_traversal_interface.h

Go to the documentation of this file.

#ifndef CVMFS_SHRINKWRAP_FS_TRAVERSAL_INTERFACE_H_
#define CVMFS_SHRINKWRAP_FS_TRAVERSAL_INTERFACE_H_

#include "libcvmfs.h"

#define COPY_BUFFER_SIZE 4096

struct fs_traversal_context {
  uint64_t version;
  uint64_t size;

  char *repo;
  char *base;
  char *data;
  char *config;
  char *lib_version;

  void *ctx;
};

enum fs_open_type {
  fs_open_read,
  fs_open_write,
  fs_open_append
};

struct fs_traversal {
  struct fs_traversal_context *context_;

  struct fs_traversal_context *(*initialize)(const char *repo,
                                             const char *base,
                                             const char *data,
                                             const char *config,
                                             int num_threads);

  void (*finalize)(struct fs_traversal_context *ctx);

  void (*archive_provenance)(struct fs_traversal_context *src,
                             struct fs_traversal_context *dest);

  void (*list_dir)(struct fs_traversal_context *ctx,
                   const char *dir,
                   char ***buf,
                   size_t *len);

  int (*get_stat)(struct fs_traversal_context *ctx, const char *path,
                  struct cvmfs_attr *stat, bool get_hash);

  bool (*is_hash_consistent)(struct fs_traversal_context *ctx,
                             const struct cvmfs_attr *stat);

  int (*set_meta)(struct fs_traversal_context *ctx, const char *path,
                  const struct cvmfs_attr *stat);

  char *(*get_identifier)(struct fs_traversal_context *ctx,
                          const struct cvmfs_attr *stat);


  bool (*has_file)(struct fs_traversal_context *ctx, const char *identifier);

  int (*do_link)(struct fs_traversal_context *ctx,
                 const char *path,
                 const char *identifier);

  int (*do_unlink)(struct fs_traversal_context *ctx, const char *path);

  int (*do_mkdir)(struct fs_traversal_context *ctx,
                  const char *path,
                  const struct cvmfs_attr *stat);

  int (*do_rmdir)(struct fs_traversal_context *ctx, const char *path);

  int (*touch)(struct fs_traversal_context *ctx, const struct cvmfs_attr *stat);

  void *(*get_handle)(struct fs_traversal_context *ctx, const char *identifier);


  int (*do_symlink)(struct fs_traversal_context *ctx,
                    const char *src,
                    const char *dest,
                    const struct cvmfs_attr *stat_info);

  int (*garbage_collector)(struct fs_traversal_context *ctx);

  int (*do_fopen)(void *file_ctx, fs_open_type op_mode);

  int (*do_fclose)(void *file_ctx);

  int (*do_fread)(void *file_ctx, char *buff, size_t len, size_t *read_len);

  int (*do_fwrite)(void *file_ctx, const char *buff, size_t len);

  void (*do_ffree)(void *file_ctx);
};

#endif  // CVMFS_SHRINKWRAP_FS_TRAVERSAL_INTERFACE_H_