/*
 * Copyright 2008-2010, Ingo Weinhold, ingo_weinhold@gmx.de.
 * Copyright 2002-2007, Axel Dörfler, axeld@pinc-software.de. All rights reserved.
 * Distributed under the terms of the MIT License.
 *
 * Copyright 2001-2002, Travis Geiselbrecht. All rights reserved.
 * Distributed under the terms of the NewOS License.
 */


#include <arch/vm_translation_map.h>

#include <boot/kernel_args.h>
#include <safemode.h>

#ifdef __x86_64__
#       include "paging/64bit/X86PagingMethod64Bit.h"
#else
#       include "paging/32bit/X86PagingMethod32Bit.h"
#       include "paging/pae/X86PagingMethodPAE.h"
#endif


//#define TRACE_VM_TMAP
#ifdef TRACE_VM_TMAP
#       define TRACE(x...) dprintf(x)
#else
#       define TRACE(x...) ;
#endif


static union {
        uint64  align;
#ifdef __x86_64__
        char    sixty_four[sizeof(X86PagingMethod64Bit)];
#else
        char    thirty_two[sizeof(X86PagingMethod32Bit)];
#if B_HAIKU_PHYSICAL_BITS == 64
        char    pae[sizeof(X86PagingMethodPAE)];
#endif
#endif
} sPagingMethodBuffer;


// #pragma mark - VM API


status_t
arch_vm_translation_map_create_map(bool kernel, VMTranslationMap** _map)
{
        return gX86PagingMethod->CreateTranslationMap(kernel, _map);
}


status_t
arch_vm_translation_map_init(kernel_args *args,
        VMPhysicalPageMapper** _physicalPageMapper)
{
        TRACE("vm_translation_map_init: entry\n");

#ifdef TRACE_VM_TMAP
        TRACE("physical memory ranges:\n");
        for (uint32 i = 0; i < args->num_physical_memory_ranges; i++) {
                phys_addr_t start = args->physical_memory_range[i].start;
                phys_addr_t end = start + args->physical_memory_range[i].size;
                TRACE("  %#10" B_PRIxPHYSADDR " - %#10" B_PRIxPHYSADDR "\n", start,
                        end);
        }

        TRACE("allocated physical ranges:\n");
        for (uint32 i = 0; i < args->num_physical_allocated_ranges; i++) {
                phys_addr_t start = args->physical_allocated_range[i].start;
                phys_addr_t end = start + args->physical_allocated_range[i].size;
                TRACE("  %#10" B_PRIxPHYSADDR " - %#10" B_PRIxPHYSADDR "\n", start,
                        end);
        }

        TRACE("allocated virtual ranges:\n");
        for (uint32 i = 0; i < args->num_virtual_allocated_ranges; i++) {
                addr_t start = args->virtual_allocated_range[i].start;
                addr_t end = start + args->virtual_allocated_range[i].size;
                TRACE("  %#10" B_PRIxADDR " - %#10" B_PRIxADDR "\n", start, end);
        }
#endif

#ifdef __x86_64__
        bool la57Available = x86_check_feature(IA32_FEATURE_LA57, FEATURE_7_ECX);
        bool enabled = la57Available && (x86_read_cr4() & IA32_CR4_LA57) != 0;
        if (enabled)
                dprintf("using LA57 paging\n");
        gX86PagingMethod = new(&sPagingMethodBuffer) X86PagingMethod64Bit(enabled);
#elif B_HAIKU_PHYSICAL_BITS == 64
        bool paeAvailable = x86_check_feature(IA32_FEATURE_PAE, FEATURE_COMMON);
        bool paeNeeded = x86_check_feature(IA32_FEATURE_AMD_EXT_NX,
                FEATURE_EXT_AMD);
        if (!paeNeeded) {
                for (uint32 i = 0; i < args->num_physical_memory_ranges; i++) {
                        phys_addr_t end = args->physical_memory_range[i].start
                                + args->physical_memory_range[i].size;
                        if (end > 0x100000000LL) {
                                paeNeeded = true;
                                break;
                        }
                }
        }

        bool paeDisabled = get_safemode_boolean_early(args,
                B_SAFEMODE_4_GB_MEMORY_LIMIT, false);

        if (paeAvailable && paeNeeded && !paeDisabled) {
                dprintf("using PAE paging\n");
                gX86PagingMethod = new(&sPagingMethodBuffer) X86PagingMethodPAE;
        } else {
                dprintf("using 32 bit paging (PAE %s)\n",
                        paeNeeded
                                ? "not available"
                                : (paeDisabled ? "disabled" : "not needed"));
                gX86PagingMethod = new(&sPagingMethodBuffer) X86PagingMethod32Bit;
        }
#else
        gX86PagingMethod = new(&sPagingMethodBuffer) X86PagingMethod32Bit;
#endif

        return gX86PagingMethod->Init(args, _physicalPageMapper);
}


status_t
arch_vm_translation_map_init_post_sem(kernel_args *args)
{
        return B_OK;
}


status_t
arch_vm_translation_map_init_post_area(kernel_args *args)
{
        TRACE("vm_translation_map_init_post_area: entry\n");

        return gX86PagingMethod->InitPostArea(args);
}


status_t
arch_vm_translation_map_early_map(kernel_args *args, addr_t va, phys_addr_t pa,
        uint8 attributes)
{
        TRACE("early_tmap: entry pa %#" B_PRIxPHYSADDR " va %#" B_PRIxADDR "\n", pa,
                va);

        return gX86PagingMethod->MapEarly(args, va, pa, attributes);
}


/*!     Verifies that the page at the given virtual address can be accessed in the
        current context.

        This function is invoked in the kernel debugger. Paranoid checking is in
        order.

        \param virtualAddress The virtual address to be checked.
        \param protection The area protection for which to check. Valid is a bitwise
                or of one or more of \c B_KERNEL_READ_AREA or \c B_KERNEL_WRITE_AREA.
        \return \c true, if the address can be accessed in all ways specified by
                \a protection, \c false otherwise.
*/
bool
arch_vm_translation_map_is_kernel_page_accessible(addr_t virtualAddress,
        uint32 protection)
{
        if (!gX86PagingMethod)
                return true;

        return gX86PagingMethod->IsKernelPageAccessible(virtualAddress, protection);
}