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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
/*********************************************************
* Copyright (C) 2006-2015 VMware, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of the Common
* Development and Distribution License (the "License") version 1.0
* and no later version. You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* http://www.opensource.org/licenses/cddl1.php
*
* See the License for the specific language governing permissions
* and limitations under the License.
*
*********************************************************/
/*
* kernelStubs.h
*
* KernelStubs implements some userspace library functions in terms
* of kernel functions to allow library userspace code to be used in a
* kernel.
*/
#ifndef __KERNELSTUBS_H__
#define __KERNELSTUBS_H__
#define KRNL_STUBS_DRIVER_TYPE_POSIX 1
#define KRNL_STUBS_DRIVER_TYPE_GDI 2
#define KRNL_STUBS_DRIVER_TYPE_WDM 3
#define KRNL_STUBS_DRIVER_TYPE_NDIS 4
// For now (vsphere-2015), choose a good default. Later we'll modify all the
// build files using KernelStubs to set this.
#ifndef KRNL_STUBS_DRIVER_TYPE
# if defined(_WIN32)
# define KRNL_STUBS_DRIVER_TYPE KRNL_STUBS_DRIVER_TYPE_WDM
# else
# define KRNL_STUBS_DRIVER_TYPE KRNL_STUBS_DRIVER_TYPE_POSIX
# endif
#endif
#ifdef linux
# ifndef __KERNEL__
# error "__KERNEL__ is not defined"
# endif
# include "driver-config.h" // Must be included before any other header files
# include "vm_basic_types.h"
# include <linux/kernel.h>
# include <linux/string.h>
#elif defined(_WIN32)
# define _CRT_ALLOCATION_DEFINED // prevent malloc.h from defining malloc et. all
# if KRNL_STUBS_DRIVER_TYPE == KRNL_STUBS_DRIVER_TYPE_GDI
# include <d3d9.h>
# include <winddi.h>
# include <stdio.h>
# include "vm_basic_types.h"
# include "vm_basic_defs.h"
# include "vm_assert.h"
# elif KRNL_STUBS_DRIVER_TYPE == KRNL_STUBS_DRIVER_TYPE_NDIS
# include "vm_basic_types.h"
# include <ndis.h>
# elif KRNL_STUBS_DRIVER_TYPE == KRNL_STUBS_DRIVER_TYPE_WDM
# include "vm_basic_types.h"
# if defined(NTDDI_WINXP) && (NTDDI_VERSION >= NTDDI_WINXP)
# include <wdm.h> /* kernel memory APIs, DbgPrintEx */
# else
# include <ntddk.h> /* kernel memory APIs */
# endif
# include <stdio.h> /* for _vsnprintf, vsprintf */
# include <stdarg.h> /* for va_start stuff */
# include <stdlib.h> /* for min macro. */
# include "vm_basic_defs.h"
# include "vm_assert.h" /* Our assert macros */
# else
# error Type KRNL_STUBS_DRIVER_TYPE must be defined.
# endif
#elif defined(__FreeBSD__)
# include "vm_basic_types.h"
# ifndef _KERNEL
# error "_KERNEL is not defined"
# endif
# include <sys/types.h>
# include <sys/malloc.h>
# include <sys/param.h>
# include <sys/kernel.h>
# include <machine/stdarg.h>
# include <sys/libkern.h>
#elif defined(__APPLE__)
# include "vm_basic_types.h"
# ifndef KERNEL
# error "KERNEL is not defined"
# endif
# include <stdarg.h>
# include <string.h>
# elif defined(sun)
# include "vm_basic_types.h"
# include <sys/types.h>
# include <sys/varargs.h>
#endif
#include "kernelStubsSal.h"
/*
* Function Prototypes
*/
#if defined(linux) || defined(__APPLE__) || defined (sun)
# ifdef linux /* if (linux) { */
char *strdup(const char *source);
# endif
/* Shared between Linux and Apple kernel stubs. */
void *malloc(size_t size);
void free(void *mem);
void *calloc(size_t num, size_t len);
void *realloc(void *ptr, size_t newSize);
#elif defined(_WIN32) /* } else if (_WIN32) { */
_Ret_allocates_malloc_mem_opt_bytecap_(_Size)
_When_windrv_(_IRQL_requires_max_(DISPATCH_LEVEL))
_CRTNOALIAS _CRTRESTRICT
void * __cdecl malloc(
_In_ size_t _Size);
_Ret_allocates_malloc_mem_opt_bytecount_(_Count*_Size)
_When_windrv_(_IRQL_requires_max_(DISPATCH_LEVEL))
_CRTNOALIAS _CRTRESTRICT
void * __cdecl calloc(
_In_ size_t _Count,
_In_ size_t _Size);
_When_windrv_(_IRQL_requires_max_(DISPATCH_LEVEL))
_CRTNOALIAS
void __cdecl free(
_In_frees_malloc_mem_opt_ void * _Memory);
_Success_(return != 0)
_When_(_Memory != 0, _Ret_reallocates_malloc_mem_opt_newbytecap_oldbytecap_(_NewSize, ((uintptr_t*)_Memory)[-1]))
_When_(_Memory == 0, _Ret_reallocates_malloc_mem_opt_newbytecap_(_NewSize))
_When_windrv_(_IRQL_requires_max_(DISPATCH_LEVEL))
_CRTNOALIAS _CRTRESTRICT
void * __cdecl realloc(
_In_reallocates_malloc_mem_opt_oldptr_ void * _Memory,
_In_ size_t _NewSize);
_Success_(return != 0)
_Ret_allocates_malloc_mem_opt_z_
_When_windrv_(_IRQL_requires_max_(DISPATCH_LEVEL))
_CRTIMP
char * __cdecl _strdup_impl(
_In_opt_z_ const char * _Src);
#define strdup _strdup_impl
#elif defined(__FreeBSD__) /* } else if (FreeBSD) { */
/* Kernel memory on FreeBSD is tagged for statistics and sanity checking. */
MALLOC_DECLARE(M_VMWARE_TEMP);
/*
* On FreeBSD, the general memory allocator for both userland and the kernel is named
* malloc, but the kernel malloc() takes more arguments. The following alias & macros
* work around this, to provide the standard malloc() API for userspace code that is
* being used in the kernel.
*/
# undef malloc
static INLINE void *
__compat_malloc(unsigned long size, struct malloc_type *type, int flags) {
return malloc(size, type, flags);
}
# define malloc(size) __compat_malloc(size, M_VMWARE_TEMP, M_NOWAIT)
# define calloc(count, size) __compat_malloc((count) * (size), \
M_VMWARE_TEMP, M_NOWAIT|M_ZERO)
# define realloc(buf, size) realloc(buf, size, M_VMWARE_TEMP, M_NOWAIT)
# define free(buf) free(buf, M_VMWARE_TEMP)
# define strchr(s,c) index(s,c)
# define strrchr(s,c) rindex(s,c)
#endif /* } */
_Ret_writes_z_(maxSize)
char *Str_Strcpy(
_Out_z_cap_(maxSize) char *buf,
_In_z_ const char *src,
_In_ size_t maxSize);
_Ret_writes_z_(maxSize)
char *Str_Strcat(
_Inout_z_cap_(maxSize) char *buf,
_In_z_ const char *src,
_In_ size_t maxSize);
_Success_(return >= 0)
int Str_Sprintf(
_Out_z_cap_(maxSize) _Post_z_count_(return+1) char *buf,
_In_ size_t maxSize,
_In_z_ _Printf_format_string_ const char *fmt,
...) PRINTF_DECL(3, 4);
_Success_(return != -1)
int Str_Vsnprintf(
_Out_z_cap_(size) _Post_z_count_(return+1) char *str,
_In_ size_t size,
_In_z_ _Printf_format_string_ const char *format,
_In_ va_list ap) PRINTF_DECL(3, 0);
_Success_(return != 0)
_When_(length != 0, _Ret_allocates_malloc_mem_opt_z_bytecount_(*length))
_When_(length == 0, _Ret_allocates_malloc_mem_opt_z_)
_When_windrv_(_IRQL_requires_max_(DISPATCH_LEVEL))
char *Str_Vasprintf(
_Out_opt_ size_t *length,
_In_z_ _Printf_format_string_ const char *format,
_In_ va_list arguments) PRINTF_DECL(2, 0);
_Success_(return != 0)
_When_(length != 0, _Ret_allocates_malloc_mem_opt_z_bytecount_(*length))
_When_(length == 0, _Ret_allocates_malloc_mem_opt_z_)
_When_windrv_(_IRQL_requires_max_(DISPATCH_LEVEL))
char *Str_Asprintf(
_Out_opt_ size_t *length,
_In_z_ _Printf_format_string_ const char *format,
...) PRINTF_DECL(2, 3);
#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable: 28301) // Suppress complaint that first declaration lacked annotations
#endif
// For now (vsphere-2015), we don't implement Panic, Warning, or Debug in the
// GDI case.
#if KRNL_STUBS_DRIVER_TYPE != KRNL_STUBS_DRIVER_TYPE_GDI
/*
* Stub functions we provide.
*/
#ifdef _WIN32
NORETURN
#endif
void Panic(
_In_z_ _Printf_format_string_ const char *fmt,
...) PRINTF_DECL(1, 2);
void Warning(
_In_z_ _Printf_format_string_ const char *fmt,
...) PRINTF_DECL(1, 2);
/*
* Functions the driver must implement for the stubs.
*/
EXTERN void Debug(
_In_z_ _Printf_format_string_ const char *fmt,
...) PRINTF_DECL(1, 2);
#endif // KRNL_STUBS_DRIVER_TYPE != KRNL_STUBS_DRIVER_TYPE_GDI
#ifdef _WIN32
#pragma warning(pop)
#endif
#endif /* __KERNELSTUBS_H__ */
|
