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

Comparing pbcdedit/pbcdedit (file contents):
Revision 1.6 by root, Wed Aug 14 22:44:57 2019 UTC vs.
Revision 1.76 by root, Tue Aug 9 11:44:54 2022 UTC

1#!/opt/bin/perl 1#!/usr/bin/perl
2 2
3# 3#
4# PBCDEDIT - Copyright 2019 Marc A. Lehmann <pbcbedit@schmorp.de> 4# PBCDEDIT - Copyright 2019 Marc A. Lehmann <pbcbedit@schmorp.de>
5# 5#
6# SPDX-License-Identifier: GPL-3.0-or-later 6# SPDX-License-Identifier: GPL-3.0-or-later
17# 17#
18# You should have received a copy of the GNU General Public License 18# You should have received a copy of the GNU General Public License
19# along with this program. If not, see <https://www.gnu.org/licenses/>. 19# along with this program. If not, see <https://www.gnu.org/licenses/>.
20# 20#
21 21
22use 5.014; # numerous features 22use 5.016; # numerous features need 5.14, __SUB__ needs 5.16
23 23
24our $VERSION = '1.0'; 24our $VERSION = '1.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
67
34 pbcdedit export path/to/BCD # output BCD hive as JSON 68 pbcdedit export path/to/BCD # output BCD hive as JSON
35 pbcdedit import path/to/bcd # convert standard input to BCD hive 69 pbcdedit import path/to/BCD # convert standard input to BCD hive
36 pbcdedit edit path/to/BCD edit-instructions... 70 pbcdedit edit path/to/BCD edit-instructions...
37 71
38 pbcdedit objects # list all supported object aliases and types 72 pbcdedit objects # list all supported object aliases and types
39 pbcdedit elements # list all supported bcd element aliases 73 pbcdedit elements # list all supported bcd element aliases
40 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
83
41=head1 DESCRIPTION 84=head1 DESCRIPTION
42 85
43This program allows you to create, read and modify Boot Configuration Data 86This program allows you to create, read and modify Boot Configuration Data
44(BCD) stores used by Windows Vista and newer versions of Windows. 87(BCD) stores used by Windows Vista and newer versions of Windows.
45 88
89At this point, it is in relatively early stages of development and has
90received little to no real-world testing.
91
46Compared to other BCD editing programs it offers the following unique 92Compared to other BCD editing programs it offers the following unique
47features: 93features:
48 94
49=over 95=over
50 96
55 101
56=item Does not rely on Windows 102=item Does not rely on Windows
57 103
58As the "portable" in the name implies, this program does not rely on 104As the "portable" in the name implies, this program does not rely on
59C<bcdedit> or other windows programs or libraries, it works on any system 105C<bcdedit> or other windows programs or libraries, it works on any system
60that supports at least perl version 5.14. 106that supports at least perl version 5.16.
61 107
62=item Decodes and encodes BCD device elements 108=item Decodes and encodes BCD device elements
63 109
64PBCDEDIT can concisely decode and encode BCD device element contents. This 110PBCDEDIT can concisely decode and encode BCD device element contents. This
65is pretty unique, and offers a lot of potential that can't be realised 111is pretty unique, and offers a lot of potential that can't be realised
72sensitive data. 118sensitive data.
73 119
74=back 120=back
75 121
76The target audience for this program is professionals and tinkerers who 122The target audience for this program is professionals and tinkerers who
77are rewady to invest time into learning how it works. It is not an easy 123are ready to invest time into learning how it works. It is not an easy
78program to use and requires patience and a good understanding of BCD data 124program to use and requires patience and a good understanding of BCD
79stores. 125stores.
80 126
81 127
82=head1 SUBCOMMANDS 128=head1 SUBCOMMANDS
83 129
84PCBEDIT expects a subcommand as first argument that tells it what to 130PBCDEDIT expects a subcommand as first argument that tells it what to
85do. The following subcommands exist: 131do. The following subcommands exist:
86 132
87=over 133=over
88 134
89=item help 135=item C<help>
90 136
91Displays the whole manuale page (this document). 137Displays the whole manual page (this document).
92 138
139=item C<version>
140
141This outputs the PBCDEDIT version, the JSON schema version it uses and the
142full log of changes.
143
93=item export F<path> 144=item C<export> F<path>
94 145
95Reads 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
96output. 147output.
97 148
98The format of the data is explained later in this document. 149The format of the data is explained later in this document.
99 150
100Example: read a BCD store, modify it wiht an extenral program, write it again. 151Example: read a BCD store, modify it with an external program, write it
152again.
101 153
102 pbcdedit export BCD | modify-json-somehow | pbcdedit import BCD 154 pbcdedit export BCD | modify-json-somehow | pbcdedit import BCD
103 155
104=item import F<path> 156=item C<import> F<path>
105 157
106The reverse of C<export>: Reads a JSON representation of a BCD data store 158The reverse of C<export>: Reads a JSON representation of a BCD data store
107from standard input, and creates or replaces the given BCD data store. 159from standard input, and creates or replaces the given BCD data store.
108 160
109=item edit F<path> instructions... 161=item C<edit> F<path> I<instructions...>
110 162
111Load a BCD data store, apply some instructions to it, and save it again. 163Load a BCD data store, apply some instructions to it, and save it again.
112 164
113See the section L<EDITING BCD DATA STORES>, below, for more info. 165See the section L<EDITING BCD STORES>, below, for more info.
114 166
115=item parse F<path> instructions... 167=item C<parse> F<path> I<instructions...>
116 168
117Same 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
118be useful to extract some data from it. 170be useful to extract some data from it.
119 171
120=item 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>]
121 178
122On 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
123using 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
124a mounted C</sys> file system. 181a mounted C</sys> file system.
125 182
126The 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>
127descriptors for GPT and both C<legacypartition> and C<partition> 184descriptors for GPT and both C<legacypartition> and C<partition>
128descritpors for MBR partitions. 185descriptors for MBR partitions.
129 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.
207
130=item objects [--json] 208=item C<objects> [C<--json>]
131 209
132Outputs 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
133element 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
134(if any). 212(if any).
135 213
136With C<--json> it prints similar information as a JSON object, for easier parsing. 214With C<--json> it prints similar information as a JSON object, for easier parsing.
137 215
138=item elements [--json] 216=item C<elements> [C<--json>]
139 217
140Outputs a table of known element aliases with their hex ID and the format 218Outputs a table of known element aliases with their hex ID and the format
141type. 219type.
142 220
143With C<--json> it prints similar information as a JSON object, for easier parsing. 221With C<--json> it prints similar information as a JSON object, for easier parsing.
144 222
145=item export-regf F<path> 223=item C<export-regf> F<path>
146 224
147This has nothing to do with BCD data stores - it takes a registry hive 225This has nothing to do with BCD stores, but simply exposes PCBEDIT's
226internal registry hive reader - it takes a registry hive file as argument
148file as argument and outputs a JSON representation of it to standard 227and outputs a JSON representation of it to standard output.
149output.
150 228
151Hive versions 1.2 till 1.6 are supported. 229Hive versions 1.2 till 1.6 are supported.
152 230
153=item import-regf F<path> 231=item C<import-regf> F<path>
154 232
155The reverse of C<export-regf>: reads a JSON representation of a registry 233The reverse of C<export-regf>: reads a JSON representation of a registry
156hive from standard input and creates or replaces the registry hive file given as 234hive from standard input and creates or replaces the registry hive file
157argument. 235given as argument.
158 236
159The written hive will always be in a slightly modified version 1.3 237The written hive will always be in a slightly modified version 1.3
160format. It's not the format windows would generate, but it should be 238format. It's not the format windows would generate, but it should be
161understood by any conformant hive reader. 239understood by any conformant hive reader.
162 240
163Note that the representation chosen by PBCDEDIT currently throws away 241Note that the representation chosen by PBCDEDIT currently throws away
164clasname data (often used for feeble attemtps at hiding stuff by 242classname data (often used for feeble attempts at hiding stuff by
165Microsoft) and security descriptors, so if you write anything other than 243Microsoft) and security descriptors, so if you write anything other than
166a BCD hive you will most likely destroy it. 244a BCD hive you will most likely destroy it.
167 245
168=back 246=back
169 247
170 248
171=head1 BCD DATA STORE REPRESENTATION FORMAT 249=head1 BCD STORE REPRESENTATION FORMAT
172 250
173A BCD data store is represented as a JSON object with one special key, 251A BCD data store is represented as a JSON object with one special key,
174C<meta>, and one key per BCD object. That is, each BCD object becomes 252C<meta>, and one key per BCD object. That is, each BCD object becomes
175one key-value pair in the object, and an additional key called C<meta> 253one key-value pair in the object, and an additional key called C<meta>
176contains meta information. 254contains meta information.
212 } 290 }
213 291
214=head2 Minimal BCD to boot windows 292=head2 Minimal BCD to boot windows
215 293
216Experimentally I found the following BCD is the minimum required to 294Experimentally I found the following BCD is the minimum required to
217successfully boot any post-XP version of Windows (suitable C<device> and 295successfully boot any post-XP version of Windows (assuming suitable
218C<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>):
219 298
220 { 299 {
221 "{bootmgr}" : { 300 "{bootmgr}" : {
222 "resumeobject" : "{45b547a7-8ca6-4417-9eb0-a257b61f35b4}" 301 "default" : "{45b547a7-8ca6-4417-9eb0-a257b61f35b4}"
223 }, 302 },
224 303
225 "{45b547a7-8ca6-4417-9eb0-a257b61f35b1}" : { 304 "{45b547a7-8ca6-4417-9eb0-a257b61f35b1}" : {
226 "type" : "application::osloader", 305 "type" : "application::osloader",
227 "description" : "Windows Boot", 306 "description" : "Windows Boot",
234 313
235Note that minimal doesn't mean recommended - Windows itself will add stuff 314Note that minimal doesn't mean recommended - Windows itself will add stuff
236to 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
237when 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>.
238 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
239=head2 The C<meta> key 334=head2 The C<meta> key
240 335
241The 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
242by PBCDEDIT. It is always generated when exporting, and importing will 337by PBCDEDIT. It is always generated when exporting, and importing will
243be 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
244the JSON schema version of PBCDEDIT. This ensures that differemt and 339the JSON schema version of PBCDEDIT. This ensures that different and
245incompatible versions of PBCDEDIT will not read and misinterΓΌret each 340incompatible versions of PBCDEDIT will not read and misinterpret each
246others data. 341others data.
247 342
248=head2 The object keys 343=head2 The object keys
249 344
250Every other key is a BCD object. There is usually a BCD object for the 345Every other key is a BCD object. There is usually a BCD object for the
251boot manager, one for every boot option and a few others that store common 346boot manager, one for every boot option and a few others that store common
252settings inherited by these. 347settings inherited by these.
253 348
254Each BCD object is represented by a GUID wrapped in curly braces. These 349Each BCD object is represented by a GUID wrapped in curly braces. These
255are usually random GUIDs used only to distinguish bCD objects from each 350are usually random GUIDs used only to distinguish BCD objects from each
256other. When adding a new boot option, you can simply generate a new GUID. 351other. When adding a new boot option, you can simply generate a new GUID.
257 352
258Some 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
259into human-readable strings such as C<{globalsettings}>, which is the same 354into human-readable strings such as C<{globalsettings}>, which is the same
260as C<{7ea2e1ac-2e61-4728-aaa3-896d9d0a9f0e}>. 355as C<{7ea2e1ac-2e61-4728-aaa3-896d9d0a9f0e}>.
261 356
262Each BCD, object has an associated type. For example, 357Each BCD object has an associated type. For example,
263C<application::osloader> for objects loading Windows via F<winload.exe>, 358C<application::osloader> for objects loading Windows via F<winload.exe>,
264C<application::bootsector> for real mode applications and so on. 359C<application::bootsector> for real mode applications and so on.
265 360
266The 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
267section). 362section).
294get a list of all BCD elements known to PBCDEDIT by running F<pbcdedit 389get a list of all BCD elements known to PBCDEDIT by running F<pbcdedit
295elements>. 390elements>.
296 391
297What was said about duplicate keys mapping to the same object is true for 392What was said about duplicate keys mapping to the same object is true for
298elements as well, so, again, you should always use the canonical name, 393elements as well, so, again, you should always use the canonical name,
299whcih is the human radable alias, if known. 394which is the human readable alias, if known.
300 395
301=head3 BCD element types 396=head3 BCD element types
302 397
303Each BCD element has a type such as I<string> or I<boolean>. This type 398Each BCD element has a type such as I<string> or I<boolean>. This type
304determines how the value is interpreted, and most of them are pretty easy 399determines how the value is interpreted, and most of them are pretty easy
316 "description" : "Windows 10", 411 "description" : "Windows 10",
317 "systemroot" : "\\Windows", 412 "systemroot" : "\\Windows",
318 413
319=item boolean 414=item boolean
320 415
321Almost as simnple are booleans, which represent I<true>/I<false>, 416Almost as simple are booleans, which represent I<true>/I<false>,
322I<on>/I<off> and similar values. In the JSON form, true is represented 417I<on>/I<off> and similar values. In the JSON form, true is represented
323by the number C<1>, and false is represented by the number C<0>. Other 418by the number C<1>, and false is represented by the number C<0>. Other
324values will be accepted, but PBCDEDIT doesn't guarantee how these are 419values will be accepted, but PBCDEDIT doesn't guarantee how these are
325interpreted. 420interpreted.
326 421
330 425
331 "displaybootmenu" : 0, 426 "displaybootmenu" : 0,
332 427
333=item integer 428=item integer
334 429
335Again, 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
336as 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
337binatry number (prefix C<0b>). 432binary number (prefix C<0b>).
338 433
339For example, the boot C<timeout> is an integer, specifying the automatic 434For example, the boot C<timeout> is an integer, specifying the automatic
340boot delay in seconds: 435boot delay in seconds:
341 436
342 "timeout" : 30, 437 "timeout" : 30,
343 438
344=item integer list 439=item integer list
345 440
346This 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
347much, so here is a somewhat artificial an untested exanmple of using 442much, so here is a somewhat artificial and untested example of using
348C<customactions> to specify a certain custom, eh, action to be executed 443C<customactions> to specify a certain custom, eh, action to be executed
349when pressing C<F10> at boot: 444when pressing C<F10> at boot:
350 445
351 "customactions" : "0x1000044000001 0x54000001", 446 "customactions" : "0x1000044000001 0x54000001",
352 447
353=item guid 448=item guid
354 449
355This represents a single GUID value wrqapped in curly braces. It is used a 450This represents a single GUID value wrapped in curly braces. It is used a
356lot to refer from one BCD object to other one. 451lot to refer from one BCD object to other one.
357 452
358For 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
359using C<resumeobject>: 454using C<default>:
360 455
361 "resumeobject" : "{7ae02178-821d-11e7-8813-1c872c5f5ab0}", 456 "default" : "{7ae02178-821d-11e7-8813-1c872c5f5ab0}",
362 457
363Human readable aliases are used and allowed. 458Human readable aliases are used and allowed.
364 459
365=item guid list 460=item guid list
366 461
367Similar to te guid type, this represents a list of such GUIDs, separated 462Similar to the GUID type, this represents a list of such GUIDs, separated
368by whitespace from each other. 463by whitespace from each other.
369 464
370For example, many BCD objects can I<inherit> elements from other BCD 465For example, many BCD objects can I<inherit> elements from other BCD
371objects by specifying the GUIDs of those other objects ina GUID list 466objects by specifying the GUIDs of those other objects in a GUID list
372called surprisingly called C<inherit>: 467called surprisingly called C<inherit>:
373 468
374 "inherit" : "{dbgsettings} {emssettings} {badmemory}", 469 "inherit" : "{dbgsettings} {emssettings} {badmemory}",
375 470
376This example also shows how human readable aliases can be used. 471This example also shows how human readable aliases can be used.
380This 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
381is the pinnacle of Microsoft-typical hacks layered on top of other 476is the pinnacle of Microsoft-typical hacks layered on top of other
382hacks. 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
383PBCDEDIT, 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
384below. 479below.
480
385=back 481=back
386 482
387=head4 The BCD "device" element type 483=head3 The BCD "device" element type
388 484
389Device elements specify, well, devices. They are used for such diverse 485Device elements specify, well, devices. They are used for such diverse
390purposes such as finding a TFTP network boot imagem serial ports or VMBUS 486purposes such as finding a TFTP network boot image, serial ports or VMBUS
391devices, but most commonly they are used to specify the disk (harddisk, 487devices, but most commonly they are used to specify the disk (harddisk,
392cdrom ramdisk, vhd...) to boot from. 488cdrom, ramdisk, vhd...) to boot from.
393 489
394The device element is kind of a mini-language in its own which is much 490The device element is kind of a mini-language in its own which is much
395more versatile then the limited windows interface to it - BCDEDIT - 491more versatile then the limited windows interface to it - BCDEDIT -
396reveals. 492reveals.
397 493
400element, so almost everything known about it had to be researched first 496element, so almost everything known about it had to be researched first
401in the process of writing this script, and consequently, support for BCD 497in the process of writing this script, and consequently, support for BCD
402device elements is partial only. 498device elements is partial only.
403 499
404On the other hand, the expressive power of PBCDEDIT in specifying devices 500On the other hand, the expressive power of PBCDEDIT in specifying devices
405is much bigger than BCDEDIT and therefore more cna be don with it. The 501is much greater than BCDEDIT and therefore more can be done with it. The
406downside is that BCD device elements are much more complicated than what 502downside is that BCD device elements are much more complicated than what
407you might think from reading the BCDEDIT documentation. 503you might think from reading the BCDEDIT documentation.
408 504
409In other words, simple things are complicated, and complicated things are 505In other words, simple things are complicated, and complicated things are
410possible. 506possible.
411 507
412Anyway, the general syntax of device elements is an optional GUID, 508Anyway, the general syntax of device elements is an optional GUID,
413followed by a device type, optionally followed by hexdecimal flags in 509followed by a device type, optionally followed by hexadecimal flags in
414angle brackets, optionally followed by C<=> and a comma-separated list of 510angle brackets, optionally followed by C<=> and a comma-separated list of
415arguments, some of which can be (and often are) in turn devices again. 511arguments, some of which can be (and often are) in turn devices again.
416 512
417 [{GUID}]type[<flags>][=arg,arg...] 513 [{GUID}]type[<flags>][=arg,arg...]
418 514
419Here are some examples: 515Here are some examples:
420 516
421 boot 517 boot
422 {b097d29f-bc00-11e9-8a9a-525400123456}block=file,<boot>,\\EFI" 518 {b097d29f-bc00-11e9-8a9a-525400123456}block=file,<boot>,\EFI
423 locate=<null>,element,systemroot 519 locate=<null>,element,systemroot
424 partition=<null>,harddisk,mbr,47cbc08a,1048576 520 partition=<null>,harddisk,mbr,47cbc08a,1048576
425 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
426 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
427 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>,\
444The types understood and used by PBCDEDIT are as follows (keep in mind 540The types understood and used by PBCDEDIT are as follows (keep in mind
445that not of all the following is necessarily supported in PBCDEDIT): 541that not of all the following is necessarily supported in PBCDEDIT):
446 542
447=over 543=over
448 544
449=item binary=hex... 545=item C<binary=>I<hex...>
450 546
451This type isn't actually a real BCD element type, but a fallback for those 547This type isn't actually a real BCD element type, but a fallback for those
452cases where PBCDEDIT can't perfectly decode a device element (except for 548cases where PBCDEDIT can't perfectly decode a device element (except for
453the 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
454convert 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.
455 551
456=item null 552=item C<null>
457 553
458This is another special type - sometimes, a device all zero-filled, which 554This is another special type - sometimes, a device is all zero-filled,
459is 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
460does not understand, so it decodes it into this special "all zero" type 556PBCDEDIT does not understand, so it decodes it into this special "all
461called C<null>. 557zero" type called C<null>.
462 558
463It'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
464device, when no parent device is used. 560device, when no parent device is used.
465 561
466=item boot 562=item C<boot>
467 563
468Another type without parameters, this refers to the device that was booted 564Another type without parameters, this refers to the device that was booted
469from (nowadays typically the EFI system partition). 565from (nowadays typically the EFI system partition).
470 566
471=item vmbus=interfacetype,interfaceinstance 567=item C<vmbus=>I<interfacetype>,I<interfaceinstance>
472 568
473This specifies a VMBUS device with the given interface type and interface 569This specifies a VMBUS device with the given interface type and interface
474instance, both of which are "naked" (no curly braces) GUIDs. 570instance, both of which are "naked" (no curly braces) GUIDs.
475 571
476Made-up example (couldn't find a single example on the web): 572Made-up example (couldn't find a single example on the web):
477 573
478 vmbus=c376c1c3-d276-48d2-90a9-c04748072c60,12345678-a234-b234-c234-d2345678abcd 574 vmbus=c376c1c3-d276-48d2-90a9-c04748072c60,12345678-a234-b234-c234-d2345678abcd
479 575
480=item partition=<parent>,devicetype,partitiontype,diskid,partitionid 576=item C<partition=><I<parent>>,I<devicetype>,I<partitiontype>,I<diskid>,I<partitionid>
481 577
482This designates a specific partition on a block device. C<< <parent> 578This designates a specific partition on a block device. I<parent> is an
483>> is an optional parent device on which to search on, and is often 579optional parent device on which to search on, and is often C<null>. Note
484C<null>. Note that the anfgle brackets are part of the syntax. 580that the angle brackets around I<parent> are part of the syntax.
485 581
486C<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>, 582I<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>,
487C<file> or C<vhd>, where the first three should be self-explaining, 583C<file> or C<vhd>, where the first three should be self-explaining,
488C<file> is usually used to locate a device by finding a magic file, and 584C<file> is usually used to locate a file to be used as a disk image,
489C<vhd> is used for virtual harddisks - F<.vhd> and F<-vhdx> files. 585and C<vhd> is used to treat files as virtual harddisks, i.e. F<vhd> and
586F<vhdx> files.
490 587
491The C<partitiontype> is either C<mbr>, C<gpt> or C<raw>, the latter being 588The I<partitiontype> is either C<mbr>, C<gpt> or C<raw>, the latter being
492used for devices without partitions, such as cdroms, where the "partition" 589used for devices without partitions, such as cdroms, where the "partition"
493is usually the whole device. 590is usually the whole device.
494 591
495The C<diskid> identifies the disk or device using a unique signature, and 592The I<diskid> identifies the disk or device using a unique signature, and
496the same is true for the C<partitionid>. How these are interpreted depends 593the same is true for the I<partitionid>. How these are interpreted depends
497on the C<partitiontype>: 594on the I<partitiontype>:
498 595
499=over 596=over
500 597
501=item mbr 598=item C<mbr>
502 599
503The C<diskid> is the 32 bit disk signature stored at offset 0x1b8 in the 600The C<diskid> is the 32 bit disk signature stored at offset 0x1b8 in the
504MBR, interpreted as a 32 bit unsigned little endian integer and written as 601MBR, interpreted as a 32 bit unsigned little endian integer and written as
505hex number. That is, the bytes C<01 02 03 04> would become C<04030201>. 602hex number. That is, the bytes C<01 02 03 04> would become C<04030201>.
506 603
507Diskpart (using the C<DETAIL> command) and the C<lsblk> comamnd typically 604Diskpart (using the C<DETAIL> command) and the C<lsblk> command typically
508found on GNU/Linux systems (using e.g. C<lsblk -o NAME,PARTUUID>) can 605found on GNU/Linux systems (using e.g. C<lsblk -o NAME,PARTUUID>) can
509display the disk id. 606display the I<diskid>.
510 607
511The C<partitionid> is the byte offset(!) of the partition counting from 608The I<partitionid> is the byte offset(!) of the partition counting from
512the beginning of the MBR. 609the beginning of the MBR.
513 610
514Example, use the partition on the harddisk with C<diskid> C<47cbc08a> 611Example, use the partition on the harddisk with I<diskid> C<47cbc08a>
515starting at sector C<2048> (= 1048576 / 512). 612starting at sector C<2048> (= 1048576 / 512).
516 613
517 partition=<null>,harddisk,mbr,47cbc08a,1048576 614 partition=<null>,harddisk,mbr,47cbc08a,1048576
518 615
519=item gpt 616=item C<gpt>
520 617
521The C<diskid> is the disk UUID/disk identifier GUID from the partition 618The I<diskid> is the disk GUID/disk identifier GUID from the partition
522table (as displayed e.g. by C<gdisk>), and the C<partitionid> is the 619table (as displayed e.g. by F<gdisk>), and the I<partitionid> is the
523partition unique GUID (displayed using e.g. the C<gdisk> C<i> command). 620partition unique GUID (displayed using e.g. the F<gdisk> F<i> command).
524 621
525Example: use the partition C<76d39e5f-ad1b-407e-9c05-c81eb83b57dd> on GPT 622Example: use the partition C<76d39e5f-ad1b-407e-9c05-c81eb83b57dd> on GPT
526disk C<9742e468-9206-48a0-b4e4-c4e9745a356a>. 623disk C<9742e468-9206-48a0-b4e4-c4e9745a356a>.
527 624
528 partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,76d39e5f-ad1b-407e-9c05-c81eb83b57dd 625 partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,76d39e5f-ad1b-407e-9c05-c81eb83b57dd
529 626
530=item raw 627=item C<raw>
531 628
532Instead of diskid and partitionid, this type only accepts a decimal disk 629Instead of I<diskid> and I<partitionid>, this type only accepts a decimal
533number and signifies the whole disk. BCDEDIT cannot display the resulting 630disk number and signifies the whole disk. BCDEDIT cannot display the
534device, and I am doubtful whether it has a useful effect. 631resulting device, and I am doubtful whether it has a useful effect.
535 632
536=back 633=back
537 634
538=item legacypartition=<parent>,devicetype,partitiontype,diskid,partitionid 635=item C<legacypartition=><I<parent>>,I<devicetype>,I<partitiontype>,I<diskid>,I<partitionid>
539 636
540This is exactly the same as the C<partition> type, except for a tiny 637This is exactly the same as the C<partition> type, except for a tiny
541detail: instead of using the partition start offset, this type uses the 638detail: instead of using the partition start offset, this type uses the
542partition number for MBR disks. Behaviour other partition types should be 639partition number for MBR disks. Behaviour other partition types should be
543the same. 640the same.
544 641
545The partition number starts at C<1> and skips unused partition, so if 642The partition number starts at C<1> and skips unused partition, so if
546there are two primary partitions and another partition inside the extended 643there are two primary partitions and another partition inside the extended
547partition, the primary partitions are number C<1> and C<2> and the 644partition, the primary partitions are number C<1> and C<2> and the
548partition inside the extended partition is number C<3>, rwegardless of any 645partition inside the extended partition is number C<3>, regardless of any
549gaps. 646gaps.
550 647
551=item locate=<parent>,locatetype,locatearg 648=item C<locate=><I<parent>>,I<locatetype>,I<locatearg>
552 649
553This device description will make the bootloader search for a partition 650This device description will make the bootloader search for a partition
554with a given path. 651with a given path.
555 652
556The C<< <parent> >> device is the device to search on (angle brackets are 653The I<parent> device is the device to search on (angle brackets are
557still part of the syntax!) If it is C<< <null> >>, then C<locate> will 654still part of the syntax!) If it is C<null>, then C<locate> will
558search all disks it can find. 655search all disks it can find.
559 656
560C<locatetype> is either C<element> or C<path>, and merely distinguishes 657I<locatetype> is either C<element> or C<path>, and merely distinguishes
561between two different ways to specify the path to search for: C<element> 658between two different ways to specify the path to search for: C<element>
562uses an element ID (either as hex or as name) as C<locatearg> and C<path> 659uses an element ID (either as hex or as name) as I<locatearg> and C<path>
563uses a relative path as C<locatearg>. 660uses a relative path as I<locatearg>.
564 661
565Example: find any partition which has the C<magicfile.xxx> path in the 662Example: find any partition which has the F<magicfile.xxx> path in the
566root. 663root.
567 664
568 locate=<null>,path,\magicfile.xxx 665 locate=<null>,path,\magicfile.xxx
569 666
570Example: find any partition which has the path specified in the 667Example: find any partition which has the path specified in the
571C<systemroot> element (typically C<\Windows>). 668C<systemroot> element (typically F<\Windows>).
572 669
573 locate=<null>,element,systemroot 670 locate=<null>,element,systemroot
574 671
575=item block=devicetype,args... 672=item C<block=>I<devicetype>,I<args...>
576 673
577Last not least, the most complex type, C<block>, which... specifies block 674Last not least, the most complex type, C<block>, which... specifies block
578devices (which could be inside a F<vhdx> file for example). 675devices (which could be inside a F<vhdx> file for example).
579 676
580C<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>,
581C<file> or C<vhd> - the same as for C<partiion=>. 678C<file> or C<vhd> - the same as for C<partition=>.
582 679
583The remaining arguments change depending on the C<devicetype>: 680The remaining arguments change depending on the I<devicetype>:
584 681
585=over 682=over
586 683
587=item block=file,<parent>,path 684=item C<block=file>,<I<parent>>,I<path>
588 685
589Interprets the C<< <parent> >> device (typically a partition) as a 686Interprets the I<parent> device (typically a partition) as a
590filesystem and specifies a file path inside. 687filesystem and specifies a file path inside.
591 688
592=item block=vhd,<parent> 689=item C<block=vhd>,<I<parent>>
593 690
594Pretty much just changes the interpretation of C<< <parent> >>, which is 691Pretty much just changes the interpretation of I<parent>, which is
595usually a disk image (C<block=file,...)>) to be a F<vhd> or F<vhdx> file. 692usually a disk image (C<block=file,...)>) to be a F<vhd> or F<vhdx> file.
596 693
597=item block=ramdisk,<parent>,base,size,offset,path 694=item C<block=ramdisk>,<I<parent>>,I<base>,I<size>,I<offset>,I<path>
598 695
599Interprets the C<< <parent> >> device as RAM disk, using the (decimal) 696Interprets the I<parent> device as RAM disk, using the (decimal)
600base address, byte size and byte offset inside a file specified by 697base address, byte size and byte offset inside a file specified by
601C<path>. The numbers are usually all C<0> because they cna be extracted 698I<path>. The numbers are usually all C<0> because they can be extracted
602from the RAM disk image or other parameters. 699from the RAM disk image or other parameters.
603 700
604This is most commonly used to boot C<wim> images. 701This is most commonly used to boot C<wim> images.
605 702
606=item block=floppy,drivenum 703=item C<block=floppy>,I<drivenum>
607 704
608Refers to a removable drive identified by a number. BCDEDIT cannot display 705Refers to a removable drive identified by a number. BCDEDIT cannot display
609the resultinfg device, and it is not clear what effect it will have. 706the resulting device, and it is not clear what effect it will have.
610 707
611=item block=cdrom,drivenum 708=item C<block=cdrom>,I<drivenum>
612 709
613Pretty much the same as C<floppy> but for CD-ROMs. 710Pretty much the same as C<floppy> but for CD-ROMs.
614 711
615=item anything else 712=item anything else
616 713
617Probably not yet implemented. Tell me of your needs... 714Probably not yet implemented. Tell me of your needs...
618 715
619=back 716=back
620 717
621=back5 Examples 718=back
719
720=head4 Examples
622 721
623This concludes the syntax overview for device elements, but probably 722This concludes the syntax overview for device elements, but probably
624leaves 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
625many questions, but I can walk you through some actual examples using mroe 724many questions, but I can walk you through some actual examples using more
626complex aspects. 725complex aspects.
627 726
727=over
728
628=item 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 >>
629 730
630Just like with C declarations, you best treat device descriptors as 731Just like with C declarations, you best treat device descriptors as
631instructions 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:
632 733
633 locate=<null>,path,\disk.vhdx 734 locate=<null>,path,\disk.vhdx
640Next, this takes the device locate has found and finds a file called 741Next, this takes the device locate has found and finds a file called
641F<\disk.vhdx> on it. This is the same file locate was using, but that is 742F<\disk.vhdx> on it. This is the same file locate was using, but that is
642only because we find the device using the same path as finding the disk 743only because we find the device using the same path as finding the disk
643image, so this is purely incidental, although quite common. 744image, so this is purely incidental, although quite common.
644 745
645Bext, this file will be opened as a virtual disk: 746Next, this file will be opened as a virtual disk:
646 747
647 block=vhd,<see above> 748 block=vhd,<see above>
648 749
649And finally, inside this disk, another C<locate> will look for a partition 750And finally, inside this disk, another C<locate> will look for a partition
650with a path as specified in the C<path> element, which most likely will be 751with a path as specified in the C<path> element, which most likely will be
653 locate=<see above>,element,path 754 locate=<see above>,element,path
654 755
655As a result, this will boot the first Windows it finds on the first 756As a result, this will boot the first Windows it finds on the first
656F<disk.vhdx> disk image it can find anywhere. 757F<disk.vhdx> disk image it can find anywhere.
657 758
658=item locate=<block=vhd,<block=file,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,\win10.vhdx>>,element,path 759=item C<< locate=<block=vhd,<block=file,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,\win10.vhdx>>,element,path >>
659 760
660Pretty much the same as the previous case, but witzh a bit of variance. First, look for a specific partition on 761Pretty much the same as the previous case, but with a bit of
661an MBR-partitioned disk: 762variance. First, look for a specific partition on an MBR-partitioned disk:
662 763
663 partition=<null>,harddisk,mbr,47cbc08a,242643632128 764 partition=<null>,harddisk,mbr,47cbc08a,242643632128
664 765
665Then open the file F<\win10.vhdx> on that partition: 766Then open the file F<\win10.vhdx> on that partition:
666 767
672 773
673And again the windows loader (or whatever is in C<path>) will be searched: 774And again the windows loader (or whatever is in C<path>) will be searched:
674 775
675 locate=<see above>,element,path 776 locate=<see above>,element,path
676 777
677=item {b097d2b2-bc00-11e9-8a9a-525400123456}block<1>=ramdisk,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,0,0,0,\boot.wim 778=item C<< {b097d2b2-bc00-11e9-8a9a-525400123456}block<1>=ramdisk,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,0,0,0,\boot.wim >>
678 779
679This is quite different. First, it starts with a GUID. This GUID belongs 780This is quite different. First, it starts with a GUID. This GUID belongs
680to a BCD object of type C<device>, which has additional parameters: 781to a BCD object of type C<device>, which has additional parameters:
681 782
682 "{b097d2b2-bc00-11e9-8a9a-525400123456}" : { 783 "{b097d2b2-bc00-11e9-8a9a-525400123456}" : {
685 "ramdisksdidevice" : "partition=<null>,harddisk,mbr,47cbc08a,1048576", 786 "ramdisksdidevice" : "partition=<null>,harddisk,mbr,47cbc08a,1048576",
686 "ramdisksdipath" : "\boot.sdi" 787 "ramdisksdipath" : "\boot.sdi"
687 }, 788 },
688 789
689I will not go into many details, but this specifies a (presumably empty) 790I will not go into many details, but this specifies a (presumably empty)
690template ramdisk image (F<\boot.sdi>) that is used to initiaolize the 791template ramdisk image (F<\boot.sdi>) that is used to initialize the
691ramdisk. The F<\boot.wim> file is then extracted into it. As you cna also 792ramdisk. The F<\boot.wim> file is then extracted into it. As you can also
692see, this F<.sdi> file resides on a different C<partition>. 793see, this F<.sdi> file resides on a different C<partition>.
693 794
694Continuitn, as always, form the inside out, first this device descriptor 795Continuing, as always, from the inside out, first this device descriptor
695finds a specific partition: 796finds a specific partition:
696 797
697 partition=<null>,harddisk,mbr,47cbc08a,242643632128 798 partition=<null>,harddisk,mbr,47cbc08a,242643632128
698 799
699And then specifies a C<ramdisk> image on this partition: 800And then specifies a C<ramdisk> image on this partition:
703I 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
704seems to be always there on this kind of entry. 805seems to be always there on this kind of entry.
705 806
706If 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.
707 808
809=back
708 810
811
709=head1 EDITING BCD DATA STORES 812=head1 EDITING BCD STORES
710 813
711The 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
712and modify it or extract data from it. This is done by exyecuting a series 815and modify it or extract data from it. This is done by executing a series
713of "editing instructions" which are explained here. 816of "editing instructions" which are explained here.
714 817
715=over 818=over
716 819
717=item get I<object> I<element> 820=item C<get> I<object> I<element>
718 821
719Reads the BCD element I<element> from the BCD object I<object> and writes 822Reads the BCD element I<element> from the BCD object I<object> and writes
720it to standard output, followed by a newline. The I<object> can be a GUID 823it to standard output, followed by a newline. The I<object> can be a GUID
721or a human-readable alias, or the special string C<{default}>, which will 824or a human-readable alias, or the special string C<{default}>, which will
722refer to the default BCD object. 825refer to the default BCD object.
723 826
724Example: find description of the default BCD object. 827Example: find description of the default BCD object.
725 828
726 pbcdedit parse BCD get "{default}" description 829 pbcdedit parse BCD get "{default}" description
727 830
728=item set I<object> I<element> I<value> 831=item C<set> I<object> I<element> I<value>
729 832
730Similar 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.
731 834
732Example: change bootmgr default too 835Example: change the bootmgr default too
733C<{b097d2ad-bc00-11e9-8a9a-525400123456}>: 836C<{b097d2ad-bc00-11e9-8a9a-525400123456}>:
734 837
735 pbcdedit edit BCD set "{bootmgr}" resumeobject "{b097d2ad-bc00-11e9-8a9a-525400123456}" 838 pbcdedit edit BCD set "{bootmgr}" default "{b097d2ad-bc00-11e9-8a9a-525400123456}"
736 839
840=item C<del> I<object> I<element>
841
842Similar to C<get>, but removed the BCD element from the specified BCD object.
843
737=item eval I<perlcode> 844=item C<eval> I<perlcode>
738 845
739This takes the next argument, interprets it as Perl code and 846This takes the next argument, interprets it as Perl code and
740evaluates it. This allows you to do more complicated modifications or 847evaluates it. This allows you to do more complicated modifications or
741extractions. 848extractions.
742 849
761The example given for C<get>, above, could be expressed like this with 868The example given for C<get>, above, could be expressed like this with
762C<eval>: 869C<eval>:
763 870
764 pbcdedit edit BCD eval 'say $BCD->{$DEFAULT}{description}' 871 pbcdedit edit BCD eval 'say $BCD->{$DEFAULT}{description}'
765 872
766The example given for C<set> could be expresed like this: 873The example given for C<set> could be expressed like this:
767 874
768 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}"'
769 876
770=item do I<path> 877=item C<do> I<path>
771 878
772Similar 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,
773it 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
774easier to write more complicated or larger programs. 881easier to write more complicated or larger programs.
775 882
776=back 883=back
777 884
885
778=head1 SEE ALSO 886=head1 SEE ALSO
779 887
780For ideas on what you can do, and some introductory material, try 888For ideas on what you can do with BCD stores in
889general, and some introductory material, try
781L<http://www.mistyprojects.co.uk/documents/BCDEdit/index.html>. 890L<http://www.mistyprojects.co.uk/documents/BCDEdit/index.html>.
782 891
783For good reference on BCD objects and elements, see Geoff Chappels pages 892For good reference on which BCD objects and
893elements exist, see Geoff Chappell's pages at
784at L<http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm>. 894L<http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm>.
785 895
786=head1 AUTHOR 896=head1 AUTHOR
787 897
788Written by Marc A. Lehmann <pbcdedit@schmorp.de>. 898Written by Marc A. Lehmann L<pbcdedit@schmorp.de>.
789 899
790=head1 REPORTING BUGS 900=head1 REPORTING BUGS
791 901
792Bugs can be reported dorectly tt he author at L<pcbedit@schmorp.de>. 902Bugs can be reported directly the author at L<pcbedit@schmorp.de>.
793 903
794=head1 BUGS AND SHORTCOMINGS 904=head1 BUGS AND SHORTCOMINGS
795 905
796This should be a module. Of a series of modules, even. 906This should be a module. Of a series of modules, even.
797 907
798Registry code should preserve classname and security descriptor data, and 908Registry code should preserve classname and security descriptor data, and
799whatever else is necessary to read and write any registry hive file. 909whatever else is necessary to read and write any registry hive file.
800 910
801I am also not happy with device descriptors being strings rather than a 911I am also not happy with device descriptors being strings rather than a
802data structure, but strings are probably better for command line usage. In 912data structure, but strings are probably better for command line usage. In
803any case,. device descriptors could be converted by simply "splitting" at 913any case, device descriptors could be converted by simply "splitting" at
804"=" and "," into an array reference, recursively. 914"=" and "," into an array reference, recursively.
805 915
806=head1 HOMEPAGE 916=head1 HOMEPAGE
807 917
808Original versions of this program can be found at 918Original versions of this program can be found at
815free to change and redistribute it. There is NO WARRANTY, to the extent 925free to change and redistribute it. There is NO WARRANTY, to the extent
816permitted by law. 926permitted by law.
817 927
818=cut 928=cut
819 929
820BEGIN { require "common/sense.pm"; common::sense->import } # common sense is optional, but recommended 930# common sense is optional, but recommended
931BEGIN { eval { require "common/sense.pm"; } && common::sense->import }
821 932
822use Data::Dump; 933no warnings 'portable'; # avoid 32 bit integer warnings
934
823use Encode (); 935use Encode ();
824use List::Util (); 936use List::Util ();
825use IO::Handle (); 937use IO::Handle ();
826use Time::HiRes (); 938use Time::HiRes ();
827 939
836 948
837# hack used for debugging 949# hack used for debugging
838sub xxd($$) { 950sub xxd($$) {
839 open my $xxd, "| xxd | sed -e 's/^/\Q$_[0]\E: /'"; 951 open my $xxd, "| xxd | sed -e 's/^/\Q$_[0]\E: /'";
840 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;
841} 967}
842 968
843sub file_load($) { 969sub file_load($) {
844 my ($path) = @_; 970 my ($path) = @_;
845 971
850 or die "$path: short read\n"; 976 or die "$path: short read\n";
851 977
852 $buf 978 $buf
853} 979}
854 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;
993}
994
855# sources and resources used for this: 995# sources and resources used for writing pbcdedit
996#
856# registry: 997# registry:
857# https://github.com/msuhanov/regf/blob/master/Windows%20registry%20file%20format%20specification.md 998# https://github.com/msuhanov/regf/blob/master/Windows%20registry%20file%20format%20specification.md
858# http://amnesia.gtisc.gatech.edu/~moyix/suzibandit.ltd.uk/MSc/ 999# http://amnesia.gtisc.gatech.edu/~moyix/suzibandit.ltd.uk/MSc/
859# bcd: 1000# bcd:
860# http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm 1001# http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm
1042 my ($rname, $root) = $decode_key->($rootcell); 1183 my ($rname, $root) = $decode_key->($rootcell);
1043 1184
1044 [$rname, $root] 1185 [$rname, $root]
1045} 1186}
1046 1187
1047# return a binary windows fILETIME struct 1188# return a binary windows FILETIME struct
1048sub filetime_now { 1189sub filetime_now {
1049 my ($s, $ms) = Time::HiRes::gettimeofday; 1190 my ($s, $ms) = Time::HiRes::gettimeofday;
1050 1191
1051 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
1052} 1194}
1053 1195
1054# encode a registry hive 1196# encode a registry hive
1055sub regf_encode($) { 1197sub regf_encode($) {
1056 my ($hive) = @_; 1198 my ($hive) = @_;
1059 1201
1060 # the filetime is apparently used to verify log file validity, 1202 # the filetime is apparently used to verify log file validity,
1061 # so by generating a new timestamp the log files *should* automatically 1203 # so by generating a new timestamp the log files *should* automatically
1062 # become invalidated and windows would "self-heal" them. 1204 # become invalidated and windows would "self-heal" them.
1063 # (update: has been verified by reverse engineering) 1205 # (update: has been verified by reverse engineering)
1064 # possibly the fact that the two sequence numbes match might also 1206 # possibly the fact that the two sequence numbers match might also
1065 # 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.
1066 # (update: has been verified by reverse engineering) 1208 # (update: has been verified by reverse engineering)
1067 1209
1068 my $now = filetime_now; 1210 my $now = filetime_now;
1069 1211
1213 1355
1214 regf_decode file_load $path 1356 regf_decode file_load $path
1215} 1357}
1216 1358
1217# encode and save registry to file 1359# encode and save registry to file
1218sub regf_save { 1360sub regf_save($$;$) {
1219 my ($path, $hive) = @_; 1361 my ($path, $hive, $stat) = @_;
1220 1362
1221 $hive = regf_encode $hive; 1363 $hive = regf_encode $hive;
1222 1364
1223 open my $regf, ">:raw", "$path~" 1365 file_save $path, $hive, $stat;
1224 or die "$path~: $!\n";
1225 print $regf $hive
1226 or die "$path~: short write\n";
1227 $regf->sync;
1228 close $regf;
1229
1230 rename "$path~", $path;
1231} 1366}
1232 1367
1233############################################################################# 1368#############################################################################
1234# bcd stuff 1369# bcd stuff
1235 1370
1236# human-readable alises for GUID object identifiers 1371# human-readable aliases for GUID object identifiers
1237our %bcd_objects = ( 1372our %bcd_objects = (
1238 '{0ce4991b-e6b3-4b16-b23c-5e0d9250e5d9}' => '{emssettings}', 1373 '{0ce4991b-e6b3-4b16-b23c-5e0d9250e5d9}' => '{emssettings}',
1239 '{1afa9c49-16ab-4a5c-4a90-212802da9460}' => '{resumeloadersettings}', 1374 '{1afa9c49-16ab-4a5c-4a90-212802da9460}' => '{resumeloadersettings}',
1240 '{1cae1eb7-a0df-4d4d-9851-4860e34ef535}' => '{default}', 1375 '{1cae1eb7-a0df-4d4d-9851-4860e34ef535}' => '{default}',
1241 '{313e8eed-7098-4586-a9bf-309c61f8d449}' => '{kerneldbgsettings}', 1376 '{313e8eed-7098-4586-a9bf-309c61f8d449}' => '{kerneldbgsettings}',
1348sub BCDE_FORMAT_GUID_LIST () { 0x04000000 } 1483sub BCDE_FORMAT_GUID_LIST () { 0x04000000 }
1349sub BCDE_FORMAT_INTEGER () { 0x05000000 } 1484sub BCDE_FORMAT_INTEGER () { 0x05000000 }
1350sub BCDE_FORMAT_BOOLEAN () { 0x06000000 } 1485sub BCDE_FORMAT_BOOLEAN () { 0x06000000 }
1351sub BCDE_FORMAT_INTEGER_LIST () { 0x07000000 } 1486sub BCDE_FORMAT_INTEGER_LIST () { 0x07000000 }
1352 1487
1353sub dec_device;
1354sub enc_device;
1355
1356sub enc_integer($) { 1488sub enc_integer($) {
1357 no warnings 'portable'; # ugh
1358 my $value = shift; 1489 my $value = shift;
1359 $value = oct $value if $value =~ /^0[bBxX]/; 1490 $value = oct $value if $value =~ /^0[bBxX]/;
1360 unpack "H*", pack "Q<", $value 1491 unpack "H*", pack "Q<", $value
1361} 1492}
1493
1494sub enc_device($$);
1495sub dec_device($$);
1362 1496
1363our %bcde_dec = ( 1497our %bcde_dec = (
1364 BCDE_FORMAT_DEVICE , \&dec_device, 1498 BCDE_FORMAT_DEVICE , \&dec_device,
1365# # for round-trip verification 1499# # for round-trip verification
1366# BCDE_FORMAT_DEVICE , sub { 1500# BCDE_FORMAT_DEVICE , sub {
1372 BCDE_FORMAT_STRING , sub { shift }, 1506 BCDE_FORMAT_STRING , sub { shift },
1373 BCDE_FORMAT_GUID , sub { dec_wguid enc_wguid shift }, 1507 BCDE_FORMAT_GUID , sub { dec_wguid enc_wguid shift },
1374 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} },
1375 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
1376 BCDE_FORMAT_BOOLEAN , sub { shift eq "00" ? 0 : 1 }, 1510 BCDE_FORMAT_BOOLEAN , sub { shift eq "00" ? 0 : 1 },
1377 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
1378); 1512);
1379 1513
1380our %bcde_enc = ( 1514our %bcde_enc = (
1381 BCDE_FORMAT_DEVICE , sub { binary => enc_device shift }, 1515 BCDE_FORMAT_DEVICE , sub { binary => enc_device $_[0], $_[1] },
1382 BCDE_FORMAT_STRING , sub { sz => shift }, 1516 BCDE_FORMAT_STRING , sub { sz => shift },
1383 BCDE_FORMAT_GUID , sub { sz => "{" . (dec_guid enc_wguid shift) . "}" }, 1517 BCDE_FORMAT_GUID , sub { sz => "{" . (dec_guid enc_wguid shift) . "}" },
1384 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 ] },
1385 BCDE_FORMAT_INTEGER , sub { binary => enc_integer shift }, 1519 BCDE_FORMAT_INTEGER , sub { binary => enc_integer shift },
1386 BCDE_FORMAT_BOOLEAN , sub { binary => shift ? "01" : "00" }, 1520 BCDE_FORMAT_BOOLEAN , sub { binary => shift ? "01" : "00" },
1387 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 },
1388); 1522);
1389 1523
1390# BCD Elements 1524# BCD Elements
1391our %bcde = ( 1525our %bcde_byclass = (
1526 any => {
1392 0x11000001 => 'device', 1527 0x11000001 => 'device',
1393 0x12000002 => 'path', 1528 0x12000002 => 'path',
1394 0x12000004 => 'description', 1529 0x12000004 => 'description',
1395 0x12000005 => 'locale', 1530 0x12000005 => 'locale',
1396 0x14000006 => 'inherit', 1531 0x14000006 => 'inherit',
1397 0x15000007 => 'truncatememory', 1532 0x15000007 => 'truncatememory',
1398 0x14000008 => 'recoverysequence', 1533 0x14000008 => 'recoverysequence',
1399 0x16000009 => 'recoveryenabled', 1534 0x16000009 => 'recoveryenabled',
1400 0x1700000a => 'badmemorylist', 1535 0x1700000a => 'badmemorylist',
1401 0x1600000b => 'badmemoryaccess', 1536 0x1600000b => 'badmemoryaccess',
1402 0x1500000c => 'firstmegabytepolicy', 1537 0x1500000c => 'firstmegabytepolicy',
1403 0x1500000d => 'relocatephysical', 1538 0x1500000d => 'relocatephysical',
1404 0x1500000e => 'avoidlowmemory', 1539 0x1500000e => 'avoidlowmemory',
1405 0x1600000f => 'traditionalkseg', 1540 0x1600000f => 'traditionalkseg',
1406 0x16000010 => 'bootdebug', 1541 0x16000010 => 'bootdebug',
1407 0x15000011 => 'debugtype', 1542 0x15000011 => 'debugtype',
1408 0x15000012 => 'debugaddress', 1543 0x15000012 => 'debugaddress',
1409 0x15000013 => 'debugport', 1544 0x15000013 => 'debugport',
1410 0x15000014 => 'baudrate', 1545 0x15000014 => 'baudrate',
1411 0x15000015 => 'channel', 1546 0x15000015 => 'channel',
1412 0x12000016 => 'targetname', 1547 0x12000016 => 'targetname',
1413 0x16000017 => 'noumex', 1548 0x16000017 => 'noumex',
1414 0x15000018 => 'debugstart', 1549 0x15000018 => 'debugstart',
1415 0x12000019 => 'busparams', 1550 0x12000019 => 'busparams',
1416 0x1500001a => 'hostip', 1551 0x1500001a => 'hostip',
1417 0x1500001b => 'port', 1552 0x1500001b => 'port',
1418 0x1600001c => 'dhcp', 1553 0x1600001c => 'dhcp',
1419 0x1200001d => 'key', 1554 0x1200001d => 'key',
1420 0x1600001e => 'vm', 1555 0x1600001e => 'vm',
1421 0x16000020 => 'bootems', 1556 0x16000020 => 'bootems',
1422 0x15000022 => 'emsport', 1557 0x15000022 => 'emsport',
1423 0x15000023 => 'emsbaudrate', 1558 0x15000023 => 'emsbaudrate',
1424 0x12000030 => 'loadoptions', 1559 0x12000030 => 'loadoptions',
1425 0x16000040 => 'advancedoptions', 1560 0x16000040 => 'advancedoptions',
1426 0x16000041 => 'optionsedit', 1561 0x16000041 => 'optionsedit',
1427 0x15000042 => 'keyringaddress', 1562 0x15000042 => 'keyringaddress',
1428 0x11000043 => 'bootstatdevice', 1563 0x11000043 => 'bootstatdevice',
1429 0x12000044 => 'bootstatfilepath', 1564 0x12000044 => 'bootstatfilepath',
1430 0x16000045 => 'preservebootstat', 1565 0x16000045 => 'preservebootstat',
1431 0x16000046 => 'graphicsmodedisabled', 1566 0x16000046 => 'graphicsmodedisabled',
1432 0x15000047 => 'configaccesspolicy', 1567 0x15000047 => 'configaccesspolicy',
1433 0x16000048 => 'nointegritychecks', 1568 0x16000048 => 'nointegritychecks',
1434 0x16000049 => 'testsigning', 1569 0x16000049 => 'testsigning',
1435 0x1200004a => 'fontpath', 1570 0x1200004a => 'fontpath',
1436 0x1500004b => 'integrityservices', 1571 0x1500004b => 'integrityservices',
1437 0x1500004c => 'volumebandid', 1572 0x1500004c => 'volumebandid',
1438 0x16000050 => 'extendedinput', 1573 0x16000050 => 'extendedinput',
1439 0x15000051 => 'initialconsoleinput', 1574 0x15000051 => 'initialconsoleinput',
1440 0x15000052 => 'graphicsresolution', 1575 0x15000052 => 'graphicsresolution',
1441 0x16000053 => 'restartonfailure', 1576 0x16000053 => 'restartonfailure',
1442 0x16000054 => 'highestmode', 1577 0x16000054 => 'highestmode',
1443 0x16000060 => 'isolatedcontext', 1578 0x16000060 => 'isolatedcontext',
1444 0x15000065 => 'displaymessage', 1579 0x15000065 => 'displaymessage',
1445 0x15000066 => 'displaymessageoverride', 1580 0x15000066 => 'displaymessageoverride',
1446 0x16000068 => 'nobootuxtext', 1581 0x16000068 => 'nobootuxtext',
1447 0x16000069 => 'nobootuxprogress', 1582 0x16000069 => 'nobootuxprogress',
1448 0x1600006a => 'nobootuxfade', 1583 0x1600006a => 'nobootuxfade',
1449 0x1600006b => 'bootuxreservepooldebug', 1584 0x1600006b => 'bootuxreservepooldebug',
1450 0x1600006c => 'bootuxdisabled', 1585 0x1600006c => 'bootuxdisabled',
1451 0x1500006d => 'bootuxfadeframes', 1586 0x1500006d => 'bootuxfadeframes',
1452 0x1600006e => 'bootuxdumpstats', 1587 0x1600006e => 'bootuxdumpstats',
1453 0x1600006f => 'bootuxshowstats', 1588 0x1600006f => 'bootuxshowstats',
1454 0x16000071 => 'multibootsystem', 1589 0x16000071 => 'multibootsystem',
1455 0x16000072 => 'nokeyboard', 1590 0x16000072 => 'nokeyboard',
1456 0x15000073 => 'aliaswindowskey', 1591 0x15000073 => 'aliaswindowskey',
1457 0x16000074 => 'bootshutdowndisabled', 1592 0x16000074 => 'bootshutdowndisabled',
1458 0x15000075 => 'performancefrequency', 1593 0x15000075 => 'performancefrequency',
1459 0x15000076 => 'securebootrawpolicy', 1594 0x15000076 => 'securebootrawpolicy',
1460 0x17000077 => 'allowedinmemorysettings', 1595 0x17000077 => 'allowedinmemorysettings',
1461 0x15000079 => 'bootuxtransitiontime', 1596 0x15000079 => 'bootuxtransitiontime',
1462 0x1600007a => 'mobilegraphics', 1597 0x1600007a => 'mobilegraphics',
1463 0x1600007b => 'forcefipscrypto', 1598 0x1600007b => 'forcefipscrypto',
1464 0x1500007d => 'booterrorux', 1599 0x1500007d => 'booterrorux',
1465 0x1600007e => 'flightsigning', 1600 0x1600007e => 'flightsigning',
1466 0x1500007f => 'measuredbootlogformat', 1601 0x1500007f => 'measuredbootlogformat',
1467 0x15000080 => 'displayrotation', 1602 0x15000080 => 'displayrotation',
1468 0x15000081 => 'logcontrol', 1603 0x15000081 => 'logcontrol',
1469 0x16000082 => 'nofirmwaresync', 1604 0x16000082 => 'nofirmwaresync',
1470 0x11000084 => 'windowssyspart', 1605 0x11000084 => 'windowssyspart',
1471 0x16000087 => 'numlock', 1606 0x16000087 => 'numlock',
1472 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 => {
1473 0x24000001 => 'displayorder', 1632 0x24000001 => 'displayorder',
1474 0x21000001 => 'filedevice',
1475 0x21000001 => 'osdevice',
1476 0x25000001 => 'passcount',
1477 0x26000001 => 'pxesoftreboot',
1478 0x22000002 => 'applicationname',
1479 0x24000002 => 'bootsequence', 1633 0x24000002 => 'bootsequence',
1480 0x22000002 => 'filepath',
1481 0x22000002 => 'systemroot',
1482 0x25000002 => 'testmix',
1483 0x26000003 => 'cacheenable',
1484 0x26000003 => 'customsettings',
1485 0x23000003 => 'default', 1634 0x23000003 => 'default',
1486 0x25000003 => 'failurecount',
1487 0x23000003 => 'resumeobject',
1488 0x26000004 => 'failuresenabled',
1489 0x26000004 => 'pae',
1490 0x26000004 => 'stampdisks',
1491 0x25000004 => 'testtofail',
1492 0x25000004 => 'timeout', 1635 0x25000004 => 'timeout',
1493 0x21000005 => 'associatedosdevice',
1494 0x26000005 => 'cacheenable',
1495 0x26000005 => 'resume', 1636 0x26000005 => 'resume',
1496 0x25000005 => 'stridefailcount',
1497 0x26000006 => 'debugoptionenabled',
1498 0x25000006 => 'invcfailcount',
1499 0x23000006 => 'resumeobject', 1637 0x23000006 => 'resumeobject',
1500 0x25000007 => 'bootux',
1501 0x25000007 => 'matsfailcount',
1502 0x24000007 => 'startupsequence', 1638 0x24000007 => 'startupsequence',
1503 0x25000008 => 'bootmenupolicy',
1504 0x25000008 => 'randfailcount',
1505 0x25000009 => 'chckrfailcount',
1506 0x26000010 => 'detecthal',
1507 0x24000010 => 'toolsdisplayorder', 1639 0x24000010 => 'toolsdisplayorder',
1508 0x22000011 => 'kernel',
1509 0x22000012 => 'hal',
1510 0x22000013 => 'dbgtransport',
1511 0x26000020 => 'displaybootmenu', 1640 0x26000020 => 'displaybootmenu',
1512 0x25000020 => 'nx',
1513 0x26000021 => 'noerrordisplay', 1641 0x26000021 => 'noerrordisplay',
1514 0x25000021 => 'pae',
1515 0x21000022 => 'bcddevice', 1642 0x21000022 => 'bcddevice',
1516 0x26000022 => 'winpe',
1517 0x22000023 => 'bcdfilepath', 1643 0x22000023 => 'bcdfilepath',
1518 0x26000024 => 'hormenabled', 1644 0x26000024 => 'hormenabled',
1519 0x26000024 => 'hormenabled',
1520 0x26000024 => 'nocrashautoreboot',
1521 0x26000025 => 'hiberboot', 1645 0x26000025 => 'hiberboot',
1522 0x26000025 => 'lastknowngood',
1523 0x26000026 => 'oslnointegritychecks',
1524 0x22000026 => 'passwordoverride', 1646 0x22000026 => 'passwordoverride',
1525 0x26000027 => 'osltestsigning',
1526 0x22000027 => 'pinpassphraseoverride', 1647 0x22000027 => 'pinpassphraseoverride',
1527 0x26000028 => 'processcustomactionsfirst', 1648 0x26000028 => 'processcustomactionsfirst',
1528 0x27000030 => 'customactions', 1649 0x27000030 => 'customactions',
1529 0x26000030 => 'nolowmem',
1530 0x26000031 => 'persistbootsequence', 1650 0x26000031 => 'persistbootsequence',
1531 0x25000031 => 'removememory',
1532 0x25000032 => 'increaseuserva',
1533 0x26000032 => 'skipstartupsequence', 1651 0x26000032 => 'skipstartupsequence',
1534 0x25000033 => 'perfmem',
1535 0x22000040 => 'fverecoveryurl', 1652 0x22000040 => 'fverecoveryurl',
1536 0x26000040 => 'vga',
1537 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',
1538 0x26000041 => 'quietboot', 1706 0x26000041 => 'quietboot',
1539 0x26000042 => 'novesa', 1707 0x26000042 => 'novesa',
1540 0x26000043 => 'novga', 1708 0x26000043 => 'novga',
1541 0x25000050 => 'clustermodeaddressing', 1709 0x25000050 => 'clustermodeaddressing',
1542 0x26000051 => 'usephysicaldestination', 1710 0x26000051 => 'usephysicaldestination',
1543 0x25000052 => 'restrictapiccluster', 1711 0x25000052 => 'restrictapiccluster',
1544 0x22000053 => 'evstore', 1712 0x22000053 => 'evstore',
1545 0x26000054 => 'uselegacyapicmode', 1713 0x26000054 => 'uselegacyapicmode',
1546 0x26000060 => 'onecpu', 1714 0x26000060 => 'onecpu',
1547 0x25000061 => 'numproc', 1715 0x25000061 => 'numproc',
1548 0x26000062 => 'maxproc', 1716 0x26000062 => 'maxproc',
1549 0x25000063 => 'configflags', 1717 0x25000063 => 'configflags',
1550 0x26000064 => 'maxgroup', 1718 0x26000064 => 'maxgroup',
1551 0x26000065 => 'groupaware', 1719 0x26000065 => 'groupaware',
1552 0x25000066 => 'groupsize', 1720 0x25000066 => 'groupsize',
1553 0x26000070 => 'usefirmwarepcisettings', 1721 0x26000070 => 'usefirmwarepcisettings',
1554 0x25000071 => 'msi', 1722 0x25000071 => 'msi',
1555 0x25000072 => 'pciexpress', 1723 0x25000072 => 'pciexpress',
1556 0x25000080 => 'safeboot', 1724 0x25000080 => 'safeboot',
1557 0x26000081 => 'safebootalternateshell', 1725 0x26000081 => 'safebootalternateshell',
1558 0x26000090 => 'bootlog', 1726 0x26000090 => 'bootlog',
1559 0x26000091 => 'sos', 1727 0x26000091 => 'sos',
1560 0x260000a0 => 'debug', 1728 0x260000a0 => 'debug',
1561 0x260000a1 => 'halbreakpoint', 1729 0x260000a1 => 'halbreakpoint',
1562 0x260000a2 => 'useplatformclock', 1730 0x260000a2 => 'useplatformclock',
1563 0x260000a3 => 'forcelegacyplatform', 1731 0x260000a3 => 'forcelegacyplatform',
1564 0x260000a4 => 'useplatformtick', 1732 0x260000a4 => 'useplatformtick',
1565 0x260000a5 => 'disabledynamictick', 1733 0x260000a5 => 'disabledynamictick',
1566 0x250000a6 => 'tscsyncpolicy', 1734 0x250000a6 => 'tscsyncpolicy',
1567 0x260000b0 => 'ems', 1735 0x260000b0 => 'ems',
1568 0x250000c0 => 'forcefailure', 1736 0x250000c0 => 'forcefailure',
1569 0x250000c1 => 'driverloadfailurepolicy', 1737 0x250000c1 => 'driverloadfailurepolicy',
1570 0x250000c2 => 'bootmenupolicy', 1738 0x250000c2 => 'bootmenupolicy',
1571 0x260000c3 => 'onetimeadvancedoptions', 1739 0x260000c3 => 'onetimeadvancedoptions',
1572 0x260000c4 => 'onetimeoptionsedit', 1740 0x260000c4 => 'onetimeoptionsedit',
1573 0x250000e0 => 'bootstatuspolicy', 1741 0x250000e0 => 'bootstatuspolicy',
1574 0x260000e1 => 'disableelamdrivers', 1742 0x260000e1 => 'disableelamdrivers',
1575 0x250000f0 => 'hypervisorlaunchtype', 1743 0x250000f0 => 'hypervisorlaunchtype',
1576 0x220000f1 => 'hypervisorpath', 1744 0x220000f1 => 'hypervisorpath',
1577 0x260000f2 => 'hypervisordebug', 1745 0x260000f2 => 'hypervisordebug',
1578 0x250000f3 => 'hypervisordebugtype', 1746 0x250000f3 => 'hypervisordebugtype',
1579 0x250000f4 => 'hypervisordebugport', 1747 0x250000f4 => 'hypervisordebugport',
1580 0x250000f5 => 'hypervisorbaudrate', 1748 0x250000f5 => 'hypervisorbaudrate',
1581 0x250000f6 => 'hypervisorchannel', 1749 0x250000f6 => 'hypervisorchannel',
1582 0x250000f7 => 'bootux', 1750 0x250000f7 => 'bootux',
1583 0x260000f8 => 'hypervisordisableslat', 1751 0x260000f8 => 'hypervisordisableslat',
1584 0x220000f9 => 'hypervisorbusparams', 1752 0x220000f9 => 'hypervisorbusparams',
1585 0x250000fa => 'hypervisornumproc', 1753 0x250000fa => 'hypervisornumproc',
1586 0x250000fb => 'hypervisorrootprocpernode', 1754 0x250000fb => 'hypervisorrootprocpernode',
1587 0x260000fc => 'hypervisoruselargevtlb', 1755 0x260000fc => 'hypervisoruselargevtlb',
1588 0x250000fd => 'hypervisorhostip', 1756 0x250000fd => 'hypervisorhostip',
1589 0x250000fe => 'hypervisorhostport', 1757 0x250000fe => 'hypervisorhostport',
1590 0x250000ff => 'hypervisordebugpages', 1758 0x250000ff => 'hypervisordebugpages',
1591 0x25000100 => 'tpmbootentropy', 1759 0x25000100 => 'tpmbootentropy',
1592 0x22000110 => 'hypervisorusekey', 1760 0x22000110 => 'hypervisorusekey',
1593 0x22000112 => 'hypervisorproductskutype', 1761 0x22000112 => 'hypervisorproductskutype',
1594 0x25000113 => 'hypervisorrootproc', 1762 0x25000113 => 'hypervisorrootproc',
1595 0x26000114 => 'hypervisordhcp', 1763 0x26000114 => 'hypervisordhcp',
1596 0x25000115 => 'hypervisoriommupolicy', 1764 0x25000115 => 'hypervisoriommupolicy',
1597 0x26000116 => 'hypervisorusevapic', 1765 0x26000116 => 'hypervisorusevapic',
1598 0x22000117 => 'hypervisorloadoptions', 1766 0x22000117 => 'hypervisorloadoptions',
1599 0x25000118 => 'hypervisormsrfilterpolicy', 1767 0x25000118 => 'hypervisormsrfilterpolicy',
1600 0x25000119 => 'hypervisormmionxpolicy', 1768 0x25000119 => 'hypervisormmionxpolicy',
1601 0x2500011a => 'hypervisorschedulertype', 1769 0x2500011a => 'hypervisorschedulertype',
1602 0x25000120 => 'xsavepolicy', 1770 0x25000120 => 'xsavepolicy',
1603 0x25000121 => 'xsaveaddfeature0', 1771 0x25000121 => 'xsaveaddfeature0',
1604 0x25000122 => 'xsaveaddfeature1', 1772 0x25000122 => 'xsaveaddfeature1',
1605 0x25000123 => 'xsaveaddfeature2', 1773 0x25000123 => 'xsaveaddfeature2',
1606 0x25000124 => 'xsaveaddfeature3', 1774 0x25000124 => 'xsaveaddfeature3',
1607 0x25000125 => 'xsaveaddfeature4', 1775 0x25000125 => 'xsaveaddfeature4',
1608 0x25000126 => 'xsaveaddfeature5', 1776 0x25000126 => 'xsaveaddfeature5',
1609 0x25000127 => 'xsaveaddfeature6', 1777 0x25000127 => 'xsaveaddfeature6',
1610 0x25000128 => 'xsaveaddfeature7', 1778 0x25000128 => 'xsaveaddfeature7',
1611 0x25000129 => 'xsaveremovefeature', 1779 0x25000129 => 'xsaveremovefeature',
1612 0x2500012a => 'xsaveprocessorsmask', 1780 0x2500012a => 'xsaveprocessorsmask',
1613 0x2500012b => 'xsavedisable', 1781 0x2500012b => 'xsavedisable',
1614 0x2500012c => 'kerneldebugtype', 1782 0x2500012c => 'kerneldebugtype',
1615 0x2200012d => 'kernelbusparams', 1783 0x2200012d => 'kernelbusparams',
1616 0x2500012e => 'kerneldebugaddress', 1784 0x2500012e => 'kerneldebugaddress',
1617 0x2500012f => 'kerneldebugport', 1785 0x2500012f => 'kerneldebugport',
1618 0x25000130 => 'claimedtpmcounter', 1786 0x25000130 => 'claimedtpmcounter',
1619 0x25000131 => 'kernelchannel', 1787 0x25000131 => 'kernelchannel',
1620 0x22000132 => 'kerneltargetname', 1788 0x22000132 => 'kerneltargetname',
1621 0x25000133 => 'kernelhostip', 1789 0x25000133 => 'kernelhostip',
1622 0x25000134 => 'kernelport', 1790 0x25000134 => 'kernelport',
1623 0x26000135 => 'kerneldhcp', 1791 0x26000135 => 'kerneldhcp',
1624 0x22000136 => 'kernelkey', 1792 0x22000136 => 'kernelkey',
1625 0x22000137 => 'imchivename', 1793 0x22000137 => 'imchivename',
1626 0x21000138 => 'imcdevice', 1794 0x21000138 => 'imcdevice',
1627 0x25000139 => 'kernelbaudrate', 1795 0x25000139 => 'kernelbaudrate',
1628 0x22000140 => 'mfgmode', 1796 0x22000140 => 'mfgmode',
1629 0x26000141 => 'event', 1797 0x26000141 => 'event',
1630 0x25000142 => 'vsmlaunchtype', 1798 0x25000142 => 'vsmlaunchtype',
1631 0x25000144 => 'hypervisorenforcedcodeintegrity', 1799 0x25000144 => 'hypervisorenforcedcodeintegrity',
1632 0x26000145 => 'enablebootdebugpolicy',
1633 0x26000146 => 'enablebootorderclean',
1634 0x26000147 => 'enabledeviceid',
1635 0x26000148 => 'enableffuloader',
1636 0x26000149 => 'enableiuloader',
1637 0x2600014a => 'enablemassstorage',
1638 0x2600014b => 'enablerpmbprovisioning',
1639 0x2600014c => 'enablesecurebootpolicy',
1640 0x2600014d => 'enablestartcharge',
1641 0x2600014e => 'enableresettpm',
1642 0x21000150 => 'systemdatadevice', 1800 0x21000150 => 'systemdatadevice',
1643 0x21000151 => 'osarcdevice', 1801 0x21000151 => 'osarcdevice',
1644 0x21000153 => 'osdatadevice', 1802 0x21000153 => 'osdatadevice',
1645 0x21000154 => 'bspdevice', 1803 0x21000154 => 'bspdevice',
1646 0x21000155 => 'bspfilepath', 1804 0x21000155 => 'bspfilepath',
1647 0x26000202 => 'skipffumode', 1805 },
1648 0x26000203 => 'forceffumode', 1806 resume => {
1649 0x25000510 => 'chargethreshold',
1650 0x26000512 => 'offmodecharging',
1651 0x25000aaa => 'bootflow',
1652 0x35000001 => 'ramdiskimageoffset',
1653 0x35000002 => 'ramdisktftpclientport',
1654 0x31000003 => 'ramdisksdidevice',
1655 0x32000004 => 'ramdisksdipath',
1656 0x35000005 => 'ramdiskimagelength',
1657 0x36000006 => 'exportascd',
1658 0x35000007 => 'ramdisktftpblocksize',
1659 0x35000008 => 'ramdisktftpwindowsize',
1660 0x36000009 => 'ramdiskmcenabled',
1661 0x3600000a => 'ramdiskmctftpfallback',
1662 0x3600000b => 'ramdisktftpvarwindow',
1663 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',
1664 0x42000002 => 'applicationrelativepath', 1819 0x22000002 => 'applicationname',
1665 0x42000003 => 'ramdiskdevicerelativepath', 1820 },
1666 0x46000004 => 'omitosloaderelements',
1667 0x47000006 => 'elementstomigrate',
1668 0x46000010 => 'recoveryos',
1669); 1821);
1670 1822
1671our %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);
1672 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
1673sub 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
1674 $bcde{$_[0]} // sprintf "custom:%08x", $_[0] 1864 sprintf "custom:%08x", $_[0]
1675} 1865}
1676 1866
1867# encodes (elem as name, type)
1677sub enc_bcde_id($) { 1868sub enc_bcde_id($$) {
1678 $_[0] =~ /^custom:([0-9a-fA-F]{8}$)/ 1869 $_[0] =~ /^custom:(?:0x)?([0-9a-fA-F]{8}$)/
1679 ? hex $1 1870 and return hex $1;
1680 : $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
1681} 1881}
1682 1882
1683# decode/encode bcd device element - the horror, no documentaion 1883# decode/encode bcd device element - the horror, no documentaion
1684# whatsoever, supercomplex, superinconsistent. 1884# whatsoever, supercomplex, superinconsistent.
1685 1885
1688our @part_type = qw(gpt mbr raw); 1888our @part_type = qw(gpt mbr raw);
1689 1889
1690our $NULL_DEVICE = "\x00" x 16; 1890our $NULL_DEVICE = "\x00" x 16;
1691 1891
1692# biggest bitch to decode, ever 1892# biggest bitch to decode, ever
1693# this decoded a device portion after the GUID 1893# this decodes a device portion after the GUID
1694sub dec_device_($); 1894sub dec_device_($$);
1695sub dec_device_($) { 1895sub dec_device_($$) {
1696 my ($device) = @_; 1896 my ($device, $type) = @_;
1697 1897
1698 my $res; 1898 my $res;
1699 1899
1700 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, "";
1701 1901
1746 1946
1747 my $partid = $parttype eq "gpt" ? dec_guid $partdata 1947 my $partid = $parttype eq "gpt" ? dec_guid $partdata
1748 : $type eq "partition" ? unpack "Q<", $partdata # byte offset to partition start 1948 : $type eq "partition" ? unpack "Q<", $partdata # byte offset to partition start
1749 : unpack "L<", $partdata; # partition number, one-based 1949 : unpack "L<", $partdata; # partition number, one-based
1750 1950
1751 (my $parent, $device) = dec_device_ $device; 1951 (my $parent, $device) = dec_device_ $device, $type;
1752 1952
1753 $res .= "="; 1953 $res .= "=";
1754 $res .= "<$parent>"; 1954 $res .= "<$parent>";
1755 $res .= ",$blocktype,$parttype,$diskid,$partid"; 1955 $res .= ",$blocktype,$parttype,$diskid,$partid";
1756 1956
1776 or die "unsupported file descriptor version '$fver'\n"; 1976 or die "unsupported file descriptor version '$fver'\n";
1777 1977
1778 $ftype == 5 1978 $ftype == 5
1779 or die "unsupported file descriptor path type '$type'\n"; 1979 or die "unsupported file descriptor path type '$type'\n";
1780 1980
1781 (my $parent, $path) = dec_device_ $path; 1981 (my $parent, $path) = dec_device_ $path, $type;
1782 1982
1783 $path = $dec_path->($path, "file device without path"); 1983 $path = $dec_path->($path, "file device without path");
1784 1984
1785 ($parent, $path) 1985 ($parent, $path)
1786 }; 1986 };
1792 1992
1793 } elsif ($blocktype eq "vhd") { 1993 } elsif ($blocktype eq "vhd") {
1794 $device =~ s/^\x00{20}//s 1994 $device =~ s/^\x00{20}//s
1795 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";
1796 1996
1797 (my $parent, $device) = dec_device_ $device; 1997 (my $parent, $device) = dec_device_ $device, $type;
1798 1998
1799 $res .= "=vhd,<$parent>"; 1999 $res .= "=vhd,<$parent>";
1800 2000
1801 } elsif ($blocktype eq "ramdisk") { 2001 } elsif ($blocktype eq "ramdisk") {
1802 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, "";
1815 my ($mode, $elem, $parent) = unpack "VVV", substr $device, 0, 4 * 3, ""; 2015 my ($mode, $elem, $parent) = unpack "VVV", substr $device, 0, 4 * 3, "";
1816 2016
1817 if ($parent) { 2017 if ($parent) {
1818 # 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
1819 $parent = substr $device, $parent - 4 * 3 - 4 * 4, 1e9, ""; 2019 $parent = substr $device, $parent - 4 * 3 - 4 * 4, 1e9, "";
1820 ($parent, my $tail) = dec_device_ $parent; 2020 ($parent, my $tail) = dec_device_ $parent, $type;
1821 0 == length $tail 2021 0 == length $tail
1822 or die "trailing data after locate device parent\n"; 2022 or die "trailing data after locate device parent\n";
1823 } else { 2023 } else {
1824 $parent = "null"; 2024 $parent = "null";
1825 } 2025 }
1831 2031
1832 if ($mode == 0) { # "Element" 2032 if ($mode == 0) { # "Element"
1833 !length $path 2033 !length $path
1834 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";
1835 2035
1836 $elem = dec_bcde_id $elem; 2036 $elem = dec_bcde_id $elem, $type;
1837 $res .= "element,$elem"; 2037 $res .= "element,$elem";
1838 2038
1839 } elsif ($mode == 1) { # "String" 2039 } elsif ($mode == 1) { # "String"
1840 !$elem 2040 !$elem
1841 or die "device locate mode 1 having non-zero element\n"; 2041 or die "device locate mode 1 having non-zero element\n";
1866 2066
1867 ($res, $tail) 2067 ($res, $tail)
1868} 2068}
1869 2069
1870# decode a full binary BCD device descriptor 2070# decode a full binary BCD device descriptor
1871sub dec_device($) { 2071sub dec_device($$) {
1872 my ($device) = @_; 2072 my ($device, $type) = @_;
1873 2073
1874 $device = pack "H*", $device; 2074 $device = pack "H*", $device;
1875 2075
1876 my $guid = dec_guid substr $device, 0, 16, ""; 2076 my $guid = dec_guid substr $device, 0, 16, "";
1877 $guid = $guid eq "00000000-0000-0000-0000-000000000000" 2077 $guid = $guid eq "00000000-0000-0000-0000-000000000000"
1878 ? "" : "{$guid}"; 2078 ? "" : "{$guid}";
1879 2079
1880 eval { 2080 eval {
1881 my ($dev, $tail) = dec_device_ $device; 2081 my ($dev, $tail) = dec_device_ $device, $type;
1882 2082
1883 $tail eq "" 2083 $tail eq ""
1884 or die "unsupported trailing data after device descriptor\n"; 2084 or die "unsupported trailing data after device descriptor\n";
1885 2085
1886 "$guid$dev" 2086 "$guid$dev"
1898 2098
1899 undef 2099 undef
1900} 2100}
1901 2101
1902# encode the device portion after the GUID 2102# encode the device portion after the GUID
1903sub enc_device_; 2103sub enc_device_($$);
1904sub enc_device_ { 2104sub enc_device_($$) {
1905 my ($device) = @_; 2105 my ($device, $type) = @_;
1906 2106
1907 my $enc_path = sub { 2107 my $enc_path = sub {
1908 my $path = shift; 2108 my $path = shift;
1909 $path =~ s/\//\\/g; 2109 $path =~ s/\//\\/g;
1910 (Encode::encode "UTF-16LE", $path) . "\x00\x00" 2110 (Encode::encode "UTF-16LE", $path) . "\x00\x00"
1928 2128
1929 my $parse_parent = sub { 2129 my $parse_parent = sub {
1930 my $parent; 2130 my $parent;
1931 2131
1932 if (s/^<//) { 2132 if (s/^<//) {
1933 ($parent, $_) = enc_device_ $_; 2133 ($parent, $_) = enc_device_ $_, $type;
1934 s/^>// 2134 s/^>//
1935 or die "$device: syntax error: parent device not followed by '>'\n"; 2135 or die "$device: syntax error: parent device not followed by '>'\n";
1936 } else { 2136 } else {
1937 $parent = $NULL_DEVICE; 2137 $parent = $NULL_DEVICE;
1938 } 2138 }
2026 2226
2027 s/^,// 2227 s/^,//
2028 or die "$_: missing comma after locate parent device\n"; 2228 or die "$_: missing comma after locate parent device\n";
2029 2229
2030 if (s/^element,//) { 2230 if (s/^element,//) {
2031 s/^([0-9a-z]+)//i 2231 s/^([0-9a-z:]+)//i
2032 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";
2033 $elem = enc_bcde_id $1; 2233 $elem = enc_bcde_id $1, $type;
2034 $mode = 0; 2234 $mode = 0;
2035 $path = $enc_path->(""); 2235 $path = $enc_path->("");
2036 2236
2037 } elsif (s/^path,//) { 2237 } elsif (s/^path,//) {
2038 $mode = 1; 2238 $mode = 1;
2105 or die "$_: malformed or missing vmbus interface instance guid\n"; 2305 or die "$_: malformed or missing vmbus interface instance guid\n";
2106 my $instance = enc_guid $1; 2306 my $instance = enc_guid $1;
2107 2307
2108 $payload = pack "a16a16x24", $type, $instance; 2308 $payload = pack "a16a16x24", $type, $instance;
2109 2309
2310# } elsif ($type eq "udp") {
2311# $payload = pack "Va16", 1, "12345678";
2312
2110 } else { 2313 } else {
2111 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";
2112 } 2315 }
2113 2316
2114 return ( 2317 return (
2117 ); 2320 );
2118 } 2321 }
2119} 2322}
2120 2323
2121# encode a full binary BCD device descriptor 2324# encode a full binary BCD device descriptor
2122sub enc_device { 2325sub enc_device($$) {
2123 my ($device) = @_; 2326 my ($device, $type) = @_;
2124 2327
2125 my $guid = "\x00" x 16; 2328 my $guid = "\x00" x 16;
2126 2329
2127 if ($device =~ s/^\{([A-Za-z0-9\-]+)\}//) { 2330 if ($device =~ s/^\{([A-Za-z0-9\-]+)\}//) {
2128 $guid = enc_guid $1 2331 $guid = enc_guid $1
2129 or die "$device: does not start with valid guid\n"; 2332 or die "$device: does not start with valid guid\n";
2130 } 2333 }
2131 2334
2132 my ($descriptor, $tail) = enc_device_ $device; 2335 my ($descriptor, $tail) = enc_device_ $device, $type;
2133 2336
2134 length $tail 2337 length $tail
2135 and die "$device: garbage after device descriptor\n"; 2338 and die "$device: garbage after device descriptor\n";
2136 2339
2137 unpack "H*", $guid . $descriptor 2340 unpack "H*", $guid . $descriptor
2152 $k = $bcd_objects{$k} // $k; 2355 $k = $bcd_objects{$k} // $k;
2153 2356
2154 my $type = $v->{Description}[0]{Type}[1]; 2357 my $type = $v->{Description}[0]{Type}[1];
2155 2358
2156 if ($type != $bcd_object_types{$k}) { 2359 if ($type != $bcd_object_types{$k}) {
2157 $type = $bcd_types{$type} // sprintf "0x%08x", $type; 2360 $kv{type} = $bcd_types{$type} // sprintf "0x%08x", $type;
2158 $kv{type} = $type;
2159 } 2361 }
2160 2362
2161 my $elems = $v->{Elements}[1]; 2363 my $elems = $v->{Elements}[1];
2162 2364
2163 while (my ($k, $v) = each %$elems) { 2365 while (my ($k, $v) = each %$elems) {
2164 my $k = hex $k; 2366 my $k = hex $k;
2165 2367
2166 my $v = $bcde_dec{$k & BCDE_FORMAT}->($v->[0]{Element}[1]); 2368 my $v = $bcde_dec{$k & BCDE_FORMAT}->($v->[0]{Element}[1], $type);
2167 my $k = dec_bcde_id $k; 2369 my $k = dec_bcde_id $k, $type;
2168 2370
2169 $kv{$k} = $v; 2371 $kv{$k} = $v;
2170 } 2372 }
2171 2373
2172 $bcd{$k} = \%kv; 2374 $bcd{$k} = \%kv;
2213 my %elem; 2415 my %elem;
2214 2416
2215 while (my ($k, $v) = each %$v) { 2417 while (my ($k, $v) = each %$v) {
2216 next if $k eq "type"; 2418 next if $k eq "type";
2217 2419
2218 $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";
2219 $elem{sprintf "%08x", $k} = [{ 2421 $elem{sprintf "%08x", $k} = [{
2220 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)]
2221 }]; 2423 }];
2222 } 2424 }
2223 2425
2239 Objects => [undef, \%objects], 2441 Objects => [undef, \%objects],
2240 }]] 2442 }]]
2241} 2443}
2242 2444
2243############################################################################# 2445#############################################################################
2446# edit instructions
2244 2447
2245sub bcd_edit_eval { 2448sub bcd_edit_eval {
2246 package pbcdedit; 2449 package pbcdedit;
2247 2450
2248 our ($PATH, $BCD, $DEFAULT); 2451 our ($PATH, $BCD, $DEFAULT);
2252} 2455}
2253 2456
2254sub bcd_edit { 2457sub bcd_edit {
2255 my ($path, $bcd, @insns) = @_; 2458 my ($path, $bcd, @insns) = @_;
2256 2459
2257 my $default = $bcd->{"{bootmgr}"}{resumeobject}; 2460 my $default = $bcd->{"{bootmgr}"}{default};
2258 2461
2259 # prepare "officially visible" variables 2462 # prepare "officially visible" variables
2260 local $pbcdedit::PATH = $path; 2463 local $pbcdedit::PATH = $path;
2261 local $pbcdedit::BCD = $bcd; 2464 local $pbcdedit::BCD = $bcd;
2262 local $pbcdedit::DEFAULT = $default; 2465 local $pbcdedit::DEFAULT = $default;
2266 2469
2267 if ($insn eq "get") { 2470 if ($insn eq "get") {
2268 my $object = shift @insns; 2471 my $object = shift @insns;
2269 my $elem = shift @insns; 2472 my $elem = shift @insns;
2270 2473
2271 $object = $default if $object eq "{default}"; 2474 $object = $object eq "{default}" ? $default : dec_wguid enc_wguid $object;
2272 2475
2273 print $bcd->{$object}{$elem}, "\n"; 2476 print $bcd->{$object}{$elem}, "\n";
2274 2477
2275 } elsif ($insn eq "set") { 2478 } elsif ($insn eq "set") {
2276 my $object = shift @insns; 2479 my $object = shift @insns;
2277 my $elem = shift @insns; 2480 my $elem = shift @insns;
2278 my $value = shift @insns; 2481 my $value = shift @insns;
2279 2482
2280 $object = $default if $object eq "{default}"; 2483 $object = $object eq "{default}" ? $default : dec_wguid enc_wguid $object;
2281 2484
2282 $bcd->{$object}{$elem} = $value; 2485 $bcd->{$object}{$elem} = $value;
2283 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
2284 } elsif ($insn eq "eval") { 2495 } elsif ($insn eq "eval") {
2285 bcd_edit_eval shift @insns; 2496 my $perl = shift @insns;
2497 bcd_edit_eval "#line 1 'eval'\n$perl";
2286 2498
2287 } elsif ($insn eq "do") { 2499 } elsif ($insn eq "do") {
2288 my $path = shift @insns; 2500 my $path = shift @insns;
2289 my $file = file_load $path; 2501 my $file = file_load $path;
2290 bcd_edit_eval "#line 1 '$path'\n$file"; 2502 bcd_edit_eval "#line 1 '$path'\n$file";
2291 2503
2292 } else { 2504 } else {
2293 die "$insn: not a recognized instruction for edit/parse\n"; 2505 die "$insn: not a recognized instruction for create/edit/parse\n";
2294 } 2506 }
2295 } 2507 }
2296 2508
2297} 2509}
2298 2510
2299############################################################################# 2511#############################################################################
2512# other utilities
2300 2513
2301# json to stdout 2514# json to stdout
2302sub prjson($) { 2515sub prjson($) {
2303 print $json_coder->encode ($_[0]); 2516 print $json_coder->encode ($_[0]);
2304} 2517}
2308 my $json; 2521 my $json;
2309 1 while read STDIN, $json, 65536, length $json; 2522 1 while read STDIN, $json, 65536, length $json;
2310 $json_coder->decode ($json) 2523 $json_coder->decode ($json)
2311} 2524}
2312 2525
2313# 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
2314our %CMD = ( 2575our %CMD = (
2315 help => sub { 2576 help => sub {
2316 require Pod::Usage; 2577 require Pod::Usage;
2317 Pod::Usage::pod2usage (-verbose => 2); 2578 Pod::Usage::pod2usage (-verbose => 2, -quotes => "none", -noperldoc => 1);
2318 }, 2579 },
2319 2580
2320 objects => sub { 2581 objects => sub {
2321 my %rbcd_types = reverse %bcd_types; 2582 my %rbcd_types = reverse %bcd_types;
2322 $_ = sprintf "%08x", $_ for values %rbcd_types; 2583 $_ = sprintf "%08x", $_ for values %rbcd_types;
2343 2604
2344 print "\n"; 2605 print "\n";
2345 2606
2346 printf "%-39s %-23s %s\n", "Object GUID", "Alias", "(Hex) Default Type"; 2607 printf "%-39s %-23s %s\n", "Object GUID", "Alias", "(Hex) Default Type";
2347 for my $name (sort keys %rbcd_objects) { 2608 for my $name (sort keys %rbcd_objects) {
2348 my $guid = $rbcd_objects{$name}; 2609 my $guid = $rbcd_objects{$name};
2349 my $type = $bcd_object_types{$name}; 2610 my $type = $bcd_object_types{$name};
2350 my $tname = $bcd_types{$type}; 2611 my $tname = $bcd_types{$type};
2351 2612
2352 $type = $type ? sprintf "(%08x) %s", $type, $tname : "-"; 2613 $type = $type ? sprintf "(%08x) %s", $type, $tname : "-";
2353 2614
2354 printf "%-39s %-23s %s\n", $guid, $name, $type; 2615 printf "%-39s %-23s %s\n", $guid, $name, $type;
2368 BCDE_FORMAT_GUID_LIST , "guid list", 2629 BCDE_FORMAT_GUID_LIST , "guid list",
2369 BCDE_FORMAT_INTEGER , "integer", 2630 BCDE_FORMAT_INTEGER , "integer",
2370 BCDE_FORMAT_BOOLEAN , "boolean", 2631 BCDE_FORMAT_BOOLEAN , "boolean",
2371 BCDE_FORMAT_INTEGER_LIST, "integer list", 2632 BCDE_FORMAT_INTEGER_LIST, "integer list",
2372 ); 2633 );
2373 my %rbcde = reverse %bcde;
2374 $_ = sprintf "%08x", $_ for values %rbcde;
2375 2634
2376 my %element; 2635 my @element;
2377 2636
2637 for my $class (sort keys %rbcde_byclass) {
2638 my $rbcde = $rbcde_byclass{$class};
2639
2378 unless ($json) { 2640 unless ($json) {
2379 print "\n"; 2641 print "\n";
2642 printf "Elements applicable to class(es): $class\n";
2380 printf "%-9s %-12s %s\n", "Element", "Format", "Name Alias"; 2643 printf "%-9s %-12s %s\n", "Element", "Format", "Name Alias";
2381 } 2644 }
2382 for my $name (sort keys %rbcde) { 2645 for my $name (sort keys %$rbcde) {
2383 my $id = $rbcde{$name}; 2646 my $id = $rbcde->{$name};
2384 my $format = $format_name{(hex $id) & BCDE_FORMAT}; 2647 my $format = $format_name{$id & BCDE_FORMAT};
2385 2648
2386 if ($json) { 2649 if ($json) {
2387 $element{$id} = [$format, $name]; 2650 push @element, [$class, $id * 1, $format, $name];
2388 } else { 2651 } else {
2652 $id = sprintf "%08x", $id;
2389 printf "%-9s %-12s %s\n", $id, $format, $name; 2653 printf "%-9s %-12s %s\n", $id, $format, $name;
2654 }
2390 } 2655 }
2391 } 2656 }
2392 print "\n" unless $json; 2657 print "\n" unless $json;
2393 2658
2394 prjson { 2659 prjson {
2395 version => $JSON_VERSION, 2660 version => $JSON_VERSION,
2396 element => \%element, 2661 element => \@element,
2662 class => \@bcde_typeclass,
2397 } if $json; 2663 } if $json;
2398 2664
2399 }, 2665 },
2400 2666
2401 export => sub { 2667 export => sub {
2404 2670
2405 import => sub { 2671 import => sub {
2406 regf_save shift, bcd_encode rdjson; 2672 regf_save shift, bcd_encode rdjson;
2407 }, 2673 },
2408 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
2409 edit => sub { 2684 edit => sub {
2410 my $path = shift; 2685 my $path = shift;
2686 my $stat = stat_get $path; # should actually be done at file load time
2411 my $bcd = bcd_decode regf_load $path; 2687 my $bcd = bcd_decode regf_load $path;
2412 bcd_edit $path, $bcd, @_; 2688 bcd_edit $path, $bcd, @_;
2413 regf_save $path, bcd_encode $bcd; 2689 regf_save $path, bcd_encode $bcd;
2690 stat_set $path, $stat;
2414 }, 2691 },
2415 2692
2416 parse => sub { 2693 parse => sub {
2417 my $path = shift; 2694 my $path = shift;
2418 my $bcd = bcd_decode regf_load $path; 2695 my $bcd = bcd_decode regf_load $path;
2427 "import-regf" => sub { 2704 "import-regf" => sub {
2428 regf_save shift, rdjson; 2705 regf_save shift, rdjson;
2429 }, 2706 },
2430 2707
2431 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 {
2432 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";
2433 2717 for my $dev (@$lsblk) {
2434 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}) {
2435
2436 for my $dev (@{ $lsblk->{blockdevices} }) {
2437 my $pr = sub {
2438 printf "%-10s %-8.8s %-6.6s %-3s %s\n", 2719 printf "%-10s %-8.8s %-6.6s %-3s %s\n",
2439 $dev->{path}, $dev->{label}, $dev->{fstype}, $dev->{pttype}, $_[0]; 2720 $dev->{path}, $dev->{label}, $dev->{fstype}, $dev->{pttype}, $bcd
2440 };
2441
2442 if ($dev->{type} eq "part") {
2443 if ($dev->{pttype} eq "gpt") {
2444 $pr->("partition=<null>,harddisk,gpt,$dev->{ptuuid},$dev->{partuuid}");
2445 } elsif ($dev->{pttype} eq "dos") { # why not "mbr" :(
2446 if ($dev->{partuuid} =~ /^([0-9a-f]{8})-([0-9a-f]{2})\z/i) {
2447 my ($diskid, $partno) = ($1, hex $2);
2448 $pr->("legacypartition=<null>,harddisk,mbr,$diskid,$partno");
2449 if (open my $fh, "/sys/class/block/$dev->{kname}/start") {
2450 my $start = 512 * readline $fh;
2451 $pr->("partition=<null>,harddisk,mbr,$diskid,$start");
2452 } 2721 if $bcd;
2453 }
2454 } 2722 }
2455 } 2723 }
2456 } 2724 }
2457 }, 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 },
2458); 2744);
2459 2745
2460my $cmd = shift; 2746my $cmd = shift;
2461 2747
2462unless (exists $CMD{$cmd}) { 2748unless (exists $CMD{$cmd}) {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines