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

Comparing pbcdedit/pbcdedit (file contents):
Revision 1.34 by root, Thu Aug 15 08:42:02 2019 UTC vs.
Revision 1.76 by root, Tue Aug 9 11:44:54 2022 UTC

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.016; # numerous features need 5.14, __SUB__ needs 5.16 22use 5.016; # numerous features need 5.14, __SUB__ needs 5.16
23 23
24our $VERSION = '1.0'; 24our $VERSION = '1.5';
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
291.5 Mon Nov 25 15:54:34 CET 2019
30 - add "del" edit instruction.
31 - work around lsblk bug sometimes giving "dos" pttype for gpt partitions.
32 - bootmenupolicy in synopsis must be set to 0 to get the text menu.
33 - minor doc fxes.
34 - disable use of perldoc for help, doesn't work well.
35
361.4 Thu Aug 22 10:48:22 CEST 2019
37 - new "create" subcommand.
38 - "create" and "edit" try to save and restore ownership/permissions
39 of bcd hives when writing the new file.
40 - editorial fixes to the documentation.
41 - add mininmal hive creation example.
42
431.3 Sat Aug 17 07:04:15 CEST 2019
44 - output of pbcdedit elements --json has changed, as it didn't
45 take the reorganisation by classes fully into account.
46 - json schema bumped to 3.
47 - new "bcd-device" and "bcd-legacy-device" subcommands.
48 - implement --json option for lsblk.
49
501.2 Fri Aug 16 00:20:41 CEST 2019
51 - bcd element names now depend on the bcd object type they are in,
52 also affects "elements" output.
53 - json schema bumped to 2.
54 - new version command.
55 - numerous minor bugfixes.
56
57EOF
26 58
27=head1 NAME 59=head1 NAME
28 60
29 pbcdedit - portable boot configuration data (BCD) store editor 61 pbcdedit - portable boot configuration data (BCD) store editor
30 62
31=head1 SYNOPSIS 63=head1 SYNOPSIS
32 64
33 pbcdedit help # output manual page 65 pbcdedit help # output manual page
66 pbcdedit version # output version and changelog
34 67
35 pbcdedit export path/to/BCD # output BCD hive as JSON 68 pbcdedit export path/to/BCD # output BCD hive as JSON
36 pbcdedit import path/to/BCD # convert standard input to BCD hive 69 pbcdedit import path/to/BCD # convert standard input to BCD hive
37 pbcdedit edit path/to/BCD edit-instructions... 70 pbcdedit edit path/to/BCD edit-instructions...
38 71
39 pbcdedit objects # list all supported object aliases and types 72 pbcdedit objects # list all supported object aliases and types
40 pbcdedit elements # list all supported bcd element aliases 73 pbcdedit elements # list all supported bcd element aliases
74
75 # Example: enable text-based boot menu.
76 pbcdedit edit /my/BCD set '{default}' bootmenupolicy 0
77
78 # Example change system device to first partition containing winload.
79 pbcdedit edit /my/BCD \
80 set '{default}' device 'locate=<null>,element,path' \
81 set '{default}' osdevice 'locate=<null>,element,path'
82
41 83
42=head1 DESCRIPTION 84=head1 DESCRIPTION
43 85
44This program allows you to create, read and modify Boot Configuration Data 86This program allows you to create, read and modify Boot Configuration Data
45(BCD) stores used by Windows Vista and newer versions of Windows. 87(BCD) stores used by Windows Vista and newer versions of Windows.
92 134
93=item C<help> 135=item C<help>
94 136
95Displays the whole manual page (this document). 137Displays the whole manual page (this document).
96 138
139=item C<version>
140
141This outputs the PBCDEDIT version, the JSON schema version it uses and the
142full log of changes.
143
97=item C<export> F<path> 144=item C<export> F<path>
98 145
99Reads a BCD data store and writes a JSON representation of it to standard 146Reads a BCD data store and writes a JSON representation of it to standard
100output. 147output.
101 148
120=item C<parse> F<path> I<instructions...> 167=item C<parse> F<path> I<instructions...>
121 168
122Same as C<edit>, above, except it doesn't save the data store again. Can 169Same as C<edit>, above, except it doesn't save the data store again. Can
123be useful to extract some data from it. 170be useful to extract some data from it.
124 171
125=item C<lsblk> 172=item C<create> F<path> I<instructions...>
173
174Same as C<edit>, above, except it creates a new data store from scratch if
175needed. An existing store will be emptied completely.
176
177=item C<lsblk> [C<--json>]
126 178
127On a GNU/Linux system, you can get a list of partition device descriptors 179On a GNU/Linux system, you can get a list of partition device descriptors
128using this command - the external C<lsblk> command is required, as well as 180using this command - the external C<lsblk> command is required, as well as
129a mounted C</sys> file system. 181a mounted C</sys> file system.
130 182
131The output will be a list of all partitions in the system and C<partition> 183The output will be a list of all partitions in the system and C<partition>
132descriptors for GPT and both C<legacypartition> and C<partition> 184descriptors for GPT and both C<legacypartition> and C<partition>
133descriptors for MBR partitions. 185descriptors for MBR partitions.
186
187With C<--json> it will print similar information as C<lsblk --json>, but
188with extra C<bcd_device> and C<bcd_legacy_device> attributes.
189
190=item C<bcd-device> F<path>
191
192Tries to find the BCD device element for the given device, which currently
193must be a a partition of some kind. Prints the C<partition=> descriptor as
194a result, or nothing. Exit status will be true on success, and false on
195failure.
196
197Like C<lsblk>, above, this likely only works on GNU/Linux systems.
198
199Example: print the partition descriptor of tghe partition with label DATA.
200
201 $ pbcdedit bcd-device /dev/disk/by-label/DATA
202 partition=<null>,harddisk,mbr,47cbc08a,213579202560
203
204=item C<bcd-legacy-device> F<path>
205
206Like above, but uses a C<legacypartition> descriptor instead.
134 207
135=item C<objects> [C<--json>] 208=item C<objects> [C<--json>]
136 209
137Outputs two tables: a table listing all type aliases with their hex BCD 210Outputs two tables: a table listing all type aliases with their hex BCD
138element ID, and all object name aliases with their GUID and default type 211element ID, and all object name aliases with their GUID and default type
217 } 290 }
218 291
219=head2 Minimal BCD to boot windows 292=head2 Minimal BCD to boot windows
220 293
221Experimentally I found the following BCD is the minimum required to 294Experimentally I found the following BCD is the minimum required to
222successfully boot any post-XP version of Windows (suitable C<device> and 295successfully boot any post-XP version of Windows (assuming suitable
223C<osdevice> values, of course): 296C<device> and C<osdevice> values, of course, and assuming a BIOS boot -
297for UEFI, you should use F<winload.efi> instead of F<winload.exe>):
224 298
225 { 299 {
226 "{bootmgr}" : { 300 "{bootmgr}" : {
227 "resumeobject" : "{45b547a7-8ca6-4417-9eb0-a257b61f35b4}" 301 "default" : "{45b547a7-8ca6-4417-9eb0-a257b61f35b4}"
228 }, 302 },
229 303
230 "{45b547a7-8ca6-4417-9eb0-a257b61f35b1}" : { 304 "{45b547a7-8ca6-4417-9eb0-a257b61f35b1}" : {
231 "type" : "application::osloader", 305 "type" : "application::osloader",
232 "description" : "Windows Boot", 306 "description" : "Windows Boot",
239 313
240Note that minimal doesn't mean recommended - Windows itself will add stuff 314Note that minimal doesn't mean recommended - Windows itself will add stuff
241to this during or after boot, and you might or might not run into issues 315to this during or after boot, and you might or might not run into issues
242when installing updates as it might not be able to find the F<bootmgr>. 316when installing updates as it might not be able to find the F<bootmgr>.
243 317
318This is how you would create a minimal hive with PBCDEDIT from within
319GNU/Linux, assuming F</dev/sdc3> is the windows partition, using
320a random GUID for the osloader and using C<partition> instead of
321C<legacypartition>:
322
323 osldr="{$(uuidgen)}"
324 part=$(pbcdedit bcd-device /dev/sdc3)
325 pbcdedit create minimal.bcd \
326 set '{bootmgr}' default "$osldr" \
327 set "$osldr" type application::osloader \
328 set "$osldr" description 'Windows Boot' \
329 set "$osldr" device "$part" \
330 set "$osldr" osdevice "$part" \
331 set "$osldr" path '\Windows\system32\winload.exe' \
332 set "$osldr" systemroot '\Windows'
333
244=head2 The C<meta> key 334=head2 The C<meta> key
245 335
246The C<meta> key is not stored in the BCD data store but is used only 336The C<meta> key is not stored in the BCD data store but is used only
247by PBCDEDIT. It is always generated when exporting, and importing will 337by PBCDEDIT. It is always generated when exporting, and importing will
248be refused when it exists and the version stored inside doesn't store 338be refused when it exists and the version stored inside doesn't match
249the JSON schema version of PBCDEDIT. This ensures that different and 339the JSON schema version of PBCDEDIT. This ensures that different and
250incompatible versions of PBCDEDIT will not read and misinterpret each 340incompatible versions of PBCDEDIT will not read and misinterpret each
251others data. 341others data.
252 342
253=head2 The object keys 343=head2 The object keys
262 352
263Some of these GUIDs are fixed well known GUIDs which PBCDEDIT will decode 353Some of these GUIDs are fixed well known GUIDs which PBCDEDIT will decode
264into human-readable strings such as C<{globalsettings}>, which is the same 354into human-readable strings such as C<{globalsettings}>, which is the same
265as C<{7ea2e1ac-2e61-4728-aaa3-896d9d0a9f0e}>. 355as C<{7ea2e1ac-2e61-4728-aaa3-896d9d0a9f0e}>.
266 356
267Each BCD, object has an associated type. For example, 357Each BCD object has an associated type. For example,
268C<application::osloader> for objects loading Windows via F<winload.exe>, 358C<application::osloader> for objects loading Windows via F<winload.exe>,
269C<application::bootsector> for real mode applications and so on. 359C<application::bootsector> for real mode applications and so on.
270 360
271The type of a object is stored in the pseudo BCD element C<type> (see next 361The type of a object is stored in the pseudo BCD element C<type> (see next
272section). 362section).
335 425
336 "displaybootmenu" : 0, 426 "displaybootmenu" : 0,
337 427
338=item integer 428=item integer
339 429
340Again, very simple, this is a 64 bit integer. IT can be either specified 430Again, very simple, this is a 64 bit integer. It can be either specified
341as a decimal number, as a hex number (by prefixing it with C<0x>) or as a 431as a decimal number, as a hex number (by prefixing it with C<0x>) or as a
342binary number (prefix C<0b>). 432binary number (prefix C<0b>).
343 433
344For example, the boot C<timeout> is an integer, specifying the automatic 434For example, the boot C<timeout> is an integer, specifying the automatic
345boot delay in seconds: 435boot delay in seconds:
347 "timeout" : 30, 437 "timeout" : 30,
348 438
349=item integer list 439=item integer list
350 440
351This is a list of 64 bit integers separated by whitespace. It is not used 441This is a list of 64 bit integers separated by whitespace. It is not used
352much, so here is a somewhat artificial an untested example of using 442much, so here is a somewhat artificial and untested example of using
353C<customactions> to specify a certain custom, eh, action to be executed 443C<customactions> to specify a certain custom, eh, action to be executed
354when pressing C<F10> at boot: 444when pressing C<F10> at boot:
355 445
356 "customactions" : "0x1000044000001 0x54000001", 446 "customactions" : "0x1000044000001 0x54000001",
357 447
359 449
360This represents a single GUID value wrapped in curly braces. It is used a 450This represents a single GUID value wrapped in curly braces. It is used a
361lot to refer from one BCD object to other one. 451lot to refer from one BCD object to other one.
362 452
363For example, The C<{bootmgr}> object might refer to a resume boot option 453For example, The C<{bootmgr}> object might refer to a resume boot option
364using C<resumeobject>: 454using C<default>:
365 455
366 "resumeobject" : "{7ae02178-821d-11e7-8813-1c872c5f5ab0}", 456 "default" : "{7ae02178-821d-11e7-8813-1c872c5f5ab0}",
367 457
368Human readable aliases are used and allowed. 458Human readable aliases are used and allowed.
369 459
370=item guid list 460=item guid list
371 461
385This type is why I write I<most> are easy to explain earlier: This type 475This type is why I write I<most> are easy to explain earlier: This type
386is the pinnacle of Microsoft-typical hacks layered on top of other 476is the pinnacle of Microsoft-typical hacks layered on top of other
387hacks. Understanding this type took more time than writing all the rest of 477hacks. Understanding this type took more time than writing all the rest of
388PBCDEDIT, and because it is so complex, this type has its own subsection 478PBCDEDIT, and because it is so complex, this type has its own subsection
389below. 479below.
480
390=back 481=back
391 482
392=head4 The BCD "device" element type 483=head3 The BCD "device" element type
393 484
394Device elements specify, well, devices. They are used for such diverse 485Device elements specify, well, devices. They are used for such diverse
395purposes such as finding a TFTP network boot image, serial ports or VMBUS 486purposes such as finding a TFTP network boot image, serial ports or VMBUS
396devices, but most commonly they are used to specify the disk (harddisk, 487devices, but most commonly they are used to specify the disk (harddisk,
397cdrom, ramdisk, vhd...) to boot from. 488cdrom, ramdisk, vhd...) to boot from.
405element, so almost everything known about it had to be researched first 496element, so almost everything known about it had to be researched first
406in the process of writing this script, and consequently, support for BCD 497in the process of writing this script, and consequently, support for BCD
407device elements is partial only. 498device elements is partial only.
408 499
409On the other hand, the expressive power of PBCDEDIT in specifying devices 500On the other hand, the expressive power of PBCDEDIT in specifying devices
410is much bigger than BCDEDIT and therefore more can be done with it. The 501is much greater than BCDEDIT and therefore more can be done with it. The
411downside is that BCD device elements are much more complicated than what 502downside is that BCD device elements are much more complicated than what
412you might think from reading the BCDEDIT documentation. 503you might think from reading the BCDEDIT documentation.
413 504
414In other words, simple things are complicated, and complicated things are 505In other words, simple things are complicated, and complicated things are
415possible. 506possible.
422 [{GUID}]type[<flags>][=arg,arg...] 513 [{GUID}]type[<flags>][=arg,arg...]
423 514
424Here are some examples: 515Here are some examples:
425 516
426 boot 517 boot
427 {b097d29f-bc00-11e9-8a9a-525400123456}block=file,<boot>,\\EFI" 518 {b097d29f-bc00-11e9-8a9a-525400123456}block=file,<boot>,\EFI
428 locate=<null>,element,systemroot 519 locate=<null>,element,systemroot
429 partition=<null>,harddisk,mbr,47cbc08a,1048576 520 partition=<null>,harddisk,mbr,47cbc08a,1048576
430 partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,76d39e5f-ad1b-407e-9c05-c81eb83b57dd 521 partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,76d39e5f-ad1b-407e-9c05-c81eb83b57dd
431 block<1>=ramdisk,<partition=<null>,harddisk,mbr,47cbc08a,68720525312>,0,0,0,\Recovery\b097d29e-bc00-11e9-8a9a-525400123456\Winre.wim 522 block<1>=ramdisk,<partition=<null>,harddisk,mbr,47cbc08a,68720525312>,0,0,0,\Recovery\b097d29e-bc00-11e9-8a9a-525400123456\Winre.wim
432 block=file,<partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,ee3a393a-f0de-4057-9946-88584245ed48>,\ 523 block=file,<partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,ee3a393a-f0de-4057-9946-88584245ed48>,\
458the leading GUID, which it can always decode). In such cases, it will 549the leading GUID, which it can always decode). In such cases, it will
459convert the device into this type with a hexdump of the element data. 550convert the device into this type with a hexdump of the element data.
460 551
461=item C<null> 552=item C<null>
462 553
463This is another special type - sometimes, a device all zero-filled, which 554This is another special type - sometimes, a device is all zero-filled,
464is not valid. This can mark the absence of a device or something PBCDEDIT 555which is not valid. This can mark the absence of a device or something
465does not understand, so it decodes it into this special "all zero" type 556PBCDEDIT does not understand, so it decodes it into this special "all
466called C<null>. 557zero" type called C<null>.
467 558
468It's most commonly found in devices that can use an optional parent 559It's most commonly found in devices that can use an optional parent
469device, when no parent device is used. 560device, when no parent device is used.
470 561
471=item C<boot> 562=item C<boot>
582 673
583Last not least, the most complex type, C<block>, which... specifies block 674Last not least, the most complex type, C<block>, which... specifies block
584devices (which could be inside a F<vhdx> file for example). 675devices (which could be inside a F<vhdx> file for example).
585 676
586I<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>, 677I<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>,
587C<file> or C<vhd> - the same as for C<partiion=>. 678C<file> or C<vhd> - the same as for C<partition=>.
588 679
589The remaining arguments change depending on the I<devicetype>: 680The remaining arguments change depending on the I<devicetype>:
590 681
591=over 682=over
592 683
622 713
623Probably not yet implemented. Tell me of your needs... 714Probably not yet implemented. Tell me of your needs...
624 715
625=back 716=back
626 717
627=back5 Examples 718=back
719
720=head4 Examples
628 721
629This concludes the syntax overview for device elements, but probably 722This concludes the syntax overview for device elements, but probably
630leaves many questions open. I can't help with most of them, as I also ave 723leaves many questions open. I can't help with most of them, as I also have
631many questions, but I can walk you through some actual examples using more 724many questions, but I can walk you through some actual examples using more
632complex aspects. 725complex aspects.
726
727=over
633 728
634=item C<< locate=<block=vhd,<block=file,<locate=<null>,path,\disk.vhdx>,\disk.vhdx>>,element,path >> 729=item C<< locate=<block=vhd,<block=file,<locate=<null>,path,\disk.vhdx>,\disk.vhdx>>,element,path >>
635 730
636Just like with C declarations, you best treat device descriptors as 731Just like with C declarations, you best treat device descriptors as
637instructions to find your device and work your way from the inside out: 732instructions to find your device and work your way from the inside out:
709I don't know what the purpose of the C<< <1> >> flag value is, but it 804I don't know what the purpose of the C<< <1> >> flag value is, but it
710seems to be always there on this kind of entry. 805seems to be always there on this kind of entry.
711 806
712If you have some good examples to add here, feel free to mail me. 807If you have some good examples to add here, feel free to mail me.
713 808
809=back
810
714 811
715=head1 EDITING BCD STORES 812=head1 EDITING BCD STORES
716 813
717The C<edit> and C<parse> subcommands allow you to read a BCD data store 814The C<edit> and C<parse> subcommands allow you to read a BCD data store
718and modify it or extract data from it. This is done by executing a series 815and modify it or extract data from it. This is done by executing a series
736Similar to C<get>, but sets the element to the given I<value> instead. 833Similar to C<get>, but sets the element to the given I<value> instead.
737 834
738Example: change the bootmgr default too 835Example: change the bootmgr default too
739C<{b097d2ad-bc00-11e9-8a9a-525400123456}>: 836C<{b097d2ad-bc00-11e9-8a9a-525400123456}>:
740 837
741 pbcdedit edit BCD set "{bootmgr}" resumeobject "{b097d2ad-bc00-11e9-8a9a-525400123456}" 838 pbcdedit edit BCD set "{bootmgr}" default "{b097d2ad-bc00-11e9-8a9a-525400123456}"
839
840=item C<del> I<object> I<element>
841
842Similar to C<get>, but removed the BCD element from the specified BCD object.
742 843
743=item C<eval> I<perlcode> 844=item C<eval> I<perlcode>
744 845
745This takes the next argument, interprets it as Perl code and 846This takes the next argument, interprets it as Perl code and
746evaluates it. This allows you to do more complicated modifications or 847evaluates it. This allows you to do more complicated modifications or
769 870
770 pbcdedit edit BCD eval 'say $BCD->{$DEFAULT}{description}' 871 pbcdedit edit BCD eval 'say $BCD->{$DEFAULT}{description}'
771 872
772The example given for C<set> could be expressed like this: 873The example given for C<set> could be expressed like this:
773 874
774 pbcdedit edit BCD eval '$BCD->{$DEFAULT}{resumeobject} = "{b097d2ad-bc00-11e9-8a9a-525400123456}"' 875 pbcdedit edit BCD eval '$BCD->{"{bootmgr}"{default} = "{b097d2ad-bc00-11e9-8a9a-525400123456}"'
775 876
776=item C<do> I<path> 877=item C<do> I<path>
777 878
778Similar to C<eval>, above, but instead of using the argument as perl code, 879Similar to C<eval>, above, but instead of using the argument as perl code,
779it loads the perl code from the given file and executes it. This makes it 880it loads the perl code from the given file and executes it. This makes it
827=cut 928=cut
828 929
829# common sense is optional, but recommended 930# common sense is optional, but recommended
830BEGIN { eval { require "common/sense.pm"; } && common::sense->import } 931BEGIN { eval { require "common/sense.pm"; } && common::sense->import }
831 932
933no warnings 'portable'; # avoid 32 bit integer warnings
934
832use Encode (); 935use Encode ();
833use List::Util (); 936use List::Util ();
834use IO::Handle (); 937use IO::Handle ();
835use Time::HiRes (); 938use Time::HiRes ();
836 939
845 948
846# hack used for debugging 949# hack used for debugging
847sub xxd($$) { 950sub xxd($$) {
848 open my $xxd, "| xxd | sed -e 's/^/\Q$_[0]\E: /'"; 951 open my $xxd, "| xxd | sed -e 's/^/\Q$_[0]\E: /'";
849 syswrite $xxd, $_[1]; 952 syswrite $xxd, $_[1];
953}
954
955# get some meta info on a file (uid, gid, perms)
956sub stat_get($) {
957 [(stat shift)[4, 5, 2]]
958}
959
960# set stat info on a file
961sub stat_set($$) {
962 my ($fh_or_path, $stat) = @_;
963
964 return unless $stat;
965 chown $stat->[0], $stat->[1], $fh_or_path;
966 chmod +($stat->[2] & 07777), $fh_or_path;
850} 967}
851 968
852sub file_load($) { 969sub file_load($) {
853 my ($path) = @_; 970 my ($path) = @_;
854 971
857 my $size = -s $fh; 974 my $size = -s $fh;
858 $size = read $fh, my $buf, $size 975 $size = read $fh, my $buf, $size
859 or die "$path: short read\n"; 976 or die "$path: short read\n";
860 977
861 $buf 978 $buf
979}
980
981sub file_save($$;$) {
982 my ($path, $data, $stat) = @_;
983
984 open my $fh, ">:raw", "$path~"
985 or die "$path~: $!\n";
986 print $fh $data
987 or die "$path~: short write\n";
988 stat_set $fh, $stat;
989 $fh->sync;
990 close $fh;
991
992 rename "$path~", $path;
862} 993}
863 994
864# sources and resources used for writing pbcdedit 995# sources and resources used for writing pbcdedit
865# 996#
866# registry: 997# registry:
1052 my ($rname, $root) = $decode_key->($rootcell); 1183 my ($rname, $root) = $decode_key->($rootcell);
1053 1184
1054 [$rname, $root] 1185 [$rname, $root]
1055} 1186}
1056 1187
1057# return a binary windows fILETIME struct 1188# return a binary windows FILETIME struct
1058sub filetime_now { 1189sub filetime_now {
1059 my ($s, $ms) = Time::HiRes::gettimeofday; 1190 my ($s, $ms) = Time::HiRes::gettimeofday;
1060 1191
1061 pack "Q<", $s = ($s * 1_000_000 + $ms) * 10 + 116_444_736_000_000_000 1192 pack "Q<", ($s * 1_000_000 + $ms) * 10
1193 + 116_444_736_000_000_000 # 1970-01-01 00:00:00
1062} 1194}
1063 1195
1064# encode a registry hive 1196# encode a registry hive
1065sub regf_encode($) { 1197sub regf_encode($) {
1066 my ($hive) = @_; 1198 my ($hive) = @_;
1069 1201
1070 # the filetime is apparently used to verify log file validity, 1202 # the filetime is apparently used to verify log file validity,
1071 # so by generating a new timestamp the log files *should* automatically 1203 # so by generating a new timestamp the log files *should* automatically
1072 # become invalidated and windows would "self-heal" them. 1204 # become invalidated and windows would "self-heal" them.
1073 # (update: has been verified by reverse engineering) 1205 # (update: has been verified by reverse engineering)
1074 # possibly the fact that the two sequence numbes match might also 1206 # possibly the fact that the two sequence numbers match might also
1075 # make windows think that the hive is not dirty and ignore logs. 1207 # make windows think that the hive is not dirty and ignore logs.
1076 # (update: has been verified by reverse engineering) 1208 # (update: has been verified by reverse engineering)
1077 1209
1078 my $now = filetime_now; 1210 my $now = filetime_now;
1079 1211
1223 1355
1224 regf_decode file_load $path 1356 regf_decode file_load $path
1225} 1357}
1226 1358
1227# encode and save registry to file 1359# encode and save registry to file
1228sub regf_save { 1360sub regf_save($$;$) {
1229 my ($path, $hive) = @_; 1361 my ($path, $hive, $stat) = @_;
1230 1362
1231 $hive = regf_encode $hive; 1363 $hive = regf_encode $hive;
1232 1364
1233 open my $regf, ">:raw", "$path~" 1365 file_save $path, $hive, $stat;
1234 or die "$path~: $!\n";
1235 print $regf $hive
1236 or die "$path~: short write\n";
1237 $regf->sync;
1238 close $regf;
1239
1240 rename "$path~", $path;
1241} 1366}
1242 1367
1243############################################################################# 1368#############################################################################
1244# bcd stuff 1369# bcd stuff
1245 1370
1246# human-readable alises for GUID object identifiers 1371# human-readable aliases for GUID object identifiers
1247our %bcd_objects = ( 1372our %bcd_objects = (
1248 '{0ce4991b-e6b3-4b16-b23c-5e0d9250e5d9}' => '{emssettings}', 1373 '{0ce4991b-e6b3-4b16-b23c-5e0d9250e5d9}' => '{emssettings}',
1249 '{1afa9c49-16ab-4a5c-4a90-212802da9460}' => '{resumeloadersettings}', 1374 '{1afa9c49-16ab-4a5c-4a90-212802da9460}' => '{resumeloadersettings}',
1250 '{1cae1eb7-a0df-4d4d-9851-4860e34ef535}' => '{default}', 1375 '{1cae1eb7-a0df-4d4d-9851-4860e34ef535}' => '{default}',
1251 '{313e8eed-7098-4586-a9bf-309c61f8d449}' => '{kerneldbgsettings}', 1376 '{313e8eed-7098-4586-a9bf-309c61f8d449}' => '{kerneldbgsettings}',
1358sub BCDE_FORMAT_GUID_LIST () { 0x04000000 } 1483sub BCDE_FORMAT_GUID_LIST () { 0x04000000 }
1359sub BCDE_FORMAT_INTEGER () { 0x05000000 } 1484sub BCDE_FORMAT_INTEGER () { 0x05000000 }
1360sub BCDE_FORMAT_BOOLEAN () { 0x06000000 } 1485sub BCDE_FORMAT_BOOLEAN () { 0x06000000 }
1361sub BCDE_FORMAT_INTEGER_LIST () { 0x07000000 } 1486sub BCDE_FORMAT_INTEGER_LIST () { 0x07000000 }
1362 1487
1363sub dec_device;
1364sub enc_device;
1365
1366sub enc_integer($) { 1488sub enc_integer($) {
1367 no warnings 'portable'; # ugh
1368 my $value = shift; 1489 my $value = shift;
1369 $value = oct $value if $value =~ /^0[bBxX]/; 1490 $value = oct $value if $value =~ /^0[bBxX]/;
1370 unpack "H*", pack "Q<", $value 1491 unpack "H*", pack "Q<", $value
1371} 1492}
1493
1494sub enc_device($$);
1495sub dec_device($$);
1372 1496
1373our %bcde_dec = ( 1497our %bcde_dec = (
1374 BCDE_FORMAT_DEVICE , \&dec_device, 1498 BCDE_FORMAT_DEVICE , \&dec_device,
1375# # for round-trip verification 1499# # for round-trip verification
1376# BCDE_FORMAT_DEVICE , sub { 1500# BCDE_FORMAT_DEVICE , sub {
1382 BCDE_FORMAT_STRING , sub { shift }, 1506 BCDE_FORMAT_STRING , sub { shift },
1383 BCDE_FORMAT_GUID , sub { dec_wguid enc_wguid shift }, 1507 BCDE_FORMAT_GUID , sub { dec_wguid enc_wguid shift },
1384 BCDE_FORMAT_GUID_LIST , sub { join " ", map dec_wguid enc_wguid $_, @{+shift} }, 1508 BCDE_FORMAT_GUID_LIST , sub { join " ", map dec_wguid enc_wguid $_, @{+shift} },
1385 BCDE_FORMAT_INTEGER , sub { unpack "Q", pack "a8", pack "H*", shift }, # integer might be 4 or 8 bytes - caused by ms coding bugs 1509 BCDE_FORMAT_INTEGER , sub { unpack "Q", pack "a8", pack "H*", shift }, # integer might be 4 or 8 bytes - caused by ms coding bugs
1386 BCDE_FORMAT_BOOLEAN , sub { shift eq "00" ? 0 : 1 }, 1510 BCDE_FORMAT_BOOLEAN , sub { shift eq "00" ? 0 : 1 },
1387 BCDE_FORMAT_INTEGER_LIST, sub { join " ", unpack "Q*", pack "H*", shift }, # not sure if this cna be 4 bytes 1511 BCDE_FORMAT_INTEGER_LIST, sub { join " ", unpack "Q*", pack "H*", shift }, # not sure if this can be 4 bytes
1388); 1512);
1389 1513
1390our %bcde_enc = ( 1514our %bcde_enc = (
1391 BCDE_FORMAT_DEVICE , sub { binary => enc_device shift }, 1515 BCDE_FORMAT_DEVICE , sub { binary => enc_device $_[0], $_[1] },
1392 BCDE_FORMAT_STRING , sub { sz => shift }, 1516 BCDE_FORMAT_STRING , sub { sz => shift },
1393 BCDE_FORMAT_GUID , sub { sz => "{" . (dec_guid enc_wguid shift) . "}" }, 1517 BCDE_FORMAT_GUID , sub { sz => "{" . (dec_guid enc_wguid shift) . "}" },
1394 BCDE_FORMAT_GUID_LIST , sub { multi_sz => [map "{" . (dec_guid enc_wguid $_) . "}", split /\s+/, shift ] }, 1518 BCDE_FORMAT_GUID_LIST , sub { multi_sz => [map "{" . (dec_guid enc_wguid $_) . "}", split /\s+/, shift ] },
1395 BCDE_FORMAT_INTEGER , sub { binary => enc_integer shift }, 1519 BCDE_FORMAT_INTEGER , sub { binary => enc_integer shift },
1396 BCDE_FORMAT_BOOLEAN , sub { binary => shift ? "01" : "00" }, 1520 BCDE_FORMAT_BOOLEAN , sub { binary => shift ? "01" : "00" },
1397 BCDE_FORMAT_INTEGER_LIST, sub { binary => join "", map enc_integer $_, split /\s+/, shift }, 1521 BCDE_FORMAT_INTEGER_LIST, sub { binary => join "", map enc_integer $_, split /\s+/, shift },
1398); 1522);
1399 1523
1400# BCD Elements 1524# BCD Elements
1401our %bcde = ( 1525our %bcde_byclass = (
1526 any => {
1402 0x11000001 => 'device', 1527 0x11000001 => 'device',
1403 0x12000002 => 'path', 1528 0x12000002 => 'path',
1404 0x12000004 => 'description', 1529 0x12000004 => 'description',
1405 0x12000005 => 'locale', 1530 0x12000005 => 'locale',
1406 0x14000006 => 'inherit', 1531 0x14000006 => 'inherit',
1407 0x15000007 => 'truncatememory', 1532 0x15000007 => 'truncatememory',
1408 0x14000008 => 'recoverysequence', 1533 0x14000008 => 'recoverysequence',
1409 0x16000009 => 'recoveryenabled', 1534 0x16000009 => 'recoveryenabled',
1410 0x1700000a => 'badmemorylist', 1535 0x1700000a => 'badmemorylist',
1411 0x1600000b => 'badmemoryaccess', 1536 0x1600000b => 'badmemoryaccess',
1412 0x1500000c => 'firstmegabytepolicy', 1537 0x1500000c => 'firstmegabytepolicy',
1413 0x1500000d => 'relocatephysical', 1538 0x1500000d => 'relocatephysical',
1414 0x1500000e => 'avoidlowmemory', 1539 0x1500000e => 'avoidlowmemory',
1415 0x1600000f => 'traditionalkseg', 1540 0x1600000f => 'traditionalkseg',
1416 0x16000010 => 'bootdebug', 1541 0x16000010 => 'bootdebug',
1417 0x15000011 => 'debugtype', 1542 0x15000011 => 'debugtype',
1418 0x15000012 => 'debugaddress', 1543 0x15000012 => 'debugaddress',
1419 0x15000013 => 'debugport', 1544 0x15000013 => 'debugport',
1420 0x15000014 => 'baudrate', 1545 0x15000014 => 'baudrate',
1421 0x15000015 => 'channel', 1546 0x15000015 => 'channel',
1422 0x12000016 => 'targetname', 1547 0x12000016 => 'targetname',
1423 0x16000017 => 'noumex', 1548 0x16000017 => 'noumex',
1424 0x15000018 => 'debugstart', 1549 0x15000018 => 'debugstart',
1425 0x12000019 => 'busparams', 1550 0x12000019 => 'busparams',
1426 0x1500001a => 'hostip', 1551 0x1500001a => 'hostip',
1427 0x1500001b => 'port', 1552 0x1500001b => 'port',
1428 0x1600001c => 'dhcp', 1553 0x1600001c => 'dhcp',
1429 0x1200001d => 'key', 1554 0x1200001d => 'key',
1430 0x1600001e => 'vm', 1555 0x1600001e => 'vm',
1431 0x16000020 => 'bootems', 1556 0x16000020 => 'bootems',
1432 0x15000022 => 'emsport', 1557 0x15000022 => 'emsport',
1433 0x15000023 => 'emsbaudrate', 1558 0x15000023 => 'emsbaudrate',
1434 0x12000030 => 'loadoptions', 1559 0x12000030 => 'loadoptions',
1435 0x16000040 => 'advancedoptions', 1560 0x16000040 => 'advancedoptions',
1436 0x16000041 => 'optionsedit', 1561 0x16000041 => 'optionsedit',
1437 0x15000042 => 'keyringaddress', 1562 0x15000042 => 'keyringaddress',
1438 0x11000043 => 'bootstatdevice', 1563 0x11000043 => 'bootstatdevice',
1439 0x12000044 => 'bootstatfilepath', 1564 0x12000044 => 'bootstatfilepath',
1440 0x16000045 => 'preservebootstat', 1565 0x16000045 => 'preservebootstat',
1441 0x16000046 => 'graphicsmodedisabled', 1566 0x16000046 => 'graphicsmodedisabled',
1442 0x15000047 => 'configaccesspolicy', 1567 0x15000047 => 'configaccesspolicy',
1443 0x16000048 => 'nointegritychecks', 1568 0x16000048 => 'nointegritychecks',
1444 0x16000049 => 'testsigning', 1569 0x16000049 => 'testsigning',
1445 0x1200004a => 'fontpath', 1570 0x1200004a => 'fontpath',
1446 0x1500004b => 'integrityservices', 1571 0x1500004b => 'integrityservices',
1447 0x1500004c => 'volumebandid', 1572 0x1500004c => 'volumebandid',
1448 0x16000050 => 'extendedinput', 1573 0x16000050 => 'extendedinput',
1449 0x15000051 => 'initialconsoleinput', 1574 0x15000051 => 'initialconsoleinput',
1450 0x15000052 => 'graphicsresolution', 1575 0x15000052 => 'graphicsresolution',
1451 0x16000053 => 'restartonfailure', 1576 0x16000053 => 'restartonfailure',
1452 0x16000054 => 'highestmode', 1577 0x16000054 => 'highestmode',
1453 0x16000060 => 'isolatedcontext', 1578 0x16000060 => 'isolatedcontext',
1454 0x15000065 => 'displaymessage', 1579 0x15000065 => 'displaymessage',
1455 0x15000066 => 'displaymessageoverride', 1580 0x15000066 => 'displaymessageoverride',
1456 0x16000068 => 'nobootuxtext', 1581 0x16000068 => 'nobootuxtext',
1457 0x16000069 => 'nobootuxprogress', 1582 0x16000069 => 'nobootuxprogress',
1458 0x1600006a => 'nobootuxfade', 1583 0x1600006a => 'nobootuxfade',
1459 0x1600006b => 'bootuxreservepooldebug', 1584 0x1600006b => 'bootuxreservepooldebug',
1460 0x1600006c => 'bootuxdisabled', 1585 0x1600006c => 'bootuxdisabled',
1461 0x1500006d => 'bootuxfadeframes', 1586 0x1500006d => 'bootuxfadeframes',
1462 0x1600006e => 'bootuxdumpstats', 1587 0x1600006e => 'bootuxdumpstats',
1463 0x1600006f => 'bootuxshowstats', 1588 0x1600006f => 'bootuxshowstats',
1464 0x16000071 => 'multibootsystem', 1589 0x16000071 => 'multibootsystem',
1465 0x16000072 => 'nokeyboard', 1590 0x16000072 => 'nokeyboard',
1466 0x15000073 => 'aliaswindowskey', 1591 0x15000073 => 'aliaswindowskey',
1467 0x16000074 => 'bootshutdowndisabled', 1592 0x16000074 => 'bootshutdowndisabled',
1468 0x15000075 => 'performancefrequency', 1593 0x15000075 => 'performancefrequency',
1469 0x15000076 => 'securebootrawpolicy', 1594 0x15000076 => 'securebootrawpolicy',
1470 0x17000077 => 'allowedinmemorysettings', 1595 0x17000077 => 'allowedinmemorysettings',
1471 0x15000079 => 'bootuxtransitiontime', 1596 0x15000079 => 'bootuxtransitiontime',
1472 0x1600007a => 'mobilegraphics', 1597 0x1600007a => 'mobilegraphics',
1473 0x1600007b => 'forcefipscrypto', 1598 0x1600007b => 'forcefipscrypto',
1474 0x1500007d => 'booterrorux', 1599 0x1500007d => 'booterrorux',
1475 0x1600007e => 'flightsigning', 1600 0x1600007e => 'flightsigning',
1476 0x1500007f => 'measuredbootlogformat', 1601 0x1500007f => 'measuredbootlogformat',
1477 0x15000080 => 'displayrotation', 1602 0x15000080 => 'displayrotation',
1478 0x15000081 => 'logcontrol', 1603 0x15000081 => 'logcontrol',
1479 0x16000082 => 'nofirmwaresync', 1604 0x16000082 => 'nofirmwaresync',
1480 0x11000084 => 'windowssyspart', 1605 0x11000084 => 'windowssyspart',
1481 0x16000087 => 'numlock', 1606 0x16000087 => 'numlock',
1482 0x22000001 => 'bpbstring', 1607 0x26000202 => 'skipffumode',
1608 0x26000203 => 'forceffumode',
1609 0x25000510 => 'chargethreshold',
1610 0x26000512 => 'offmodecharging',
1611 0x25000aaa => 'bootflow',
1612 0x45000001 => 'devicetype',
1613 0x42000002 => 'applicationrelativepath',
1614 0x42000003 => 'ramdiskdevicerelativepath',
1615 0x46000004 => 'omitosloaderelements',
1616 0x47000006 => 'elementstomigrate',
1617 0x46000010 => 'recoveryos',
1618 },
1619 bootapp => {
1620 0x26000145 => 'enablebootdebugpolicy',
1621 0x26000146 => 'enablebootorderclean',
1622 0x26000147 => 'enabledeviceid',
1623 0x26000148 => 'enableffuloader',
1624 0x26000149 => 'enableiuloader',
1625 0x2600014a => 'enablemassstorage',
1626 0x2600014b => 'enablerpmbprovisioning',
1627 0x2600014c => 'enablesecurebootpolicy',
1628 0x2600014d => 'enablestartcharge',
1629 0x2600014e => 'enableresettpm',
1630 },
1631 bootmgr => {
1483 0x24000001 => 'displayorder', 1632 0x24000001 => 'displayorder',
1484 0x21000001 => 'filedevice',
1485 0x21000001 => 'osdevice',
1486 0x25000001 => 'passcount',
1487 0x26000001 => 'pxesoftreboot',
1488 0x22000002 => 'applicationname',
1489 0x24000002 => 'bootsequence', 1633 0x24000002 => 'bootsequence',
1490 0x22000002 => 'filepath',
1491 0x22000002 => 'systemroot',
1492 0x25000002 => 'testmix',
1493 0x26000003 => 'cacheenable',
1494 0x26000003 => 'customsettings',
1495 0x23000003 => 'default', 1634 0x23000003 => 'default',
1496 0x25000003 => 'failurecount',
1497 0x23000003 => 'resumeobject',
1498 0x26000004 => 'failuresenabled',
1499 0x26000004 => 'pae',
1500 0x26000004 => 'stampdisks',
1501 0x25000004 => 'testtofail',
1502 0x25000004 => 'timeout', 1635 0x25000004 => 'timeout',
1503 0x21000005 => 'associatedosdevice',
1504 0x26000005 => 'cacheenable',
1505 0x26000005 => 'resume', 1636 0x26000005 => 'resume',
1506 0x25000005 => 'stridefailcount',
1507 0x26000006 => 'debugoptionenabled',
1508 0x25000006 => 'invcfailcount',
1509 0x23000006 => 'resumeobject', 1637 0x23000006 => 'resumeobject',
1510 0x25000007 => 'bootux',
1511 0x25000007 => 'matsfailcount',
1512 0x24000007 => 'startupsequence', 1638 0x24000007 => 'startupsequence',
1513 0x25000008 => 'bootmenupolicy',
1514 0x25000008 => 'randfailcount',
1515 0x25000009 => 'chckrfailcount',
1516 0x26000010 => 'detecthal',
1517 0x24000010 => 'toolsdisplayorder', 1639 0x24000010 => 'toolsdisplayorder',
1518 0x22000011 => 'kernel',
1519 0x22000012 => 'hal',
1520 0x22000013 => 'dbgtransport',
1521 0x26000020 => 'displaybootmenu', 1640 0x26000020 => 'displaybootmenu',
1522 0x25000020 => 'nx',
1523 0x26000021 => 'noerrordisplay', 1641 0x26000021 => 'noerrordisplay',
1524 0x25000021 => 'pae',
1525 0x21000022 => 'bcddevice', 1642 0x21000022 => 'bcddevice',
1526 0x26000022 => 'winpe',
1527 0x22000023 => 'bcdfilepath', 1643 0x22000023 => 'bcdfilepath',
1528 0x26000024 => 'hormenabled', 1644 0x26000024 => 'hormenabled',
1529 0x26000024 => 'hormenabled',
1530 0x26000024 => 'nocrashautoreboot',
1531 0x26000025 => 'hiberboot', 1645 0x26000025 => 'hiberboot',
1532 0x26000025 => 'lastknowngood',
1533 0x26000026 => 'oslnointegritychecks',
1534 0x22000026 => 'passwordoverride', 1646 0x22000026 => 'passwordoverride',
1535 0x26000027 => 'osltestsigning',
1536 0x22000027 => 'pinpassphraseoverride', 1647 0x22000027 => 'pinpassphraseoverride',
1537 0x26000028 => 'processcustomactionsfirst', 1648 0x26000028 => 'processcustomactionsfirst',
1538 0x27000030 => 'customactions', 1649 0x27000030 => 'customactions',
1539 0x26000030 => 'nolowmem',
1540 0x26000031 => 'persistbootsequence', 1650 0x26000031 => 'persistbootsequence',
1541 0x25000031 => 'removememory',
1542 0x25000032 => 'increaseuserva',
1543 0x26000032 => 'skipstartupsequence', 1651 0x26000032 => 'skipstartupsequence',
1544 0x25000033 => 'perfmem',
1545 0x22000040 => 'fverecoveryurl', 1652 0x22000040 => 'fverecoveryurl',
1546 0x26000040 => 'vga',
1547 0x22000041 => 'fverecoverymessage', 1653 0x22000041 => 'fverecoverymessage',
1654 },
1655 device => {
1656 0x35000001 => 'ramdiskimageoffset',
1657 0x35000002 => 'ramdisktftpclientport',
1658 0x31000003 => 'ramdisksdidevice',
1659 0x32000004 => 'ramdisksdipath',
1660 0x35000005 => 'ramdiskimagelength',
1661 0x36000006 => 'exportascd',
1662 0x35000007 => 'ramdisktftpblocksize',
1663 0x35000008 => 'ramdisktftpwindowsize',
1664 0x36000009 => 'ramdiskmcenabled',
1665 0x3600000a => 'ramdiskmctftpfallback',
1666 0x3600000b => 'ramdisktftpvarwindow',
1667 },
1668 memdiag => {
1669 0x25000001 => 'passcount',
1670 0x25000002 => 'testmix',
1671 0x25000003 => 'failurecount',
1672 0x26000003 => 'cacheenable',
1673 0x25000004 => 'testtofail',
1674 0x26000004 => 'failuresenabled',
1675 0x25000005 => 'stridefailcount',
1676 0x26000005 => 'cacheenable',
1677 0x25000006 => 'invcfailcount',
1678 0x25000007 => 'matsfailcount',
1679 0x25000008 => 'randfailcount',
1680 0x25000009 => 'chckrfailcount',
1681 },
1682 ntldr => {
1683 0x22000001 => 'bpbstring',
1684 },
1685 osloader => {
1686 0x21000001 => 'osdevice',
1687 0x22000002 => 'systemroot',
1688 0x23000003 => 'resumeobject',
1689 0x26000004 => 'stampdisks',
1690 0x26000010 => 'detecthal',
1691 0x22000011 => 'kernel',
1692 0x22000012 => 'hal',
1693 0x22000013 => 'dbgtransport',
1694 0x25000020 => 'nx',
1695 0x25000021 => 'pae',
1696 0x26000022 => 'winpe',
1697 0x26000024 => 'nocrashautoreboot',
1698 0x26000025 => 'lastknowngood',
1699 0x26000026 => 'oslnointegritychecks',
1700 0x26000027 => 'osltestsigning',
1701 0x26000030 => 'nolowmem',
1702 0x25000031 => 'removememory',
1703 0x25000032 => 'increaseuserva',
1704 0x25000033 => 'perfmem',
1705 0x26000040 => 'vga',
1548 0x26000041 => 'quietboot', 1706 0x26000041 => 'quietboot',
1549 0x26000042 => 'novesa', 1707 0x26000042 => 'novesa',
1550 0x26000043 => 'novga', 1708 0x26000043 => 'novga',
1551 0x25000050 => 'clustermodeaddressing', 1709 0x25000050 => 'clustermodeaddressing',
1552 0x26000051 => 'usephysicaldestination', 1710 0x26000051 => 'usephysicaldestination',
1553 0x25000052 => 'restrictapiccluster', 1711 0x25000052 => 'restrictapiccluster',
1554 0x22000053 => 'evstore', 1712 0x22000053 => 'evstore',
1555 0x26000054 => 'uselegacyapicmode', 1713 0x26000054 => 'uselegacyapicmode',
1556 0x26000060 => 'onecpu', 1714 0x26000060 => 'onecpu',
1557 0x25000061 => 'numproc', 1715 0x25000061 => 'numproc',
1558 0x26000062 => 'maxproc', 1716 0x26000062 => 'maxproc',
1559 0x25000063 => 'configflags', 1717 0x25000063 => 'configflags',
1560 0x26000064 => 'maxgroup', 1718 0x26000064 => 'maxgroup',
1561 0x26000065 => 'groupaware', 1719 0x26000065 => 'groupaware',
1562 0x25000066 => 'groupsize', 1720 0x25000066 => 'groupsize',
1563 0x26000070 => 'usefirmwarepcisettings', 1721 0x26000070 => 'usefirmwarepcisettings',
1564 0x25000071 => 'msi', 1722 0x25000071 => 'msi',
1565 0x25000072 => 'pciexpress', 1723 0x25000072 => 'pciexpress',
1566 0x25000080 => 'safeboot', 1724 0x25000080 => 'safeboot',
1567 0x26000081 => 'safebootalternateshell', 1725 0x26000081 => 'safebootalternateshell',
1568 0x26000090 => 'bootlog', 1726 0x26000090 => 'bootlog',
1569 0x26000091 => 'sos', 1727 0x26000091 => 'sos',
1570 0x260000a0 => 'debug', 1728 0x260000a0 => 'debug',
1571 0x260000a1 => 'halbreakpoint', 1729 0x260000a1 => 'halbreakpoint',
1572 0x260000a2 => 'useplatformclock', 1730 0x260000a2 => 'useplatformclock',
1573 0x260000a3 => 'forcelegacyplatform', 1731 0x260000a3 => 'forcelegacyplatform',
1574 0x260000a4 => 'useplatformtick', 1732 0x260000a4 => 'useplatformtick',
1575 0x260000a5 => 'disabledynamictick', 1733 0x260000a5 => 'disabledynamictick',
1576 0x250000a6 => 'tscsyncpolicy', 1734 0x250000a6 => 'tscsyncpolicy',
1577 0x260000b0 => 'ems', 1735 0x260000b0 => 'ems',
1578 0x250000c0 => 'forcefailure', 1736 0x250000c0 => 'forcefailure',
1579 0x250000c1 => 'driverloadfailurepolicy', 1737 0x250000c1 => 'driverloadfailurepolicy',
1580 0x250000c2 => 'bootmenupolicy', 1738 0x250000c2 => 'bootmenupolicy',
1581 0x260000c3 => 'onetimeadvancedoptions', 1739 0x260000c3 => 'onetimeadvancedoptions',
1582 0x260000c4 => 'onetimeoptionsedit', 1740 0x260000c4 => 'onetimeoptionsedit',
1583 0x250000e0 => 'bootstatuspolicy', 1741 0x250000e0 => 'bootstatuspolicy',
1584 0x260000e1 => 'disableelamdrivers', 1742 0x260000e1 => 'disableelamdrivers',
1585 0x250000f0 => 'hypervisorlaunchtype', 1743 0x250000f0 => 'hypervisorlaunchtype',
1586 0x220000f1 => 'hypervisorpath', 1744 0x220000f1 => 'hypervisorpath',
1587 0x260000f2 => 'hypervisordebug', 1745 0x260000f2 => 'hypervisordebug',
1588 0x250000f3 => 'hypervisordebugtype', 1746 0x250000f3 => 'hypervisordebugtype',
1589 0x250000f4 => 'hypervisordebugport', 1747 0x250000f4 => 'hypervisordebugport',
1590 0x250000f5 => 'hypervisorbaudrate', 1748 0x250000f5 => 'hypervisorbaudrate',
1591 0x250000f6 => 'hypervisorchannel', 1749 0x250000f6 => 'hypervisorchannel',
1592 0x250000f7 => 'bootux', 1750 0x250000f7 => 'bootux',
1593 0x260000f8 => 'hypervisordisableslat', 1751 0x260000f8 => 'hypervisordisableslat',
1594 0x220000f9 => 'hypervisorbusparams', 1752 0x220000f9 => 'hypervisorbusparams',
1595 0x250000fa => 'hypervisornumproc', 1753 0x250000fa => 'hypervisornumproc',
1596 0x250000fb => 'hypervisorrootprocpernode', 1754 0x250000fb => 'hypervisorrootprocpernode',
1597 0x260000fc => 'hypervisoruselargevtlb', 1755 0x260000fc => 'hypervisoruselargevtlb',
1598 0x250000fd => 'hypervisorhostip', 1756 0x250000fd => 'hypervisorhostip',
1599 0x250000fe => 'hypervisorhostport', 1757 0x250000fe => 'hypervisorhostport',
1600 0x250000ff => 'hypervisordebugpages', 1758 0x250000ff => 'hypervisordebugpages',
1601 0x25000100 => 'tpmbootentropy', 1759 0x25000100 => 'tpmbootentropy',
1602 0x22000110 => 'hypervisorusekey', 1760 0x22000110 => 'hypervisorusekey',
1603 0x22000112 => 'hypervisorproductskutype', 1761 0x22000112 => 'hypervisorproductskutype',
1604 0x25000113 => 'hypervisorrootproc', 1762 0x25000113 => 'hypervisorrootproc',
1605 0x26000114 => 'hypervisordhcp', 1763 0x26000114 => 'hypervisordhcp',
1606 0x25000115 => 'hypervisoriommupolicy', 1764 0x25000115 => 'hypervisoriommupolicy',
1607 0x26000116 => 'hypervisorusevapic', 1765 0x26000116 => 'hypervisorusevapic',
1608 0x22000117 => 'hypervisorloadoptions', 1766 0x22000117 => 'hypervisorloadoptions',
1609 0x25000118 => 'hypervisormsrfilterpolicy', 1767 0x25000118 => 'hypervisormsrfilterpolicy',
1610 0x25000119 => 'hypervisormmionxpolicy', 1768 0x25000119 => 'hypervisormmionxpolicy',
1611 0x2500011a => 'hypervisorschedulertype', 1769 0x2500011a => 'hypervisorschedulertype',
1612 0x25000120 => 'xsavepolicy', 1770 0x25000120 => 'xsavepolicy',
1613 0x25000121 => 'xsaveaddfeature0', 1771 0x25000121 => 'xsaveaddfeature0',
1614 0x25000122 => 'xsaveaddfeature1', 1772 0x25000122 => 'xsaveaddfeature1',
1615 0x25000123 => 'xsaveaddfeature2', 1773 0x25000123 => 'xsaveaddfeature2',
1616 0x25000124 => 'xsaveaddfeature3', 1774 0x25000124 => 'xsaveaddfeature3',
1617 0x25000125 => 'xsaveaddfeature4', 1775 0x25000125 => 'xsaveaddfeature4',
1618 0x25000126 => 'xsaveaddfeature5', 1776 0x25000126 => 'xsaveaddfeature5',
1619 0x25000127 => 'xsaveaddfeature6', 1777 0x25000127 => 'xsaveaddfeature6',
1620 0x25000128 => 'xsaveaddfeature7', 1778 0x25000128 => 'xsaveaddfeature7',
1621 0x25000129 => 'xsaveremovefeature', 1779 0x25000129 => 'xsaveremovefeature',
1622 0x2500012a => 'xsaveprocessorsmask', 1780 0x2500012a => 'xsaveprocessorsmask',
1623 0x2500012b => 'xsavedisable', 1781 0x2500012b => 'xsavedisable',
1624 0x2500012c => 'kerneldebugtype', 1782 0x2500012c => 'kerneldebugtype',
1625 0x2200012d => 'kernelbusparams', 1783 0x2200012d => 'kernelbusparams',
1626 0x2500012e => 'kerneldebugaddress', 1784 0x2500012e => 'kerneldebugaddress',
1627 0x2500012f => 'kerneldebugport', 1785 0x2500012f => 'kerneldebugport',
1628 0x25000130 => 'claimedtpmcounter', 1786 0x25000130 => 'claimedtpmcounter',
1629 0x25000131 => 'kernelchannel', 1787 0x25000131 => 'kernelchannel',
1630 0x22000132 => 'kerneltargetname', 1788 0x22000132 => 'kerneltargetname',
1631 0x25000133 => 'kernelhostip', 1789 0x25000133 => 'kernelhostip',
1632 0x25000134 => 'kernelport', 1790 0x25000134 => 'kernelport',
1633 0x26000135 => 'kerneldhcp', 1791 0x26000135 => 'kerneldhcp',
1634 0x22000136 => 'kernelkey', 1792 0x22000136 => 'kernelkey',
1635 0x22000137 => 'imchivename', 1793 0x22000137 => 'imchivename',
1636 0x21000138 => 'imcdevice', 1794 0x21000138 => 'imcdevice',
1637 0x25000139 => 'kernelbaudrate', 1795 0x25000139 => 'kernelbaudrate',
1638 0x22000140 => 'mfgmode', 1796 0x22000140 => 'mfgmode',
1639 0x26000141 => 'event', 1797 0x26000141 => 'event',
1640 0x25000142 => 'vsmlaunchtype', 1798 0x25000142 => 'vsmlaunchtype',
1641 0x25000144 => 'hypervisorenforcedcodeintegrity', 1799 0x25000144 => 'hypervisorenforcedcodeintegrity',
1642 0x26000145 => 'enablebootdebugpolicy',
1643 0x26000146 => 'enablebootorderclean',
1644 0x26000147 => 'enabledeviceid',
1645 0x26000148 => 'enableffuloader',
1646 0x26000149 => 'enableiuloader',
1647 0x2600014a => 'enablemassstorage',
1648 0x2600014b => 'enablerpmbprovisioning',
1649 0x2600014c => 'enablesecurebootpolicy',
1650 0x2600014d => 'enablestartcharge',
1651 0x2600014e => 'enableresettpm',
1652 0x21000150 => 'systemdatadevice', 1800 0x21000150 => 'systemdatadevice',
1653 0x21000151 => 'osarcdevice', 1801 0x21000151 => 'osarcdevice',
1654 0x21000153 => 'osdatadevice', 1802 0x21000153 => 'osdatadevice',
1655 0x21000154 => 'bspdevice', 1803 0x21000154 => 'bspdevice',
1656 0x21000155 => 'bspfilepath', 1804 0x21000155 => 'bspfilepath',
1657 0x26000202 => 'skipffumode', 1805 },
1658 0x26000203 => 'forceffumode', 1806 resume => {
1659 0x25000510 => 'chargethreshold',
1660 0x26000512 => 'offmodecharging',
1661 0x25000aaa => 'bootflow',
1662 0x35000001 => 'ramdiskimageoffset',
1663 0x35000002 => 'ramdisktftpclientport',
1664 0x31000003 => 'ramdisksdidevice',
1665 0x32000004 => 'ramdisksdipath',
1666 0x35000005 => 'ramdiskimagelength',
1667 0x36000006 => 'exportascd',
1668 0x35000007 => 'ramdisktftpblocksize',
1669 0x35000008 => 'ramdisktftpwindowsize',
1670 0x36000009 => 'ramdiskmcenabled',
1671 0x3600000a => 'ramdiskmctftpfallback',
1672 0x3600000b => 'ramdisktftpvarwindow',
1673 0x45000001 => 'devicetype', 1807 0x21000001 => 'filedevice',
1808 0x22000002 => 'filepath',
1809 0x26000003 => 'customsettings',
1810 0x26000004 => 'pae',
1811 0x21000005 => 'associatedosdevice',
1812 0x26000006 => 'debugoptionenabled',
1813 0x25000007 => 'bootux',
1814 0x25000008 => 'bootmenupolicy',
1815 0x26000024 => 'hormenabled',
1816 },
1817 startup => {
1818 0x26000001 => 'pxesoftreboot',
1674 0x42000002 => 'applicationrelativepath', 1819 0x22000002 => 'applicationname',
1675 0x42000003 => 'ramdiskdevicerelativepath', 1820 },
1676 0x46000004 => 'omitosloaderelements',
1677 0x47000006 => 'elementstomigrate',
1678 0x46000010 => 'recoveryos',
1679); 1821);
1680 1822
1681our %rbcde = reverse %bcde; 1823# mask, value => class
1824our @bcde_typeclass = (
1825 [0x00000000, 0x00000000, 'any'],
1826 [0xf00fffff, 0x1000000a, 'bootapp'],
1827 [0xf0ffffff, 0x2020000a, 'bootapp'],
1828 [0xf00fffff, 0x10000001, 'bootmgr'],
1829 [0xf00fffff, 0x10000002, 'bootmgr'],
1830 [0xf0ffffff, 0x20200001, 'bootmgr'],
1831 [0xf0ffffff, 0x20200002, 'bootmgr'],
1832 [0xf0f00000, 0x20300000, 'device'],
1833 [0xf0000000, 0x30000000, 'device'],
1834 [0xf00fffff, 0x10000005, 'memdiag'],
1835 [0xf0ffffff, 0x20200005, 'memdiag'],
1836 [0xf00fffff, 0x10000006, 'ntldr'],
1837 [0xf00fffff, 0x10000007, 'ntldr'],
1838 [0xf0ffffff, 0x20200006, 'ntldr'],
1839 [0xf0ffffff, 0x20200007, 'ntldr'],
1840 [0xf00fffff, 0x10000003, 'osloader'],
1841 [0xf0ffffff, 0x20200003, 'osloader'],
1842 [0xf00fffff, 0x10000004, 'resume'],
1843 [0xf0ffffff, 0x20200004, 'resume'],
1844 [0xf00fffff, 0x10000009, 'startup'],
1845 [0xf0ffffff, 0x20200009, 'startup'],
1846);
1682 1847
1848our %rbcde_byclass;
1849
1850while (my ($k, $v) = each %bcde_byclass) {
1851 $rbcde_byclass{$k} = { reverse %$v };
1852}
1853
1854# decodes (numerical elem, type) to name
1683sub dec_bcde_id($) { 1855sub dec_bcde_id($$) {
1856 for my $class (@bcde_typeclass) {
1857 if (($_[1] & $class->[0]) == $class->[1]) {
1858 if (my $id = $bcde_byclass{$class->[2]}{$_[0]}) {
1859 return $id;
1860 }
1861 }
1862 }
1863
1684 $bcde{$_[0]} // sprintf "custom:%08x", $_[0] 1864 sprintf "custom:%08x", $_[0]
1685} 1865}
1686 1866
1867# encodes (elem as name, type)
1687sub enc_bcde_id($) { 1868sub enc_bcde_id($$) {
1688 $_[0] =~ /^custom:([0-9a-fA-F]{8}$)/ 1869 $_[0] =~ /^custom:(?:0x)?([0-9a-fA-F]{8}$)/
1689 ? hex $1 1870 and return hex $1;
1690 : $rbcde{$_[0]} 1871
1872 for my $class (@bcde_typeclass) {
1873 if (($_[1] & $class->[0]) == $class->[1]) {
1874 if (my $value = $rbcde_byclass{$class->[2]}{$_[0]}) {
1875 return $value;
1876 }
1877 }
1878 }
1879
1880 undef
1691} 1881}
1692 1882
1693# decode/encode bcd device element - the horror, no documentaion 1883# decode/encode bcd device element - the horror, no documentaion
1694# whatsoever, supercomplex, superinconsistent. 1884# whatsoever, supercomplex, superinconsistent.
1695 1885
1698our @part_type = qw(gpt mbr raw); 1888our @part_type = qw(gpt mbr raw);
1699 1889
1700our $NULL_DEVICE = "\x00" x 16; 1890our $NULL_DEVICE = "\x00" x 16;
1701 1891
1702# biggest bitch to decode, ever 1892# biggest bitch to decode, ever
1703# this decoded a device portion after the GUID 1893# this decodes a device portion after the GUID
1704sub dec_device_($); 1894sub dec_device_($$);
1705sub dec_device_($) { 1895sub dec_device_($$) {
1706 my ($device) = @_; 1896 my ($device, $type) = @_;
1707 1897
1708 my $res; 1898 my $res;
1709 1899
1710 my ($type, $flags, $length, $pad) = unpack "VVVV", substr $device, 0, 4 * 4, ""; 1900 my ($type, $flags, $length, $pad) = unpack "VVVV", substr $device, 0, 4 * 4, "";
1711 1901
1756 1946
1757 my $partid = $parttype eq "gpt" ? dec_guid $partdata 1947 my $partid = $parttype eq "gpt" ? dec_guid $partdata
1758 : $type eq "partition" ? unpack "Q<", $partdata # byte offset to partition start 1948 : $type eq "partition" ? unpack "Q<", $partdata # byte offset to partition start
1759 : unpack "L<", $partdata; # partition number, one-based 1949 : unpack "L<", $partdata; # partition number, one-based
1760 1950
1761 (my $parent, $device) = dec_device_ $device; 1951 (my $parent, $device) = dec_device_ $device, $type;
1762 1952
1763 $res .= "="; 1953 $res .= "=";
1764 $res .= "<$parent>"; 1954 $res .= "<$parent>";
1765 $res .= ",$blocktype,$parttype,$diskid,$partid"; 1955 $res .= ",$blocktype,$parttype,$diskid,$partid";
1766 1956
1786 or die "unsupported file descriptor version '$fver'\n"; 1976 or die "unsupported file descriptor version '$fver'\n";
1787 1977
1788 $ftype == 5 1978 $ftype == 5
1789 or die "unsupported file descriptor path type '$type'\n"; 1979 or die "unsupported file descriptor path type '$type'\n";
1790 1980
1791 (my $parent, $path) = dec_device_ $path; 1981 (my $parent, $path) = dec_device_ $path, $type;
1792 1982
1793 $path = $dec_path->($path, "file device without path"); 1983 $path = $dec_path->($path, "file device without path");
1794 1984
1795 ($parent, $path) 1985 ($parent, $path)
1796 }; 1986 };
1802 1992
1803 } elsif ($blocktype eq "vhd") { 1993 } elsif ($blocktype eq "vhd") {
1804 $device =~ s/^\x00{20}//s 1994 $device =~ s/^\x00{20}//s
1805 or die "virtualdisk has non-zero fields I don't understand\n"; 1995 or die "virtualdisk has non-zero fields I don't understand\n";
1806 1996
1807 (my $parent, $device) = dec_device_ $device; 1997 (my $parent, $device) = dec_device_ $device, $type;
1808 1998
1809 $res .= "=vhd,<$parent>"; 1999 $res .= "=vhd,<$parent>";
1810 2000
1811 } elsif ($blocktype eq "ramdisk") { 2001 } elsif ($blocktype eq "ramdisk") {
1812 my ($base, $size, $offset) = unpack "Q< Q< L<", substr $device, 0, 8 + 8 + 4, ""; 2002 my ($base, $size, $offset) = unpack "Q< Q< L<", substr $device, 0, 8 + 8 + 4, "";
1825 my ($mode, $elem, $parent) = unpack "VVV", substr $device, 0, 4 * 3, ""; 2015 my ($mode, $elem, $parent) = unpack "VVV", substr $device, 0, 4 * 3, "";
1826 2016
1827 if ($parent) { 2017 if ($parent) {
1828 # not sure why this is an offset - it must come after the path 2018 # not sure why this is an offset - it must come after the path
1829 $parent = substr $device, $parent - 4 * 3 - 4 * 4, 1e9, ""; 2019 $parent = substr $device, $parent - 4 * 3 - 4 * 4, 1e9, "";
1830 ($parent, my $tail) = dec_device_ $parent; 2020 ($parent, my $tail) = dec_device_ $parent, $type;
1831 0 == length $tail 2021 0 == length $tail
1832 or die "trailing data after locate device parent\n"; 2022 or die "trailing data after locate device parent\n";
1833 } else { 2023 } else {
1834 $parent = "null"; 2024 $parent = "null";
1835 } 2025 }
1841 2031
1842 if ($mode == 0) { # "Element" 2032 if ($mode == 0) { # "Element"
1843 !length $path 2033 !length $path
1844 or die "device locate mode 0 having non-empty path ($mode, $elem, $path)\n"; 2034 or die "device locate mode 0 having non-empty path ($mode, $elem, $path)\n";
1845 2035
1846 $elem = dec_bcde_id $elem; 2036 $elem = dec_bcde_id $elem, $type;
1847 $res .= "element,$elem"; 2037 $res .= "element,$elem";
1848 2038
1849 } elsif ($mode == 1) { # "String" 2039 } elsif ($mode == 1) { # "String"
1850 !$elem 2040 !$elem
1851 or die "device locate mode 1 having non-zero element\n"; 2041 or die "device locate mode 1 having non-zero element\n";
1876 2066
1877 ($res, $tail) 2067 ($res, $tail)
1878} 2068}
1879 2069
1880# decode a full binary BCD device descriptor 2070# decode a full binary BCD device descriptor
1881sub dec_device($) { 2071sub dec_device($$) {
1882 my ($device) = @_; 2072 my ($device, $type) = @_;
1883 2073
1884 $device = pack "H*", $device; 2074 $device = pack "H*", $device;
1885 2075
1886 my $guid = dec_guid substr $device, 0, 16, ""; 2076 my $guid = dec_guid substr $device, 0, 16, "";
1887 $guid = $guid eq "00000000-0000-0000-0000-000000000000" 2077 $guid = $guid eq "00000000-0000-0000-0000-000000000000"
1888 ? "" : "{$guid}"; 2078 ? "" : "{$guid}";
1889 2079
1890 eval { 2080 eval {
1891 my ($dev, $tail) = dec_device_ $device; 2081 my ($dev, $tail) = dec_device_ $device, $type;
1892 2082
1893 $tail eq "" 2083 $tail eq ""
1894 or die "unsupported trailing data after device descriptor\n"; 2084 or die "unsupported trailing data after device descriptor\n";
1895 2085
1896 "$guid$dev" 2086 "$guid$dev"
1908 2098
1909 undef 2099 undef
1910} 2100}
1911 2101
1912# encode the device portion after the GUID 2102# encode the device portion after the GUID
1913sub enc_device_; 2103sub enc_device_($$);
1914sub enc_device_ { 2104sub enc_device_($$) {
1915 my ($device) = @_; 2105 my ($device, $type) = @_;
1916 2106
1917 my $enc_path = sub { 2107 my $enc_path = sub {
1918 my $path = shift; 2108 my $path = shift;
1919 $path =~ s/\//\\/g; 2109 $path =~ s/\//\\/g;
1920 (Encode::encode "UTF-16LE", $path) . "\x00\x00" 2110 (Encode::encode "UTF-16LE", $path) . "\x00\x00"
1938 2128
1939 my $parse_parent = sub { 2129 my $parse_parent = sub {
1940 my $parent; 2130 my $parent;
1941 2131
1942 if (s/^<//) { 2132 if (s/^<//) {
1943 ($parent, $_) = enc_device_ $_; 2133 ($parent, $_) = enc_device_ $_, $type;
1944 s/^>// 2134 s/^>//
1945 or die "$device: syntax error: parent device not followed by '>'\n"; 2135 or die "$device: syntax error: parent device not followed by '>'\n";
1946 } else { 2136 } else {
1947 $parent = $NULL_DEVICE; 2137 $parent = $NULL_DEVICE;
1948 } 2138 }
2036 2226
2037 s/^,// 2227 s/^,//
2038 or die "$_: missing comma after locate parent device\n"; 2228 or die "$_: missing comma after locate parent device\n";
2039 2229
2040 if (s/^element,//) { 2230 if (s/^element,//) {
2041 s/^([0-9a-z]+)//i 2231 s/^([0-9a-z:]+)//i
2042 or die "$_ locate element must be either name or 8-digit hex id\n"; 2232 or die "$_ locate element must be either name or 8-digit hex id\n";
2043 $elem = enc_bcde_id $1; 2233 $elem = enc_bcde_id $1, $type;
2044 $mode = 0; 2234 $mode = 0;
2045 $path = $enc_path->(""); 2235 $path = $enc_path->("");
2046 2236
2047 } elsif (s/^path,//) { 2237 } elsif (s/^path,//) {
2048 $mode = 1; 2238 $mode = 1;
2115 or die "$_: malformed or missing vmbus interface instance guid\n"; 2305 or die "$_: malformed or missing vmbus interface instance guid\n";
2116 my $instance = enc_guid $1; 2306 my $instance = enc_guid $1;
2117 2307
2118 $payload = pack "a16a16x24", $type, $instance; 2308 $payload = pack "a16a16x24", $type, $instance;
2119 2309
2310# } elsif ($type eq "udp") {
2311# $payload = pack "Va16", 1, "12345678";
2312
2120 } else { 2313 } else {
2121 die "$type: not a supported device type (binary, null, boot, legacypartition, partition, block, locate)\n"; 2314 die "$type: not a supported device type (binary, null, boot, legacypartition, partition, block, locate)\n";
2122 } 2315 }
2123 2316
2124 return ( 2317 return (
2127 ); 2320 );
2128 } 2321 }
2129} 2322}
2130 2323
2131# encode a full binary BCD device descriptor 2324# encode a full binary BCD device descriptor
2132sub enc_device { 2325sub enc_device($$) {
2133 my ($device) = @_; 2326 my ($device, $type) = @_;
2134 2327
2135 my $guid = "\x00" x 16; 2328 my $guid = "\x00" x 16;
2136 2329
2137 if ($device =~ s/^\{([A-Za-z0-9\-]+)\}//) { 2330 if ($device =~ s/^\{([A-Za-z0-9\-]+)\}//) {
2138 $guid = enc_guid $1 2331 $guid = enc_guid $1
2139 or die "$device: does not start with valid guid\n"; 2332 or die "$device: does not start with valid guid\n";
2140 } 2333 }
2141 2334
2142 my ($descriptor, $tail) = enc_device_ $device; 2335 my ($descriptor, $tail) = enc_device_ $device, $type;
2143 2336
2144 length $tail 2337 length $tail
2145 and die "$device: garbage after device descriptor\n"; 2338 and die "$device: garbage after device descriptor\n";
2146 2339
2147 unpack "H*", $guid . $descriptor 2340 unpack "H*", $guid . $descriptor
2162 $k = $bcd_objects{$k} // $k; 2355 $k = $bcd_objects{$k} // $k;
2163 2356
2164 my $type = $v->{Description}[0]{Type}[1]; 2357 my $type = $v->{Description}[0]{Type}[1];
2165 2358
2166 if ($type != $bcd_object_types{$k}) { 2359 if ($type != $bcd_object_types{$k}) {
2167 $type = $bcd_types{$type} // sprintf "0x%08x", $type; 2360 $kv{type} = $bcd_types{$type} // sprintf "0x%08x", $type;
2168 $kv{type} = $type;
2169 } 2361 }
2170 2362
2171 my $elems = $v->{Elements}[1]; 2363 my $elems = $v->{Elements}[1];
2172 2364
2173 while (my ($k, $v) = each %$elems) { 2365 while (my ($k, $v) = each %$elems) {
2174 my $k = hex $k; 2366 my $k = hex $k;
2175 2367
2176 my $v = $bcde_dec{$k & BCDE_FORMAT}->($v->[0]{Element}[1]); 2368 my $v = $bcde_dec{$k & BCDE_FORMAT}->($v->[0]{Element}[1], $type);
2177 my $k = dec_bcde_id $k; 2369 my $k = dec_bcde_id $k, $type;
2178 2370
2179 $kv{$k} = $v; 2371 $kv{$k} = $v;
2180 } 2372 }
2181 2373
2182 $bcd{$k} = \%kv; 2374 $bcd{$k} = \%kv;
2223 my %elem; 2415 my %elem;
2224 2416
2225 while (my ($k, $v) = each %$v) { 2417 while (my ($k, $v) = each %$v) {
2226 next if $k eq "type"; 2418 next if $k eq "type";
2227 2419
2228 $k = (enc_bcde_id $k) // die "$k: invalid bcde element name or id\n"; 2420 $k = (enc_bcde_id $k, $type) // die "$k: invalid bcde element name or id\n";
2229 $elem{sprintf "%08x", $k} = [{ 2421 $elem{sprintf "%08x", $k} = [{
2230 Element => [ ($bcde_enc{$k & BCDE_FORMAT} // die "$k: unable to encode unknown bcd element type}")->($v)] 2422 Element => [ ($bcde_enc{$k & BCDE_FORMAT} // die "$k: unable to encode unknown bcd element type}")->($v)]
2231 }]; 2423 }];
2232 } 2424 }
2233 2425
2263} 2455}
2264 2456
2265sub bcd_edit { 2457sub bcd_edit {
2266 my ($path, $bcd, @insns) = @_; 2458 my ($path, $bcd, @insns) = @_;
2267 2459
2268 my $default = $bcd->{"{bootmgr}"}{resumeobject}; 2460 my $default = $bcd->{"{bootmgr}"}{default};
2269 2461
2270 # prepare "officially visible" variables 2462 # prepare "officially visible" variables
2271 local $pbcdedit::PATH = $path; 2463 local $pbcdedit::PATH = $path;
2272 local $pbcdedit::BCD = $bcd; 2464 local $pbcdedit::BCD = $bcd;
2273 local $pbcdedit::DEFAULT = $default; 2465 local $pbcdedit::DEFAULT = $default;
2290 2482
2291 $object = $object eq "{default}" ? $default : dec_wguid enc_wguid $object; 2483 $object = $object eq "{default}" ? $default : dec_wguid enc_wguid $object;
2292 2484
2293 $bcd->{$object}{$elem} = $value; 2485 $bcd->{$object}{$elem} = $value;
2294 2486
2487 } elsif ($insn eq "del") {
2488 my $object = shift @insns;
2489 my $elem = shift @insns;
2490
2491 $object = $object eq "{default}" ? $default : dec_wguid enc_wguid $object;
2492
2493 delete $bcd->{$object}{$elem};
2494
2295 } elsif ($insn eq "eval") { 2495 } elsif ($insn eq "eval") {
2296 bcd_edit_eval shift @insns; 2496 my $perl = shift @insns;
2497 bcd_edit_eval "#line 1 'eval'\n$perl";
2297 2498
2298 } elsif ($insn eq "do") { 2499 } elsif ($insn eq "do") {
2299 my $path = shift @insns; 2500 my $path = shift @insns;
2300 my $file = file_load $path; 2501 my $file = file_load $path;
2301 bcd_edit_eval "#line 1 '$path'\n$file"; 2502 bcd_edit_eval "#line 1 '$path'\n$file";
2302 2503
2303 } else { 2504 } else {
2304 die "$insn: not a recognized instruction for edit/parse\n"; 2505 die "$insn: not a recognized instruction for create/edit/parse\n";
2305 } 2506 }
2306 } 2507 }
2307 2508
2308} 2509}
2309 2510
2310############################################################################# 2511#############################################################################
2311# command line parser 2512# other utilities
2312 2513
2313# json to stdout 2514# json to stdout
2314sub prjson($) { 2515sub prjson($) {
2315 print $json_coder->encode ($_[0]); 2516 print $json_coder->encode ($_[0]);
2316} 2517}
2320 my $json; 2521 my $json;
2321 1 while read STDIN, $json, 65536, length $json; 2522 1 while read STDIN, $json, 65536, length $json;
2322 $json_coder->decode ($json) 2523 $json_coder->decode ($json)
2323} 2524}
2324 2525
2325# all subcommands 2526sub lsblk() {
2527 my $lsblk = $json_coder->decode (scalar qx<lsblk --json -o PATH,KNAME,MAJ:MIN,TYPE,PTTYPE,PTUUID,PARTUUID,LABEL,FSTYPE>);
2528
2529 for my $dev (@{ $lsblk->{blockdevices} }) {
2530 if ($dev->{type} eq "part") {
2531
2532 # lsblk sometimes gives a bogus pttype, so we recreate it here
2533 $dev->{pttype} = $dev->{ptuuid} =~ /^$RE_GUID\z/
2534 ? "gpt" : "dos";
2535
2536 if ($dev->{pttype} eq "gpt") {
2537 $dev->{bcd_device} = "partition=<null>,harddisk,gpt,$dev->{ptuuid},$dev->{partuuid}";
2538 } elsif ($dev->{pttype} eq "dos") { # why not "mbr" :(
2539 if ($dev->{partuuid} =~ /^([0-9a-f]{8})-([0-9a-f]{2})\z/i) {
2540 my ($diskid, $partno) = ($1, hex $2);
2541 $dev->{bcd_legacy_device} = "legacypartition=<null>,harddisk,mbr,$diskid,$partno";
2542 if (open my $fh, "/sys/class/block/$dev->{kname}/start") {
2543 my $start = 512 * readline $fh;
2544 $dev->{bcd_device} = "partition=<null>,harddisk,mbr,$diskid,$start";
2545 }
2546 }
2547 }
2548 }
2549 }
2550
2551 $lsblk->{blockdevices}
2552}
2553
2554sub prdev($$) {
2555 my ($path, $attribute) = @_;
2556
2557 # rather than stat'ing and guessing how devices are encoded, we use lsblk for this
2558 my $mm = $json_coder->decode (scalar qx<lsblk -d -o MAJ:MIN -J \Q$path\E>)->{blockdevices}[0]{"maj:min"};
2559
2560 my $lsblk = lsblk;
2561
2562 for my $dev (@$lsblk) {
2563 if ($dev->{"maj:min"} eq $mm && $dev->{$attribute}) {
2564 say $dev->{$attribute};
2565 exit 0;
2566 }
2567 }
2568
2569 exit 1;
2570}
2571
2572#############################################################################
2573# command line parser
2574
2326our %CMD = ( 2575our %CMD = (
2327 help => sub { 2576 help => sub {
2328 require Pod::Usage; 2577 require Pod::Usage;
2329 Pod::Usage::pod2usage (-verbose => 2); 2578 Pod::Usage::pod2usage (-verbose => 2, -quotes => "none", -noperldoc => 1);
2330 }, 2579 },
2331 2580
2332 objects => sub { 2581 objects => sub {
2333 my %rbcd_types = reverse %bcd_types; 2582 my %rbcd_types = reverse %bcd_types;
2334 $_ = sprintf "%08x", $_ for values %rbcd_types; 2583 $_ = sprintf "%08x", $_ for values %rbcd_types;
2355 2604
2356 print "\n"; 2605 print "\n";
2357 2606
2358 printf "%-39s %-23s %s\n", "Object GUID", "Alias", "(Hex) Default Type"; 2607 printf "%-39s %-23s %s\n", "Object GUID", "Alias", "(Hex) Default Type";
2359 for my $name (sort keys %rbcd_objects) { 2608 for my $name (sort keys %rbcd_objects) {
2360 my $guid = $rbcd_objects{$name}; 2609 my $guid = $rbcd_objects{$name};
2361 my $type = $bcd_object_types{$name}; 2610 my $type = $bcd_object_types{$name};
2362 my $tname = $bcd_types{$type}; 2611 my $tname = $bcd_types{$type};
2363 2612
2364 $type = $type ? sprintf "(%08x) %s", $type, $tname : "-"; 2613 $type = $type ? sprintf "(%08x) %s", $type, $tname : "-";
2365 2614
2366 printf "%-39s %-23s %s\n", $guid, $name, $type; 2615 printf "%-39s %-23s %s\n", $guid, $name, $type;
2380 BCDE_FORMAT_GUID_LIST , "guid list", 2629 BCDE_FORMAT_GUID_LIST , "guid list",
2381 BCDE_FORMAT_INTEGER , "integer", 2630 BCDE_FORMAT_INTEGER , "integer",
2382 BCDE_FORMAT_BOOLEAN , "boolean", 2631 BCDE_FORMAT_BOOLEAN , "boolean",
2383 BCDE_FORMAT_INTEGER_LIST, "integer list", 2632 BCDE_FORMAT_INTEGER_LIST, "integer list",
2384 ); 2633 );
2385 my %rbcde = reverse %bcde;
2386 $_ = sprintf "%08x", $_ for values %rbcde;
2387 2634
2388 my %element; 2635 my @element;
2389 2636
2637 for my $class (sort keys %rbcde_byclass) {
2638 my $rbcde = $rbcde_byclass{$class};
2639
2390 unless ($json) { 2640 unless ($json) {
2391 print "\n"; 2641 print "\n";
2642 printf "Elements applicable to class(es): $class\n";
2392 printf "%-9s %-12s %s\n", "Element", "Format", "Name Alias"; 2643 printf "%-9s %-12s %s\n", "Element", "Format", "Name Alias";
2393 } 2644 }
2394 for my $name (sort keys %rbcde) { 2645 for my $name (sort keys %$rbcde) {
2395 my $id = $rbcde{$name}; 2646 my $id = $rbcde->{$name};
2396 my $format = $format_name{(hex $id) & BCDE_FORMAT}; 2647 my $format = $format_name{$id & BCDE_FORMAT};
2397 2648
2398 if ($json) { 2649 if ($json) {
2399 $element{$id} = [$format, $name]; 2650 push @element, [$class, $id * 1, $format, $name];
2400 } else { 2651 } else {
2652 $id = sprintf "%08x", $id;
2401 printf "%-9s %-12s %s\n", $id, $format, $name; 2653 printf "%-9s %-12s %s\n", $id, $format, $name;
2654 }
2402 } 2655 }
2403 } 2656 }
2404 print "\n" unless $json; 2657 print "\n" unless $json;
2405 2658
2406 prjson { 2659 prjson {
2407 version => $JSON_VERSION, 2660 version => $JSON_VERSION,
2408 element => \%element, 2661 element => \@element,
2662 class => \@bcde_typeclass,
2409 } if $json; 2663 } if $json;
2410 2664
2411 }, 2665 },
2412 2666
2413 export => sub { 2667 export => sub {
2416 2670
2417 import => sub { 2671 import => sub {
2418 regf_save shift, bcd_encode rdjson; 2672 regf_save shift, bcd_encode rdjson;
2419 }, 2673 },
2420 2674
2675 create => sub {
2676 my $path = shift;
2677 my $stat = stat_get $path; # should actually be done at file load time
2678 my $bcd = { };
2679 bcd_edit $path, $bcd, @_;
2680 regf_save $path, bcd_encode $bcd;
2681 stat_set $path, $stat;
2682 },
2683
2421 edit => sub { 2684 edit => sub {
2422 my $path = shift; 2685 my $path = shift;
2686 my $stat = stat_get $path; # should actually be done at file load time
2423 my $bcd = bcd_decode regf_load $path; 2687 my $bcd = bcd_decode regf_load $path;
2424 bcd_edit $path, $bcd, @_; 2688 bcd_edit $path, $bcd, @_;
2425 regf_save $path, bcd_encode $bcd; 2689 regf_save $path, bcd_encode $bcd;
2690 stat_set $path, $stat;
2426 }, 2691 },
2427 2692
2428 parse => sub { 2693 parse => sub {
2429 my $path = shift; 2694 my $path = shift;
2430 my $bcd = bcd_decode regf_load $path; 2695 my $bcd = bcd_decode regf_load $path;
2439 "import-regf" => sub { 2704 "import-regf" => sub {
2440 regf_save shift, rdjson; 2705 regf_save shift, rdjson;
2441 }, 2706 },
2442 2707
2443 lsblk => sub { 2708 lsblk => sub {
2709 my $json = $_[0] eq "--json";
2710
2711 my $lsblk = lsblk;
2712
2713 if ($json) {
2714 prjson $lsblk;
2715 } else {
2444 printf "%-10s %-8.8s %-6.6s %-3s %s\n", "DEVICE", "LABEL", "FSTYPE", "PT", "DEVICE DESCRIPTOR"; 2716 printf "%-10s %-8.8s %-6.6s %-3s %s\n", "DEVICE", "LABEL", "FSTYPE", "PT", "DEVICE DESCRIPTOR";
2445 2717 for my $dev (@$lsblk) {
2446 my $lsblk = $json_coder->decode (scalar qx<lsblk --json -o PATH,KNAME,TYPE,PTTYPE,PTUUID,PARTUUID,LABEL,FSTYPE>); 2718 for my $bcd ($dev->{bcd_device}, $dev->{bcd_legacy_device}) {
2447
2448 for my $dev (@{ $lsblk->{blockdevices} }) {
2449 my $pr = sub {
2450 printf "%-10s %-8.8s %-6.6s %-3s %s\n", 2719 printf "%-10s %-8.8s %-6.6s %-3s %s\n",
2451 $dev->{path}, $dev->{label}, $dev->{fstype}, $dev->{pttype}, $_[0]; 2720 $dev->{path}, $dev->{label}, $dev->{fstype}, $dev->{pttype}, $bcd
2452 };
2453
2454 if ($dev->{type} eq "part") {
2455 if ($dev->{pttype} eq "gpt") {
2456 $pr->("partition=<null>,harddisk,gpt,$dev->{ptuuid},$dev->{partuuid}");
2457 } elsif ($dev->{pttype} eq "dos") { # why not "mbr" :(
2458 if ($dev->{partuuid} =~ /^([0-9a-f]{8})-([0-9a-f]{2})\z/i) {
2459 my ($diskid, $partno) = ($1, hex $2);
2460 $pr->("legacypartition=<null>,harddisk,mbr,$diskid,$partno");
2461 if (open my $fh, "/sys/class/block/$dev->{kname}/start") {
2462 my $start = 512 * readline $fh;
2463 $pr->("partition=<null>,harddisk,mbr,$diskid,$start");
2464 } 2721 if $bcd;
2465 }
2466 } 2722 }
2467 } 2723 }
2468 } 2724 }
2469 }, 2725 },
2726
2727 "bcd-device" => sub {
2728 prdev shift, "bcd_device";
2729 },
2730
2731 "bcd-legacy-device" => sub {
2732 prdev shift, "bcd_legacy_device";
2733 },
2734
2735 version => sub {
2736 print "\n",
2737 "PBCDEDIT version $VERSION, copyright 2019 Marc A. Lehmann <pbcdedit\@schmorp.de>.\n",
2738 "JSON schema version: $JSON_VERSION\n",
2739 "Licensed under the GNU General Public License Version 3.0, or any later version.\n",
2740 "\n",
2741 $CHANGELOG,
2742 "\n";
2743 },
2470); 2744);
2471 2745
2472my $cmd = shift; 2746my $cmd = shift;
2473 2747
2474unless (exists $CMD{$cmd}) { 2748unless (exists $CMD{$cmd}) {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines