reactos/dll/appcompat/apphelp/sdbapi.c

   1 /*
   2  * Copyright 2011 André Hentschel
   3  * Copyright 2013 Mislav Blažević
   4  * Copyright 2015,2016 Mark Jansen
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #define WIN32_NO_STATUS
  22 #include "windows.h"
  23 #include "ntndk.h"
  24 #include "strsafe.h"
  25 #include "apphelp.h"
  26
  27 #include "wine/unicode.h"
  28
  29
  30 static const GUID GUID_DATABASE_MSI = {0xd8ff6d16,0x6a3a,0x468a, {0x8b,0x44,0x01,0x71,0x4d,0xdc,0x49,0xea}};
  31 static const GUID GUID_DATABASE_SHIM = {0x11111111,0x1111,0x1111, {0x11,0x11,0x11,0x11,0x11,0x11,0x11,0x11}};
  32 static const GUID GUID_DATABASE_DRIVERS = {0xf9ab2228,0x3312,0x4a73, {0xb6,0xf9,0x93,0x6d,0x70,0xe1,0x12,0xef}};
  33
  34 static HANDLE SdbpHeap(void);
  35
  36 #if SDBAPI_DEBUG_ALLOC
  37
  38 typedef struct SHIM_ALLOC_ENTRY
  39 {
  40     PVOID Address;
  41     SIZE_T Size;
  42     int Line;
  43     const char* File;
  44     PVOID Next;
  45     PVOID Prev;
  46 } SHIM_ALLOC_ENTRY, *PSHIM_ALLOC_ENTRY;
  47
  48
  49 static RTL_AVL_TABLE g_SdbpAllocationTable;
  50
  51
  52 static RTL_GENERIC_COMPARE_RESULTS
  53 NTAPI ShimAllocCompareRoutine(_In_ PRTL_AVL_TABLE Table, _In_ PVOID FirstStruct, _In_ PVOID SecondStruct)
  54 {
  55     PVOID First = ((PSHIM_ALLOC_ENTRY)FirstStruct)->Address;
  56     PVOID Second = ((PSHIM_ALLOC_ENTRY)SecondStruct)->Address;
  57
  58     if (First < Second)
  59         return GenericLessThan;
  60     else if (First == Second)
  61         return GenericEqual;
  62     return GenericGreaterThan;
  63 }
  64
  65 static PVOID NTAPI ShimAllocAllocateRoutine(_In_ PRTL_AVL_TABLE Table, _In_ CLONG ByteSize)
  66 {
  67     return HeapAlloc(SdbpHeap(), HEAP_ZERO_MEMORY, ByteSize);
  68 }
  69
  70 static VOID NTAPI ShimAllocFreeRoutine(_In_ PRTL_AVL_TABLE Table, _In_ PVOID Buffer)
  71 {
  72     HeapFree(SdbpHeap(), 0, Buffer);
  73 }
  74
  75 static void SdbpInsertAllocation(PVOID address, SIZE_T size, int line, const char* file)
  76 {
  77     SHIM_ALLOC_ENTRY Entry = {0};
  78
  79     Entry.Address = address;
  80     Entry.Size = size;
  81     Entry.Line = line;
  82     Entry.File = file;
  83     RtlInsertElementGenericTableAvl(&g_SdbpAllocationTable, &Entry, sizeof(Entry), NULL);
  84 }
  85
  86 static void SdbpUpdateAllocation(PVOID address, PVOID newaddress, SIZE_T size, int line, const char* file)
  87 {
  88     SHIM_ALLOC_ENTRY Lookup = {0};
  89     PSHIM_ALLOC_ENTRY Entry;
  90     Lookup.Address = address;
  91     Entry = RtlLookupElementGenericTableAvl(&g_SdbpAllocationTable, &Lookup);
  92
  93     if (address == newaddress)
  94     {
  95         Entry->Size = size;
  96     }
  97     else
  98     {
  99         Lookup.Address = newaddress;
 100         Lookup.Size = size;
 101         Lookup.Line = line;
 102         Lookup.File = file;
 103         Lookup.Prev = address;
 104         RtlInsertElementGenericTableAvl(&g_SdbpAllocationTable, &Lookup, sizeof(Lookup), NULL);
 105         Entry->Next = newaddress;
 106     }
 107 }
 108
 109 static void SdbpRemoveAllocation(PVOID address, int line, const char* file)
 110 {
 111     char buf[512];
 112     SHIM_ALLOC_ENTRY Lookup = {0};
 113     PSHIM_ALLOC_ENTRY Entry;
 114
 115     sprintf(buf, "\r\n===============\r\n%s(%d): SdbpFree called, tracing alloc:\r\n", file, line);
 116     OutputDebugStringA(buf);
 117
 118     Lookup.Address = address;
 119     while (Lookup.Address)
 120     {
 121         Entry = RtlLookupElementGenericTableAvl(&g_SdbpAllocationTable, &Lookup);
 122         if (Entry)
 123         {
 124             Lookup = *Entry;
 125             RtlDeleteElementGenericTableAvl(&g_SdbpAllocationTable, Entry);
 126
 127             sprintf(buf, " > %s(%d): %s%sAlloc( %d ) ==> %p\r\n", Lookup.File, Lookup.Line,
 128                 Lookup.Next ? "Invalidated " : "", Lookup.Prev ? "Re" : "", Lookup.Size, Lookup.Address);
 129             OutputDebugStringA(buf);
 130             Lookup.Address = Lookup.Prev;
 131         }
 132         else
 133         {
 134             Lookup.Address = NULL;
 135         }
 136     }
 137     sprintf(buf, "\r\n===============\r\n");
 138     OutputDebugStringA(buf);
 139 }
 140
 141 #endif
 142
 143 static HANDLE g_Heap;
 144 void SdbpHeapInit(void)
 145 {
 146 #if SDBAPI_DEBUG_ALLOC
 147     RtlInitializeGenericTableAvl(&g_SdbpAllocationTable, ShimAllocCompareRoutine,
 148         ShimAllocAllocateRoutine, ShimAllocFreeRoutine, NULL);
 149 #endif
 150     g_Heap = HeapCreate(0, 0x10000, 0);
 151 }
 152
 153 void SdbpHeapDeinit(void)
 154 {
 155 #if SDBAPI_DEBUG_ALLOC
 156     if (g_SdbpAllocationTable.NumberGenericTableElements != 0)
 157         __debugbreak();
 158 #endif
 159     HeapDestroy(g_Heap);
 160 }
 161
 162 static HANDLE SdbpHeap(void)
 163 {
 164     return g_Heap;
 165 }
 166
 167 LPVOID SdbpAlloc(SIZE_T size
 168 #if SDBAPI_DEBUG_ALLOC
 169     , int line, const char* file
 170 #endif
 171     )
 172 {
 173     LPVOID mem = HeapAlloc(SdbpHeap(), HEAP_ZERO_MEMORY, size);
 174 #if SDBAPI_DEBUG_ALLOC
 175     SdbpInsertAllocation(mem, size, line, file);
 176 #endif
 177     return mem;
 178 }
 179
 180 LPVOID SdbpReAlloc(LPVOID mem, SIZE_T size
 181 #if SDBAPI_DEBUG_ALLOC
 182     , int line, const char* file
 183 #endif
 184     )
 185 {
 186     LPVOID newmem = HeapReAlloc(SdbpHeap(), HEAP_ZERO_MEMORY, mem, size);
 187 #if SDBAPI_DEBUG_ALLOC
 188     SdbpUpdateAllocation(mem, newmem, size, line, file);
 189 #endif
 190     return newmem;
 191 }
 192
 193 void SdbpFree(LPVOID mem
 194 #if SDBAPI_DEBUG_ALLOC
 195     , int line, const char* file
 196 #endif
 197     )
 198 {
 199 #if SDBAPI_DEBUG_ALLOC
 200     SdbpRemoveAllocation(mem, line, file);
 201 #endif
 202     HeapFree(SdbpHeap(), 0, mem);
 203 }
 204
 205 PDB WINAPI SdbpCreate(LPCWSTR path, PATH_TYPE type, BOOL write)
 206 {
 207     NTSTATUS Status;
 208     IO_STATUS_BLOCK io;
 209     OBJECT_ATTRIBUTES attr;
 210     UNICODE_STRING str;
 211     PDB db;
 212
 213     if (type == DOS_PATH)
 214     {
 215         if (!RtlDosPathNameToNtPathName_U(path, &str, NULL, NULL))
 216             return NULL;
 217     }
 218     else
 219         RtlInitUnicodeString(&str, path);
 220
 221     /* SdbAlloc zeroes the memory. */
 222     db = (PDB)SdbAlloc(sizeof(DB));
 223     if (!db)
 224     {
 225         SHIM_ERR("Failed to allocate memory for shim database\n");
 226         return NULL;
 227     }
 228
 229     InitializeObjectAttributes(&attr, &str, OBJ_CASE_INSENSITIVE, NULL, NULL);
 230
 231     //Status = NtCreateFile(&db->file, FILE_GENERIC_READ | SYNCHRONIZE,
 232     //                      &attr, &io, NULL, FILE_ATTRIBUTE_NORMAL, FILE_SHARE_READ,
 233     //                      FILE_OPEN, FILE_NON_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT, NULL, 0);
 234     Status = NtCreateFile(&db->file, (write ? FILE_GENERIC_WRITE : FILE_GENERIC_READ )| SYNCHRONIZE,
 235                           &attr, &io, NULL, FILE_ATTRIBUTE_NORMAL, FILE_SHARE_READ,
 236                           write ? FILE_SUPERSEDE : FILE_OPEN, FILE_NON_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT, NULL, 0);
 237
 238     if (type == DOS_PATH)
 239         RtlFreeUnicodeString(&str);
 240
 241     if (!NT_SUCCESS(Status))
 242     {
 243         SdbCloseDatabase(db);
 244         SHIM_ERR("Failed to create shim database file: %lx\n", Status);
 245         return NULL;
 246     }
 247
 248     return db;
 249 }
 250
 251 void WINAPI SdbpFlush(PDB db)
 252 {
 253     IO_STATUS_BLOCK io;
 254     NTSTATUS Status = NtWriteFile(db->file, NULL, NULL, NULL, &io,
 255         db->data, db->write_iter, NULL, NULL);
 256     if( !NT_SUCCESS(Status))
 257         SHIM_WARN("failed with 0x%lx\n", Status);
 258 }
 259
 260 DWORD SdbpStrlen(PCWSTR string)
 261 {
 262     return lstrlenW(string);
 263 }
 264
 265 DWORD SdbpStrsize(PCWSTR string)
 266 {
 267     return (SdbpStrlen(string) + 1) * sizeof(WCHAR);
 268 }
 269
 270 PWSTR SdbpStrDup(LPCWSTR string)
 271 {
 272     PWSTR ret = SdbpAlloc(SdbpStrsize(string));
 273     lstrcpyW(ret, string);
 274     return ret;
 275 }
 276
 277
 278 BOOL WINAPI SdbpOpenMemMappedFile(LPCWSTR path, PMEMMAPPED mapping)
 279 {
 280     NTSTATUS Status;
 281     OBJECT_ATTRIBUTES ObjectAttributes;
 282     IO_STATUS_BLOCK IoStatusBlock;
 283     FILE_STANDARD_INFORMATION FileStandard;
 284     UNICODE_STRING FileName;
 285
 286     RtlZeroMemory(mapping, sizeof(*mapping));
 287
 288     if(!RtlDosPathNameToNtPathName_U(path, &FileName, NULL, NULL))
 289     {
 290         RtlFreeUnicodeString(&FileName);
 291         return FALSE;
 292     }
 293
 294     InitializeObjectAttributes(&ObjectAttributes, &FileName, OBJ_CASE_INSENSITIVE, NULL, NULL);
 295     Status = NtOpenFile(&mapping->file, GENERIC_READ | SYNCHRONIZE, &ObjectAttributes, &IoStatusBlock, FILE_SHARE_READ, FILE_SYNCHRONOUS_IO_NONALERT);
 296     RtlFreeUnicodeString(&FileName);
 297
 298     if (!NT_SUCCESS(Status))
 299     {
 300         SHIM_ERR("Failed to open file %S: 0x%lx\n", path, Status);
 301         return FALSE;
 302     }
 303
 304     Status = NtCreateSection(&mapping->section, STANDARD_RIGHTS_REQUIRED | SECTION_QUERY | SECTION_MAP_READ, 0, 0, PAGE_READONLY, SEC_COMMIT, mapping->file);
 305     if (!NT_SUCCESS(Status))
 306     {
 307         /* Special case */
 308         if (Status == STATUS_MAPPED_FILE_SIZE_ZERO)
 309         {
 310             NtClose(mapping->file);
 311             mapping->file = mapping->section = NULL;
 312             return TRUE;
 313         }
 314         SHIM_ERR("Failed to create mapping for file: 0x%lx\n", Status);
 315         goto err_out;
 316     }
 317
 318     Status = NtQueryInformationFile(mapping->file, &IoStatusBlock, &FileStandard, sizeof(FileStandard), FileStandardInformation);
 319     if (!NT_SUCCESS(Status))
 320     {
 321         SHIM_ERR("Failed to read file info for file: 0x%lx\n", Status);
 322         goto err_out;
 323     }
 324
 325     mapping->mapped_size = mapping->size = FileStandard.EndOfFile.LowPart;
 326     Status = NtMapViewOfSection(mapping->section, NtCurrentProcess(), (PVOID*)&mapping->view, 0, 0, 0, &mapping->mapped_size, ViewUnmap, 0, PAGE_READONLY);
 327     if (!NT_SUCCESS(Status))
 328     {
 329         SHIM_ERR("Failed to map view of file: 0x%lx\n", Status);
 330         goto err_out;
 331     }
 332
 333     return TRUE;
 334
 335 err_out:
 336     if (!mapping->view)
 337     {
 338         if (mapping->section)
 339             NtClose(mapping->section);
 340         NtClose(mapping->file);
 341     }
 342     return FALSE;
 343 }
 344
 345 void WINAPI SdbpCloseMemMappedFile(PMEMMAPPED mapping)
 346 {
 347     /* Prevent a VAD warning */
 348     if (mapping->view)
 349         NtUnmapViewOfSection(NtCurrentProcess(), mapping->view);
 350     NtClose(mapping->section);
 351     NtClose(mapping->file);
 352     RtlZeroMemory(mapping, sizeof(*mapping));
 353 }
 354
 355 BOOL WINAPI SdbpCheckTagType(TAG tag, WORD type)
 356 {
 357     if ((tag & TAG_TYPE_MASK) != type)
 358         return FALSE;
 359     return TRUE;
 360 }
 361
 362 BOOL WINAPI SdbpCheckTagIDType(PDB db, TAGID tagid, WORD type)
 363 {
 364     TAG tag = SdbGetTagFromTagID(db, tagid);
 365     if (tag == TAG_NULL)
 366         return FALSE;
 367     return SdbpCheckTagType(tag, type);
 368 }
 369
 370 PDB SdbpOpenDatabase(LPCWSTR path, PATH_TYPE type, PDWORD major, PDWORD minor)
 371 {
 372     IO_STATUS_BLOCK io;
 373     PDB db;
 374     NTSTATUS Status;
 375     BYTE header[12];
 376
 377     db = SdbpCreate(path, type, FALSE);
 378     if (!db)
 379         return NULL;
 380
 381     db->size = GetFileSize(db->file, NULL);
 382     db->data = SdbAlloc(db->size);
 383     Status = NtReadFile(db->file, NULL, NULL, NULL, &io, db->data, db->size, NULL, NULL);
 384
 385     if (!NT_SUCCESS(Status))
 386     {
 387         SdbCloseDatabase(db);
 388         SHIM_ERR("Failed to open shim database file: 0x%lx\n", Status);
 389         return NULL;
 390     }
 391
 392     if (!SdbpReadData(db, &header, 0, 12))
 393     {
 394         SdbCloseDatabase(db);
 395         SHIM_ERR("Failed to read shim database header\n");
 396         return NULL;
 397     }
 398
 399     if (memcmp(&header[8], "sdbf", 4) != 0)
 400     {
 401         SdbCloseDatabase(db);
 402         SHIM_ERR("Shim database header is invalid\n");
 403         return NULL;
 404     }
 405
 406     *major = *(DWORD*)&header[0];
 407     *minor = *(DWORD*)&header[4];
 408
 409     return db;
 410 }
 411
 412
 413 /**
 414  * Opens specified shim database file.
 415  *
 416  * @param [in]  path    Path to the shim database.
 417  * @param [in]  type    Type of path. Either DOS_PATH or NT_PATH.
 418  *
 419  * @return  Success: Handle to the shim database, NULL otherwise.
 420  */
 421 PDB WINAPI SdbOpenDatabase(LPCWSTR path, PATH_TYPE type)
 422 {
 423     PDB db;
 424     DWORD major, minor;
 425
 426     db = SdbpOpenDatabase(path, type, &major, &minor);
 427     if (!db)
 428         return NULL;
 429
 430     if (major != 2)
 431     {
 432         SdbCloseDatabase(db);
 433         SHIM_ERR("Invalid shim database version\n");
 434         return NULL;
 435     }
 436
 437     db->stringtable = SdbFindFirstTag(db, TAGID_ROOT, TAG_STRINGTABLE);
 438     if(!SdbGetDatabaseID(db, &db->database_id))
 439     {
 440         SHIM_INFO("Failed to get the database id\n");
 441     }
 442     return db;
 443 }
 444
 445 /**
 446  * Closes specified database and frees its memory.
 447  *
 448  * @param [in]  db  Handle to the shim database.
 449  */
 450 void WINAPI SdbCloseDatabase(PDB db)
 451 {
 452     if (!db)
 453         return;
 454
 455     if (db->file)
 456         NtClose(db->file);
 457     SdbFree(db->data);
 458     SdbFree(db);
 459 }
 460
 461 /**
 462  * Retrieves AppPatch directory.
 463  *
 464  * @param [in]  db      Handle to the shim database.
 465  * @param [out] path    Pointer to memory in which path shall be written.
 466  * @param [in]  size    Size of the buffer in characters.
 467  */
 468 BOOL WINAPI SdbGetAppPatchDir(HSDB db, LPWSTR path, DWORD size)
 469 {
 470     static WCHAR* default_dir = NULL;
 471     static CONST WCHAR szAppPatch[] = {'\\','A','p','p','P','a','t','c','h',0};
 472
 473     if(!default_dir)
 474     {
 475         WCHAR* tmp = NULL;
 476         UINT len = GetSystemWindowsDirectoryW(NULL, 0) + lstrlenW(szAppPatch);
 477         tmp = SdbAlloc((len + 1)* sizeof(WCHAR));
 478         if(tmp)
 479         {
 480             UINT r = GetSystemWindowsDirectoryW(tmp, len+1);
 481             if (r && r < len)
 482             {
 483                 if (SUCCEEDED(StringCchCatW(tmp, len+1, szAppPatch)))
 484                 {
 485                     if(InterlockedCompareExchangePointer((void**)&default_dir, tmp, NULL) == NULL)
 486                         tmp = NULL;
 487                 }
 488             }
 489             if (tmp)
 490                 SdbFree(tmp);
 491         }
 492     }
 493
 494     /* In case function fails, path holds empty string */
 495     if (size > 0)
 496         *path = 0;
 497
 498     if (!db)
 499     {
 500         return SUCCEEDED(StringCchCopyW(path, size, default_dir));
 501     }
 502     else
 503     {
 504         /* fixme */
 505         return FALSE;
 506     }
 507 }
 508
 509 /**
 510  * Parses a string to retrieve a GUID.
 511  *
 512  * @param [in]  GuidString  The string to parse.
 513  * @param [out] Guid        The resulting GUID.
 514  *
 515  * @return  TRUE if it succeeds, FALSE if it fails.
 516  */
 517 BOOL WINAPI SdbGUIDFromString(PCWSTR GuidString, GUID *Guid)
 518 {
 519     UNICODE_STRING GuidString_u;
 520     RtlInitUnicodeString(&GuidString_u, GuidString);
 521     return NT_SUCCESS(RtlGUIDFromString(&GuidString_u, Guid));
 522 }
 523
 524 /**
 525  * Converts a GUID to a string.
 526  *
 527  * @param [in]  Guid        The GUID to convert.
 528  * @param [out] GuidString  The resulting string representation of Guid.
 529  * @param [in]  Length      The length of GuidString.
 530  *
 531  * @return  TRUE if it succeeds, FALSE if it fails.
 532  */
 533 BOOL WINAPI SdbGUIDToString(CONST GUID *Guid, PWSTR GuidString, SIZE_T Length)
 534 {
 535     UNICODE_STRING GuidString_u;
 536     if(NT_SUCCESS(RtlStringFromGUID(Guid, &GuidString_u)))
 537     {
 538         HRESULT hr = StringCchCopyNW(GuidString, Length, GuidString_u.Buffer, GuidString_u.Length / 2);
 539         RtlFreeUnicodeString(&GuidString_u);
 540         return SUCCEEDED(hr);
 541     }
 542     return FALSE;
 543 }
 544
 545 /**
 546  * Checks if the specified GUID is a NULL GUID
 547  *
 548  * @param [in]  Guid    The GUID to check.
 549  *
 550  * @return  TRUE if it is a NULL GUID.
 551  */
 552 BOOL WINAPI SdbIsNullGUID(CONST GUID *Guid)
 553 {
 554     static GUID NullGuid = { 0 };
 555     return !Guid || IsEqualGUID(&NullGuid, Guid);
 556 }
 557
 558 /**
 559  * Get the GUID from one of the standard databases.
 560  *
 561  * @param [in]  Flags   The ID to retrieve the guid from. (See SDB_DATABASE_MAIN_[xxx])
 562  * @param [out] Guid    The resulting GUID.
 563  *
 564  * @return  TRUE if a known database ID.
 565  */
 566 BOOL WINAPI SdbGetStandardDatabaseGUID(DWORD Flags, GUID* Guid)
 567 {
 568     const GUID* copy_from = NULL;
 569     switch(Flags & HID_DATABASE_TYPE_MASK)
 570     {
 571     case SDB_DATABASE_MAIN_MSI:
 572         copy_from = &GUID_DATABASE_MSI;
 573         break;
 574     case SDB_DATABASE_MAIN_SHIM:
 575         copy_from = &GUID_DATABASE_SHIM;
 576         break;
 577     case SDB_DATABASE_MAIN_DRIVERS:
 578         copy_from = &GUID_DATABASE_DRIVERS;
 579         break;
 580     default:
 581         SHIM_ERR("Cannot obtain database guid for databases other than main\n");
 582         return FALSE;
 583     }
 584     if(Guid)
 585     {
 586         memcpy(Guid, copy_from, sizeof(GUID));
 587     }
 588     return TRUE;
 589 }
 590
 591 /**
 592  * Read the database version from the specified database.
 593  *
 594  * @param [in]  database    The database.
 595  * @param [out] VersionHi   The first part of the version number.
 596  * @param [out] VersionLo   The second part of the version number.
 597  *
 598  * @return  TRUE if it succeeds or fails, FALSE if ???
 599  */
 600 BOOL WINAPI SdbGetDatabaseVersion(LPCWSTR database, PDWORD VersionHi, PDWORD VersionLo)
 601 {
 602     PDB db;
 603
 604     db = SdbpOpenDatabase(database, DOS_PATH, VersionHi, VersionLo);
 605     if (db)
 606         SdbCloseDatabase(db);
 607
 608     return TRUE;
 609 }
 610
 611 /**
 612  * Converts specified tag into a string.
 613  *
 614  * @param [in]  tag The tag which will be converted to a string.
 615  *
 616  * @return  Success: Pointer to the string matching specified tag, or L"InvalidTag" on failure.
 617  *
 618  * @todo: Convert this into a lookup table, this is wasting alot of space.
 619  */
 620 LPCWSTR WINAPI SdbTagToString(TAG tag)
 621 {
 622     /* lookup tables for tags in range 0x1 -> 0xFF | TYPE */
 623     static const WCHAR table[9][0x32][25] = {
 624     {   /* TAG_TYPE_NULL */
 625         {'I','N','C','L','U','D','E',0},
 626         {'G','E','N','E','R','A','L',0},
 627         {'M','A','T','C','H','_','L','O','G','I','C','_','N','O','T',0},
 628         {'A','P','P','L','Y','_','A','L','L','_','S','H','I','M','S',0},
 629         {'U','S','E','_','S','E','R','V','I','C','E','_','P','A','C','K','_','F','I','L','E','S',0},
 630         {'M','I','T','I','G','A','T','I','O','N','_','O','S',0},
 631         {'B','L','O','C','K','_','U','P','G','R','A','D','E',0},
 632         {'I','N','C','L','U','D','E','E','X','C','L','U','D','E','D','L','L',0},
 633         {'R','A','C','_','E','V','E','N','T','_','O','F','F',0},
 634         {'T','E','L','E','M','E','T','R','Y','_','O','F','F',0},
 635         {'S','H','I','M','_','E','N','G','I','N','E','_','O','F','F',0},
 636         {'L','A','Y','E','R','_','P','R','O','P','A','G','A','T','I','O','N','_','O','F','F',0},
 637         {'R','E','I','N','S','T','A','L','L','_','U','P','G','R','A','D','E',0}
 638     },
 639     {   /* TAG_TYPE_BYTE */
 640         {'I','n','v','a','l','i','d','T','a','g',0}
 641     },
 642     {   /* TAG_TYPE_WORD */
 643         {'M','A','T','C','H','_','M','O','D','E',0}
 644     },
 645     {   /* TAG_TYPE_DWORD */
 646         {'S','I','Z','E',0},
 647         {'O','F','F','S','E','T',0},
 648         {'C','H','E','C','K','S','U','M',0},
 649         {'S','H','I','M','_','T','A','G','I','D',0},
 650         {'P','A','T','C','H','_','T','A','G','I','D',0},
 651         {'M','O','D','U','L','E','_','T','Y','P','E',0},
 652         {'V','E','R','D','A','T','E','H','I',0},
 653         {'V','E','R','D','A','T','E','L','O',0},
 654         {'V','E','R','F','I','L','E','O','S',0},
 655         {'V','E','R','F','I','L','E','T','Y','P','E',0},
 656         {'P','E','_','C','H','E','C','K','S','U','M',0},
 657         {'P','R','E','V','O','S','M','A','J','O','R','V','E','R',0},
 658         {'P','R','E','V','O','S','M','I','N','O','R','V','E','R',0},
 659         {'P','R','E','V','O','S','P','L','A','T','F','O','R','M','I','D',0},
 660         {'P','R','E','V','O','S','B','U','I','L','D','N','O',0},
 661         {'P','R','O','B','L','E','M','S','E','V','E','R','I','T','Y',0},
 662         {'L','A','N','G','I','D',0},
 663         {'V','E','R','_','L','A','N','G','U','A','G','E',0},
 664         {'I','n','v','a','l','i','d','T','a','g',0},
 665         {'E','N','G','I','N','E',0},
 666         {'H','T','M','L','H','E','L','P','I','D',0},
 667         {'I','N','D','E','X','_','F','L','A','G','S',0},
 668         {'F','L','A','G','S',0},
 669         {'D','A','T','A','_','V','A','L','U','E','T','Y','P','E',0},
 670         {'D','A','T','A','_','D','W','O','R','D',0},
 671         {'L','A','Y','E','R','_','T','A','G','I','D',0},
 672         {'M','S','I','_','T','R','A','N','S','F','O','R','M','_','T','A','G','I','D',0},
 673         {'L','I','N','K','E','R','_','V','E','R','S','I','O','N',0},
 674         {'L','I','N','K','_','D','A','T','E',0},
 675         {'U','P','T','O','_','L','I','N','K','_','D','A','T','E',0},
 676         {'O','S','_','S','E','R','V','I','C','E','_','P','A','C','K',0},
 677         {'F','L','A','G','_','T','A','G','I','D',0},
 678         {'R','U','N','T','I','M','E','_','P','L','A','T','F','O','R','M',0},
 679         {'O','S','_','S','K','U',0},
 680         {'O','S','_','P','L','A','T','F','O','R','M',0},
 681         {'A','P','P','_','N','A','M','E','_','R','C','_','I','D',0},
 682         {'V','E','N','D','O','R','_','N','A','M','E','_','R','C','_','I','D',0},
 683         {'S','U','M','M','A','R','Y','_','M','S','G','_','R','C','_','I','D',0},
 684         {'V','I','S','T','A','_','S','K','U',0},
 685         {'D','E','S','C','R','I','P','T','I','O','N','_','R','C','_','I','D',0},
 686         {'P','A','R','A','M','E','T','E','R','1','_','R','C','_','I','D',0},
 687         {'I','n','v','a','l','i','d','T','a','g',0},
 688         {'I','n','v','a','l','i','d','T','a','g',0},
 689         {'I','n','v','a','l','i','d','T','a','g',0},
 690         {'I','n','v','a','l','i','d','T','a','g',0},
 691         {'I','n','v','a','l','i','d','T','a','g',0},
 692         {'I','n','v','a','l','i','d','T','a','g',0},
 693         {'C','O','N','T','E','X','T','_','T','A','G','I','D',0},
 694         {'E','X','E','_','W','R','A','P','P','E','R',0},
 695         {'U','R','L','_','I','D',0}
 696     },
 697     {   /* TAG_TYPE_QWORD */
 698         {'T','I','M','E',0},
 699         {'B','I','N','_','F','I','L','E','_','V','E','R','S','I','O','N',0},
 700         {'B','I','N','_','P','R','O','D','U','C','T','_','V','E','R','S','I','O','N',0},
 701         {'M','O','D','T','I','M','E',0},
 702         {'F','L','A','G','_','M','A','S','K','_','K','E','R','N','E','L',0},
 703         {'U','P','T','O','_','B','I','N','_','P','R','O','D','U','C','T','_','V','E','R','S','I','O','N',0},
 704         {'D','A','T','A','_','Q','W','O','R','D',0},
 705         {'F','L','A','G','_','M','A','S','K','_','U','S','E','R',0},
 706         {'F','L','A','G','S','_','N','T','V','D','M','1',0},
 707         {'F','L','A','G','S','_','N','T','V','D','M','2',0},
 708         {'F','L','A','G','S','_','N','T','V','D','M','3',0},
 709         {'F','L','A','G','_','M','A','S','K','_','S','H','E','L','L',0},
 710         {'U','P','T','O','_','B','I','N','_','F','I','L','E','_','V','E','R','S','I','O','N',0},
 711         {'F','L','A','G','_','M','A','S','K','_','F','U','S','I','O','N',0},
 712         {'F','L','A','G','_','P','R','O','C','E','S','S','P','A','R','A','M',0},
 713         {'F','L','A','G','_','L','U','A',0},
 714         {'F','L','A','G','_','I','N','S','T','A','L','L',0}
 715     },
 716     {   /* TAG_TYPE_STRINGREF */
 717         {'N','A','M','E',0},
 718         {'D','E','S','C','R','I','P','T','I','O','N',0},
 719         {'M','O','D','U','L','E',0},
 720         {'A','P','I',0},
 721         {'V','E','N','D','O','R',0},
 722         {'A','P','P','_','N','A','M','E',0},
 723         {'I','n','v','a','l','i','d','T','a','g',0},
 724         {'C','O','M','M','A','N','D','_','L','I','N','E',0},
 725         {'C','O','M','P','A','N','Y','_','N','A','M','E',0},
 726         {'D','L','L','F','I','L','E',0},
 727         {'W','I','L','D','C','A','R','D','_','N','A','M','E',0},
 728         {'I','n','v','a','l','i','d','T','a','g',0},
 729         {'I','n','v','a','l','i','d','T','a','g',0},
 730         {'I','n','v','a','l','i','d','T','a','g',0},
 731         {'I','n','v','a','l','i','d','T','a','g',0},
 732         {'P','R','O','D','U','C','T','_','N','A','M','E',0},
 733         {'P','R','O','D','U','C','T','_','V','E','R','S','I','O','N',0},
 734         {'F','I','L','E','_','D','E','S','C','R','I','P','T','I','O','N',0},
 735         {'F','I','L','E','_','V','E','R','S','I','O','N',0},
 736         {'O','R','I','G','I','N','A','L','_','F','I','L','E','N','A','M','E',0},
 737         {'I','N','T','E','R','N','A','L','_','N','A','M','E',0},
 738         {'L','E','G','A','L','_','C','O','P','Y','R','I','G','H','T',0},
 739         {'1','6','B','I','T','_','D','E','S','C','R','I','P','T','I','O','N',0},
 740         {'A','P','P','H','E','L','P','_','D','E','T','A','I','L','S',0},
 741         {'L','I','N','K','_','U','R','L',0},
 742         {'L','I','N','K','_','T','E','X','T',0},
 743         {'A','P','P','H','E','L','P','_','T','I','T','L','E',0},
 744         {'A','P','P','H','E','L','P','_','C','O','N','T','A','C','T',0},
 745         {'S','X','S','_','M','A','N','I','F','E','S','T',0},
 746         {'D','A','T','A','_','S','T','R','I','N','G',0},
 747         {'M','S','I','_','T','R','A','N','S','F','O','R','M','_','F','I','L','E',0},
 748         {'1','6','B','I','T','_','M','O','D','U','L','E','_','N','A','M','E',0},
 749         {'L','A','Y','E','R','_','D','I','S','P','L','A','Y','N','A','M','E',0},
 750         {'C','O','M','P','I','L','E','R','_','V','E','R','S','I','O','N',0},
 751         {'A','C','T','I','O','N','_','T','Y','P','E',0},
 752         {'E','X','P','O','R','T','_','N','A','M','E',0},
 753         {'U','R','L',0}
 754     },
 755     {   /* TAG_TYPE_LIST */
 756         {'D','A','T','A','B','A','S','E',0},
 757         {'L','I','B','R','A','R','Y',0},
 758         {'I','N','E','X','C','L','U','D','E',0},
 759         {'S','H','I','M',0},
 760         {'P','A','T','C','H',0},
 761         {'A','P','P',0},
 762         {'E','X','E',0},
 763         {'M','A','T','C','H','I','N','G','_','F','I','L','E',0},
 764         {'S','H','I','M','_','R','E','F',0},
 765         {'P','A','T','C','H','_','R','E','F',0},
 766         {'L','A','Y','E','R',0},
 767         {'F','I','L','E',0},
 768         {'A','P','P','H','E','L','P',0},
 769         {'L','I','N','K',0},
 770         {'D','A','T','A',0},
 771         {'M','S','I','_','T','R','A','N','S','F','O','R','M',0},
 772         {'M','S','I','_','T','R','A','N','S','F','O','R','M','_','R','E','F',0},
 773         {'M','S','I','_','P','A','C','K','A','G','E',0},
 774         {'F','L','A','G',0},
 775         {'M','S','I','_','C','U','S','T','O','M','_','A','C','T','I','O','N',0},
 776         {'F','L','A','G','_','R','E','F',0},
 777         {'A','C','T','I','O','N',0},
 778         {'L','O','O','K','U','P',0},
 779         {'C','O','N','T','E','X','T',0},
 780         {'C','O','N','T','E','X','T','_','R','E','F',0},
 781         {'I','n','v','a','l','i','d','T','a','g',0},
 782         {'I','n','v','a','l','i','d','T','a','g',0},
 783         {'I','n','v','a','l','i','d','T','a','g',0},
 784         {'I','n','v','a','l','i','d','T','a','g',0},
 785         {'I','n','v','a','l','i','d','T','a','g',0},
 786         {'I','n','v','a','l','i','d','T','a','g',0},
 787         {'S','P','C',0}
 788     },
 789     {   /* TAG_TYPE_STRING */
 790         {'I','n','v','a','l','i','d','T','a','g',0}
 791     },
 792     {   /* TAG_TYPE_BINARY */
 793         {'I','n','v','a','l','i','d','T','a','g',0},
 794         {'P','A','T','C','H','_','B','I','T','S',0},
 795         {'F','I','L','E','_','B','I','T','S',0},
 796         {'E','X','E','_','I','D',0},
 797         {'D','A','T','A','_','B','I','T','S',0},
 798         {'M','S','I','_','P','A','C','K','A','G','E','_','I','D',0},
 799         {'D','A','T','A','B','A','S','E','_','I','D',0},
 800         {'C','O','N','T','E','X','T','_','P','L','A','T','F','O','R','M','_','I','D',0},
 801         {'C','O','N','T','E','X','T','_','B','R','A','N','C','H','_','I','D',0},
 802         {'I','n','v','a','l','i','d','T','a','g',0},
 803         {'I','n','v','a','l','i','d','T','a','g',0},
 804         {'I','n','v','a','l','i','d','T','a','g',0},
 805         {'I','n','v','a','l','i','d','T','a','g',0},
 806         {'I','n','v','a','l','i','d','T','a','g',0},
 807         {'I','n','v','a','l','i','d','T','a','g',0},
 808         {'F','I','X','_','I','D',0},
 809         {'A','P','P','_','I','D',0}
 810     }
 811     };
 812
 813     /* sizes of tables in above array (# strings per type) */
 814     static const WORD limits[9] = {
 815         /* switch off TYPE_* nibble of last tag for each type */
 816         TAG_REINSTALL_UPGRADE & 0xFF,
 817         1,
 818         TAG_MATCH_MODE & 0xFF,
 819         TAG_URL_ID & 0xFF,
 820         TAG_FLAG_INSTALL & 0xFF,
 821         TAG_URL & 0xFF,
 822         TAG_SPC & 0xFF,
 823         1,
 824         TAG_APP_ID & 0xFF
 825     };
 826
 827     /* lookup tables for tags in range 0x800 + (0x1 -> 0xFF) | TYPE */
 828     static const WCHAR table2[9][3][17] = {
 829     { {'I','n','v','a','l','i','d','T','a','g',0} }, /* TAG_TYPE_NULL */
 830     { {'I','n','v','a','l','i','d','T','a','g',0} }, /* TAG_TYPE_BYTE */
 831     {
 832         {'T','A','G',0}, /* TAG_TYPE_WORD */
 833         {'I','N','D','E','X','_','T','A','G',0},
 834         {'I','N','D','E','X','_','K','E','Y',0}
 835     },
 836     { {'T','A','G','I','D',0} }, /* TAG_TYPE_DWORD */
 837     { {'I','n','v','a','l','i','d','T','a','g',0} }, /* TAG_TYPE_QWORD */
 838     { {'I','n','v','a','l','i','d','T','a','g',0} }, /* TAG_TYPE_STRINGREF */
 839     {
 840         {'S','T','R','I','N','G','T','A','B','L','E',0}, /* TAG_TYPE_LIST */
 841         {'I','N','D','E','X','E','S',0},
 842         {'I','N','D','E','X',0}
 843     },
 844     { {'S','T','R','I','N','G','T','A','B','L','E','_','I','T','E','M',0}, }, /* TAG_TYPE_STRING */
 845     { {'I','N','D','E','X','_','B','I','T','S',0} } /* TAG_TYPE_BINARY */
 846     };
 847
 848     /* sizes of tables in above array, hardcoded for simplicity */
 849     static const WORD limits2[9] = { 0, 0, 3, 1, 0, 0, 3, 1, 1 };
 850
 851     static const WCHAR null[] = {'N','U','L','L',0};
 852     static const WCHAR invalid[] = {'I','n','v','a','l','i','d','T','a','g',0};
 853
 854     BOOL switch_table; /* should we use table2 and limits2? */
 855     WORD index, type_index;
 856
 857     /* special case: null tag */
 858     if (tag == TAG_NULL)
 859         return null;
 860
 861     /* tags with only type mask or no type mask are invalid */
 862     if ((tag & ~TAG_TYPE_MASK) == 0 || (tag & TAG_TYPE_MASK) == 0)
 863         return invalid;
 864
 865     /* some valid tags are in range 0x800 + (0x1 -> 0xF) | TYPE */
 866     if ((tag & 0xF00) == 0x800)
 867         switch_table = TRUE;
 868     else if ((tag & 0xF00) == 0)
 869         switch_table = FALSE;
 870     else return invalid;
 871
 872     /* index of table in array is type nibble */
 873     type_index = (tag >> 12) - 1;
 874
 875     /* index of string in table is low byte */
 876     index = (tag & 0xFF) - 1;
 877
 878     /* bound check */
 879     if (type_index >= 9 || index >= (switch_table ? limits2[type_index] : limits[type_index]))
 880         return invalid;
 881
 882     /* tag is valid */
 883     return switch_table ? table2[type_index][index] : table[type_index][index];
 884 }