mail-index.c revision e06c0b65c16ccce69bbee009ead14d7d3d17a256
02c335c23bf5fa225a467c19f2c063fb0dc7b8c3Timo Sirainen/* Copyright (C) 2003-2004 Timo Sirainen */
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainenstruct mail_index *mail_index_alloc(const char *dir, const char *prefix)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainenstatic int mail_index_check_header(struct mail_index *index,
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen const struct mail_index_header *hdr = map->hdr;
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen compat_data[0] = MAIL_INDEX_COMPAT_LITTLE_ENDIAN;
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen if (hdr->major_version != MAIL_INDEX_MAJOR_VERSION) {
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen /* major version change - handle silently(?) */
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen if (memcmp(hdr->compat_data, compat_data, sizeof(compat_data)) != 0) {
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen /* architecture change - handle silently(?) */
09060303d565e15d54e42b4ef722f9d3c26f5336Timo Sirainen if ((map->hdr->flags & MAIL_INDEX_HDR_FLAG_CORRUPTED) != 0) {
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen /* either a crash or we've already complained about it */
a5ddfd7a8b473f73135b93d5e081e470a87f0f7eTimo Sirainen /* following some extra checks that only take a bit of CPU */
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
8b16d3b00f051401c97568697ccdbba48663759aTimo Sirainen if (hdr->recent_messages_count > hdr->messages_count ||
8b16d3b00f051401c97568697ccdbba48663759aTimo Sirainen hdr->seen_messages_count > hdr->messages_count ||
8b16d3b00f051401c97568697ccdbba48663759aTimo Sirainen hdr->deleted_messages_count > hdr->messages_count)
8b16d3b00f051401c97568697ccdbba48663759aTimo Sirainen if (hdr->first_recent_uid_lowwater > hdr->next_uid ||
eb209d12e3b1cfed564c35cf19fdb1bf7fcc6811Timo Sirainen hdr->first_unseen_uid_lowwater > hdr->next_uid ||
8b16d3b00f051401c97568697ccdbba48663759aTimo Sirainen hdr->first_deleted_uid_lowwater > hdr->next_uid)
8b16d3b00f051401c97568697ccdbba48663759aTimo Sirainenstatic void mail_index_map_clear(struct mail_index *index,
8b16d3b00f051401c97568697ccdbba48663759aTimo Sirainen if (munmap(map->mmap_base, map->mmap_size) < 0)
8b16d3b00f051401c97568697ccdbba48663759aTimo Sirainen mail_index_set_syscall_error(index, "munmap()");
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainenvoid mail_index_unmap(struct mail_index *index, struct mail_index_map *map)
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainenstatic void mail_index_unmap_forced(struct mail_index *index,
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainenstatic int mail_index_mmap(struct mail_index *index, struct mail_index_map *map)
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainen map->mmap_base = index->lock_type != F_WRLCK ?
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainen mail_index_set_syscall_error(index, "mmap()");
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainen if (map->mmap_size < MAIL_INDEX_HEADER_MIN_SIZE) {
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainen hdr->messages_count * sizeof(struct mail_index_record);
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainen records_count = (map->mmap_size - hdr->header_size) /
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainen "messages_count too large (%u > %u)",
4fda77c9e9fc68feb292c4dacae1fac49dd08165Timo Sirainen if (map->hdr->header_size < sizeof(*map->hdr)) {
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen /* header smaller than ours, make a copy so our newer headers
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen won't have garbage in them */
4fda77c9e9fc68feb292c4dacae1fac49dd08165Timo Sirainen memcpy(&map->hdr_copy, map->hdr, map->hdr->header_size);
4fda77c9e9fc68feb292c4dacae1fac49dd08165Timo Sirainen map->records = PTR_OFFSET(map->mmap_base, map->hdr->header_size);
4fda77c9e9fc68feb292c4dacae1fac49dd08165Timo Sirainen map->records_count = map->hdr->messages_count;
4fda77c9e9fc68feb292c4dacae1fac49dd08165Timo Sirainenstatic int mail_index_read_map(struct mail_index *index,
8c2b4a45f17a5cb13bb01058ca37798cf48d91baTimo Sirainen for (pos = 0; ret > 0 && pos < sizeof(hdr); ) {
ad404d294fedf792619aed432ed8de5174e9ce7cTimo Sirainen if (ret >= 0 && pos >= MAIL_INDEX_HEADER_MIN_SIZE) {
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen map->buffer = buffer_create_dynamic(default_pool,
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen /* @UNSAFE */
892e25e1c0caad62ced087d9eba2741a59e3d9ceTimo Sirainen data = buffer_append_space_unsafe(map->buffer, records_size);
e4194f4703eeec32b432371ae30fc8f25ab720d8Timo Sirainen ret = pread_full(index->fd, data, records_size,
e4194f4703eeec32b432371ae30fc8f25ab720d8Timo Sirainen mail_index_set_syscall_error(index, "pread_full()");
e4194f4703eeec32b432371ae30fc8f25ab720d8Timo Sirainen "Unexpected EOF while reading index file");
e4194f4703eeec32b432371ae30fc8f25ab720d8Timo Sirainenstatic int mail_index_read_map_with_retry(struct mail_index *index,
009217abb57a24a4076092e8e4e165545747839eStephan Bosch for (i = 0; i < MAIL_INDEX_ESTALE_RETRY_COUNT; i++) {
e4194f4703eeec32b432371ae30fc8f25ab720d8Timo Sirainen /* ESTALE - reopen index file */
e4194f4703eeec32b432371ae30fc8f25ab720d8Timo Sirainen mail_index_set_syscall_error(index, "close()");
e4194f4703eeec32b432371ae30fc8f25ab720d8Timo Sirainen /* the file was lost */
e4194f4703eeec32b432371ae30fc8f25ab720d8Timo Sirainen mail_index_set_syscall_error(index, "open()");
cf9d67e4a9bfee31cf3be05244555d51a3d1b9feTimo Sirainen /* Too many ESTALE retries */
892e25e1c0caad62ced087d9eba2741a59e3d9ceTimo Sirainen mail_index_set_syscall_error(index, "read_map()");
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainenint mail_index_map(struct mail_index *index, int force)
a4502a71879d6018bd2c64f13614bb619911dd9fTimo Sirainen } else if (MAIL_INDEX_MAP_IS_IN_MEMORY(map)) {
892e25e1c0caad62ced087d9eba2741a59e3d9ceTimo Sirainen /* we have modified this mapping and it's waiting to
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen be written to disk once we drop exclusive lock.
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen mapping couldn't have changed, so do nothing. */
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen /* FIXME: we need to re-read header */
cf9d67e4a9bfee31cf3be05244555d51a3d1b9feTimo Sirainen /* see if re-mmaping is needed (file has grown) */
a4502a71879d6018bd2c64f13614bb619911dd9fTimo Sirainen hdr->messages_count * sizeof(struct mail_index_record);
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen if (munmap(map->mmap_base, map->mmap_size) < 0)
28789c7ce1aa66ab21798bfb73ec64308b9a4de8Timo Sirainen mail_index_set_syscall_error(index, "munmap()");
09060303d565e15d54e42b4ef722f9d3c26f5336Timo Sirainen if ((ret = mail_index_mmap(index, map)) <= 0) {
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen if (mail_index_read_map_with_retry(index, map) < 0) {
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen map->log_file_offset = map->hdr->log_file_offset;
892e25e1c0caad62ced087d9eba2741a59e3d9ceTimo Sirainenstruct mail_index_map *mail_index_map_to_memory(struct mail_index_map *map)
28789c7ce1aa66ab21798bfb73ec64308b9a4de8Timo Sirainen size = map->records_count * sizeof(struct mail_index_record);
28789c7ce1aa66ab21798bfb73ec64308b9a4de8Timo Sirainen mem_map->buffer = buffer_create_dynamic(default_pool, size, (size_t)-1);
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen buffer_append(mem_map->buffer, map->records, size);
87842f621233257b7a7945d994ba931508b34877Timo Sirainen mem_map->records = buffer_get_modifyable_data(mem_map->buffer, NULL);
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen I_MIN(hdr->header_size, sizeof(mem_map->hdr_copy)));
892e25e1c0caad62ced087d9eba2741a59e3d9ceTimo Sirainenvoid mail_index_header_init(struct mail_index_header *hdr)
5e9bb72de1209cd39fdf3e95bdb26e047cc5594eTimo Sirainen hdr->major_version = MAIL_INDEX_MAJOR_VERSION;
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen hdr->minor_version = MAIL_INDEX_MINOR_VERSION;
e2a88d59c0d47d63ce1ad5b1fd95e487124a3fd4Timo Sirainen hdr->compat_data[0] = MAIL_INDEX_COMPAT_LITTLE_ENDIAN;
e2a88d59c0d47d63ce1ad5b1fd95e487124a3fd4Timo Sirainen hdr->compat_data[3] = sizeof(keywords_mask_t);
5e9bb72de1209cd39fdf3e95bdb26e047cc5594eTimo Sirainenint mail_index_write_header(struct mail_index *index,
0a53eb0283d7ec28c6105f61e118b96fce8ecb95Timo Sirainen if (!MAIL_INDEX_MAP_IS_IN_MEMORY(index->map)) {
9ffd3c8ca82bd2af8ca4f7e167339820ddcf1fe3Timo Sirainen memcpy(index->map->mmap_base, hdr, sizeof(*hdr));
0a53eb0283d7ec28c6105f61e118b96fce8ecb95Timo Sirainen if (msync(index->map->mmap_base, sizeof(*hdr), MS_SYNC) < 0)
0a53eb0283d7ec28c6105f61e118b96fce8ecb95Timo Sirainen return mail_index_set_syscall_error(index, "msync()");
9ffd3c8ca82bd2af8ca4f7e167339820ddcf1fe3Timo Sirainen if (pwrite_full(index->fd, hdr, sizeof(*hdr), 0) < 0) {
9ffd3c8ca82bd2af8ca4f7e167339820ddcf1fe3Timo Sirainen mail_index_set_syscall_error(index, "pwrite_full()");
892e25e1c0caad62ced087d9eba2741a59e3d9ceTimo Sirainenint mail_index_create_tmp_file(struct mail_index *index, const char **path_r)
892e25e1c0caad62ced087d9eba2741a59e3d9ceTimo Sirainen path = *path_r = t_strconcat(index->filepath, ".tmp", NULL);
5e9bb72de1209cd39fdf3e95bdb26e047cc5594eTimo Sirainen fd = open(path, O_RDWR|O_CREAT|O_TRUNC, index->mode);
5e9bb72de1209cd39fdf3e95bdb26e047cc5594eTimo Sirainen return mail_index_file_set_syscall_error(index, path, "open()");
e2a88d59c0d47d63ce1ad5b1fd95e487124a3fd4Timo Sirainen fchown(index->fd, (uid_t)-1, index->gid) < 0) {
5e9bb72de1209cd39fdf3e95bdb26e047cc5594eTimo Sirainen mail_index_file_set_syscall_error(index, path, "fchown()");
5e9bb72de1209cd39fdf3e95bdb26e047cc5594eTimo Sirainenstatic int mail_index_create(struct mail_index *index,
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen /* log file lock protects index creation */
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen if (mail_transaction_log_sync_lock(index->log, &seq, &offset) < 0)
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen /* create it fully in index.tmp first */
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen index->fd = mail_index_create_tmp_file(index, &path);
7bccaece91a0b1bc61111c30443d6bad6b22c6d0Timo Sirainen else if (write_full(index->fd, hdr, sizeof(*hdr)) < 0) {
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen mail_index_file_set_syscall_error(index, path, "write_full()");
093b42b11c1236a687d3da564b26a324e2189ae6Timo Sirainen /* it's corrupted even while we just created it,
7bccaece91a0b1bc61111c30443d6bad6b22c6d0Timo Sirainen should never happen unless someone pokes the file directly */
7bccaece91a0b1bc61111c30443d6bad6b22c6d0Timo Sirainen "Newly created index file is corrupted: %s", path);
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen mail_index_file_set_syscall_error(index, path,
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen /* make it visible to others */
7bccaece91a0b1bc61111c30443d6bad6b22c6d0Timo Sirainen mail_index_set_error(index, "rename(%s, %s) failed: %m",
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainenint mail_index_try_open_only(struct mail_index *index)
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen for (i = 0; i < 3; i++) {
7bccaece91a0b1bc61111c30443d6bad6b22c6d0Timo Sirainen /* May happen with some OSes with NFS. Try again, although
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen there's still a race condition with another computer
892e25e1c0caad62ced087d9eba2741a59e3d9ceTimo Sirainen creating the index file again. However, we can't try forever
892e25e1c0caad62ced087d9eba2741a59e3d9ceTimo Sirainen as ESTALE happens also if index directory has been deleted
7bccaece91a0b1bc61111c30443d6bad6b22c6d0Timo Sirainen from server.. */
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen return mail_index_set_syscall_error(index, "open()");
7bccaece91a0b1bc61111c30443d6bad6b22c6d0Timo Sirainen /* have to create it */
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainenint mail_index_try_open(struct mail_index *index, unsigned int *lock_id_r)
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen unsigned int lock_id;
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen if (mail_index_lock_shared(index, FALSE, &lock_id) < 0)
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainen /* it's corrupted - recreate it */
11ee3b40320a31669bd717fecbe1e332dad4fd84Timo Sirainenstatic int mail_index_open_files(struct mail_index *index,
7bccaece91a0b1bc61111c30443d6bad6b22c6d0Timo Sirainen unsigned int lock_id = 0;
edd318d5866ac3fbc6e8df28fb24a4dfef93c884Timo Sirainen else if (ret == 0) {
892e25e1c0caad62ced087d9eba2741a59e3d9ceTimo Sirainen /* doesn't exist, or corrupted */
edd318d5866ac3fbc6e8df28fb24a4dfef93c884Timo Sirainen if ((flags & MAIL_INDEX_OPEN_FLAG_CREATE) == 0)
09060303d565e15d54e42b4ef722f9d3c26f5336Timo Sirainen } else if (ret < 0)
09060303d565e15d54e42b4ef722f9d3c26f5336Timo Sirainen index->log = mail_transaction_log_open_or_create(index);
b2024fa4e6ed39f9b5b6bb6c051f6d535fc0e011Timo Sirainen return index->fd != -1 ? 1 : mail_index_create(index, &hdr);
edd318d5866ac3fbc6e8df28fb24a4dfef93c884Timo Sirainenint mail_index_open(struct mail_index *index, enum mail_index_open_flags flags)
edd318d5866ac3fbc6e8df28fb24a4dfef93c884Timo Sirainen index->filepath = i_strconcat(index->dir, "/", index->prefix, NULL);
e2a88d59c0d47d63ce1ad5b1fd95e487124a3fd4Timo Sirainen (flags & MAIL_INDEX_OPEN_FLAG_MMAP_DISABLE) != 0;
b2024fa4e6ed39f9b5b6bb6c051f6d535fc0e011Timo Sirainen (flags & MAIL_INDEX_OPEN_FLAG_MMAP_NO_WRITE) != 0;
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen (flags & MAIL_INDEX_OPEN_FLAG_FCNTL_LOCKS_DISABLE) != 0;
caa1fa99c79c568ce2e42477bc169e7024fb220bTimo Sirainen /* completely broken, reopen */
caa1fa99c79c568ce2e42477bc169e7024fb220bTimo Sirainen /* too many tries */
caa1fa99c79c568ce2e42477bc169e7024fb220bTimo Sirainenvoid mail_index_close(struct mail_index *index)
15ab2452b0220a115f4351ad9d7fd5ec70ae7966Timo Sirainen mail_index_set_syscall_error(index, "close()");
15ab2452b0220a115f4351ad9d7fd5ec70ae7966Timo Sirainenstruct mail_cache *mail_index_get_cache(struct mail_index *index)
15ab2452b0220a115f4351ad9d7fd5ec70ae7966Timo Sirainenint mail_index_set_error(struct mail_index *index, const char *fmt, ...)
550d2fe097e95f12e8fa60ef52753ea7fe53d4eaTimo Sirainenvoid mail_index_set_inconsistent(struct mail_index *index)
9ba1a38e2fa5ffe9d0db83c4a14a6552bcff3181Timo Sirainenvoid mail_index_mark_corrupted(struct mail_index *index)
9ba1a38e2fa5ffe9d0db83c4a14a6552bcff3181Timo Sirainen /* make sure we can write the header */
9ba1a38e2fa5ffe9d0db83c4a14a6552bcff3181Timo Sirainen if (!MAIL_INDEX_MAP_IS_IN_MEMORY(index->map)) {
9ba1a38e2fa5ffe9d0db83c4a14a6552bcff3181Timo Sirainen if (mprotect(index->map->mmap_base, sizeof(hdr),
9ba1a38e2fa5ffe9d0db83c4a14a6552bcff3181Timo Sirainen mail_index_set_syscall_error(index, "mprotect()");
9ba1a38e2fa5ffe9d0db83c4a14a6552bcff3181Timo Sirainen if (mail_index_write_header(index, &hdr) == 0) {
9ba1a38e2fa5ffe9d0db83c4a14a6552bcff3181Timo Sirainen mail_index_set_syscall_error(index, "fsync()");
9ba1a38e2fa5ffe9d0db83c4a14a6552bcff3181Timo Sirainenint mail_index_set_syscall_error(struct mail_index *index,
9ba1a38e2fa5ffe9d0db83c4a14a6552bcff3181Timo Sirainen return mail_index_set_error(index, "%s failed with index file %s: %m",
9ba1a38e2fa5ffe9d0db83c4a14a6552bcff3181Timo Sirainenint mail_index_file_set_syscall_error(struct mail_index *index,
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainen return mail_index_set_error(index, "%s failed with file %s: %m",
d2cadbf5445156fc12988506279d51d0e53b0449Timo Sirainenenum mail_index_error mail_index_get_last_error(struct mail_index *index)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainenconst char *mail_index_get_error_message(struct mail_index *index)
3c3001681da75afc68578a180ec8f8b2d6dfacfaTimo Sirainenvoid mail_index_reset_error(struct mail_index *index)