mail-cache-fields.c revision 6e235046e1d8e9d89fc948f5c623676c20421a28
76b43e4417bab52e913da39b5f5bc2a130d3f149Timo Sirainen/* Copyright (c) 2004-2007 Dovecot authors, see the included COPYING file */
fcfb528483369975066c6adf1c55c16e6fb6e91fTimo Sirainen#define CACHE_FIELD_IS_NEWLY_WANTED(cache, field_idx) \
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen ((cache)->field_file_map[field_idx] == (uint32_t)-1 && \
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainenstatic bool field_has_fixed_size(enum mail_cache_field_type type)
fcfb528483369975066c6adf1c55c16e6fb6e91fTimo Sirainenstatic bool field_decision_is_valid(enum mail_cache_decision_type type)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenstatic int field_type_verify(struct mail_cache *cache, unsigned int idx,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen enum mail_cache_field_type type, unsigned int size)
6a7f64562ddd0dd2fec755ec4e9c9afde8e85cf1Timo Sirainen const struct mail_cache_field *field = &cache->fields[idx].field;
6a19e109ee8c5a6f688da83a86a7f6abeb71abddTimo Sirainen "registered field %s type changed", field->name);
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen if (field->field_size != size && field_has_fixed_size(type)) {
6a7f64562ddd0dd2fec755ec4e9c9afde8e85cf1Timo Sirainen "registered field %s size changed", field->name);
6a7f64562ddd0dd2fec755ec4e9c9afde8e85cf1Timo Sirainenvoid mail_cache_register_fields(struct mail_cache *cache,
6a7f64562ddd0dd2fec755ec4e9c9afde8e85cf1Timo Sirainen unsigned int new_idx;
6a7f64562ddd0dd2fec755ec4e9c9afde8e85cf1Timo Sirainen unsigned int i, j;
6a7f64562ddd0dd2fec755ec4e9c9afde8e85cf1Timo Sirainen for (i = 0; i < fields_count; i++) {
6a7f64562ddd0dd2fec755ec4e9c9afde8e85cf1Timo Sirainen if (hash_lookup_full(cache->field_name_hash, fields[i].name,
6a7f64562ddd0dd2fec755ec4e9c9afde8e85cf1Timo Sirainen i_assert(fields[i].type < MAIL_CACHE_FIELD_COUNT);
dc0474dc9d5652d76cb41f439844dd80c8b96642Timo Sirainen /* check if the same header is being registered in the
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainen same field array */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen for (j = 0; j < i; j++) {
72368bc3058d36912317ffe55e6017205f4fa036Timo Sirainen if (strcasecmp(fields[i].name, fields[j].name) == 0) {
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* @UNSAFE */
785b1ca149341b70bf2cb8cc3049f1c4c1070b52Timo Sirainen cache->fields_count * sizeof(*cache->field_file_map),
785b1ca149341b70bf2cb8cc3049f1c4c1070b52Timo Sirainen for (i = 0; i < fields_count; i++) {
785b1ca149341b70bf2cb8cc3049f1c4c1070b52Timo Sirainen /* new index - save it */
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen name = p_strdup(cache->field_pool, fields[i].name);
56f45b3f3ae20e5c933701f4657dda5ef1916855Timo Sirainen if (!field_has_fixed_size(cache->fields[idx].field.type))
6a8a4c9f530668cd8961b73d702856ed94f05f80Timo Sirainen cache->fields[idx].field.field_size = (unsigned int)-1;
6a8a4c9f530668cd8961b73d702856ed94f05f80Timo Sirainen hash_insert(cache->field_name_hash, name, POINTER_CAST(idx));
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainenmail_cache_register_lookup(struct mail_cache *cache, const char *name)
73a44af966c790560a72a0447f37bb35b1031a83Timo Sirainen if (hash_lookup_full(cache->field_name_hash, name,
73a44af966c790560a72a0447f37bb35b1031a83Timo Sirainen return POINTER_CAST_TO(orig_value, unsigned int);
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen return (unsigned int)-1;
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainenmail_cache_register_get_list(struct mail_cache *cache, pool_t pool,
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen unsigned int *count_r)
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen unsigned int i;
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen list = p_new(pool, struct mail_cache_field, cache->fields_count);
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainenstatic int mail_cache_header_fields_get_offset(struct mail_cache *cache,
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen const struct mail_cache_header_fields *field_hdr;
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen struct mail_cache_header_fields tmp_field_hdr;
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen unsigned int next_count = 0;
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen /* find the latest header */
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen next_offset = cache->last_field_header_offset != 0 ?
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen mail_index_offset_to_uint32(cache->hdr->field_header_offset);
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen while (next_offset != 0) {
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen "next_offset in field header loops");
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen sizeof(*field_hdr)) < 0)
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen field_hdr = CONST_PTR_OFFSET(cache->data, offset);
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen /* if we need to follow multiple offsets to get to
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen the last one, it's faster to just pread() the file
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen instead of going through cache */
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen mail_cache_set_syscall_error(cache, "pread()");
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen "next_offset points outside file");
5e4f94015f5bbc9eefb1f2cb7af81ed50dcd2b39Timo Sirainen mail_index_offset_to_uint32(field_hdr->next_offset);
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen mail_cache_set_corrupted(cache, "missing header fields");
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen if (next_count > MAIL_CACHE_HEADER_FIELD_CONTINUE_COUNT)
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen cache->need_compress_file_seq = cache->hdr->file_seq;
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen /* we can't trust that the cached data is valid */
785b1ca149341b70bf2cb8cc3049f1c4c1070b52Timo Sirainen file_cache_invalidate(cache->file_cache, offset,
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen if (mail_cache_map(cache, offset, field_hdr->size) < 0)
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainenint mail_cache_header_fields_read(struct mail_cache *cache)
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen const struct mail_cache_header_fields *field_hdr = NULL;
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen if (mail_cache_header_fields_get_offset(cache, &offset, TRUE) < 0)
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen /* no fields - the file is empty */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen field_hdr = CONST_PTR_OFFSET(cache->data, offset);
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen if (offset + field_hdr->size > cache->mmap_length) {
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainen "field header points outside file");
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen /* check the fixed size of the header. name[] has to be checked
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen separately */
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen field_hdr->fields_count * (sizeof(uint32_t)*2 + 1 + 2)) {
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen mail_cache_set_corrupted(cache, "invalid field header size");
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen field_hdr = CONST_PTR_OFFSET(cache->data, offset);
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainen sizeof(unsigned int),
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen new_fields_count * sizeof(unsigned int));
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen last_used = CONST_PTR_OFFSET(field_hdr, MAIL_CACHE_FIELD_LAST_USED());
6a8a4c9f530668cd8961b73d702856ed94f05f80Timo Sirainen MAIL_CACHE_FIELD_SIZE(field_hdr->fields_count));
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainen MAIL_CACHE_FIELD_TYPE(field_hdr->fields_count));
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen MAIL_CACHE_FIELD_DECISION(field_hdr->fields_count));
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen MAIL_CACHE_FIELD_NAMES(field_hdr->fields_count));
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen end = CONST_PTR_OFFSET(field_hdr, field_hdr->size);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* clear the old mapping */
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainen max_drop_time = cache->index->map->hdr.day_stamp -
710deabc6b3c305c3a842e7a2e0d173c526d13a7Timo Sirainen for (i = 0; i < field_hdr->fields_count; i++) {
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen for (p = names; p != end && *p != '\0'; p++) ;
710deabc6b3c305c3a842e7a2e0d173c526d13a7Timo Sirainen "field header names corrupted");
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen mail_cache_set_corrupted(cache, "field type corrupted");
dd4b5f14b71b01a84af942e720a2d6e5f15ee1a7Timo Sirainen "field decision type corrupted");
dd4b5f14b71b01a84af942e720a2d6e5f15ee1a7Timo Sirainen if (hash_lookup_full(cache->field_name_hash, names,
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen /* already exists, see if decision can be updated */
dd4b5f14b71b01a84af942e720a2d6e5f15ee1a7Timo Sirainen field.idx = POINTER_CAST_TO(orig_value, unsigned int);
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen if (!cache->fields[field.idx].decision_dirty) {
1171f0abf442638bac1827bb24a0b6b8eb682a82Timo Sirainen if (cache->field_file_map[field.idx] != (uint32_t)-1) {
0beb5d6c661ee68130a954ed0f31a34c19195fb7Timo Sirainen /* update last_used if it's newer than ours */
0beb5d6c661ee68130a954ed0f31a34c19195fb7Timo Sirainen if (last_used[i] > cache->fields[field.idx].last_used)
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen cache->fields[field.idx].last_used = last_used[i];
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen if (cache->fields[field.idx].last_used < max_drop_time) {
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen /* time to drop this field */
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen cache->need_compress_file_seq = cache->hdr->file_seq;
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainenstatic void copy_to_buf(struct mail_cache *cache, buffer_t *dest, bool add_new,
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen unsigned int i, field;
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen /* copy the existing fields */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen for (i = 0; i < cache->file_fields_count; i++) {
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainen data = CONST_PTR_OFFSET(&cache->fields[field], offset);
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen /* copy newly wanted fields */
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainen data = CONST_PTR_OFFSET(&cache->fields[i], offset);
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainenstatic void copy_to_buf_byte(struct mail_cache *cache, buffer_t *dest,
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen unsigned int i, field;
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen /* copy the existing fields */
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen for (i = 0; i < cache->file_fields_count; i++) {
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen data = CONST_PTR_OFFSET(&cache->fields[field], offset);
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen /* copy newly wanted fields */
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen data = CONST_PTR_OFFSET(&cache->fields[i], offset);
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainenstatic int mail_cache_header_fields_update_locked(struct mail_cache *cache)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen if (mail_cache_header_fields_read(cache) < 0 ||
da5d50534cfca45d0aaaf0bdac17b287b4588809Timo Sirainen mail_cache_header_fields_get_offset(cache, &offset, FALSE) < 0)
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen buffer = buffer_create_dynamic(pool_datastack_create(), 256);
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen offsetof(struct mail_cache_field_private, last_used),
eddd9bf1a1369aea4a2715f6be1137da6d17d293Timo Sirainen ret = mail_cache_write(cache, buffer->data, buffer->used,
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainen MAIL_CACHE_FIELD_DECISION(cache->file_fields_count);
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen ret = mail_cache_write(cache, buffer->data, buffer->used,
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainen for (i = 0; i < cache->file_fields_count; i++)
0beb5d6c661ee68130a954ed0f31a34c19195fb7Timo Sirainenint mail_cache_header_fields_update(struct mail_cache *cache)
4b058f90f9e8a2c6b2eed275de4eb8cc5195a71dTimo Sirainen return mail_cache_header_fields_update_locked(cache);
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen ret = mail_cache_header_fields_update_locked(cache);
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainenvoid mail_cache_header_fields_get(struct mail_cache *cache, buffer_t *dest)
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen unsigned int field;
6b85bc4b03e552cfaeeae872d63c2d8ac5fcb7c4Timo Sirainen /* we have to keep the field order for the existing fields. */
eddd9bf1a1369aea4a2715f6be1137da6d17d293Timo Sirainen offsetof(struct mail_cache_field_private, last_used),
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen offsetof(struct mail_cache_field, field_size),
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen /* add existing fields' names */
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen for (i = 0; i < cache->file_fields_count; i++) {
1b97a59edb073e9a89ac43a21a9abe5d590d4a56Timo Sirainen /* add newly wanted fields' names */
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainenint mail_cache_header_fields_get_next_offset(struct mail_cache *cache,
eddd9bf1a1369aea4a2715f6be1137da6d17d293Timo Sirainen if (mail_cache_header_fields_get_offset(cache, offset_r, FALSE) < 0)
eddd9bf1a1369aea4a2715f6be1137da6d17d293Timo Sirainen *offset_r = offsetof(struct mail_cache_header,