mail-cache-transaction.c revision 0e7a1bd9b7b39e57a22dbd4ba12df9b9603e6391
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen/* Copyright (C) 2003-2004 Timo Sirainen */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen uint32_t reserved_space_offset, reserved_space;
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenstatic const unsigned char *null4[] = { 0, 0, 0, 0 };
e1f05b193ac1edd3267294e9501e8063aa0f791aTimo Sirainenstatic int mail_cache_link_unlocked(struct mail_cache *cache,
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenmail_cache_get_transaction(struct mail_cache_view *view,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen ctx = i_new(struct mail_cache_transaction_ctx, 1);
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen buffer_create_dynamic(system_pool, 256, (size_t)-1);
ee26329cb5cc679b5645e4933d529f86accb976aTimo Sirainen ctx->cache_file_seq = ctx->cache->hdr->file_seq;
a2ce2eb4c266e2854fd34416ea5cfbe05dfd3971Timo Sirainenstatic void mail_cache_transaction_reset(struct mail_cache_transaction_ctx *ctx)
a2ce2eb4c266e2854fd34416ea5cfbe05dfd3971Timo Sirainen ctx->cache_file_seq = ctx->cache->hdr->file_seq;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenstatic void mail_cache_transaction_free(struct mail_cache_transaction_ctx *ctx)
ca316aeb7648d3f1bcf45231f73ddeb1b67a6961Timo Sirainen ctx->view->trans_seq1 = ctx->view->trans_seq2 = 0;
a2ce2eb4c266e2854fd34416ea5cfbe05dfd3971Timo Sirainenstatic int mail_cache_transaction_lock(struct mail_cache_transaction_ctx *ctx)
a2ce2eb4c266e2854fd34416ea5cfbe05dfd3971Timo Sirainen if (ctx->cache_file_seq != ctx->cache->hdr->file_seq)
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenstatic int mail_cache_grow_file(struct mail_cache *cache, size_t size)
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* grow the file */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen new_fsize = cache->hdr_copy.used_file_size + size;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen grow_size = new_fsize / 100 * MAIL_CACHE_GROW_PERCENTAGE;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen mail_cache_set_syscall_error(cache, "fstat()");
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (file_set_size(cache->fd, new_fsize) < 0) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen mail_cache_set_syscall_error(cache, "file_set_size()");
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenstatic int mail_cache_unlink_hole(struct mail_cache *cache, size_t size,
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen struct mail_cache_header *hdr = &cache->hdr_copy;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen while (offset != 0) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (pread_full(cache->fd, &hole, sizeof(hole), offset) <= 0) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen mail_cache_set_syscall_error(cache, "pread_full()");
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (hole.magic != MAIL_CACHE_HOLE_HEADER_MAGIC) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen "Invalid magic in hole header");
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen mail_cache_set_syscall_error(cache, "pwrite_full()");
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenmail_cache_transaction_add_reservation(struct mail_cache_transaction_ctx *ctx)
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen buffer_append(ctx->reservations, &ctx->reserved_space_offset,
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen buffer_append(ctx->reservations, &ctx->reserved_space,
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenmail_cache_transaction_reserve_more(struct mail_cache_transaction_ctx *ctx,
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen struct mail_cache_header *hdr = &cache->hdr_copy;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (mail_cache_unlink_hole(cache, size, &hole)) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* found a large enough hole. */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen ctx->reserved_space_offset = hole.next_offset;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* mail_cache_unlink_hole() could have noticed corruption */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if ((uoff_t)hdr->used_file_size + size > (uint32_t)-1) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen mail_index_set_error(cache->index, "Cache file too large: %s",
0a51697f82fbd45a511710479e99efd42dc18453Timo Sirainen /* allocate some more space than we need */
0a51697f82fbd45a511710479e99efd42dc18453Timo Sirainen size_t new_size = (size + ctx->last_grow_size) * 2;
0a51697f82fbd45a511710479e99efd42dc18453Timo Sirainen if ((uoff_t)hdr->used_file_size + new_size > (uint32_t)-1)
0a51697f82fbd45a511710479e99efd42dc18453Timo Sirainen if (new_size > MAIL_CACHE_MAX_RESERVED_BLOCK_SIZE) {
0a51697f82fbd45a511710479e99efd42dc18453Timo Sirainen new_size = size > MAIL_CACHE_MAX_RESERVED_BLOCK_SIZE ?
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (mail_cache_grow_file(ctx->cache, size) < 0)
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (ctx->reserved_space_offset + ctx->reserved_space ==
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* we can simply grow it */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen ctx->reserved_space = size - ctx->reserved_space;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* grow reservation. it's probably the last one in the buffer,
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen but it's not guarateed because we might have used holes
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen buf = buffer_get_modifyable_data(ctx->reservations, &size);
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (buf[size] == ctx->reserved_space_offset) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen ctx->reserved_space_offset = hdr->used_file_size;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen hdr->used_file_size = ctx->reserved_space_offset + ctx->reserved_space;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenmail_cache_free_space(struct mail_cache *cache, uint32_t offset, uint32_t size)
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (offset + size == cache->hdr_copy.used_file_size) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* we can just set used_file_size back */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen } else if (size >= MAIL_CACHE_MIN_HOLE_SIZE) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* set it up as a hole */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen hole.next_offset = cache->hdr_copy.hole_offset;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (pwrite_full(cache->fd, &hole, sizeof(hole), offset) < 0) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen mail_cache_set_syscall_error(cache, "pwrite_full()");
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenmail_cache_transaction_free_space(struct mail_cache_transaction_ctx *ctx)
f79a807865222dc8d5afd21667d2ace67f6c831bTimo Sirainen /* check again - locking might have reopened the cache file */
0e7a1bd9b7b39e57a22dbd4ba12df9b9603e6391Timo Sirainen i_assert(ctx->cache_file_seq == ctx->cache->hdr->file_seq);
f79a807865222dc8d5afd21667d2ace67f6c831bTimo Sirainen mail_cache_free_space(ctx->cache, ctx->reserved_space_offset,
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenmail_cache_transaction_get_space(struct mail_cache_transaction_ctx *ctx,
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen ret = mail_cache_transaction_reserve_more(ctx, max_size,
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* final commit - see if we can free the rest of the
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen reserved space */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenmail_cache_transaction_flush(struct mail_cache_transaction_ctx *ctx)
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen const struct mail_cache_record *rec, *tmp_rec;
f79a807865222dc8d5afd21667d2ace67f6c831bTimo Sirainen uint32_t write_offset, old_offset, rec_pos, cache_file_seq;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen size_t size, max_size, seq_idx, seq_limit, seq_count;
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* committing, remove the last dummy record */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen buffer_set_used_size(ctx->cache_data, ctx->prev_pos);
7496b0969019303b4917eaccd1f4f771584d8a48Timo Sirainen if (ctx->cache_file_seq != ctx->cache->hdr->file_seq) {
7496b0969019303b4917eaccd1f4f771584d8a48Timo Sirainen /* cache file reopened - need to abort */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen rec = buffer_get_data(ctx->cache_data, &size);
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen seq = buffer_get_data(ctx->cache_data_seq, &seq_count);
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen for (seq_idx = 0, rec_pos = 0; rec_pos < ctx->prev_pos;) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen write_offset = mail_cache_transaction_get_space(ctx, rec->size,
f79a807865222dc8d5afd21667d2ace67f6c831bTimo Sirainen /* cache file reopened - need to abort */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* nothing to write / error */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* see how much we can really write there */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen for (size = 0; size + tmp_rec->size <= max_size; ) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* write it to file */
0e7a1bd9b7b39e57a22dbd4ba12df9b9603e6391Timo Sirainen i_assert(ctx->cache_file_seq == cache->hdr->file_seq);
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (pwrite_full(cache->fd, rec, max_size, write_offset) < 0) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen mail_cache_set_syscall_error(cache, "pwrite_full()");
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* write the cache_offsets to index file. records' prev_offset
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen is updated to point to old cache record when index is being
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen mail_index_update_cache(ctx->trans, seq[seq_idx],
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* we added records for this message multiple
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen times in this same uncommitted transaction.
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen only the new one will be written to
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen transaction log, we need to do the linking
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen ourself here. */
e1f05b193ac1edd3267294e9501e8063aa0f791aTimo Sirainen if (mail_cache_link_unlocked(cache, old_offset,
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* drop the written data from buffer */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenmail_cache_transaction_switch_seq(struct mail_cache_transaction_ctx *ctx)
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* fix record size */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen data = buffer_get_modifyable_data(ctx->cache_data, &size);
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen buffer_append(ctx->cache_data_seq, &ctx->prev_seq,
50c4a9739b55370b1d3950d7b3ec2f7cd2ed5f49Timo Sirainen buffer_create_dynamic(system_pool, 32768, (size_t)-1);
50c4a9739b55370b1d3950d7b3ec2f7cd2ed5f49Timo Sirainen buffer_create_dynamic(system_pool, 256, (size_t)-1);
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen buffer_append(ctx->cache_data, &new_rec, sizeof(new_rec));
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenint mail_cache_transaction_commit(struct mail_cache_transaction_ctx *ctx)
531fa12126fc7abf63244a7ed4505896a8694206Timo Sirainen if (!ctx->changes || MAIL_CACHE_IS_UNUSABLE(cache)) {
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* make sure everything's written before updating offsets */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen mail_cache_set_syscall_error(cache, "fdatasync()");
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenvoid mail_cache_transaction_rollback(struct mail_cache_transaction_ctx *ctx)
f79a807865222dc8d5afd21667d2ace67f6c831bTimo Sirainen if ((ctx->reserved_space > 0 || ctx->reservations->used > 0) &&
f79a807865222dc8d5afd21667d2ace67f6c831bTimo Sirainen buf = buffer_get_data(ctx->reservations, &size);
31854ec69857e384882bcade5cf0c5dea8abf230Timo Sirainen /* free flushed data as well. do it from end to
31854ec69857e384882bcade5cf0c5dea8abf230Timo Sirainen beginning so we have a better chance of
31854ec69857e384882bcade5cf0c5dea8abf230Timo Sirainen updating used_file_size instead of adding
31854ec69857e384882bcade5cf0c5dea8abf230Timo Sirainen } while (size > 0);
5ebddd2d812296900bc255b24bcd508878784c37Timo Sirainenstatic int mail_cache_header_add_field(struct mail_cache_transaction_ctx *ctx,
5ebddd2d812296900bc255b24bcd508878784c37Timo Sirainen unsigned int field)
5ebddd2d812296900bc255b24bcd508878784c37Timo Sirainen /* re-read header to make sure we don't lose any fields. */
5ebddd2d812296900bc255b24bcd508878784c37Timo Sirainen if (mail_cache_header_fields_read(cache) < 0) {
5ebddd2d812296900bc255b24bcd508878784c37Timo Sirainen if (ctx->cache->field_file_map[field] != (uint32_t)-1) {
5ebddd2d812296900bc255b24bcd508878784c37Timo Sirainen /* it was already added */
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen buffer = buffer_create_dynamic(pool_datastack_create(),
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen offset = mail_cache_transaction_get_space(ctx, size, size, &size, TRUE);
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen else if (pwrite_full(cache->fd, data, size, offset) < 0) {
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen mail_cache_set_syscall_error(cache, "pwrite_full()");
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen mail_cache_set_syscall_error(cache, "fdatasync()");
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen } else if (mail_cache_header_fields_get_next_offset(cache,
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen /* after it's guaranteed to be in disk, update header offset */
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen if (pwrite_full(cache->fd, &offset, sizeof(offset),
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen mail_cache_set_syscall_error(cache, "pwrite_full()");
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen /* we'll need to fix mappings. */
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenvoid mail_cache_add(struct mail_cache_transaction_ctx *ctx, uint32_t seq,
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen unsigned int field, const void *data, size_t data_size)
4bbee99b3aef449a9a2a11a5b5cf1ca486915c49Timo Sirainen if (ctx->cache->fields[field].field.decision ==
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen (MAIL_CACHE_DECISION_NO | MAIL_CACHE_DECISION_FORCED))
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen file_field = ctx->cache->field_file_map[field];
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen /* we'll have to add this field to headers */
5ebddd2d812296900bc255b24bcd508878784c37Timo Sirainen if (mail_cache_header_add_field(ctx, field) < 0)
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen file_field = ctx->cache->field_file_map[field];
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen mail_cache_decision_add(ctx->view, seq, field);
4bbee99b3aef449a9a2a11a5b5cf1ca486915c49Timo Sirainen fixed_size = ctx->cache->fields[field].field.field_size;
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen i_assert(fixed_size == (unsigned int)-1 || fixed_size == data_size);
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* remember roughly what we have modified, so cache lookups can
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen look into transactions to see changes. */
ca316aeb7648d3f1bcf45231f73ddeb1b67a6961Timo Sirainen if (seq < ctx->view->trans_seq1 || ctx->view->trans_seq1 == 0)
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (buffer_get_used_size(ctx->cache_data) + full_size >
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen /* time to flush our buffer */
e015e2f7e7f48874495f9df8b0dd192b7ffcb5ccTimo Sirainen buffer_append(ctx->cache_data, &file_field, sizeof(file_field));
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen buffer_append(ctx->cache_data, data, data_size);
992a13add4eea0810e4db0f042a595dddf85536aTimo Sirainen buffer_append(ctx->cache_data, null4, 4 - (data_size & 3));
ca316aeb7648d3f1bcf45231f73ddeb1b67a6961Timo Sirainenint mail_cache_transaction_lookup(struct mail_cache_transaction_ctx *ctx,
ca316aeb7648d3f1bcf45231f73ddeb1b67a6961Timo Sirainen return mail_index_update_cache_lookup(ctx->trans, seq, offset_r);
e1f05b193ac1edd3267294e9501e8063aa0f791aTimo Sirainenstatic int mail_cache_link_unlocked(struct mail_cache *cache,
e1f05b193ac1edd3267294e9501e8063aa0f791aTimo Sirainen new_offset += offsetof(struct mail_cache_record, prev_offset);
e1f05b193ac1edd3267294e9501e8063aa0f791aTimo Sirainen mail_cache_set_syscall_error(cache, "pwrite_full()");
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenint mail_cache_link(struct mail_cache *cache, uint32_t old_offset,
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen if (new_offset + sizeof(struct mail_cache_record) >
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen "Cache record offset %u points outside file",
e1f05b193ac1edd3267294e9501e8063aa0f791aTimo Sirainen if (mail_cache_link_unlocked(cache, old_offset, new_offset) < 0)
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainenint mail_cache_delete(struct mail_cache *cache, uint32_t offset)
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen cache_rec = mail_cache_get_record(cache, offset);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* we'll only update the deleted_space in header. we can't really
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen do any actual deleting as other processes might still be using
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen the data. also it's actually useful as some index views are still
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen able to ask cached data from messages that have already been
72cbf33ae81fde08384d30c779ff540752d9256cTimo Sirainen cache->hdr_copy.deleted_space += cache_rec->size;