/*
 * Copyright (c) 2000 University of Utah and the Flux Group.
 * All rights reserved.
 * 
 * This file is part of the Flux OSKit.  The OSKit is free software, also known
 * as "open source;" you can redistribute it and/or modify it under the terms
 * of the GNU General Public License (GPL), version 2, as published by the Free
 * Software Foundation (FSF).  To explore alternate licensing terms, contact
 * the University of Utah at csl-dist@cs.utah.edu or +1-801-585-3271.
 * 
 * The OSKit is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GPL for more details.  You should have
 * received a copy of the GPL along with the OSKit; see the file COPYING.  If
 * not, write to the FSF, 59 Temple Place #330, Boston, MA 02111-1307, USA.
 */

/*
 * Add guard blocks to the malloc_lmm.
 */
#include <oskit/lmm.h>
#include <oskit/page.h>
#include <knit/c/lmm.h>
#include <oskit/machine/phys_lmm.h>

#include <oskit/debug.h>

extern const oskit_u32_t guard_size; // size of guard blocks in words
#define GUARD_SIZE (guard_size * sizeof(oskit_u32_t))

#define inline

static void
set_guard(void *m)
{
        int i;
        for(i=0; i < guard_size; ++i) {
                ((oskit_u32_t*)m)[i] = 0xdeadbeef;
        }
}

static void
check_guard(char * which, oskit_u32_t *m)
{
        int i;
        for(i=0; i < guard_size; ++i) {
                oskit_u32_t x = ((oskit_u32_t*)m)[i];
                if (x != 0xdeadbeef) {
                        panic("guard corrupted: %s[%d] == %x\n",which,i,x);
                }
        }
}

static void
scrub(char *block, oskit_size_t size)
{
        int i;
        for(i=0; i < size; ++i) {
                block[i] = 0xff;
        }
}

void out_add_region(lmm_region_t *lmm_region,
                    void *addr, oskit_size_t size,
                    lmm_flags_t flags, lmm_pri_t pri)
{
        in_add_region(lmm_region,addr,size,flags,pri);
}

void out_add_free(void *block, oskit_size_t size)
{
        in_add_free(block,size);
}

void out_remove_free(void *block, oskit_size_t size)
{
        in_remove_free(block,size);
}

void *out_alloc(oskit_size_t size, lmm_flags_t flags)
{
        void* r;
        r = in_alloc(size + 2*GUARD_SIZE,flags);
        if (r) {
                set_guard(r);
                r += GUARD_SIZE;
                set_guard(r+size);
        }
        return r;
}

void *out_alloc_aligned(oskit_size_t size, lmm_flags_t flags,
                    int align_bits, oskit_addr_t align_ofs)
{
        void* r;
        align_ofs = (align_ofs + GUARD_SIZE) & ((1 << align_bits) - 1);
        r = in_alloc_aligned(size + 2*GUARD_SIZE,flags,align_bits,align_ofs);
        if (r) {
                set_guard(r);
                r += GUARD_SIZE;
                set_guard(r+size);
        }
        return r;
}

void *out_alloc_page(lmm_flags_t flags)
{
	return in_alloc_gen(PAGE_SIZE, flags, PAGE_SHIFT, 0,
                            (oskit_addr_t)0, (oskit_size_t)-1);
}

void *out_alloc_gen(oskit_size_t size, lmm_flags_t flags,
                int align_bits, oskit_addr_t align_ofs,
                oskit_addr_t bounds_min, oskit_addr_t bounds_max)
{
        void* r;
        align_ofs = (align_ofs + GUARD_SIZE) & ((1 << align_bits) - 1);
        r = in_alloc_gen(size,flags,align_bits,align_ofs,
                         bounds_min + GUARD_SIZE,
                         bounds_max + GUARD_SIZE);
        if (r) {
                set_guard(r);
                r += GUARD_SIZE;
                set_guard(r+size);
        }
        return r;
}

oskit_size_t out_avail(lmm_flags_t flags)
{
        oskit_size_t r;
        r = in_avail(flags);
        return r;
}

void out_find_free(oskit_addr_t *inout_addr,
                   oskit_size_t *out_size, lmm_flags_t *out_flags)
{
        in_find_free(inout_addr,out_size,out_flags);
}

void out_free(void *block, oskit_size_t size)
{
        check_guard("post", block+size);
        block -= GUARD_SIZE;
        size  += GUARD_SIZE * 2;
        check_guard("pre", block);
        scrub(block,size);
        in_free(block,size);
}

void out_free_page(void *block)
{
	in_free(block, PAGE_SIZE);
}

/* Only available if debugging turned on.  */
void out_dump(void)
{
        in_dump();
}

void out_stats(void)
{
        in_stats();
}