indirect.c

/*
 * Copyright (C) 2010 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "ext4_utils.h"
#include "indirect.h"
#include "allocate.h"

#include <sparse/sparse.h>

#include <stdlib.h>
#include <stdio.h>

/* Creates data buffers for the first backing_len bytes of a block allocation
   and queues them to be written */
static u8 *create_backing(struct fs_info *info,
			  struct sparse_file *ext4_sparse_file,
			  jmp_buf *setjmp_env,
			  struct block_allocation *alloc,
			  unsigned long backing_len)
{
	if (DIV_ROUND_UP(backing_len, info->block_size) > EXT4_NDIR_BLOCKS)
		critical_error(setjmp_env,
			       "indirect backing larger than %d blocks",
			       EXT4_NDIR_BLOCKS);

	u8 *data = calloc(backing_len, 1);
	if (!data)
		critical_error_errno(setjmp_env, "calloc(%zu, 1)", backing_len);

	u8 *ptr = data;
	for (; alloc != NULL && backing_len > 0; get_next_region(alloc)) {
		u32 region_block;
		u32 region_len;
		u32 len;
		get_region(alloc, &region_block, &region_len);

		len = min(region_len * info->block_size, backing_len);

		sparse_file_add_data(ext4_sparse_file, ptr, len, region_block);
		ptr += len;
		backing_len -= len;
	}

	return data;
}

static void reserve_indirect_block(int force, jmp_buf *setjmp_env,
				   struct block_allocation *alloc, int len)
{
	if (reserve_oob_blocks(alloc, setjmp_env, 1)) {
		error(force, setjmp_env, "failed to reserve oob block");
		return;
	}

	if (advance_blocks(alloc, len)) {
		error(force, setjmp_env, "failed to advance %d blocks", len);
		return;
	}
}

static void reserve_dindirect_block(struct fs_aux_info *aux_info, int force,
				    jmp_buf *setjmp_env,
				    struct block_allocation *alloc, int len)
{
	if (reserve_oob_blocks(alloc, setjmp_env, 1)) {
		error(force, setjmp_env, "failed to reserve oob block");
		return;
	}

	while (len > 0) {
		int ind_block_len = min((int)aux_info->blocks_per_ind, len);

		reserve_indirect_block(force, setjmp_env, alloc, ind_block_len);

		len -= ind_block_len;
	}

}

static void reserve_tindirect_block(struct fs_aux_info *aux_info, int force,
				    jmp_buf *setjmp_env,
				    struct block_allocation *alloc, int len)
{
	if (reserve_oob_blocks(alloc, setjmp_env, 1)) {
		error(force, setjmp_env, "failed to reserve oob block");
		return;
	}

	while (len > 0) {
		int dind_block_len = min((int)aux_info->blocks_per_dind, len);

		reserve_dindirect_block(aux_info, force, setjmp_env, alloc,
					dind_block_len);

		len -= dind_block_len;
	}
}

static void fill_indirect_block(u32 *ind_block, int len,
				struct block_allocation *alloc)
{
	int i;
	for (i = 0; i < len; i++) {
		ind_block[i] = get_block(alloc, i);
	}
}

static void fill_dindirect_block(struct fs_info *info,
				 struct fs_aux_info *aux_info,
				 struct sparse_file *ext4_sparse_file,
				 int force, jmp_buf *setjmp_env,
				 u32 *dind_block,
				 int len, struct block_allocation *alloc)
{
	int i;
	u32 ind_block;

	for (i = 0; len > 0; i++) {
		ind_block = get_oob_block(alloc, 0);
		if (advance_oob_blocks(alloc, 1)) {
			error(force, setjmp_env, "failed to reserve oob block");
			return;
		}

		dind_block[i] = ind_block;

		u32 *ind_block_data = calloc(info->block_size, 1);
		if (!ind_block_data) {
			critical_error_errno(setjmp_env, "calloc(%zu,1)",
					     (size_t)info->block_size);
		}
		sparse_file_add_data(ext4_sparse_file, ind_block_data,
				     info->block_size, ind_block);
		int ind_block_len = min((int)aux_info->blocks_per_ind, len);

		fill_indirect_block(ind_block_data, ind_block_len, alloc);

		if (advance_blocks(alloc, ind_block_len)) {
			error(force, setjmp_env, "failed to advance %d blocks",
			      ind_block_len);
			return;
		}

		len -= ind_block_len;
	}
}

static void fill_tindirect_block(struct fs_info *info,
				 struct fs_aux_info *aux_info,
				 struct sparse_file *ext4_sparse_file,
				 int force, jmp_buf *setjmp_env,
				 u32 *tind_block, int len,
				 struct block_allocation *alloc)
{
	int i;
	u32 dind_block;

	for (i = 0; len > 0; i++) {
		dind_block = get_oob_block(alloc, 0);
		if (advance_oob_blocks(alloc, 1)) {
			error(force, setjmp_env, "failed to reserve oob block");
			return;
		}

		tind_block[i] = dind_block;

		u32 *dind_block_data = calloc(info->block_size, 1);
		if (!dind_block_data) {
			critical_error_errno(setjmp_env, "calloc(%zu, 1)",
					     (size_t)info->block_size);
		}
		sparse_file_add_data(ext4_sparse_file, dind_block_data,
				     info->block_size, dind_block);
		int dind_block_len = min((int)aux_info->blocks_per_dind, len);

		fill_dindirect_block(info, aux_info, ext4_sparse_file, force,
				     setjmp_env, dind_block_data,
				     dind_block_len, alloc);

		len -= dind_block_len;
	}
}

/* Given an allocation, attach as many blocks as possible to direct inode
   blocks, and return the rest */
static int inode_attach_direct_blocks(int force, jmp_buf *setjmp_env,
				      struct ext4_inode *inode,
				      struct block_allocation *alloc,
				      u32 *block_len)
{
	int len = min(*block_len, EXT4_NDIR_BLOCKS);
	int i;

	for (i = 0; i < len; i++) {
		inode->i_block[i] = get_block(alloc, i);
	}

	if (advance_blocks(alloc, len)) {
		error(force, setjmp_env, "failed to advance %d blocks", len);
		return -1;
	}

	*block_len -= len;
	return 0;
}

/* Given an allocation, attach as many blocks as possible to indirect blocks,
   and return the rest
   Assumes that the blocks necessary to hold the indirect blocks were included
   as part of the allocation */
static int inode_attach_indirect_blocks(struct fs_info *info,
					struct fs_aux_info *aux_info,
					struct sparse_file *ext4_sparse_file,
					int force, jmp_buf *setjmp_env,
					struct ext4_inode *inode,
					struct block_allocation *alloc,
					u32 *block_len)
{
	int len = min(*block_len, aux_info->blocks_per_ind);

	int ind_block = get_oob_block(alloc, 0);
	inode->i_block[EXT4_IND_BLOCK] = ind_block;

	if (advance_oob_blocks(alloc, 1)) {
		error(force, setjmp_env, "failed to advance oob block");
		return -1;
	}

	u32 *ind_block_data = calloc(info->block_size, 1);
	if (!ind_block_data) {
		critical_error_errno(setjmp_env, "calloc(%zu, 1)",
				     (size_t)info->block_size);
	}
	sparse_file_add_data(ext4_sparse_file, ind_block_data, info->block_size,
			     ind_block);

	fill_indirect_block(ind_block_data, len, alloc);

	if (advance_blocks(alloc, len)) {
		error(force, setjmp_env, "failed to advance %d blocks", len);
		return -1;
	}

	*block_len -= len;
	return 0;
}

/* Given an allocation, attach as many blocks as possible to doubly indirect
   blocks, and return the rest.
   Assumes that the blocks necessary to hold the indirect and doubly indirect
   blocks were included as part of the allocation */
static int inode_attach_dindirect_blocks(struct fs_info *info,
					 struct fs_aux_info *aux_info,
					 struct sparse_file *ext4_sparse_file,
					 int force, jmp_buf *setjmp_env,
					 struct ext4_inode *inode,
					 struct block_allocation *alloc,
					 u32 *block_len)
{
	int len = min(*block_len, aux_info->blocks_per_dind);

	int dind_block = get_oob_block(alloc, 0);
	inode->i_block[EXT4_DIND_BLOCK] = dind_block;

	if (advance_oob_blocks(alloc, 1)) {
		error(force, setjmp_env, "failed to advance oob block");
		return -1;
	}

	u32 *dind_block_data = calloc(info->block_size, 1);
	if (!dind_block_data) {
		critical_error_errno(setjmp_env, "calloc(%zu, 1)",
				     (size_t)info->block_size);
	}
	sparse_file_add_data(ext4_sparse_file, dind_block_data,
			     info->block_size, dind_block);

	fill_dindirect_block(info, aux_info, ext4_sparse_file, force,
			     setjmp_env, dind_block_data, len, alloc);

	if (advance_blocks(alloc, len)) {
		error(force, setjmp_env, "failed to advance %d blocks", len);
		return -1;
	}

	*block_len -= len;
	return 0;
}

/* Given an allocation, attach as many blocks as possible to triply indirect
   blocks, and return the rest.
   Assumes that the blocks necessary to hold the indirect, doubly indirect and
   triply indirect blocks were included as part of the allocation */
static int inode_attach_tindirect_blocks(struct fs_info *info,
					 struct fs_aux_info *aux_info,
					 struct sparse_file *ext4_sparse_file,
					 int force, jmp_buf *setjmp_env,
					 struct ext4_inode *inode,
					 struct block_allocation *alloc,
					 u32 *block_len)
{
	int len = min(*block_len, aux_info->blocks_per_tind);

	int tind_block = get_oob_block(alloc, 0);
	inode->i_block[EXT4_TIND_BLOCK] = tind_block;

	if (advance_oob_blocks(alloc, 1)) {
		error(force, setjmp_env, "failed to advance oob block");
		return -1;
	}

	u32 *tind_block_data = calloc(info->block_size, 1);
	if (!tind_block_data) {
		critical_error_errno(setjmp_env, "calloc(%zu, 1)",
				     (size_t)info->block_size);
	}
	sparse_file_add_data(ext4_sparse_file, tind_block_data,
			     info->block_size, tind_block);

	fill_tindirect_block(info, aux_info, ext4_sparse_file, force,
			     setjmp_env, tind_block_data, len, alloc);

	if (advance_blocks(alloc, len)) {
		error(force, setjmp_env, "failed to advance %d blocks", len);
		return -1;
	}

	*block_len -= len;
	return 0;
}

static void reserve_all_indirect_blocks(struct fs_aux_info *aux_info,
					int force, jmp_buf *setjmp_env,
					struct block_allocation *alloc, u32 len)
{
	if (len <= EXT4_NDIR_BLOCKS)
		return;

	len -= EXT4_NDIR_BLOCKS;
	advance_blocks(alloc, EXT4_NDIR_BLOCKS);

	u32 ind_block_len = min(aux_info->blocks_per_ind, len);
	reserve_indirect_block(force, setjmp_env, alloc, ind_block_len);

	len -= ind_block_len;
	if (len == 0)
		return;

	u32 dind_block_len = min(aux_info->blocks_per_dind, len);
	reserve_dindirect_block(aux_info, force, setjmp_env, alloc,
				dind_block_len);

	len -= dind_block_len;
	if (len == 0)
		return;

	u32 tind_block_len = min(aux_info->blocks_per_tind, len);
	reserve_tindirect_block(aux_info, force, setjmp_env, alloc,
				tind_block_len);

	len -= tind_block_len;
	if (len == 0)
		return;

	error(force, setjmp_env, "%d blocks remaining", len);
}

static u32 indirect_blocks_needed(struct fs_aux_info *aux_info,
				  jmp_buf *setjmp_env, u32 len)
{
	u32 ind = 0;

	if (len <= EXT4_NDIR_BLOCKS)
		return ind;

	len -= EXT4_NDIR_BLOCKS;

	/* We will need an indirect block for the rest of the blocks */
	ind += DIV_ROUND_UP(len, aux_info->blocks_per_ind);

	if (len <= aux_info->blocks_per_ind)
		return ind;

	len -= aux_info->blocks_per_ind;

	ind += DIV_ROUND_UP(len, aux_info->blocks_per_dind);

	if (len <= aux_info->blocks_per_dind)
		return ind;

	len -= aux_info->blocks_per_dind;

	ind += DIV_ROUND_UP(len, aux_info->blocks_per_tind);

	if (len <= aux_info->blocks_per_tind)
		return ind;

	critical_error(setjmp_env, "request too large");
	return 0;
}

static int do_inode_attach_indirect(struct fs_info *info,
				    struct fs_aux_info *aux_info,
				    struct sparse_file *ext4_sparse_file,
				    int force, jmp_buf *setjmp_env,
				    struct ext4_inode *inode,
				    struct block_allocation *alloc,
				    u32 block_len)
{
	u32 count = block_len;

	if (inode_attach_direct_blocks(force, setjmp_env, inode, alloc, &count)) {
		error(force, setjmp_env,
		      "failed to attach direct blocks to inode");
		return -1;
	}

	if (count > 0) {
		if (inode_attach_indirect_blocks(info, aux_info,
						 ext4_sparse_file, force,
						 setjmp_env, inode, alloc,
						 &count)) {
			error(force, setjmp_env,
			      "failed to attach indirect blocks to inode");
			return -1;
		}
	}

	if (count > 0) {
		if (inode_attach_dindirect_blocks(info, aux_info,
						  ext4_sparse_file, force,
						  setjmp_env, inode, alloc,
						  &count)) {
			error(force, setjmp_env,
			      "failed to attach dindirect blocks to inode");
			return -1;
		}
	}

	if (count > 0) {
		if (inode_attach_tindirect_blocks(info, aux_info,
						  ext4_sparse_file, force,
						  setjmp_env, inode, alloc,
						  &count)) {
			error(force, setjmp_env,
			      "failed to attach tindirect blocks to inode");
			return -1;
		}
	}

	if (count) {
		error(force, setjmp_env,
		      "blocks left after triply-indirect allocation");
		return -1;
	}

	rewind_alloc(alloc);

	return 0;
}

static struct block_allocation *do_inode_allocate_indirect(struct fs_aux_info
							   *aux_info, int force,
							   jmp_buf *setjmp_env,
							   u32 block_len)
{
	u32 indirect_len = indirect_blocks_needed(aux_info, setjmp_env,
						  block_len);

	struct block_allocation *alloc =
	    allocate_blocks(aux_info, force, setjmp_env,
			    block_len + indirect_len);

	if (alloc == NULL) {
		error(force, setjmp_env, "Failed to allocate %d blocks",
		      block_len + indirect_len);
		return NULL;
	}

	return alloc;
}

/* Allocates enough blocks to hold len bytes and connects them to an inode */
void inode_allocate_indirect(struct fs_info *info, struct fs_aux_info *aux_info,
			     struct sparse_file *ext4_sparse_file,
			     int force, jmp_buf *setjmp_env,
			     struct ext4_inode *inode, unsigned long len)
{
	struct block_allocation *alloc;
	u32 block_len = DIV_ROUND_UP(len, info->block_size);
	u32 indirect_len = indirect_blocks_needed(aux_info, setjmp_env,
						  block_len);

	alloc = do_inode_allocate_indirect(aux_info, force, setjmp_env,
					   block_len);
	if (alloc == NULL) {
		error(force, setjmp_env,
		      "failed to allocate extents for %lu bytes", len);
		return;
	}

	reserve_all_indirect_blocks(aux_info, force, setjmp_env, alloc,
				    block_len);
	rewind_alloc(alloc);

	if (do_inode_attach_indirect(info, aux_info, ext4_sparse_file, force,
				     setjmp_env, inode, alloc, block_len))
		error(force, setjmp_env,
		      "failed to attach blocks to indirect inode");

	inode->i_flags = 0;
	inode->i_blocks_lo =
	    (block_len + indirect_len) * info->block_size / 512;
	inode->i_size_lo = len;

	free_alloc(alloc);
}

void inode_attach_resize(struct fs_info *info, struct fs_aux_info *aux_info,
			 struct sparse_file *ext4_sparse_file,
			 int force, jmp_buf *setjmp_env,
			 struct ext4_inode *inode,
			 struct block_allocation *alloc)
{
	u32 block_len = block_allocation_len(alloc);
	u32 superblocks = block_len / info->bg_desc_reserve_blocks;
	u32 i, j;
	u64 blocks;
	u64 size;

	if (block_len % info->bg_desc_reserve_blocks)
		critical_error(setjmp_env,
			       "reserved blocks not a multiple of %d",
			       info->bg_desc_reserve_blocks);

	append_oob_allocation(aux_info, force, setjmp_env, alloc, 1);
	u32 dind_block = get_oob_block(alloc, 0);

	u32 *dind_block_data = calloc(info->block_size, 1);
	if (!dind_block_data)
		critical_error_errno(setjmp_env, "calloc(%zu, 1)",
				     (size_t)info->block_size);
	sparse_file_add_data(ext4_sparse_file, dind_block_data,
			     info->block_size, dind_block);

	u32 *ind_block_data =
	    calloc(info->block_size, info->bg_desc_reserve_blocks);
	if (!ind_block_data)
		critical_error_errno(setjmp_env, "calloc(%zu, %zu)",
				     (size_t)info->block_size,
				     (size_t)info->bg_desc_reserve_blocks);
	sparse_file_add_data(ext4_sparse_file, ind_block_data,
			     info->block_size * info->bg_desc_reserve_blocks,
			     get_block(alloc, 0));

	for (i = 0; i < info->bg_desc_reserve_blocks; i++) {
		int r =
		    (i -
		     aux_info->bg_desc_blocks) % info->bg_desc_reserve_blocks;
		if (r < 0)
			r += info->bg_desc_reserve_blocks;

		dind_block_data[i] = get_block(alloc, r);

		for (j = 1; j < superblocks; j++) {
			u32 b = j * info->bg_desc_reserve_blocks + r;
			ind_block_data[r * aux_info->blocks_per_ind + j - 1] =
			    get_block(alloc, b);
		}
	}

	u32 last_block = EXT4_NDIR_BLOCKS + aux_info->blocks_per_ind +
	    aux_info->blocks_per_ind * (info->bg_desc_reserve_blocks - 1) +
	    superblocks - 2;

	blocks = ((u64)block_len + 1) * info->block_size / 512;
	size = (u64)last_block *info->block_size;

	inode->i_block[EXT4_DIND_BLOCK] = dind_block;
	inode->i_flags = 0;
	inode->i_blocks_lo = blocks;
	inode->osd2.linux2.l_i_blocks_high = blocks >> 32;
	inode->i_size_lo = size;
	inode->i_size_high = size >> 32;
}

/* Allocates enough blocks to hold len bytes, with backing_len bytes in a data
   buffer, and connects them to an inode.  Returns a pointer to the data
   buffer. */
u8 *inode_allocate_data_indirect(struct fs_info *info,
				 struct fs_aux_info *aux_info,
				 struct sparse_file *ext4_sparse_file,
				 int force, jmp_buf *setjmp_env,
				 struct ext4_inode *inode, unsigned long len,
				 unsigned long backing_len)
{
	struct block_allocation *alloc;
	u32 block_len = DIV_ROUND_UP(len, info->block_size);
	u8 *data = NULL;

	alloc = do_inode_allocate_indirect(aux_info, force, setjmp_env,
					   block_len);
	if (alloc == NULL) {
		error(force, setjmp_env,
		      "failed to allocate extents for %lu bytes", len);
		return NULL;
	}

	if (backing_len) {
		data = create_backing(info, ext4_sparse_file, setjmp_env, alloc,
				      backing_len);
		if (!data)
			error(force, setjmp_env,
			      "failed to create backing for %lu bytes",
			      backing_len);
	}

	rewind_alloc(alloc);
	if (do_inode_attach_indirect(info, aux_info, ext4_sparse_file, force,
				     setjmp_env, inode, alloc, block_len))
		error(force, setjmp_env,
		      "failed to attach blocks to indirect inode");

	free_alloc(alloc);

	return data;
}