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

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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines