/*********************************************************************
 *                
 * Copyright (C) 2002, 2004, 2006, 2010,  Karlsruhe University
 *                
 * File path:     api/v4/space.h
 * 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: space.h,v 1.13 2006/11/14 18:45:37 skoglund Exp $
 *                
 ********************************************************************/
#ifndef __API__V4__SPACE_H__
#define __API__V4__SPACE_H__

#include <kmemory.h>
#include INC_GLUE(space.h)

EXTERN_KMEM_GROUP (kmem_utcb);

extern space_t * sigma0_space;
extern space_t * sigma1_space;
extern space_t * roottask_space;

INLINE bool is_sigma0_space(space_t * space)
{
    return (space == sigma0_space);
}

INLINE bool is_sigma1_space(space_t * space)
{
    return (space == sigma1_space);
}

INLINE bool is_roottask_space(space_t * space)
{
    return (space == roottask_space);
}

INLINE bool is_privileged_space(space_t * space)
{
    return (is_roottask_space(space) ||
	    is_sigma0_space(space) || 
	    is_sigma1_space(space));
}

INLINE bool space_t::is_mappable(addr_t addr)
{
    return (is_user_area(addr) && 
	(!get_kip_page_area().is_addr_in_fpage(addr)) &&
	(!get_utcb_page_area().is_addr_in_fpage(addr)) &&
	is_arch_mappable(addr, 1));
}

INLINE bool space_t::is_mappable(fpage_t fpage)
{
    return (is_user_area(fpage) &&
	(!get_kip_page_area().is_overlapping(fpage)) &&
	(!get_utcb_page_area().is_overlapping(fpage)) &&
	is_arch_mappable(fpage.get_address(), fpage.get_size()));
}

INLINE bool space_t::is_user_area(fpage_t fpage)
{
    return is_user_area(fpage.get_address()) && 
	is_user_area(addr_offset(fpage.get_address(), fpage.get_size()-1));
}


INLINE bool space_t::is_user_area (addr_t addr)
{
#if (USER_AREA_START != 0)
    return (((word_t) sign_extend(addr)) >= USER_AREA_START &&
	    ((word_t) sign_extend(addr)) < USER_AREA_END);
#else
    return (((word_t) sign_extend(addr)) < USER_AREA_END);
#endif
    
}

INLINE bool space_t::is_kernel_area(addr_t addr)
{
    return (((word_t)sign_extend(addr)) >= KERNEL_AREA_START &&
	    ((word_t)sign_extend(addr)) < KERNEL_AREA_END);
}

INLINE bool space_t::is_tcb_area (addr_t addr)
{
#if defined(CONFIG_STATIC_TCBS)
    return false;
#else
    return (((word_t) sign_extend(addr)) >= KTCB_AREA_START &&
	    ((word_t) sign_extend(addr)) < KTCB_AREA_END);
#endif
}

INLINE bool space_t::is_copy_area (addr_t addr)
{
    return (((word_t)sign_extend(addr)) >= COPY_AREA_START &&
	    ((word_t)sign_extend(addr)) < COPY_AREA_END);
}

INLINE bool space_t::is_initialized()
{
    return !get_kip_page_area().is_nil_fpage();
}

INLINE fpage_t space_t::unmap_fpage (fpage_t fpage, bool flush, bool all)
{
    mdb_t::ctrl_t ctrl (0);
    ctrl.mapctrl_self	= flush;
    ctrl.unmap		= fpage.is_rwx ();
    ctrl.set_rights	= ! fpage.is_rwx ();
    ctrl.reset_status	= 1;
    ctrl.deliver_status	= 1;
    fpage.set_rwx (~fpage.get_rwx ());
    return mapctrl (fpage, ctrl, 0, all);
}

#endif /* !__API__V4__SPACE_H__ */