index-storage.h revision 389e0ad41d4dd6acf50f855ecd5f0651082c9f31
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi#ifndef INDEX_STORAGE_H
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi#define INDEX_STORAGE_H
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi#include "file-dotlock.h"
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi#include "mail-storage-private.h"
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi#include "mail-index-private.h"
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi/* Max. mmap()ed size for a message */
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi#define MAIL_MMAP_BLOCK_SIZE (1024*256)
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi/* Block size when read()ing message. */
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi#define MAIL_READ_BLOCK_SIZE (1024*8)
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi#define MAILBOX_FULL_SYNC_INTERVAL 5
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomienum mailbox_lock_notify_type {
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi MAILBOX_LOCK_NOTIFY_NONE,
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi /* Mailbox is locked, will abort in secs_left */
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi MAILBOX_LOCK_NOTIFY_MAILBOX_ABORT,
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi /* Mailbox lock looks stale, will override in secs_left */
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi MAILBOX_LOCK_NOTIFY_MAILBOX_OVERRIDE
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi};
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomistruct index_mailbox {
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mailbox box;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi union mail_index_view_module_context view_module_ctx;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_storage *storage;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi enum mailbox_open_flags open_flags;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_index *index;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_index_view *view;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_cache *cache;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_vfuncs *mail_vfuncs;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi uint32_t md5hdr_ext_idx;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct timeout *notify_to;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct index_notify_file *notify_files;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct index_notify_io *notify_ios;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi time_t notify_last_check, notify_last_sent;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi time_t next_lock_notify; /* temporary */
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi enum mailbox_lock_notify_type last_notify_type;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi uint32_t commit_log_file_seq;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi uoff_t commit_log_file_offset;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi const ARRAY_TYPE(keywords) *keyword_names;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_cache_field *cache_fields;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi unsigned int mail_cache_min_mail_count;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi ARRAY_TYPE(seq_range) recent_flags;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi uint32_t recent_flags_prev_uid;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi uint32_t recent_flags_count;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi time_t sync_last_check;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi unsigned int readonly:1;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi unsigned int keep_recent:1;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi unsigned int keep_locked:1;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi unsigned int sent_diskspace_warning:1;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi unsigned int sent_readonly_flags_warning:1;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi unsigned int notify_pending:1;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi unsigned int move_to_memory:1;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi unsigned int fsync_disable:1;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi};
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomistruct index_transaction_context {
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mailbox_transaction_context mailbox_ctx;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_index_transaction_vfuncs super;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct index_mailbox *ibox;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi enum mailbox_transaction_flags flags;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi int mail_ref_count;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_index_transaction *trans;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_index_view *trans_view;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_cache_view *cache_view;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_cache_transaction_ctx *cache_trans;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi uint32_t *saved_uid_validity;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi uint32_t *first_saved_uid, *last_saved_uid;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi unsigned int cache_trans_failed:1;
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi};
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid mail_storage_set_index_error(struct index_mailbox *ibox);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_storage_lock_notify(struct index_mailbox *ibox,
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi enum mailbox_lock_notify_type notify_type,
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi unsigned int secs_left);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_storage_lock_notify_reset(struct index_mailbox *ibox);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomistruct mail_index *
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomiindex_storage_alloc(struct mail_storage *storage, const char *name,
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi enum mailbox_open_flags flags, const char *prefix);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_storage_unref(struct mail_index *index);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_storage_destroy_unrefed(void);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_storage_destroy(struct mail_storage *storage ATTR_UNUSED);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_storage_mailbox_init(struct index_mailbox *ibox, const char *name,
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi enum mailbox_open_flags flags,
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi bool move_to_memory);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_storage_mailbox_open(struct index_mailbox *ibox);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomiint index_storage_mailbox_close(struct mailbox *box);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomibool index_storage_is_readonly(struct mailbox *box);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomibool index_storage_allow_new_keywords(struct mailbox *box);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomibool index_storage_is_inconsistent(struct mailbox *box);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomiint index_mailbox_keyword_is_valid(struct index_mailbox *ibox,
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi const char *keyword, const char **error_r);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomiint index_keywords_create(struct mailbox *box, const char *const keywords[],
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_keywords **keywords_r, bool skip_invalid);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_keywords_free(struct mail_keywords *keywords);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_mailbox_set_recent_uid(struct index_mailbox *ibox, uint32_t uid);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_mailbox_set_recent_seq(struct index_mailbox *ibox,
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi struct mail_index_view *view,
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi uint32_t seq1, uint32_t seq2);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomibool index_mailbox_is_recent(struct index_mailbox *ibox, uint32_t uid);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomiunsigned int index_mailbox_get_recent_count(struct index_mailbox *ibox);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_mailbox_check_add(struct index_mailbox *ibox,
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi const char *path);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomivoid index_mailbox_check_remove_all(struct index_mailbox *ibox);
844129da33797fba15314372a0dfab4cfe8162e8Aki Tuomi
struct mailbox_sync_context *
index_mailbox_sync_init(struct mailbox *box, enum mailbox_sync_flags flags,
bool failed);
bool index_mailbox_sync_next(struct mailbox_sync_context *ctx,
struct mailbox_sync_rec *sync_rec_r);
int index_mailbox_sync_deinit(struct mailbox_sync_context *ctx,
enum mailbox_status_items status_items,
struct mailbox_status *status_r);
int index_storage_sync(struct mailbox *box, enum mailbox_sync_flags flags);
enum mailbox_sync_type index_sync_type_convert(enum mail_index_sync_type type);
void index_storage_get_status(struct mailbox *box,
enum mailbox_status_items items,
struct mailbox_status *status_r);
void index_storage_get_uids(struct mailbox *box, uint32_t uid1, uint32_t uid2,
uint32_t *seq1_r, uint32_t *seq2_r);
struct mailbox_header_lookup_ctx *
index_header_lookup_init(struct mailbox *box, const char *const headers[]);
void index_header_lookup_deinit(struct mailbox_header_lookup_ctx *ctx);
struct mail_search_context *
index_storage_search_init(struct mailbox_transaction_context *t,
const char *charset, struct mail_search_arg *args,
const enum mail_sort_type *sort_program);
int index_storage_search_deinit(struct mail_search_context *ctx);
int index_storage_search_next(struct mail_search_context *ctx,
struct mail *mail);
int index_storage_search_next_nonblock(struct mail_search_context *ctx,
struct mail *mail, bool *tryagain_r);
int index_storage_search_next_update_seq(struct mail_search_context *ctx);
void index_transaction_init(struct index_transaction_context *t,
struct index_mailbox *ibox);
int index_transaction_finish_commit(struct index_transaction_context *t,
uint32_t *log_file_seq_r,
uoff_t *log_file_offset_r);
void index_transaction_finish_rollback(struct index_transaction_context *t);
struct mailbox_transaction_context *
index_transaction_begin(struct mailbox *box,
enum mailbox_transaction_flags flags);
int index_transaction_commit(struct mailbox_transaction_context *t,
uint32_t *uid_validity_r,
uint32_t *first_saved_uid_r,
uint32_t *last_saved_uid_r);
void index_transaction_rollback(struct mailbox_transaction_context *t);
bool index_keyword_array_cmp(const ARRAY_TYPE(keyword_indexes) *k1,
const ARRAY_TYPE(keyword_indexes) *k2);
#endif