ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/pbcdedit/pbcdedit
(Generate patch)

Comparing pbcdedit/pbcdedit (file contents):
Revision 1.2 by root, Wed Aug 14 20:56:50 2019 UTC vs.
Revision 1.39 by root, Thu Aug 15 23:49:22 2019 UTC

1#!/opt/bin/perl 1#!/usr/bin/perl
2 2
3# 3#
4# PBCDEDIT - Copyright 2019 Marc A. Lehmann <pbcbedit@schmorp.de> 4# PBCDEDIT - Copyright 2019 Marc A. Lehmann <pbcbedit@schmorp.de>
5# 5#
6# SPDX-License-Identifier: GPL-3.0-or-later 6# SPDX-License-Identifier: GPL-3.0-or-later
17# 17#
18# You should have received a copy of the GNU General Public License 18# You should have received a copy of the GNU General Public License
19# along with this program. If not, see <https://www.gnu.org/licenses/>. 19# along with this program. If not, see <https://www.gnu.org/licenses/>.
20# 20#
21 21
22use 5.014; # numerous features 22use 5.016; # numerous features need 5.14, __SUB__ needs 5.16
23 23
24our $VERSION = '1.0'; 24our $VERSION = '1.2';
25our $JSON_VERSION = 1; # the versiobn of the json objects generated by this program 25our $JSON_VERSION = 2; # the version of the json objects generated by this program
26
27our $CHANGELOG = <<EOF;
281.2 Fri Aug 16 00:20:41 CEST 2019
29 - bcde element names now depend on the bcd object type they are in,
30 also affects "elements" output.
31 - json schema bumped to 2.
32 - new version command.
33 - numerous minor bugfixes.
34
35EOF
26 36
27=head1 NAME 37=head1 NAME
28 38
29 pbcdedit - portable boot configuration data (BCD) store editor 39 pbcdedit - portable boot configuration data (BCD) store editor
30 40
31=head1 SYNOPSIS 41=head1 SYNOPSIS
32 42
33 pbcdedit help # output manual page 43 pbcdedit help # output manual page
44 pbcdedit version # output version and changelog
45
34 pbcdedit export path/to/BCD # output BCD hive as JSON 46 pbcdedit export path/to/BCD # output BCD hive as JSON
35 pbcdedit import path/to/bcd # convert standard input to BCD hive 47 pbcdedit import path/to/BCD # convert standard input to BCD hive
36 pbcdedit edit path/to/BCD edit-instructions... 48 pbcdedit edit path/to/BCD edit-instructions...
37 49
38 pbcdedit objects # list all supported object aliases and types 50 pbcdedit objects # list all supported object aliases and types
39 pbcdedit elements # list all supported bcd element aliases 51 pbcdedit elements # list all supported bcd element aliases
40 52
41=head1 DESCRIPTION 53=head1 DESCRIPTION
42 54
43This program allows you to create, read and modify Boot Configuration Data 55This program allows you to create, read and modify Boot Configuration Data
44(BCD) stores used by Windows Vista and newer versions of Windows. 56(BCD) stores used by Windows Vista and newer versions of Windows.
45 57
58At this point, it is in relatively early stages of development and has
59received little to no real-world testing.
60
46Compared to other BCD editing programs it offers the following unique 61Compared to other BCD editing programs it offers the following unique
47features: 62features:
48 63
49=over 64=over
50 65
55 70
56=item Does not rely on Windows 71=item Does not rely on Windows
57 72
58As the "portable" in the name implies, this program does not rely on 73As the "portable" in the name implies, this program does not rely on
59C<bcdedit> or other windows programs or libraries, it works on any system 74C<bcdedit> or other windows programs or libraries, it works on any system
60that supports at least perl version 5.14. 75that supports at least perl version 5.16.
61 76
62=item Decodes and encodes BCD device elements 77=item Decodes and encodes BCD device elements
63 78
64PBCDEDIT can concisely decode and encode BCD device element contents. This 79PBCDEDIT can concisely decode and encode BCD device element contents. This
65is pretty unique, and offers a lot of potential that can't be realised 80is pretty unique, and offers a lot of potential that can't be realised
72sensitive data. 87sensitive data.
73 88
74=back 89=back
75 90
76The target audience for this program is professionals and tinkerers who 91The target audience for this program is professionals and tinkerers who
77are rewady to invest time into learning how it works. It is not an easy 92are ready to invest time into learning how it works. It is not an easy
78program to use and requires patience and a good understanding of BCD data 93program to use and requires patience and a good understanding of BCD
79stores. 94stores.
80 95
81 96
82=head1 SUBCOMMANDS 97=head1 SUBCOMMANDS
83 98
84PCBEDIT expects a subcommand as first argument that tells it what to 99PBCDEDIT expects a subcommand as first argument that tells it what to
85do. The following subcommands exist: 100do. The following subcommands exist:
86 101
87=over 102=over
88 103
89=item help 104=item C<help>
90 105
91Displays the whole manuale page (this document). 106Displays the whole manual page (this document).
92 107
108=item C<version>
109
110This outputs the PBCDEDIT version, the JSON schema version it uses and the
111full log of changes.
112
93=item export F<path> 113=item C<export> F<path>
94 114
95Reads a BCD data store and writes a JSON representation of it to standard 115Reads a BCD data store and writes a JSON representation of it to standard
96output. 116output.
97 117
98The format of the data is explained later in this document. 118The format of the data is explained later in this document.
99 119
100Example: read a BCD store, modify it wiht an extenral program, write it again. 120Example: read a BCD store, modify it with an external program, write it
121again.
101 122
102 pbcdedit export BCD | modify-json-somehow | pbcdedit import BCD 123 pbcdedit export BCD | modify-json-somehow | pbcdedit import BCD
103 124
104=item import F<path> 125=item C<import> F<path>
105 126
106The reverse of C<export>: Reads a JSON representation of a BCD data store 127The reverse of C<export>: Reads a JSON representation of a BCD data store
107from standard input, and creates or replaces the given BCD data store. 128from standard input, and creates or replaces the given BCD data store.
108 129
109=item edit F<path> instructions... 130=item C<edit> F<path> I<instructions...>
110 131
111#TODO 132Load a BCD data store, apply some instructions to it, and save it again.
112 133
134See the section L<EDITING BCD STORES>, below, for more info.
135
136=item C<parse> F<path> I<instructions...>
137
138Same as C<edit>, above, except it doesn't save the data store again. Can
139be useful to extract some data from it.
140
113=item lsblk 141=item C<lsblk>
114 142
115On a GNU/Linux system, you can get a list of partition device descriptors 143On a GNU/Linux system, you can get a list of partition device descriptors
116using this command - the external C<lsblk> command is required, as well as 144using this command - the external C<lsblk> command is required, as well as
117a mounted C</sys> file system. 145a mounted C</sys> file system.
118 146
119The output will be a list of all partitions in the system and C<partition> 147The output will be a list of all partitions in the system and C<partition>
120descriptors for GPT and both C<legacypartition> and C<partition> 148descriptors for GPT and both C<legacypartition> and C<partition>
121descritpors for MBR partitions. 149descriptors for MBR partitions.
122 150
123=item objects [--json] 151=item C<objects> [C<--json>]
124 152
125Outputs two tables: a table listing all type aliases with their hex bcd 153Outputs two tables: a table listing all type aliases with their hex BCD
126element ID, and all object name aliases with their GUID and default type 154element ID, and all object name aliases with their GUID and default type
127(if any). 155(if any).
128 156
129With C<--json> it prints similar information as a JSON object, for easier parsing. 157With C<--json> it prints similar information as a JSON object, for easier parsing.
130 158
131=item elements [--json] 159=item C<elements> [C<--json>]
132 160
133Outputs a table of known element aliases with their hex ID and the format 161Outputs a table of known element aliases with their hex ID and the format
134type. 162type.
135 163
136With C<--json> it prints similar information as a JSON object, for easier parsing. 164With C<--json> it prints similar information as a JSON object, for easier parsing.
137 165
138=item export-regf F<path> 166=item C<export-regf> F<path>
139 167
140This has nothing to do with BCD data stores - it takes a registry hive 168This has nothing to do with BCD stores, but simply exposes PCBEDIT's
169internal registry hive reader - it takes a registry hive file as argument
141file as argument and outputs a JSON representation of it to standard 170and outputs a JSON representation of it to standard output.
142output.
143 171
144Hive versions 1.2 till 1.6 are supported. 172Hive versions 1.2 till 1.6 are supported.
145 173
146=item import-regf F<path> 174=item C<import-regf> F<path>
147 175
148The reverse of C<export-regf>: reads a JSON representation of a registry 176The reverse of C<export-regf>: reads a JSON representation of a registry
149hive from standard input and creates or replaces the registry hive file given as 177hive from standard input and creates or replaces the registry hive file
150argument. 178given as argument.
151 179
152The written hive will always be in a slightly modified version 1.3 180The written hive will always be in a slightly modified version 1.3
153format. It's not the format windows would generate, but it should be 181format. It's not the format windows would generate, but it should be
154understood by any conformant hive reader. 182understood by any conformant hive reader.
155 183
156Note that the representation chosen by PBCDEDIT currently throws away 184Note that the representation chosen by PBCDEDIT currently throws away
157clasname data (often used for feeble attemtps at hiding stuff by 185classname data (often used for feeble attempts at hiding stuff by
158Microsoft) and security descriptors, so if you write anything other than 186Microsoft) and security descriptors, so if you write anything other than
159a BCD hive you will most likely destroy it. 187a BCD hive you will most likely destroy it.
160 188
161=back 189=back
162 190
163 191
164=head1 BCD DATA STORE REPRESENTATION FORMAT 192=head1 BCD STORE REPRESENTATION FORMAT
165 193
166A BCD data store is represented as a JSON object with one special key, 194A BCD data store is represented as a JSON object with one special key,
167C<meta>, and one key per BCD object. That is, each BCD object becomes 195C<meta>, and one key per BCD object. That is, each BCD object becomes
168one key-value pair in the object, and an additional key called C<meta> 196one key-value pair in the object, and an additional key called C<meta>
169contains meta information. 197contains meta information.
202 "hypervisordebugtype" : 0 230 "hypervisordebugtype" : 0
203 }, 231 },
204 # ... 232 # ...
205 } 233 }
206 234
235=head2 Minimal BCD to boot windows
236
237Experimentally I found the following BCD is the minimum required to
238successfully boot any post-XP version of Windows (assuming suitable
239C<device> and C<osdevice> values, of course, and assuming a BIOS boot -
240for UEFI, you should use F<winload.efi> instead of F<winload.exe>):
241
242 {
243 "{bootmgr}" : {
244 "default" : "{45b547a7-8ca6-4417-9eb0-a257b61f35b4}"
245 },
246
247 "{45b547a7-8ca6-4417-9eb0-a257b61f35b1}" : {
248 "type" : "application::osloader",
249 "description" : "Windows Boot",
250 "device" : "legacypartition=<null>,harddisk,mbr,47cbc08a,1",
251 "osdevice" : "legacypartition=<null>,harddisk,mbr,47cbc08a,1",
252 "path" : "\\Windows\\system32\\winload.exe",
253 "systemroot" : "\\Windows"
254 },
255 }
256
257Note that minimal doesn't mean recommended - Windows itself will add stuff
258to this during or after boot, and you might or might not run into issues
259when installing updates as it might not be able to find the F<bootmgr>.
260
207=head2 The C<meta> key 261=head2 The C<meta> key
208 262
209The C<meta> key is not stored in the BCD data store but is used only 263The C<meta> key is not stored in the BCD data store but is used only
210by PBCDEDIT. It is always generated when exporting, and importing will 264by PBCDEDIT. It is always generated when exporting, and importing will
211be refused when it exists and the version stored inside doesn't store 265be refused when it exists and the version stored inside doesn't store
212the JSON schema version of PBCDEDIT. This ensures that differemt and 266the JSON schema version of PBCDEDIT. This ensures that different and
213incompatible versions of PBCDEDIT will not read and misinterΓΌret each 267incompatible versions of PBCDEDIT will not read and misinterpret each
214others data. 268others data.
215 269
216=head2 The object keys 270=head2 The object keys
217 271
218Every other key is a BCD object. There is usually a BCD object for the 272Every other key is a BCD object. There is usually a BCD object for the
219boot manager, one for every boot option and a few others that store common 273boot manager, one for every boot option and a few others that store common
220settings inherited by these. 274settings inherited by these.
221 275
222Each BCD object is represented by a GUID wrapped in curly braces. These 276Each BCD object is represented by a GUID wrapped in curly braces. These
223are usually random GUIDs used only to distinguish bCD objects from each 277are usually random GUIDs used only to distinguish BCD objects from each
224other. When adding a new boot option, you can simply generate a new GUID. 278other. When adding a new boot option, you can simply generate a new GUID.
225 279
226Some of these GUIDs are fixed well known GUIDs which PBCDEDIT will decode 280Some of these GUIDs are fixed well known GUIDs which PBCDEDIT will decode
227into human-readable strings such as C<{globalsettings}>, which is the same 281into human-readable strings such as C<{globalsettings}>, which is the same
228as C<{7ea2e1ac-2e61-4728-aaa3-896d9d0a9f0e}>. 282as C<{7ea2e1ac-2e61-4728-aaa3-896d9d0a9f0e}>.
262get a list of all BCD elements known to PBCDEDIT by running F<pbcdedit 316get a list of all BCD elements known to PBCDEDIT by running F<pbcdedit
263elements>. 317elements>.
264 318
265What was said about duplicate keys mapping to the same object is true for 319What was said about duplicate keys mapping to the same object is true for
266elements as well, so, again, you should always use the canonical name, 320elements as well, so, again, you should always use the canonical name,
267whcih is the human radable alias, if known. 321which is the human readable alias, if known.
268 322
269=head3 BCD element types 323=head3 BCD element types
270 324
271Each BCD element has a type such as I<string> or I<boolean>. This type 325Each BCD element has a type such as I<string> or I<boolean>. This type
272determines how the value is interpreted, and most of them are pretty easy 326determines how the value is interpreted, and most of them are pretty easy
284 "description" : "Windows 10", 338 "description" : "Windows 10",
285 "systemroot" : "\\Windows", 339 "systemroot" : "\\Windows",
286 340
287=item boolean 341=item boolean
288 342
289Almost as simnple are booleans, which represent I<true>/I<false>, 343Almost as simple are booleans, which represent I<true>/I<false>,
290I<on>/I<off> and similar values. In the JSON form, true is represented 344I<on>/I<off> and similar values. In the JSON form, true is represented
291by the number C<1>, and false is represented by the number C<0>. Other 345by the number C<1>, and false is represented by the number C<0>. Other
292values will be accepted, but PBCDEDIT doesn't guarantee how these are 346values will be accepted, but PBCDEDIT doesn't guarantee how these are
293interpreted. 347interpreted.
294 348
300 354
301=item integer 355=item integer
302 356
303Again, very simple, this is a 64 bit integer. IT can be either specified 357Again, very simple, this is a 64 bit integer. IT can be either specified
304as a decimal number, as a hex number (by prefixing it with C<0x>) or as a 358as a decimal number, as a hex number (by prefixing it with C<0x>) or as a
305binatry number (prefix C<0b>). 359binary number (prefix C<0b>).
306 360
307For example, the boot C<timeout> is an integer, specifying the automatic 361For example, the boot C<timeout> is an integer, specifying the automatic
308boot delay in seconds: 362boot delay in seconds:
309 363
310 "timeout" : 30, 364 "timeout" : 30,
311 365
312=item integer list 366=item integer list
313 367
314This is a list of 64 bit integers separated by whitespace. It is not used 368This is a list of 64 bit integers separated by whitespace. It is not used
315much, so here is a somewhat artificial an untested exanmple of using 369much, so here is a somewhat artificial an untested example of using
316C<customactions> to specify a certain custom, eh, action to be executed 370C<customactions> to specify a certain custom, eh, action to be executed
317when pressing C<F10> at boot: 371when pressing C<F10> at boot:
318 372
319 "customactions" : "0x1000044000001 0x54000001", 373 "customactions" : "0x1000044000001 0x54000001",
320 374
321=item guid 375=item guid
322 376
323This represents a single GUID value wrqapped in curly braces. It is used a 377This represents a single GUID value wrapped in curly braces. It is used a
324lot to refer from one BCD object to other one. 378lot to refer from one BCD object to other one.
325 379
326For example, The C<{bootmgr}> object might refer to a resume boot option 380For example, The C<{bootmgr}> object might refer to a resume boot option
327using C<resumeobject>: 381using C<default>:
328 382
329 "resumeobject" : "{7ae02178-821d-11e7-8813-1c872c5f5ab0}", 383 "default" : "{7ae02178-821d-11e7-8813-1c872c5f5ab0}",
330 384
331Human readable aliases are used and allowed. 385Human readable aliases are used and allowed.
332 386
333=item guid list 387=item guid list
334 388
335Similar to te guid type, this represents a list of such GUIDs, separated 389Similar to the GUID type, this represents a list of such GUIDs, separated
336by whitespace from each other. 390by whitespace from each other.
337 391
338For example, many BCD objects can I<inherit> elements from other BCD 392For example, many BCD objects can I<inherit> elements from other BCD
339objects by specifying the GUIDs of those other objects ina GUID list 393objects by specifying the GUIDs of those other objects in a GUID list
340called surprisingly called C<inherit>: 394called surprisingly called C<inherit>:
341 395
342 "inherit" : "{dbgsettings} {emssettings} {badmemory}", 396 "inherit" : "{dbgsettings} {emssettings} {badmemory}",
343 397
344This example also shows how human readable aliases can be used. 398This example also shows how human readable aliases can be used.
353=back 407=back
354 408
355=head4 The BCD "device" element type 409=head4 The BCD "device" element type
356 410
357Device elements specify, well, devices. They are used for such diverse 411Device elements specify, well, devices. They are used for such diverse
358purposes such as finding a TFTP network boot imagem serial ports or VMBUS 412purposes such as finding a TFTP network boot image, serial ports or VMBUS
359devices, but most commonly they are used to specify the disk (harddisk, 413devices, but most commonly they are used to specify the disk (harddisk,
360cdrom ramdisk, vhd...) to boot from. 414cdrom, ramdisk, vhd...) to boot from.
361 415
362The device element is kind of a mini-language in its own which is much 416The device element is kind of a mini-language in its own which is much
363more versatile then the limited windows interface to it - BCDEDIT - 417more versatile then the limited windows interface to it - BCDEDIT -
364reveals. 418reveals.
365 419
368element, so almost everything known about it had to be researched first 422element, so almost everything known about it had to be researched first
369in the process of writing this script, and consequently, support for BCD 423in the process of writing this script, and consequently, support for BCD
370device elements is partial only. 424device elements is partial only.
371 425
372On the other hand, the expressive power of PBCDEDIT in specifying devices 426On the other hand, the expressive power of PBCDEDIT in specifying devices
373is much bigger than BCDEDIT and therefore more cna be don with it. The 427is much bigger than BCDEDIT and therefore more can be done with it. The
374downside is that BCD device elements are much more complicated than what 428downside is that BCD device elements are much more complicated than what
375you might think from reading the BCDEDIT documentation. 429you might think from reading the BCDEDIT documentation.
376 430
377In other words, simple things are complicated, and complicated things are 431In other words, simple things are complicated, and complicated things are
378possible. 432possible.
379 433
380Anyway, the general syntax of device elements is an optional GUID, 434Anyway, the general syntax of device elements is an optional GUID,
381followed by a device type, optionally followed by hexdecimal flags in 435followed by a device type, optionally followed by hexadecimal flags in
382angle brackets, optionally followed by C<=> and a comma-separated list of 436angle brackets, optionally followed by C<=> and a comma-separated list of
383arguments, some of which can be (and often are) in turn devices again. 437arguments, some of which can be (and often are) in turn devices again.
384 438
385 [{GUID}]type[<flags>][=arg,arg...] 439 [{GUID}]type[<flags>][=arg,arg...]
386 440
412The types understood and used by PBCDEDIT are as follows (keep in mind 466The types understood and used by PBCDEDIT are as follows (keep in mind
413that not of all the following is necessarily supported in PBCDEDIT): 467that not of all the following is necessarily supported in PBCDEDIT):
414 468
415=over 469=over
416 470
417=item binary=hex... 471=item C<binary=>I<hex...>
418 472
419This type isn't actually a real BCD element type, but a fallback for those 473This type isn't actually a real BCD element type, but a fallback for those
420cases where PBCDEDIT can't perfectly decode a device element (except for 474cases where PBCDEDIT can't perfectly decode a device element (except for
421the leading GUID, which it can always decode). In such cases, it will 475the leading GUID, which it can always decode). In such cases, it will
422convert the device into this type with a hexdump of the element data. 476convert the device into this type with a hexdump of the element data.
423 477
424=item null 478=item C<null>
425 479
426This is another special type - sometimes, a device all zero-filled, which 480This is another special type - sometimes, a device all zero-filled, which
427is not valid. This can mark the absence of a device or something PBCDEDIT 481is not valid. This can mark the absence of a device or something PBCDEDIT
428does not understand, so it decodes it into this special "all zero" type 482does not understand, so it decodes it into this special "all zero" type
429called C<null>. 483called C<null>.
430 484
431It's most commonly found in devices that can use an optional parent 485It's most commonly found in devices that can use an optional parent
432device, when no parent device is used. 486device, when no parent device is used.
433 487
434=item boot 488=item C<boot>
435 489
436Another type without parameters, this refers to the device that was booted 490Another type without parameters, this refers to the device that was booted
437from (nowadays typically the EFI system partition). 491from (nowadays typically the EFI system partition).
438 492
439=item vmbus=interfacetype,interfaceinstance 493=item C<vmbus=>I<interfacetype>,I<interfaceinstance>
440 494
441This specifies a VMBUS device with the given interface type and interface 495This specifies a VMBUS device with the given interface type and interface
442instance, both of which are "naked" (no curly braces) GUIDs. 496instance, both of which are "naked" (no curly braces) GUIDs.
443 497
444Made-up example (couldn't find a single example on the web): 498Made-up example (couldn't find a single example on the web):
445 499
446 vmbus=c376c1c3-d276-48d2-90a9-c04748072c60,12345678-a234-b234-c234-d2345678abcd 500 vmbus=c376c1c3-d276-48d2-90a9-c04748072c60,12345678-a234-b234-c234-d2345678abcd
447 501
448=item partition=<parent>,devicetype,partitiontype,diskid,partitionid 502=item C<partition=><I<parent>>,I<devicetype>,I<partitiontype>,I<diskid>,I<partitionid>
449 503
450This designates a specific partition on a block device. C<< <parent> 504This designates a specific partition on a block device. I<parent> is an
451>> is an optional parent device on which to search on, and is often 505optional parent device on which to search on, and is often C<null>. Note
452C<null>. Note that the anfgle brackets are part of the syntax. 506that the angle brackets around I<parent> are part of the syntax.
453 507
454C<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>, 508I<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>,
455C<file> or C<vhd>, where the first three should be self-explaining, 509C<file> or C<vhd>, where the first three should be self-explaining,
456C<file> is usually used to locate a device by finding a magic file, and 510C<file> is usually used to locate a file to be used as a disk image,
457C<vhd> is used for virtual harddisks - F<.vhd> and F<-vhdx> files. 511and C<vhd> is used to treat files as virtual harddisks, i.e. F<vhd> and
512F<vhdx> files.
458 513
459The C<partitiontype> is either C<mbr>, C<gpt> or C<raw>, the latter being 514The I<partitiontype> is either C<mbr>, C<gpt> or C<raw>, the latter being
460used for devices without partitions, such as cdroms, where the "partition" 515used for devices without partitions, such as cdroms, where the "partition"
461is usually the whole device. 516is usually the whole device.
462 517
463The C<diskid> identifies the disk or device using a unique signature, and 518The I<diskid> identifies the disk or device using a unique signature, and
464the same is true for the C<partitionid>. How these are interpreted depends 519the same is true for the I<partitionid>. How these are interpreted depends
465on the C<partitiontype>: 520on the I<partitiontype>:
466 521
467=over 522=over
468 523
469=item mbr 524=item C<mbr>
470 525
471The C<diskid> is the 32 bit disk signature stored at offset 0x1b8 in the 526The C<diskid> is the 32 bit disk signature stored at offset 0x1b8 in the
472MBR, interpreted as a 32 bit unsigned little endian integer and written as 527MBR, interpreted as a 32 bit unsigned little endian integer and written as
473hex number. That is, the bytes C<01 02 03 04> would become C<04030201>. 528hex number. That is, the bytes C<01 02 03 04> would become C<04030201>.
474 529
475Diskpart (using the C<DETAIL> command) and the C<lsblk> comamnd typically 530Diskpart (using the C<DETAIL> command) and the C<lsblk> command typically
476found on GNU/Linux systems (using e.g. C<lsblk -o NAME,PARTUUID>) can 531found on GNU/Linux systems (using e.g. C<lsblk -o NAME,PARTUUID>) can
477display the disk id. 532display the I<diskid>.
478 533
479The C<partitionid> is the byte offset(!) of the partition counting from 534The I<partitionid> is the byte offset(!) of the partition counting from
480the beginning of the MBR. 535the beginning of the MBR.
481 536
482Example, use the partition on the harddisk with C<diskid> C<47cbc08a> 537Example, use the partition on the harddisk with I<diskid> C<47cbc08a>
483starting at sector C<2048> (= 1048576 / 512). 538starting at sector C<2048> (= 1048576 / 512).
484 539
485 partition=<null>,harddisk,mbr,47cbc08a,1048576 540 partition=<null>,harddisk,mbr,47cbc08a,1048576
486 541
487=item gpt 542=item C<gpt>
488 543
489The C<diskid> is the disk UUID/disk identifier GUID from the partition 544The I<diskid> is the disk GUID/disk identifier GUID from the partition
490table (as displayed e.g. by C<gdisk>), and the C<partitionid> is the 545table (as displayed e.g. by F<gdisk>), and the I<partitionid> is the
491partition unique GUID (displayed using e.g. the C<gdisk> C<i> command). 546partition unique GUID (displayed using e.g. the F<gdisk> F<i> command).
492 547
493Example: use the partition C<76d39e5f-ad1b-407e-9c05-c81eb83b57dd> on GPT 548Example: use the partition C<76d39e5f-ad1b-407e-9c05-c81eb83b57dd> on GPT
494disk C<9742e468-9206-48a0-b4e4-c4e9745a356a>. 549disk C<9742e468-9206-48a0-b4e4-c4e9745a356a>.
495 550
496 partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,76d39e5f-ad1b-407e-9c05-c81eb83b57dd 551 partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,76d39e5f-ad1b-407e-9c05-c81eb83b57dd
497 552
498=item raw 553=item C<raw>
499 554
500Instead of diskid and partitionid, this type only accepts a decimal disk 555Instead of I<diskid> and I<partitionid>, this type only accepts a decimal
501number and signifies the whole disk. BCDEDIT cannot display the resulting 556disk number and signifies the whole disk. BCDEDIT cannot display the
502device, and I am doubtful whether it has a useful effect. 557resulting device, and I am doubtful whether it has a useful effect.
503 558
504=back 559=back
505 560
506=item legacypartition=<parent>,devicetype,partitiontype,diskid,partitionid 561=item C<legacypartition=><I<parent>>,I<devicetype>,I<partitiontype>,I<diskid>,I<partitionid>
507 562
508This is exactly the same as the C<partition> type, except for a tiny 563This is exactly the same as the C<partition> type, except for a tiny
509detail: instead of using the partition start offset, this type uses the 564detail: instead of using the partition start offset, this type uses the
510partition number for MBR disks. Behaviour other partition types should be 565partition number for MBR disks. Behaviour other partition types should be
511the same. 566the same.
512 567
513The partition number starts at C<1> and skips unused partition, so if 568The partition number starts at C<1> and skips unused partition, so if
514there are two primary partitions and another partition inside the extended 569there are two primary partitions and another partition inside the extended
515partition, the primary partitions are number C<1> and C<2> and the 570partition, the primary partitions are number C<1> and C<2> and the
516partition inside the extended partition is number C<3>, rwegardless of any 571partition inside the extended partition is number C<3>, regardless of any
517gaps. 572gaps.
518 573
519=item locate=<parent>,locatetype,locatearg 574=item C<locate=><I<parent>>,I<locatetype>,I<locatearg>
520 575
521This device description will make the bootloader search for a partition 576This device description will make the bootloader search for a partition
522with a given path. 577with a given path.
523 578
524The C<< <parent> >> device is the device to search on (angle brackets are 579The I<parent> device is the device to search on (angle brackets are
525still part of the syntax!) If it is C<< <null> >>, then C<locate> will 580still part of the syntax!) If it is C<null>, then C<locate> will
526search all disks it can find. 581search all disks it can find.
527 582
528C<locatetype> is either C<element> or C<path>, and merely distinguishes 583I<locatetype> is either C<element> or C<path>, and merely distinguishes
529between two different ways to specify the path to search for: C<element> 584between two different ways to specify the path to search for: C<element>
530uses an element ID (either as hex or as name) as C<locatearg> and C<path> 585uses an element ID (either as hex or as name) as I<locatearg> and C<path>
531uses a relative path as C<locatearg>. 586uses a relative path as I<locatearg>.
532 587
533Example: find any partition which has the C<magicfile.xxx> path in the 588Example: find any partition which has the F<magicfile.xxx> path in the
534root. 589root.
535 590
536 locate=<null>,path,\magicfile.xxx 591 locate=<null>,path,\magicfile.xxx
537 592
538Example: find any partition which has the path specified in the 593Example: find any partition which has the path specified in the
539C<systemroot> element (typically C<\Windows>). 594C<systemroot> element (typically F<\Windows>).
540 595
541 locate=<null>,element,systemroot 596 locate=<null>,element,systemroot
542 597
543=item block=devicetype,args... 598=item C<block=>I<devicetype>,I<args...>
544 599
545Last not least, the most complex type, C<block>, which... specifies block 600Last not least, the most complex type, C<block>, which... specifies block
546devices (which could be inside a F<vhdx> file for example). 601devices (which could be inside a F<vhdx> file for example).
547 602
548C<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>, 603I<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>,
549C<file> or C<vhd> - the same as for C<partiion=>. 604C<file> or C<vhd> - the same as for C<partiion=>.
550 605
551The remaining arguments change depending on the C<devicetype>: 606The remaining arguments change depending on the I<devicetype>:
552 607
553=over 608=over
554 609
555=item block=file,<parent>,path 610=item C<block=file>,<I<parent>>,I<path>
556 611
557Interprets the C<< <parent> >> device (typically a partition) as a 612Interprets the I<parent> device (typically a partition) as a
558filesystem and specifies a file path inside. 613filesystem and specifies a file path inside.
559 614
560=item block=vhd,<parent> 615=item C<block=vhd>,<I<parent>>
561 616
562Pretty much just changes the interpretation of C<< <parent> >>, which is 617Pretty much just changes the interpretation of I<parent>, which is
563usually a disk image (C<block=file,...)>) to be a F<vhd> or F<vhdx> file. 618usually a disk image (C<block=file,...)>) to be a F<vhd> or F<vhdx> file.
564 619
565=item block=ramdisk,<parent>,base,size,offset,path 620=item C<block=ramdisk>,<I<parent>>,I<base>,I<size>,I<offset>,I<path>
566 621
567Interprets the C<< <parent> >> device as RAM disk, using the (decimal) 622Interprets the I<parent> device as RAM disk, using the (decimal)
568base address, byte size and byte offset inside a file specified by 623base address, byte size and byte offset inside a file specified by
569C<path>. The numbers are usually all C<0> because they cna be extracted 624I<path>. The numbers are usually all C<0> because they can be extracted
570from the RAM disk image or other parameters. 625from the RAM disk image or other parameters.
571 626
572This is most commonly used to boot C<wim> images. 627This is most commonly used to boot C<wim> images.
573 628
574=item block=floppy,drivenum 629=item C<block=floppy>,I<drivenum>
575 630
576Refers to a removable drive identified by a number. BCDEDIT cannot display 631Refers to a removable drive identified by a number. BCDEDIT cannot display
577the resultinfg device, and it is not clear what effect it will have. 632the resulting device, and it is not clear what effect it will have.
578 633
579=item block=cdrom,drivenum 634=item C<block=cdrom>,I<drivenum>
580 635
581Pretty much the same as C<floppy> but for CD-ROMs. 636Pretty much the same as C<floppy> but for CD-ROMs.
582 637
583=item anything else 638=item anything else
584 639
588 643
589=back5 Examples 644=back5 Examples
590 645
591This concludes the syntax overview for device elements, but probably 646This concludes the syntax overview for device elements, but probably
592leaves many questions open. I can't help with most of them, as I also ave 647leaves many questions open. I can't help with most of them, as I also ave
593many questions, but I can walk you through some actual examples using mroe 648many questions, but I can walk you through some actual examples using more
594complex aspects. 649complex aspects.
595 650
596=item locate=<block=vhd,<block=file,<locate=<null>,path,\disk.vhdx>,\disk.vhdx>>,element,path 651=item C<< locate=<block=vhd,<block=file,<locate=<null>,path,\disk.vhdx>,\disk.vhdx>>,element,path >>
597 652
598#todo 653Just like with C declarations, you best treat device descriptors as
654instructions to find your device and work your way from the inside out:
599 655
656 locate=<null>,path,\disk.vhdx
657
658First, the innermost device descriptor searches all partitions on the
659system for a file called F<\disk.vhdx>:
660
661 block=file,<see above>,\disk.vhdx
662
663Next, this takes the device locate has found and finds a file called
664F<\disk.vhdx> on it. This is the same file locate was using, but that is
665only because we find the device using the same path as finding the disk
666image, so this is purely incidental, although quite common.
667
668Next, this file will be opened as a virtual disk:
669
670 block=vhd,<see above>
671
672And finally, inside this disk, another C<locate> will look for a partition
673with a path as specified in the C<path> element, which most likely will be
674F<\Windows\system32\winload.exe>:
675
676 locate=<see above>,element,path
677
678As a result, this will boot the first Windows it finds on the first
679F<disk.vhdx> disk image it can find anywhere.
680
600=item locate=<block=vhd,<block=file,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,\win10.vhdx>>,element,path 681=item C<< locate=<block=vhd,<block=file,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,\win10.vhdx>>,element,path >>
601 682
602#todo 683Pretty much the same as the previous case, but with a bit of
684variance. First, look for a specific partition on an MBR-partitioned disk:
603 685
686 partition=<null>,harddisk,mbr,47cbc08a,242643632128
687
688Then open the file F<\win10.vhdx> on that partition:
689
690 block=file,<see above>,\win10.vhdx
691
692Then, again, the file is opened as a virtual disk image:
693
694 block=vhd,<see above>
695
696And again the windows loader (or whatever is in C<path>) will be searched:
697
698 locate=<see above>,element,path
699
604=item {b097d2b2-bc00-11e9-8a9a-525400123456}block<1>=ramdisk,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,0,0,0,\boot.wim 700=item C<< {b097d2b2-bc00-11e9-8a9a-525400123456}block<1>=ramdisk,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,0,0,0,\boot.wim >>
605 701
606#todo 702This is quite different. First, it starts with a GUID. This GUID belongs
703to a BCD object of type C<device>, which has additional parameters:
704
705 "{b097d2b2-bc00-11e9-8a9a-525400123456}" : {
706 "type" : "device",
707 "description" : "sdi file for ramdisk",
708 "ramdisksdidevice" : "partition=<null>,harddisk,mbr,47cbc08a,1048576",
709 "ramdisksdipath" : "\boot.sdi"
710 },
711
712I will not go into many details, but this specifies a (presumably empty)
713template ramdisk image (F<\boot.sdi>) that is used to initialize the
714ramdisk. The F<\boot.wim> file is then extracted into it. As you can also
715see, this F<.sdi> file resides on a different C<partition>.
716
717Continuing, as always, from the inside out, first this device descriptor
718finds a specific partition:
719
720 partition=<null>,harddisk,mbr,47cbc08a,242643632128
721
722And then specifies a C<ramdisk> image on this partition:
723
724 block<1>=ramdisk,<see above>,0,0,0,\boot.wim
725
726I don't know what the purpose of the C<< <1> >> flag value is, but it
727seems to be always there on this kind of entry.
728
729If you have some good examples to add here, feel free to mail me.
730
731
732=head1 EDITING BCD STORES
733
734The C<edit> and C<parse> subcommands allow you to read a BCD data store
735and modify it or extract data from it. This is done by executing a series
736of "editing instructions" which are explained here.
737
738=over
739
740=item C<get> I<object> I<element>
741
742Reads the BCD element I<element> from the BCD object I<object> and writes
743it to standard output, followed by a newline. The I<object> can be a GUID
744or a human-readable alias, or the special string C<{default}>, which will
745refer to the default BCD object.
746
747Example: find description of the default BCD object.
748
749 pbcdedit parse BCD get "{default}" description
750
751=item C<set> I<object> I<element> I<value>
752
753Similar to C<get>, but sets the element to the given I<value> instead.
754
755Example: change the bootmgr default too
756C<{b097d2ad-bc00-11e9-8a9a-525400123456}>:
757
758 pbcdedit edit BCD set "{bootmgr}" default "{b097d2ad-bc00-11e9-8a9a-525400123456}"
759
760=item C<eval> I<perlcode>
761
762This takes the next argument, interprets it as Perl code and
763evaluates it. This allows you to do more complicated modifications or
764extractions.
765
766The following variables are predefined for your use:
767
768=over
769
770=item C<$PATH>
771
772The path to the BCD data store, as given to C<edit> or C<parse>.
773
774=item C<$BCD>
775
776The decoded BCD data store.
777
778=item C<$DEFAULT>
779
780The default BCD object name.
781
782=back
783
784The example given for C<get>, above, could be expressed like this with
785C<eval>:
786
787 pbcdedit edit BCD eval 'say $BCD->{$DEFAULT}{description}'
788
789The example given for C<set> could be expressed like this:
790
791 pbcdedit edit BCD eval '$BCD->{"{bootmgr}"{default} = "{b097d2ad-bc00-11e9-8a9a-525400123456}"'
792
793=item C<do> I<path>
794
795Similar to C<eval>, above, but instead of using the argument as perl code,
796it loads the perl code from the given file and executes it. This makes it
797easier to write more complicated or larger programs.
798
799=back
607 800
608 801
609=head1 SEE ALSO 802=head1 SEE ALSO
610 803
611For ideas on what you can do, and some introductory material, try 804For ideas on what you can do with BCD stores in
805general, and some introductory material, try
612L<http://www.mistyprojects.co.uk/documents/BCDEdit/index.html>. 806L<http://www.mistyprojects.co.uk/documents/BCDEdit/index.html>.
613 807
614For good reference on BCD objects and elements, see Geoff Chappels pages 808For good reference on which BCD objects and
809elements exist, see Geoff Chappell's pages at
615at L<http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm>. 810L<http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm>.
616 811
617=head1 AUTHOR 812=head1 AUTHOR
618 813
619Written by Marc A. Lehmann <pbcdedit@schmorp.de>. 814Written by Marc A. Lehmann L<pbcdedit@schmorp.de>.
620 815
621=head1 REPORTING BUGS 816=head1 REPORTING BUGS
622 817
623Bugs can be reported dorectly tt he author at L<pcbedit@schmorp.de>. 818Bugs can be reported directly the author at L<pcbedit@schmorp.de>.
624 819
625=head1 BUGS AND SHORTCOMINGS 820=head1 BUGS AND SHORTCOMINGS
626 821
627This should be a module. Of a series of modules, even. 822This should be a module. Of a series of modules, even.
628 823
629Registry code should preserve classname and security descriptor data, and 824Registry code should preserve classname and security descriptor data, and
630whatever else is necessary to read and write any registry hive file. 825whatever else is necessary to read and write any registry hive file.
631 826
632I am also not happy with device descriptors being strings rather than a 827I am also not happy with device descriptors being strings rather than a
633data structure, but strings are probably better for command line usage. In 828data structure, but strings are probably better for command line usage. In
634any case,. device descriptors could be converted by simply "splitting" at 829any case, device descriptors could be converted by simply "splitting" at
635"=" and "," into an array reference, recursively. 830"=" and "," into an array reference, recursively.
636 831
637=head1 HOMEPAGE 832=head1 HOMEPAGE
638 833
639Original versions of this program can be found at 834Original versions of this program can be found at
646free to change and redistribute it. There is NO WARRANTY, to the extent 841free to change and redistribute it. There is NO WARRANTY, to the extent
647permitted by law. 842permitted by law.
648 843
649=cut 844=cut
650 845
651BEGIN { require "common/sense.pm"; common::sense->import } # common sense is optional, but recommended 846# common sense is optional, but recommended
847BEGIN { eval { require "common/sense.pm"; } && common::sense->import }
652 848
653use Data::Dump; 849no warnings 'portable'; # avoid 32 bit integer warnings
850
654use Encode (); 851use Encode ();
655use List::Util (); 852use List::Util ();
656use IO::Handle (); 853use IO::Handle ();
657use Time::HiRes (); 854use Time::HiRes ();
658 855
669sub xxd($$) { 866sub xxd($$) {
670 open my $xxd, "| xxd | sed -e 's/^/\Q$_[0]\E: /'"; 867 open my $xxd, "| xxd | sed -e 's/^/\Q$_[0]\E: /'";
671 syswrite $xxd, $_[1]; 868 syswrite $xxd, $_[1];
672} 869}
673 870
871sub file_load($) {
872 my ($path) = @_;
873
874 open my $fh, "<:raw", $path
875 or die "$path: $!\n";
876 my $size = -s $fh;
877 $size = read $fh, my $buf, $size
878 or die "$path: short read\n";
879
880 $buf
881}
882
674# sources and resources used for this: 883# sources and resources used for writing pbcdedit
884#
675# registry: 885# registry:
676# https://github.com/msuhanov/regf/blob/master/Windows%20registry%20file%20format%20specification.md 886# https://github.com/msuhanov/regf/blob/master/Windows%20registry%20file%20format%20specification.md
677# http://amnesia.gtisc.gatech.edu/~moyix/suzibandit.ltd.uk/MSc/ 887# http://amnesia.gtisc.gatech.edu/~moyix/suzibandit.ltd.uk/MSc/
678# bcd: 888# bcd:
679# http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm 889# http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm
1027} 1237}
1028 1238
1029# load and parse registry from file 1239# load and parse registry from file
1030sub regf_load($) { 1240sub regf_load($) {
1031 my ($path) = @_; 1241 my ($path) = @_;
1032 open my $regf, "<:raw", $path
1033 or die "$path: $!\n";
1034 my $size = -s $regf;
1035 $size = read $regf, my $buf, $size
1036 or die "$path: short read\n";
1037 1242
1038 regf_decode $buf 1243 regf_decode file_load $path
1039} 1244}
1040 1245
1041# encode and save registry to file 1246# encode and save registry to file
1042sub regf_save { 1247sub regf_save {
1043 my ($path, $hive) = @_; 1248 my ($path, $hive) = @_;
1172sub BCDE_FORMAT_GUID_LIST () { 0x04000000 } 1377sub BCDE_FORMAT_GUID_LIST () { 0x04000000 }
1173sub BCDE_FORMAT_INTEGER () { 0x05000000 } 1378sub BCDE_FORMAT_INTEGER () { 0x05000000 }
1174sub BCDE_FORMAT_BOOLEAN () { 0x06000000 } 1379sub BCDE_FORMAT_BOOLEAN () { 0x06000000 }
1175sub BCDE_FORMAT_INTEGER_LIST () { 0x07000000 } 1380sub BCDE_FORMAT_INTEGER_LIST () { 0x07000000 }
1176 1381
1177sub dec_device;
1178sub enc_device;
1179
1180sub enc_integer($) { 1382sub enc_integer($) {
1181 no warnings 'portable'; # ugh
1182 my $value = shift; 1383 my $value = shift;
1183 $value = oct $value if $value =~ /^0[bBxX]/; 1384 $value = oct $value if $value =~ /^0[bBxX]/;
1184 unpack "H*", pack "Q<", $value 1385 unpack "H*", pack "Q<", $value
1185} 1386}
1387
1388sub enc_device($$);
1389sub dec_device($$);
1186 1390
1187our %bcde_dec = ( 1391our %bcde_dec = (
1188 BCDE_FORMAT_DEVICE , \&dec_device, 1392 BCDE_FORMAT_DEVICE , \&dec_device,
1189# # for round-trip verification 1393# # for round-trip verification
1190# BCDE_FORMAT_DEVICE , sub { 1394# BCDE_FORMAT_DEVICE , sub {
1200 BCDE_FORMAT_BOOLEAN , sub { shift eq "00" ? 0 : 1 }, 1404 BCDE_FORMAT_BOOLEAN , sub { shift eq "00" ? 0 : 1 },
1201 BCDE_FORMAT_INTEGER_LIST, sub { join " ", unpack "Q*", pack "H*", shift }, # not sure if this cna be 4 bytes 1405 BCDE_FORMAT_INTEGER_LIST, sub { join " ", unpack "Q*", pack "H*", shift }, # not sure if this cna be 4 bytes
1202); 1406);
1203 1407
1204our %bcde_enc = ( 1408our %bcde_enc = (
1205 BCDE_FORMAT_DEVICE , sub { binary => enc_device shift }, 1409 BCDE_FORMAT_DEVICE , sub { binary => enc_device $_[0], $_[1] },
1206 BCDE_FORMAT_STRING , sub { sz => shift }, 1410 BCDE_FORMAT_STRING , sub { sz => shift },
1207 BCDE_FORMAT_GUID , sub { sz => "{" . (dec_guid enc_wguid shift) . "}" }, 1411 BCDE_FORMAT_GUID , sub { sz => "{" . (dec_guid enc_wguid shift) . "}" },
1208 BCDE_FORMAT_GUID_LIST , sub { multi_sz => [map "{" . (dec_guid enc_wguid $_) . "}", split /\s+/, shift ] }, 1412 BCDE_FORMAT_GUID_LIST , sub { multi_sz => [map "{" . (dec_guid enc_wguid $_) . "}", split /\s+/, shift ] },
1209 BCDE_FORMAT_INTEGER , sub { binary => enc_integer shift }, 1413 BCDE_FORMAT_INTEGER , sub { binary => enc_integer shift },
1210 BCDE_FORMAT_BOOLEAN , sub { binary => shift ? "01" : "00" }, 1414 BCDE_FORMAT_BOOLEAN , sub { binary => shift ? "01" : "00" },
1211 BCDE_FORMAT_INTEGER_LIST, sub { binary => join "", map enc_integer $_, split /\s+/, shift }, 1415 BCDE_FORMAT_INTEGER_LIST, sub { binary => join "", map enc_integer $_, split /\s+/, shift },
1212); 1416);
1213 1417
1214# BCD Elements 1418# BCD Elements
1215our %bcde = ( 1419our %bcde_byclass = (
1420 any => {
1216 0x11000001 => 'device', 1421 0x11000001 => 'device',
1217 0x12000002 => 'path', 1422 0x12000002 => 'path',
1218 0x12000004 => 'description', 1423 0x12000004 => 'description',
1219 0x12000005 => 'locale', 1424 0x12000005 => 'locale',
1220 0x14000006 => 'inherit', 1425 0x14000006 => 'inherit',
1221 0x15000007 => 'truncatememory', 1426 0x15000007 => 'truncatememory',
1222 0x14000008 => 'recoverysequence', 1427 0x14000008 => 'recoverysequence',
1223 0x16000009 => 'recoveryenabled', 1428 0x16000009 => 'recoveryenabled',
1224 0x1700000a => 'badmemorylist', 1429 0x1700000a => 'badmemorylist',
1225 0x1600000b => 'badmemoryaccess', 1430 0x1600000b => 'badmemoryaccess',
1226 0x1500000c => 'firstmegabytepolicy', 1431 0x1500000c => 'firstmegabytepolicy',
1227 0x1500000d => 'relocatephysical', 1432 0x1500000d => 'relocatephysical',
1228 0x1500000e => 'avoidlowmemory', 1433 0x1500000e => 'avoidlowmemory',
1229 0x1600000f => 'traditionalkseg', 1434 0x1600000f => 'traditionalkseg',
1230 0x16000010 => 'bootdebug', 1435 0x16000010 => 'bootdebug',
1231 0x15000011 => 'debugtype', 1436 0x15000011 => 'debugtype',
1232 0x15000012 => 'debugaddress', 1437 0x15000012 => 'debugaddress',
1233 0x15000013 => 'debugport', 1438 0x15000013 => 'debugport',
1234 0x15000014 => 'baudrate', 1439 0x15000014 => 'baudrate',
1235 0x15000015 => 'channel', 1440 0x15000015 => 'channel',
1236 0x12000016 => 'targetname', 1441 0x12000016 => 'targetname',
1237 0x16000017 => 'noumex', 1442 0x16000017 => 'noumex',
1238 0x15000018 => 'debugstart', 1443 0x15000018 => 'debugstart',
1239 0x12000019 => 'busparams', 1444 0x12000019 => 'busparams',
1240 0x1500001a => 'hostip', 1445 0x1500001a => 'hostip',
1241 0x1500001b => 'port', 1446 0x1500001b => 'port',
1242 0x1600001c => 'dhcp', 1447 0x1600001c => 'dhcp',
1243 0x1200001d => 'key', 1448 0x1200001d => 'key',
1244 0x1600001e => 'vm', 1449 0x1600001e => 'vm',
1245 0x16000020 => 'bootems', 1450 0x16000020 => 'bootems',
1246 0x15000022 => 'emsport', 1451 0x15000022 => 'emsport',
1247 0x15000023 => 'emsbaudrate', 1452 0x15000023 => 'emsbaudrate',
1248 0x12000030 => 'loadoptions', 1453 0x12000030 => 'loadoptions',
1249 0x16000040 => 'advancedoptions', 1454 0x16000040 => 'advancedoptions',
1250 0x16000041 => 'optionsedit', 1455 0x16000041 => 'optionsedit',
1251 0x15000042 => 'keyringaddress', 1456 0x15000042 => 'keyringaddress',
1252 0x11000043 => 'bootstatdevice', 1457 0x11000043 => 'bootstatdevice',
1253 0x12000044 => 'bootstatfilepath', 1458 0x12000044 => 'bootstatfilepath',
1254 0x16000045 => 'preservebootstat', 1459 0x16000045 => 'preservebootstat',
1255 0x16000046 => 'graphicsmodedisabled', 1460 0x16000046 => 'graphicsmodedisabled',
1256 0x15000047 => 'configaccesspolicy', 1461 0x15000047 => 'configaccesspolicy',
1257 0x16000048 => 'nointegritychecks', 1462 0x16000048 => 'nointegritychecks',
1258 0x16000049 => 'testsigning', 1463 0x16000049 => 'testsigning',
1259 0x1200004a => 'fontpath', 1464 0x1200004a => 'fontpath',
1260 0x1500004b => 'integrityservices', 1465 0x1500004b => 'integrityservices',
1261 0x1500004c => 'volumebandid', 1466 0x1500004c => 'volumebandid',
1262 0x16000050 => 'extendedinput', 1467 0x16000050 => 'extendedinput',
1263 0x15000051 => 'initialconsoleinput', 1468 0x15000051 => 'initialconsoleinput',
1264 0x15000052 => 'graphicsresolution', 1469 0x15000052 => 'graphicsresolution',
1265 0x16000053 => 'restartonfailure', 1470 0x16000053 => 'restartonfailure',
1266 0x16000054 => 'highestmode', 1471 0x16000054 => 'highestmode',
1267 0x16000060 => 'isolatedcontext', 1472 0x16000060 => 'isolatedcontext',
1268 0x15000065 => 'displaymessage', 1473 0x15000065 => 'displaymessage',
1269 0x15000066 => 'displaymessageoverride', 1474 0x15000066 => 'displaymessageoverride',
1270 0x16000068 => 'nobootuxtext', 1475 0x16000068 => 'nobootuxtext',
1271 0x16000069 => 'nobootuxprogress', 1476 0x16000069 => 'nobootuxprogress',
1272 0x1600006a => 'nobootuxfade', 1477 0x1600006a => 'nobootuxfade',
1273 0x1600006b => 'bootuxreservepooldebug', 1478 0x1600006b => 'bootuxreservepooldebug',
1274 0x1600006c => 'bootuxdisabled', 1479 0x1600006c => 'bootuxdisabled',
1275 0x1500006d => 'bootuxfadeframes', 1480 0x1500006d => 'bootuxfadeframes',
1276 0x1600006e => 'bootuxdumpstats', 1481 0x1600006e => 'bootuxdumpstats',
1277 0x1600006f => 'bootuxshowstats', 1482 0x1600006f => 'bootuxshowstats',
1278 0x16000071 => 'multibootsystem', 1483 0x16000071 => 'multibootsystem',
1279 0x16000072 => 'nokeyboard', 1484 0x16000072 => 'nokeyboard',
1280 0x15000073 => 'aliaswindowskey', 1485 0x15000073 => 'aliaswindowskey',
1281 0x16000074 => 'bootshutdowndisabled', 1486 0x16000074 => 'bootshutdowndisabled',
1282 0x15000075 => 'performancefrequency', 1487 0x15000075 => 'performancefrequency',
1283 0x15000076 => 'securebootrawpolicy', 1488 0x15000076 => 'securebootrawpolicy',
1284 0x17000077 => 'allowedinmemorysettings', 1489 0x17000077 => 'allowedinmemorysettings',
1285 0x15000079 => 'bootuxtransitiontime', 1490 0x15000079 => 'bootuxtransitiontime',
1286 0x1600007a => 'mobilegraphics', 1491 0x1600007a => 'mobilegraphics',
1287 0x1600007b => 'forcefipscrypto', 1492 0x1600007b => 'forcefipscrypto',
1288 0x1500007d => 'booterrorux', 1493 0x1500007d => 'booterrorux',
1289 0x1600007e => 'flightsigning', 1494 0x1600007e => 'flightsigning',
1290 0x1500007f => 'measuredbootlogformat', 1495 0x1500007f => 'measuredbootlogformat',
1291 0x15000080 => 'displayrotation', 1496 0x15000080 => 'displayrotation',
1292 0x15000081 => 'logcontrol', 1497 0x15000081 => 'logcontrol',
1293 0x16000082 => 'nofirmwaresync', 1498 0x16000082 => 'nofirmwaresync',
1294 0x11000084 => 'windowssyspart', 1499 0x11000084 => 'windowssyspart',
1295 0x16000087 => 'numlock', 1500 0x16000087 => 'numlock',
1296 0x22000001 => 'bpbstring', 1501 0x26000202 => 'skipffumode',
1502 0x26000203 => 'forceffumode',
1503 0x25000510 => 'chargethreshold',
1504 0x26000512 => 'offmodecharging',
1505 0x25000aaa => 'bootflow',
1506 0x45000001 => 'devicetype',
1507 0x42000002 => 'applicationrelativepath',
1508 0x42000003 => 'ramdiskdevicerelativepath',
1509 0x46000004 => 'omitosloaderelements',
1510 0x47000006 => 'elementstomigrate',
1511 0x46000010 => 'recoveryos',
1512 },
1513 bootapp => {
1514 0x26000145 => 'enablebootdebugpolicy',
1515 0x26000146 => 'enablebootorderclean',
1516 0x26000147 => 'enabledeviceid',
1517 0x26000148 => 'enableffuloader',
1518 0x26000149 => 'enableiuloader',
1519 0x2600014a => 'enablemassstorage',
1520 0x2600014b => 'enablerpmbprovisioning',
1521 0x2600014c => 'enablesecurebootpolicy',
1522 0x2600014d => 'enablestartcharge',
1523 0x2600014e => 'enableresettpm',
1524 },
1525 bootmgr => {
1297 0x24000001 => 'displayorder', 1526 0x24000001 => 'displayorder',
1298 0x21000001 => 'filedevice',
1299 0x21000001 => 'osdevice',
1300 0x25000001 => 'passcount',
1301 0x26000001 => 'pxesoftreboot',
1302 0x22000002 => 'applicationname',
1303 0x24000002 => 'bootsequence', 1527 0x24000002 => 'bootsequence',
1304 0x22000002 => 'filepath',
1305 0x22000002 => 'systemroot',
1306 0x25000002 => 'testmix',
1307 0x26000003 => 'cacheenable',
1308 0x26000003 => 'customsettings',
1309 0x23000003 => 'default', 1528 0x23000003 => 'default',
1310 0x25000003 => 'failurecount',
1311 0x23000003 => 'resumeobject',
1312 0x26000004 => 'failuresenabled',
1313 0x26000004 => 'pae',
1314 0x26000004 => 'stampdisks',
1315 0x25000004 => 'testtofail',
1316 0x25000004 => 'timeout', 1529 0x25000004 => 'timeout',
1317 0x21000005 => 'associatedosdevice',
1318 0x26000005 => 'cacheenable',
1319 0x26000005 => 'resume', 1530 0x26000005 => 'resume',
1320 0x25000005 => 'stridefailcount',
1321 0x26000006 => 'debugoptionenabled',
1322 0x25000006 => 'invcfailcount',
1323 0x23000006 => 'resumeobject', 1531 0x23000006 => 'resumeobject',
1324 0x25000007 => 'bootux',
1325 0x25000007 => 'matsfailcount',
1326 0x24000007 => 'startupsequence', 1532 0x24000007 => 'startupsequence',
1327 0x25000008 => 'bootmenupolicy',
1328 0x25000008 => 'randfailcount',
1329 0x25000009 => 'chckrfailcount',
1330 0x26000010 => 'detecthal',
1331 0x24000010 => 'toolsdisplayorder', 1533 0x24000010 => 'toolsdisplayorder',
1332 0x22000011 => 'kernel',
1333 0x22000012 => 'hal',
1334 0x22000013 => 'dbgtransport',
1335 0x26000020 => 'displaybootmenu', 1534 0x26000020 => 'displaybootmenu',
1336 0x25000020 => 'nx',
1337 0x26000021 => 'noerrordisplay', 1535 0x26000021 => 'noerrordisplay',
1338 0x25000021 => 'pae',
1339 0x21000022 => 'bcddevice', 1536 0x21000022 => 'bcddevice',
1340 0x26000022 => 'winpe',
1341 0x22000023 => 'bcdfilepath', 1537 0x22000023 => 'bcdfilepath',
1342 0x26000024 => 'hormenabled', 1538 0x26000024 => 'hormenabled',
1343 0x26000024 => 'hormenabled',
1344 0x26000024 => 'nocrashautoreboot',
1345 0x26000025 => 'hiberboot', 1539 0x26000025 => 'hiberboot',
1346 0x26000025 => 'lastknowngood',
1347 0x26000026 => 'oslnointegritychecks',
1348 0x22000026 => 'passwordoverride', 1540 0x22000026 => 'passwordoverride',
1349 0x26000027 => 'osltestsigning',
1350 0x22000027 => 'pinpassphraseoverride', 1541 0x22000027 => 'pinpassphraseoverride',
1351 0x26000028 => 'processcustomactionsfirst', 1542 0x26000028 => 'processcustomactionsfirst',
1352 0x27000030 => 'customactions', 1543 0x27000030 => 'customactions',
1353 0x26000030 => 'nolowmem',
1354 0x26000031 => 'persistbootsequence', 1544 0x26000031 => 'persistbootsequence',
1355 0x25000031 => 'removememory',
1356 0x25000032 => 'increaseuserva',
1357 0x26000032 => 'skipstartupsequence', 1545 0x26000032 => 'skipstartupsequence',
1358 0x25000033 => 'perfmem',
1359 0x22000040 => 'fverecoveryurl', 1546 0x22000040 => 'fverecoveryurl',
1360 0x26000040 => 'vga',
1361 0x22000041 => 'fverecoverymessage', 1547 0x22000041 => 'fverecoverymessage',
1548 },
1549 device => {
1550 0x35000001 => 'ramdiskimageoffset',
1551 0x35000002 => 'ramdisktftpclientport',
1552 0x31000003 => 'ramdisksdidevice',
1553 0x32000004 => 'ramdisksdipath',
1554 0x35000005 => 'ramdiskimagelength',
1555 0x36000006 => 'exportascd',
1556 0x35000007 => 'ramdisktftpblocksize',
1557 0x35000008 => 'ramdisktftpwindowsize',
1558 0x36000009 => 'ramdiskmcenabled',
1559 0x3600000a => 'ramdiskmctftpfallback',
1560 0x3600000b => 'ramdisktftpvarwindow',
1561 },
1562 memdiag => {
1563 0x25000001 => 'passcount',
1564 0x25000002 => 'testmix',
1565 0x25000003 => 'failurecount',
1566 0x26000003 => 'cacheenable',
1567 0x25000004 => 'testtofail',
1568 0x26000004 => 'failuresenabled',
1569 0x25000005 => 'stridefailcount',
1570 0x26000005 => 'cacheenable',
1571 0x25000006 => 'invcfailcount',
1572 0x25000007 => 'matsfailcount',
1573 0x25000008 => 'randfailcount',
1574 0x25000009 => 'chckrfailcount',
1575 },
1576 ntldr => {
1577 0x22000001 => 'bpbstring',
1578 },
1579 osloader => {
1580 0x21000001 => 'osdevice',
1581 0x22000002 => 'systemroot',
1582 0x23000003 => 'resumeobject',
1583 0x26000004 => 'stampdisks',
1584 0x26000010 => 'detecthal',
1585 0x22000011 => 'kernel',
1586 0x22000012 => 'hal',
1587 0x22000013 => 'dbgtransport',
1588 0x25000020 => 'nx',
1589 0x25000021 => 'pae',
1590 0x26000022 => 'winpe',
1591 0x26000024 => 'nocrashautoreboot',
1592 0x26000025 => 'lastknowngood',
1593 0x26000026 => 'oslnointegritychecks',
1594 0x26000027 => 'osltestsigning',
1595 0x26000030 => 'nolowmem',
1596 0x25000031 => 'removememory',
1597 0x25000032 => 'increaseuserva',
1598 0x25000033 => 'perfmem',
1599 0x26000040 => 'vga',
1362 0x26000041 => 'quietboot', 1600 0x26000041 => 'quietboot',
1363 0x26000042 => 'novesa', 1601 0x26000042 => 'novesa',
1364 0x26000043 => 'novga', 1602 0x26000043 => 'novga',
1365 0x25000050 => 'clustermodeaddressing', 1603 0x25000050 => 'clustermodeaddressing',
1366 0x26000051 => 'usephysicaldestination', 1604 0x26000051 => 'usephysicaldestination',
1367 0x25000052 => 'restrictapiccluster', 1605 0x25000052 => 'restrictapiccluster',
1368 0x22000053 => 'evstore', 1606 0x22000053 => 'evstore',
1369 0x26000054 => 'uselegacyapicmode', 1607 0x26000054 => 'uselegacyapicmode',
1370 0x26000060 => 'onecpu', 1608 0x26000060 => 'onecpu',
1371 0x25000061 => 'numproc', 1609 0x25000061 => 'numproc',
1372 0x26000062 => 'maxproc', 1610 0x26000062 => 'maxproc',
1373 0x25000063 => 'configflags', 1611 0x25000063 => 'configflags',
1374 0x26000064 => 'maxgroup', 1612 0x26000064 => 'maxgroup',
1375 0x26000065 => 'groupaware', 1613 0x26000065 => 'groupaware',
1376 0x25000066 => 'groupsize', 1614 0x25000066 => 'groupsize',
1377 0x26000070 => 'usefirmwarepcisettings', 1615 0x26000070 => 'usefirmwarepcisettings',
1378 0x25000071 => 'msi', 1616 0x25000071 => 'msi',
1379 0x25000072 => 'pciexpress', 1617 0x25000072 => 'pciexpress',
1380 0x25000080 => 'safeboot', 1618 0x25000080 => 'safeboot',
1381 0x26000081 => 'safebootalternateshell', 1619 0x26000081 => 'safebootalternateshell',
1382 0x26000090 => 'bootlog', 1620 0x26000090 => 'bootlog',
1383 0x26000091 => 'sos', 1621 0x26000091 => 'sos',
1384 0x260000a0 => 'debug', 1622 0x260000a0 => 'debug',
1385 0x260000a1 => 'halbreakpoint', 1623 0x260000a1 => 'halbreakpoint',
1386 0x260000a2 => 'useplatformclock', 1624 0x260000a2 => 'useplatformclock',
1387 0x260000a3 => 'forcelegacyplatform', 1625 0x260000a3 => 'forcelegacyplatform',
1388 0x260000a4 => 'useplatformtick', 1626 0x260000a4 => 'useplatformtick',
1389 0x260000a5 => 'disabledynamictick', 1627 0x260000a5 => 'disabledynamictick',
1390 0x250000a6 => 'tscsyncpolicy', 1628 0x250000a6 => 'tscsyncpolicy',
1391 0x260000b0 => 'ems', 1629 0x260000b0 => 'ems',
1392 0x250000c0 => 'forcefailure', 1630 0x250000c0 => 'forcefailure',
1393 0x250000c1 => 'driverloadfailurepolicy', 1631 0x250000c1 => 'driverloadfailurepolicy',
1394 0x250000c2 => 'bootmenupolicy', 1632 0x250000c2 => 'bootmenupolicy',
1395 0x260000c3 => 'onetimeadvancedoptions', 1633 0x260000c3 => 'onetimeadvancedoptions',
1396 0x260000c4 => 'onetimeoptionsedit', 1634 0x260000c4 => 'onetimeoptionsedit',
1397 0x250000e0 => 'bootstatuspolicy', 1635 0x250000e0 => 'bootstatuspolicy',
1398 0x260000e1 => 'disableelamdrivers', 1636 0x260000e1 => 'disableelamdrivers',
1399 0x250000f0 => 'hypervisorlaunchtype', 1637 0x250000f0 => 'hypervisorlaunchtype',
1400 0x220000f1 => 'hypervisorpath', 1638 0x220000f1 => 'hypervisorpath',
1401 0x260000f2 => 'hypervisordebug', 1639 0x260000f2 => 'hypervisordebug',
1402 0x250000f3 => 'hypervisordebugtype', 1640 0x250000f3 => 'hypervisordebugtype',
1403 0x250000f4 => 'hypervisordebugport', 1641 0x250000f4 => 'hypervisordebugport',
1404 0x250000f5 => 'hypervisorbaudrate', 1642 0x250000f5 => 'hypervisorbaudrate',
1405 0x250000f6 => 'hypervisorchannel', 1643 0x250000f6 => 'hypervisorchannel',
1406 0x250000f7 => 'bootux', 1644 0x250000f7 => 'bootux',
1407 0x260000f8 => 'hypervisordisableslat', 1645 0x260000f8 => 'hypervisordisableslat',
1408 0x220000f9 => 'hypervisorbusparams', 1646 0x220000f9 => 'hypervisorbusparams',
1409 0x250000fa => 'hypervisornumproc', 1647 0x250000fa => 'hypervisornumproc',
1410 0x250000fb => 'hypervisorrootprocpernode', 1648 0x250000fb => 'hypervisorrootprocpernode',
1411 0x260000fc => 'hypervisoruselargevtlb', 1649 0x260000fc => 'hypervisoruselargevtlb',
1412 0x250000fd => 'hypervisorhostip', 1650 0x250000fd => 'hypervisorhostip',
1413 0x250000fe => 'hypervisorhostport', 1651 0x250000fe => 'hypervisorhostport',
1414 0x250000ff => 'hypervisordebugpages', 1652 0x250000ff => 'hypervisordebugpages',
1415 0x25000100 => 'tpmbootentropy', 1653 0x25000100 => 'tpmbootentropy',
1416 0x22000110 => 'hypervisorusekey', 1654 0x22000110 => 'hypervisorusekey',
1417 0x22000112 => 'hypervisorproductskutype', 1655 0x22000112 => 'hypervisorproductskutype',
1418 0x25000113 => 'hypervisorrootproc', 1656 0x25000113 => 'hypervisorrootproc',
1419 0x26000114 => 'hypervisordhcp', 1657 0x26000114 => 'hypervisordhcp',
1420 0x25000115 => 'hypervisoriommupolicy', 1658 0x25000115 => 'hypervisoriommupolicy',
1421 0x26000116 => 'hypervisorusevapic', 1659 0x26000116 => 'hypervisorusevapic',
1422 0x22000117 => 'hypervisorloadoptions', 1660 0x22000117 => 'hypervisorloadoptions',
1423 0x25000118 => 'hypervisormsrfilterpolicy', 1661 0x25000118 => 'hypervisormsrfilterpolicy',
1424 0x25000119 => 'hypervisormmionxpolicy', 1662 0x25000119 => 'hypervisormmionxpolicy',
1425 0x2500011a => 'hypervisorschedulertype', 1663 0x2500011a => 'hypervisorschedulertype',
1426 0x25000120 => 'xsavepolicy', 1664 0x25000120 => 'xsavepolicy',
1427 0x25000121 => 'xsaveaddfeature0', 1665 0x25000121 => 'xsaveaddfeature0',
1428 0x25000122 => 'xsaveaddfeature1', 1666 0x25000122 => 'xsaveaddfeature1',
1429 0x25000123 => 'xsaveaddfeature2', 1667 0x25000123 => 'xsaveaddfeature2',
1430 0x25000124 => 'xsaveaddfeature3', 1668 0x25000124 => 'xsaveaddfeature3',
1431 0x25000125 => 'xsaveaddfeature4', 1669 0x25000125 => 'xsaveaddfeature4',
1432 0x25000126 => 'xsaveaddfeature5', 1670 0x25000126 => 'xsaveaddfeature5',
1433 0x25000127 => 'xsaveaddfeature6', 1671 0x25000127 => 'xsaveaddfeature6',
1434 0x25000128 => 'xsaveaddfeature7', 1672 0x25000128 => 'xsaveaddfeature7',
1435 0x25000129 => 'xsaveremovefeature', 1673 0x25000129 => 'xsaveremovefeature',
1436 0x2500012a => 'xsaveprocessorsmask', 1674 0x2500012a => 'xsaveprocessorsmask',
1437 0x2500012b => 'xsavedisable', 1675 0x2500012b => 'xsavedisable',
1438 0x2500012c => 'kerneldebugtype', 1676 0x2500012c => 'kerneldebugtype',
1439 0x2200012d => 'kernelbusparams', 1677 0x2200012d => 'kernelbusparams',
1440 0x2500012e => 'kerneldebugaddress', 1678 0x2500012e => 'kerneldebugaddress',
1441 0x2500012f => 'kerneldebugport', 1679 0x2500012f => 'kerneldebugport',
1442 0x25000130 => 'claimedtpmcounter', 1680 0x25000130 => 'claimedtpmcounter',
1443 0x25000131 => 'kernelchannel', 1681 0x25000131 => 'kernelchannel',
1444 0x22000132 => 'kerneltargetname', 1682 0x22000132 => 'kerneltargetname',
1445 0x25000133 => 'kernelhostip', 1683 0x25000133 => 'kernelhostip',
1446 0x25000134 => 'kernelport', 1684 0x25000134 => 'kernelport',
1447 0x26000135 => 'kerneldhcp', 1685 0x26000135 => 'kerneldhcp',
1448 0x22000136 => 'kernelkey', 1686 0x22000136 => 'kernelkey',
1449 0x22000137 => 'imchivename', 1687 0x22000137 => 'imchivename',
1450 0x21000138 => 'imcdevice', 1688 0x21000138 => 'imcdevice',
1451 0x25000139 => 'kernelbaudrate', 1689 0x25000139 => 'kernelbaudrate',
1452 0x22000140 => 'mfgmode', 1690 0x22000140 => 'mfgmode',
1453 0x26000141 => 'event', 1691 0x26000141 => 'event',
1454 0x25000142 => 'vsmlaunchtype', 1692 0x25000142 => 'vsmlaunchtype',
1455 0x25000144 => 'hypervisorenforcedcodeintegrity', 1693 0x25000144 => 'hypervisorenforcedcodeintegrity',
1456 0x26000145 => 'enablebootdebugpolicy',
1457 0x26000146 => 'enablebootorderclean',
1458 0x26000147 => 'enabledeviceid',
1459 0x26000148 => 'enableffuloader',
1460 0x26000149 => 'enableiuloader',
1461 0x2600014a => 'enablemassstorage',
1462 0x2600014b => 'enablerpmbprovisioning',
1463 0x2600014c => 'enablesecurebootpolicy',
1464 0x2600014d => 'enablestartcharge',
1465 0x2600014e => 'enableresettpm',
1466 0x21000150 => 'systemdatadevice', 1694 0x21000150 => 'systemdatadevice',
1467 0x21000151 => 'osarcdevice', 1695 0x21000151 => 'osarcdevice',
1468 0x21000153 => 'osdatadevice', 1696 0x21000153 => 'osdatadevice',
1469 0x21000154 => 'bspdevice', 1697 0x21000154 => 'bspdevice',
1470 0x21000155 => 'bspfilepath', 1698 0x21000155 => 'bspfilepath',
1471 0x26000202 => 'skipffumode', 1699 },
1472 0x26000203 => 'forceffumode', 1700 resume => {
1473 0x25000510 => 'chargethreshold', 1701 0x21000001 => 'filedevice',
1474 0x26000512 => 'offmodecharging', 1702 0x22000002 => 'filepath',
1475 0x25000aaa => 'bootflow', 1703 0x26000003 => 'customsettings',
1476 0x35000001 => 'ramdiskimageoffset', 1704 0x26000004 => 'pae',
1477 0x35000002 => 'ramdisktftpclientport', 1705 0x21000005 => 'associatedosdevice',
1478 0x31000003 => 'ramdisksdidevice', 1706 0x26000006 => 'debugoptionenabled',
1479 0x32000004 => 'ramdisksdipath', 1707 0x25000007 => 'bootux',
1480 0x35000005 => 'ramdiskimagelength', 1708 0x25000008 => 'bootmenupolicy',
1481 0x36000006 => 'exportascd', 1709 0x26000024 => 'hormenabled',
1482 0x35000007 => 'ramdisktftpblocksize', 1710 },
1483 0x35000008 => 'ramdisktftpwindowsize', 1711 startup => {
1484 0x36000009 => 'ramdiskmcenabled', 1712 0x26000001 => 'pxesoftreboot',
1485 0x3600000a => 'ramdiskmctftpfallback', 1713 0x22000002 => 'applicationname',
1486 0x3600000b => 'ramdisktftpvarwindow', 1714 },
1487 0x45000001 => 'devicetype',
1488 0x42000002 => 'applicationrelativepath',
1489 0x42000003 => 'ramdiskdevicerelativepath',
1490 0x46000004 => 'omitosloaderelements',
1491 0x47000006 => 'elementstomigrate',
1492 0x46000010 => 'recoveryos',
1493); 1715);
1494 1716
1495our %rbcde = reverse %bcde; 1717# mask, value => class
1718our @bcde_typeclass = (
1719 [0x00000000, 0x00000000, 'any'],
1720 [0xf00fffff, 0x1000000a, 'bootapp'],
1721 [0xf0ffffff, 0x2020000a, 'bootapp'],
1722 [0xf00fffff, 0x10000001, 'bootmgr'],
1723 [0xf00fffff, 0x10000002, 'bootmgr'],
1724 [0xf0ffffff, 0x20200001, 'bootmgr'],
1725 [0xf0ffffff, 0x20200002, 'bootmgr'],
1726 [0xf0f00000, 0x20300000, 'device'],
1727 [0xf0000000, 0x30000000, 'device'],
1728 [0xf00fffff, 0x10000005, 'memdiag'],
1729 [0xf0ffffff, 0x20200005, 'memdiag'],
1730 [0xf00fffff, 0x10000006, 'ntldr'],
1731 [0xf00fffff, 0x10000007, 'ntldr'],
1732 [0xf0ffffff, 0x20200006, 'ntldr'],
1733 [0xf0ffffff, 0x20200007, 'ntldr'],
1734 [0xf00fffff, 0x10000003, 'osloader'],
1735 [0xf0ffffff, 0x20200003, 'osloader'],
1736 [0xf00fffff, 0x10000004, 'resume'],
1737 [0xf0ffffff, 0x20200004, 'resume'],
1738 [0xf00fffff, 0x10000009, 'startup'],
1739 [0xf0ffffff, 0x20200009, 'startup'],
1740);
1496 1741
1742our %rbcde_byclass;
1743
1744while (my ($k, $v) = each %bcde_byclass) {
1745 $rbcde_byclass{$k} = { reverse %$v };
1746}
1747
1748# decodes (numerical elem, type) to name
1497sub dec_bcde_id($) { 1749sub dec_bcde_id($$) {
1750 for my $class (@bcde_typeclass) {
1751 if (($_[1] & $class->[0]) == $class->[1]) {
1752 if (my $id = $bcde_byclass{$class->[2]}{$_[0]}) {
1753 return $id;
1754 }
1755 }
1756 }
1757
1498 $bcde{$_[0]} // sprintf "custom:%08x", $_[0] 1758 sprintf "custom:%08x", $_[0]
1499} 1759}
1500 1760
1761# encodes (elem as name, type)
1501sub enc_bcde_id($) { 1762sub enc_bcde_id($$) {
1502 $_[0] =~ /^custom:([0-9a-fA-F]{8}$)/ 1763 $_[0] =~ /^custom:(?:0x)?([0-9a-fA-F]{8}$)/
1503 ? hex $1 1764 and return hex $1;
1504 : $rbcde{$_[0]} 1765
1766 for my $class (@bcde_typeclass) {
1767 if (($_[1] & $class->[0]) == $class->[1]) {
1768 if (my $value = $rbcde_byclass{$class->[2]}{$_[0]}) {
1769 return $value;
1770 }
1771 }
1772 }
1773
1774 undef
1505} 1775}
1506 1776
1507# decode/encode bcd device element - the horror, no documentaion 1777# decode/encode bcd device element - the horror, no documentaion
1508# whatsoever, supercomplex, superinconsistent. 1778# whatsoever, supercomplex, superinconsistent.
1509 1779
1513 1783
1514our $NULL_DEVICE = "\x00" x 16; 1784our $NULL_DEVICE = "\x00" x 16;
1515 1785
1516# biggest bitch to decode, ever 1786# biggest bitch to decode, ever
1517# this decoded a device portion after the GUID 1787# this decoded a device portion after the GUID
1518sub dec_device_($); 1788sub dec_device_($$);
1519sub dec_device_($) { 1789sub dec_device_($$) {
1520 my ($device) = @_; 1790 my ($device, $type) = @_;
1521 1791
1522 my $res; 1792 my $res;
1523 1793
1524 my ($type, $flags, $length, $pad) = unpack "VVVV", substr $device, 0, 4 * 4, ""; 1794 my ($type, $flags, $length, $pad) = unpack "VVVV", substr $device, 0, 4 * 4, "";
1525 1795
1570 1840
1571 my $partid = $parttype eq "gpt" ? dec_guid $partdata 1841 my $partid = $parttype eq "gpt" ? dec_guid $partdata
1572 : $type eq "partition" ? unpack "Q<", $partdata # byte offset to partition start 1842 : $type eq "partition" ? unpack "Q<", $partdata # byte offset to partition start
1573 : unpack "L<", $partdata; # partition number, one-based 1843 : unpack "L<", $partdata; # partition number, one-based
1574 1844
1575 (my $parent, $device) = dec_device_ $device; 1845 (my $parent, $device) = dec_device_ $device, $type;
1576 1846
1577 $res .= "="; 1847 $res .= "=";
1578 $res .= "<$parent>"; 1848 $res .= "<$parent>";
1579 $res .= ",$blocktype,$parttype,$diskid,$partid"; 1849 $res .= ",$blocktype,$parttype,$diskid,$partid";
1580 1850
1600 or die "unsupported file descriptor version '$fver'\n"; 1870 or die "unsupported file descriptor version '$fver'\n";
1601 1871
1602 $ftype == 5 1872 $ftype == 5
1603 or die "unsupported file descriptor path type '$type'\n"; 1873 or die "unsupported file descriptor path type '$type'\n";
1604 1874
1605 (my $parent, $path) = dec_device_ $path; 1875 (my $parent, $path) = dec_device_ $path, $type;
1606 1876
1607 $path = $dec_path->($path, "file device without path"); 1877 $path = $dec_path->($path, "file device without path");
1608 1878
1609 ($parent, $path) 1879 ($parent, $path)
1610 }; 1880 };
1616 1886
1617 } elsif ($blocktype eq "vhd") { 1887 } elsif ($blocktype eq "vhd") {
1618 $device =~ s/^\x00{20}//s 1888 $device =~ s/^\x00{20}//s
1619 or die "virtualdisk has non-zero fields I don't understand\n"; 1889 or die "virtualdisk has non-zero fields I don't understand\n";
1620 1890
1621 (my $parent, $device) = dec_device_ $device; 1891 (my $parent, $device) = dec_device_ $device, $type;
1622 1892
1623 $res .= "=vhd,<$parent>"; 1893 $res .= "=vhd,<$parent>";
1624 1894
1625 } elsif ($blocktype eq "ramdisk") { 1895 } elsif ($blocktype eq "ramdisk") {
1626 my ($base, $size, $offset) = unpack "Q< Q< L<", substr $device, 0, 8 + 8 + 4, ""; 1896 my ($base, $size, $offset) = unpack "Q< Q< L<", substr $device, 0, 8 + 8 + 4, "";
1639 my ($mode, $elem, $parent) = unpack "VVV", substr $device, 0, 4 * 3, ""; 1909 my ($mode, $elem, $parent) = unpack "VVV", substr $device, 0, 4 * 3, "";
1640 1910
1641 if ($parent) { 1911 if ($parent) {
1642 # not sure why this is an offset - it must come after the path 1912 # not sure why this is an offset - it must come after the path
1643 $parent = substr $device, $parent - 4 * 3 - 4 * 4, 1e9, ""; 1913 $parent = substr $device, $parent - 4 * 3 - 4 * 4, 1e9, "";
1644 ($parent, my $tail) = dec_device_ $parent; 1914 ($parent, my $tail) = dec_device_ $parent, $type;
1645 0 == length $tail 1915 0 == length $tail
1646 or die "trailing data after locate device parent\n"; 1916 or die "trailing data after locate device parent\n";
1647 } else { 1917 } else {
1648 $parent = "null"; 1918 $parent = "null";
1649 } 1919 }
1655 1925
1656 if ($mode == 0) { # "Element" 1926 if ($mode == 0) { # "Element"
1657 !length $path 1927 !length $path
1658 or die "device locate mode 0 having non-empty path ($mode, $elem, $path)\n"; 1928 or die "device locate mode 0 having non-empty path ($mode, $elem, $path)\n";
1659 1929
1660 $elem = dec_bcde_id $elem; 1930 $elem = dec_bcde_id $elem, $type;
1661 $res .= "element,$elem"; 1931 $res .= "element,$elem";
1662 1932
1663 } elsif ($mode == 1) { # "String" 1933 } elsif ($mode == 1) { # "String"
1664 !$elem 1934 !$elem
1665 or die "device locate mode 1 having non-zero element\n"; 1935 or die "device locate mode 1 having non-zero element\n";
1690 1960
1691 ($res, $tail) 1961 ($res, $tail)
1692} 1962}
1693 1963
1694# decode a full binary BCD device descriptor 1964# decode a full binary BCD device descriptor
1695sub dec_device($) { 1965sub dec_device($$) {
1696 my ($device) = @_; 1966 my ($device, $type) = @_;
1697 1967
1698 $device = pack "H*", $device; 1968 $device = pack "H*", $device;
1699 1969
1700 my $guid = dec_guid substr $device, 0, 16, ""; 1970 my $guid = dec_guid substr $device, 0, 16, "";
1701 $guid = $guid eq "00000000-0000-0000-0000-000000000000" 1971 $guid = $guid eq "00000000-0000-0000-0000-000000000000"
1702 ? "" : "{$guid}"; 1972 ? "" : "{$guid}";
1703 1973
1704 eval { 1974 eval {
1705 my ($dev, $tail) = dec_device_ $device; 1975 my ($dev, $tail) = dec_device_ $device, $type;
1706 1976
1707 $tail eq "" 1977 $tail eq ""
1708 or die "unsupported trailing data after device descriptor\n"; 1978 or die "unsupported trailing data after device descriptor\n";
1709 1979
1710 "$guid$dev" 1980 "$guid$dev"
1722 1992
1723 undef 1993 undef
1724} 1994}
1725 1995
1726# encode the device portion after the GUID 1996# encode the device portion after the GUID
1727sub enc_device_; 1997sub enc_device_($$);
1728sub enc_device_ { 1998sub enc_device_($$) {
1729 my ($device) = @_; 1999 my ($device, $type) = @_;
1730 2000
1731 my $enc_path = sub { 2001 my $enc_path = sub {
1732 my $path = shift; 2002 my $path = shift;
1733 $path =~ s/\//\\/g; 2003 $path =~ s/\//\\/g;
1734 (Encode::encode "UTF-16LE", $path) . "\x00\x00" 2004 (Encode::encode "UTF-16LE", $path) . "\x00\x00"
1752 2022
1753 my $parse_parent = sub { 2023 my $parse_parent = sub {
1754 my $parent; 2024 my $parent;
1755 2025
1756 if (s/^<//) { 2026 if (s/^<//) {
1757 ($parent, $_) = enc_device_ $_; 2027 ($parent, $_) = enc_device_ $_, $type;
1758 s/^>// 2028 s/^>//
1759 or die "$device: syntax error: parent device not followed by '>'\n"; 2029 or die "$device: syntax error: parent device not followed by '>'\n";
1760 } else { 2030 } else {
1761 $parent = $NULL_DEVICE; 2031 $parent = $NULL_DEVICE;
1762 } 2032 }
1850 2120
1851 s/^,// 2121 s/^,//
1852 or die "$_: missing comma after locate parent device\n"; 2122 or die "$_: missing comma after locate parent device\n";
1853 2123
1854 if (s/^element,//) { 2124 if (s/^element,//) {
1855 s/^([0-9a-z]+)//i 2125 s/^([0-9a-z:]+)//i
1856 or die "$_ locate element must be either name or 8-digit hex id\n"; 2126 or die "$_ locate element must be either name or 8-digit hex id\n";
1857 $elem = enc_bcde_id $1; 2127 $elem = enc_bcde_id $1, $type;
1858 $mode = 0; 2128 $mode = 0;
1859 $path = $enc_path->(""); 2129 $path = $enc_path->("");
1860 2130
1861 } elsif (s/^path,//) { 2131 } elsif (s/^path,//) {
1862 $mode = 1; 2132 $mode = 1;
1941 ); 2211 );
1942 } 2212 }
1943} 2213}
1944 2214
1945# encode a full binary BCD device descriptor 2215# encode a full binary BCD device descriptor
1946sub enc_device { 2216sub enc_device($$) {
1947 my ($device) = @_; 2217 my ($device, $type) = @_;
1948 2218
1949 my $guid = "\x00" x 16; 2219 my $guid = "\x00" x 16;
1950 2220
1951 if ($device =~ s/^\{([A-Za-z0-9\-]+)\}//) { 2221 if ($device =~ s/^\{([A-Za-z0-9\-]+)\}//) {
1952 $guid = enc_guid $1 2222 $guid = enc_guid $1
1953 or die "$device: does not start with valid guid\n"; 2223 or die "$device: does not start with valid guid\n";
1954 } 2224 }
1955 2225
1956 my ($descriptor, $tail) = enc_device_ $device; 2226 my ($descriptor, $tail) = enc_device_ $device, $type;
1957 2227
1958 length $tail 2228 length $tail
1959 and die "$device: garbage after device descriptor\n"; 2229 and die "$device: garbage after device descriptor\n";
1960 2230
1961 unpack "H*", $guid . $descriptor 2231 unpack "H*", $guid . $descriptor
1976 $k = $bcd_objects{$k} // $k; 2246 $k = $bcd_objects{$k} // $k;
1977 2247
1978 my $type = $v->{Description}[0]{Type}[1]; 2248 my $type = $v->{Description}[0]{Type}[1];
1979 2249
1980 if ($type != $bcd_object_types{$k}) { 2250 if ($type != $bcd_object_types{$k}) {
1981 $type = $bcd_types{$type} // sprintf "0x%08x", $type; 2251 $kv{type} = $bcd_types{$type} // sprintf "0x%08x", $type;
1982 $kv{type} = $type;
1983 } 2252 }
1984 2253
1985 my $elems = $v->{Elements}[1]; 2254 my $elems = $v->{Elements}[1];
1986 2255
1987 while (my ($k, $v) = each %$elems) { 2256 while (my ($k, $v) = each %$elems) {
1988 my $k = hex $k; 2257 my $k = hex $k;
1989 2258
1990 my $v = $bcde_dec{$k & BCDE_FORMAT}->($v->[0]{Element}[1]); 2259 my $v = $bcde_dec{$k & BCDE_FORMAT}->($v->[0]{Element}[1], $type);
1991 my $k = dec_bcde_id $k; 2260 my $k = dec_bcde_id $k, $type;
1992 2261
1993 $kv{$k} = $v; 2262 $kv{$k} = $v;
1994 } 2263 }
1995 2264
1996 $bcd{$k} = \%kv; 2265 $bcd{$k} = \%kv;
2037 my %elem; 2306 my %elem;
2038 2307
2039 while (my ($k, $v) = each %$v) { 2308 while (my ($k, $v) = each %$v) {
2040 next if $k eq "type"; 2309 next if $k eq "type";
2041 2310
2042 $k = (enc_bcde_id $k) // die "$k: invalid bcde element name or id\n"; 2311 $k = (enc_bcde_id $k, $type) // die "$k: invalid bcde element name or id\n";
2043 $elem{sprintf "%08x", $k} = [{ 2312 $elem{sprintf "%08x", $k} = [{
2044 Element => [ ($bcde_enc{$k & BCDE_FORMAT} // die "$k: unable to encode unknown bcd element type}")->($v)] 2313 Element => [ ($bcde_enc{$k & BCDE_FORMAT} // die "$k: unable to encode unknown bcd element type}")->($v)]
2045 }]; 2314 }];
2046 } 2315 }
2047 2316
2063 Objects => [undef, \%objects], 2332 Objects => [undef, \%objects],
2064 }]] 2333 }]]
2065} 2334}
2066 2335
2067############################################################################# 2336#############################################################################
2337# edit instructions
2338
2339sub bcd_edit_eval {
2340 package pbcdedit;
2341
2342 our ($PATH, $BCD, $DEFAULT);
2343
2344 eval shift;
2345 die "$@" if $@;
2346}
2347
2348sub bcd_edit {
2349 my ($path, $bcd, @insns) = @_;
2350
2351 my $default = $bcd->{"{bootmgr}"}{default};
2352
2353 # prepare "officially visible" variables
2354 local $pbcdedit::PATH = $path;
2355 local $pbcdedit::BCD = $bcd;
2356 local $pbcdedit::DEFAULT = $default;
2357
2358 while (@insns) {
2359 my $insn = shift @insns;
2360
2361 if ($insn eq "get") {
2362 my $object = shift @insns;
2363 my $elem = shift @insns;
2364
2365 $object = $object eq "{default}" ? $default : dec_wguid enc_wguid $object;
2366
2367 print $bcd->{$object}{$elem}, "\n";
2368
2369 } elsif ($insn eq "set") {
2370 my $object = shift @insns;
2371 my $elem = shift @insns;
2372 my $value = shift @insns;
2373
2374 $object = $object eq "{default}" ? $default : dec_wguid enc_wguid $object;
2375
2376 $bcd->{$object}{$elem} = $value;
2377
2378 } elsif ($insn eq "eval") {
2379 my $perl = shift @insns;
2380 bcd_edit_eval "#line 1 'eval'\n$perl";
2381
2382 } elsif ($insn eq "do") {
2383 my $path = shift @insns;
2384 my $file = file_load $path;
2385 bcd_edit_eval "#line 1 '$path'\n$file";
2386
2387 } else {
2388 die "$insn: not a recognized instruction for edit/parse\n";
2389 }
2390 }
2391
2392}
2393
2394#############################################################################
2395# command line parser
2068 2396
2069# json to stdout 2397# json to stdout
2070sub prjson($) { 2398sub prjson($) {
2071 print $json_coder->encode ($_[0]); 2399 print $json_coder->encode ($_[0]);
2072} 2400}
2111 2439
2112 print "\n"; 2440 print "\n";
2113 2441
2114 printf "%-39s %-23s %s\n", "Object GUID", "Alias", "(Hex) Default Type"; 2442 printf "%-39s %-23s %s\n", "Object GUID", "Alias", "(Hex) Default Type";
2115 for my $name (sort keys %rbcd_objects) { 2443 for my $name (sort keys %rbcd_objects) {
2116 my $guid = $rbcd_objects{$name}; 2444 my $guid = $rbcd_objects{$name};
2117 my $type = $bcd_object_types{$name}; 2445 my $type = $bcd_object_types{$name};
2118 my $tname = $bcd_types{$type}; 2446 my $tname = $bcd_types{$type};
2119 2447
2120 $type = $type ? sprintf "(%08x) %s", $type, $tname : "-"; 2448 $type = $type ? sprintf "(%08x) %s", $type, $tname : "-";
2121 2449
2122 printf "%-39s %-23s %s\n", $guid, $name, $type; 2450 printf "%-39s %-23s %s\n", $guid, $name, $type;
2136 BCDE_FORMAT_GUID_LIST , "guid list", 2464 BCDE_FORMAT_GUID_LIST , "guid list",
2137 BCDE_FORMAT_INTEGER , "integer", 2465 BCDE_FORMAT_INTEGER , "integer",
2138 BCDE_FORMAT_BOOLEAN , "boolean", 2466 BCDE_FORMAT_BOOLEAN , "boolean",
2139 BCDE_FORMAT_INTEGER_LIST, "integer list", 2467 BCDE_FORMAT_INTEGER_LIST, "integer list",
2140 ); 2468 );
2141 my %rbcde = reverse %bcde;
2142 $_ = sprintf "%08x", $_ for values %rbcde;
2143 2469
2144 my %element; 2470 my %element;
2145 2471
2472 for my $class (sort keys %rbcde_byclass) {
2473 my $rbcde = $rbcde_byclass{$class};
2474
2146 unless ($json) { 2475 unless ($json) {
2147 print "\n"; 2476 print "\n";
2477 printf "Elements applicable to class(es): $class\n";
2148 printf "%-9s %-12s %s\n", "Element", "Format", "Name Alias"; 2478 printf "%-9s %-12s %s\n", "Element", "Format", "Name Alias";
2149 } 2479 }
2150 for my $name (sort keys %rbcde) { 2480 for my $name (sort keys %$rbcde) {
2151 my $id = $rbcde{$name}; 2481 my $id = $rbcde->{$name};
2152 my $format = $format_name{(hex $id) & BCDE_FORMAT}; 2482 my $format = $format_name{$id & BCDE_FORMAT};
2483 $id = sprintf "%08x", $id;
2153 2484
2154 if ($json) { 2485 if ($json) {
2155 $element{$id} = [$format, $name]; 2486 $element{$id} = [$class, $format, $name];
2156 } else { 2487 } else {
2157 printf "%-9s %-12s %s\n", $id, $format, $name; 2488 printf "%-9s %-12s %s\n", $id, $format, $name;
2489 }
2158 } 2490 }
2159 } 2491 }
2160 print "\n" unless $json; 2492 print "\n" unless $json;
2161 2493
2162 prjson { 2494 prjson {
2163 version => $JSON_VERSION, 2495 version => $JSON_VERSION,
2164 element => \%element, 2496 element => \%element,
2497 class => \@bcde_typeclass,
2165 } if $json; 2498 } if $json;
2166 2499
2167 }, 2500 },
2168 2501
2169 export => sub { 2502 export => sub {
2170 prjson bcd_decode regf_load shift; 2503 prjson bcd_decode regf_load shift;
2171 }, 2504 },
2172 2505
2173 import => sub { 2506 import => sub {
2174 regf_save shift, bcd_encode rdjson; 2507 regf_save shift, bcd_encode rdjson;
2508 },
2509
2510 edit => sub {
2511 my $path = shift;
2512 my $bcd = bcd_decode regf_load $path;
2513 bcd_edit $path, $bcd, @_;
2514 regf_save $path, bcd_encode $bcd;
2515 },
2516
2517 parse => sub {
2518 my $path = shift;
2519 my $bcd = bcd_decode regf_load $path;
2520 bcd_edit $path, $bcd, @_;
2175 }, 2521 },
2176 2522
2177 "export-regf" => sub { 2523 "export-regf" => sub {
2178 prjson regf_load shift; 2524 prjson regf_load shift;
2179 2525
2208 } 2554 }
2209 } 2555 }
2210 } 2556 }
2211 } 2557 }
2212 }, 2558 },
2559
2560 version => sub {
2561 print "\n",
2562 "PBCDEDIT version $VERSION, copyright 2019 Marc A. Lehmann <pbcdedit\@schmorp.de>.\n",
2563 "JSON schema version: $JSON_VERSION\n",
2564 "Licensed under the GNU General Public License Version 3.0, or any later version.\n",
2565 "\n",
2566 $CHANGELOG,
2567 "\n";
2568 },
2213); 2569);
2214 2570
2215my $cmd = shift; 2571my $cmd = shift;
2216 2572
2217unless (exists $CMD{$cmd}) { 2573unless (exists $CMD{$cmd}) {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines