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