/*-
 * Copyright (c) Peter Wemm <peter@netplex.com.au>
 * Copyright (c) 2008 The DragonFly Project.
 * All rights reserved.
 *
 * 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.
 *
 *	Only machine-dependant code should ever include this file.  MI
 *	code and header files do NOT include this file.  e.g. sys/globaldata.h
 *	should not include this file.
 *
 * $FreeBSD: src/sys/i386/include/globaldata.h,v 1.11.2.1 2000/05/16 06:58:10 dillon Exp $
 */

#ifndef _MACHINE_GLOBALDATA_H_
#define _MACHINE_GLOBALDATA_H_

#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)

#ifndef _SYS_GLOBALDATA_H_
#include <sys/globaldata.h>	/* struct globaldata */
#endif
#ifndef _SYS_THREAD_H_
#include <sys/thread.h>		/* struct thread */
#endif
#include <machine/segments.h>	/* struct user_segment_descriptor */
#include <machine/tss.h>	/* struct x86_64tss */
#include <machine/npx.h>

struct pv_entry;

/*
 * Note on interrupt control.  Pending interrupts not yet dispatched are
 * marked in gd_fpending or gd_spending.  Once dispatched the interrupt's
 * pending bit is cleared and the interrupt is masked.  Upon completion
 * the interrupt is unmasked.
 *
 * For edge triggered interrupts interrupts may be enabled again at this
 * point and if they occur before the interrupt service routine is complete
 * the service routine will loop.
 *
 * The current thread's cpl is stored in the thread structure.
 *
 * Note: the embedded globaldata and/or the mdglobaldata structure
 * may exceed the size of a page.
 */
struct mdglobaldata {
	struct globaldata mi;
	struct user_segment_descriptor gd_common_tssd;
	struct user_segment_descriptor *gd_tss_gdt;	/* gd_gdt[GPROC0_SEL] */
	struct thread   *gd_npxthread;
	union savefpu	gd_savefpu;	/* fast bcopy/zero temp fpu save area */
	union savefpu	gd_zerofpu;	/* xrstor/fxrstor/frstor zero regs */
	int		gd_fpu_lock;	/* fast bcopy/zero cpu lock */
	int		gd_xinvaltlb;	/* reentrancy check invaltlb routine */
	int		gd_unused001;
	int		gd_spending;	/* software interrupt pending */
	int		gd_sdelayed;	/* delayed software ints */
	int		gd_currentldt;
	int		gd_private_tss;
	u_int		gd_unused002;
	u_int		gd_unused003;
	u_int		gd_ss_eflags;
	struct user_segment_descriptor *gd_gdt; /* pcpu gdt[] table */
	long		gd_lunused1;
	long		gd_lunused2;
	long		gd_lunusde3;
	caddr_t		gd_aunused0;
	caddr_t		gd_aunused1;
	caddr_t		gd_aunused2;
	struct pv_entry	*gd_newpv;
	u_int		gd_acpi_id;
	u_int		gd_apic_id;
	register_t	gd_unused004;
	register_t	gd_unused005;
	register_t	gd_user_fs;	/* current user fs in MSR */
	register_t	gd_user_gs;	/* current user gs in MSR */
	cpumask_t	gd_unused006;
	u_long		gd_ipending[3];
};

#define MDGLOBALDATA_BASEALLOC_SIZE	\
	((sizeof(struct mdglobaldata) + PAGE_MASK) & ~PAGE_MASK)
#define MDGLOBALDATA_BASEALLOC_PAGES	\
	(MDGLOBALDATA_BASEALLOC_SIZE / PAGE_SIZE)
#define MDGLOBALDATA_PAD		\
	(MDGLOBALDATA_BASEALLOC_SIZE - sizeof(struct mdglobaldata))

/*
 * This is the upper (0xff800000) address space layout that is per-cpu.
 * It is setup in locore.s and pmap.c for the BSP and in mp_machdep.c for
 * each AP.  genassym helps export this to the assembler code.
 *
 * Most of the major elements in struct privatespace must be
 * PAGE_SIZE aligned.
 */
struct privatespace {
	/*
	 * page 0 - data page
	 */
	struct mdglobaldata mdglobaldata;
	char		__filler0[MDGLOBALDATA_PAD];

	/*
	 * page 1 - Unused (unmapped)
	 */
	char		unused2[PAGE_SIZE];

	/*
	 * page 2 - Trampoline page.  Put the trampoline and common_tss
	 *	    in the same page to make them easier to isolate
	 *	    from the rest of the kernel map.  See x86_64/pmap.c
	 *
	 *	    rsp0 points into trampoline.  Interrupts are always
	 *	    disabled for this case but leave reserved1[]
	 *	    reserved just in case.
	 */
	char		reserved1[PAGE_SIZE -
				  sizeof(struct trampframe) -
				  sizeof(uint64_t) -
				  sizeof(struct x86_64tss)];
	struct trampframe trampoline;
	uint64_t	reserved1b;	/* 16-byte-align trampoline */
	struct x86_64tss common_tss;	/* (misaligned by 8 bytes) */

	/*
	 * page 3, 4 - NMI, Double fault stack
	 * page 5, 6 - Debug fault stack
	 */
	char		dblstack[PAGE_SIZE * 2 -
				 sizeof(struct trampframe)];
	struct trampframe dbltramp;
	char		dbgstack[PAGE_SIZE * 2 -
				 sizeof(struct trampframe)];
	struct trampframe dbgtramp;

	/* page 7+   - idle stack (UPAGES pages) */
	char		idlestack[UPAGES * PAGE_SIZE];
} __packed;

#define mdcpu  		((struct mdglobaldata *)_get_mycpu())
#define pscpu  		((struct privatespace *)_get_mycpu())

#endif

#ifdef _KERNEL

extern struct privatespace *CPU_prvspace[];

#endif

#endif