/* $Id: OS2KVM.h,v 1.3 2001-09-27 03:04:12 bird Exp $ * * OS/2 kernel VM functions. * * Copyright (c) 2000 knut st. osmundsen (knut.stange.osmundsen@mynd.no) * * Project Odin Software License can be found in LICENSE.TXT * */ #ifndef _OS2KVM_h_ #define _OS2KVM_h_ /******************************************************************************* * Defined Constants And Macros * *******************************************************************************/ /* * From SG24-4640-00 * Object flags. (ob_fs) */ #define OB_PSEUDO 0x8000 /* Pseudo-object */ #define OB_API 0x4000 /* API allocated object */ #define OB_LOCKWAIT 0x2000 /* Some thread to wake in VMUnlock */ #define OB_LALIAS 0x1000 /* Object has aliases */ #define OB_SHARED 0x0800 /* Object's contents are shared */ #define OB_UVIRT 0x0400 /* UVirt object */ #define OB_ZEROINIT 0x0200 /* Object is zero-initialized */ #define OB_RESIDENT 0x0100 /* Initial allocation was resident */ #define OB_LOWMEM 0x0040 /* Object is in low memory */ #define OB_GUARD 0x0080 /* Page attribute/permission flags */ #define OB_EXEC 0x0020 /* Executable */ #define OB_READ 0x0010 /* Read permission */ #define OB_USER 0x0008 /* User Storage */ #define OB_WRITE 0x0004 /* Write permission */ #define OB_HUGE 0x0002 /* Object is huge */ #define OB_SHRINKABLE 0x0001 /* Object is Shrinkable */ #define OB_DHSETMEM 0x0001 /* DevHlp_VMSetMems are allowed */ /* * From SG24-4640-00 * ob_xflags */ #define VMOB_SLOCK_WAIT 0x01 /* Waiting on short term locks to clear */ #define VMOB_LLOCK_WAIT 0x02 /* Waiting on long term locks to clear */ #define VMOB_DISC_SEG 0x04 /* Object is part of a discardable seg */ #define VMOB_HIGHMEM 0x08 /* Object was allocated via dh_vmalloc */ /* v8086.h */ #define VM_PG_W 0x00000002 /* VPMPG_W - Page Writeable. */ #define VM_PG_U 0x00000004 /* VPMPG_U - Page User Mode Accessible.*/ #define VM_PG_X 0x00000008 /* VPMPG_X - Page Executable. */ #define VM_PG_R 0x00000010 /* VPMPG_R - Page Readable. */ #define VM_PG_RESERVED 0x00001000 /* VPMPG_RESERVED- Reservered */ /* vpmx2.h */ #define VM_PG_SWAPPABLE 0x00000000 /* Swappable */ /* * VMAlloc flFlag1 guessings */ #define VMA_CONTIG 0x00000001UL /* VMDHA_CONTIG */ #define VMA_WRITE VM_PG_W /* PAG_WRITE and OB_WRITE */ #define VMA_USER VM_PG_U /* OB_USER */ #define VMA_EXECUTE VM_PG_X /* PAG_EXECUTE and OB_READ !! */ #define VMA_READ VM_PG_R /* PAG_READ and OB_EXEC !! */ #define VMA_LOWMEM 0x00000020UL /* OB_LOWMEM < 1MB physical */ #define VMA_GUARD 0x00000040UL /* PAG_GUARD and VMDHA_16M and OB_GUARD */ #if 0 #define VMA_RESIDENT 0x00000080UL /* OB_RESIDENT */ #define VMA_ZEROINIT 0x00000100UL /* OB_ZEROINIT */ #define VMA_PHYS 0x00000200UL /* VMDHA_PHYS */ #define VMA_FIXED 0x00000400UL /* VMDHA_FIXED and OB_SHARED */ #else #define VMA_ZEROFILL 0x00000080UL #define VMA_SWAPONWRITE 0x00000100UL #define VMA_UVIRT 0x00000200UL /* VMDHA_PHYS */ #define VMA_RESIDENT 0x00000400UL /* VMDHA_FIXED and OB_SHARED */ #endif #define VMA_DISCARDABLE 0x00000800UL /* discarable object */ #define VMA_SHARE 0x00001000UL /* OBJSHARE and OBJEXEC (which implies shared) */ #define VMA_PROTECTED 0x00004000UL /* PAG_PROTECTED */ #define VMA_LOWMEM2 0x00010000UL /* OB_LOWMEM */ #define VMA_VDM 0x00040000UL /* (VPMVMAC_VDM) VDM allocation */ #define VMA_DECOMMIT 0x00080000UL /* PAG_DECOMMIT */ #define VMA_TILE 0x00400000UL /* OBJ_TILE */ #define VMA_SELALLOC 0x00400000UL /* Allocates selector */ #define VMA_SHRINKABLE 0x00800000UL /* OB_SHRINKABLE */ #define VMA_HUGH 0x01000000UL /* OB_HUGH */ #define VMA_ARENASHARED 0x04000000UL /* Shared Arena */ #define VMA_ARENASYSTEM 0x00000000UL /* System Arena */ #define VMA_ARENAPRIVATE 0x02000000UL /* (VPMVMAC_ARENAPRV) Private Arena */ #define VMA_ARENAHEAP 0x06000000UL /* Heap Arena */ #define VMA_ARENAHIGHA 0x00008000UL /* High shared arena (Warp >= fp13) - flag! Use together with VMA_ARENASHARED or VMA_ARENAPRIVATE */ #define VMA_ARENAHIGH (options.ulBuild >= AURORAGA ? VMA_ARENAHIGHA : 0UL) #define VMA_ARENAMASKW 0x06000000UL /* Warp < fp13 Arena Mask */ #define VMA_ARENAMASKA 0x06008000UL /* Aurora Arena Mask */ #define VMA_ARENAMASK (options.ulBuild >= AURORAGA ? VMA_ARENAMASKA : VMA_ARENAMASKW) #define VMA_ALIGNSEL 0x10000000UL /* Selector aligment */ #define VMA_ALIGNPAGE 0x18000000UL /* (VPMVMAC_ALIGNPAGE) Page alignment */ #define VMA_LOCMASK 0xC0000000UL /* Location mask */ #define VMA_LOCSPECIFIC 0x80000000UL /* (VPMVMAC_LOCSPECIFIC) Specific location */ #define VMA_LOCABOVE 0x40000000UL /* (VPMVMAC_LOCABOVE) Above or equal to specified location */ #define VMA_LOCANY 0x00000000UL /* Anywhere */ /* * VMAlloc flFlags2 guessings - These are flags to the Selector Manager. * Now prefixed SELAF - SELectorAllocFlags. */ #if 0 /*???*/ #define VDHAM_FIXED 0x0000UL #define VDHAM_SWAPPABLE 0x0001UL #define VPMVMFM_VDM 0x00000004UL/* Request on behalf of VDM */ #endif #define SELAF_SELMAP 0x0400 #define SELAF_WRITE 0x0002 /* Writable selector. (PAG_WRITE) */ #define SELAF_DPL0 0x0000 /* Descriptor privilege level - Ring 0 */ #define SELAF_DPL1 0x0020 /* Descriptor privilege level - Ring 1 */ #define SELAF_DPL2 0x0040 /* Descriptor privilege level - Ring 2 */ #define SELAF_DPL3 0x0060 /* Descriptor privilege level - Ring 3 */ /* * VMMapDebugAlias flags. */ #define VMMDA_ARENAPRIVATE 0 /* Create alias in private arena */ #define VMMDA_ARENASYSTEM 4 /* Create alias in system arena */ #define VMMDA_READONLY 1 /* Create readonly alias */ /* * vmRecalcShrBound flags. */ #define VMRSBF_ARENASHR 0 /* Queries for the Shared Arena. */ #define VMRSBF_ARENAHIGH 4 /* Queries for the High Shared Arena. */ #define VMRSBF_UPDATE 1 /* Seems to update the Sentinel Arena Record. */ /* * Arena Header flags as defined in SG24-4640-00. */ #define VMAH_BITMAP_BYPASS 0x00000001 /* Worth bypassing bitmap */ #define VMAH_NO_HASH_WRAP 0x00000002 /* No hash table wraparound yet */ #define VMAH_GROW_DOWN 0x00000004 /* Arena grows down */ /******************************************************************************* * Structures and Typedefs * *******************************************************************************/ /* * Handle to Memory Object. */ typedef USHORT VMHOB; typedef VMHOB * PVMHOB; /* * Handle to Arena Record. */ typedef VMHOB VMHAR; typedef VMHOB * PVMHAR; /* * VMAllocMem struct - found in SDFs. */ typedef struct _vmac { ULONG ac_va; /* off=0 cb=4 Virtual Address. */ USHORT ac_sel; /* off=4 cb=2 Selector. */ USHORT ac_hob; /* off=6 cb=2 Object handle. */ } VMAC, *PVMAC; /* * Dummy structs we need pointers for. */ typedef PVOID PVMAR; typedef PVOID PVMBM; typedef PVOID PVMAT; /* * Arena Header structure as defined in SG24-4640-00 and all SDF files. */ typedef struct vmah_s { struct vmah_s * ah_pahNext; /* Link to next arena. */ struct vmah_s * ah_pahPrev; /* Link to previous arena. */ PVMAR ah_parSen; /* Pointer to the arena sentinel. */ PVMAR ah_parFree; /* Hint of 1st free block in arena. */ PVMBM ah_papbm; /* Pointer to bitmap directory. */ PVMHAR ah_paharHash;/*Hash table pointer. */ PVMAT ah_pat; /* Pointer to per-type info. */ ULONG ah_fl; /* Flags. */ ULONG ah_laddrMin;/* Minimum address currently mapped. */ ULONG ah_laddrMax;/* Maximum address currently mapped. */ ULONG ah_car; /* Count of arena entries. */ ULONG ah_carBitmap;/*Max entry count to need bitmap. */ ULONG ah_lbmNumbMax; /* Max bitmap number */ ULONG ah_lbmeNumbMax; /* Max bitmap entry number */ ULONG ah_lHashNumbMax;/* Max hash table index. */ VMHOB ah_hob; /* Arena header pseudo-handle. */ USHORT ah_filler; /* Filler to 4-byte align struct. */ } VMAH, *PVMAH; /******************************************************************************* * Global Variables * *******************************************************************************/ /* * Mapping from _stdcall variable names nonmangled names. */ #ifndef KKRNLLIB #if defined(__IBMC__) || defined(__IBMCPP__) #pragma map(VirtualAddressLimit, "_VirtualAddressLimit") #pragma map(ahvmSys, "_ahvmSys") #pragma map(ahvmShr, "_ahvmShr") #pragma map(ahvmhShr, "_ahvmhShr") #else #pragma VirtualAddressLimit _VirtualAddressLimit #pragma ahvmSys _ahvmSys #pragma ahvmShr _ahvmShr #pragma ahvmhShr _ahvmhShr #endif #endif /** * Virtual Address Limit - this pointer might be NULL! */ #ifdef KKRNLLIB extern ULONG *pVirtualAddressLimit; #define VirtualAddressLimit (pVirtualAddressLimit ? *pVirtualAddressLimit : 0x20000000UL) #else extern ULONG VirtualAddressLimit; #define VirtualAddressLimit (&VirtualAddressLimit ? VirtualAddressLimit : 0x20000000UL) #endif /** * System arena header. */ #ifdef KKRNLLIB extern PVMAH pahvmSys; #define ahvmSys (*pahvmSys) #else extern VMAH ahvmSys; #endif /** * Shared arena header. */ #ifdef KKRNLLIB extern PVMAH pahvmShr; #define ahvmShr (*pahvmShr) #else extern VMAH ahvmShr; #endif /** * High Shread arena header - only aurora and Warp Server Advanced SMP. * Check if &ahvmhShr is NULL! */ #ifdef KKRNLLIB extern PVMAH pahvmhShr; #define ahvmhShr (*pahvmhShr) #else extern VMAH ahvmhShr; #endif /******************************************************************************* * Exported Functions * *******************************************************************************/ HMTE KRNLCALL VMGetOwner( ULONG ulCS, ULONG ulEIP); HMTE KRNLCALL OrgVMGetOwner( ULONG ulCS, ULONG ulEIP); APIRET KRNLCALL VMAllocMem( ULONG cbSize, ULONG cbCommit, ULONG flFlags1, HPTDA hPTDA, USHORT usVMOwnerId, HMTE hMTE, ULONG flFlags2, ULONG SomeArg2, PVMAC pvmac); APIRET KRNLCALL OrgVMAllocMem( ULONG cbSize, ULONG cbCommit, ULONG flFlags1, HPTDA hPTDA, USHORT usVMOwnerId, HMTE hMTE, ULONG flFlags2, ULONG SomeArg2, PVMAC pvmac); APIRET KRNLCALL VMFreeMem( ULONG ulAddress, HPTDA hPTDA, ULONG flFlags); APIRET KRNLCALL OrgVMFreeMem( ULONG ulAddress, HPTDA hPTDA, ULONG flFlags); APIRET KRNLCALL VMMapDebugAlias( ULONG flVMFlags, ULONG ulAddress, ULONG cbSize, HPTDA hPTDA, PVMAC pvmac); APIRET KRNLCALL OrgVMMapDebugAlias( ULONG flVMFlags, ULONG ulAddress, ULONG cbSize, HPTDA hPTDA, PVMAC pvmac); APIRET KRNLCALL VMObjHandleInfo( USHORT usHob, PULONG pulAddr, PUSHORT pushPTDA); APIRET KRNLCALL OrgVMObjHandleInfo( USHORT usHob, PULONG pulAddr, PUSHORT pushPTDA); #ifdef _OS2KLDR_H_ PMTE KRNLCALL VMPseudoHandleMap( HMTE hMTE); PMTE KRNLCALL OrgVMPseudoHandleMap( HMTE hMTE); #endif /** * This function seems to find the top of the private arena. * And for high arena kernels (AURORA and W3SMP?) it is modified * to calc the top of the high private arena, given flFlag = 4. * -- * This function is really intented for resizing / recaling the size of * the shared arena(s). But, it's useful for finding the highest used * private arena(s). * @param flFlags VMRSBF_* flags. * @param pulSentinelAddress Pointer to return variable (optional). */ VOID KRNLCALL vmRecalcShrBound( ULONG flFlags, PULONG pulSentinelAddress); VOID KRNLCALL OrgvmRecalcShrBound( ULONG flFlags, PULONG pulSentinelAddress); /** * Creates a pseudo handle for a given memory address. * @returns OS/2 return code. NO_ERROR on success. * @param pvData Pointer to the data which the handle should represent. * @param hobOwner Owner of the pseudo handle. * @param phob Pointer to object handle variable. Upon successful return * this will hold the handle value of the crated pseudo handle. * @remark Used for many types of handles within the kernel. * Among them are the loader HMTEs. The loader uses usOwner = 0xffa6 (ldrmte). */ APIRET KRNLCALL VMCreatePseudoHandle( PVOID pvData, VMHOB usOwner, PVMHOB phob); APIRET KRNLCALL OrgVMCreatePseudoHandle( PVOID pvData, VMHOB usOwner, PVMHOB phob); /** * This call frees a pseudo handle pointer previously allocated by * VMCreatePseudoHandle. * @returns OS/2 return code. * @param hob Handle to be freed. */ APIRET KRNLCALL VMFreePseudoHandle( VMHOB hob); APIRET KRNLCALL OrgVMFreePseudoHandle( VMHOB hob); #endif