/*********************************************************************
 *                
 * Copyright (C) 2003,  Karlsruhe University
 *                
 * File path:     mbi.cc
 * Description:   
 *                
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *                
 * $Id: mbi.cc,v 1.3.2.1 2003/12/16 14:52:37 joshua Exp $
 *                
 ********************************************************************/

#include "mbi.h"
#include "lib.h"

/**
 * Returns the total size of the mbi.  Includes the size of module
 * definitions, strings, and any space necessary to maintain
 * aligment.
 *
 * @returns The total size of the mbi.
 */
L4_Word_t mbi_t::get_size()
{
    L4_Word_t tot = sizeof(mbi_t);
    L4_Word_t alignment_space = sizeof(L4_Word_t);

    tot += 1 + strlen(this->cmdline) + alignment_space;

    for( L4_Word_t i = 0; i < this->modcount; i++ )
    {
	tot += sizeof(mbi_module_t);
	tot += 1 + strlen(this->mods[i].cmdline) + alignment_space;
    }

    return tot;
}

/**
 * Copies the current mbi into a new location.
 *
 * @param target	The destination for the new copy.  Must have enough
 * 			space to store the copy.  The space is calculated
 * 			via the get_size() method.
 */
void mbi_t::copy( mbi_t *target )
{
    // Put strings after the target mbi and after the modules.
    char *strings = (char *)( L4_Word_t(target) + sizeof(mbi_t) + 
	    sizeof(mbi_module_t)*this->modcount );

    // Copy the structure.
    memcopy( target, this, sizeof(mbi_t) );
    // Copy the command line.
    if( this->cmdline )
    {
	target->cmdline = strings;
	strcpy( target->cmdline, this->cmdline );
	strings = strings + 1 + strlen(this->cmdline);
	// TODO: align the strings pointer.
    }

    // Put modules at end of the target mbi.  Assume this will get
    // proper aligment.
    target->mods = (mbi_module_t *)( L4_Word_t(target) + sizeof(mbi_t) );

    for( L4_Word_t i = 0; i < this->modcount; i++ )
    {
	// Copy the structure.
	memcopy( &target->mods[i], &this->mods[i], sizeof(mbi_module_t) );
	// Copy the command line.
	if( this->mods[i].cmdline )
	{
	    target->mods[i].cmdline = strings;
	    strcpy( target->mods[i].cmdline, this->mods[i].cmdline );
	    strings = strings + 1 + strlen(this->mods[i].cmdline);
	    // TODO: align the strings pointer.
	}
    }
}

/**
 * Determines whether there is a conflict for a memory region with
 * the modules defined by the mbi.
 *
 * @param start		The start of the memory region.
 * @param size		The size of the memory region.
 *
 * @returns true if there is no conflict, otherwise false.
 */
bool mbi_t::is_mem_region_free( L4_Word_t start, L4_Word_t size )
{
    L4_Word_t end = start - 1 + size;

    // Look for conflicts with modules.
    for( L4_Word_t i = 0; i < this->modcount; i++ )
    {
	L4_Word_t mod_start = this->mods[i].start;
	L4_Word_t mod_end = this->mods[i].end;
	if( is_intersection(start, end, mod_start, mod_end) )
	    return false;
    }

    // Look for a conflict with the bootloader.
    extern char _kickstart_begin[], _kickstart_end[];
    L4_Word_t kick_begin = L4_Word_t(_kickstart_begin);
    L4_Word_t kick_end = L4_Word_t(_kickstart_end);
    return !is_intersection( start, end, kick_begin, kick_end );
}