summaryrefslogtreecommitdiff
path: root/open-vm-tools/lib/misc/hostType.c
blob: 557075ded237db579c6d902430442acc84aee198 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
/*********************************************************
 * Copyright (C) 2006-2015 VMware, Inc. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation version 2.1 and no later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the Lesser GNU General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA.
 *
 *********************************************************/

/*
 * hostType.c --
 *
 *    Platform-independent code that calls into hostType<OS>-specific
 *    code to determine the host OS type.
 */

#include <stdlib.h>
#include <string.h>

#include "vmware.h"
#include "hostType.h"
#include "str.h"

/*
 * XXX see bug 651592 for how to make this not warn on newer linux hosts
 * that have deprecated sysctl.
 */
#if defined(VMX86_SERVER) || ((defined(VMX86_VPX) || defined(VMX86_VMACORE)) && defined(linux))
#include <errno.h>
#include <sys/types.h>
#include <sys/sysctl.h>
#include <unistd.h>
#include "uwvmkAPI.h"
#define DO_REAL_HOST_CHECK
#endif

#define LGPFX "HOSTTYPE:"

/*
 *----------------------------------------------------------------------
 *
 * HostTypeOSVMKernelType --
 *
 *      Are we running on a flavor of VMKernel?  Only if the KERN_OSTYPE
 *      sysctl returns one of USERWORLD_SYSCTL_KERN_OSTYPE,
 *      USERWORLD_SYSCTL_VISOR_OSTYPE or USERWORLD_SYSCTL_VISOR64_OSTYPE
 *
 * Results:
 *      4 if running in a VMvisor UserWorld on the 64-bit vmkernel in ESX.
 *      3 if running directly in a UserWorld on the 64-bit vmkernel** in ESX.
 *      2 if running in a VMvisor UserWorld on the vmkernel in ESX.
 *      1 if running directly in a UserWorld on the vmkernel in ESX.
 *      0 if running on the COS or in a non-server product.
 *
 *      **Note that 64-bit vmkernel in ESX does not currently exist.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

static int
HostTypeOSVMKernelType(void)
{
#ifdef DO_REAL_HOST_CHECK
   static int vmkernelType = -1;

   if (vmkernelType == -1) {
      char osname[128];
      size_t osnameLength;
      int kernOsTypeCtl[] = { CTL_KERN, KERN_OSTYPE };
      int rc;
      
      osnameLength = sizeof(osname);
      rc = sysctl(kernOsTypeCtl, ARRAYSIZE(kernOsTypeCtl),
                  osname, &osnameLength,
                  0, 0);
      if (rc == 0) {
         osnameLength = MAX(sizeof (osname), osnameLength);

         /*
          * XXX Yes, this is backwards in order of probability now, but we
          *     call it only once and anyway someday it won't be backwards ...
          */

         if (! strncmp(osname, USERWORLD_SYSCTL_VISOR64_OSTYPE,
                       osnameLength)) {
            vmkernelType = 4;
         } else if (! strncmp(osname, USERWORLD_SYSCTL_KERN64_OSTYPE,
                              osnameLength)) {
            vmkernelType = 3;
         } else if (! strncmp(osname, USERWORLD_SYSCTL_VISOR_OSTYPE,
                              osnameLength)) {
            vmkernelType = 2;
         } else if (! strncmp(osname, USERWORLD_SYSCTL_KERN_OSTYPE,
                              osnameLength)) {
            vmkernelType = 1;
         } else {
            vmkernelType = 0;
         }
      } else {
         /*
          * XXX too many of the callers don't define Warning.  See bug 125455
          */

         vmkernelType = 0;
      }
   }

   return (vmkernelType);
#else
   /* Non-linux builds are never running in a userworld */
   return 0;
#endif
}


/*
 *----------------------------------------------------------------------
 *
 * HostType_OSIsVMK --
 *
 *      Are we running on the VMKernel (_any_ varient)?  True if KERN_OSTYPE
 *      sysctl returns _any_ of 
 *
 *          "UserWorld/VMKernel"
 *          "VMKernel"
 *          "UserWorld/VMKernel64"
 *          "VMKernel64"
 *
 * Results:
 *      TRUE if running in a UserWorld on the vmkernel in ESX.
 *      FALSE if running on the COS or in a non-server product.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

Bool
HostType_OSIsVMK(void)
{
   return (HostTypeOSVMKernelType() > 0);
}


/*
 *----------------------------------------------------------------------
 *
 * HostType_OSIsPureVMK --
 *
 *      Are we running on the VMvisor VMKernel (_any_ bitness)?  True if
 *      KERN_OSTYPE sysctl returns "VMKernel" or "VMKernel64".
 *
 * Results:
 *      TRUE if running in a VMvisor UserWorld on the vmkernel in ESX.
 *      FALSE if running on any other type of ESX or in a non-server product.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

Bool
HostType_OSIsPureVMK(void)
{
   return (HostTypeOSVMKernelType() == 2 || HostTypeOSVMKernelType() == 4);
}


/*
 *----------------------------------------------------------------------
 *
 * HostType_OSIsVMK64 --
 *
 *      Are we running on a 64-bit VMKernel?  Only if the KERN_OSTYPE
 *      sysctl returns "UserWorld/VMKernel64" or "VMKernel64".
 *
 * Results:
 *      TRUE if running in a UserWorld on a 64-bit vmkernel in ESX or VMvisor.
 *      FALSE if running on a 32-bit VMkernel in ESX or in a non-server product.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

Bool
HostType_OSIsVMK64(void)
{
   return (HostTypeOSVMKernelType() == 3 || HostTypeOSVMKernelType() == 4);
}

/*
 *----------------------------------------------------------------------
 *
 * HostType_OSIsSimulator --
 *
 *      Are we running on an ESX host simulator? Check presence of the
 *      mockup file.
 *
 * Results:
 *      TRUE if mockup file exists
 *      FALSE if the file doesn't exist
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

Bool
HostType_OSIsSimulator(void)
{
#ifdef DO_REAL_HOST_CHECK
   static int simulatorType = -1;
   if (simulatorType == -1) {
      if (access("/etc/vmware/hostd/mockupEsxHost.txt", 0) != -1) {
         simulatorType = 1;
      } else {
         simulatorType = 0;
      }
   }
   return (simulatorType == 1);
#else
   /* We are only interested in the case where VMX86_SERVER or friends are defined */
   return FALSE;
#endif
}