mail-index.c revision c53e8ee216904ffe6de4f6518d9f9f5107b7610e
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher/* Copyright (c) 2003-2007 Dovecot authors, see the included COPYING file */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherstruct mail_index_module_register mail_index_module_register = { 0 };
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherstruct mail_index *mail_index_alloc(const char *dir, const char *prefix)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher pool_alloconly_create(MEMPOOL_GROWING"index extension", 1024);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher p_array_init(&index->extensions, index->extension_pool, 5);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher i_array_init(&index->sync_lost_handlers, 4);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher mail_index_ext_register(index, "keywords", 128, 2, 1);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher index->keywords_pool = pool_alloconly_create("keywords", 512);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher hash_create(default_pool, index->keywords_pool, 0,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher strcase_hash, (hash_cmp_callback_t *)strcasecmp);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher index->log = mail_transaction_log_alloc(index);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_free(struct mail_index **_index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_set_permissions(struct mail_index *index,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagheruint32_t mail_index_ext_register(struct mail_index *index, const char *name,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (strcmp(name, str_sanitize(name, -1)) != 0)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher i_panic("mail_index_ext_register(%s): Invalid name", name);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (mail_index_ext_lookup(index, name, &ext_id))
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher rext.name = p_strdup(index->extension_pool, name);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher rext.index_idx = array_count(&index->extensions);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher array_append(&index->extensions, &rext, 1);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherbool mail_index_ext_lookup(struct mail_index *index, const char *name,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher const struct mail_index_registered_ext *extensions;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher unsigned int i, count;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher extensions = array_get(&index->extensions, &count);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher for (i = 0; i < count; i++) {
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (strcmp(extensions[i].name, name) == 0) {
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_register_expunge_handler(struct mail_index *index,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher rext = array_idx_modifiable(&index->extensions, ext_id);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher i_assert(rext->expunge_handler == NULL || rext->expunge_handler == cb);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher rext->expunge_handler_call_always = call_always;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_unregister_expunge_handler(struct mail_index *index,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher rext = array_idx_modifiable(&index->extensions, ext_id);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_register_sync_handler(struct mail_index *index, uint32_t ext_id,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher rext = array_idx_modifiable(&index->extensions, ext_id);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher i_assert(rext->sync_handler.callback == NULL);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_unregister_sync_handler(struct mail_index *index,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher rext = array_idx_modifiable(&index->extensions, ext_id);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher i_assert(rext->sync_handler.callback != NULL);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_register_sync_lost_handler(struct mail_index *index,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher array_append(&index->sync_lost_handlers, &cb, 1);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_unregister_sync_lost_handler(struct mail_index *index,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher mail_index_sync_lost_handler_t *const *handlers;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher unsigned int i, count;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher handlers = array_get(&index->sync_lost_handlers, &count);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher for (i = 0; i < count; i++) {
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher array_delete(&index->sync_lost_handlers, i, 1);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherbool mail_index_keyword_lookup(struct mail_index *index,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* keywords_hash keeps a name => index mapping of keywords.
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher Keywords are never removed from it, so the index values are valid
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher for the lifetime of the mail_index. */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (hash_lookup_full(index->keywords_hash, keyword, NULL, &value)) {
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher *idx_r = POINTER_CAST_TO(value, unsigned int);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_keyword_lookup_or_create(struct mail_index *index,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher unsigned int *idx_r)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (mail_index_keyword_lookup(index, keyword, idx_r))
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher keyword = keyword_dup = p_strdup(index->keywords_pool, keyword);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher hash_insert(index->keywords_hash, keyword_dup, POINTER_CAST(*idx_r));
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher array_append(&index->keywords, &keyword, 1);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherconst ARRAY_TYPE(keywords) *mail_index_get_keywords(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherint mail_index_try_open_only(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher i_assert(!MAIL_INDEX_IS_IN_MEMORY(index));
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* Note that our caller must close index->fd by itself. */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher index->fd = nfs_safe_open(index->filepath, O_RDWR);
bdd205037059e56484de3174951b22ff8f0f79f8Stephen Gallagher index->fd = open(index->filepath, O_RDONLY);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher return mail_index_set_syscall_error(index, "open()");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* have to create it */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghermail_index_try_open(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher i_assert(index->map == NULL || index->map->rec_map->lock_id == 0);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher ret = mail_index_map(index, MAIL_INDEX_SYNC_HANDLER_HEAD);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* it's corrupted - recreate it */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher mail_index_set_syscall_error(index, "close()");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherint mail_index_create_tmp_file(struct mail_index *index, const char **path_r)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher i_assert(!MAIL_INDEX_IS_IN_MEMORY(index));
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher path = *path_r = t_strconcat(index->filepath, ".tmp", NULL);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher fd = open(path, O_RDWR|O_CREAT|O_TRUNC, index->mode);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher return mail_index_file_set_syscall_error(index, path, "open()");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (index->gid != (gid_t)-1 && fchown(fd, (uid_t)-1, index->gid) < 0) {
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher mail_index_file_set_syscall_error(index, path, "fchown()");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherstatic int mail_index_open_files(struct mail_index *index,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher ret = mail_transaction_log_open(index->log);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if ((flags & MAIL_INDEX_OPEN_FLAG_CREATE) == 0)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* if dovecot.index exists, read it first so that we can get
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher the correct indexid and log sequence */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* Create a new indexid for us. If we're opening index
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher into memory, index->map doesn't exist yet. */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher ret = mail_transaction_log_create(index->log);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher ret = index->map != NULL ? 0 : mail_index_try_open(index);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* doesn't exist / corrupted */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher ret = mail_transaction_log_create(index->log);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* open/create failed, fallback to in-memory indexes */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if ((flags & MAIL_INDEX_OPEN_FLAG_CREATE) == 0)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher index->cache = created ? mail_cache_create(index) :
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherint mail_index_open(struct mail_index *index, enum mail_index_open_flags flags,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* corrupted, reopen files */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher index->filepath = MAIL_INDEX_IS_IN_MEMORY(index) ?
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher i_strconcat(index->dir, "/", index->prefix, NULL);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher index->mmap_disable = (flags & MAIL_INDEX_OPEN_FLAG_MMAP_DISABLE) != 0;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher (flags & MAIL_INDEX_OPEN_FLAG_DOTLOCK_USE_EXCL) != 0;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher (flags & MAIL_INDEX_OPEN_FLAG_FSYNC_DISABLE) != 0;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher index->nfs_flush = (flags & MAIL_INDEX_OPEN_FLAG_NFS_FLUSH) != 0;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher index->readonly = (flags & MAIL_INDEX_OPEN_FLAG_READONLY) != 0;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (index->nfs_flush && index->fsync_disable)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher i_fatal("nfs flush requires fsync_disable=no");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (index->nfs_flush && !index->mmap_disable)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher i_fatal("nfs flush requires mmap_disable=yes");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if ((ret = mail_index_open_files(index, flags)) <= 0) {
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* doesn't exist and create flag not used */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_close_file(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher mail_index_set_syscall_error(index, "close()");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_close(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherint mail_index_reopen_if_changed(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher return mail_index_set_syscall_error(index, "fstat()");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (nfs_safe_stat(index->filepath, &st2) < 0) {
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher return mail_index_set_syscall_error(index, "stat()");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (st1.st_ino == st2.st_ino && CMP_DEV_T(st1.st_dev, st2.st_dev)) {
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* the same file */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* new file, new locks. the old fd can keep its locks, they don't
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher matter anymore as no-one's going to modify the file. */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherint mail_index_refresh(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* we have index exclusively locked, nothing could
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher have changed. */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher ret = mail_index_map(index, MAIL_INDEX_SYNC_HANDLER_HEAD);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherstruct mail_cache *mail_index_get_cache(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherint mail_index_set_error(struct mail_index *index, const char *fmt, ...)
bdd205037059e56484de3174951b22ff8f0f79f8Stephen Gallagherint mail_index_move_to_memory(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* set the index as being into memory */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher index->filepath = i_strdup("(in-memory index)");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* index was never even opened. just mark it as being in
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher memory and let the caller re-open the index. */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* move index map to memory */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (!MAIL_INDEX_MAP_IS_IN_MEMORY(index->map)) {
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher /* move transaction log to memory */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher mail_transaction_log_move_to_memory(index->log);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher mail_index_set_syscall_error(index, "close()");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_mark_corrupted(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher index->map->hdr.flags |= MAIL_INDEX_HDR_FLAG_CORRUPTED;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher if (unlink(index->filepath) < 0 && errno != ENOENT && errno != ESTALE)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher mail_index_set_syscall_error(index, "unlink()");
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherint mail_index_set_syscall_error(struct mail_index *index,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher return mail_index_set_error(index, "%s failed with index file %s: %m",
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherint mail_index_file_set_syscall_error(struct mail_index *index,
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher return mail_index_set_error(index, "%s failed with file %s: %m",
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagherconst char *mail_index_get_error_message(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallaghervoid mail_index_reset_error(struct mail_index *index)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher/* FIXME: Unfortunately these functions were originally written to use
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher endian-specific code and we can't avoid that without breaking backwards
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher compatibility. When we do break it, just select one of these. */
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagheruint32_t mail_index_uint32_to_offset(uint32_t offset)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher return 0x00000080 | ((offset & 0x0000007f)) |
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher 0x00008000 | ((offset & 0x00003f80) >> 7 << 8) |
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher 0x00800000 | ((offset & 0x001fc000) >> 14 << 16) |
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher 0x80000000 | ((offset & 0x0fe00000) >> 21 << 24);
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagheruint32_t mail_index_offset_to_uint32(uint32_t offset)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher ((offset & 0x7f000000) >> 24 << 21)) << 2;
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagheruint32_t mail_index_uint32_to_offset(uint32_t offset)
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher return 0x80000000 | ((offset & 0x0000007f) << 24) |
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher 0x00800000 | ((offset & 0x00003f80) >> 7 << 16) |
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher 0x00008000 | ((offset & 0x001fc000) >> 14 << 8) |
52261fe16203dec6e6f69177c6d0a810b47d073fStephen Gallagher 0x00000080 | ((offset & 0x0fe00000) >> 21);