ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/pbcdedit/pbcdedit

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

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines