mail-cache-fields.c revision 19e8adccba16ff419f5675b1575358c2956dce83
e59faf65ce864fe95dc00f5d52b8323cdbd0608aTimo Sirainen/* Copyright (c) 2004-2008 Dovecot authors, see the included COPYING file */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen#define CACHE_FIELD_IS_NEWLY_WANTED(cache, field_idx) \
f0a2d04321ba456e5c5ba821c0d1ed9e8e0e2e08Timo Sirainen ((cache)->field_file_map[field_idx] == (uint32_t)-1 && \
f0a2d04321ba456e5c5ba821c0d1ed9e8e0e2e08Timo Sirainenstatic bool field_has_fixed_size(enum mail_cache_field_type type)
98922c5675bbbfadc84d58768bef867fe82256c2Timo 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,
98922c5675bbbfadc84d58768bef867fe82256c2Timo Sirainen enum mail_cache_field_type type, unsigned int size)
98922c5675bbbfadc84d58768bef867fe82256c2Timo Sirainen const struct mail_cache_field *field = &cache->fields[idx].field;
98922c5675bbbfadc84d58768bef867fe82256c2Timo Sirainen "registered field %s type changed", field->name);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen if (field->field_size != size && field_has_fixed_size(type)) {
b6a7e0a7899e7f5d60c23cdaa50e025e4c67d05fTimo Sirainen "registered field %s size changed", field->name);
f0a2d04321ba456e5c5ba821c0d1ed9e8e0e2e08Timo Sirainenvoid mail_cache_register_fields(struct mail_cache *cache,
f0a2d04321ba456e5c5ba821c0d1ed9e8e0e2e08Timo Sirainen unsigned int new_idx;
1eb17e61d3d38372674aa0c55caedb0185a985f5Timo Sirainen unsigned int i, j;
b6a7e0a7899e7f5d60c23cdaa50e025e4c67d05fTimo Sirainen for (i = 0; i < fields_count; i++) {
b6a7e0a7899e7f5d60c23cdaa50e025e4c67d05fTimo Sirainen if (hash_lookup_full(cache->field_name_hash, fields[i].name,
f0a2d04321ba456e5c5ba821c0d1ed9e8e0e2e08Timo Sirainen i_assert(fields[i].type < MAIL_CACHE_FIELD_COUNT);
c60d1eda4df179d83d531647732d5e3e45064219Timo Sirainen /* check if the same header is being registered in the
c60d1eda4df179d83d531647732d5e3e45064219Timo Sirainen same field array */
f6f021c133f680cf3d559187524fd9abcbaae9b9Timo Sirainen for (j = 0; j < i; j++) {
f6f021c133f680cf3d559187524fd9abcbaae9b9Timo Sirainen if (strcasecmp(fields[i].name, fields[j].name) == 0) {
b0a901f1dbe9e05ac1c92a0974af6bce0274f31aTimo Sirainen /* @UNSAFE */
ebe6df72f1309135f02b6a4d2aef1e81a073f91cTimo Sirainen cache->fields_count * sizeof(*cache->field_file_map),
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen for (i = 0; i < fields_count; i++) {
b0a901f1dbe9e05ac1c92a0974af6bce0274f31aTimo Sirainen /* new index - save it */
1eb17e61d3d38372674aa0c55caedb0185a985f5Timo Sirainen name = p_strdup(cache->field_pool, fields[i].name);
3eb63515855f386449c22233d1f1baf1ddfe8a2dTimo Sirainen if (!field_has_fixed_size(cache->fields[idx].field.type))
1eb17e61d3d38372674aa0c55caedb0185a985f5Timo Sirainen cache->fields[idx].field.field_size = (unsigned int)-1;
e9d29ae46d435aee85514decfe6ee27399ebf794Timo Sirainen hash_insert(cache->field_name_hash, name, POINTER_CAST(idx));
1eb17e61d3d38372674aa0c55caedb0185a985f5Timo Sirainenmail_cache_register_lookup(struct mail_cache *cache, const char *name)
83bb013a99f0936995f9c7a1077822662d8fefdbTimo Sirainen if (hash_lookup_full(cache->field_name_hash, name,
83bb013a99f0936995f9c7a1077822662d8fefdbTimo Sirainen return POINTER_CAST_TO(orig_value, unsigned int);
90adcaa0a00eba29b7fbd50ca66be11c8d086d6aTimo Sirainen return (unsigned int)-1;
90adcaa0a00eba29b7fbd50ca66be11c8d086d6aTimo Sirainenmail_cache_register_get_list(struct mail_cache *cache, pool_t pool,
90adcaa0a00eba29b7fbd50ca66be11c8d086d6aTimo Sirainen unsigned int *count_r)
90adcaa0a00eba29b7fbd50ca66be11c8d086d6aTimo Sirainen unsigned int i;
83bb013a99f0936995f9c7a1077822662d8fefdbTimo Sirainen list = p_new(pool, struct mail_cache_field, cache->fields_count);
90adcaa0a00eba29b7fbd50ca66be11c8d086d6aTimo Sirainenstatic int mail_cache_header_fields_get_offset(struct mail_cache *cache,
83bb013a99f0936995f9c7a1077822662d8fefdbTimo Sirainen const struct mail_cache_header_fields *field_hdr;
90adcaa0a00eba29b7fbd50ca66be11c8d086d6aTimo Sirainen struct mail_cache_header_fields tmp_field_hdr;
83bb013a99f0936995f9c7a1077822662d8fefdbTimo Sirainen unsigned int next_count = 0;
3ec2c1f31631bb5ff86f5fc93a563c33e5cae90dTimo Sirainen /* find the latest header */
9334fbad0aabb2fed88f40b2205d0d6f80bdffa2Timo Sirainen next_offset = cache->last_field_header_offset != 0 ?
9334fbad0aabb2fed88f40b2205d0d6f80bdffa2Timo Sirainen mail_index_offset_to_uint32(cache->hdr->field_header_offset);
7ede6554e451ec039a67beec7d6ee4aff61d386eTimo Sirainen while (next_offset != 0) {
7ede6554e451ec039a67beec7d6ee4aff61d386eTimo Sirainen "next_offset in field header loops");
9334fbad0aabb2fed88f40b2205d0d6f80bdffa2Timo Sirainen sizeof(*field_hdr)) < 0)
9334fbad0aabb2fed88f40b2205d0d6f80bdffa2Timo Sirainen field_hdr = CONST_PTR_OFFSET(cache->data, offset);
9334fbad0aabb2fed88f40b2205d0d6f80bdffa2Timo Sirainen /* if we need to follow multiple offsets to get to
9334fbad0aabb2fed88f40b2205d0d6f80bdffa2Timo Sirainen the last one, it's faster to just pread() the file
9334fbad0aabb2fed88f40b2205d0d6f80bdffa2Timo Sirainen instead of going through cache */
3ec2c1f31631bb5ff86f5fc93a563c33e5cae90dTimo Sirainen mail_cache_set_syscall_error(cache, "pread()");
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen "next_offset points outside file");
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen mail_index_offset_to_uint32(field_hdr->next_offset);
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen mail_cache_set_corrupted(cache, "missing header fields");
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen if (next_count > MAIL_CACHE_HEADER_FIELD_CONTINUE_COUNT)
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen cache->need_compress_file_seq = cache->hdr->file_seq;
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen if (cache->file_cache != NULL && invalidate) {
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen /* if this isn't the first header in file and we hadn't
d22301419109ed4a38351715e6760011421dadecTimo Sirainen read this before, we can't trust that the cached
d22301419109ed4a38351715e6760011421dadecTimo Sirainen data is valid */
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen file_cache_invalidate(cache->file_cache, offset,
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen if (mail_cache_map(cache, offset, field_hdr->size) < 0)
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainenint mail_cache_header_fields_read(struct mail_cache *cache)
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen const struct mail_cache_header_fields *field_hdr = NULL;
d22301419109ed4a38351715e6760011421dadecTimo Sirainen if (mail_cache_header_fields_get_offset(cache, &offset, TRUE) < 0)
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen /* no fields - the file is empty */
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen field_hdr = CONST_PTR_OFFSET(cache->data, offset);
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen if (offset + field_hdr->size > cache->mmap_length) {
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen "field header points outside file");
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen /* check the fixed size of the header. name[] has to be checked
d22301419109ed4a38351715e6760011421dadecTimo Sirainen separately */
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen field_hdr->fields_count * (sizeof(uint32_t)*2 + 1 + 2)) {
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen mail_cache_set_corrupted(cache, "invalid field header size");
b6a7e0a7899e7f5d60c23cdaa50e025e4c67d05fTimo Sirainen field_hdr = CONST_PTR_OFFSET(cache->data, offset);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen sizeof(unsigned int),
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen new_fields_count * sizeof(unsigned int));
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen last_used = CONST_PTR_OFFSET(field_hdr, MAIL_CACHE_FIELD_LAST_USED());
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen MAIL_CACHE_FIELD_SIZE(field_hdr->fields_count));
c36ec256c1bd1abe1c12e792cf64f0b7e3b3135aTimo Sirainen MAIL_CACHE_FIELD_TYPE(field_hdr->fields_count));
9261dbf0675204898c6557591c7aa376e23a52b2Timo Sirainen MAIL_CACHE_FIELD_DECISION(field_hdr->fields_count));
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen MAIL_CACHE_FIELD_NAMES(field_hdr->fields_count));
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen end = CONST_PTR_OFFSET(field_hdr, field_hdr->size);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* clear the old mapping */
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen max_drop_time = cache->index->map->hdr.day_stamp == 0 ? 0 :
d22301419109ed4a38351715e6760011421dadecTimo Sirainen cache->index->map->hdr.day_stamp - MAIL_CACHE_FIELD_DROP_SECS;
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen for (i = 0; i < field_hdr->fields_count; i++) {
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen for (p = names; p != end && *p != '\0'; p++) ;
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen "field header names corrupted");
cf49fc07f541c0f74578ac6c3b334ddade143aa1Timo Sirainen mail_cache_set_corrupted(cache, "field type corrupted");
cf49fc07f541c0f74578ac6c3b334ddade143aa1Timo Sirainen "field decision type corrupted");
cf49fc07f541c0f74578ac6c3b334ddade143aa1Timo Sirainen if (hash_lookup_full(cache->field_name_hash, names,
63aaafe7e6b201d6633f8c25610ecd30c9cda99cTimo Sirainen /* already exists, see if decision can be updated */
cf49fc07f541c0f74578ac6c3b334ddade143aa1Timo Sirainen fidx = POINTER_CAST_TO(orig_value, unsigned int);
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen if (cache->field_file_map[fidx] != (uint32_t)-1) {
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen /* update last_used if it's newer than ours */
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen if (last_used[i] > cache->fields[fidx].last_used)
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen if ((time_t)cache->fields[fidx].last_used < max_drop_time &&
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen /* time to drop this field. don't bother dropping
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen fields that have never been used. */
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen cache->need_compress_file_seq = cache->hdr->file_seq;
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainenstatic void copy_to_buf(struct mail_cache *cache, buffer_t *dest, bool add_new,
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen unsigned int i, field;
ae1b268ffff743ad9927c304a1344c5cbd7f909dTimo Sirainen /* copy the existing fields */
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen for (i = 0; i < cache->file_fields_count; i++) {
83bb013a99f0936995f9c7a1077822662d8fefdbTimo Sirainen data = CONST_PTR_OFFSET(&cache->fields[field], offset);
d22301419109ed4a38351715e6760011421dadecTimo Sirainen /* copy newly wanted fields */
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen data = CONST_PTR_OFFSET(&cache->fields[i], offset);
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainenstatic void copy_to_buf_byte(struct mail_cache *cache, buffer_t *dest,
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen unsigned int i, field;
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen /* copy the existing fields */
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen for (i = 0; i < cache->file_fields_count; i++) {
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen data = CONST_PTR_OFFSET(&cache->fields[field], offset);
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen /* copy newly wanted fields */
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen data = CONST_PTR_OFFSET(&cache->fields[i], offset);
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainenstatic int mail_cache_header_fields_update_locked(struct mail_cache *cache)
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen if (mail_cache_header_fields_read(cache) < 0 ||
97eb53ade9057e6966dbb77289ad0204c7e1657bTimo Sirainen mail_cache_header_fields_get_offset(cache, &offset, FALSE) < 0)
83bb013a99f0936995f9c7a1077822662d8fefdbTimo Sirainen buffer = buffer_create_dynamic(pool_datastack_create(), 256);
d22301419109ed4a38351715e6760011421dadecTimo Sirainen offsetof(struct mail_cache_field_private, last_used),
366d6311c9d5bac6613e3cd64619eb878adce9ecTimo Sirainen ret = mail_cache_write(cache, buffer->data, buffer->used,
24cd47a2c8f7507e555459b7e841de771ba3c318Timo Sirainen MAIL_CACHE_FIELD_DECISION(cache->file_fields_count);
24cd47a2c8f7507e555459b7e841de771ba3c318Timo Sirainen ret = mail_cache_write(cache, buffer->data, buffer->used,
e4e7475f646d66a257d682738fbff1f206ce4924Timo Sirainen for (i = 0; i < cache->file_fields_count; i++)
129cc29ae6d8ad64d6d2b72f18da18fa134d0f3eTimo Sirainenint mail_cache_header_fields_update(struct mail_cache *cache)
83bb013a99f0936995f9c7a1077822662d8fefdbTimo Sirainen ret = mail_cache_header_fields_update_locked(cache);
129cc29ae6d8ad64d6d2b72f18da18fa134d0f3eTimo Sirainen ret = mail_cache_header_fields_update_locked(cache);
89fb98e9eb7e95255a579c8e9d865383c2334a74Timo Sirainenvoid mail_cache_header_fields_get(struct mail_cache *cache, buffer_t *dest)
89fb98e9eb7e95255a579c8e9d865383c2334a74Timo Sirainen unsigned int field;
366d6311c9d5bac6613e3cd64619eb878adce9ecTimo Sirainen /* we have to keep the field order for the existing fields. */
83bb013a99f0936995f9c7a1077822662d8fefdbTimo Sirainen offsetof(struct mail_cache_field_private, last_used),
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen offsetof(struct mail_cache_field, field_size),
910fa4e4204a73d3d24c03f3059dd24e727ca057Timo Sirainen /* add existing fields' names */
83bb013a99f0936995f9c7a1077822662d8fefdbTimo Sirainen for (i = 0; i < cache->file_fields_count; i++) {
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* add newly wanted fields' names */
225e82df5dd1e765f4e52b80c954558f00e5a7dfTimo Sirainenint mail_cache_header_fields_get_next_offset(struct mail_cache *cache,
225e82df5dd1e765f4e52b80c954558f00e5a7dfTimo Sirainen if (mail_cache_header_fields_get_offset(cache, offset_r, FALSE) < 0)
d22301419109ed4a38351715e6760011421dadecTimo Sirainen *offset_r = offsetof(struct mail_cache_header,