mail-index.c revision b4931fc08faa0079f32f29286f4c3abd0d8788bc
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen/* Copyright (C) 2003-2004 Timo Sirainen */
d6badc27cd6e8d3398877b6766cb0aaeef3a7800Timo Sirainenstatic int mail_index_try_open_only(struct mail_index *index);
d6badc27cd6e8d3398877b6766cb0aaeef3a7800Timo Sirainenstatic void mail_index_create_in_memory(struct mail_index *index,
4b231ca0bbe3b536acbd350101e183441ce0247aTimo Sirainenstruct mail_index *mail_index_alloc(const char *dir, const char *prefix)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen index->extension_pool = pool_alloconly_create("extension", 512);
024815ea2ffdda9ea79919f18e865663977f73eaTimo Sirainen ARRAY_CREATE(&index->extensions, index->extension_pool,
91dca97b367c54a139c268b56a0c67f564bd9197Timo Sirainen ARRAY_CREATE(&index->sync_lost_handlers, default_pool,
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen mail_index_ext_register(index, "keywords", 128, 2, 1);
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen index->keywords_pool = pool_alloconly_create("keywords", 512);
41e1c7380edda701719d8ce1fb4d465d2ec4c84dTimo Sirainen ARRAY_CREATE(&index->keywords, default_pool, const char *, 16);
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen hash_create(default_pool, index->keywords_pool, 0,
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen strcase_hash, (hash_cmp_callback_t *)strcasecmp);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenvoid mail_index_free(struct mail_index **_index)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenvoid mail_index_set_permissions(struct mail_index *index,
20a802016205bbcafc90f164f769ea801f88d014Timo Sirainenuint32_t mail_index_ext_register(struct mail_index *index, const char *name,
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen const struct mail_index_registered_ext *extensions;
c27f03fa8fd2ef4acd1db814fae7d90e0eb9d3aeTimo Sirainen unsigned int i, ext_count;
287ba82a8da3eaa473b5735d4eeac2fb4c5d8117Timo Sirainen extensions = array_get(&index->extensions, &ext_count);
287ba82a8da3eaa473b5735d4eeac2fb4c5d8117Timo Sirainen /* see if it's already there */
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen for (i = 0; i < ext_count; i++) {
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen rext.name = p_strdup(index->extension_pool, name);
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainenvoid mail_index_register_expunge_handler(struct mail_index *index,
6a19e109ee8c5a6f688da83a86a7f6abeb71abddTimo Sirainen rext = array_idx_modifyable(&index->extensions, ext_id);
de12ff295bb3d0873b4dced5840612cbacd635efTimo Sirainenvoid mail_index_unregister_expunge_handler(struct mail_index *index,
519e0a461271843833a2b42626ad93f6e7ddc497Timo Sirainen rext = array_idx_modifyable(&index->extensions, ext_id);
de12ff295bb3d0873b4dced5840612cbacd635efTimo Sirainenvoid mail_index_register_sync_handler(struct mail_index *index, uint32_t ext_id,
5626ae5e3316eced244adb6485c0927f1c7fdc41Timo Sirainen rext = array_idx_modifyable(&index->extensions, ext_id);
5626ae5e3316eced244adb6485c0927f1c7fdc41Timo Sirainen i_assert(rext->sync_handler.callback == NULL);
519e0a461271843833a2b42626ad93f6e7ddc497Timo Sirainenvoid mail_index_unregister_sync_handler(struct mail_index *index,
519e0a461271843833a2b42626ad93f6e7ddc497Timo Sirainen rext = array_idx_modifyable(&index->extensions, ext_id);
519e0a461271843833a2b42626ad93f6e7ddc497Timo Sirainen i_assert(rext->sync_handler.callback != NULL);
519e0a461271843833a2b42626ad93f6e7ddc497Timo Sirainenvoid mail_index_register_sync_lost_handler(struct mail_index *index,
519e0a461271843833a2b42626ad93f6e7ddc497Timo Sirainen array_append(&index->sync_lost_handlers, &cb, 1);
f23298fea47eecbeded985ee2537a34c4c4ef56bTimo Sirainenvoid mail_index_unregister_sync_lost_handler(struct mail_index *index,
f23298fea47eecbeded985ee2537a34c4c4ef56bTimo Sirainen mail_index_sync_lost_handler_t *const *handlers;
f23298fea47eecbeded985ee2537a34c4c4ef56bTimo Sirainen unsigned int i, count;
519e0a461271843833a2b42626ad93f6e7ddc497Timo Sirainen handlers = array_get(&index->sync_lost_handlers, &count);
519e0a461271843833a2b42626ad93f6e7ddc497Timo Sirainen for (i = 0; i < count; i++) {
519e0a461271843833a2b42626ad93f6e7ddc497Timo Sirainen array_delete(&index->sync_lost_handlers, i, 1);
519e0a461271843833a2b42626ad93f6e7ddc497Timo Sirainenstatic void mail_index_map_init_extbufs(struct mail_index_map *map,
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen size = (sizeof(array_t) + BUFFER_APPROX_SIZE) * 2 +
003079baf8056c81c25162a176a89f9169cc374fTimo Sirainen sizeof(struct mail_index_ext) +
003079baf8056c81c25162a176a89f9169cc374fTimo Sirainen ARRAY_CREATE(&map->extensions, map->extension_pool,
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainen ARRAY_CREATE(&map->ext_id_map, map->extension_pool,
003079baf8056c81c25162a176a89f9169cc374fTimo Sirainenuint32_t mail_index_map_lookup_ext(struct mail_index_map *map, const char *name)
003079baf8056c81c25162a176a89f9169cc374fTimo Sirainen unsigned int i, size;
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen extensions = array_get(&map->extensions, &size);
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen for (i = 0; i < size; i++) {
287ba82a8da3eaa473b5735d4eeac2fb4c5d8117Timo Sirainenmail_index_map_register_ext(struct mail_index *index,
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen i_assert(mail_index_map_lookup_ext(map, name) == (uint32_t)-1);
6a19e109ee8c5a6f688da83a86a7f6abeb71abddTimo Sirainen ext->name = p_strdup(map->extension_pool, name);
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen ext->index_idx = mail_index_ext_register(index, name, hdr_size,
b79ec51bdeef6ef950eb5e890e65cc0491cf5fe9Timo Sirainen /* Update index ext_id -> map ext_id mapping. Fill non-used
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen ext_ids with (uint32_t)-1 */
053843989f13d9013b265fb401a4bde7e0e6568eTimo Sirainen while (array_count(&map->ext_id_map) < ext->index_idx)
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainen array_append(&map->ext_id_map, &empty_idx, 1);
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainen array_idx_set(&map->ext_id_map, ext->index_idx, &idx);
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainenstatic bool size_check(size_t *size_left, size_t size)
287ba82a8da3eaa473b5735d4eeac2fb4c5d8117Timo Sirainen size_t size = sizeof(struct mail_index_ext_header) + name_len;
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen return MAIL_INDEX_HEADER_SIZE_ALIGN(size) - size;
6ef7e31619edfaa17ed044b45861d106a86191efTimo Sirainenstatic int mail_index_parse_extensions(struct mail_index *index,
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen unsigned int i, old_count;
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen /* extension headers always start from 64bit offsets, so if base header
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen doesn't happen to be 64bit aligned we'll skip some bytes */
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen offset = MAIL_INDEX_HEADER_SIZE_ALIGN(map->hdr.base_header_size);
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen if (offset >= map->hdr.header_size && map->extension_pool == NULL) {
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen /* nothing to do, skip allocatations and all */
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen mail_index_map_init_extbufs(map, old_count + 5);
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen for (i = 0; i < old_count; i++)
1b3bb8d39686ed24730cbc31cc9a33dc62c8c6c3Timo Sirainen ext_hdr = CONST_PTR_OFFSET(map->hdr_base, offset);
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen /* Extension header contains:
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen - struct mail_index_ext_header
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen - name (not 0-terminated)
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen - 64bit alignment padding
287ba82a8da3eaa473b5735d4eeac2fb4c5d8117Timo Sirainen - extension header contents
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainen - 64bit alignment padding
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainen if (!size_check(&size_left, sizeof(*ext_hdr)) ||
287ba82a8da3eaa473b5735d4eeac2fb4c5d8117Timo Sirainen !size_check(&size_left, ext_hdr->name_size) ||
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen !size_check(&size_left, get_align(ext_hdr->name_size)) ||
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen "Header extension goes outside header",
6a04c5112961c5f4fb2d2f25192b3dc424d62ad0Timo Sirainen offset += ext_hdr->name_size + get_align(ext_hdr->name_size);
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen name = t_strndup(CONST_PTR_OFFSET(map->hdr_base, name_offset),
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen if (mail_index_map_lookup_ext(map, name) != (uint32_t)-1) {
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen "Duplicate header extension %s",
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen if ((ext_hdr->record_offset % ext_hdr->record_align) != 0 ||
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen (map->hdr.record_size % ext_hdr->record_align) != 0) {
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen "Record field %s alignmentation %u not used",
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen index->filepath, name, ext_hdr->record_align);
64541374b58e4c702b1926e87df421d180ffa006Timo Sirainen offset += MAIL_INDEX_HEADER_SIZE_ALIGN(ext_hdr->hdr_size);
64541374b58e4c702b1926e87df421d180ffa006Timo Sirainenbool mail_index_keyword_lookup(struct mail_index *index,
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen unsigned int *idx_r)
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen /* keywords_hash keeps a name => index mapping of keywords.
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen Keywords are never removed from it, so the index values are valid
bbf796c17f02538058d7559bfe96d677e5b55015Timo Sirainen for the lifetime of the mail_index. */
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen if (hash_lookup_full(index->keywords_hash, keyword, NULL, &value)) {
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen *idx_r = POINTER_CAST_TO(value, unsigned int);
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen keyword = keyword_dup = p_strdup(index->keywords_pool, keyword);
6a04c5112961c5f4fb2d2f25192b3dc424d62ad0Timo Sirainen hash_insert(index->keywords_hash, keyword_dup, POINTER_CAST(*idx_r));
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainenint mail_index_map_parse_keywords(struct mail_index *index,
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen const struct mail_index_keyword_header *kw_hdr;
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen const struct mail_index_keyword_header_rec *kw_rec;
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen unsigned int i, name_area_end_offset, old_count;
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen ext_id = mail_index_map_lookup_ext(map, "keywords");
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen /* Extension header contains:
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen - struct mail_index_keyword_header
6a04c5112961c5f4fb2d2f25192b3dc424d62ad0Timo Sirainen - struct mail_index_keyword_header_rec * keywords_count
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen - const char names[] * keywords_count
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen i_assert(ext->hdr_offset < map->hdr.header_size);
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen kw_hdr = CONST_PTR_OFFSET(map->hdr_base, ext->hdr_offset);
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen name = (const char *)(kw_rec + kw_hdr->keywords_count);
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen old_count = !array_is_created(&map->keyword_idx_map) ? 0 :
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen /* Keywords can only be added into same mapping. Removing requires a
6a04c5112961c5f4fb2d2f25192b3dc424d62ad0Timo Sirainen new mapping (recreating the index file) */
6a04c5112961c5f4fb2d2f25192b3dc424d62ad0Timo Sirainen /* nothing changed */
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen /* make sure the header is valid */
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen "Keywords removed unexpectedly",
6a04c5112961c5f4fb2d2f25192b3dc424d62ad0Timo Sirainen if ((size_t)(name - (const char *)kw_hdr) > ext->hdr_size) {
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen "keywords_count larger than header size",
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen name_area_end_offset = (const char *)kw_hdr + ext->hdr_size - name;
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen for (i = 0; i < kw_hdr->keywords_count; i++) {
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen if (kw_rec[i].name_offset > name_area_end_offset) {
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen "name_offset points outside allocated header",
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen "Keyword header doesn't end with NUL",
6a04c5112961c5f4fb2d2f25192b3dc424d62ad0Timo Sirainen /* create file -> index mapping */
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen if (!array_is_created(&map->keyword_idx_map)) {
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen ARRAY_CREATE(&map->keyword_idx_map, default_pool,
6a04c5112961c5f4fb2d2f25192b3dc424d62ad0Timo Sirainen /* Check that existing headers are still the same. It's behind DEBUG
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen since it's pretty useless waste of CPU normally. */
871c7b8969e8627dc4c8b3e56fd126f948e6bce6Timo Sirainen for (i = 0; i < array_count(&map->keyword_idx_map); i++) {
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen const char *keyword = name + kw_rec[i].name_offset;
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen const unsigned int *old_idx;
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen unsigned int idx;
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen old_idx = array_idx(&map->keyword_idx_map, i);
91dca97b367c54a139c268b56a0c67f564bd9197Timo Sirainen if (!mail_index_keyword_lookup(index, keyword, FALSE, &idx) ||
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen "Keywords changed unexpectedly",
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen /* Register the newly seen keywords */
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen const char *keyword = name + kw_rec[i].name_offset;
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen unsigned int idx;
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen (void)mail_index_keyword_lookup(index, keyword, TRUE, &idx);
6a04c5112961c5f4fb2d2f25192b3dc424d62ad0Timo Sirainenconst array_t *mail_index_get_keywords(struct mail_index *index)
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen /* Make sure all the keywords are in index->keywords. It's quick to do
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen if nothing has changed. */
bb10ebcf076c959c752f583746d83805d7686df8Timo Sirainen (void)mail_index_map_parse_keywords(index, index->map);
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainenstatic int mail_index_check_header(struct mail_index *index,
8d80659e504ffb34bb0c6a633184fece35751b18Timo Sirainen const struct mail_index_header *hdr = &map->hdr;
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen enum mail_index_header_compat_flags compat_flags = 0;
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen compat_flags |= MAIL_INDEX_COMPAT_LITTLE_ENDIAN;
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen if (hdr->major_version != MAIL_INDEX_MAJOR_VERSION) {
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen /* major version change - handle silently(?) */
1b3bb8d39686ed24730cbc31cc9a33dc62c8c6c3Timo Sirainen /* architecture change - handle silently(?) */
811f2e26d9782d9cb99fdf82e18ffa0a77564fe2Timo Sirainen if ((map->hdr.flags & MAIL_INDEX_HDR_FLAG_CORRUPTED) != 0) {
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* we've already complained about it */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* following some extra checks that only take a bit of CPU */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen if (hdr->uid_validity == 0 && hdr->next_uid != 1) {
811f2e26d9782d9cb99fdf82e18ffa0a77564fe2Timo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen "uid_validity = 0, next_uid = %u",
8830fab191cab8440281eb641dfdd93974b2933bTimo Sirainen if (hdr->record_size < sizeof(struct mail_index_record)) {
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen sizeof(struct mail_index_record));
92888ef30960c30ccc9e030fe7eab5d4d04a7d1cTimo Sirainen if ((hdr->flags & MAIL_INDEX_HDR_FLAG_FSCK) != 0)
7e94cf9d70ce9fdeccb7a85ff400b899e6386f36Timo Sirainen if (hdr->recent_messages_count > hdr->messages_count ||
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen hdr->seen_messages_count > hdr->messages_count ||
7e94cf9d70ce9fdeccb7a85ff400b899e6386f36Timo Sirainen hdr->deleted_messages_count > hdr->messages_count)
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen if (hdr->first_recent_uid_lowwater > hdr->next_uid ||
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen hdr->first_unseen_uid_lowwater > hdr->next_uid ||
e12648867876aaec17e06ee4caef0bb60363449dTimo Sirainen hdr->first_deleted_uid_lowwater > hdr->next_uid)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen return mail_index_parse_extensions(index, map);
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainenstatic void mail_index_map_clear(struct mail_index *index,
5e69206e0b13bbe3dbc50c5dc6c58da007402237Timo Sirainen if (munmap(map->mmap_base, map->mmap_size) < 0)
5e69206e0b13bbe3dbc50c5dc6c58da007402237Timo Sirainen mail_index_set_syscall_error(index, "munmap()");
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenvoid mail_index_unmap(struct mail_index *index, struct mail_index_map **_map)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenstatic void mail_index_map_copy_hdr(struct mail_index_map *map,
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen if (hdr->base_header_size < sizeof(map->hdr)) {
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen /* header smaller than ours, make a copy so our newer headers
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen won't have garbage in them */
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen memcpy(&map->hdr, hdr, hdr->base_header_size);
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainenstatic int mail_index_mmap(struct mail_index *index, struct mail_index_map *map)
0ce3bbb0f03fb0ee99258b41b5a1d689c1158a75Timo Sirainen /* we had temporarily used a buffer, eg. for updating index */
0ce3bbb0f03fb0ee99258b41b5a1d689c1158a75Timo Sirainen mail_index_set_syscall_error(index, "mmap()");
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen offsetof(struct mail_index_header, major_version) &&
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen hdr->major_version != MAIL_INDEX_MAJOR_VERSION) {
3c24d47ad5ff02ea00684233bef314ef2eefda4aTimo Sirainen /* major version change - handle silently */
3c24d47ad5ff02ea00684233bef314ef2eefda4aTimo Sirainen if (map->mmap_size < MAIL_INDEX_HEADER_MIN_SIZE) {
3c24d47ad5ff02ea00684233bef314ef2eefda4aTimo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen records_count = (map->mmap_size - hdr->header_size) /
91b5eae18db48ebb70eee5407a7ab52bf798ee12Timo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
91b5eae18db48ebb70eee5407a7ab52bf798ee12Timo Sirainen "messages_count too large (%u > %u)",
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen map->records = PTR_OFFSET(map->mmap_base, map->hdr.header_size);
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainenstatic int mail_index_read_header(struct mail_index *index,
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen memset(buf, 0, sizeof(struct mail_index_header));
cd65dfcedc603fabbf644be793efb09096f6c1b5Timo Sirainen /* try to read the whole header, but it's not necessarily an error to
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen read less since the older versions of the index format could be
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen smaller. Request reading up to buf_size, but accept if we only got
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen the header. */
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen } while (ret > 0 && pos < sizeof(struct mail_index_header));
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainenmail_index_read_map(struct mail_index *index, struct mail_index_map *map,
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen ret = mail_index_read_header(index, buf, sizeof(buf), &pos);
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen if (pos > (ssize_t)offsetof(struct mail_index_header, major_version) &&
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen hdr->major_version != MAIL_INDEX_MAJOR_VERSION) {
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen /* major version change - handle silently */
c485524d09c650ff6e6c552129d4257ac6145a8bTimo Sirainen if (ret >= 0 && pos >= MAIL_INDEX_HEADER_MIN_SIZE &&
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen if (hdr->base_header_size < MAIL_INDEX_HEADER_MIN_SIZE ||
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen mail_index_set_error(index, "Corrupted index file %s: "
28dd1eeb9fdb93051bb5899c80cf300d69ba9f9eTimo Sirainen "Corrupted header sizes (base %u, full %u)",
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen /* place the base header into memory. */
91b5eae18db48ebb70eee5407a7ab52bf798ee12Timo Sirainen /* @UNSAFE: read the rest of the header into memory */
91b5eae18db48ebb70eee5407a7ab52bf798ee12Timo Sirainen data = buffer_append_space_unsafe(map->hdr_copy_buf,
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen /* header read, read the records now. */
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen records_size = hdr->messages_count * hdr->record_size;
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen map->buffer = buffer_create_dynamic(default_pool,
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen /* @UNSAFE */
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen data = buffer_append_space_unsafe(map->buffer, records_size);
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen ret = pread_full(index->fd, data, records_size,
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen /* a new index file was renamed over this one. */
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen mail_index_set_syscall_error(index, "pread_full()");
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen "Corrupted index file %s: File too small",
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen index->sync_log_file_offset = hdr->log_file_int_offset;
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainenstatic int mail_index_sync_from_transactions(struct mail_index *index,
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen const struct mail_index_header *map_hdr = &(*map)->hdr;
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen /* read the real log position where we are supposed to be
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen ret = mail_index_read_header(index, &hdr, sizeof(hdr), &pos);
fea541eec46707f9b01bd3cbc981d73c1e808a54Timo Sirainen mail_index_set_syscall_error(index, "pread()");
fea541eec46707f9b01bd3cbc981d73c1e808a54Timo Sirainen if (map_hdr->log_file_seq == hdr.log_file_seq &&
fea541eec46707f9b01bd3cbc981d73c1e808a54Timo Sirainen map_hdr->log_file_int_offset == hdr.log_file_int_offset) {
fea541eec46707f9b01bd3cbc981d73c1e808a54Timo Sirainen /* nothing to do */
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen if (map_hdr->log_file_seq > hdr.log_file_seq ||
6ef7e31619edfaa17ed044b45861d106a86191efTimo Sirainen map_hdr->log_file_int_offset > hdr.log_file_int_offset)) {
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen /* we went too far, have to re-read the file */
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen hdr.log_file_ext_offset != hdr.log_file_int_offset) {
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen /* too much trouble to get this right. */
0c583855501178ec9c62f2a94946192df2a01be4Timo Sirainen /* sync everything there is */
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen log_view = mail_transaction_log_view_open(index->log);
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen /* can't use it. sync by re-reading index. */
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen while ((ret = mail_transaction_log_view_next(log_view, &thdr, &tdata,
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen if (mail_index_sync_record(&sync_map_ctx, thdr, tdata) < 0) {
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen mail_transaction_log_view_get_prev_pos(log_view, &prev_seq,
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen (prev_seq != max_seq || prev_offset <= max_offset));
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen index->map->hdr.log_file_ext_offset = prev_offset;
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen /* make sure we did everything right. note that although the
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen message counts should be equal, the flag counters may not */
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen i_assert(hdr.messages_count == (*map)->hdr.messages_count);
45edf6cad665a5c270322516c587708a0c630b80Timo Sirainen i_assert(hdr.log_file_seq == (*map)->hdr.log_file_seq);
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen i_assert(hdr.log_file_int_offset == (*map)->hdr.log_file_int_offset);
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen i_assert(hdr.log_file_ext_offset == (*map)->hdr.log_file_ext_offset);
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainenstatic int mail_index_read_map_with_retry(struct mail_index *index,
fea541eec46707f9b01bd3cbc981d73c1e808a54Timo Sirainen mail_index_sync_lost_handler_t *const *handlers;
fea541eec46707f9b01bd3cbc981d73c1e808a54Timo Sirainen unsigned int i, count;
0c583855501178ec9c62f2a94946192df2a01be4Timo Sirainen /* we're most likely syncing the index and we really don't
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen want to read more than what was synced last time. */
0c583855501178ec9c62f2a94946192df2a01be4Timo Sirainen if ((*map)->hdr.indexid != 0 && index->log != NULL) {
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen /* we're not creating the index, or opening transaction log.
0b38c17fb10e2ad1d081369d34b93d0448d971a2Timo Sirainen sync this as a view from transaction log. */
f2786c07cbd4a7a0a6a46c3e06dc4545aaf2f278Timo Sirainen ret = mail_index_sync_from_transactions(index, map,
0b38c17fb10e2ad1d081369d34b93d0448d971a2Timo Sirainen /* transaction log lost/broken, fallback to re-reading it */
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen /* notify all "sync lost" handlers */
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen handlers = array_get(&index->sync_lost_handlers, &count);
45edf6cad665a5c270322516c587708a0c630b80Timo Sirainen for (i = 0; i < count; i++)
0c583855501178ec9c62f2a94946192df2a01be4Timo Sirainen for (i = 0;; i++) {
a80241dc44ee43bc809ed5ec6dedb74711966dafTimo Sirainen ret = mail_index_read_map(index, *map, &retry,
a80241dc44ee43bc809ed5ec6dedb74711966dafTimo Sirainen /* ESTALE - reopen index file */
09714f2f8d4c8cc7d89930f7eb836816d8dc9eb8Timo Sirainen mail_index_set_syscall_error(index, "close()");
6ef7e31619edfaa17ed044b45861d106a86191efTimo Sirainen /* the file was lost */
f23298fea47eecbeded985ee2537a34c4c4ef56bTimo Sirainen mail_index_set_syscall_error(index, "open()");
673ab5815277e6f9ac09227c866c90ab57438912Timo Sirainen /* Too many ESTALE retries */
673ab5815277e6f9ac09227c866c90ab57438912Timo Sirainen mail_index_set_syscall_error(index, "read_map()");
2ef8fac74c9d0bfc330bf53bb06df7e9d5f08e7dTimo Sirainenstatic int mail_index_map_try_existing(struct mail_index_map *map)
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen /* always check corrupted-flag to avoid errors later */
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen if ((hdr->flags & MAIL_INDEX_HDR_FLAG_CORRUPTED) != 0)
287ba82a8da3eaa473b5735d4eeac2fb4c5d8117Timo Sirainen used_size = hdr->header_size + hdr->messages_count * hdr->record_size;
287ba82a8da3eaa473b5735d4eeac2fb4c5d8117Timo Sirainen if (map->mmap_size >= used_size && map->hdr_base == hdr) {
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainenint mail_index_map(struct mail_index *index, bool force)
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen i_assert(index->map == NULL || index->map->refcount > 0);
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen ret = mail_index_map_try_existing(index->map);
e2ea49bd487d76b425e270321e9cf1e546642de0Timo Sirainen /* we're syncing, don't break the mapping */
e2ea49bd487d76b425e270321e9cf1e546642de0Timo Sirainen if (index->map != NULL && index->map->refcount > 1) {
1b3bb8d39686ed24730cbc31cc9a33dc62c8c6c3Timo Sirainen /* this map is already used by some views and they may have
e2ea49bd487d76b425e270321e9cf1e546642de0Timo Sirainen pointers into it. leave them and create a new mapping. */
e2ea49bd487d76b425e270321e9cf1e546642de0Timo Sirainen /* create a copy of the mapping instead so we don't
e2ea49bd487d76b425e270321e9cf1e546642de0Timo Sirainen have to re-read it */
4b231ca0bbe3b536acbd350101e183441ce0247aTimo Sirainen buffer_create_dynamic(default_pool, sizeof(map->hdr));
4b231ca0bbe3b536acbd350101e183441ce0247aTimo Sirainen } else if (MAIL_INDEX_MAP_IS_IN_MEMORY(map)) {
e2ea49bd487d76b425e270321e9cf1e546642de0Timo Sirainen if (munmap(map->mmap_base, map->mmap_size) < 0)
20c26f4fcf9ef87434761829cc209c2f84ff5716Timo Sirainen mail_index_set_syscall_error(index, "munmap()");
6a19e109ee8c5a6f688da83a86a7f6abeb71abddTimo Sirainen ret = mail_index_read_map_with_retry(index, &map, force);
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainen else if (ret == 0) {
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen i_assert(map->hdr.messages_count == map->records_count);
e86d0d34fe365da4c7ca4312d575bfcbf3a01c0eTimo Sirainenint mail_index_get_latest_header(struct mail_index *index,
19593623a2278039be23fc93e3404c012920b664Timo Sirainen unsigned int i;
20c26f4fcf9ef87434761829cc209c2f84ff5716Timo Sirainen for (i = 0;; i++) {
ed3ce1282f6bc35d20e82c2c23a2990c8dfe876fTimo Sirainen ret = mail_index_read_header(index, hdr_r, sizeof(*hdr_r),
ed3ce1282f6bc35d20e82c2c23a2990c8dfe876fTimo Sirainen /* ESTALE - reopen index file */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen mail_index_set_syscall_error(index, "close()");
ed3ce1282f6bc35d20e82c2c23a2990c8dfe876fTimo Sirainen /* the file was lost */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen mail_index_set_syscall_error(index, "open()");
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen mail_index_set_syscall_error(index, "pread_full()");
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainenmail_index_map_clone(struct mail_index_map *map, uint32_t new_record_size)
75ef04fc62a3955d3a5310410e09735cbd4e972bTimo Sirainen unsigned int i, count;
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen mem_map->buffer = buffer_create_dynamic(default_pool, size);
c485524d09c650ff6e6c552129d4257ac6145a8bTimo Sirainen buffer_append(mem_map->buffer, map->records, size);
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen copy_size = I_MIN(map->hdr.record_size, new_record_size);
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen dest = buffer_append_space_unsafe(mem_map->buffer,
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen mem_map->records = buffer_get_modifyable_data(mem_map->buffer, NULL);
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen buffer_create_dynamic(default_pool, map->hdr.header_size);
75ef04fc62a3955d3a5310410e09735cbd4e972bTimo Sirainen buffer_append_zero(mem_map->hdr_copy_buf, sizeof(*hdr));
75ef04fc62a3955d3a5310410e09735cbd4e972bTimo Sirainen map->hdr.header_size - map->hdr.base_header_size);
d7095f3a4466fbb78b2d5eb3d322bc15a5b0ab1fTimo Sirainen hdr = buffer_get_modifyable_data(mem_map->hdr_copy_buf, NULL);
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen /* copy extensions */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen mail_index_map_init_extbufs(mem_map, count + 2);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen array_append_array(&mem_map->extensions, &map->extensions);
4b058f90f9e8a2c6b2eed275de4eb8cc5195a71dTimo Sirainen array_append_array(&mem_map->ext_id_map, &map->ext_id_map);
7e94cf9d70ce9fdeccb7a85ff400b899e6386f36Timo Sirainen /* fix the name pointers to use our own pool */
7e94cf9d70ce9fdeccb7a85ff400b899e6386f36Timo Sirainen extensions = array_get_modifyable(&mem_map->extensions, &count);
1b3bb8d39686ed24730cbc31cc9a33dc62c8c6c3Timo Sirainen for (i = 0; i < count; i++) {
7e94cf9d70ce9fdeccb7a85ff400b899e6386f36Timo Sirainen extensions[i].name = p_strdup(mem_map->extension_pool,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenint mail_index_map_get_ext_idx(struct mail_index_map *map,
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainenstatic int mail_index_try_open_only(struct mail_index *index)
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen /* Note that our caller must close index->fd by itself.
1b3bb8d39686ed24730cbc31cc9a33dc62c8c6c3Timo Sirainen mail_index_reopen() for example wants to revert back to old
1b3bb8d39686ed24730cbc31cc9a33dc62c8c6c3Timo Sirainen index file if opening the new one fails. */
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen index->fd = nfs_safe_open(index->filepath, O_RDWR);
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainen return mail_index_set_syscall_error(index, "open()");
287ba82a8da3eaa473b5735d4eeac2fb4c5d8117Timo Sirainen /* have to create it */
8d80659e504ffb34bb0c6a633184fece35751b18Timo Sirainenmail_index_try_open(struct mail_index *index, unsigned int *lock_id_r)
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainen unsigned int lock_id;
5a07b37a9df398b5189c14872a600384208ab74bTimo Sirainen if (mail_index_lock_shared(index, FALSE, &lock_id) < 0) {
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen /* it's corrupted - recreate it */
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainenint mail_index_write_base_header(struct mail_index *index,
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen hdr_size = I_MIN(sizeof(*hdr), hdr->base_header_size);
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen if (!MAIL_INDEX_MAP_IS_IN_MEMORY(index->map)) {
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen if (msync(index->map->mmap_base, hdr_size, MS_SYNC) < 0)
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen return mail_index_set_syscall_error(index, "msync()");
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen if (pwrite_full(index->fd, hdr, hdr_size, 0) < 0) {
d9fdacd5fb3e07997e5c389739d2054f0c8441d8Timo Sirainen "pwrite_full()");
4b231ca0bbe3b536acbd350101e183441ce0247aTimo Sirainen buffer_write(index->map->hdr_copy_buf, 0, hdr, hdr_size);
c9f1a617593eb569fb02f45041bad3c13e534496Timo Sirainenint mail_index_create_tmp_file(struct mail_index *index, const char **path_r)
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen path = *path_r = t_strconcat(index->filepath, ".tmp", NULL);
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen fd = open(path, O_RDWR|O_CREAT|O_TRUNC, index->mode);
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen return mail_index_file_set_syscall_error(index, path, "open()");
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen if (index->gid != (gid_t)-1 && fchown(fd, (uid_t)-1, index->gid) < 0) {
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen mail_index_file_set_syscall_error(index, path, "fchown()");
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainenstatic int mail_index_create(struct mail_index *index,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* log file lock protects index creation */
ea9e10039e23a4926984a56860b5cc88f7b1f75eTimo Sirainen if (mail_transaction_log_sync_lock(index->log, &seq, &offset) < 0)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* mark the existing log file as synced */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* create it fully in index.tmp first */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen index->fd = mail_index_create_tmp_file(index, &path);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen else if (write_full(index->fd, hdr, sizeof(*hdr)) < 0) {
d22390f33eedbd2413debabc0662dde5241b1aa6Timo Sirainen mail_index_file_set_syscall_error(index, path, "write_full()");
d22390f33eedbd2413debabc0662dde5241b1aa6Timo Sirainen /* it's corrupted even while we just created it,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen should never happen unless someone pokes the file directly */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen "Newly created index file is corrupted: %s", path);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen mail_index_file_set_syscall_error(index, path,
93b29720c5141f787bd1861796867e4595c9d084Timo Sirainen /* make it visible to others */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen mail_index_set_error(index, "rename(%s, %s) failed: %m",
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenstatic void mail_index_header_init(struct mail_index_header *hdr)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen i_assert((sizeof(*hdr) % sizeof(uint64_t)) == 0);
9fc077d3886b1584019bcc9b92c717cfffce5c67Timo Sirainen hdr->major_version = MAIL_INDEX_MAJOR_VERSION;
9fc077d3886b1584019bcc9b92c717cfffce5c67Timo Sirainen hdr->minor_version = MAIL_INDEX_MINOR_VERSION;
9fc077d3886b1584019bcc9b92c717cfffce5c67Timo Sirainen hdr->record_size = sizeof(struct mail_index_record);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen hdr->compat_flags |= MAIL_INDEX_COMPAT_LITTLE_ENDIAN;
68917b81c83e8a4d18a81cda188ffa5cb643c46cTimo Sirainenstatic void mail_index_create_in_memory(struct mail_index *index,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* a bit kludgy way to do this, but it initializes everything
86bc22621dcce6d9f1ca7216c9cc958381a61277Timo Sirainen nicely and correctly */
86bc22621dcce6d9f1ca7216c9cc958381a61277Timo Sirainen index->map = mail_index_map_clone(&tmp_map, hdr->record_size);
86bc22621dcce6d9f1ca7216c9cc958381a61277Timo Sirainen/* returns -1 = error, 0 = won't create, 1 = ok */
86bc22621dcce6d9f1ca7216c9cc958381a61277Timo Sirainenstatic int mail_index_open_files(struct mail_index *index,
86bc22621dcce6d9f1ca7216c9cc958381a61277Timo Sirainen unsigned int lock_id = 0;
264bc938e956288ec7a2a43417c01c3a3ce840fdTimo Sirainen else if (ret == 0) {
264bc938e956288ec7a2a43417c01c3a3ce840fdTimo Sirainen /* doesn't exist, or corrupted */
e687badfdd7f4001e9a89a80a2c4a79ec4bafc8dTimo Sirainen if ((flags & MAIL_INDEX_OPEN_FLAG_CREATE) == 0 &&
e687badfdd7f4001e9a89a80a2c4a79ec4bafc8dTimo Sirainen } else if (ret < 0)
e687badfdd7f4001e9a89a80a2c4a79ec4bafc8dTimo Sirainen index->log = mail_transaction_log_open_or_create(index);
e687badfdd7f4001e9a89a80a2c4a79ec4bafc8dTimo Sirainen /* looks like someone else created the transaction log
4b231ca0bbe3b536acbd350101e183441ce0247aTimo Sirainen before we had the chance. use its indexid so we
4b231ca0bbe3b536acbd350101e183441ce0247aTimo Sirainen don't try to create conflicting ones. */
4b231ca0bbe3b536acbd350101e183441ce0247aTimo Sirainen /* fallback to in-memory index */
93b29720c5141f787bd1861796867e4595c9d084Timo Sirainen if (mail_index_lock_shared(index, FALSE, &lock_id) < 0)
6ef7e31619edfaa17ed044b45861d106a86191efTimo Sirainen index->cache = created ? mail_cache_create(index) :
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenint mail_index_open(struct mail_index *index, enum mail_index_open_flags flags,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen (index->hdr->flags & MAIL_INDEX_HDR_FLAG_CORRUPTED) != 0) {
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* corrupted, reopen files */
da5d50534cfca45d0aaaf0bdac17b287b4588809Timo Sirainen index->filepath = MAIL_INDEX_IS_IN_MEMORY(index) ?
67b9db4e0bd93ffe24cc95f609193f6f642f6448Timo Sirainen i_strconcat(index->dir, "/", index->prefix, NULL);
0d0451206a91e9f96e522075dce28a89adc2325dTimo Sirainen (flags & MAIL_INDEX_OPEN_FLAG_MMAP_DISABLE) != 0;
0d0451206a91e9f96e522075dce28a89adc2325dTimo Sirainen (flags & MAIL_INDEX_OPEN_FLAG_MMAP_NO_WRITE) != 0;
4b231ca0bbe3b536acbd350101e183441ce0247aTimo Sirainen /* don't even bother to handle dotlocking without mmap being
f239eb76f77afcbc0bfc97c9b52b4407d1bc3fe6Timo Sirainen disabled. that combination simply doesn't make any sense */
da5d50534cfca45d0aaaf0bdac17b287b4588809Timo Sirainen i_fatal("lock_method=dotlock and mmap_disable=no "
da5d50534cfca45d0aaaf0bdac17b287b4588809Timo Sirainen "combination isn't supported. "
da5d50534cfca45d0aaaf0bdac17b287b4588809Timo Sirainen "You don't _really_ want it anyway.");
d9fdacd5fb3e07997e5c389739d2054f0c8441d8Timo Sirainen /* completely broken, reopen */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* too many tries */
4b231ca0bbe3b536acbd350101e183441ce0247aTimo Sirainenvoid mail_index_close(struct mail_index *index)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen mail_index_set_syscall_error(index, "close()");
68917b81c83e8a4d18a81cda188ffa5cb643c46cTimo Sirainenint mail_index_reopen(struct mail_index *index, int fd)
6fcaeede31ef2292b3ff59c461eb6ef4ae989dfdTimo Sirainen unsigned int old_shared_locks, old_lock_id, lock_id = 0;
6fcaeede31ef2292b3ff59c461eb6ef4ae989dfdTimo Sirainen i_assert(index->copy_lock_path == NULL || index->excl_lock_count == 0);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* new file, new locks. the old fd can keep its locks, they don't
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen matter anymore as no-one's going to modify the file. */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen ret = mail_index_lock_shared(index, FALSE, &lock_id);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen else if (ret == 0) {
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* index file is lost */
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen /* read the new mapping. note that with mmap_disable we want
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen to keep the old mapping in index->map so we can update it
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen by reading transaction log. */
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen mail_index_set_syscall_error(index, "close()");
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen mail_index_set_syscall_error(index, "close()");
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainenint mail_index_reopen_if_needed(struct mail_index *index)
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen /* deleted, reopen */
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen return mail_index_set_syscall_error(index, "fstat()");
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen mail_index_set_syscall_error(index, "stat()");
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen /* lost it? recreate */
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainenint mail_index_refresh(struct mail_index *index)
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen unsigned int lock_id;
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen /* we have index exclusively locked, nothing could
d9fdacd5fb3e07997e5c389739d2054f0c8441d8Timo Sirainen have changed. */
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen /* reopening is all we need */
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen /* mail_index_map() simply reads latest changes from transaction log,
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen which makes us fully refreshed. */
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainen if (mail_index_lock_shared(index, TRUE, &lock_id) < 0)
538c58fc95200fcc5e91abdda8b912b574a2f968Timo Sirainenstruct mail_cache *mail_index_get_cache(struct mail_index *index)
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainenint mail_index_set_error(struct mail_index *index, const char *fmt, ...)
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainenvoid mail_index_set_inconsistent(struct mail_index *index)
e4b09b008ab544eb8994beecbfffefa21d855e43Timo Sirainenint mail_index_move_to_memory(struct mail_index *index)
d30da25fb6be1f1c667d93767c9194000194b618Timo Sirainen /* set the index as being into memory */
d30da25fb6be1f1c667d93767c9194000194b618Timo Sirainen /* mbox file was never even opened. just mark it as being in
4b231ca0bbe3b536acbd350101e183441ce0247aTimo Sirainen memory and let the caller re-open the index. */
d30da25fb6be1f1c667d93767c9194000194b618Timo Sirainen /* move index map to memory */
d30da25fb6be1f1c667d93767c9194000194b618Timo Sirainen map = mail_index_map_clone(index->map, index->map->hdr.record_size);
d30da25fb6be1f1c667d93767c9194000194b618Timo Sirainen /* move transaction log to memory */
d30da25fb6be1f1c667d93767c9194000194b618Timo Sirainen if (mail_transaction_log_move_to_memory(index->log) < 0)
d30da25fb6be1f1c667d93767c9194000194b618Timo Sirainen /* close the index file. */
d30da25fb6be1f1c667d93767c9194000194b618Timo Sirainen mail_index_set_syscall_error(index, "close()");
d30da25fb6be1f1c667d93767c9194000194b618Timo Sirainenvoid mail_index_mark_corrupted(struct mail_index *index)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen if (mail_index_write_base_header(index, &hdr) == 0) {
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen if (!MAIL_INDEX_IS_IN_MEMORY(index) && fsync(index->fd) < 0)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen mail_index_set_syscall_error(index, "fsync()");
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenint mail_index_set_syscall_error(struct mail_index *index,
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen return mail_index_set_error(index, "%s failed with index file %s: %m",
0d0451206a91e9f96e522075dce28a89adc2325dTimo Sirainenint mail_index_file_set_syscall_error(struct mail_index *index,
5cc772dc8b507be0bc1996b5717943ba13432e08Timo Sirainen return mail_index_set_error(index, "%s failed with file %s: %m",
5cc772dc8b507be0bc1996b5717943ba13432e08Timo Sirainenenum mail_index_error mail_index_get_last_error(struct mail_index *index)
ae14dfd895881f9d1c6899b0c09f1a8b51447d61Timo Sirainenconst char *mail_index_get_error_message(struct mail_index *index)
d9fdacd5fb3e07997e5c389739d2054f0c8441d8Timo Sirainenvoid mail_index_reset_error(struct mail_index *index)
5ec0ca7ff13595daf0d096c17100afb352e6294aTimo Sirainenuint32_t mail_index_uint32_to_offset(uint32_t offset)
5ec0ca7ff13595daf0d096c17100afb352e6294aTimo Sirainen buf[0] = 0x80 | ((offset & 0x0fe00000) >> 21);
7e94cf9d70ce9fdeccb7a85ff400b899e6386f36Timo Sirainen buf[1] = 0x80 | ((offset & 0x001fc000) >> 14);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenuint32_t mail_index_offset_to_uint32(uint32_t offset)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen const unsigned char *buf = (const unsigned char *) &offset;