ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/pbcdedit/pbcdedit

Comparing pbcdedit/pbcdedit (file contents):
Revision 1.9 by root, Wed Aug 14 22:54:28 2019 UTC vs.
Revision 1.58 by root, Thu Aug 22 09:09:12 2019 UTC

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

Diff Legend

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