Move TopologyEntry into its own header file

It is needed in the kernel and this consolidates versions of the
structure.  This change also wraps types in types.h that cannot be
used in the kernel in an #ifdef that removes them from compilation
during the kext build.

Author: nealsid

src/MacMSRDriver/MSRAccessor.cpp

@@ -18,7 +18,7 @@ MSRAccessor::MSRAccessor()
 
 int32_t MSRAccessor::buildTopology(uint32_t num_cores, void* pTopos)
 {
-    size_t topology_struct_size = sizeof(topologyEntry)*num_cores;
+    size_t topology_struct_size = sizeof(TopologyEntry)*num_cores;
 
     kern_return_t ret = IOConnectCallStructMethod(connect, kBuildTopology,
                                                   NULL, 0,

src/MacMSRDriver/PcmMsr/PcmMsr.cpp

@@ -57,7 +57,7 @@ void cpuWriteMSR(void* pIDatas){
 }
 
 void cpuGetTopoData(void* pTopos){
-    topologyEntry* entries = (topologyEntry*)pTopos;
+    TopologyEntry* entries = (TopologyEntry*)pTopos;
     int cpu = cpu_number();
     int info[4];
     entries[cpu].os_id = cpu;
@@ -166,18 +166,18 @@ IOReturn PcmMsrDriverClassName::writeMSR(pcm_msr_data_t* idata){
     return ret;
 }
 
-IOReturn PcmMsrDriverClassName::buildTopology(topologyEntry* odata, uint32_t input_num_cores)
+IOReturn PcmMsrDriverClassName::buildTopology(TopologyEntry* odata, uint32_t input_num_cores)
 {
      size_t topologyBufferSize;
 
      // TODO figure out when input_num_cores is used rather than num_cores
-     if (os_mul_overflow(sizeof(topologyEntry), (size_t) num_cores, &topologyBufferSize))
+     if (os_mul_overflow(sizeof(TopologyEntry), (size_t) num_cores, &topologyBufferSize))
      {
           return kIOReturnBadArgument;
      }
 
-    topologyEntry *topologies =
-         (topologyEntry *)IOMallocAligned(topologyBufferSize, 32);
+    TopologyEntry *topologies =
+         (TopologyEntry *)IOMallocAligned(topologyBufferSize, 32);
 
     if (topologies == nullptr)
     {

src/MacMSRDriver/PcmMsr/PcmMsr.h

@@ -14,7 +14,7 @@ class PcmMsrDriverClassName : public IOService
 
     virtual IOReturn writeMSR(pcm_msr_data_t* data);
     virtual IOReturn readMSR(pcm_msr_data_t* idata,pcm_msr_data_t* odata);
-    virtual IOReturn buildTopology(topologyEntry* odata, uint32_t input_num_cores);
+    virtual IOReturn buildTopology(TopologyEntry* odata, uint32_t input_num_cores);
     virtual bool init(OSDictionary *dict) override;
     virtual void free(void) override;
     virtual bool handleOpen(IOService* forClient, IOOptionBits opts, void* args) override;

src/MacMSRDriver/PcmMsr/PcmMsrClient.cpp

@@ -154,12 +154,12 @@ IOReturn PcmMsrClientClassName::writeMSR(pcm_msr_data_t* data)
 }
 
 IOReturn PcmMsrClientClassName::sBuildTopology(PcmMsrClientClassName* target, void* reference, IOExternalMethodArguments* args){
-    return target -> buildTopology((topologyEntry*)args->structureOutput, args->structureOutputSize);
+    return target -> buildTopology((TopologyEntry*)args->structureOutput, args->structureOutputSize);
 }
 
-IOReturn PcmMsrClientClassName::buildTopology(topologyEntry* data, size_t output_size)
+IOReturn PcmMsrClientClassName::buildTopology(TopologyEntry* data, size_t output_size)
 {
-    uint32_t num_cores = (uint32_t) (output_size / sizeof(topologyEntry) );
+    uint32_t num_cores = (uint32_t) (output_size / sizeof(TopologyEntry) );
     IOReturn	result = checkActiveAndOpened (__FUNCTION__);
 
     if (result == kIOReturnSuccess)

src/MacMSRDriver/PcmMsr/PcmMsrClient.h

@@ -44,7 +44,7 @@ class PcmMsrClientClassName : public IOUserClient
     virtual IOReturn writeMSR(pcm_msr_data_t* data);
 
     static IOReturn sBuildTopology(PcmMsrClientClassName* target, void* reference, IOExternalMethodArguments* args);
-    virtual IOReturn buildTopology(topologyEntry* data, size_t output_size);
+    virtual IOReturn buildTopology(TopologyEntry* data, size_t output_size);
 
     static IOReturn sGetNumInstances(PcmMsrClientClassName* target, void* reference, IOExternalMethodArguments* args);
     virtual IOReturn getNumInstances(uint32_t* num_insts);

src/MacMSRDriver/PcmMsr/UserKernelShared.h

@@ -1,12 +1,20 @@
 // SPDX-License-Identifier: BSD-3-Clause
 // Copyright (c) 2012, Intel Corporation
 // written by Austen Ott
-//    
+//
 #define PcmMsrDriverClassName com_intel_driver_PcmMsr
 #define kPcmMsrDriverClassName "com_intel_driver_PcmMsr"
+
 #ifndef USER_KERNEL_SHARED
 #define USER_KERNEL_SHARED
+
+#define PCM_API
+
 #include <stdint.h>
+#include "../../topologyentry.h"
+
+using namespace pcm;
+
 typedef struct {
     uint64_t value;
     uint32_t cpu_num;
@@ -20,19 +28,6 @@ typedef struct {
     char padding[115];
 } k_pcm_msr_data_t;
 
-// The topologyEntry struct that is used by PCM
-typedef struct
-{
-    int32_t os_id;
-    int32_t thread_id;
-    int32_t core_id;
-    int32_t tile_id;
-    int32_t socket;
-    int32_t native_cpu_model;
-    int32_t core_type; // This is an enum in the userland structure.
-    int32_t padding;
-} topologyEntry;
-
 enum {
     kOpenDriver,
     kCloseDriver,

src/cpucounters.h

@@ -23,6 +23,7 @@
 #undef PCM_UNCORE_PMON_BOX_CHECK_STATUS // debug only
 
 #include "types.h"
+#include "topologyentry.h"
 #include "msr.h"
 #include "pci.h"
 #include "bw.h"
@@ -86,38 +87,6 @@ class SystemRoot;
         A set of performance monitoring routines for recent Intel CPUs
 */
 
-struct PCM_API TopologyEntry // describes a core
-{
-    int32 os_id;
-    int32 thread_id;
-    int32 core_id;
-    int32 tile_id; // tile is a constalation of 1 or more cores sharing salem L2 cache. Unique for entire system
-    int32 socket;
-    int32 native_cpu_model = -1;
-    enum CoreType
-    {
-        Atom = 0x20,
-        Core = 0x40,
-        Invalid = -1
-    };
-    CoreType core_type = Invalid;
-
-    TopologyEntry() : os_id(-1), thread_id (-1), core_id(-1), tile_id(-1), socket(-1) { }
-    const char* getCoreTypeStr()
-    {
-        switch (core_type)
-        {
-            case Atom:
-                return "Atom";
-            case Core:
-                return "Core";
-            case Invalid:
-                return "invalid";
-        }
-        return "unknown";
-    }
-};
-
 class HWRegister
 {
 public:

src/topologyentry.h

@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2022-, Intel Corporation
+
+#pragma once
+
+#include "types.h"
+
+namespace pcm
+{
+
+struct PCM_API TopologyEntry // describes a core
+{
+    int32 os_id;
+    int32 thread_id;
+    int32 core_id;
+    int32 tile_id; // tile is a constalation of 1 or more cores sharing salem L2 cache. Unique for entire system
+    int32 socket;
+    int32 native_cpu_model = -1;
+    enum CoreType
+    {
+        Atom = 0x20,
+        Core = 0x40,
+        Invalid = -1
+    };
+    CoreType core_type = Invalid;
+
+    TopologyEntry() : os_id(-1), thread_id (-1), core_id(-1), tile_id(-1), socket(-1) { }
+    const char* getCoreTypeStr()
+    {
+        switch (core_type)
+        {
+            case Atom:
+                return "Atom";
+            case Core:
+                return "Core";
+            case Invalid:
+                return "invalid";
+        }
+        return "unknown";
+    }
+};
+
+}
+

src/types.h

@@ -13,6 +13,8 @@
 
 #undef PCM_DEBUG
 
+#ifndef KERNEL
+
 #include <iostream>
 #include <istream>
 #include <sstream>
@@ -23,6 +25,8 @@
 #include <windows.h>
 #endif
 
+#endif // #ifndef KERNEL
+
 namespace pcm {
 
 typedef unsigned long long uint64;
@@ -383,6 +387,8 @@ struct FixedEventControlRegister
     FixedEventControlRegister() : value(0) {}
 };
 
+#ifndef KERNEL
+
 inline std::ostream & operator << (std::ostream & o, const FixedEventControlRegister & reg)
 {
     o << "os0\t\t" << reg.fields.os0 << "\n";
@@ -404,6 +410,8 @@ inline std::ostream & operator << (std::ostream & o, const FixedEventControlRegi
     return o;
 }
 
+#endif // #ifndef KERNEL
+
 // UNCORE COUNTER CONTROL
 
 /* \brief Uncore Event Select Register Register format
@@ -1256,6 +1264,8 @@ union cvt_ds
     } ui32;
 };
 
+#ifndef KERNEL
+
 struct MCFGRecord
 {
     unsigned long long baseAddress;
@@ -1298,6 +1308,8 @@ struct MCFGHeader
     }
 };
 
+#endif // #ifndef KERNEL
+
 } // namespace pcm
 
 #endif