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

Comparing pbcdedit/pbcdedit (file contents):
Revision 1.9 by root, Wed Aug 14 22:54:28 2019 UTC vs.
Revision 1.53 by root, Thu Aug 22 07:51:23 2019 UTC

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 needed 22use 5.016; # numerous features need 5.14, __SUB__ needs 5.16
23 23
24our $VERSION = '1.0'; 24our $VERSION = '1.3';
25our $JSON_VERSION = 1; # the versiobn of the json objects generated by this program 25our $JSON_VERSION = 3; # the version of the json objects generated by this program
26
27our $CHANGELOG = <<EOF;
28
29 - editorial fixes to the documentation.
30
311.3 Sat Aug 17 07:04:15 CEST 2019
32 - output of pbcdedit elements --json has changed, as it didn't
33 take the reorganisation by classes fully into account.
34 - json schema bumped to 3.
35 - new "bcd-device" and "bcd-legacy-device" subcommands.
36 - implement --json option for lsblk.
37
381.2 Fri Aug 16 00:20:41 CEST 2019
39 - bcd element names now depend on the bcd object type they are in,
40 also affects "elements" output.
41 - json schema bumped to 2.
42 - new version command.
43 - numerous minor bugfixes.
44
45EOF
26 46
27=head1 NAME 47=head1 NAME
28 48
29 pbcdedit - portable boot configuration data (BCD) store editor 49 pbcdedit - portable boot configuration data (BCD) store editor
30 50
31=head1 SYNOPSIS 51=head1 SYNOPSIS
32 52
33 pbcdedit help # output manual page 53 pbcdedit help # output manual page
54 pbcdedit version # output version and changelog
55
34 pbcdedit export path/to/BCD # output BCD hive as JSON 56 pbcdedit export path/to/BCD # output BCD hive as JSON
35 pbcdedit import path/to/bcd # convert standard input to BCD hive 57 pbcdedit import path/to/BCD # convert standard input to BCD hive
36 pbcdedit edit path/to/BCD edit-instructions... 58 pbcdedit edit path/to/BCD edit-instructions...
37 59
38 pbcdedit objects # list all supported object aliases and types 60 pbcdedit objects # list all supported object aliases and types
39 pbcdedit elements # list all supported bcd element aliases 61 pbcdedit elements # list all supported bcd element aliases
40 62
63 # Example: enable text-based boot menu.
64 pbcdedit edit /my/BCD set '{default}' bootmenupolicy 1
65
66 # Example change system device to first partition containing winload.
67 pbcdedit edit /my/BCD \
68 set '{default}' device 'locate=<null>,element,path' \
69 set '{default}' osdevice 'locate=<null>,element,path'
70
71
41=head1 DESCRIPTION 72=head1 DESCRIPTION
42 73
43This program allows you to create, read and modify Boot Configuration Data 74This program allows you to create, read and modify Boot Configuration Data
44(BCD) stores used by Windows Vista and newer versions of Windows. 75(BCD) stores used by Windows Vista and newer versions of Windows.
45 76
58 89
59=item Does not rely on Windows 90=item Does not rely on Windows
60 91
61As the "portable" in the name implies, this program does not rely on 92As the "portable" in the name implies, this program does not rely on
62C<bcdedit> or other windows programs or libraries, it works on any system 93C<bcdedit> or other windows programs or libraries, it works on any system
63that supports at least perl version 5.14. 94that supports at least perl version 5.16.
64 95
65=item Decodes and encodes BCD device elements 96=item Decodes and encodes BCD device elements
66 97
67PBCDEDIT can concisely decode and encode BCD device element contents. This 98PBCDEDIT can concisely decode and encode BCD device element contents. This
68is pretty unique, and offers a lot of potential that can't be realised 99is pretty unique, and offers a lot of potential that can't be realised
75sensitive data. 106sensitive data.
76 107
77=back 108=back
78 109
79The target audience for this program is professionals and tinkerers who 110The target audience for this program is professionals and tinkerers who
80are rewady to invest time into learning how it works. It is not an easy 111are ready to invest time into learning how it works. It is not an easy
81program to use and requires patience and a good understanding of BCD data 112program to use and requires patience and a good understanding of BCD
82stores. 113stores.
83 114
84 115
85=head1 SUBCOMMANDS 116=head1 SUBCOMMANDS
86 117
87PCBEDIT expects a subcommand as first argument that tells it what to 118PBCDEDIT expects a subcommand as first argument that tells it what to
88do. The following subcommands exist: 119do. The following subcommands exist:
89 120
90=over 121=over
91 122
92=item help 123=item C<help>
93 124
94Displays the whole manuale page (this document). 125Displays the whole manual page (this document).
95 126
127=item C<version>
128
129This outputs the PBCDEDIT version, the JSON schema version it uses and the
130full log of changes.
131
96=item export F<path> 132=item C<export> F<path>
97 133
98Reads a BCD data store and writes a JSON representation of it to standard 134Reads a BCD data store and writes a JSON representation of it to standard
99output. 135output.
100 136
101The format of the data is explained later in this document. 137The format of the data is explained later in this document.
102 138
103Example: read a BCD store, modify it wiht an extenral program, write it again. 139Example: read a BCD store, modify it with an external program, write it
140again.
104 141
105 pbcdedit export BCD | modify-json-somehow | pbcdedit import BCD 142 pbcdedit export BCD | modify-json-somehow | pbcdedit import BCD
106 143
107=item import F<path> 144=item C<import> F<path>
108 145
109The reverse of C<export>: Reads a JSON representation of a BCD data store 146The reverse of C<export>: Reads a JSON representation of a BCD data store
110from standard input, and creates or replaces the given BCD data store. 147from standard input, and creates or replaces the given BCD data store.
111 148
112=item edit F<path> instructions... 149=item C<edit> F<path> I<instructions...>
113 150
114Load a BCD data store, apply some instructions to it, and save it again. 151Load a BCD data store, apply some instructions to it, and save it again.
115 152
116See the section L<EDITING BCD DATA STORES>, below, for more info. 153See the section L<EDITING BCD STORES>, below, for more info.
117 154
118=item parse F<path> instructions... 155=item C<parse> F<path> I<instructions...>
119 156
120Same as C<edit>, above, except it doesn't save the data store again. Can 157Same as C<edit>, above, except it doesn't save the data store again. Can
121be useful to extract some data from it. 158be useful to extract some data from it.
122 159
123=item lsblk 160=item C<lsblk> [C<--json>]
124 161
125On a GNU/Linux system, you can get a list of partition device descriptors 162On a GNU/Linux system, you can get a list of partition device descriptors
126using this command - the external C<lsblk> command is required, as well as 163using this command - the external C<lsblk> command is required, as well as
127a mounted C</sys> file system. 164a mounted C</sys> file system.
128 165
129The output will be a list of all partitions in the system and C<partition> 166The output will be a list of all partitions in the system and C<partition>
130descriptors for GPT and both C<legacypartition> and C<partition> 167descriptors for GPT and both C<legacypartition> and C<partition>
131descritpors for MBR partitions. 168descriptors for MBR partitions.
132 169
170With C<--json> it will print similar information as C<lsblk --json>, but
171with extra C<bcd_device> and C<bcd_legacy_device> attributes.
172
173=item C<bcd-device> F<path>
174
175Tries to find the BCD device element for the given device, which currently
176must be a a partition of some kind. Prints the C<partition=> descriptor as
177a result, or nothing. Exit status will be true on success, and false on
178failure.
179
180Like C<lsblk>, above, this likely only works on GNU/Linux systems.
181
182Example: print the partition descriptor of tghe partition with label DATA.
183
184 $ pbcdedit bcd-device /dev/disk/by-label/DATA
185 partition=<null>,harddisk,mbr,47cbc08a,213579202560
186
187=item C<bcd-legacy-device> F<path>
188
189Like above, but uses a C<legacypartition> descriptor instead.
190
133=item objects [--json] 191=item C<objects> [C<--json>]
134 192
135Outputs two tables: a table listing all type aliases with their hex bcd 193Outputs two tables: a table listing all type aliases with their hex BCD
136element ID, and all object name aliases with their GUID and default type 194element ID, and all object name aliases with their GUID and default type
137(if any). 195(if any).
138 196
139With C<--json> it prints similar information as a JSON object, for easier parsing. 197With C<--json> it prints similar information as a JSON object, for easier parsing.
140 198
141=item elements [--json] 199=item C<elements> [C<--json>]
142 200
143Outputs a table of known element aliases with their hex ID and the format 201Outputs a table of known element aliases with their hex ID and the format
144type. 202type.
145 203
146With C<--json> it prints similar information as a JSON object, for easier parsing. 204With C<--json> it prints similar information as a JSON object, for easier parsing.
147 205
148=item export-regf F<path> 206=item C<export-regf> F<path>
149 207
150This has nothing to do with BCD data stores - it takes a registry hive 208This has nothing to do with BCD stores, but simply exposes PCBEDIT's
209internal registry hive reader - it takes a registry hive file as argument
151file as argument and outputs a JSON representation of it to standard 210and outputs a JSON representation of it to standard output.
152output.
153 211
154Hive versions 1.2 till 1.6 are supported. 212Hive versions 1.2 till 1.6 are supported.
155 213
156=item import-regf F<path> 214=item C<import-regf> F<path>
157 215
158The reverse of C<export-regf>: reads a JSON representation of a registry 216The reverse of C<export-regf>: reads a JSON representation of a registry
159hive from standard input and creates or replaces the registry hive file given as 217hive from standard input and creates or replaces the registry hive file
160argument. 218given as argument.
161 219
162The written hive will always be in a slightly modified version 1.3 220The written hive will always be in a slightly modified version 1.3
163format. It's not the format windows would generate, but it should be 221format. It's not the format windows would generate, but it should be
164understood by any conformant hive reader. 222understood by any conformant hive reader.
165 223
166Note that the representation chosen by PBCDEDIT currently throws away 224Note that the representation chosen by PBCDEDIT currently throws away
167clasname data (often used for feeble attemtps at hiding stuff by 225classname data (often used for feeble attempts at hiding stuff by
168Microsoft) and security descriptors, so if you write anything other than 226Microsoft) and security descriptors, so if you write anything other than
169a BCD hive you will most likely destroy it. 227a BCD hive you will most likely destroy it.
170 228
171=back 229=back
172 230
173 231
174=head1 BCD DATA STORE REPRESENTATION FORMAT 232=head1 BCD STORE REPRESENTATION FORMAT
175 233
176A BCD data store is represented as a JSON object with one special key, 234A BCD data store is represented as a JSON object with one special key,
177C<meta>, and one key per BCD object. That is, each BCD object becomes 235C<meta>, and one key per BCD object. That is, each BCD object becomes
178one key-value pair in the object, and an additional key called C<meta> 236one key-value pair in the object, and an additional key called C<meta>
179contains meta information. 237contains meta information.
215 } 273 }
216 274
217=head2 Minimal BCD to boot windows 275=head2 Minimal BCD to boot windows
218 276
219Experimentally I found the following BCD is the minimum required to 277Experimentally I found the following BCD is the minimum required to
220successfully boot any post-XP version of Windows (suitable C<device> and 278successfully boot any post-XP version of Windows (assuming suitable
221C<osdevice> values, of course): 279C<device> and C<osdevice> values, of course, and assuming a BIOS boot -
280for UEFI, you should use F<winload.efi> instead of F<winload.exe>):
222 281
223 { 282 {
224 "{bootmgr}" : { 283 "{bootmgr}" : {
225 "resumeobject" : "{45b547a7-8ca6-4417-9eb0-a257b61f35b4}" 284 "default" : "{45b547a7-8ca6-4417-9eb0-a257b61f35b4}"
226 }, 285 },
227 286
228 "{45b547a7-8ca6-4417-9eb0-a257b61f35b1}" : { 287 "{45b547a7-8ca6-4417-9eb0-a257b61f35b1}" : {
229 "type" : "application::osloader", 288 "type" : "application::osloader",
230 "description" : "Windows Boot", 289 "description" : "Windows Boot",
242=head2 The C<meta> key 301=head2 The C<meta> key
243 302
244The C<meta> key is not stored in the BCD data store but is used only 303The C<meta> key is not stored in the BCD data store but is used only
245by PBCDEDIT. It is always generated when exporting, and importing will 304by PBCDEDIT. It is always generated when exporting, and importing will
246be refused when it exists and the version stored inside doesn't store 305be refused when it exists and the version stored inside doesn't store
247the JSON schema version of PBCDEDIT. This ensures that differemt and 306the JSON schema version of PBCDEDIT. This ensures that different and
248incompatible versions of PBCDEDIT will not read and misinterΓΌret each 307incompatible versions of PBCDEDIT will not read and misinterpret each
249others data. 308others data.
250 309
251=head2 The object keys 310=head2 The object keys
252 311
253Every other key is a BCD object. There is usually a BCD object for the 312Every other key is a BCD object. There is usually a BCD object for the
254boot manager, one for every boot option and a few others that store common 313boot manager, one for every boot option and a few others that store common
255settings inherited by these. 314settings inherited by these.
256 315
257Each BCD object is represented by a GUID wrapped in curly braces. These 316Each BCD object is represented by a GUID wrapped in curly braces. These
258are usually random GUIDs used only to distinguish bCD objects from each 317are usually random GUIDs used only to distinguish BCD objects from each
259other. When adding a new boot option, you can simply generate a new GUID. 318other. When adding a new boot option, you can simply generate a new GUID.
260 319
261Some of these GUIDs are fixed well known GUIDs which PBCDEDIT will decode 320Some of these GUIDs are fixed well known GUIDs which PBCDEDIT will decode
262into human-readable strings such as C<{globalsettings}>, which is the same 321into human-readable strings such as C<{globalsettings}>, which is the same
263as C<{7ea2e1ac-2e61-4728-aaa3-896d9d0a9f0e}>. 322as C<{7ea2e1ac-2e61-4728-aaa3-896d9d0a9f0e}>.
297get a list of all BCD elements known to PBCDEDIT by running F<pbcdedit 356get a list of all BCD elements known to PBCDEDIT by running F<pbcdedit
298elements>. 357elements>.
299 358
300What was said about duplicate keys mapping to the same object is true for 359What was said about duplicate keys mapping to the same object is true for
301elements as well, so, again, you should always use the canonical name, 360elements as well, so, again, you should always use the canonical name,
302whcih is the human radable alias, if known. 361which is the human readable alias, if known.
303 362
304=head3 BCD element types 363=head3 BCD element types
305 364
306Each BCD element has a type such as I<string> or I<boolean>. This type 365Each BCD element has a type such as I<string> or I<boolean>. This type
307determines how the value is interpreted, and most of them are pretty easy 366determines how the value is interpreted, and most of them are pretty easy
319 "description" : "Windows 10", 378 "description" : "Windows 10",
320 "systemroot" : "\\Windows", 379 "systemroot" : "\\Windows",
321 380
322=item boolean 381=item boolean
323 382
324Almost as simnple are booleans, which represent I<true>/I<false>, 383Almost as simple are booleans, which represent I<true>/I<false>,
325I<on>/I<off> and similar values. In the JSON form, true is represented 384I<on>/I<off> and similar values. In the JSON form, true is represented
326by the number C<1>, and false is represented by the number C<0>. Other 385by the number C<1>, and false is represented by the number C<0>. Other
327values will be accepted, but PBCDEDIT doesn't guarantee how these are 386values will be accepted, but PBCDEDIT doesn't guarantee how these are
328interpreted. 387interpreted.
329 388
333 392
334 "displaybootmenu" : 0, 393 "displaybootmenu" : 0,
335 394
336=item integer 395=item integer
337 396
338Again, very simple, this is a 64 bit integer. IT can be either specified 397Again, very simple, this is a 64 bit integer. It can be either specified
339as a decimal number, as a hex number (by prefixing it with C<0x>) or as a 398as a decimal number, as a hex number (by prefixing it with C<0x>) or as a
340binatry number (prefix C<0b>). 399binary number (prefix C<0b>).
341 400
342For example, the boot C<timeout> is an integer, specifying the automatic 401For example, the boot C<timeout> is an integer, specifying the automatic
343boot delay in seconds: 402boot delay in seconds:
344 403
345 "timeout" : 30, 404 "timeout" : 30,
346 405
347=item integer list 406=item integer list
348 407
349This is a list of 64 bit integers separated by whitespace. It is not used 408This is a list of 64 bit integers separated by whitespace. It is not used
350much, so here is a somewhat artificial an untested exanmple of using 409much, so here is a somewhat artificial an untested example of using
351C<customactions> to specify a certain custom, eh, action to be executed 410C<customactions> to specify a certain custom, eh, action to be executed
352when pressing C<F10> at boot: 411when pressing C<F10> at boot:
353 412
354 "customactions" : "0x1000044000001 0x54000001", 413 "customactions" : "0x1000044000001 0x54000001",
355 414
356=item guid 415=item guid
357 416
358This represents a single GUID value wrqapped in curly braces. It is used a 417This represents a single GUID value wrapped in curly braces. It is used a
359lot to refer from one BCD object to other one. 418lot to refer from one BCD object to other one.
360 419
361For example, The C<{bootmgr}> object might refer to a resume boot option 420For example, The C<{bootmgr}> object might refer to a resume boot option
362using C<resumeobject>: 421using C<default>:
363 422
364 "resumeobject" : "{7ae02178-821d-11e7-8813-1c872c5f5ab0}", 423 "default" : "{7ae02178-821d-11e7-8813-1c872c5f5ab0}",
365 424
366Human readable aliases are used and allowed. 425Human readable aliases are used and allowed.
367 426
368=item guid list 427=item guid list
369 428
370Similar to te guid type, this represents a list of such GUIDs, separated 429Similar to the GUID type, this represents a list of such GUIDs, separated
371by whitespace from each other. 430by whitespace from each other.
372 431
373For example, many BCD objects can I<inherit> elements from other BCD 432For example, many BCD objects can I<inherit> elements from other BCD
374objects by specifying the GUIDs of those other objects ina GUID list 433objects by specifying the GUIDs of those other objects in a GUID list
375called surprisingly called C<inherit>: 434called surprisingly called C<inherit>:
376 435
377 "inherit" : "{dbgsettings} {emssettings} {badmemory}", 436 "inherit" : "{dbgsettings} {emssettings} {badmemory}",
378 437
379This example also shows how human readable aliases can be used. 438This example also shows how human readable aliases can be used.
385hacks. Understanding this type took more time than writing all the rest of 444hacks. Understanding this type took more time than writing all the rest of
386PBCDEDIT, and because it is so complex, this type has its own subsection 445PBCDEDIT, and because it is so complex, this type has its own subsection
387below. 446below.
388=back 447=back
389 448
390=head4 The BCD "device" element type 449=head3 The BCD "device" element type
391 450
392Device elements specify, well, devices. They are used for such diverse 451Device elements specify, well, devices. They are used for such diverse
393purposes such as finding a TFTP network boot imagem serial ports or VMBUS 452purposes such as finding a TFTP network boot image, serial ports or VMBUS
394devices, but most commonly they are used to specify the disk (harddisk, 453devices, but most commonly they are used to specify the disk (harddisk,
395cdrom ramdisk, vhd...) to boot from. 454cdrom, ramdisk, vhd...) to boot from.
396 455
397The device element is kind of a mini-language in its own which is much 456The device element is kind of a mini-language in its own which is much
398more versatile then the limited windows interface to it - BCDEDIT - 457more versatile then the limited windows interface to it - BCDEDIT -
399reveals. 458reveals.
400 459
403element, so almost everything known about it had to be researched first 462element, so almost everything known about it had to be researched first
404in the process of writing this script, and consequently, support for BCD 463in the process of writing this script, and consequently, support for BCD
405device elements is partial only. 464device elements is partial only.
406 465
407On the other hand, the expressive power of PBCDEDIT in specifying devices 466On the other hand, the expressive power of PBCDEDIT in specifying devices
408is much bigger than BCDEDIT and therefore more cna be don with it. The 467is much bigger than BCDEDIT and therefore more can be done with it. The
409downside is that BCD device elements are much more complicated than what 468downside is that BCD device elements are much more complicated than what
410you might think from reading the BCDEDIT documentation. 469you might think from reading the BCDEDIT documentation.
411 470
412In other words, simple things are complicated, and complicated things are 471In other words, simple things are complicated, and complicated things are
413possible. 472possible.
414 473
415Anyway, the general syntax of device elements is an optional GUID, 474Anyway, the general syntax of device elements is an optional GUID,
416followed by a device type, optionally followed by hexdecimal flags in 475followed by a device type, optionally followed by hexadecimal flags in
417angle brackets, optionally followed by C<=> and a comma-separated list of 476angle brackets, optionally followed by C<=> and a comma-separated list of
418arguments, some of which can be (and often are) in turn devices again. 477arguments, some of which can be (and often are) in turn devices again.
419 478
420 [{GUID}]type[<flags>][=arg,arg...] 479 [{GUID}]type[<flags>][=arg,arg...]
421 480
447The types understood and used by PBCDEDIT are as follows (keep in mind 506The types understood and used by PBCDEDIT are as follows (keep in mind
448that not of all the following is necessarily supported in PBCDEDIT): 507that not of all the following is necessarily supported in PBCDEDIT):
449 508
450=over 509=over
451 510
452=item binary=hex... 511=item C<binary=>I<hex...>
453 512
454This type isn't actually a real BCD element type, but a fallback for those 513This type isn't actually a real BCD element type, but a fallback for those
455cases where PBCDEDIT can't perfectly decode a device element (except for 514cases where PBCDEDIT can't perfectly decode a device element (except for
456the leading GUID, which it can always decode). In such cases, it will 515the leading GUID, which it can always decode). In such cases, it will
457convert the device into this type with a hexdump of the element data. 516convert the device into this type with a hexdump of the element data.
458 517
459=item null 518=item C<null>
460 519
461This is another special type - sometimes, a device all zero-filled, which 520This is another special type - sometimes, a device is all zero-filled,
462is not valid. This can mark the absence of a device or something PBCDEDIT 521which is not valid. This can mark the absence of a device or something
463does not understand, so it decodes it into this special "all zero" type 522PBCDEDIT does not understand, so it decodes it into this special "all
464called C<null>. 523zero" type called C<null>.
465 524
466It's most commonly found in devices that can use an optional parent 525It's most commonly found in devices that can use an optional parent
467device, when no parent device is used. 526device, when no parent device is used.
468 527
469=item boot 528=item C<boot>
470 529
471Another type without parameters, this refers to the device that was booted 530Another type without parameters, this refers to the device that was booted
472from (nowadays typically the EFI system partition). 531from (nowadays typically the EFI system partition).
473 532
474=item vmbus=interfacetype,interfaceinstance 533=item C<vmbus=>I<interfacetype>,I<interfaceinstance>
475 534
476This specifies a VMBUS device with the given interface type and interface 535This specifies a VMBUS device with the given interface type and interface
477instance, both of which are "naked" (no curly braces) GUIDs. 536instance, both of which are "naked" (no curly braces) GUIDs.
478 537
479Made-up example (couldn't find a single example on the web): 538Made-up example (couldn't find a single example on the web):
480 539
481 vmbus=c376c1c3-d276-48d2-90a9-c04748072c60,12345678-a234-b234-c234-d2345678abcd 540 vmbus=c376c1c3-d276-48d2-90a9-c04748072c60,12345678-a234-b234-c234-d2345678abcd
482 541
483=item partition=<parent>,devicetype,partitiontype,diskid,partitionid 542=item C<partition=><I<parent>>,I<devicetype>,I<partitiontype>,I<diskid>,I<partitionid>
484 543
485This designates a specific partition on a block device. C<< <parent> 544This designates a specific partition on a block device. I<parent> is an
486>> is an optional parent device on which to search on, and is often 545optional parent device on which to search on, and is often C<null>. Note
487C<null>. Note that the anfgle brackets are part of the syntax. 546that the angle brackets around I<parent> are part of the syntax.
488 547
489C<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>, 548I<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>,
490C<file> or C<vhd>, where the first three should be self-explaining, 549C<file> or C<vhd>, where the first three should be self-explaining,
491C<file> is usually used to locate a device by finding a magic file, and 550C<file> is usually used to locate a file to be used as a disk image,
492C<vhd> is used for virtual harddisks - F<.vhd> and F<-vhdx> files. 551and C<vhd> is used to treat files as virtual harddisks, i.e. F<vhd> and
552F<vhdx> files.
493 553
494The C<partitiontype> is either C<mbr>, C<gpt> or C<raw>, the latter being 554The I<partitiontype> is either C<mbr>, C<gpt> or C<raw>, the latter being
495used for devices without partitions, such as cdroms, where the "partition" 555used for devices without partitions, such as cdroms, where the "partition"
496is usually the whole device. 556is usually the whole device.
497 557
498The C<diskid> identifies the disk or device using a unique signature, and 558The I<diskid> identifies the disk or device using a unique signature, and
499the same is true for the C<partitionid>. How these are interpreted depends 559the same is true for the I<partitionid>. How these are interpreted depends
500on the C<partitiontype>: 560on the I<partitiontype>:
501 561
502=over 562=over
503 563
504=item mbr 564=item C<mbr>
505 565
506The C<diskid> is the 32 bit disk signature stored at offset 0x1b8 in the 566The C<diskid> is the 32 bit disk signature stored at offset 0x1b8 in the
507MBR, interpreted as a 32 bit unsigned little endian integer and written as 567MBR, interpreted as a 32 bit unsigned little endian integer and written as
508hex number. That is, the bytes C<01 02 03 04> would become C<04030201>. 568hex number. That is, the bytes C<01 02 03 04> would become C<04030201>.
509 569
510Diskpart (using the C<DETAIL> command) and the C<lsblk> comamnd typically 570Diskpart (using the C<DETAIL> command) and the C<lsblk> command typically
511found on GNU/Linux systems (using e.g. C<lsblk -o NAME,PARTUUID>) can 571found on GNU/Linux systems (using e.g. C<lsblk -o NAME,PARTUUID>) can
512display the disk id. 572display the I<diskid>.
513 573
514The C<partitionid> is the byte offset(!) of the partition counting from 574The I<partitionid> is the byte offset(!) of the partition counting from
515the beginning of the MBR. 575the beginning of the MBR.
516 576
517Example, use the partition on the harddisk with C<diskid> C<47cbc08a> 577Example, use the partition on the harddisk with I<diskid> C<47cbc08a>
518starting at sector C<2048> (= 1048576 / 512). 578starting at sector C<2048> (= 1048576 / 512).
519 579
520 partition=<null>,harddisk,mbr,47cbc08a,1048576 580 partition=<null>,harddisk,mbr,47cbc08a,1048576
521 581
522=item gpt 582=item C<gpt>
523 583
524The C<diskid> is the disk UUID/disk identifier GUID from the partition 584The I<diskid> is the disk GUID/disk identifier GUID from the partition
525table (as displayed e.g. by C<gdisk>), and the C<partitionid> is the 585table (as displayed e.g. by F<gdisk>), and the I<partitionid> is the
526partition unique GUID (displayed using e.g. the C<gdisk> C<i> command). 586partition unique GUID (displayed using e.g. the F<gdisk> F<i> command).
527 587
528Example: use the partition C<76d39e5f-ad1b-407e-9c05-c81eb83b57dd> on GPT 588Example: use the partition C<76d39e5f-ad1b-407e-9c05-c81eb83b57dd> on GPT
529disk C<9742e468-9206-48a0-b4e4-c4e9745a356a>. 589disk C<9742e468-9206-48a0-b4e4-c4e9745a356a>.
530 590
531 partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,76d39e5f-ad1b-407e-9c05-c81eb83b57dd 591 partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,76d39e5f-ad1b-407e-9c05-c81eb83b57dd
532 592
533=item raw 593=item C<raw>
534 594
535Instead of diskid and partitionid, this type only accepts a decimal disk 595Instead of I<diskid> and I<partitionid>, this type only accepts a decimal
536number and signifies the whole disk. BCDEDIT cannot display the resulting 596disk number and signifies the whole disk. BCDEDIT cannot display the
537device, and I am doubtful whether it has a useful effect. 597resulting device, and I am doubtful whether it has a useful effect.
538 598
539=back 599=back
540 600
541=item legacypartition=<parent>,devicetype,partitiontype,diskid,partitionid 601=item C<legacypartition=><I<parent>>,I<devicetype>,I<partitiontype>,I<diskid>,I<partitionid>
542 602
543This is exactly the same as the C<partition> type, except for a tiny 603This is exactly the same as the C<partition> type, except for a tiny
544detail: instead of using the partition start offset, this type uses the 604detail: instead of using the partition start offset, this type uses the
545partition number for MBR disks. Behaviour other partition types should be 605partition number for MBR disks. Behaviour other partition types should be
546the same. 606the same.
547 607
548The partition number starts at C<1> and skips unused partition, so if 608The partition number starts at C<1> and skips unused partition, so if
549there are two primary partitions and another partition inside the extended 609there are two primary partitions and another partition inside the extended
550partition, the primary partitions are number C<1> and C<2> and the 610partition, the primary partitions are number C<1> and C<2> and the
551partition inside the extended partition is number C<3>, rwegardless of any 611partition inside the extended partition is number C<3>, regardless of any
552gaps. 612gaps.
553 613
554=item locate=<parent>,locatetype,locatearg 614=item C<locate=><I<parent>>,I<locatetype>,I<locatearg>
555 615
556This device description will make the bootloader search for a partition 616This device description will make the bootloader search for a partition
557with a given path. 617with a given path.
558 618
559The C<< <parent> >> device is the device to search on (angle brackets are 619The I<parent> device is the device to search on (angle brackets are
560still part of the syntax!) If it is C<< <null> >>, then C<locate> will 620still part of the syntax!) If it is C<null>, then C<locate> will
561search all disks it can find. 621search all disks it can find.
562 622
563C<locatetype> is either C<element> or C<path>, and merely distinguishes 623I<locatetype> is either C<element> or C<path>, and merely distinguishes
564between two different ways to specify the path to search for: C<element> 624between two different ways to specify the path to search for: C<element>
565uses an element ID (either as hex or as name) as C<locatearg> and C<path> 625uses an element ID (either as hex or as name) as I<locatearg> and C<path>
566uses a relative path as C<locatearg>. 626uses a relative path as I<locatearg>.
567 627
568Example: find any partition which has the C<magicfile.xxx> path in the 628Example: find any partition which has the F<magicfile.xxx> path in the
569root. 629root.
570 630
571 locate=<null>,path,\magicfile.xxx 631 locate=<null>,path,\magicfile.xxx
572 632
573Example: find any partition which has the path specified in the 633Example: find any partition which has the path specified in the
574C<systemroot> element (typically C<\Windows>). 634C<systemroot> element (typically F<\Windows>).
575 635
576 locate=<null>,element,systemroot 636 locate=<null>,element,systemroot
577 637
578=item block=devicetype,args... 638=item C<block=>I<devicetype>,I<args...>
579 639
580Last not least, the most complex type, C<block>, which... specifies block 640Last not least, the most complex type, C<block>, which... specifies block
581devices (which could be inside a F<vhdx> file for example). 641devices (which could be inside a F<vhdx> file for example).
582 642
583C<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>, 643I<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>,
584C<file> or C<vhd> - the same as for C<partiion=>. 644C<file> or C<vhd> - the same as for C<partition=>.
585 645
586The remaining arguments change depending on the C<devicetype>: 646The remaining arguments change depending on the I<devicetype>:
587 647
588=over 648=over
589 649
590=item block=file,<parent>,path 650=item C<block=file>,<I<parent>>,I<path>
591 651
592Interprets the C<< <parent> >> device (typically a partition) as a 652Interprets the I<parent> device (typically a partition) as a
593filesystem and specifies a file path inside. 653filesystem and specifies a file path inside.
594 654
595=item block=vhd,<parent> 655=item C<block=vhd>,<I<parent>>
596 656
597Pretty much just changes the interpretation of C<< <parent> >>, which is 657Pretty much just changes the interpretation of I<parent>, which is
598usually a disk image (C<block=file,...)>) to be a F<vhd> or F<vhdx> file. 658usually a disk image (C<block=file,...)>) to be a F<vhd> or F<vhdx> file.
599 659
600=item block=ramdisk,<parent>,base,size,offset,path 660=item C<block=ramdisk>,<I<parent>>,I<base>,I<size>,I<offset>,I<path>
601 661
602Interprets the C<< <parent> >> device as RAM disk, using the (decimal) 662Interprets the I<parent> device as RAM disk, using the (decimal)
603base address, byte size and byte offset inside a file specified by 663base address, byte size and byte offset inside a file specified by
604C<path>. The numbers are usually all C<0> because they cna be extracted 664I<path>. The numbers are usually all C<0> because they can be extracted
605from the RAM disk image or other parameters. 665from the RAM disk image or other parameters.
606 666
607This is most commonly used to boot C<wim> images. 667This is most commonly used to boot C<wim> images.
608 668
609=item block=floppy,drivenum 669=item C<block=floppy>,I<drivenum>
610 670
611Refers to a removable drive identified by a number. BCDEDIT cannot display 671Refers to a removable drive identified by a number. BCDEDIT cannot display
612the resultinfg device, and it is not clear what effect it will have. 672the resulting device, and it is not clear what effect it will have.
613 673
614=item block=cdrom,drivenum 674=item C<block=cdrom>,I<drivenum>
615 675
616Pretty much the same as C<floppy> but for CD-ROMs. 676Pretty much the same as C<floppy> but for CD-ROMs.
617 677
618=item anything else 678=item anything else
619 679
620Probably not yet implemented. Tell me of your needs... 680Probably not yet implemented. Tell me of your needs...
621 681
622=back 682=back
623 683
624=back5 Examples 684=head4 Examples
625 685
626This concludes the syntax overview for device elements, but probably 686This concludes the syntax overview for device elements, but probably
627leaves many questions open. I can't help with most of them, as I also ave 687leaves many questions open. I can't help with most of them, as I also have
628many questions, but I can walk you through some actual examples using mroe 688many questions, but I can walk you through some actual examples using more
629complex aspects. 689complex aspects.
630 690
631=item locate=<block=vhd,<block=file,<locate=<null>,path,\disk.vhdx>,\disk.vhdx>>,element,path 691=item C<< locate=<block=vhd,<block=file,<locate=<null>,path,\disk.vhdx>,\disk.vhdx>>,element,path >>
632 692
633Just like with C declarations, you best treat device descriptors as 693Just like with C declarations, you best treat device descriptors as
634instructions to find your device and work your way from the inside out: 694instructions to find your device and work your way from the inside out:
635 695
636 locate=<null>,path,\disk.vhdx 696 locate=<null>,path,\disk.vhdx
643Next, this takes the device locate has found and finds a file called 703Next, this takes the device locate has found and finds a file called
644F<\disk.vhdx> on it. This is the same file locate was using, but that is 704F<\disk.vhdx> on it. This is the same file locate was using, but that is
645only because we find the device using the same path as finding the disk 705only because we find the device using the same path as finding the disk
646image, so this is purely incidental, although quite common. 706image, so this is purely incidental, although quite common.
647 707
648Bext, this file will be opened as a virtual disk: 708Next, this file will be opened as a virtual disk:
649 709
650 block=vhd,<see above> 710 block=vhd,<see above>
651 711
652And finally, inside this disk, another C<locate> will look for a partition 712And finally, inside this disk, another C<locate> will look for a partition
653with a path as specified in the C<path> element, which most likely will be 713with a path as specified in the C<path> element, which most likely will be
656 locate=<see above>,element,path 716 locate=<see above>,element,path
657 717
658As a result, this will boot the first Windows it finds on the first 718As a result, this will boot the first Windows it finds on the first
659F<disk.vhdx> disk image it can find anywhere. 719F<disk.vhdx> disk image it can find anywhere.
660 720
661=item locate=<block=vhd,<block=file,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,\win10.vhdx>>,element,path 721=item C<< locate=<block=vhd,<block=file,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,\win10.vhdx>>,element,path >>
662 722
663Pretty much the same as the previous case, but witzh a bit of variance. First, look for a specific partition on 723Pretty much the same as the previous case, but with a bit of
664an MBR-partitioned disk: 724variance. First, look for a specific partition on an MBR-partitioned disk:
665 725
666 partition=<null>,harddisk,mbr,47cbc08a,242643632128 726 partition=<null>,harddisk,mbr,47cbc08a,242643632128
667 727
668Then open the file F<\win10.vhdx> on that partition: 728Then open the file F<\win10.vhdx> on that partition:
669 729
675 735
676And again the windows loader (or whatever is in C<path>) will be searched: 736And again the windows loader (or whatever is in C<path>) will be searched:
677 737
678 locate=<see above>,element,path 738 locate=<see above>,element,path
679 739
680=item {b097d2b2-bc00-11e9-8a9a-525400123456}block<1>=ramdisk,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,0,0,0,\boot.wim 740=item C<< {b097d2b2-bc00-11e9-8a9a-525400123456}block<1>=ramdisk,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,0,0,0,\boot.wim >>
681 741
682This is quite different. First, it starts with a GUID. This GUID belongs 742This is quite different. First, it starts with a GUID. This GUID belongs
683to a BCD object of type C<device>, which has additional parameters: 743to a BCD object of type C<device>, which has additional parameters:
684 744
685 "{b097d2b2-bc00-11e9-8a9a-525400123456}" : { 745 "{b097d2b2-bc00-11e9-8a9a-525400123456}" : {
688 "ramdisksdidevice" : "partition=<null>,harddisk,mbr,47cbc08a,1048576", 748 "ramdisksdidevice" : "partition=<null>,harddisk,mbr,47cbc08a,1048576",
689 "ramdisksdipath" : "\boot.sdi" 749 "ramdisksdipath" : "\boot.sdi"
690 }, 750 },
691 751
692I will not go into many details, but this specifies a (presumably empty) 752I will not go into many details, but this specifies a (presumably empty)
693template ramdisk image (F<\boot.sdi>) that is used to initiaolize the 753template ramdisk image (F<\boot.sdi>) that is used to initialize the
694ramdisk. The F<\boot.wim> file is then extracted into it. As you cna also 754ramdisk. The F<\boot.wim> file is then extracted into it. As you can also
695see, this F<.sdi> file resides on a different C<partition>. 755see, this F<.sdi> file resides on a different C<partition>.
696 756
697Continuitn, as always, form the inside out, first this device descriptor 757Continuing, as always, from the inside out, first this device descriptor
698finds a specific partition: 758finds a specific partition:
699 759
700 partition=<null>,harddisk,mbr,47cbc08a,242643632128 760 partition=<null>,harddisk,mbr,47cbc08a,242643632128
701 761
702And then specifies a C<ramdisk> image on this partition: 762And then specifies a C<ramdisk> image on this partition:
707seems to be always there on this kind of entry. 767seems to be always there on this kind of entry.
708 768
709If you have some good examples to add here, feel free to mail me. 769If you have some good examples to add here, feel free to mail me.
710 770
711 771
712=head1 EDITING BCD DATA STORES 772=head1 EDITING BCD STORES
713 773
714The C<edit> and C<parse> subcommands allow you to read a BCD data store 774The C<edit> and C<parse> subcommands allow you to read a BCD data store
715and modify it or extract data from it. This is done by exyecuting a series 775and modify it or extract data from it. This is done by executing a series
716of "editing instructions" which are explained here. 776of "editing instructions" which are explained here.
717 777
718=over 778=over
719 779
720=item get I<object> I<element> 780=item C<get> I<object> I<element>
721 781
722Reads the BCD element I<element> from the BCD object I<object> and writes 782Reads the BCD element I<element> from the BCD object I<object> and writes
723it to standard output, followed by a newline. The I<object> can be a GUID 783it to standard output, followed by a newline. The I<object> can be a GUID
724or a human-readable alias, or the special string C<{default}>, which will 784or a human-readable alias, or the special string C<{default}>, which will
725refer to the default BCD object. 785refer to the default BCD object.
726 786
727Example: find description of the default BCD object. 787Example: find description of the default BCD object.
728 788
729 pbcdedit parse BCD get "{default}" description 789 pbcdedit parse BCD get "{default}" description
730 790
731=item set I<object> I<element> I<value> 791=item C<set> I<object> I<element> I<value>
732 792
733Similar to C<get>, but sets the element to the given I<value> instead. 793Similar to C<get>, but sets the element to the given I<value> instead.
734 794
735Example: change bootmgr default too 795Example: change the bootmgr default too
736C<{b097d2ad-bc00-11e9-8a9a-525400123456}>: 796C<{b097d2ad-bc00-11e9-8a9a-525400123456}>:
737 797
738 pbcdedit edit BCD set "{bootmgr}" resumeobject "{b097d2ad-bc00-11e9-8a9a-525400123456}" 798 pbcdedit edit BCD set "{bootmgr}" default "{b097d2ad-bc00-11e9-8a9a-525400123456}"
739 799
740=item eval I<perlcode> 800=item C<eval> I<perlcode>
741 801
742This takes the next argument, interprets it as Perl code and 802This takes the next argument, interprets it as Perl code and
743evaluates it. This allows you to do more complicated modifications or 803evaluates it. This allows you to do more complicated modifications or
744extractions. 804extractions.
745 805
764The example given for C<get>, above, could be expressed like this with 824The example given for C<get>, above, could be expressed like this with
765C<eval>: 825C<eval>:
766 826
767 pbcdedit edit BCD eval 'say $BCD->{$DEFAULT}{description}' 827 pbcdedit edit BCD eval 'say $BCD->{$DEFAULT}{description}'
768 828
769The example given for C<set> could be expresed like this: 829The example given for C<set> could be expressed like this:
770 830
771 pbcdedit edit BCD eval '$BCD->{$DEFAULT}{resumeobject} = "{b097d2ad-bc00-11e9-8a9a-525400123456}"' 831 pbcdedit edit BCD eval '$BCD->{"{bootmgr}"{default} = "{b097d2ad-bc00-11e9-8a9a-525400123456}"'
772 832
773=item do I<path> 833=item C<do> I<path>
774 834
775Similar to C<eval>, above, but instead of using the argument as perl code, 835Similar to C<eval>, above, but instead of using the argument as perl code,
776it loads the perl code from the given file and executes it. This makes it 836it loads the perl code from the given file and executes it. This makes it
777easier to write more complicated or larger programs. 837easier to write more complicated or larger programs.
778 838
779=back 839=back
780 840
841
781=head1 SEE ALSO 842=head1 SEE ALSO
782 843
783For ideas on what you can do, and some introductory material, try 844For ideas on what you can do with BCD stores in
845general, and some introductory material, try
784L<http://www.mistyprojects.co.uk/documents/BCDEdit/index.html>. 846L<http://www.mistyprojects.co.uk/documents/BCDEdit/index.html>.
785 847
786For good reference on BCD objects and elements, see Geoff Chappels pages 848For good reference on which BCD objects and
849elements exist, see Geoff Chappell's pages at
787at L<http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm>. 850L<http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm>.
788 851
789=head1 AUTHOR 852=head1 AUTHOR
790 853
791Written by Marc A. Lehmann <pbcdedit@schmorp.de>. 854Written by Marc A. Lehmann L<pbcdedit@schmorp.de>.
792 855
793=head1 REPORTING BUGS 856=head1 REPORTING BUGS
794 857
795Bugs can be reported dorectly tt he author at L<pcbedit@schmorp.de>. 858Bugs can be reported directly the author at L<pcbedit@schmorp.de>.
796 859
797=head1 BUGS AND SHORTCOMINGS 860=head1 BUGS AND SHORTCOMINGS
798 861
799This should be a module. Of a series of modules, even. 862This should be a module. Of a series of modules, even.
800 863
801Registry code should preserve classname and security descriptor data, and 864Registry code should preserve classname and security descriptor data, and
802whatever else is necessary to read and write any registry hive file. 865whatever else is necessary to read and write any registry hive file.
803 866
804I am also not happy with device descriptors being strings rather than a 867I am also not happy with device descriptors being strings rather than a
805data structure, but strings are probably better for command line usage. In 868data structure, but strings are probably better for command line usage. In
806any case,. device descriptors could be converted by simply "splitting" at 869any case, device descriptors could be converted by simply "splitting" at
807"=" and "," into an array reference, recursively. 870"=" and "," into an array reference, recursively.
808 871
809=head1 HOMEPAGE 872=head1 HOMEPAGE
810 873
811Original versions of this program can be found at 874Original versions of this program can be found at
818free to change and redistribute it. There is NO WARRANTY, to the extent 881free to change and redistribute it. There is NO WARRANTY, to the extent
819permitted by law. 882permitted by law.
820 883
821=cut 884=cut
822 885
823BEGIN { require "common/sense.pm"; common::sense->import } # common sense is optional, but recommended 886# common sense is optional, but recommended
887BEGIN { eval { require "common/sense.pm"; } && common::sense->import }
824 888
825use Data::Dump; 889no warnings 'portable'; # avoid 32 bit integer warnings
890
826use Encode (); 891use Encode ();
827use List::Util (); 892use List::Util ();
828use IO::Handle (); 893use IO::Handle ();
829use Time::HiRes (); 894use Time::HiRes ();
830 895
853 or die "$path: short read\n"; 918 or die "$path: short read\n";
854 919
855 $buf 920 $buf
856} 921}
857 922
858# sources and resources used for this: 923# sources and resources used for writing pbcdedit
924#
859# registry: 925# registry:
860# https://github.com/msuhanov/regf/blob/master/Windows%20registry%20file%20format%20specification.md 926# https://github.com/msuhanov/regf/blob/master/Windows%20registry%20file%20format%20specification.md
861# http://amnesia.gtisc.gatech.edu/~moyix/suzibandit.ltd.uk/MSc/ 927# http://amnesia.gtisc.gatech.edu/~moyix/suzibandit.ltd.uk/MSc/
862# bcd: 928# bcd:
863# http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm 929# http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm
1351sub BCDE_FORMAT_GUID_LIST () { 0x04000000 } 1417sub BCDE_FORMAT_GUID_LIST () { 0x04000000 }
1352sub BCDE_FORMAT_INTEGER () { 0x05000000 } 1418sub BCDE_FORMAT_INTEGER () { 0x05000000 }
1353sub BCDE_FORMAT_BOOLEAN () { 0x06000000 } 1419sub BCDE_FORMAT_BOOLEAN () { 0x06000000 }
1354sub BCDE_FORMAT_INTEGER_LIST () { 0x07000000 } 1420sub BCDE_FORMAT_INTEGER_LIST () { 0x07000000 }
1355 1421
1356sub dec_device;
1357sub enc_device;
1358
1359sub enc_integer($) { 1422sub enc_integer($) {
1360 no warnings 'portable'; # ugh
1361 my $value = shift; 1423 my $value = shift;
1362 $value = oct $value if $value =~ /^0[bBxX]/; 1424 $value = oct $value if $value =~ /^0[bBxX]/;
1363 unpack "H*", pack "Q<", $value 1425 unpack "H*", pack "Q<", $value
1364} 1426}
1427
1428sub enc_device($$);
1429sub dec_device($$);
1365 1430
1366our %bcde_dec = ( 1431our %bcde_dec = (
1367 BCDE_FORMAT_DEVICE , \&dec_device, 1432 BCDE_FORMAT_DEVICE , \&dec_device,
1368# # for round-trip verification 1433# # for round-trip verification
1369# BCDE_FORMAT_DEVICE , sub { 1434# BCDE_FORMAT_DEVICE , sub {
1379 BCDE_FORMAT_BOOLEAN , sub { shift eq "00" ? 0 : 1 }, 1444 BCDE_FORMAT_BOOLEAN , sub { shift eq "00" ? 0 : 1 },
1380 BCDE_FORMAT_INTEGER_LIST, sub { join " ", unpack "Q*", pack "H*", shift }, # not sure if this cna be 4 bytes 1445 BCDE_FORMAT_INTEGER_LIST, sub { join " ", unpack "Q*", pack "H*", shift }, # not sure if this cna be 4 bytes
1381); 1446);
1382 1447
1383our %bcde_enc = ( 1448our %bcde_enc = (
1384 BCDE_FORMAT_DEVICE , sub { binary => enc_device shift }, 1449 BCDE_FORMAT_DEVICE , sub { binary => enc_device $_[0], $_[1] },
1385 BCDE_FORMAT_STRING , sub { sz => shift }, 1450 BCDE_FORMAT_STRING , sub { sz => shift },
1386 BCDE_FORMAT_GUID , sub { sz => "{" . (dec_guid enc_wguid shift) . "}" }, 1451 BCDE_FORMAT_GUID , sub { sz => "{" . (dec_guid enc_wguid shift) . "}" },
1387 BCDE_FORMAT_GUID_LIST , sub { multi_sz => [map "{" . (dec_guid enc_wguid $_) . "}", split /\s+/, shift ] }, 1452 BCDE_FORMAT_GUID_LIST , sub { multi_sz => [map "{" . (dec_guid enc_wguid $_) . "}", split /\s+/, shift ] },
1388 BCDE_FORMAT_INTEGER , sub { binary => enc_integer shift }, 1453 BCDE_FORMAT_INTEGER , sub { binary => enc_integer shift },
1389 BCDE_FORMAT_BOOLEAN , sub { binary => shift ? "01" : "00" }, 1454 BCDE_FORMAT_BOOLEAN , sub { binary => shift ? "01" : "00" },
1390 BCDE_FORMAT_INTEGER_LIST, sub { binary => join "", map enc_integer $_, split /\s+/, shift }, 1455 BCDE_FORMAT_INTEGER_LIST, sub { binary => join "", map enc_integer $_, split /\s+/, shift },
1391); 1456);
1392 1457
1393# BCD Elements 1458# BCD Elements
1394our %bcde = ( 1459our %bcde_byclass = (
1460 any => {
1395 0x11000001 => 'device', 1461 0x11000001 => 'device',
1396 0x12000002 => 'path', 1462 0x12000002 => 'path',
1397 0x12000004 => 'description', 1463 0x12000004 => 'description',
1398 0x12000005 => 'locale', 1464 0x12000005 => 'locale',
1399 0x14000006 => 'inherit', 1465 0x14000006 => 'inherit',
1400 0x15000007 => 'truncatememory', 1466 0x15000007 => 'truncatememory',
1401 0x14000008 => 'recoverysequence', 1467 0x14000008 => 'recoverysequence',
1402 0x16000009 => 'recoveryenabled', 1468 0x16000009 => 'recoveryenabled',
1403 0x1700000a => 'badmemorylist', 1469 0x1700000a => 'badmemorylist',
1404 0x1600000b => 'badmemoryaccess', 1470 0x1600000b => 'badmemoryaccess',
1405 0x1500000c => 'firstmegabytepolicy', 1471 0x1500000c => 'firstmegabytepolicy',
1406 0x1500000d => 'relocatephysical', 1472 0x1500000d => 'relocatephysical',
1407 0x1500000e => 'avoidlowmemory', 1473 0x1500000e => 'avoidlowmemory',
1408 0x1600000f => 'traditionalkseg', 1474 0x1600000f => 'traditionalkseg',
1409 0x16000010 => 'bootdebug', 1475 0x16000010 => 'bootdebug',
1410 0x15000011 => 'debugtype', 1476 0x15000011 => 'debugtype',
1411 0x15000012 => 'debugaddress', 1477 0x15000012 => 'debugaddress',
1412 0x15000013 => 'debugport', 1478 0x15000013 => 'debugport',
1413 0x15000014 => 'baudrate', 1479 0x15000014 => 'baudrate',
1414 0x15000015 => 'channel', 1480 0x15000015 => 'channel',
1415 0x12000016 => 'targetname', 1481 0x12000016 => 'targetname',
1416 0x16000017 => 'noumex', 1482 0x16000017 => 'noumex',
1417 0x15000018 => 'debugstart', 1483 0x15000018 => 'debugstart',
1418 0x12000019 => 'busparams', 1484 0x12000019 => 'busparams',
1419 0x1500001a => 'hostip', 1485 0x1500001a => 'hostip',
1420 0x1500001b => 'port', 1486 0x1500001b => 'port',
1421 0x1600001c => 'dhcp', 1487 0x1600001c => 'dhcp',
1422 0x1200001d => 'key', 1488 0x1200001d => 'key',
1423 0x1600001e => 'vm', 1489 0x1600001e => 'vm',
1424 0x16000020 => 'bootems', 1490 0x16000020 => 'bootems',
1425 0x15000022 => 'emsport', 1491 0x15000022 => 'emsport',
1426 0x15000023 => 'emsbaudrate', 1492 0x15000023 => 'emsbaudrate',
1427 0x12000030 => 'loadoptions', 1493 0x12000030 => 'loadoptions',
1428 0x16000040 => 'advancedoptions', 1494 0x16000040 => 'advancedoptions',
1429 0x16000041 => 'optionsedit', 1495 0x16000041 => 'optionsedit',
1430 0x15000042 => 'keyringaddress', 1496 0x15000042 => 'keyringaddress',
1431 0x11000043 => 'bootstatdevice', 1497 0x11000043 => 'bootstatdevice',
1432 0x12000044 => 'bootstatfilepath', 1498 0x12000044 => 'bootstatfilepath',
1433 0x16000045 => 'preservebootstat', 1499 0x16000045 => 'preservebootstat',
1434 0x16000046 => 'graphicsmodedisabled', 1500 0x16000046 => 'graphicsmodedisabled',
1435 0x15000047 => 'configaccesspolicy', 1501 0x15000047 => 'configaccesspolicy',
1436 0x16000048 => 'nointegritychecks', 1502 0x16000048 => 'nointegritychecks',
1437 0x16000049 => 'testsigning', 1503 0x16000049 => 'testsigning',
1438 0x1200004a => 'fontpath', 1504 0x1200004a => 'fontpath',
1439 0x1500004b => 'integrityservices', 1505 0x1500004b => 'integrityservices',
1440 0x1500004c => 'volumebandid', 1506 0x1500004c => 'volumebandid',
1441 0x16000050 => 'extendedinput', 1507 0x16000050 => 'extendedinput',
1442 0x15000051 => 'initialconsoleinput', 1508 0x15000051 => 'initialconsoleinput',
1443 0x15000052 => 'graphicsresolution', 1509 0x15000052 => 'graphicsresolution',
1444 0x16000053 => 'restartonfailure', 1510 0x16000053 => 'restartonfailure',
1445 0x16000054 => 'highestmode', 1511 0x16000054 => 'highestmode',
1446 0x16000060 => 'isolatedcontext', 1512 0x16000060 => 'isolatedcontext',
1447 0x15000065 => 'displaymessage', 1513 0x15000065 => 'displaymessage',
1448 0x15000066 => 'displaymessageoverride', 1514 0x15000066 => 'displaymessageoverride',
1449 0x16000068 => 'nobootuxtext', 1515 0x16000068 => 'nobootuxtext',
1450 0x16000069 => 'nobootuxprogress', 1516 0x16000069 => 'nobootuxprogress',
1451 0x1600006a => 'nobootuxfade', 1517 0x1600006a => 'nobootuxfade',
1452 0x1600006b => 'bootuxreservepooldebug', 1518 0x1600006b => 'bootuxreservepooldebug',
1453 0x1600006c => 'bootuxdisabled', 1519 0x1600006c => 'bootuxdisabled',
1454 0x1500006d => 'bootuxfadeframes', 1520 0x1500006d => 'bootuxfadeframes',
1455 0x1600006e => 'bootuxdumpstats', 1521 0x1600006e => 'bootuxdumpstats',
1456 0x1600006f => 'bootuxshowstats', 1522 0x1600006f => 'bootuxshowstats',
1457 0x16000071 => 'multibootsystem', 1523 0x16000071 => 'multibootsystem',
1458 0x16000072 => 'nokeyboard', 1524 0x16000072 => 'nokeyboard',
1459 0x15000073 => 'aliaswindowskey', 1525 0x15000073 => 'aliaswindowskey',
1460 0x16000074 => 'bootshutdowndisabled', 1526 0x16000074 => 'bootshutdowndisabled',
1461 0x15000075 => 'performancefrequency', 1527 0x15000075 => 'performancefrequency',
1462 0x15000076 => 'securebootrawpolicy', 1528 0x15000076 => 'securebootrawpolicy',
1463 0x17000077 => 'allowedinmemorysettings', 1529 0x17000077 => 'allowedinmemorysettings',
1464 0x15000079 => 'bootuxtransitiontime', 1530 0x15000079 => 'bootuxtransitiontime',
1465 0x1600007a => 'mobilegraphics', 1531 0x1600007a => 'mobilegraphics',
1466 0x1600007b => 'forcefipscrypto', 1532 0x1600007b => 'forcefipscrypto',
1467 0x1500007d => 'booterrorux', 1533 0x1500007d => 'booterrorux',
1468 0x1600007e => 'flightsigning', 1534 0x1600007e => 'flightsigning',
1469 0x1500007f => 'measuredbootlogformat', 1535 0x1500007f => 'measuredbootlogformat',
1470 0x15000080 => 'displayrotation', 1536 0x15000080 => 'displayrotation',
1471 0x15000081 => 'logcontrol', 1537 0x15000081 => 'logcontrol',
1472 0x16000082 => 'nofirmwaresync', 1538 0x16000082 => 'nofirmwaresync',
1473 0x11000084 => 'windowssyspart', 1539 0x11000084 => 'windowssyspart',
1474 0x16000087 => 'numlock', 1540 0x16000087 => 'numlock',
1475 0x22000001 => 'bpbstring', 1541 0x26000202 => 'skipffumode',
1542 0x26000203 => 'forceffumode',
1543 0x25000510 => 'chargethreshold',
1544 0x26000512 => 'offmodecharging',
1545 0x25000aaa => 'bootflow',
1546 0x45000001 => 'devicetype',
1547 0x42000002 => 'applicationrelativepath',
1548 0x42000003 => 'ramdiskdevicerelativepath',
1549 0x46000004 => 'omitosloaderelements',
1550 0x47000006 => 'elementstomigrate',
1551 0x46000010 => 'recoveryos',
1552 },
1553 bootapp => {
1554 0x26000145 => 'enablebootdebugpolicy',
1555 0x26000146 => 'enablebootorderclean',
1556 0x26000147 => 'enabledeviceid',
1557 0x26000148 => 'enableffuloader',
1558 0x26000149 => 'enableiuloader',
1559 0x2600014a => 'enablemassstorage',
1560 0x2600014b => 'enablerpmbprovisioning',
1561 0x2600014c => 'enablesecurebootpolicy',
1562 0x2600014d => 'enablestartcharge',
1563 0x2600014e => 'enableresettpm',
1564 },
1565 bootmgr => {
1476 0x24000001 => 'displayorder', 1566 0x24000001 => 'displayorder',
1477 0x21000001 => 'filedevice',
1478 0x21000001 => 'osdevice',
1479 0x25000001 => 'passcount',
1480 0x26000001 => 'pxesoftreboot',
1481 0x22000002 => 'applicationname',
1482 0x24000002 => 'bootsequence', 1567 0x24000002 => 'bootsequence',
1483 0x22000002 => 'filepath',
1484 0x22000002 => 'systemroot',
1485 0x25000002 => 'testmix',
1486 0x26000003 => 'cacheenable',
1487 0x26000003 => 'customsettings',
1488 0x23000003 => 'default', 1568 0x23000003 => 'default',
1489 0x25000003 => 'failurecount',
1490 0x23000003 => 'resumeobject',
1491 0x26000004 => 'failuresenabled',
1492 0x26000004 => 'pae',
1493 0x26000004 => 'stampdisks',
1494 0x25000004 => 'testtofail',
1495 0x25000004 => 'timeout', 1569 0x25000004 => 'timeout',
1496 0x21000005 => 'associatedosdevice',
1497 0x26000005 => 'cacheenable',
1498 0x26000005 => 'resume', 1570 0x26000005 => 'resume',
1499 0x25000005 => 'stridefailcount',
1500 0x26000006 => 'debugoptionenabled',
1501 0x25000006 => 'invcfailcount',
1502 0x23000006 => 'resumeobject', 1571 0x23000006 => 'resumeobject',
1503 0x25000007 => 'bootux',
1504 0x25000007 => 'matsfailcount',
1505 0x24000007 => 'startupsequence', 1572 0x24000007 => 'startupsequence',
1506 0x25000008 => 'bootmenupolicy',
1507 0x25000008 => 'randfailcount',
1508 0x25000009 => 'chckrfailcount',
1509 0x26000010 => 'detecthal',
1510 0x24000010 => 'toolsdisplayorder', 1573 0x24000010 => 'toolsdisplayorder',
1511 0x22000011 => 'kernel',
1512 0x22000012 => 'hal',
1513 0x22000013 => 'dbgtransport',
1514 0x26000020 => 'displaybootmenu', 1574 0x26000020 => 'displaybootmenu',
1515 0x25000020 => 'nx',
1516 0x26000021 => 'noerrordisplay', 1575 0x26000021 => 'noerrordisplay',
1517 0x25000021 => 'pae',
1518 0x21000022 => 'bcddevice', 1576 0x21000022 => 'bcddevice',
1519 0x26000022 => 'winpe',
1520 0x22000023 => 'bcdfilepath', 1577 0x22000023 => 'bcdfilepath',
1521 0x26000024 => 'hormenabled', 1578 0x26000024 => 'hormenabled',
1522 0x26000024 => 'hormenabled',
1523 0x26000024 => 'nocrashautoreboot',
1524 0x26000025 => 'hiberboot', 1579 0x26000025 => 'hiberboot',
1525 0x26000025 => 'lastknowngood',
1526 0x26000026 => 'oslnointegritychecks',
1527 0x22000026 => 'passwordoverride', 1580 0x22000026 => 'passwordoverride',
1528 0x26000027 => 'osltestsigning',
1529 0x22000027 => 'pinpassphraseoverride', 1581 0x22000027 => 'pinpassphraseoverride',
1530 0x26000028 => 'processcustomactionsfirst', 1582 0x26000028 => 'processcustomactionsfirst',
1531 0x27000030 => 'customactions', 1583 0x27000030 => 'customactions',
1532 0x26000030 => 'nolowmem',
1533 0x26000031 => 'persistbootsequence', 1584 0x26000031 => 'persistbootsequence',
1534 0x25000031 => 'removememory',
1535 0x25000032 => 'increaseuserva',
1536 0x26000032 => 'skipstartupsequence', 1585 0x26000032 => 'skipstartupsequence',
1537 0x25000033 => 'perfmem',
1538 0x22000040 => 'fverecoveryurl', 1586 0x22000040 => 'fverecoveryurl',
1539 0x26000040 => 'vga',
1540 0x22000041 => 'fverecoverymessage', 1587 0x22000041 => 'fverecoverymessage',
1588 },
1589 device => {
1590 0x35000001 => 'ramdiskimageoffset',
1591 0x35000002 => 'ramdisktftpclientport',
1592 0x31000003 => 'ramdisksdidevice',
1593 0x32000004 => 'ramdisksdipath',
1594 0x35000005 => 'ramdiskimagelength',
1595 0x36000006 => 'exportascd',
1596 0x35000007 => 'ramdisktftpblocksize',
1597 0x35000008 => 'ramdisktftpwindowsize',
1598 0x36000009 => 'ramdiskmcenabled',
1599 0x3600000a => 'ramdiskmctftpfallback',
1600 0x3600000b => 'ramdisktftpvarwindow',
1601 },
1602 memdiag => {
1603 0x25000001 => 'passcount',
1604 0x25000002 => 'testmix',
1605 0x25000003 => 'failurecount',
1606 0x26000003 => 'cacheenable',
1607 0x25000004 => 'testtofail',
1608 0x26000004 => 'failuresenabled',
1609 0x25000005 => 'stridefailcount',
1610 0x26000005 => 'cacheenable',
1611 0x25000006 => 'invcfailcount',
1612 0x25000007 => 'matsfailcount',
1613 0x25000008 => 'randfailcount',
1614 0x25000009 => 'chckrfailcount',
1615 },
1616 ntldr => {
1617 0x22000001 => 'bpbstring',
1618 },
1619 osloader => {
1620 0x21000001 => 'osdevice',
1621 0x22000002 => 'systemroot',
1622 0x23000003 => 'resumeobject',
1623 0x26000004 => 'stampdisks',
1624 0x26000010 => 'detecthal',
1625 0x22000011 => 'kernel',
1626 0x22000012 => 'hal',
1627 0x22000013 => 'dbgtransport',
1628 0x25000020 => 'nx',
1629 0x25000021 => 'pae',
1630 0x26000022 => 'winpe',
1631 0x26000024 => 'nocrashautoreboot',
1632 0x26000025 => 'lastknowngood',
1633 0x26000026 => 'oslnointegritychecks',
1634 0x26000027 => 'osltestsigning',
1635 0x26000030 => 'nolowmem',
1636 0x25000031 => 'removememory',
1637 0x25000032 => 'increaseuserva',
1638 0x25000033 => 'perfmem',
1639 0x26000040 => 'vga',
1541 0x26000041 => 'quietboot', 1640 0x26000041 => 'quietboot',
1542 0x26000042 => 'novesa', 1641 0x26000042 => 'novesa',
1543 0x26000043 => 'novga', 1642 0x26000043 => 'novga',
1544 0x25000050 => 'clustermodeaddressing', 1643 0x25000050 => 'clustermodeaddressing',
1545 0x26000051 => 'usephysicaldestination', 1644 0x26000051 => 'usephysicaldestination',
1546 0x25000052 => 'restrictapiccluster', 1645 0x25000052 => 'restrictapiccluster',
1547 0x22000053 => 'evstore', 1646 0x22000053 => 'evstore',
1548 0x26000054 => 'uselegacyapicmode', 1647 0x26000054 => 'uselegacyapicmode',
1549 0x26000060 => 'onecpu', 1648 0x26000060 => 'onecpu',
1550 0x25000061 => 'numproc', 1649 0x25000061 => 'numproc',
1551 0x26000062 => 'maxproc', 1650 0x26000062 => 'maxproc',
1552 0x25000063 => 'configflags', 1651 0x25000063 => 'configflags',
1553 0x26000064 => 'maxgroup', 1652 0x26000064 => 'maxgroup',
1554 0x26000065 => 'groupaware', 1653 0x26000065 => 'groupaware',
1555 0x25000066 => 'groupsize', 1654 0x25000066 => 'groupsize',
1556 0x26000070 => 'usefirmwarepcisettings', 1655 0x26000070 => 'usefirmwarepcisettings',
1557 0x25000071 => 'msi', 1656 0x25000071 => 'msi',
1558 0x25000072 => 'pciexpress', 1657 0x25000072 => 'pciexpress',
1559 0x25000080 => 'safeboot', 1658 0x25000080 => 'safeboot',
1560 0x26000081 => 'safebootalternateshell', 1659 0x26000081 => 'safebootalternateshell',
1561 0x26000090 => 'bootlog', 1660 0x26000090 => 'bootlog',
1562 0x26000091 => 'sos', 1661 0x26000091 => 'sos',
1563 0x260000a0 => 'debug', 1662 0x260000a0 => 'debug',
1564 0x260000a1 => 'halbreakpoint', 1663 0x260000a1 => 'halbreakpoint',
1565 0x260000a2 => 'useplatformclock', 1664 0x260000a2 => 'useplatformclock',
1566 0x260000a3 => 'forcelegacyplatform', 1665 0x260000a3 => 'forcelegacyplatform',
1567 0x260000a4 => 'useplatformtick', 1666 0x260000a4 => 'useplatformtick',
1568 0x260000a5 => 'disabledynamictick', 1667 0x260000a5 => 'disabledynamictick',
1569 0x250000a6 => 'tscsyncpolicy', 1668 0x250000a6 => 'tscsyncpolicy',
1570 0x260000b0 => 'ems', 1669 0x260000b0 => 'ems',
1571 0x250000c0 => 'forcefailure', 1670 0x250000c0 => 'forcefailure',
1572 0x250000c1 => 'driverloadfailurepolicy', 1671 0x250000c1 => 'driverloadfailurepolicy',
1573 0x250000c2 => 'bootmenupolicy', 1672 0x250000c2 => 'bootmenupolicy',
1574 0x260000c3 => 'onetimeadvancedoptions', 1673 0x260000c3 => 'onetimeadvancedoptions',
1575 0x260000c4 => 'onetimeoptionsedit', 1674 0x260000c4 => 'onetimeoptionsedit',
1576 0x250000e0 => 'bootstatuspolicy', 1675 0x250000e0 => 'bootstatuspolicy',
1577 0x260000e1 => 'disableelamdrivers', 1676 0x260000e1 => 'disableelamdrivers',
1578 0x250000f0 => 'hypervisorlaunchtype', 1677 0x250000f0 => 'hypervisorlaunchtype',
1579 0x220000f1 => 'hypervisorpath', 1678 0x220000f1 => 'hypervisorpath',
1580 0x260000f2 => 'hypervisordebug', 1679 0x260000f2 => 'hypervisordebug',
1581 0x250000f3 => 'hypervisordebugtype', 1680 0x250000f3 => 'hypervisordebugtype',
1582 0x250000f4 => 'hypervisordebugport', 1681 0x250000f4 => 'hypervisordebugport',
1583 0x250000f5 => 'hypervisorbaudrate', 1682 0x250000f5 => 'hypervisorbaudrate',
1584 0x250000f6 => 'hypervisorchannel', 1683 0x250000f6 => 'hypervisorchannel',
1585 0x250000f7 => 'bootux', 1684 0x250000f7 => 'bootux',
1586 0x260000f8 => 'hypervisordisableslat', 1685 0x260000f8 => 'hypervisordisableslat',
1587 0x220000f9 => 'hypervisorbusparams', 1686 0x220000f9 => 'hypervisorbusparams',
1588 0x250000fa => 'hypervisornumproc', 1687 0x250000fa => 'hypervisornumproc',
1589 0x250000fb => 'hypervisorrootprocpernode', 1688 0x250000fb => 'hypervisorrootprocpernode',
1590 0x260000fc => 'hypervisoruselargevtlb', 1689 0x260000fc => 'hypervisoruselargevtlb',
1591 0x250000fd => 'hypervisorhostip', 1690 0x250000fd => 'hypervisorhostip',
1592 0x250000fe => 'hypervisorhostport', 1691 0x250000fe => 'hypervisorhostport',
1593 0x250000ff => 'hypervisordebugpages', 1692 0x250000ff => 'hypervisordebugpages',
1594 0x25000100 => 'tpmbootentropy', 1693 0x25000100 => 'tpmbootentropy',
1595 0x22000110 => 'hypervisorusekey', 1694 0x22000110 => 'hypervisorusekey',
1596 0x22000112 => 'hypervisorproductskutype', 1695 0x22000112 => 'hypervisorproductskutype',
1597 0x25000113 => 'hypervisorrootproc', 1696 0x25000113 => 'hypervisorrootproc',
1598 0x26000114 => 'hypervisordhcp', 1697 0x26000114 => 'hypervisordhcp',
1599 0x25000115 => 'hypervisoriommupolicy', 1698 0x25000115 => 'hypervisoriommupolicy',
1600 0x26000116 => 'hypervisorusevapic', 1699 0x26000116 => 'hypervisorusevapic',
1601 0x22000117 => 'hypervisorloadoptions', 1700 0x22000117 => 'hypervisorloadoptions',
1602 0x25000118 => 'hypervisormsrfilterpolicy', 1701 0x25000118 => 'hypervisormsrfilterpolicy',
1603 0x25000119 => 'hypervisormmionxpolicy', 1702 0x25000119 => 'hypervisormmionxpolicy',
1604 0x2500011a => 'hypervisorschedulertype', 1703 0x2500011a => 'hypervisorschedulertype',
1605 0x25000120 => 'xsavepolicy', 1704 0x25000120 => 'xsavepolicy',
1606 0x25000121 => 'xsaveaddfeature0', 1705 0x25000121 => 'xsaveaddfeature0',
1607 0x25000122 => 'xsaveaddfeature1', 1706 0x25000122 => 'xsaveaddfeature1',
1608 0x25000123 => 'xsaveaddfeature2', 1707 0x25000123 => 'xsaveaddfeature2',
1609 0x25000124 => 'xsaveaddfeature3', 1708 0x25000124 => 'xsaveaddfeature3',
1610 0x25000125 => 'xsaveaddfeature4', 1709 0x25000125 => 'xsaveaddfeature4',
1611 0x25000126 => 'xsaveaddfeature5', 1710 0x25000126 => 'xsaveaddfeature5',
1612 0x25000127 => 'xsaveaddfeature6', 1711 0x25000127 => 'xsaveaddfeature6',
1613 0x25000128 => 'xsaveaddfeature7', 1712 0x25000128 => 'xsaveaddfeature7',
1614 0x25000129 => 'xsaveremovefeature', 1713 0x25000129 => 'xsaveremovefeature',
1615 0x2500012a => 'xsaveprocessorsmask', 1714 0x2500012a => 'xsaveprocessorsmask',
1616 0x2500012b => 'xsavedisable', 1715 0x2500012b => 'xsavedisable',
1617 0x2500012c => 'kerneldebugtype', 1716 0x2500012c => 'kerneldebugtype',
1618 0x2200012d => 'kernelbusparams', 1717 0x2200012d => 'kernelbusparams',
1619 0x2500012e => 'kerneldebugaddress', 1718 0x2500012e => 'kerneldebugaddress',
1620 0x2500012f => 'kerneldebugport', 1719 0x2500012f => 'kerneldebugport',
1621 0x25000130 => 'claimedtpmcounter', 1720 0x25000130 => 'claimedtpmcounter',
1622 0x25000131 => 'kernelchannel', 1721 0x25000131 => 'kernelchannel',
1623 0x22000132 => 'kerneltargetname', 1722 0x22000132 => 'kerneltargetname',
1624 0x25000133 => 'kernelhostip', 1723 0x25000133 => 'kernelhostip',
1625 0x25000134 => 'kernelport', 1724 0x25000134 => 'kernelport',
1626 0x26000135 => 'kerneldhcp', 1725 0x26000135 => 'kerneldhcp',
1627 0x22000136 => 'kernelkey', 1726 0x22000136 => 'kernelkey',
1628 0x22000137 => 'imchivename', 1727 0x22000137 => 'imchivename',
1629 0x21000138 => 'imcdevice', 1728 0x21000138 => 'imcdevice',
1630 0x25000139 => 'kernelbaudrate', 1729 0x25000139 => 'kernelbaudrate',
1631 0x22000140 => 'mfgmode', 1730 0x22000140 => 'mfgmode',
1632 0x26000141 => 'event', 1731 0x26000141 => 'event',
1633 0x25000142 => 'vsmlaunchtype', 1732 0x25000142 => 'vsmlaunchtype',
1634 0x25000144 => 'hypervisorenforcedcodeintegrity', 1733 0x25000144 => 'hypervisorenforcedcodeintegrity',
1635 0x26000145 => 'enablebootdebugpolicy',
1636 0x26000146 => 'enablebootorderclean',
1637 0x26000147 => 'enabledeviceid',
1638 0x26000148 => 'enableffuloader',
1639 0x26000149 => 'enableiuloader',
1640 0x2600014a => 'enablemassstorage',
1641 0x2600014b => 'enablerpmbprovisioning',
1642 0x2600014c => 'enablesecurebootpolicy',
1643 0x2600014d => 'enablestartcharge',
1644 0x2600014e => 'enableresettpm',
1645 0x21000150 => 'systemdatadevice', 1734 0x21000150 => 'systemdatadevice',
1646 0x21000151 => 'osarcdevice', 1735 0x21000151 => 'osarcdevice',
1647 0x21000153 => 'osdatadevice', 1736 0x21000153 => 'osdatadevice',
1648 0x21000154 => 'bspdevice', 1737 0x21000154 => 'bspdevice',
1649 0x21000155 => 'bspfilepath', 1738 0x21000155 => 'bspfilepath',
1650 0x26000202 => 'skipffumode', 1739 },
1651 0x26000203 => 'forceffumode', 1740 resume => {
1652 0x25000510 => 'chargethreshold', 1741 0x21000001 => 'filedevice',
1653 0x26000512 => 'offmodecharging', 1742 0x22000002 => 'filepath',
1654 0x25000aaa => 'bootflow', 1743 0x26000003 => 'customsettings',
1655 0x35000001 => 'ramdiskimageoffset', 1744 0x26000004 => 'pae',
1656 0x35000002 => 'ramdisktftpclientport', 1745 0x21000005 => 'associatedosdevice',
1657 0x31000003 => 'ramdisksdidevice', 1746 0x26000006 => 'debugoptionenabled',
1658 0x32000004 => 'ramdisksdipath', 1747 0x25000007 => 'bootux',
1659 0x35000005 => 'ramdiskimagelength', 1748 0x25000008 => 'bootmenupolicy',
1660 0x36000006 => 'exportascd', 1749 0x26000024 => 'hormenabled',
1661 0x35000007 => 'ramdisktftpblocksize', 1750 },
1662 0x35000008 => 'ramdisktftpwindowsize', 1751 startup => {
1663 0x36000009 => 'ramdiskmcenabled', 1752 0x26000001 => 'pxesoftreboot',
1664 0x3600000a => 'ramdiskmctftpfallback', 1753 0x22000002 => 'applicationname',
1665 0x3600000b => 'ramdisktftpvarwindow', 1754 },
1666 0x45000001 => 'devicetype',
1667 0x42000002 => 'applicationrelativepath',
1668 0x42000003 => 'ramdiskdevicerelativepath',
1669 0x46000004 => 'omitosloaderelements',
1670 0x47000006 => 'elementstomigrate',
1671 0x46000010 => 'recoveryos',
1672); 1755);
1673 1756
1674our %rbcde = reverse %bcde; 1757# mask, value => class
1758our @bcde_typeclass = (
1759 [0x00000000, 0x00000000, 'any'],
1760 [0xf00fffff, 0x1000000a, 'bootapp'],
1761 [0xf0ffffff, 0x2020000a, 'bootapp'],
1762 [0xf00fffff, 0x10000001, 'bootmgr'],
1763 [0xf00fffff, 0x10000002, 'bootmgr'],
1764 [0xf0ffffff, 0x20200001, 'bootmgr'],
1765 [0xf0ffffff, 0x20200002, 'bootmgr'],
1766 [0xf0f00000, 0x20300000, 'device'],
1767 [0xf0000000, 0x30000000, 'device'],
1768 [0xf00fffff, 0x10000005, 'memdiag'],
1769 [0xf0ffffff, 0x20200005, 'memdiag'],
1770 [0xf00fffff, 0x10000006, 'ntldr'],
1771 [0xf00fffff, 0x10000007, 'ntldr'],
1772 [0xf0ffffff, 0x20200006, 'ntldr'],
1773 [0xf0ffffff, 0x20200007, 'ntldr'],
1774 [0xf00fffff, 0x10000003, 'osloader'],
1775 [0xf0ffffff, 0x20200003, 'osloader'],
1776 [0xf00fffff, 0x10000004, 'resume'],
1777 [0xf0ffffff, 0x20200004, 'resume'],
1778 [0xf00fffff, 0x10000009, 'startup'],
1779 [0xf0ffffff, 0x20200009, 'startup'],
1780);
1675 1781
1782our %rbcde_byclass;
1783
1784while (my ($k, $v) = each %bcde_byclass) {
1785 $rbcde_byclass{$k} = { reverse %$v };
1786}
1787
1788# decodes (numerical elem, type) to name
1676sub dec_bcde_id($) { 1789sub dec_bcde_id($$) {
1790 for my $class (@bcde_typeclass) {
1791 if (($_[1] & $class->[0]) == $class->[1]) {
1792 if (my $id = $bcde_byclass{$class->[2]}{$_[0]}) {
1793 return $id;
1794 }
1795 }
1796 }
1797
1677 $bcde{$_[0]} // sprintf "custom:%08x", $_[0] 1798 sprintf "custom:%08x", $_[0]
1678} 1799}
1679 1800
1801# encodes (elem as name, type)
1680sub enc_bcde_id($) { 1802sub enc_bcde_id($$) {
1681 $_[0] =~ /^custom:([0-9a-fA-F]{8}$)/ 1803 $_[0] =~ /^custom:(?:0x)?([0-9a-fA-F]{8}$)/
1682 ? hex $1 1804 and return hex $1;
1683 : $rbcde{$_[0]} 1805
1806 for my $class (@bcde_typeclass) {
1807 if (($_[1] & $class->[0]) == $class->[1]) {
1808 if (my $value = $rbcde_byclass{$class->[2]}{$_[0]}) {
1809 return $value;
1810 }
1811 }
1812 }
1813
1814 undef
1684} 1815}
1685 1816
1686# decode/encode bcd device element - the horror, no documentaion 1817# decode/encode bcd device element - the horror, no documentaion
1687# whatsoever, supercomplex, superinconsistent. 1818# whatsoever, supercomplex, superinconsistent.
1688 1819
1692 1823
1693our $NULL_DEVICE = "\x00" x 16; 1824our $NULL_DEVICE = "\x00" x 16;
1694 1825
1695# biggest bitch to decode, ever 1826# biggest bitch to decode, ever
1696# this decoded a device portion after the GUID 1827# this decoded a device portion after the GUID
1697sub dec_device_($); 1828sub dec_device_($$);
1698sub dec_device_($) { 1829sub dec_device_($$) {
1699 my ($device) = @_; 1830 my ($device, $type) = @_;
1700 1831
1701 my $res; 1832 my $res;
1702 1833
1703 my ($type, $flags, $length, $pad) = unpack "VVVV", substr $device, 0, 4 * 4, ""; 1834 my ($type, $flags, $length, $pad) = unpack "VVVV", substr $device, 0, 4 * 4, "";
1704 1835
1749 1880
1750 my $partid = $parttype eq "gpt" ? dec_guid $partdata 1881 my $partid = $parttype eq "gpt" ? dec_guid $partdata
1751 : $type eq "partition" ? unpack "Q<", $partdata # byte offset to partition start 1882 : $type eq "partition" ? unpack "Q<", $partdata # byte offset to partition start
1752 : unpack "L<", $partdata; # partition number, one-based 1883 : unpack "L<", $partdata; # partition number, one-based
1753 1884
1754 (my $parent, $device) = dec_device_ $device; 1885 (my $parent, $device) = dec_device_ $device, $type;
1755 1886
1756 $res .= "="; 1887 $res .= "=";
1757 $res .= "<$parent>"; 1888 $res .= "<$parent>";
1758 $res .= ",$blocktype,$parttype,$diskid,$partid"; 1889 $res .= ",$blocktype,$parttype,$diskid,$partid";
1759 1890
1779 or die "unsupported file descriptor version '$fver'\n"; 1910 or die "unsupported file descriptor version '$fver'\n";
1780 1911
1781 $ftype == 5 1912 $ftype == 5
1782 or die "unsupported file descriptor path type '$type'\n"; 1913 or die "unsupported file descriptor path type '$type'\n";
1783 1914
1784 (my $parent, $path) = dec_device_ $path; 1915 (my $parent, $path) = dec_device_ $path, $type;
1785 1916
1786 $path = $dec_path->($path, "file device without path"); 1917 $path = $dec_path->($path, "file device without path");
1787 1918
1788 ($parent, $path) 1919 ($parent, $path)
1789 }; 1920 };
1795 1926
1796 } elsif ($blocktype eq "vhd") { 1927 } elsif ($blocktype eq "vhd") {
1797 $device =~ s/^\x00{20}//s 1928 $device =~ s/^\x00{20}//s
1798 or die "virtualdisk has non-zero fields I don't understand\n"; 1929 or die "virtualdisk has non-zero fields I don't understand\n";
1799 1930
1800 (my $parent, $device) = dec_device_ $device; 1931 (my $parent, $device) = dec_device_ $device, $type;
1801 1932
1802 $res .= "=vhd,<$parent>"; 1933 $res .= "=vhd,<$parent>";
1803 1934
1804 } elsif ($blocktype eq "ramdisk") { 1935 } elsif ($blocktype eq "ramdisk") {
1805 my ($base, $size, $offset) = unpack "Q< Q< L<", substr $device, 0, 8 + 8 + 4, ""; 1936 my ($base, $size, $offset) = unpack "Q< Q< L<", substr $device, 0, 8 + 8 + 4, "";
1818 my ($mode, $elem, $parent) = unpack "VVV", substr $device, 0, 4 * 3, ""; 1949 my ($mode, $elem, $parent) = unpack "VVV", substr $device, 0, 4 * 3, "";
1819 1950
1820 if ($parent) { 1951 if ($parent) {
1821 # not sure why this is an offset - it must come after the path 1952 # not sure why this is an offset - it must come after the path
1822 $parent = substr $device, $parent - 4 * 3 - 4 * 4, 1e9, ""; 1953 $parent = substr $device, $parent - 4 * 3 - 4 * 4, 1e9, "";
1823 ($parent, my $tail) = dec_device_ $parent; 1954 ($parent, my $tail) = dec_device_ $parent, $type;
1824 0 == length $tail 1955 0 == length $tail
1825 or die "trailing data after locate device parent\n"; 1956 or die "trailing data after locate device parent\n";
1826 } else { 1957 } else {
1827 $parent = "null"; 1958 $parent = "null";
1828 } 1959 }
1834 1965
1835 if ($mode == 0) { # "Element" 1966 if ($mode == 0) { # "Element"
1836 !length $path 1967 !length $path
1837 or die "device locate mode 0 having non-empty path ($mode, $elem, $path)\n"; 1968 or die "device locate mode 0 having non-empty path ($mode, $elem, $path)\n";
1838 1969
1839 $elem = dec_bcde_id $elem; 1970 $elem = dec_bcde_id $elem, $type;
1840 $res .= "element,$elem"; 1971 $res .= "element,$elem";
1841 1972
1842 } elsif ($mode == 1) { # "String" 1973 } elsif ($mode == 1) { # "String"
1843 !$elem 1974 !$elem
1844 or die "device locate mode 1 having non-zero element\n"; 1975 or die "device locate mode 1 having non-zero element\n";
1869 2000
1870 ($res, $tail) 2001 ($res, $tail)
1871} 2002}
1872 2003
1873# decode a full binary BCD device descriptor 2004# decode a full binary BCD device descriptor
1874sub dec_device($) { 2005sub dec_device($$) {
1875 my ($device) = @_; 2006 my ($device, $type) = @_;
1876 2007
1877 $device = pack "H*", $device; 2008 $device = pack "H*", $device;
1878 2009
1879 my $guid = dec_guid substr $device, 0, 16, ""; 2010 my $guid = dec_guid substr $device, 0, 16, "";
1880 $guid = $guid eq "00000000-0000-0000-0000-000000000000" 2011 $guid = $guid eq "00000000-0000-0000-0000-000000000000"
1881 ? "" : "{$guid}"; 2012 ? "" : "{$guid}";
1882 2013
1883 eval { 2014 eval {
1884 my ($dev, $tail) = dec_device_ $device; 2015 my ($dev, $tail) = dec_device_ $device, $type;
1885 2016
1886 $tail eq "" 2017 $tail eq ""
1887 or die "unsupported trailing data after device descriptor\n"; 2018 or die "unsupported trailing data after device descriptor\n";
1888 2019
1889 "$guid$dev" 2020 "$guid$dev"
1901 2032
1902 undef 2033 undef
1903} 2034}
1904 2035
1905# encode the device portion after the GUID 2036# encode the device portion after the GUID
1906sub enc_device_; 2037sub enc_device_($$);
1907sub enc_device_ { 2038sub enc_device_($$) {
1908 my ($device) = @_; 2039 my ($device, $type) = @_;
1909 2040
1910 my $enc_path = sub { 2041 my $enc_path = sub {
1911 my $path = shift; 2042 my $path = shift;
1912 $path =~ s/\//\\/g; 2043 $path =~ s/\//\\/g;
1913 (Encode::encode "UTF-16LE", $path) . "\x00\x00" 2044 (Encode::encode "UTF-16LE", $path) . "\x00\x00"
1931 2062
1932 my $parse_parent = sub { 2063 my $parse_parent = sub {
1933 my $parent; 2064 my $parent;
1934 2065
1935 if (s/^<//) { 2066 if (s/^<//) {
1936 ($parent, $_) = enc_device_ $_; 2067 ($parent, $_) = enc_device_ $_, $type;
1937 s/^>// 2068 s/^>//
1938 or die "$device: syntax error: parent device not followed by '>'\n"; 2069 or die "$device: syntax error: parent device not followed by '>'\n";
1939 } else { 2070 } else {
1940 $parent = $NULL_DEVICE; 2071 $parent = $NULL_DEVICE;
1941 } 2072 }
2029 2160
2030 s/^,// 2161 s/^,//
2031 or die "$_: missing comma after locate parent device\n"; 2162 or die "$_: missing comma after locate parent device\n";
2032 2163
2033 if (s/^element,//) { 2164 if (s/^element,//) {
2034 s/^([0-9a-z]+)//i 2165 s/^([0-9a-z:]+)//i
2035 or die "$_ locate element must be either name or 8-digit hex id\n"; 2166 or die "$_ locate element must be either name or 8-digit hex id\n";
2036 $elem = enc_bcde_id $1; 2167 $elem = enc_bcde_id $1, $type;
2037 $mode = 0; 2168 $mode = 0;
2038 $path = $enc_path->(""); 2169 $path = $enc_path->("");
2039 2170
2040 } elsif (s/^path,//) { 2171 } elsif (s/^path,//) {
2041 $mode = 1; 2172 $mode = 1;
2120 ); 2251 );
2121 } 2252 }
2122} 2253}
2123 2254
2124# encode a full binary BCD device descriptor 2255# encode a full binary BCD device descriptor
2125sub enc_device { 2256sub enc_device($$) {
2126 my ($device) = @_; 2257 my ($device, $type) = @_;
2127 2258
2128 my $guid = "\x00" x 16; 2259 my $guid = "\x00" x 16;
2129 2260
2130 if ($device =~ s/^\{([A-Za-z0-9\-]+)\}//) { 2261 if ($device =~ s/^\{([A-Za-z0-9\-]+)\}//) {
2131 $guid = enc_guid $1 2262 $guid = enc_guid $1
2132 or die "$device: does not start with valid guid\n"; 2263 or die "$device: does not start with valid guid\n";
2133 } 2264 }
2134 2265
2135 my ($descriptor, $tail) = enc_device_ $device; 2266 my ($descriptor, $tail) = enc_device_ $device, $type;
2136 2267
2137 length $tail 2268 length $tail
2138 and die "$device: garbage after device descriptor\n"; 2269 and die "$device: garbage after device descriptor\n";
2139 2270
2140 unpack "H*", $guid . $descriptor 2271 unpack "H*", $guid . $descriptor
2155 $k = $bcd_objects{$k} // $k; 2286 $k = $bcd_objects{$k} // $k;
2156 2287
2157 my $type = $v->{Description}[0]{Type}[1]; 2288 my $type = $v->{Description}[0]{Type}[1];
2158 2289
2159 if ($type != $bcd_object_types{$k}) { 2290 if ($type != $bcd_object_types{$k}) {
2160 $type = $bcd_types{$type} // sprintf "0x%08x", $type; 2291 $kv{type} = $bcd_types{$type} // sprintf "0x%08x", $type;
2161 $kv{type} = $type;
2162 } 2292 }
2163 2293
2164 my $elems = $v->{Elements}[1]; 2294 my $elems = $v->{Elements}[1];
2165 2295
2166 while (my ($k, $v) = each %$elems) { 2296 while (my ($k, $v) = each %$elems) {
2167 my $k = hex $k; 2297 my $k = hex $k;
2168 2298
2169 my $v = $bcde_dec{$k & BCDE_FORMAT}->($v->[0]{Element}[1]); 2299 my $v = $bcde_dec{$k & BCDE_FORMAT}->($v->[0]{Element}[1], $type);
2170 my $k = dec_bcde_id $k; 2300 my $k = dec_bcde_id $k, $type;
2171 2301
2172 $kv{$k} = $v; 2302 $kv{$k} = $v;
2173 } 2303 }
2174 2304
2175 $bcd{$k} = \%kv; 2305 $bcd{$k} = \%kv;
2216 my %elem; 2346 my %elem;
2217 2347
2218 while (my ($k, $v) = each %$v) { 2348 while (my ($k, $v) = each %$v) {
2219 next if $k eq "type"; 2349 next if $k eq "type";
2220 2350
2221 $k = (enc_bcde_id $k) // die "$k: invalid bcde element name or id\n"; 2351 $k = (enc_bcde_id $k, $type) // die "$k: invalid bcde element name or id\n";
2222 $elem{sprintf "%08x", $k} = [{ 2352 $elem{sprintf "%08x", $k} = [{
2223 Element => [ ($bcde_enc{$k & BCDE_FORMAT} // die "$k: unable to encode unknown bcd element type}")->($v)] 2353 Element => [ ($bcde_enc{$k & BCDE_FORMAT} // die "$k: unable to encode unknown bcd element type}")->($v)]
2224 }]; 2354 }];
2225 } 2355 }
2226 2356
2242 Objects => [undef, \%objects], 2372 Objects => [undef, \%objects],
2243 }]] 2373 }]]
2244} 2374}
2245 2375
2246############################################################################# 2376#############################################################################
2377# edit instructions
2247 2378
2248sub bcd_edit_eval { 2379sub bcd_edit_eval {
2249 package pbcdedit; 2380 package pbcdedit;
2250 2381
2251 our ($PATH, $BCD, $DEFAULT); 2382 our ($PATH, $BCD, $DEFAULT);
2255} 2386}
2256 2387
2257sub bcd_edit { 2388sub bcd_edit {
2258 my ($path, $bcd, @insns) = @_; 2389 my ($path, $bcd, @insns) = @_;
2259 2390
2260 my $default = $bcd->{"{bootmgr}"}{resumeobject}; 2391 my $default = $bcd->{"{bootmgr}"}{default};
2261 2392
2262 # prepare "officially visible" variables 2393 # prepare "officially visible" variables
2263 local $pbcdedit::PATH = $path; 2394 local $pbcdedit::PATH = $path;
2264 local $pbcdedit::BCD = $bcd; 2395 local $pbcdedit::BCD = $bcd;
2265 local $pbcdedit::DEFAULT = $default; 2396 local $pbcdedit::DEFAULT = $default;
2269 2400
2270 if ($insn eq "get") { 2401 if ($insn eq "get") {
2271 my $object = shift @insns; 2402 my $object = shift @insns;
2272 my $elem = shift @insns; 2403 my $elem = shift @insns;
2273 2404
2274 $object = $default if $object eq "{default}"; 2405 $object = $object eq "{default}" ? $default : dec_wguid enc_wguid $object;
2275 2406
2276 print $bcd->{$object}{$elem}, "\n"; 2407 print $bcd->{$object}{$elem}, "\n";
2277 2408
2278 } elsif ($insn eq "set") { 2409 } elsif ($insn eq "set") {
2279 my $object = shift @insns; 2410 my $object = shift @insns;
2280 my $elem = shift @insns; 2411 my $elem = shift @insns;
2281 my $value = shift @insns; 2412 my $value = shift @insns;
2282 2413
2283 $object = $default if $object eq "{default}"; 2414 $object = $object eq "{default}" ? $default : dec_wguid enc_wguid $object;
2284 2415
2285 $bcd->{$object}{$elem} = $value; 2416 $bcd->{$object}{$elem} = $value;
2286 2417
2287 } elsif ($insn eq "eval") { 2418 } elsif ($insn eq "eval") {
2288 bcd_edit_eval shift @insns; 2419 my $perl = shift @insns;
2420 bcd_edit_eval "#line 1 'eval'\n$perl";
2289 2421
2290 } elsif ($insn eq "do") { 2422 } elsif ($insn eq "do") {
2291 my $path = shift @insns; 2423 my $path = shift @insns;
2292 my $file = file_load $path; 2424 my $file = file_load $path;
2293 bcd_edit_eval "#line 1 '$path'\n$file"; 2425 bcd_edit_eval "#line 1 '$path'\n$file";
2298 } 2430 }
2299 2431
2300} 2432}
2301 2433
2302############################################################################# 2434#############################################################################
2435# other utilities
2303 2436
2304# json to stdout 2437# json to stdout
2305sub prjson($) { 2438sub prjson($) {
2306 print $json_coder->encode ($_[0]); 2439 print $json_coder->encode ($_[0]);
2307} 2440}
2311 my $json; 2444 my $json;
2312 1 while read STDIN, $json, 65536, length $json; 2445 1 while read STDIN, $json, 65536, length $json;
2313 $json_coder->decode ($json) 2446 $json_coder->decode ($json)
2314} 2447}
2315 2448
2316# all subcommands 2449sub lsblk() {
2450 my $lsblk = $json_coder->decode (scalar qx<lsblk --json -o PATH,KNAME,MAJ:MIN,TYPE,PTTYPE,PTUUID,PARTUUID,LABEL,FSTYPE>);
2451
2452 for my $dev (@{ $lsblk->{blockdevices} }) {
2453 if ($dev->{type} eq "part") {
2454 if ($dev->{pttype} eq "gpt") {
2455 $dev->{bcd_device} = "partition=<null>,harddisk,gpt,$dev->{ptuuid},$dev->{partuuid}";
2456 } elsif ($dev->{pttype} eq "dos") { # why not "mbr" :(
2457 if ($dev->{partuuid} =~ /^([0-9a-f]{8})-([0-9a-f]{2})\z/i) {
2458 my ($diskid, $partno) = ($1, hex $2);
2459 $dev->{bcd_legacy_device} = "legacypartition=<null>,harddisk,mbr,$diskid,$partno";
2460 if (open my $fh, "/sys/class/block/$dev->{kname}/start") {
2461 my $start = 512 * readline $fh;
2462 $dev->{bcd_device} = "partition=<null>,harddisk,mbr,$diskid,$start";
2463 }
2464 }
2465 }
2466 }
2467 }
2468
2469 $lsblk->{blockdevices}
2470}
2471
2472sub prdev($$) {
2473 my ($path, $attribute) = @_;
2474
2475 # rather than stat'ing and guessing how devices are encoded, we use lsblk for this
2476 # unfortunately, there doesn't seem to be a way to restrict lsblk to just oned evice,
2477 # so we always assume the first one is it.
2478 my $mm = $json_coder->decode (scalar qx<lsblk -o MAJ:MIN -J \Q$path\E>)->{blockdevices}[0]{"maj:min"};
2479
2480 my $lsblk = lsblk;
2481
2482 for my $dev (@$lsblk) {
2483 if ($dev->{"maj:min"} eq $mm && $dev->{$attribute}) {
2484 say $dev->{$attribute};
2485 exit 0;
2486 }
2487 }
2488
2489 exit 1;
2490}
2491
2492#############################################################################
2493# command line parser
2494
2317our %CMD = ( 2495our %CMD = (
2318 help => sub { 2496 help => sub {
2319 require Pod::Usage; 2497 require Pod::Usage;
2320 Pod::Usage::pod2usage (-verbose => 2); 2498 Pod::Usage::pod2usage (-verbose => 2);
2321 }, 2499 },
2346 2524
2347 print "\n"; 2525 print "\n";
2348 2526
2349 printf "%-39s %-23s %s\n", "Object GUID", "Alias", "(Hex) Default Type"; 2527 printf "%-39s %-23s %s\n", "Object GUID", "Alias", "(Hex) Default Type";
2350 for my $name (sort keys %rbcd_objects) { 2528 for my $name (sort keys %rbcd_objects) {
2351 my $guid = $rbcd_objects{$name}; 2529 my $guid = $rbcd_objects{$name};
2352 my $type = $bcd_object_types{$name}; 2530 my $type = $bcd_object_types{$name};
2353 my $tname = $bcd_types{$type}; 2531 my $tname = $bcd_types{$type};
2354 2532
2355 $type = $type ? sprintf "(%08x) %s", $type, $tname : "-"; 2533 $type = $type ? sprintf "(%08x) %s", $type, $tname : "-";
2356 2534
2357 printf "%-39s %-23s %s\n", $guid, $name, $type; 2535 printf "%-39s %-23s %s\n", $guid, $name, $type;
2371 BCDE_FORMAT_GUID_LIST , "guid list", 2549 BCDE_FORMAT_GUID_LIST , "guid list",
2372 BCDE_FORMAT_INTEGER , "integer", 2550 BCDE_FORMAT_INTEGER , "integer",
2373 BCDE_FORMAT_BOOLEAN , "boolean", 2551 BCDE_FORMAT_BOOLEAN , "boolean",
2374 BCDE_FORMAT_INTEGER_LIST, "integer list", 2552 BCDE_FORMAT_INTEGER_LIST, "integer list",
2375 ); 2553 );
2376 my %rbcde = reverse %bcde;
2377 $_ = sprintf "%08x", $_ for values %rbcde;
2378 2554
2379 my %element; 2555 my @element;
2380 2556
2557 for my $class (sort keys %rbcde_byclass) {
2558 my $rbcde = $rbcde_byclass{$class};
2559
2381 unless ($json) { 2560 unless ($json) {
2382 print "\n"; 2561 print "\n";
2562 printf "Elements applicable to class(es): $class\n";
2383 printf "%-9s %-12s %s\n", "Element", "Format", "Name Alias"; 2563 printf "%-9s %-12s %s\n", "Element", "Format", "Name Alias";
2384 } 2564 }
2385 for my $name (sort keys %rbcde) { 2565 for my $name (sort keys %$rbcde) {
2386 my $id = $rbcde{$name}; 2566 my $id = $rbcde->{$name};
2387 my $format = $format_name{(hex $id) & BCDE_FORMAT}; 2567 my $format = $format_name{$id & BCDE_FORMAT};
2388 2568
2389 if ($json) { 2569 if ($json) {
2390 $element{$id} = [$format, $name]; 2570 push @element, [$class, $id * 1, $format, $name];
2391 } else { 2571 } else {
2572 $id = sprintf "%08x", $id;
2392 printf "%-9s %-12s %s\n", $id, $format, $name; 2573 printf "%-9s %-12s %s\n", $id, $format, $name;
2574 }
2393 } 2575 }
2394 } 2576 }
2395 print "\n" unless $json; 2577 print "\n" unless $json;
2396 2578
2397 prjson { 2579 prjson {
2398 version => $JSON_VERSION, 2580 version => $JSON_VERSION,
2399 element => \%element, 2581 element => \@element,
2582 class => \@bcde_typeclass,
2400 } if $json; 2583 } if $json;
2401 2584
2402 }, 2585 },
2403 2586
2404 export => sub { 2587 export => sub {
2430 "import-regf" => sub { 2613 "import-regf" => sub {
2431 regf_save shift, rdjson; 2614 regf_save shift, rdjson;
2432 }, 2615 },
2433 2616
2434 lsblk => sub { 2617 lsblk => sub {
2618 my $json = $_[0] eq "--json";
2619
2620 my $lsblk = lsblk;
2621
2622 if ($json) {
2623 prjson $lsblk;
2624 } else {
2435 printf "%-10s %-8.8s %-6.6s %-3s %s\n", "DEVICE", "LABEL", "FSTYPE", "PT", "DEVICE DESCRIPTOR"; 2625 printf "%-10s %-8.8s %-6.6s %-3s %s\n", "DEVICE", "LABEL", "FSTYPE", "PT", "DEVICE DESCRIPTOR";
2436 2626 for my $dev (@$lsblk) {
2437 my $lsblk = $json_coder->decode (scalar qx<lsblk --json -o PATH,KNAME,TYPE,PTTYPE,PTUUID,PARTUUID,LABEL,FSTYPE>); 2627 for my $bcd ($dev->{bcd_device}, $dev->{bcd_legacy_device}) {
2438
2439 for my $dev (@{ $lsblk->{blockdevices} }) {
2440 my $pr = sub {
2441 printf "%-10s %-8.8s %-6.6s %-3s %s\n", 2628 printf "%-10s %-8.8s %-6.6s %-3s %s\n",
2442 $dev->{path}, $dev->{label}, $dev->{fstype}, $dev->{pttype}, $_[0]; 2629 $dev->{path}, $dev->{label}, $dev->{fstype}, $dev->{pttype}, $bcd
2443 };
2444
2445 if ($dev->{type} eq "part") {
2446 if ($dev->{pttype} eq "gpt") {
2447 $pr->("partition=<null>,harddisk,gpt,$dev->{ptuuid},$dev->{partuuid}");
2448 } elsif ($dev->{pttype} eq "dos") { # why not "mbr" :(
2449 if ($dev->{partuuid} =~ /^([0-9a-f]{8})-([0-9a-f]{2})\z/i) {
2450 my ($diskid, $partno) = ($1, hex $2);
2451 $pr->("legacypartition=<null>,harddisk,mbr,$diskid,$partno");
2452 if (open my $fh, "/sys/class/block/$dev->{kname}/start") {
2453 my $start = 512 * readline $fh;
2454 $pr->("partition=<null>,harddisk,mbr,$diskid,$start");
2455 } 2630 if $bcd;
2456 }
2457 } 2631 }
2458 } 2632 }
2459 } 2633 }
2460 }, 2634 },
2635
2636 "bcd-device" => sub {
2637 prdev shift, "bcd_device";
2638 },
2639
2640 "bcd-legacy-device" => sub {
2641 prdev shift, "bcd_legacy_device";
2642 },
2643
2644 version => sub {
2645 print "\n",
2646 "PBCDEDIT version $VERSION, copyright 2019 Marc A. Lehmann <pbcdedit\@schmorp.de>.\n",
2647 "JSON schema version: $JSON_VERSION\n",
2648 "Licensed under the GNU General Public License Version 3.0, or any later version.\n",
2649 "\n",
2650 $CHANGELOG,
2651 "\n";
2652 },
2461); 2653);
2462 2654
2463my $cmd = shift; 2655my $cmd = shift;
2464 2656
2465unless (exists $CMD{$cmd}) { 2657unless (exists $CMD{$cmd}) {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines