Pyrogenesis  trunk
apic.h
Go to the documentation of this file.
1 /* Copyright (c) 2011 Wildfire Games
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining
4  * a copy of this software and associated documentation files (the
5  * "Software"), to deal in the Software without restriction, including
6  * without limitation the rights to use, copy, modify, merge, publish,
7  * distribute, sublicense, and/or sell copies of the Software, and to
8  * permit persons to whom the Software is furnished to do so, subject to
9  * the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef INCLUDED_X86_X64_APIC
24 #define INCLUDED_X86_X64_APIC
25 
26 typedef u8 ApicId; // not necessarily contiguous values
27 
28 /**
29  * @return APIC ID of the currently executing processor or zero if the
30  * platform does not have an xAPIC (i.e. 7th generation x86 or below).
31  *
32  * rationale: the alternative of accessing the APIC mmio registers is not
33  * feasible - mahaf_MapPhysicalMemory only works reliably on WinXP. we also
34  * don't want to interfere with the OS's constant use of the APIC registers.
35  **/
36 LIB_API ApicId GetApicId();
37 
38 // if this returns false, apicId = contiguousId = processor.
39 // otherwise, there are unspecified but bijective mappings between
40 // apicId<->contiguousId and apicId<->processor.
41 LIB_API bool AreApicIdsReliable();
42 
43 LIB_API size_t ProcessorFromApicId(ApicId apicId);
44 LIB_API size_t ContiguousIdFromApicId(ApicId apicId);
45 
46 LIB_API ApicId ApicIdFromProcessor(size_t contiguousId);
47 LIB_API ApicId ApicIdFromContiguousId(size_t contiguousId);
48 
49 #endif // #ifndef INCLUDED_X86_X64_APIC
LIB_API ApicId ApicIdFromProcessor(size_t contiguousId)
Definition: apic.cpp:147
uint8_t u8
Definition: types.h:37
LIB_API size_t ProcessorFromApicId(ApicId apicId)
Definition: apic.cpp:129
u8 ApicId
Definition: apic.h:26
LIB_API bool AreApicIdsReliable()
Definition: apic.cpp:105
LIB_API ApicId GetApicId()
Definition: apic.cpp:33
LIB_API size_t ContiguousIdFromApicId(ApicId apicId)
Definition: apic.cpp:134
LIB_API ApicId ApicIdFromContiguousId(size_t contiguousId)
Definition: apic.cpp:152