Windows Kernel Header Files

It can’t have gone completely unnoticed, though it does look to have gone largely unremarked, but public symbol files for the Windows kernel nowadays contain information from which reverse engineers can learn:

This disclosure starts with Windows 8 and continues at least to the 2004 edition of Windows 10. It’s not specific to the Windows kernel or even to Windows, but seems instead to come from new capability of the compiler and related tools in Visual Studio 2012. In symbol files that are built with this and later compilers, the type information that has long described classes, structures, unions and enumerations, even down to the detail of listing the names, types and offsets of members, comes with a separate set of records of where these user-defined types came from. These records have the leaf index 0x1606, which Microsoft defines symbolically as LF_UDT_SRC_LINE. These records are created during compilation. Private symbol files—which Microsoft occasionally distributes in packages of public symbol files, though apparently never for the kernel—may instead have slightly more informative records with leaf index LF_UDT_MOD_SRC_LINE (0x1607) which are created when linking.

In public symbol files that retain type information, as the kernel’s must to support debugging, the LF_UDT_SRC_LINE records are retained too. The types need not come from headers, but in practice they do and so the records might well enough be thought of as header information for types. They aren’t present for every type that the kernel uses, only for those for which the public symbol files have type information. Even so, the public symbol files for the kernel—and for other modules, but the kernel is the interest here—tell much more than they used to.

Public and Private Symbols

With enough investigative work, this relatively new embellishment of the public symbol files even reveals how it is that they have any type information at all. Remember that the whole point to a public symbol file is that it “omits symbols that you would not want to ship to your customers.” This is from Microsoft’s documentation of the linker’s /pdbstripped switch, which specifically lists type information among the things that the “stripped PDB file will not contain”. Yet the kernel’s public symbol files do have type information—and have done since as long ago as Windows XP (chronologically, but Windows 2000 SP3 by version number).

It turns out that however much it may be convenient to think of public symbol files as retaining type information from the private symbol files, as if the stripping was only partial, they do not in fact retain any such thing. They are fully stripped but then they get merged into them the type information from compiling a separate source file. In the kernel’s case, this source file is among the many that are specifically the kernel’s. It is compiled with many, if not all, of the same headers, but it is separate in the sense that the object file that results from its compilation is not linked into the kernel. It contributes nothing to the binary. It possibly never is fed to the linker to contribute to any binary. Even the object file is not wanted, just the PDB streams that have type information.

Strictly speaking, then, the type information in the kernel’s public symbol files is not the kernel’s. To say so may seem like splitting hairs, but it’s not without consequences. It may, for instance, explain an age-old mystery about the SECTION_OBJECT and SEGMENT_OBJECT types. Examples are clearer for executables other than the kernel: some sizes and offsets that the public symbol files for WIN32K.SYS in Windows 7 give for several structures, including both the PROCESSINFO and THREADINFO, cannot be correct for the structure as used by the matching binary. Surely the most credible explanation is that this mechanism by which Microsoft gets type information into public symbol files sometimes goes wrong because the separate source file may pick up a different definition or compile the same definition slightly differently from what got built into the matching binary. Still, the examples are few. We can’t keep looking under the bed for monsters even though we know they’re real. Having summarised that type information in public symbol files comes with caveats, this introductory page must leave the details and implications to be taken up elsewhere—a link follows the source tree, below—and press on with what can be learnt about the kernel’s header files now that public symbol files tell us more than they used to.

Source Tree

An immediate insight is to flesh out the source tree. Microsoft’s debugging support in the first few versions showed which code and data came from which source file and where these source files were when compiled. The change from .DBG files to .PDB files reduced this to showing not the source files but the object files. Still, the .PDB files tell where the object files got built and which libraries brought them into the kernel. Pathnames for at least some source files continued to be disclosed through assert statements in checked builds. These also give line numbers, often also showing macros and the names of arguments and local variables. Say what you will about Microsoft, but the programmer who commits enough to Windows that their debugging turns into reverse engineering has never been anything like as much deprived of details as you might think they must be in a closed-source model.

But back to the source tree, specifically. Though the directory structure of source files for the kernel has never been a secret, little has been reliably inferrable about how Microsoft organises header files for inclusion into the source files. Starting with Windows 8, however, the public symbol files for the kernel give full pathnames for every header that defines any type for which the same symbol files have type information. The tree below is reconstructed from information in the NTKRPAMP.PDB and NTKRNLMP.PDB symbol files for the 32-bit and 64-bit kernel, respectively, from the original release of Windows 10. If you browse this page with scripts enabled, then it starts with my selection of branches to expand for your attention, but you can expand the branches that interest you and collapse those that don’t.

Among the records of header files is one for a file that I do not place in the tree above. This file is named just ..\ntsym.c. It is indeed a source file, not a header. Though its LF_UDT_SRC_LINE record gives only a relative path, the file is almost certainly in a directory named d:\th\minkernel\ntos\init. Though it is in that part of the source tree that has the source files that are specifically for the kernel, it does not contribute any code or data to the kernel. It is instead the source file that is described above as additional, intended only for getting otherwise private type information into the public symbol files. Follow the link for the evidence.

Standard Headers

To go by this record in the public symbol files, the kernel’s source code does not include any of the usual headers, such as WDM.H, NTDDK.H and NTIFS.H, that are standard inclusions for almost all kernel-mode projects. Even the HAL includes NTDDK.H (and therefore also WDM.H), but the kernel evidently does not. Clues have abounded even from as long ago as version 3.10 that these headers are not fundamental but are instead constructed from others. Now we get to see something of how.

Repeated Definitions

Start with the clues, if only to use the history as background. The first part to the oldest clue is the repetition of definitions. Even for Windows NT 3.1, a programmer who works only with kernel mode and is armed only with the Device Driver Kit (DDK) will see that although most drivers include NTDDK.H, some do not. These others are miniport drivers. If only in principle, they interact only with a designated port driver, not directly with the kernel. They do not need, and would better not even have access to, most of the definitions in NTDDK.H or even to most in NTDEF.H (which is included by NTDDK.H). The header that miniport drivers include as standard is not NTDDK.H but is MINIPORT.H instead. Inevitably, some types and macros are defined in both MINIPORT.H and NTDEF.H. The programmer who looks at the user-mode support in the Software Development Kit (SDK) will find that some of these types are also defined in WINNT.H. Moroever, such repetitions are not limited just to headers that get included as standard. For instance, some definitions in NTDDK.H are repeated in DEVIOCTL.H from the DDK and in WINIOCTL.H from the SDK, and the two SDK headers WINNT.H and NTIMAGE.H share a run of 928 lines.

Microsoft’s programmers surely didn’t intend that identical sequences in a range of headers supplied in two kits should be maintained separately, with the attendant risk that they would soon get out of synch. If there was not some coordination right from the start, there surely was at least a plan that each sequence in common has one master definition. Some indication is visible in the published headers as comments, which become the second part to this old clue. Some of the repeated sequences are, in some of the affected headers, bracketed by comments in a particular form. Some repeated lines, again only in some of the headers, end with single-line comments in a particular form. For instance, the first example in NTDDK.H is

// begin_winnt
#define MAXIMUM_WAIT_OBJECTS 64     // Maximum number of wait objects

#define MAXIMUM_SUSPEND_COUNT MAXCHAR // Maximum times thread can be suspended
// end_winnt

The lines between the begin_winnt and end_winnt comments are reproduced exactly in WINNT.H. Roughly 20 lines later in NTDDK.H is

typedef ULONG KSPIN_LOCK;  // winnt

and it is the very next line in WINNT.H, reproduced exactly except for being stripped of the single-line comment. Before these lines in WINNT.H are definitions of some two dozen NTSTATUS values, which are just the ones whose definitions in NTSTATUS.H end with the single-line “winnt” comment.

Such comments might exist just to alert Microsoft’s programmers that lines they might think to edit have consequences for synchronisation with other headers, but this would invite that the comments too get out of synch. Even in the DDK for Windows NT 3.1, the alerts aren’t consistent. For instance, the reader of NTIMAGE.H will be warned of 928 lines that are also in WINNT.H but the reader of the latter is not warned that these lines are shared with the former. More plausible is that the comments are remnants, perhaps left carelessly, of automation. The suggestion is strong that headers such as WINNT.H and perhaps even NTDDK.H itself are each prepared from some script or some master header that contains directions to pull in lines from other masters.

Signs of what such master headers may even be named, let alone of what they contain, were initially few in any published DDK or SDK. The earliest that I know of is in an SDK dated January 1998. A new header, named SCARDERR.H, defines Win32 error codes that are specific to the Smart Card Resource Manager and begins with a comment that the content “must be reconciled with winerror.w”. The relationship is more direct in a new header, SDDL.H, from an SDK dated January 2000. Its introductory comment has “sddl.w” as the Module Name right after the copyright notice at the top. That the file extension .w is in use for something very much like header files is put beyond doubt by the Windows XP DDK, whose KBD.H follows its definition of ALTNUMPAD_BIT by a comment that it is “copied from windows\inc\wincon.w”. Thus have the .w names trickled out for years, occasionally to be removed, perhaps as some hint that disclosure was once seen as an oversight to be corrected. By now, after many years, there has been a relative proliferation. In the SDK for Windows 10, as prominent a header as WINBASE.H mentions “ntioapi_x.w”, which is notable because not even the .h form of this header is published.

Different Definitions

That NTDDK.H specifically is not fundamental and that the kernel is built without it was also inferrable in ancient times, at least as a possibility. The most prominent, but perhaps not the first, basis for such inference is the KPCR structure. C-language definitions of this structure for different processors are presented in NTDDK.H from the DDK for Windows NT 3.1, though not for the i386 processor until the DDK for Windows NT 3.51. This definition in NTDDK.H is only of “the architecturally defined section”. It is not the whole thing, but there is no conditional compilation through which the kernel can include NTDDK.H while bringing in a different KPCR definition from elsewhere. Either the kernel’s knowledge of the whole structure uses a different name or the kernel does not include NTDDK.H.

Confirmation that the full definition of the structure that NTDDK.H defines as KPCR also has the name KPCR when building the kernel came with Windows XP. In this version (chronologically, but in Windows 2000 SP3 by version number), the .PDB files for the kernels have type information. The big benefit of this is that debuggers, which Microsoft concurrently unified around the Debugger Engine (DBGENG.DLL), could do their work without needing built-in knowledge of implementation details such as where to find this member of that structure. To debug a particular Windows version, programmers no longer needed a particular version of the debugger or of some debugger extension, just the right symbol files for that Windows version. A benefit for Microsoft’s programmers of the kernel is that they became more free to change the internals without fear of complicating debugging, but that’s another story. What matters here is that type information in symbol files was a significant increase in disclosure. Type information can be reconstructed mechanically into a C-language definition. The type information that public symbol files for the kernels in Windows XP show for the KPCR is plausibly the full definition, certainly with more members than are shown in NTDDK.H.

Since Windows XP, then, it has been known certainly that the kernel doesn’t include NTDDK.H. What, then, does the kernel include instead? Which header has the kernel’s definition of the KPCR? This seemed unanswerable, short of access to Microsoft’s source code, until Windows 8 and its augmentation of type information with header information. Now it is known that the x86 and x64 kernels gets their KPCR definitions by including i386_x.h and amd64_x.h, respectively. These headers are not supplied with any DDK or WDK or through any other channel that reasonably counts as publication. That asking Google for pages containing “i386_x.h” today, 9th November 2020, turns up only four matches (two of them to pages of mine) doesn’t mean the file has been super-secret. It may be that the name and even the file have been seen by many and thought by all to be too obscure for words. Still, it doesn’t seem impossible that even this header’s name has never been formally revealed by Microsoft except to a limited audience that had explicitly agreed in advance to non-disclosure. Relative to this, header information in the public symbol files is a signficant new disclosure.