fs-api-private.h revision e13e798694ba1b0d0a5cf471600168eeaa8d2af4
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen#ifndef FS_API_PRIVATE_H
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen#define FS_API_PRIVATE_H
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen#include "fs-api.h"
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainenstruct fs_vfuncs {
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen struct fs *(*alloc)(void);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen int (*init)(struct fs *fs, const char *args,
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen const struct fs_settings *set);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen void (*deinit)(struct fs *fs);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen enum fs_properties (*get_properties)(struct fs *fs);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen struct fs_file *(*file_init)(struct fs *fs, const char *path,
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen enum fs_open_mode mode,
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen enum fs_open_flags flags);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen void (*file_deinit)(struct fs_file *file);
0b32a8d139f6a4f2b18a6444fc66d31b4a1b0da6Timo Sirainen void (*file_close)(struct fs_file *file);
3dcb9fd82c1edd40bea1ad572ed39f024686e463Timo Sirainen const char *(*get_path)(struct fs_file *file);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen void (*set_async_callback)(struct fs_file *file,
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen fs_file_async_callback_t *callback,
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen void *context);
2766f1de8141c09767a959d2d2c3065c5a300bf0Timo Sirainen int (*wait_async)(struct fs *fs);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen void (*set_metadata)(struct fs_file *file, const char *key,
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen const char *value);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen int (*get_metadata)(struct fs_file *file,
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen const ARRAY_TYPE(fs_metadata) **metadata_r);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen bool (*prefetch)(struct fs_file *file, uoff_t length);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen ssize_t (*read)(struct fs_file *file, void *buf, size_t size);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen struct istream *(*read_stream)(struct fs_file *file,
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen size_t max_buffer_size);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen int (*write)(struct fs_file *file, const void *data, size_t size);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen void (*write_stream)(struct fs_file *file);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen int (*write_stream_finish)(struct fs_file *file, bool success);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen int (*lock)(struct fs_file *file, unsigned int secs,
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen struct fs_lock **lock_r);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen void (*unlock)(struct fs_lock *lock);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen int (*exists)(struct fs_file *file);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen int (*stat)(struct fs_file *file, struct stat *st_r);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen int (*copy)(struct fs_file *src, struct fs_file *dest);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen int (*rename)(struct fs_file *src, struct fs_file *dest);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen int (*delete_file)(struct fs_file *file);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen
63e94e8f57920b510fcdc479c5482ba9f4337a5cTimo Sirainen struct fs_iter *(*iter_init)(struct fs *fs, const char *path,
63e94e8f57920b510fcdc479c5482ba9f4337a5cTimo Sirainen enum fs_iter_flags flags);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen const char *(*iter_next)(struct fs_iter *iter);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen int (*iter_deinit)(struct fs_iter *iter);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen};
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainenstruct fs {
c4e3c997c04eb6f93f782c5fa53354390ed07a02Timo Sirainen struct fs *parent; /* for wrapper filesystems */
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen const char *name;
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen struct fs_vfuncs v;
a06af8e117e14e2ddc5835bcbe0d2f0370cbc0a1Timo Sirainen char *temp_path_prefix;
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
02cc28525a97ee60cb512c8eb15908082743bfe9Timo Sirainen char *username, *session_id;
02cc28525a97ee60cb512c8eb15908082743bfe9Timo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen struct fs_settings set;
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen string_t *last_error;
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
5804ddddad82319839785885fdacbba60e0c9581Timo Sirainen /* may be used by fs_wait_async() to do the waiting */
5804ddddad82319839785885fdacbba60e0c9581Timo Sirainen struct ioloop *wait_ioloop, *prev_ioloop;
5804ddddad82319839785885fdacbba60e0c9581Timo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen unsigned int files_open_count;
92093e6d8bdddeac59e169bcde6d0080a17e66efTimo Sirainen struct fs_file *files;
e13e798694ba1b0d0a5cf471600168eeaa8d2af4Timo Sirainen struct fs_iter *iters;
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen};
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainenstruct fs_file {
e13e798694ba1b0d0a5cf471600168eeaa8d2af4Timo Sirainen /* linked list of all files */
92093e6d8bdddeac59e169bcde6d0080a17e66efTimo Sirainen struct fs_file *prev, *next;
92093e6d8bdddeac59e169bcde6d0080a17e66efTimo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen struct fs *fs;
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen struct ostream *output;
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen char *path;
a06af8e117e14e2ddc5835bcbe0d2f0370cbc0a1Timo Sirainen enum fs_open_flags flags;
251457b81928bab1ad25193e8a09bda829abe9eeTimo Sirainen
4948718872b7dacb239e7db20393cd232bf4568bTimo Sirainen struct istream *seekable_input;
251457b81928bab1ad25193e8a09bda829abe9eeTimo Sirainen struct istream *pending_read_input;
84669c712403b742cc07ae70229725c486ef1235Timo Sirainen
67a163f3a07593446fab1cbbb8f92a89d4c6cb57Timo Sirainen const struct hash_method *write_digest_method;
67a163f3a07593446fab1cbbb8f92a89d4c6cb57Timo Sirainen void *write_digest;
67a163f3a07593446fab1cbbb8f92a89d4c6cb57Timo Sirainen
84669c712403b742cc07ae70229725c486ef1235Timo Sirainen pool_t metadata_pool;
84669c712403b742cc07ae70229725c486ef1235Timo Sirainen ARRAY_TYPE(fs_metadata) metadata;
84669c712403b742cc07ae70229725c486ef1235Timo Sirainen
84669c712403b742cc07ae70229725c486ef1235Timo Sirainen struct fs_file *copy_src;
84669c712403b742cc07ae70229725c486ef1235Timo Sirainen struct istream *copy_input;
84669c712403b742cc07ae70229725c486ef1235Timo Sirainen struct ostream *copy_output;
392538eef147981f6d818cd14cabc94cf8049d8eTimo Sirainen
392538eef147981f6d818cd14cabc94cf8049d8eTimo Sirainen unsigned int write_pending;
392538eef147981f6d818cd14cabc94cf8049d8eTimo Sirainen unsigned int metadata_changed:1;
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen};
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainenstruct fs_lock {
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen struct fs_file *file;
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen};
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainenstruct fs_iter {
e13e798694ba1b0d0a5cf471600168eeaa8d2af4Timo Sirainen /* linked list of all iters */
e13e798694ba1b0d0a5cf471600168eeaa8d2af4Timo Sirainen struct fs_iter *prev, *next;
e13e798694ba1b0d0a5cf471600168eeaa8d2af4Timo Sirainen
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen struct fs *fs;
63e94e8f57920b510fcdc479c5482ba9f4337a5cTimo Sirainen enum fs_iter_flags flags;
9c45f33d0e0ca0b8f87f9a3318dd505a78fd198eTimo Sirainen
9c45f33d0e0ca0b8f87f9a3318dd505a78fd198eTimo Sirainen bool async_have_more;
9c45f33d0e0ca0b8f87f9a3318dd505a78fd198eTimo Sirainen fs_file_async_callback_t *async_callback;
9c45f33d0e0ca0b8f87f9a3318dd505a78fd198eTimo Sirainen void *async_context;
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen};
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen
6e8fce0589289d10e6dcd9b71fde763492bb29b8Timo Sirainenextern const struct fs fs_class_posix;
84669c712403b742cc07ae70229725c486ef1235Timo Sirainenextern const struct fs fs_class_metawrap;
6e8fce0589289d10e6dcd9b71fde763492bb29b8Timo Sirainenextern const struct fs fs_class_sis;
6e8fce0589289d10e6dcd9b71fde763492bb29b8Timo Sirainenextern const struct fs fs_class_sis_queue;
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainenvoid fs_set_error(struct fs *fs, const char *fmt, ...) ATTR_FORMAT(2, 3);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainenvoid fs_set_critical(struct fs *fs, const char *fmt, ...) ATTR_FORMAT(2, 3);
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainenvoid fs_set_error_async(struct fs *fs);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen
84669c712403b742cc07ae70229725c486ef1235Timo Sirainenssize_t fs_read_via_stream(struct fs_file *file, void *buf, size_t size);
84669c712403b742cc07ae70229725c486ef1235Timo Sirainenint fs_write_via_stream(struct fs_file *file, const void *data, size_t size);
84669c712403b742cc07ae70229725c486ef1235Timo Sirainenvoid fs_metadata_init(struct fs_file *file);
84669c712403b742cc07ae70229725c486ef1235Timo Sirainenvoid fs_default_set_metadata(struct fs_file *file,
84669c712403b742cc07ae70229725c486ef1235Timo Sirainen const char *key, const char *value);
84669c712403b742cc07ae70229725c486ef1235Timo Sirainenint fs_default_copy(struct fs_file *src, struct fs_file *dest);
84669c712403b742cc07ae70229725c486ef1235Timo Sirainen
c33d3f93abf8392fdc60e12bea41ffd12cc85a8dTimo Sirainen#endif