harvey/sys/src/9/riscv/dat.h

/*
 * This file is part of the UCB release of Plan 9. It is subject to the license
 * terms in the LICENSE file found in the top-level directory of this
 * distribution and at http://akaros.cs.berkeley.edu/files/Plan9License. No
 * part of the UCB release of Plan 9, including this file, may be copied,
 * modified, propagated, or distributed except according to the terms contained
 * in the LICENSE file.
 */

typedef struct Conf Conf;
typedef struct Confmem Confmem;
typedef struct Fxsave Fxsave;
typedef struct ICC ICC;
typedef struct ICCparms ICCparms;
typedef struct ISAConf ISAConf;
typedef struct Label Label;
typedef struct Lock Lock;
typedef struct MCPU MCPU;
typedef struct MFPU MFPU;
typedef struct MMMU MMMU;
typedef struct NIX NIX;
typedef struct Mach Mach;
typedef u64 Mpl;
typedef struct Page Page;
typedef struct PFPU PFPU;
typedef struct PmcCtr PmcCtr;
typedef struct PmcCtl PmcCtl;
typedef struct PmcWait PmcWait;
typedef struct PMMU PMMU;
typedef struct PNOTIFY PNOTIFY;
typedef u64 PTE;
typedef struct Proc Proc;
typedef struct Sys Sys;
typedef struct Stackframe Stackframe;
typedef u64 uintmem; /* Physical address (hideous) */
typedef struct Ureg Ureg;
typedef struct Vctl Vctl;

/*
 * Conversion for Ureg to gdb reg. This avoids a lot of nonsense
 * in the outside world. TODO.
 */
enum regnames {
	GDB_IP,
};
#define DBG_MAX_REG_NUM (0)
#define GDB_NUMREGBYTES (0)

#define MAXSYSARG 6 /* for mount(fd, afd, mpt, flag, arg, mntname) */

/*
 *  parameters for sysproc.c
 */
#define ELF_MAGIC (ELF_MAG)

/*
 *  machine dependent definitions used by ../port/portdat.h
 */

/* Crap. */
struct ISAConf {
	int _;
};

/* End Crap. */

struct Lock {
	u32 key;
	int isilock;
	Mpl pl;
	usize _pc;
	Proc *p;
	Mach *m;
	u64 lockcycles;
};

struct Label {
	/* order known to assembly */
	usize sp;
	usize pc;
	usize fp;
	usize x[32];
};

struct Fxsave {
	int _;
};

/*
 *  FPU stuff in Proc
 */
struct PFPU {
	int fpustate;
	unsigned char fxsave[sizeof(Fxsave) + 15];
	void *fpusave;
};

/*
 *  MMU stuff in Proc
 */
#define NCOLOR 1
struct PMMU {
	Page *mmuptp[4]; /* page table pages for each level */
};

/*
 *  things saved in the Proc structure during a notify
 */
struct PNOTIFY {
	//	void	emptiness;
	char emptiness;
};

struct Confmem {
	usize base;
	usize npage;
	usize kbase;
	usize klimit;
};

struct Conf {
	u32 nproc;	   /* processes */
	Confmem mem[4];	   /* physical memory */
	u64 npage;	   /* total physical pages of memory */
	usize upages;	   /* user page pool */
	u32 copymode; /* 0 is copy on write, 1 is copy on reference */
	u32 ialloc;   /* max interrupt time allocation in bytes */
	u32 nimage;   /* number of page cache image headers */
};

enum {
	NPGSZ = 4 /* # of supported  pages sizes in Mach */
};

#include "../port/portdat.h"

/*
 *  CPU stuff in Mach.
 */
struct MCPU {
	int _;
};

/*
 *  FPU stuff in Mach.
 */
struct MFPU {
	int _;
};

struct NIX {
	ICC *icc; /* inter-core call */
	int nixtype;
};

/*
 *  MMU stuff in Mach.
 */
struct MMMU {
	usize badaddr;
	Page *root; /* root for this processor */
	PTE *pmap;  /* unused as of yet */

	Page nixkludge; /* NIX KLUDGE: we need a page */
};

/*
 * Inter core calls
 */
enum {
	ICCLNSZ = 128, /* Cache line size for inter core calls */

	ICCOK = 0, /* Return codes: Ok; trap; syscall */
	ICCTRAP,
	ICCSYSCALL
};

struct ICC {
	/* fn is kept in its own cache line */
	union {
		void (*fn)(void);
		unsigned char _ln1_[ICCLNSZ];
	};
	int flushtlb;		     /* on the AC, before running fn */
	int rc;			     /* return code from AC to TC */
	char *note;		     /* to be posted in the TC after returning */
	unsigned char data[ICCLNSZ]; /* sent to the AC */
};

/*
 * hw perf counters
 */
struct PmcCtl {
	Ref r;
	u32 _coreno;
	int enab;
	int user;
	int os;
	int nodesc;
	char descstr[KNAMELEN];
	int reset;
};

struct PmcWait {
	Ref r;
	Rendez rend;
	PmcWait *next;
};

struct PmcCtr {
	int stale;
	PmcWait *wq;
	u64 ctr;
	int ctrset;
	PmcCtl PmcCtl;
	int ctlset;
};

enum {
	PmcMaxCtrs = 4,
	PmcIgn = 0,
	PmcGet = 1,
	PmcSet = 2,
};

/*
 * Per processor information.
 *
 * The offsets of the first few elements may be known
 * to low-level assembly code, so do not re-order:
 *	self	- machp()
 *	splpc	- splhi, spllo, splx
 *	proc	- syscallentry
 *	stack	- acsyscall
 *	externup - externup()
 *
 * riscv uses tp for mach.
 */
struct Mach {
	/* WARNING! Known to assembly! */
	usize self; /* %gs:0 still gives us a Mach* */
	u64 splpc; /* pc of last caller to splhi */

	Proc *proc;	   /* current process on this processor */
	usize stack;   /* mach stack, kstack is in proc->kstack */
	usize rathole; /* to save a reg in syscallentry */
	Proc *externup;	   /* Forsyth recommends we replace the global up with this. */
	/* end warning, I think */

	int machno; /* physical id of processor */

	int online;

	MMMU MMU;

	u64 ticks; /* of the clock since boot time */
	Label sched;	/* scheduler wakeup */
	Lock alarmlock; /* access to alarm list */
	void *alarm;	/* alarms bound to this clock */
	int inclockintr;

	Proc *readied;	     /* old runproc, only relevant if kernel booted with nosmp (-n append) */
	u64 schedticks; /* next forced context switch, same as above */
	u64 qstart;     /* time when up started running */
	int qexpired;	     /* quantum expired */

	int tlbfault;
	int tlbpurge;
	int pfault;
	int cs;
	int syscall;
	int intr;
	int mmuflush; /* make current proc flush it's mmu state */
	int ilockdepth;
	Perf perf;  /* performance counters */
	int inidle; /* profiling */
	int lastintr;

	u64 cyclefreq; /* Frequency of user readable cycle counter */
	i64 cpuhz;
	int cpumhz;
	u64 rdtsc;

	Lock pmclock;
	PmcCtr pmc[PmcMaxCtrs];

	MFPU FPU;
	MCPU CPU;

	NIX NIX;

	/* for restoring pre-AMP scheduler */
	Sched *sch;
	int load;
};

struct Stackframe {
	Stackframe *next;
	usize pc;
};

/*
 * firmware sets up the virtual memory of the kernel. What to do after that? I don't know.
 */
struct Sys {
	unsigned char machstk[MACHSTKSZ];

	Page root;

	union {
		Mach mach;
		unsigned char machpage[MACHSZ];
	};

	union {
		struct {
			u64 pmstart;    /* physical memory */
			u64 pmoccupied; /* how much is occupied */
			u64 pmend;	     /* total span */

			usize vmstart;    /* base address for malloc */
			usize vmunused;   /* 1st unused va */
			usize vmunmapped; /* 1st unmapped va */
			usize vmend;      /* 1st unusable va */
			u64 epoch;	      /* crude time synchronisation */

			int nc[NIXROLES]; /* number of online processors */
			int nmach;
			int load;
			u64 ticks; /* of the clock since boot time */
		};
		unsigned char syspage[4 * KiB];
	};

	union {
		Mach *machptr[MACHMAX];
		unsigned char ptrpage[4 * KiB];
	};

	u64 cyclefreq; /* Frequency of user readable cycle counter (mach 0) */

	u32 pgszlg2[NPGSZ];  /* per Mach or per Sys? */
	u32 pgszmask[NPGSZ]; /* Per sys -aki */
	u32 pgsz[NPGSZ];
	int npgsz;

	unsigned char _57344_[2][4 * KiB]; /* unused */
};

extern Sys *sys;
#define MACHP(x) (sys->machptr[(x)])
/*
 * KMap
 */
typedef void KMap;
extern KMap *kmap(Page *);

#define kunmap(k)
#define VA(k) PTR2UINT(k)

struct
{
	Lock l;
	int nonline;	       /* # of active CPUs */
	int nbooting;	       /* # of CPUs waiting for the bTC to go */
	int exiting;	       /* shutdown */
	int ispanic;	       /* shutdown in response to a panic */
	int thunderbirdsarego; /* lets the added processors continue */
} active;

/*
 * The Mach structures must be available via the per-processor
 * MMU information array machptr, mainly for disambiguation and access to
 * the clock which is only maintained by the bootstrap processor (0).
 */

extern usize kseg0;

extern char *rolename[];
extern void *kseg2;

/*
 * Horrid.
 */
// HARVEY: TODO: bring this back, it's actually nice. Or do something better.
// Talk to Ron before you condemn it.

#ifdef _DBGC_
#define DBGFLG (dbgflg[_DBGC_])
#else
#define DBGFLG (0)
#endif /* _DBGC_ */

#define DBG(...)                               \
	do {                                   \
		if(DBGFLG)                     \
			dbgprint(__VA_ARGS__); \
	} while(0)

extern char dbgflg[256];

#define dbgprint print /* for now */