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.56 by root, Thu Aug 22 08:49:05 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",
…		…
242	=head2 The C<meta> key	310	=head2 The C<meta> key
243		311
244	The C<meta> key is not stored in the BCD data store but is used only	312	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	313	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	314	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	315	the JSON schema version of PBCDEDIT. This ensures that different and
248	incompatible versions of PBCDEDIT will not read and misinterüret each	316	incompatible versions of PBCDEDIT will not read and misinterpret each
249	others data.	317	others data.
250		318
251	=head2 The object keys	319	=head2 The object keys
252		320
253	Every other key is a BCD object. There is usually a BCD object for the	321	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	322	boot manager, one for every boot option and a few others that store common
255	settings inherited by these.	323	settings inherited by these.
256		324
257	Each BCD object is represented by a GUID wrapped in curly braces. These	325	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	326	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.	327	other. When adding a new boot option, you can simply generate a new GUID.
260		328
261	Some of these GUIDs are fixed well known GUIDs which PBCDEDIT will decode	329	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	330	into human-readable strings such as C<{globalsettings}>, which is the same
263	as C<{7ea2e1ac-2e61-4728-aaa3-896d9d0a9f0e}>.	331	as C<{7ea2e1ac-2e61-4728-aaa3-896d9d0a9f0e}>.
…		…
297	get a list of all BCD elements known to PBCDEDIT by running F<pbcdedit	365	get a list of all BCD elements known to PBCDEDIT by running F<pbcdedit
298	elements>.	366	elements>.
299		367
300	What was said about duplicate keys mapping to the same object is true for	368	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,	369	elements as well, so, again, you should always use the canonical name,
302	whcih is the human radable alias, if known.	370	which is the human readable alias, if known.
303		371
304	=head3 BCD element types	372	=head3 BCD element types
305		373
306	Each BCD element has a type such as I<string> or I<boolean>. This type	374	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	375	determines how the value is interpreted, and most of them are pretty easy
…		…
319	"description" : "Windows 10",	387	"description" : "Windows 10",
320	"systemroot" : "\\Windows",	388	"systemroot" : "\\Windows",
321		389
322	=item boolean	390	=item boolean
323		391
324	Almost as simnple are booleans, which represent I<true>/I<false>,	392	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	393	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	394	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	395	values will be accepted, but PBCDEDIT doesn't guarantee how these are
328	interpreted.	396	interpreted.
329		397
…		…
333		401
334	"displaybootmenu" : 0,	402	"displaybootmenu" : 0,
335		403
336	=item integer	404	=item integer
337		405
338	Again, very simple, this is a 64 bit integer. IT can be either specified	406	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	407	as a decimal number, as a hex number (by prefixing it with C<0x>) or as a
340	binatry number (prefix C<0b>).	408	binary number (prefix C<0b>).
341		409
342	For example, the boot C<timeout> is an integer, specifying the automatic	410	For example, the boot C<timeout> is an integer, specifying the automatic
343	boot delay in seconds:	411	boot delay in seconds:
344		412
345	"timeout" : 30,	413	"timeout" : 30,
346		414
347	=item integer list	415	=item integer list
348		416
349	This is a list of 64 bit integers separated by whitespace. It is not used	417	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	418	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	419	C<customactions> to specify a certain custom, eh, action to be executed
352	when pressing C<F10> at boot:	420	when pressing C<F10> at boot:
353		421
354	"customactions" : "0x1000044000001 0x54000001",	422	"customactions" : "0x1000044000001 0x54000001",
355		423
356	=item guid	424	=item guid
357		425
358	This represents a single GUID value wrqapped in curly braces. It is used a	426	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.	427	lot to refer from one BCD object to other one.
360		428
361	For example, The C<{bootmgr}> object might refer to a resume boot option	429	For example, The C<{bootmgr}> object might refer to a resume boot option
362	using C<resumeobject>:	430	using C<default>:
363		431
364	"resumeobject" : "{7ae02178-821d-11e7-8813-1c872c5f5ab0}",	432	"default" : "{7ae02178-821d-11e7-8813-1c872c5f5ab0}",
365		433
366	Human readable aliases are used and allowed.	434	Human readable aliases are used and allowed.
367		435
368	=item guid list	436	=item guid list
369		437
370	Similar to te guid type, this represents a list of such GUIDs, separated	438	Similar to the GUID type, this represents a list of such GUIDs, separated
371	by whitespace from each other.	439	by whitespace from each other.
372		440
373	For example, many BCD objects can I<inherit> elements from other BCD	441	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	442	objects by specifying the GUIDs of those other objects in a GUID list
375	called surprisingly called C<inherit>:	443	called surprisingly called C<inherit>:
376		444
377	"inherit" : "{dbgsettings} {emssettings} {badmemory}",	445	"inherit" : "{dbgsettings} {emssettings} {badmemory}",
378		446
379	This example also shows how human readable aliases can be used.	447	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	451	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	452	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	453	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	454	PBCDEDIT, and because it is so complex, this type has its own subsection
387	below.	455	below.
		456
388	=back	457	=back
389		458
390	=head4 The BCD "device" element type	459	=head3 The BCD "device" element type
391		460
392	Device elements specify, well, devices. They are used for such diverse	461	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	462	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,	463	devices, but most commonly they are used to specify the disk (harddisk,
395	cdrom ramdisk, vhd...) to boot from.	464	cdrom, ramdisk, vhd...) to boot from.
396		465
397	The device element is kind of a mini-language in its own which is much	466	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 -	467	more versatile then the limited windows interface to it - BCDEDIT -
399	reveals.	468	reveals.
400		469
…		…
403	element, so almost everything known about it had to be researched first	472	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	473	in the process of writing this script, and consequently, support for BCD
405	device elements is partial only.	474	device elements is partial only.
406		475
407	On the other hand, the expressive power of PBCDEDIT in specifying devices	476	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	477	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	478	downside is that BCD device elements are much more complicated than what
410	you might think from reading the BCDEDIT documentation.	479	you might think from reading the BCDEDIT documentation.
411		480
412	In other words, simple things are complicated, and complicated things are	481	In other words, simple things are complicated, and complicated things are
413	possible.	482	possible.
414		483
415	Anyway, the general syntax of device elements is an optional GUID,	484	Anyway, the general syntax of device elements is an optional GUID,
416	followed by a device type, optionally followed by hexdecimal flags in	485	followed by a device type, optionally followed by hexadecimal flags in
417	angle brackets, optionally followed by C<=> and a comma-separated list of	486	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.	487	arguments, some of which can be (and often are) in turn devices again.
419		488
420	[{GUID}]type[<flags>][=arg,arg...]	489	[{GUID}]type[<flags>][=arg,arg...]
421		490
…		…
447	The types understood and used by PBCDEDIT are as follows (keep in mind	516	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):	517	that not of all the following is necessarily supported in PBCDEDIT):
449		518
450	=over	519	=over
451		520
452	=item binary=hex...	521	=item C<binary=>I<hex...>
453		522
454	This type isn't actually a real BCD element type, but a fallback for those	523	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	524	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	525	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.	526	convert the device into this type with a hexdump of the element data.
458		527
459	=item null	528	=item C<null>
460		529
461	This is another special type - sometimes, a device all zero-filled, which	530	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	531	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	532	PBCDEDIT does not understand, so it decodes it into this special "all
464	called C<null>.	533	zero" type called C<null>.
465		534
466	It's most commonly found in devices that can use an optional parent	535	It's most commonly found in devices that can use an optional parent
467	device, when no parent device is used.	536	device, when no parent device is used.
468		537
469	=item boot	538	=item C<boot>
470		539
471	Another type without parameters, this refers to the device that was booted	540	Another type without parameters, this refers to the device that was booted
472	from (nowadays typically the EFI system partition).	541	from (nowadays typically the EFI system partition).
473		542
474	=item vmbus=interfacetype,interfaceinstance	543	=item C<vmbus=>I<interfacetype>,I<interfaceinstance>
475		544
476	This specifies a VMBUS device with the given interface type and interface	545	This specifies a VMBUS device with the given interface type and interface
477	instance, both of which are "naked" (no curly braces) GUIDs.	546	instance, both of which are "naked" (no curly braces) GUIDs.
478		547
479	Made-up example (couldn't find a single example on the web):	548	Made-up example (couldn't find a single example on the web):
480		549
481	vmbus=c376c1c3-d276-48d2-90a9-c04748072c60,12345678-a234-b234-c234-d2345678abcd	550	vmbus=c376c1c3-d276-48d2-90a9-c04748072c60,12345678-a234-b234-c234-d2345678abcd
482		551
483	=item partition=<parent>,devicetype,partitiontype,diskid,partitionid	552	=item C<partition=><I<parent>>,I<devicetype>,I<partitiontype>,I<diskid>,I<partitionid>
484		553
485	This designates a specific partition on a block device. C<< <parent>	554	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	555	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.	556	that the angle brackets around I<parent> are part of the syntax.
488		557
489	C<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>,	558	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,	559	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	560	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.	561	and C<vhd> is used to treat files as virtual harddisks, i.e. F<vhd> and
		562	F<vhdx> files.
493		563
494	The C<partitiontype> is either C<mbr>, C<gpt> or C<raw>, the latter being	564	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"	565	used for devices without partitions, such as cdroms, where the "partition"
496	is usually the whole device.	566	is usually the whole device.
497		567
498	The C<diskid> identifies the disk or device using a unique signature, and	568	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	569	the same is true for the I<partitionid>. How these are interpreted depends
500	on the C<partitiontype>:	570	on the I<partitiontype>:
501		571
502	=over	572	=over
503		573
504	=item mbr	574	=item C<mbr>
505		575
506	The C<diskid> is the 32 bit disk signature stored at offset 0x1b8 in the	576	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	577	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>.	578	hex number. That is, the bytes C<01 02 03 04> would become C<04030201>.
509		579
510	Diskpart (using the C<DETAIL> command) and the C<lsblk> comamnd typically	580	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	581	found on GNU/Linux systems (using e.g. C<lsblk -o NAME,PARTUUID>) can
512	display the disk id.	582	display the I<diskid>.
513		583
514	The C<partitionid> is the byte offset(!) of the partition counting from	584	The I<partitionid> is the byte offset(!) of the partition counting from
515	the beginning of the MBR.	585	the beginning of the MBR.
516		586
517	Example, use the partition on the harddisk with C<diskid> C<47cbc08a>	587	Example, use the partition on the harddisk with I<diskid> C<47cbc08a>
518	starting at sector C<2048> (= 1048576 / 512).	588	starting at sector C<2048> (= 1048576 / 512).
519		589
520	partition=<null>,harddisk,mbr,47cbc08a,1048576	590	partition=<null>,harddisk,mbr,47cbc08a,1048576
521		591
522	=item gpt	592	=item C<gpt>
523		593
524	The C<diskid> is the disk UUID/disk identifier GUID from the partition	594	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	595	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).	596	partition unique GUID (displayed using e.g. the F<gdisk> F<i> command).
527		597
528	Example: use the partition C<76d39e5f-ad1b-407e-9c05-c81eb83b57dd> on GPT	598	Example: use the partition C<76d39e5f-ad1b-407e-9c05-c81eb83b57dd> on GPT
529	disk C<9742e468-9206-48a0-b4e4-c4e9745a356a>.	599	disk C<9742e468-9206-48a0-b4e4-c4e9745a356a>.
530		600
531	partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,76d39e5f-ad1b-407e-9c05-c81eb83b57dd	601	partition=<null>,harddisk,gpt,9742e468-9206-48a0-b4e4-c4e9745a356a,76d39e5f-ad1b-407e-9c05-c81eb83b57dd
532		602
533	=item raw	603	=item C<raw>
534		604
535	Instead of diskid and partitionid, this type only accepts a decimal disk	605	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	606	disk number and signifies the whole disk. BCDEDIT cannot display the
537	device, and I am doubtful whether it has a useful effect.	607	resulting device, and I am doubtful whether it has a useful effect.
538		608
539	=back	609	=back
540		610
541	=item legacypartition=<parent>,devicetype,partitiontype,diskid,partitionid	611	=item C<legacypartition=><I<parent>>,I<devicetype>,I<partitiontype>,I<diskid>,I<partitionid>
542		612
543	This is exactly the same as the C<partition> type, except for a tiny	613	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	614	detail: instead of using the partition start offset, this type uses the
545	partition number for MBR disks. Behaviour other partition types should be	615	partition number for MBR disks. Behaviour other partition types should be
546	the same.	616	the same.
547		617
548	The partition number starts at C<1> and skips unused partition, so if	618	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	619	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	620	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	621	partition inside the extended partition is number C<3>, regardless of any
552	gaps.	622	gaps.
553		623
554	=item locate=<parent>,locatetype,locatearg	624	=item C<locate=><I<parent>>,I<locatetype>,I<locatearg>
555		625
556	This device description will make the bootloader search for a partition	626	This device description will make the bootloader search for a partition
557	with a given path.	627	with a given path.
558		628
559	The C<< <parent> >> device is the device to search on (angle brackets are	629	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	630	still part of the syntax!) If it is C<null>, then C<locate> will
561	search all disks it can find.	631	search all disks it can find.
562		632
563	C<locatetype> is either C<element> or C<path>, and merely distinguishes	633	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>	634	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>	635	uses an element ID (either as hex or as name) as I<locatearg> and C<path>
566	uses a relative path as C<locatearg>.	636	uses a relative path as I<locatearg>.
567		637
568	Example: find any partition which has the C<magicfile.xxx> path in the	638	Example: find any partition which has the F<magicfile.xxx> path in the
569	root.	639	root.
570		640
571	locate=<null>,path,\magicfile.xxx	641	locate=<null>,path,\magicfile.xxx
572		642
573	Example: find any partition which has the path specified in the	643	Example: find any partition which has the path specified in the
574	C<systemroot> element (typically C<\Windows>).	644	C<systemroot> element (typically F<\Windows>).
575		645
576	locate=<null>,element,systemroot	646	locate=<null>,element,systemroot
577		647
578	=item block=devicetype,args...	648	=item C<block=>I<devicetype>,I<args...>
579		649
580	Last not least, the most complex type, C<block>, which... specifies block	650	Last not least, the most complex type, C<block>, which... specifies block
581	devices (which could be inside a F<vhdx> file for example).	651	devices (which could be inside a F<vhdx> file for example).
582		652
583	C<devicetypes> is one of C<harddisk>, C<floppy>, C<cdrom>, C<ramdisk>,	653	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=>.	654	C<file> or C<vhd> - the same as for C<partition=>.
585		655
586	The remaining arguments change depending on the C<devicetype>:	656	The remaining arguments change depending on the I<devicetype>:
587		657
588	=over	658	=over
589		659
590	=item block=file,<parent>,path	660	=item C<block=file>,<I<parent>>,I<path>
591		661
592	Interprets the C<< <parent> >> device (typically a partition) as a	662	Interprets the I<parent> device (typically a partition) as a
593	filesystem and specifies a file path inside.	663	filesystem and specifies a file path inside.
594		664
595	=item block=vhd,<parent>	665	=item C<block=vhd>,<I<parent>>
596		666
597	Pretty much just changes the interpretation of C<< <parent> >>, which is	667	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.	668	usually a disk image (C<block=file,...)>) to be a F<vhd> or F<vhdx> file.
599		669
600	=item block=ramdisk,<parent>,base,size,offset,path	670	=item C<block=ramdisk>,<I<parent>>,I<base>,I<size>,I<offset>,I<path>
601		671
602	Interprets the C<< <parent> >> device as RAM disk, using the (decimal)	672	Interprets the I<parent> device as RAM disk, using the (decimal)
603	base address, byte size and byte offset inside a file specified by	673	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	674	I<path>. The numbers are usually all C<0> because they can be extracted
605	from the RAM disk image or other parameters.	675	from the RAM disk image or other parameters.
606		676
607	This is most commonly used to boot C<wim> images.	677	This is most commonly used to boot C<wim> images.
608		678
609	=item block=floppy,drivenum	679	=item C<block=floppy>,I<drivenum>
610		680
611	Refers to a removable drive identified by a number. BCDEDIT cannot display	681	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.	682	the resulting device, and it is not clear what effect it will have.
613		683
614	=item block=cdrom,drivenum	684	=item C<block=cdrom>,I<drivenum>
615		685
616	Pretty much the same as C<floppy> but for CD-ROMs.	686	Pretty much the same as C<floppy> but for CD-ROMs.
617		687
618	=item anything else	688	=item anything else
619		689
620	Probably not yet implemented. Tell me of your needs...	690	Probably not yet implemented. Tell me of your needs...
621		691
622	=back	692	=back
623		693
624	=back5 Examples	694	=head4 Examples
625		695
626	This concludes the syntax overview for device elements, but probably	696	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	697	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	698	many questions, but I can walk you through some actual examples using more
629	complex aspects.	699	complex aspects.
630		700
631	=item locate=<block=vhd,<block=file,<locate=<null>,path,\disk.vhdx>,\disk.vhdx>>,element,path	701	=item C<< locate=<block=vhd,<block=file,<locate=<null>,path,\disk.vhdx>,\disk.vhdx>>,element,path >>
632		702
633	Just like with C declarations, you best treat device descriptors as	703	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:	704	instructions to find your device and work your way from the inside out:
635		705
636	locate=<null>,path,\disk.vhdx	706	locate=<null>,path,\disk.vhdx
…		…
643	Next, this takes the device locate has found and finds a file called	713	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	714	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	715	only because we find the device using the same path as finding the disk
646	image, so this is purely incidental, although quite common.	716	image, so this is purely incidental, although quite common.
647		717
648	Bext, this file will be opened as a virtual disk:	718	Next, this file will be opened as a virtual disk:
649		719
650	block=vhd,<see above>	720	block=vhd,<see above>
651		721
652	And finally, inside this disk, another C<locate> will look for a partition	722	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	723	with a path as specified in the C<path> element, which most likely will be
…		…
656	locate=<see above>,element,path	726	locate=<see above>,element,path
657		727
658	As a result, this will boot the first Windows it finds on the first	728	As a result, this will boot the first Windows it finds on the first
659	F<disk.vhdx> disk image it can find anywhere.	729	F<disk.vhdx> disk image it can find anywhere.
660		730
661	=item locate=<block=vhd,<block=file,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,\win10.vhdx>>,element,path	731	=item C<< locate=<block=vhd,<block=file,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,\win10.vhdx>>,element,path >>
662		732
663	Pretty much the same as the previous case, but witzh a bit of variance. First, look for a specific partition on	733	Pretty much the same as the previous case, but with a bit of
664	an MBR-partitioned disk:	734	variance. First, look for a specific partition on an MBR-partitioned disk:
665		735
666	partition=<null>,harddisk,mbr,47cbc08a,242643632128	736	partition=<null>,harddisk,mbr,47cbc08a,242643632128
667		737
668	Then open the file F<\win10.vhdx> on that partition:	738	Then open the file F<\win10.vhdx> on that partition:
669		739
…		…
675		745
676	And again the windows loader (or whatever is in C<path>) will be searched:	746	And again the windows loader (or whatever is in C<path>) will be searched:
677		747
678	locate=<see above>,element,path	748	locate=<see above>,element,path
679		749
680	=item {b097d2b2-bc00-11e9-8a9a-525400123456}block<1>=ramdisk,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,0,0,0,\boot.wim	750	=item C<< {b097d2b2-bc00-11e9-8a9a-525400123456}block<1>=ramdisk,<partition=<null>,harddisk,mbr,47cbc08a,242643632128>,0,0,0,\boot.wim >>
681		751
682	This is quite different. First, it starts with a GUID. This GUID belongs	752	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:	753	to a BCD object of type C<device>, which has additional parameters:
684		754
685	"{b097d2b2-bc00-11e9-8a9a-525400123456}" : {	755	"{b097d2b2-bc00-11e9-8a9a-525400123456}" : {
…		…
688	"ramdisksdidevice" : "partition=<null>,harddisk,mbr,47cbc08a,1048576",	758	"ramdisksdidevice" : "partition=<null>,harddisk,mbr,47cbc08a,1048576",
689	"ramdisksdipath" : "\boot.sdi"	759	"ramdisksdipath" : "\boot.sdi"
690	},	760	},
691		761
692	I will not go into many details, but this specifies a (presumably empty)	762	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	763	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	764	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>.	765	see, this F<.sdi> file resides on a different C<partition>.
696		766
697	Continuitn, as always, form the inside out, first this device descriptor	767	Continuing, as always, from the inside out, first this device descriptor
698	finds a specific partition:	768	finds a specific partition:
699		769
700	partition=<null>,harddisk,mbr,47cbc08a,242643632128	770	partition=<null>,harddisk,mbr,47cbc08a,242643632128
701		771
702	And then specifies a C<ramdisk> image on this partition:	772	And then specifies a C<ramdisk> image on this partition:
…		…
707	seems to be always there on this kind of entry.	777	seems to be always there on this kind of entry.
708		778
709	If you have some good examples to add here, feel free to mail me.	779	If you have some good examples to add here, feel free to mail me.
710		780
711		781
712	=head1 EDITING BCD DATA STORES	782	=head1 EDITING BCD STORES
713		783
714	The C<edit> and C<parse> subcommands allow you to read a BCD data store	784	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	785	and modify it or extract data from it. This is done by executing a series
716	of "editing instructions" which are explained here.	786	of "editing instructions" which are explained here.
717		787
718	=over	788	=over
719		789
720	=item get I<object> I<element>	790	=item C<get> I<object> I<element>
721		791
722	Reads the BCD element I<element> from the BCD object I<object> and writes	792	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	793	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	794	or a human-readable alias, or the special string C<{default}>, which will
725	refer to the default BCD object.	795	refer to the default BCD object.
726		796
727	Example: find description of the default BCD object.	797	Example: find description of the default BCD object.
728		798
729	pbcdedit parse BCD get "{default}" description	799	pbcdedit parse BCD get "{default}" description
730		800
731	=item set I<object> I<element> I<value>	801	=item C<set> I<object> I<element> I<value>
732		802
733	Similar to C<get>, but sets the element to the given I<value> instead.	803	Similar to C<get>, but sets the element to the given I<value> instead.
734		804
735	Example: change bootmgr default too	805	Example: change the bootmgr default too
736	C<{b097d2ad-bc00-11e9-8a9a-525400123456}>:	806	C<{b097d2ad-bc00-11e9-8a9a-525400123456}>:
737		807
738	pbcdedit edit BCD set "{bootmgr}" resumeobject "{b097d2ad-bc00-11e9-8a9a-525400123456}"	808	pbcdedit edit BCD set "{bootmgr}" default "{b097d2ad-bc00-11e9-8a9a-525400123456}"
739		809
740	=item eval I<perlcode>	810	=item C<eval> I<perlcode>
741		811
742	This takes the next argument, interprets it as Perl code and	812	This takes the next argument, interprets it as Perl code and
743	evaluates it. This allows you to do more complicated modifications or	813	evaluates it. This allows you to do more complicated modifications or
744	extractions.	814	extractions.
745		815
…		…
764	The example given for C<get>, above, could be expressed like this with	834	The example given for C<get>, above, could be expressed like this with
765	C<eval>:	835	C<eval>:
766		836
767	pbcdedit edit BCD eval 'say $BCD->{$DEFAULT}{description}'	837	pbcdedit edit BCD eval 'say $BCD->{$DEFAULT}{description}'
768		838
769	The example given for C<set> could be expresed like this:	839	The example given for C<set> could be expressed like this:
770		840
771	pbcdedit edit BCD eval '$BCD->{$DEFAULT}{resumeobject} = "{b097d2ad-bc00-11e9-8a9a-525400123456}"'	841	pbcdedit edit BCD eval '$BCD->{"{bootmgr}"{default} = "{b097d2ad-bc00-11e9-8a9a-525400123456}"'
772		842
773	=item do I<path>	843	=item C<do> I<path>
774		844
775	Similar to C<eval>, above, but instead of using the argument as perl code,	845	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	846	it loads the perl code from the given file and executes it. This makes it
777	easier to write more complicated or larger programs.	847	easier to write more complicated or larger programs.
778		848
779	=back	849	=back
780		850
		851
781	=head1 SEE ALSO	852	=head1 SEE ALSO
782		853
783	For ideas on what you can do, and some introductory material, try	854	For ideas on what you can do with BCD stores in
		855	general, and some introductory material, try
784	L<http://www.mistyprojects.co.uk/documents/BCDEdit/index.html>.	856	L<http://www.mistyprojects.co.uk/documents/BCDEdit/index.html>.
785		857
786	For good reference on BCD objects and elements, see Geoff Chappels pages	858	For good reference on which BCD objects and
		859	elements exist, see Geoff Chappell's pages at
787	at L<http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm>.	860	L<http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm>.
788		861
789	=head1 AUTHOR	862	=head1 AUTHOR
790		863
791	Written by Marc A. Lehmann <pbcdedit@schmorp.de>.	864	Written by Marc A. Lehmann L<pbcdedit@schmorp.de>.
792		865
793	=head1 REPORTING BUGS	866	=head1 REPORTING BUGS
794		867
795	Bugs can be reported dorectly tt he author at L<pcbedit@schmorp.de>.	868	Bugs can be reported directly the author at L<pcbedit@schmorp.de>.
796		869
797	=head1 BUGS AND SHORTCOMINGS	870	=head1 BUGS AND SHORTCOMINGS
798		871
799	This should be a module. Of a series of modules, even.	872	This should be a module. Of a series of modules, even.
800		873
801	Registry code should preserve classname and security descriptor data, and	874	Registry code should preserve classname and security descriptor data, and
802	whatever else is necessary to read and write any registry hive file.	875	whatever else is necessary to read and write any registry hive file.
803		876
804	I am also not happy with device descriptors being strings rather than a	877	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	878	data structure, but strings are probably better for command line usage. In
806	any case,. device descriptors could be converted by simply "splitting" at	879	any case, device descriptors could be converted by simply "splitting" at
807	"=" and "," into an array reference, recursively.	880	"=" and "," into an array reference, recursively.
808		881
809	=head1 HOMEPAGE	882	=head1 HOMEPAGE
810		883
811	Original versions of this program can be found at	884	Original versions of this program can be found at
…		…
818	free to change and redistribute it. There is NO WARRANTY, to the extent	891	free to change and redistribute it. There is NO WARRANTY, to the extent
819	permitted by law.	892	permitted by law.
820		893
821	=cut	894	=cut
822		895
823	BEGIN { require "common/sense.pm"; common::sense->import } # common sense is optional, but recommended	896	# common sense is optional, but recommended
		897	BEGIN { eval { require "common/sense.pm"; } && common::sense->import }
824		898
825	use Data::Dump;	899	no warnings 'portable'; # avoid 32 bit integer warnings
		900
826	use Encode ();	901	use Encode ();
827	use List::Util ();	902	use List::Util ();
828	use IO::Handle ();	903	use IO::Handle ();
829	use Time::HiRes ();	904	use Time::HiRes ();
830		905
…		…
839		914
840	# hack used for debugging	915	# hack used for debugging
841	sub xxd($$) {	916	sub xxd($$) {
842	open my $xxd, "| xxd | sed -e 's/^/\Q$_[0]\E: /'";	917	open my $xxd, "| xxd | sed -e 's/^/\Q$_[0]\E: /'";
843	syswrite $xxd, $_[1];	918	syswrite $xxd, $_[1];
		919	}
		920
		921	# get some meta info on a file (uid, gid, perms)
		922	sub stat_get($) {
		923	[(stat shift)[4, 5, 2]]
		924	}
		925
		926	# set stat info on a file
		927	sub stat_set($$) {
		928	my ($fh_or_path, $stat) = @_;
		929
		930	return unless $stat;
		931	chown $stat->[0], $stat->[1], $fh_or_path;
		932	chmod +($stat->[2] & 07777), $fh_or_path;
844	}	933	}
845		934
846	sub file_load($) {	935	sub file_load($) {
847	my ($path) = @_;	936	my ($path) = @_;
848		937
…		…
853	or die "$path: short read\n";	942	or die "$path: short read\n";
854		943
855	$buf	944	$buf
856	}	945	}
857		946
		947	sub file_save($$;$) {
		948	my ($path, $data, $stat) = @_;
		949
		950	open my $fh, ">:raw", "$path~"
		951	or die "$path~: $!\n";
		952	print $fh $data
		953	or die "$path~: short write\n";
		954	stat_set $fh, $stat;
		955	$fh->sync;
		956	close $fh;
		957
		958	rename "$path~", $path;
		959	}
		960
858	# sources and resources used for this:	961	# sources and resources used for writing pbcdedit
		962	#
859	# registry:	963	# registry:
860	# https://github.com/msuhanov/regf/blob/master/Windows%20registry%20file%20format%20specification.md	964	# https://github.com/msuhanov/regf/blob/master/Windows%20registry%20file%20format%20specification.md
861	# http://amnesia.gtisc.gatech.edu/~moyix/suzibandit.ltd.uk/MSc/	965	# http://amnesia.gtisc.gatech.edu/~moyix/suzibandit.ltd.uk/MSc/
862	# bcd:	966	# bcd:
863	# http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm	967	# http://www.geoffchappell.com/notes/windows/boot/bcd/index.htm
…		…
1216		1320
1217	regf_decode file_load $path	1321	regf_decode file_load $path
1218	}	1322	}
1219		1323
1220	# encode and save registry to file	1324	# encode and save registry to file
1221	sub regf_save {	1325	sub regf_save($$;$) {
1222	my ($path, $hive) = @_;	1326	my ($path, $hive, $stat) = @_;
1223		1327
1224	$hive = regf_encode $hive;	1328	$hive = regf_encode $hive;
1225		1329
1226	open my $regf, ">:raw", "$path~"	1330	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	}	1331	}
1235		1332
1236	#############################################################################	1333	#############################################################################
1237	# bcd stuff	1334	# bcd stuff
1238		1335
…		…
1351	sub BCDE_FORMAT_GUID_LIST () { 0x04000000 }	1448	sub BCDE_FORMAT_GUID_LIST () { 0x04000000 }
1352	sub BCDE_FORMAT_INTEGER () { 0x05000000 }	1449	sub BCDE_FORMAT_INTEGER () { 0x05000000 }
1353	sub BCDE_FORMAT_BOOLEAN () { 0x06000000 }	1450	sub BCDE_FORMAT_BOOLEAN () { 0x06000000 }
1354	sub BCDE_FORMAT_INTEGER_LIST () { 0x07000000 }	1451	sub BCDE_FORMAT_INTEGER_LIST () { 0x07000000 }
1355		1452
1356	sub dec_device;
1357	sub enc_device;
1358
1359	sub enc_integer($) {	1453	sub enc_integer($) {
1360	no warnings 'portable'; # ugh
1361	my $value = shift;	1454	my $value = shift;
1362	$value = oct $value if $value =~ /^0[bBxX]/;	1455	$value = oct $value if $value =~ /^0[bBxX]/;
1363	unpack "H*", pack "Q<", $value	1456	unpack "H*", pack "Q<", $value
1364	}	1457	}
		1458
		1459	sub enc_device($$);
		1460	sub dec_device($$);
1365		1461
1366	our %bcde_dec = (	1462	our %bcde_dec = (
1367	BCDE_FORMAT_DEVICE , \&dec_device,	1463	BCDE_FORMAT_DEVICE , \&dec_device,
1368	# # for round-trip verification	1464	# # for round-trip verification
1369	# BCDE_FORMAT_DEVICE , sub {	1465	# BCDE_FORMAT_DEVICE , sub {
…		…
1379	BCDE_FORMAT_BOOLEAN , sub { shift eq "00" ? 0 : 1 },	1475	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	1476	BCDE_FORMAT_INTEGER_LIST, sub { join " ", unpack "Q*", pack "H*", shift }, # not sure if this cna be 4 bytes
1381	);	1477	);
1382		1478
1383	our %bcde_enc = (	1479	our %bcde_enc = (
1384	BCDE_FORMAT_DEVICE , sub { binary => enc_device shift },	1480	BCDE_FORMAT_DEVICE , sub { binary => enc_device $_[0], $_[1] },
1385	BCDE_FORMAT_STRING , sub { sz => shift },	1481	BCDE_FORMAT_STRING , sub { sz => shift },
1386	BCDE_FORMAT_GUID , sub { sz => "{" . (dec_guid enc_wguid shift) . "}" },	1482	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 ] },	1483	BCDE_FORMAT_GUID_LIST , sub { multi_sz => [map "{" . (dec_guid enc_wguid $_) . "}", split /\s+/, shift ] },
1388	BCDE_FORMAT_INTEGER , sub { binary => enc_integer shift },	1484	BCDE_FORMAT_INTEGER , sub { binary => enc_integer shift },
1389	BCDE_FORMAT_BOOLEAN , sub { binary => shift ? "01" : "00" },	1485	BCDE_FORMAT_BOOLEAN , sub { binary => shift ? "01" : "00" },
1390	BCDE_FORMAT_INTEGER_LIST, sub { binary => join "", map enc_integer $_, split /\s+/, shift },	1486	BCDE_FORMAT_INTEGER_LIST, sub { binary => join "", map enc_integer $_, split /\s+/, shift },
1391	);	1487	);
1392		1488
1393	# BCD Elements	1489	# BCD Elements
1394	our %bcde = (	1490	our %bcde_byclass = (
		1491	any => {
1395	0x11000001 => 'device',	1492	0x11000001 => 'device',
1396	0x12000002 => 'path',	1493	0x12000002 => 'path',
1397	0x12000004 => 'description',	1494	0x12000004 => 'description',
1398	0x12000005 => 'locale',	1495	0x12000005 => 'locale',
1399	0x14000006 => 'inherit',	1496	0x14000006 => 'inherit',
1400	0x15000007 => 'truncatememory',	1497	0x15000007 => 'truncatememory',
1401	0x14000008 => 'recoverysequence',	1498	0x14000008 => 'recoverysequence',
1402	0x16000009 => 'recoveryenabled',	1499	0x16000009 => 'recoveryenabled',
1403	0x1700000a => 'badmemorylist',	1500	0x1700000a => 'badmemorylist',
1404	0x1600000b => 'badmemoryaccess',	1501	0x1600000b => 'badmemoryaccess',
1405	0x1500000c => 'firstmegabytepolicy',	1502	0x1500000c => 'firstmegabytepolicy',
1406	0x1500000d => 'relocatephysical',	1503	0x1500000d => 'relocatephysical',
1407	0x1500000e => 'avoidlowmemory',	1504	0x1500000e => 'avoidlowmemory',
1408	0x1600000f => 'traditionalkseg',	1505	0x1600000f => 'traditionalkseg',
1409	0x16000010 => 'bootdebug',	1506	0x16000010 => 'bootdebug',
1410	0x15000011 => 'debugtype',	1507	0x15000011 => 'debugtype',
1411	0x15000012 => 'debugaddress',	1508	0x15000012 => 'debugaddress',
1412	0x15000013 => 'debugport',	1509	0x15000013 => 'debugport',
1413	0x15000014 => 'baudrate',	1510	0x15000014 => 'baudrate',
1414	0x15000015 => 'channel',	1511	0x15000015 => 'channel',
1415	0x12000016 => 'targetname',	1512	0x12000016 => 'targetname',
1416	0x16000017 => 'noumex',	1513	0x16000017 => 'noumex',
1417	0x15000018 => 'debugstart',	1514	0x15000018 => 'debugstart',
1418	0x12000019 => 'busparams',	1515	0x12000019 => 'busparams',
1419	0x1500001a => 'hostip',	1516	0x1500001a => 'hostip',
1420	0x1500001b => 'port',	1517	0x1500001b => 'port',
1421	0x1600001c => 'dhcp',	1518	0x1600001c => 'dhcp',
1422	0x1200001d => 'key',	1519	0x1200001d => 'key',
1423	0x1600001e => 'vm',	1520	0x1600001e => 'vm',
1424	0x16000020 => 'bootems',	1521	0x16000020 => 'bootems',
1425	0x15000022 => 'emsport',	1522	0x15000022 => 'emsport',
1426	0x15000023 => 'emsbaudrate',	1523	0x15000023 => 'emsbaudrate',
1427	0x12000030 => 'loadoptions',	1524	0x12000030 => 'loadoptions',
1428	0x16000040 => 'advancedoptions',	1525	0x16000040 => 'advancedoptions',
1429	0x16000041 => 'optionsedit',	1526	0x16000041 => 'optionsedit',
1430	0x15000042 => 'keyringaddress',	1527	0x15000042 => 'keyringaddress',
1431	0x11000043 => 'bootstatdevice',	1528	0x11000043 => 'bootstatdevice',
1432	0x12000044 => 'bootstatfilepath',	1529	0x12000044 => 'bootstatfilepath',
1433	0x16000045 => 'preservebootstat',	1530	0x16000045 => 'preservebootstat',
1434	0x16000046 => 'graphicsmodedisabled',	1531	0x16000046 => 'graphicsmodedisabled',
1435	0x15000047 => 'configaccesspolicy',	1532	0x15000047 => 'configaccesspolicy',
1436	0x16000048 => 'nointegritychecks',	1533	0x16000048 => 'nointegritychecks',
1437	0x16000049 => 'testsigning',	1534	0x16000049 => 'testsigning',
1438	0x1200004a => 'fontpath',	1535	0x1200004a => 'fontpath',
1439	0x1500004b => 'integrityservices',	1536	0x1500004b => 'integrityservices',
1440	0x1500004c => 'volumebandid',	1537	0x1500004c => 'volumebandid',
1441	0x16000050 => 'extendedinput',	1538	0x16000050 => 'extendedinput',
1442	0x15000051 => 'initialconsoleinput',	1539	0x15000051 => 'initialconsoleinput',
1443	0x15000052 => 'graphicsresolution',	1540	0x15000052 => 'graphicsresolution',
1444	0x16000053 => 'restartonfailure',	1541	0x16000053 => 'restartonfailure',
1445	0x16000054 => 'highestmode',	1542	0x16000054 => 'highestmode',
1446	0x16000060 => 'isolatedcontext',	1543	0x16000060 => 'isolatedcontext',
1447	0x15000065 => 'displaymessage',	1544	0x15000065 => 'displaymessage',
1448	0x15000066 => 'displaymessageoverride',	1545	0x15000066 => 'displaymessageoverride',
1449	0x16000068 => 'nobootuxtext',	1546	0x16000068 => 'nobootuxtext',
1450	0x16000069 => 'nobootuxprogress',	1547	0x16000069 => 'nobootuxprogress',
1451	0x1600006a => 'nobootuxfade',	1548	0x1600006a => 'nobootuxfade',
1452	0x1600006b => 'bootuxreservepooldebug',	1549	0x1600006b => 'bootuxreservepooldebug',
1453	0x1600006c => 'bootuxdisabled',	1550	0x1600006c => 'bootuxdisabled',
1454	0x1500006d => 'bootuxfadeframes',	1551	0x1500006d => 'bootuxfadeframes',
1455	0x1600006e => 'bootuxdumpstats',	1552	0x1600006e => 'bootuxdumpstats',
1456	0x1600006f => 'bootuxshowstats',	1553	0x1600006f => 'bootuxshowstats',
1457	0x16000071 => 'multibootsystem',	1554	0x16000071 => 'multibootsystem',
1458	0x16000072 => 'nokeyboard',	1555	0x16000072 => 'nokeyboard',
1459	0x15000073 => 'aliaswindowskey',	1556	0x15000073 => 'aliaswindowskey',
1460	0x16000074 => 'bootshutdowndisabled',	1557	0x16000074 => 'bootshutdowndisabled',
1461	0x15000075 => 'performancefrequency',	1558	0x15000075 => 'performancefrequency',
1462	0x15000076 => 'securebootrawpolicy',	1559	0x15000076 => 'securebootrawpolicy',
1463	0x17000077 => 'allowedinmemorysettings',	1560	0x17000077 => 'allowedinmemorysettings',
1464	0x15000079 => 'bootuxtransitiontime',	1561	0x15000079 => 'bootuxtransitiontime',
1465	0x1600007a => 'mobilegraphics',	1562	0x1600007a => 'mobilegraphics',
1466	0x1600007b => 'forcefipscrypto',	1563	0x1600007b => 'forcefipscrypto',
1467	0x1500007d => 'booterrorux',	1564	0x1500007d => 'booterrorux',
1468	0x1600007e => 'flightsigning',	1565	0x1600007e => 'flightsigning',
1469	0x1500007f => 'measuredbootlogformat',	1566	0x1500007f => 'measuredbootlogformat',
1470	0x15000080 => 'displayrotation',	1567	0x15000080 => 'displayrotation',
1471	0x15000081 => 'logcontrol',	1568	0x15000081 => 'logcontrol',
1472	0x16000082 => 'nofirmwaresync',	1569	0x16000082 => 'nofirmwaresync',
1473	0x11000084 => 'windowssyspart',	1570	0x11000084 => 'windowssyspart',
1474	0x16000087 => 'numlock',	1571	0x16000087 => 'numlock',
1475	0x22000001 => 'bpbstring',	1572	0x26000202 => 'skipffumode',
		1573	0x26000203 => 'forceffumode',
		1574	0x25000510 => 'chargethreshold',
		1575	0x26000512 => 'offmodecharging',
		1576	0x25000aaa => 'bootflow',
		1577	0x45000001 => 'devicetype',
		1578	0x42000002 => 'applicationrelativepath',
		1579	0x42000003 => 'ramdiskdevicerelativepath',
		1580	0x46000004 => 'omitosloaderelements',
		1581	0x47000006 => 'elementstomigrate',
		1582	0x46000010 => 'recoveryos',
		1583	},
		1584	bootapp => {
		1585	0x26000145 => 'enablebootdebugpolicy',
		1586	0x26000146 => 'enablebootorderclean',
		1587	0x26000147 => 'enabledeviceid',
		1588	0x26000148 => 'enableffuloader',
		1589	0x26000149 => 'enableiuloader',
		1590	0x2600014a => 'enablemassstorage',
		1591	0x2600014b => 'enablerpmbprovisioning',
		1592	0x2600014c => 'enablesecurebootpolicy',
		1593	0x2600014d => 'enablestartcharge',
		1594	0x2600014e => 'enableresettpm',
		1595	},
		1596	bootmgr => {
1476	0x24000001 => 'displayorder',	1597	0x24000001 => 'displayorder',
1477	0x21000001 => 'filedevice',
1478	0x21000001 => 'osdevice',
1479	0x25000001 => 'passcount',
1480	0x26000001 => 'pxesoftreboot',
1481	0x22000002 => 'applicationname',
1482	0x24000002 => 'bootsequence',	1598	0x24000002 => 'bootsequence',
1483	0x22000002 => 'filepath',
1484	0x22000002 => 'systemroot',
1485	0x25000002 => 'testmix',
1486	0x26000003 => 'cacheenable',
1487	0x26000003 => 'customsettings',
1488	0x23000003 => 'default',	1599	0x23000003 => 'default',
1489	0x25000003 => 'failurecount',
1490	0x23000003 => 'resumeobject',
1491	0x26000004 => 'failuresenabled',
1492	0x26000004 => 'pae',
1493	0x26000004 => 'stampdisks',
1494	0x25000004 => 'testtofail',
1495	0x25000004 => 'timeout',	1600	0x25000004 => 'timeout',
1496	0x21000005 => 'associatedosdevice',
1497	0x26000005 => 'cacheenable',
1498	0x26000005 => 'resume',	1601	0x26000005 => 'resume',
1499	0x25000005 => 'stridefailcount',
1500	0x26000006 => 'debugoptionenabled',
1501	0x25000006 => 'invcfailcount',
1502	0x23000006 => 'resumeobject',	1602	0x23000006 => 'resumeobject',
1503	0x25000007 => 'bootux',
1504	0x25000007 => 'matsfailcount',
1505	0x24000007 => 'startupsequence',	1603	0x24000007 => 'startupsequence',
1506	0x25000008 => 'bootmenupolicy',
1507	0x25000008 => 'randfailcount',
1508	0x25000009 => 'chckrfailcount',
1509	0x26000010 => 'detecthal',
1510	0x24000010 => 'toolsdisplayorder',	1604	0x24000010 => 'toolsdisplayorder',
1511	0x22000011 => 'kernel',
1512	0x22000012 => 'hal',
1513	0x22000013 => 'dbgtransport',
1514	0x26000020 => 'displaybootmenu',	1605	0x26000020 => 'displaybootmenu',
1515	0x25000020 => 'nx',
1516	0x26000021 => 'noerrordisplay',	1606	0x26000021 => 'noerrordisplay',
1517	0x25000021 => 'pae',
1518	0x21000022 => 'bcddevice',	1607	0x21000022 => 'bcddevice',
1519	0x26000022 => 'winpe',
1520	0x22000023 => 'bcdfilepath',	1608	0x22000023 => 'bcdfilepath',
1521	0x26000024 => 'hormenabled',	1609	0x26000024 => 'hormenabled',
1522	0x26000024 => 'hormenabled',
1523	0x26000024 => 'nocrashautoreboot',
1524	0x26000025 => 'hiberboot',	1610	0x26000025 => 'hiberboot',
1525	0x26000025 => 'lastknowngood',
1526	0x26000026 => 'oslnointegritychecks',
1527	0x22000026 => 'passwordoverride',	1611	0x22000026 => 'passwordoverride',
1528	0x26000027 => 'osltestsigning',
1529	0x22000027 => 'pinpassphraseoverride',	1612	0x22000027 => 'pinpassphraseoverride',
1530	0x26000028 => 'processcustomactionsfirst',	1613	0x26000028 => 'processcustomactionsfirst',
1531	0x27000030 => 'customactions',	1614	0x27000030 => 'customactions',
1532	0x26000030 => 'nolowmem',
1533	0x26000031 => 'persistbootsequence',	1615	0x26000031 => 'persistbootsequence',
1534	0x25000031 => 'removememory',
1535	0x25000032 => 'increaseuserva',
1536	0x26000032 => 'skipstartupsequence',	1616	0x26000032 => 'skipstartupsequence',
1537	0x25000033 => 'perfmem',
1538	0x22000040 => 'fverecoveryurl',	1617	0x22000040 => 'fverecoveryurl',
1539	0x26000040 => 'vga',
1540	0x22000041 => 'fverecoverymessage',	1618	0x22000041 => 'fverecoverymessage',
		1619	},
		1620	device => {
		1621	0x35000001 => 'ramdiskimageoffset',
		1622	0x35000002 => 'ramdisktftpclientport',
		1623	0x31000003 => 'ramdisksdidevice',
		1624	0x32000004 => 'ramdisksdipath',
		1625	0x35000005 => 'ramdiskimagelength',
		1626	0x36000006 => 'exportascd',
		1627	0x35000007 => 'ramdisktftpblocksize',
		1628	0x35000008 => 'ramdisktftpwindowsize',
		1629	0x36000009 => 'ramdiskmcenabled',
		1630	0x3600000a => 'ramdiskmctftpfallback',
		1631	0x3600000b => 'ramdisktftpvarwindow',
		1632	},
		1633	memdiag => {
		1634	0x25000001 => 'passcount',
		1635	0x25000002 => 'testmix',
		1636	0x25000003 => 'failurecount',
		1637	0x26000003 => 'cacheenable',
		1638	0x25000004 => 'testtofail',
		1639	0x26000004 => 'failuresenabled',
		1640	0x25000005 => 'stridefailcount',
		1641	0x26000005 => 'cacheenable',
		1642	0x25000006 => 'invcfailcount',
		1643	0x25000007 => 'matsfailcount',
		1644	0x25000008 => 'randfailcount',
		1645	0x25000009 => 'chckrfailcount',
		1646	},
		1647	ntldr => {
		1648	0x22000001 => 'bpbstring',
		1649	},
		1650	osloader => {
		1651	0x21000001 => 'osdevice',
		1652	0x22000002 => 'systemroot',
		1653	0x23000003 => 'resumeobject',
		1654	0x26000004 => 'stampdisks',
		1655	0x26000010 => 'detecthal',
		1656	0x22000011 => 'kernel',
		1657	0x22000012 => 'hal',
		1658	0x22000013 => 'dbgtransport',
		1659	0x25000020 => 'nx',
		1660	0x25000021 => 'pae',
		1661	0x26000022 => 'winpe',
		1662	0x26000024 => 'nocrashautoreboot',
		1663	0x26000025 => 'lastknowngood',
		1664	0x26000026 => 'oslnointegritychecks',
		1665	0x26000027 => 'osltestsigning',
		1666	0x26000030 => 'nolowmem',
		1667	0x25000031 => 'removememory',
		1668	0x25000032 => 'increaseuserva',
		1669	0x25000033 => 'perfmem',
		1670	0x26000040 => 'vga',
1541	0x26000041 => 'quietboot',	1671	0x26000041 => 'quietboot',
1542	0x26000042 => 'novesa',	1672	0x26000042 => 'novesa',
1543	0x26000043 => 'novga',	1673	0x26000043 => 'novga',
1544	0x25000050 => 'clustermodeaddressing',	1674	0x25000050 => 'clustermodeaddressing',
1545	0x26000051 => 'usephysicaldestination',	1675	0x26000051 => 'usephysicaldestination',
1546	0x25000052 => 'restrictapiccluster',	1676	0x25000052 => 'restrictapiccluster',
1547	0x22000053 => 'evstore',	1677	0x22000053 => 'evstore',
1548	0x26000054 => 'uselegacyapicmode',	1678	0x26000054 => 'uselegacyapicmode',
1549	0x26000060 => 'onecpu',	1679	0x26000060 => 'onecpu',
1550	0x25000061 => 'numproc',	1680	0x25000061 => 'numproc',
1551	0x26000062 => 'maxproc',	1681	0x26000062 => 'maxproc',
1552	0x25000063 => 'configflags',	1682	0x25000063 => 'configflags',
1553	0x26000064 => 'maxgroup',	1683	0x26000064 => 'maxgroup',
1554	0x26000065 => 'groupaware',	1684	0x26000065 => 'groupaware',
1555	0x25000066 => 'groupsize',	1685	0x25000066 => 'groupsize',
1556	0x26000070 => 'usefirmwarepcisettings',	1686	0x26000070 => 'usefirmwarepcisettings',
1557	0x25000071 => 'msi',	1687	0x25000071 => 'msi',
1558	0x25000072 => 'pciexpress',	1688	0x25000072 => 'pciexpress',
1559	0x25000080 => 'safeboot',	1689	0x25000080 => 'safeboot',
1560	0x26000081 => 'safebootalternateshell',	1690	0x26000081 => 'safebootalternateshell',
1561	0x26000090 => 'bootlog',	1691	0x26000090 => 'bootlog',
1562	0x26000091 => 'sos',	1692	0x26000091 => 'sos',
1563	0x260000a0 => 'debug',	1693	0x260000a0 => 'debug',
1564	0x260000a1 => 'halbreakpoint',	1694	0x260000a1 => 'halbreakpoint',
1565	0x260000a2 => 'useplatformclock',	1695	0x260000a2 => 'useplatformclock',
1566	0x260000a3 => 'forcelegacyplatform',	1696	0x260000a3 => 'forcelegacyplatform',
1567	0x260000a4 => 'useplatformtick',	1697	0x260000a4 => 'useplatformtick',
1568	0x260000a5 => 'disabledynamictick',	1698	0x260000a5 => 'disabledynamictick',
1569	0x250000a6 => 'tscsyncpolicy',	1699	0x250000a6 => 'tscsyncpolicy',
1570	0x260000b0 => 'ems',	1700	0x260000b0 => 'ems',
1571	0x250000c0 => 'forcefailure',	1701	0x250000c0 => 'forcefailure',
1572	0x250000c1 => 'driverloadfailurepolicy',	1702	0x250000c1 => 'driverloadfailurepolicy',
1573	0x250000c2 => 'bootmenupolicy',	1703	0x250000c2 => 'bootmenupolicy',
1574	0x260000c3 => 'onetimeadvancedoptions',	1704	0x260000c3 => 'onetimeadvancedoptions',
1575	0x260000c4 => 'onetimeoptionsedit',	1705	0x260000c4 => 'onetimeoptionsedit',
1576	0x250000e0 => 'bootstatuspolicy',	1706	0x250000e0 => 'bootstatuspolicy',
1577	0x260000e1 => 'disableelamdrivers',	1707	0x260000e1 => 'disableelamdrivers',
1578	0x250000f0 => 'hypervisorlaunchtype',	1708	0x250000f0 => 'hypervisorlaunchtype',
1579	0x220000f1 => 'hypervisorpath',	1709	0x220000f1 => 'hypervisorpath',
1580	0x260000f2 => 'hypervisordebug',	1710	0x260000f2 => 'hypervisordebug',
1581	0x250000f3 => 'hypervisordebugtype',	1711	0x250000f3 => 'hypervisordebugtype',
1582	0x250000f4 => 'hypervisordebugport',	1712	0x250000f4 => 'hypervisordebugport',
1583	0x250000f5 => 'hypervisorbaudrate',	1713	0x250000f5 => 'hypervisorbaudrate',
1584	0x250000f6 => 'hypervisorchannel',	1714	0x250000f6 => 'hypervisorchannel',
1585	0x250000f7 => 'bootux',	1715	0x250000f7 => 'bootux',
1586	0x260000f8 => 'hypervisordisableslat',	1716	0x260000f8 => 'hypervisordisableslat',
1587	0x220000f9 => 'hypervisorbusparams',	1717	0x220000f9 => 'hypervisorbusparams',
1588	0x250000fa => 'hypervisornumproc',	1718	0x250000fa => 'hypervisornumproc',
1589	0x250000fb => 'hypervisorrootprocpernode',	1719	0x250000fb => 'hypervisorrootprocpernode',
1590	0x260000fc => 'hypervisoruselargevtlb',	1720	0x260000fc => 'hypervisoruselargevtlb',
1591	0x250000fd => 'hypervisorhostip',	1721	0x250000fd => 'hypervisorhostip',
1592	0x250000fe => 'hypervisorhostport',	1722	0x250000fe => 'hypervisorhostport',
1593	0x250000ff => 'hypervisordebugpages',	1723	0x250000ff => 'hypervisordebugpages',
1594	0x25000100 => 'tpmbootentropy',	1724	0x25000100 => 'tpmbootentropy',
1595	0x22000110 => 'hypervisorusekey',	1725	0x22000110 => 'hypervisorusekey',
1596	0x22000112 => 'hypervisorproductskutype',	1726	0x22000112 => 'hypervisorproductskutype',
1597	0x25000113 => 'hypervisorrootproc',	1727	0x25000113 => 'hypervisorrootproc',
1598	0x26000114 => 'hypervisordhcp',	1728	0x26000114 => 'hypervisordhcp',
1599	0x25000115 => 'hypervisoriommupolicy',	1729	0x25000115 => 'hypervisoriommupolicy',
1600	0x26000116 => 'hypervisorusevapic',	1730	0x26000116 => 'hypervisorusevapic',
1601	0x22000117 => 'hypervisorloadoptions',	1731	0x22000117 => 'hypervisorloadoptions',
1602	0x25000118 => 'hypervisormsrfilterpolicy',	1732	0x25000118 => 'hypervisormsrfilterpolicy',
1603	0x25000119 => 'hypervisormmionxpolicy',	1733	0x25000119 => 'hypervisormmionxpolicy',
1604	0x2500011a => 'hypervisorschedulertype',	1734	0x2500011a => 'hypervisorschedulertype',
1605	0x25000120 => 'xsavepolicy',	1735	0x25000120 => 'xsavepolicy',
1606	0x25000121 => 'xsaveaddfeature0',	1736	0x25000121 => 'xsaveaddfeature0',
1607	0x25000122 => 'xsaveaddfeature1',	1737	0x25000122 => 'xsaveaddfeature1',
1608	0x25000123 => 'xsaveaddfeature2',	1738	0x25000123 => 'xsaveaddfeature2',
1609	0x25000124 => 'xsaveaddfeature3',	1739	0x25000124 => 'xsaveaddfeature3',
1610	0x25000125 => 'xsaveaddfeature4',	1740	0x25000125 => 'xsaveaddfeature4',
1611	0x25000126 => 'xsaveaddfeature5',	1741	0x25000126 => 'xsaveaddfeature5',
1612	0x25000127 => 'xsaveaddfeature6',	1742	0x25000127 => 'xsaveaddfeature6',
1613	0x25000128 => 'xsaveaddfeature7',	1743	0x25000128 => 'xsaveaddfeature7',
1614	0x25000129 => 'xsaveremovefeature',	1744	0x25000129 => 'xsaveremovefeature',
1615	0x2500012a => 'xsaveprocessorsmask',	1745	0x2500012a => 'xsaveprocessorsmask',
1616	0x2500012b => 'xsavedisable',	1746	0x2500012b => 'xsavedisable',
1617	0x2500012c => 'kerneldebugtype',	1747	0x2500012c => 'kerneldebugtype',
1618	0x2200012d => 'kernelbusparams',	1748	0x2200012d => 'kernelbusparams',
1619	0x2500012e => 'kerneldebugaddress',	1749	0x2500012e => 'kerneldebugaddress',
1620	0x2500012f => 'kerneldebugport',	1750	0x2500012f => 'kerneldebugport',
1621	0x25000130 => 'claimedtpmcounter',	1751	0x25000130 => 'claimedtpmcounter',
1622	0x25000131 => 'kernelchannel',	1752	0x25000131 => 'kernelchannel',
1623	0x22000132 => 'kerneltargetname',	1753	0x22000132 => 'kerneltargetname',
1624	0x25000133 => 'kernelhostip',	1754	0x25000133 => 'kernelhostip',
1625	0x25000134 => 'kernelport',	1755	0x25000134 => 'kernelport',
1626	0x26000135 => 'kerneldhcp',	1756	0x26000135 => 'kerneldhcp',
1627	0x22000136 => 'kernelkey',	1757	0x22000136 => 'kernelkey',
1628	0x22000137 => 'imchivename',	1758	0x22000137 => 'imchivename',
1629	0x21000138 => 'imcdevice',	1759	0x21000138 => 'imcdevice',
1630	0x25000139 => 'kernelbaudrate',	1760	0x25000139 => 'kernelbaudrate',
1631	0x22000140 => 'mfgmode',	1761	0x22000140 => 'mfgmode',
1632	0x26000141 => 'event',	1762	0x26000141 => 'event',
1633	0x25000142 => 'vsmlaunchtype',	1763	0x25000142 => 'vsmlaunchtype',
1634	0x25000144 => 'hypervisorenforcedcodeintegrity',	1764	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',	1765	0x21000150 => 'systemdatadevice',
1646	0x21000151 => 'osarcdevice',	1766	0x21000151 => 'osarcdevice',
1647	0x21000153 => 'osdatadevice',	1767	0x21000153 => 'osdatadevice',
1648	0x21000154 => 'bspdevice',	1768	0x21000154 => 'bspdevice',
1649	0x21000155 => 'bspfilepath',	1769	0x21000155 => 'bspfilepath',
1650	0x26000202 => 'skipffumode',	1770	},
1651	0x26000203 => 'forceffumode',	1771	resume => {
1652	0x25000510 => 'chargethreshold',	1772	0x21000001 => 'filedevice',
1653	0x26000512 => 'offmodecharging',	1773	0x22000002 => 'filepath',
1654	0x25000aaa => 'bootflow',	1774	0x26000003 => 'customsettings',
1655	0x35000001 => 'ramdiskimageoffset',	1775	0x26000004 => 'pae',
1656	0x35000002 => 'ramdisktftpclientport',	1776	0x21000005 => 'associatedosdevice',
1657	0x31000003 => 'ramdisksdidevice',	1777	0x26000006 => 'debugoptionenabled',
1658	0x32000004 => 'ramdisksdipath',	1778	0x25000007 => 'bootux',
1659	0x35000005 => 'ramdiskimagelength',	1779	0x25000008 => 'bootmenupolicy',
1660	0x36000006 => 'exportascd',	1780	0x26000024 => 'hormenabled',
1661	0x35000007 => 'ramdisktftpblocksize',	1781	},
1662	0x35000008 => 'ramdisktftpwindowsize',	1782	startup => {
1663	0x36000009 => 'ramdiskmcenabled',	1783	0x26000001 => 'pxesoftreboot',
1664	0x3600000a => 'ramdiskmctftpfallback',	1784	0x22000002 => 'applicationname',
1665	0x3600000b => 'ramdisktftpvarwindow',	1785	},
1666	0x45000001 => 'devicetype',
1667	0x42000002 => 'applicationrelativepath',
1668	0x42000003 => 'ramdiskdevicerelativepath',
1669	0x46000004 => 'omitosloaderelements',
1670	0x47000006 => 'elementstomigrate',
1671	0x46000010 => 'recoveryos',
1672	);	1786	);
1673		1787
1674	our %rbcde = reverse %bcde;	1788	# mask, value => class
		1789	our @bcde_typeclass = (
		1790	[0x00000000, 0x00000000, 'any'],
		1791	[0xf00fffff, 0x1000000a, 'bootapp'],
		1792	[0xf0ffffff, 0x2020000a, 'bootapp'],
		1793	[0xf00fffff, 0x10000001, 'bootmgr'],
		1794	[0xf00fffff, 0x10000002, 'bootmgr'],
		1795	[0xf0ffffff, 0x20200001, 'bootmgr'],
		1796	[0xf0ffffff, 0x20200002, 'bootmgr'],
		1797	[0xf0f00000, 0x20300000, 'device'],
		1798	[0xf0000000, 0x30000000, 'device'],
		1799	[0xf00fffff, 0x10000005, 'memdiag'],
		1800	[0xf0ffffff, 0x20200005, 'memdiag'],
		1801	[0xf00fffff, 0x10000006, 'ntldr'],
		1802	[0xf00fffff, 0x10000007, 'ntldr'],
		1803	[0xf0ffffff, 0x20200006, 'ntldr'],
		1804	[0xf0ffffff, 0x20200007, 'ntldr'],
		1805	[0xf00fffff, 0x10000003, 'osloader'],
		1806	[0xf0ffffff, 0x20200003, 'osloader'],
		1807	[0xf00fffff, 0x10000004, 'resume'],
		1808	[0xf0ffffff, 0x20200004, 'resume'],
		1809	[0xf00fffff, 0x10000009, 'startup'],
		1810	[0xf0ffffff, 0x20200009, 'startup'],
		1811	);
1675		1812
		1813	our %rbcde_byclass;
		1814
		1815	while (my ($k, $v) = each %bcde_byclass) {
		1816	$rbcde_byclass{$k} = { reverse %$v };
		1817	}
		1818
		1819	# decodes (numerical elem, type) to name
1676	sub dec_bcde_id($) {	1820	sub dec_bcde_id($$) {
		1821	for my $class (@bcde_typeclass) {
		1822	if (($_[1] & $class->[0]) == $class->[1]) {
		1823	if (my $id = $bcde_byclass{$class->[2]}{$_[0]}) {
		1824	return $id;
		1825	}
		1826	}
		1827	}
		1828
1677	$bcde{$_[0]} // sprintf "custom:%08x", $_[0]	1829	sprintf "custom:%08x", $_[0]
1678	}	1830	}
1679		1831
		1832	# encodes (elem as name, type)
1680	sub enc_bcde_id($) {	1833	sub enc_bcde_id($$) {
1681	$_[0] =~ /^custom:([0-9a-fA-F]{8}$)/	1834	$_[0] =~ /^custom:(?:0x)?([0-9a-fA-F]{8}$)/
1682	? hex $1	1835	and return hex $1;
1683	: $rbcde{$_[0]}	1836
		1837	for my $class (@bcde_typeclass) {
		1838	if (($_[1] & $class->[0]) == $class->[1]) {
		1839	if (my $value = $rbcde_byclass{$class->[2]}{$_[0]}) {
		1840	return $value;
		1841	}
		1842	}
		1843	}
		1844
		1845	undef
1684	}	1846	}
1685		1847
1686	# decode/encode bcd device element - the horror, no documentaion	1848	# decode/encode bcd device element - the horror, no documentaion
1687	# whatsoever, supercomplex, superinconsistent.	1849	# whatsoever, supercomplex, superinconsistent.
1688		1850
…		…
1692		1854
1693	our $NULL_DEVICE = "\x00" x 16;	1855	our $NULL_DEVICE = "\x00" x 16;
1694		1856
1695	# biggest bitch to decode, ever	1857	# biggest bitch to decode, ever
1696	# this decoded a device portion after the GUID	1858	# this decoded a device portion after the GUID
1697	sub dec_device_($);	1859	sub dec_device_($$);
1698	sub dec_device_($) {	1860	sub dec_device_($$) {
1699	my ($device) = @_;	1861	my ($device, $type) = @_;
1700		1862
1701	my $res;	1863	my $res;
1702		1864
1703	my ($type, $flags, $length, $pad) = unpack "VVVV", substr $device, 0, 4 * 4, "";	1865	my ($type, $flags, $length, $pad) = unpack "VVVV", substr $device, 0, 4 * 4, "";
1704		1866
…		…
1749		1911
1750	my $partid = $parttype eq "gpt" ? dec_guid $partdata	1912	my $partid = $parttype eq "gpt" ? dec_guid $partdata
1751	: $type eq "partition" ? unpack "Q<", $partdata # byte offset to partition start	1913	: $type eq "partition" ? unpack "Q<", $partdata # byte offset to partition start
1752	: unpack "L<", $partdata; # partition number, one-based	1914	: unpack "L<", $partdata; # partition number, one-based
1753		1915
1754	(my $parent, $device) = dec_device_ $device;	1916	(my $parent, $device) = dec_device_ $device, $type;
1755		1917
1756	$res .= "=";	1918	$res .= "=";
1757	$res .= "<$parent>";	1919	$res .= "<$parent>";
1758	$res .= ",$blocktype,$parttype,$diskid,$partid";	1920	$res .= ",$blocktype,$parttype,$diskid,$partid";
1759		1921
…		…
1779	or die "unsupported file descriptor version '$fver'\n";	1941	or die "unsupported file descriptor version '$fver'\n";
1780		1942
1781	$ftype == 5	1943	$ftype == 5
1782	or die "unsupported file descriptor path type '$type'\n";	1944	or die "unsupported file descriptor path type '$type'\n";
1783		1945
1784	(my $parent, $path) = dec_device_ $path;	1946	(my $parent, $path) = dec_device_ $path, $type;
1785		1947
1786	$path = $dec_path->($path, "file device without path");	1948	$path = $dec_path->($path, "file device without path");
1787		1949
1788	($parent, $path)	1950	($parent, $path)
1789	};	1951	};
…		…
1795		1957
1796	} elsif ($blocktype eq "vhd") {	1958	} elsif ($blocktype eq "vhd") {
1797	$device =~ s/^\x00{20}//s	1959	$device =~ s/^\x00{20}//s
1798	or die "virtualdisk has non-zero fields I don't understand\n";	1960	or die "virtualdisk has non-zero fields I don't understand\n";
1799		1961
1800	(my $parent, $device) = dec_device_ $device;	1962	(my $parent, $device) = dec_device_ $device, $type;
1801		1963
1802	$res .= "=vhd,<$parent>";	1964	$res .= "=vhd,<$parent>";
1803		1965
1804	} elsif ($blocktype eq "ramdisk") {	1966	} elsif ($blocktype eq "ramdisk") {
1805	my ($base, $size, $offset) = unpack "Q< Q< L<", substr $device, 0, 8 + 8 + 4, "";	1967	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, "";	1980	my ($mode, $elem, $parent) = unpack "VVV", substr $device, 0, 4 * 3, "";
1819		1981
1820	if ($parent) {	1982	if ($parent) {
1821	# not sure why this is an offset - it must come after the path	1983	# not sure why this is an offset - it must come after the path
1822	$parent = substr $device, $parent - 4 * 3 - 4 * 4, 1e9, "";	1984	$parent = substr $device, $parent - 4 * 3 - 4 * 4, 1e9, "";
1823	($parent, my $tail) = dec_device_ $parent;	1985	($parent, my $tail) = dec_device_ $parent, $type;
1824	0 == length $tail	1986	0 == length $tail
1825	or die "trailing data after locate device parent\n";	1987	or die "trailing data after locate device parent\n";
1826	} else {	1988	} else {
1827	$parent = "null";	1989	$parent = "null";
1828	}	1990	}
…		…
1834		1996
1835	if ($mode == 0) { # "Element"	1997	if ($mode == 0) { # "Element"
1836	!length $path	1998	!length $path
1837	or die "device locate mode 0 having non-empty path ($mode, $elem, $path)\n";	1999	or die "device locate mode 0 having non-empty path ($mode, $elem, $path)\n";
1838		2000
1839	$elem = dec_bcde_id $elem;	2001	$elem = dec_bcde_id $elem, $type;
1840	$res .= "element,$elem";	2002	$res .= "element,$elem";
1841		2003
1842	} elsif ($mode == 1) { # "String"	2004	} elsif ($mode == 1) { # "String"
1843	!$elem	2005	!$elem
1844	or die "device locate mode 1 having non-zero element\n";	2006	or die "device locate mode 1 having non-zero element\n";
…		…
1869		2031
1870	($res, $tail)	2032	($res, $tail)
1871	}	2033	}
1872		2034
1873	# decode a full binary BCD device descriptor	2035	# decode a full binary BCD device descriptor
1874	sub dec_device($) {	2036	sub dec_device($$) {
1875	my ($device) = @_;	2037	my ($device, $type) = @_;
1876		2038
1877	$device = pack "H*", $device;	2039	$device = pack "H*", $device;
1878		2040
1879	my $guid = dec_guid substr $device, 0, 16, "";	2041	my $guid = dec_guid substr $device, 0, 16, "";
1880	$guid = $guid eq "00000000-0000-0000-0000-000000000000"	2042	$guid = $guid eq "00000000-0000-0000-0000-000000000000"
1881	? "" : "{$guid}";	2043	? "" : "{$guid}";
1882		2044
1883	eval {	2045	eval {
1884	my ($dev, $tail) = dec_device_ $device;	2046	my ($dev, $tail) = dec_device_ $device, $type;
1885		2047
1886	$tail eq ""	2048	$tail eq ""
1887	or die "unsupported trailing data after device descriptor\n";	2049	or die "unsupported trailing data after device descriptor\n";
1888		2050
1889	"$guid$dev"	2051	"$guid$dev"
…		…
1901		2063
1902	undef	2064	undef
1903	}	2065	}
1904		2066
1905	# encode the device portion after the GUID	2067	# encode the device portion after the GUID
1906	sub enc_device_;	2068	sub enc_device_($$);
1907	sub enc_device_ {	2069	sub enc_device_($$) {
1908	my ($device) = @_;	2070	my ($device, $type) = @_;
1909		2071
1910	my $enc_path = sub {	2072	my $enc_path = sub {
1911	my $path = shift;	2073	my $path = shift;
1912	$path =~ s/\//\\/g;	2074	$path =~ s/\//\\/g;
1913	(Encode::encode "UTF-16LE", $path) . "\x00\x00"	2075	(Encode::encode "UTF-16LE", $path) . "\x00\x00"
…		…
1931		2093
1932	my $parse_parent = sub {	2094	my $parse_parent = sub {
1933	my $parent;	2095	my $parent;
1934		2096
1935	if (s/^<//) {	2097	if (s/^<//) {
1936	($parent, $_) = enc_device_ $_;	2098	($parent, $_) = enc_device_ $_, $type;
1937	s/^>//	2099	s/^>//
1938	or die "$device: syntax error: parent device not followed by '>'\n";	2100	or die "$device: syntax error: parent device not followed by '>'\n";
1939	} else {	2101	} else {
1940	$parent = $NULL_DEVICE;	2102	$parent = $NULL_DEVICE;
1941	}	2103	}
…		…
2029		2191
2030	s/^,//	2192	s/^,//
2031	or die "$_: missing comma after locate parent device\n";	2193	or die "$_: missing comma after locate parent device\n";
2032		2194
2033	if (s/^element,//) {	2195	if (s/^element,//) {
2034	s/^([0-9a-z]+)//i	2196	s/^([0-9a-z:]+)//i
2035	or die "$_ locate element must be either name or 8-digit hex id\n";	2197	or die "$_ locate element must be either name or 8-digit hex id\n";
2036	$elem = enc_bcde_id $1;	2198	$elem = enc_bcde_id $1, $type;
2037	$mode = 0;	2199	$mode = 0;
2038	$path = $enc_path->("");	2200	$path = $enc_path->("");
2039		2201
2040	} elsif (s/^path,//) {	2202	} elsif (s/^path,//) {
2041	$mode = 1;	2203	$mode = 1;
…		…
2108	or die "$_: malformed or missing vmbus interface instance guid\n";	2270	or die "$_: malformed or missing vmbus interface instance guid\n";
2109	my $instance = enc_guid $1;	2271	my $instance = enc_guid $1;
2110		2272
2111	$payload = pack "a16a16x24", $type, $instance;	2273	$payload = pack "a16a16x24", $type, $instance;
2112		2274
		2275	# } elsif ($type eq "udp") {
		2276	# $payload = pack "Va16", 1, "12345678";
		2277
2113	} else {	2278	} else {
2114	die "$type: not a supported device type (binary, null, boot, legacypartition, partition, block, locate)\n";	2279	die "$type: not a supported device type (binary, null, boot, legacypartition, partition, block, locate)\n";
2115	}	2280	}
2116		2281
2117	return (	2282	return (
…		…
2120	);	2285	);
2121	}	2286	}
2122	}	2287	}
2123		2288
2124	# encode a full binary BCD device descriptor	2289	# encode a full binary BCD device descriptor
2125	sub enc_device {	2290	sub enc_device($$) {
2126	my ($device) = @_;	2291	my ($device, $type) = @_;
2127		2292
2128	my $guid = "\x00" x 16;	2293	my $guid = "\x00" x 16;
2129		2294
2130	if ($device =~ s/^\{([A-Za-z0-9\-]+)\}//) {	2295	if ($device =~ s/^\{([A-Za-z0-9\-]+)\}//) {
2131	$guid = enc_guid $1	2296	$guid = enc_guid $1
2132	or die "$device: does not start with valid guid\n";	2297	or die "$device: does not start with valid guid\n";
2133	}	2298	}
2134		2299
2135	my ($descriptor, $tail) = enc_device_ $device;	2300	my ($descriptor, $tail) = enc_device_ $device, $type;
2136		2301
2137	length $tail	2302	length $tail
2138	and die "$device: garbage after device descriptor\n";	2303	and die "$device: garbage after device descriptor\n";
2139		2304
2140	unpack "H*", $guid . $descriptor	2305	unpack "H*", $guid . $descriptor
…		…
2155	$k = $bcd_objects{$k} // $k;	2320	$k = $bcd_objects{$k} // $k;
2156		2321
2157	my $type = $v->{Description}[0]{Type}[1];	2322	my $type = $v->{Description}[0]{Type}[1];
2158		2323
2159	if ($type != $bcd_object_types{$k}) {	2324	if ($type != $bcd_object_types{$k}) {
2160	$type = $bcd_types{$type} // sprintf "0x%08x", $type;	2325	$kv{type} = $bcd_types{$type} // sprintf "0x%08x", $type;
2161	$kv{type} = $type;
2162	}	2326	}
2163		2327
2164	my $elems = $v->{Elements}[1];	2328	my $elems = $v->{Elements}[1];
2165		2329
2166	while (my ($k, $v) = each %$elems) {	2330	while (my ($k, $v) = each %$elems) {
2167	my $k = hex $k;	2331	my $k = hex $k;
2168		2332
2169	my $v = $bcde_dec{$k & BCDE_FORMAT}->($v->[0]{Element}[1]);	2333	my $v = $bcde_dec{$k & BCDE_FORMAT}->($v->[0]{Element}[1], $type);
2170	my $k = dec_bcde_id $k;	2334	my $k = dec_bcde_id $k, $type;
2171		2335
2172	$kv{$k} = $v;	2336	$kv{$k} = $v;
2173	}	2337	}
2174		2338
2175	$bcd{$k} = \%kv;	2339	$bcd{$k} = \%kv;
…		…
2216	my %elem;	2380	my %elem;
2217		2381
2218	while (my ($k, $v) = each %$v) {	2382	while (my ($k, $v) = each %$v) {
2219	next if $k eq "type";	2383	next if $k eq "type";
2220		2384
2221	$k = (enc_bcde_id $k) // die "$k: invalid bcde element name or id\n";	2385	$k = (enc_bcde_id $k, $type) // die "$k: invalid bcde element name or id\n";
2222	$elem{sprintf "%08x", $k} = [{	2386	$elem{sprintf "%08x", $k} = [{
2223	Element => [ ($bcde_enc{$k & BCDE_FORMAT} // die "$k: unable to encode unknown bcd element type}")->($v)]	2387	Element => [ ($bcde_enc{$k & BCDE_FORMAT} // die "$k: unable to encode unknown bcd element type}")->($v)]
2224	}];	2388	}];
2225	}	2389	}
2226		2390
…		…
2242	Objects => [undef, \%objects],	2406	Objects => [undef, \%objects],
2243	}]]	2407	}]]
2244	}	2408	}
2245		2409
2246	#############################################################################	2410	#############################################################################
		2411	# edit instructions
2247		2412
2248	sub bcd_edit_eval {	2413	sub bcd_edit_eval {
2249	package pbcdedit;	2414	package pbcdedit;
2250		2415
2251	our ($PATH, $BCD, $DEFAULT);	2416	our ($PATH, $BCD, $DEFAULT);
…		…
2255	}	2420	}
2256		2421
2257	sub bcd_edit {	2422	sub bcd_edit {
2258	my ($path, $bcd, @insns) = @_;	2423	my ($path, $bcd, @insns) = @_;
2259		2424
2260	my $default = $bcd->{"{bootmgr}"}{resumeobject};	2425	my $default = $bcd->{"{bootmgr}"}{default};
2261		2426
2262	# prepare "officially visible" variables	2427	# prepare "officially visible" variables
2263	local $pbcdedit::PATH = $path;	2428	local $pbcdedit::PATH = $path;
2264	local $pbcdedit::BCD = $bcd;	2429	local $pbcdedit::BCD = $bcd;
2265	local $pbcdedit::DEFAULT = $default;	2430	local $pbcdedit::DEFAULT = $default;
…		…
2269		2434
2270	if ($insn eq "get") {	2435	if ($insn eq "get") {
2271	my $object = shift @insns;	2436	my $object = shift @insns;
2272	my $elem = shift @insns;	2437	my $elem = shift @insns;
2273		2438
2274	$object = $default if $object eq "{default}";	2439	$object = $object eq "{default}" ? $default : dec_wguid enc_wguid $object;
2275		2440
2276	print $bcd->{$object}{$elem}, "\n";	2441	print $bcd->{$object}{$elem}, "\n";
2277		2442
2278	} elsif ($insn eq "set") {	2443	} elsif ($insn eq "set") {
2279	my $object = shift @insns;	2444	my $object = shift @insns;
2280	my $elem = shift @insns;	2445	my $elem = shift @insns;
2281	my $value = shift @insns;	2446	my $value = shift @insns;
2282		2447
2283	$object = $default if $object eq "{default}";	2448	$object = $object eq "{default}" ? $default : dec_wguid enc_wguid $object;
2284		2449
2285	$bcd->{$object}{$elem} = $value;	2450	$bcd->{$object}{$elem} = $value;
2286		2451
2287	} elsif ($insn eq "eval") {	2452	} elsif ($insn eq "eval") {
2288	bcd_edit_eval shift @insns;	2453	my $perl = shift @insns;
		2454	bcd_edit_eval "#line 1 'eval'\n$perl";
2289		2455
2290	} elsif ($insn eq "do") {	2456	} elsif ($insn eq "do") {
2291	my $path = shift @insns;	2457	my $path = shift @insns;
2292	my $file = file_load $path;	2458	my $file = file_load $path;
2293	bcd_edit_eval "#line 1 '$path'\n$file";	2459	bcd_edit_eval "#line 1 '$path'\n$file";
…		…
2298	}	2464	}
2299		2465
2300	}	2466	}
2301		2467
2302	#############################################################################	2468	#############################################################################
		2469	# other utilities
2303		2470
2304	# json to stdout	2471	# json to stdout
2305	sub prjson($) {	2472	sub prjson($) {
2306	print $json_coder->encode ($_[0]);	2473	print $json_coder->encode ($_[0]);
2307	}	2474	}
…		…
2311	my $json;	2478	my $json;
2312	1 while read STDIN, $json, 65536, length $json;	2479	1 while read STDIN, $json, 65536, length $json;
2313	$json_coder->decode ($json)	2480	$json_coder->decode ($json)
2314	}	2481	}
2315		2482
2316	# all subcommands	2483	sub lsblk() {
		2484	my $lsblk = $json_coder->decode (scalar qx<lsblk --json -o PATH,KNAME,MAJ:MIN,TYPE,PTTYPE,PTUUID,PARTUUID,LABEL,FSTYPE>);
		2485
		2486	for my $dev (@{ $lsblk->{blockdevices} }) {
		2487	if ($dev->{type} eq "part") {
		2488	if ($dev->{pttype} eq "gpt") {
		2489	$dev->{bcd_device} = "partition=<null>,harddisk,gpt,$dev->{ptuuid},$dev->{partuuid}";
		2490	} elsif ($dev->{pttype} eq "dos") { # why not "mbr" :(
		2491	if ($dev->{partuuid} =~ /^([0-9a-f]{8})-([0-9a-f]{2})\z/i) {
		2492	my ($diskid, $partno) = ($1, hex $2);
		2493	$dev->{bcd_legacy_device} = "legacypartition=<null>,harddisk,mbr,$diskid,$partno";
		2494	if (open my $fh, "/sys/class/block/$dev->{kname}/start") {
		2495	my $start = 512 * readline $fh;
		2496	$dev->{bcd_device} = "partition=<null>,harddisk,mbr,$diskid,$start";
		2497	}
		2498	}
		2499	}
		2500	}
		2501	}
		2502
		2503	$lsblk->{blockdevices}
		2504	}
		2505
		2506	sub prdev($$) {
		2507	my ($path, $attribute) = @_;
		2508
		2509	# rather than stat'ing and guessing how devices are encoded, we use lsblk for this
		2510	# unfortunately, there doesn't seem to be a way to restrict lsblk to just oned evice,
		2511	# so we always assume the first one is it.
		2512	my $mm = $json_coder->decode (scalar qx<lsblk -o MAJ:MIN -J \Q$path\E>)->{blockdevices}[0]{"maj:min"};
		2513
		2514	my $lsblk = lsblk;
		2515
		2516	for my $dev (@$lsblk) {
		2517	if ($dev->{"maj:min"} eq $mm && $dev->{$attribute}) {
		2518	say $dev->{$attribute};
		2519	exit 0;
		2520	}
		2521	}
		2522
		2523	exit 1;
		2524	}
		2525
		2526	#############################################################################
		2527	# command line parser
		2528
2317	our %CMD = (	2529	our %CMD = (
2318	help => sub {	2530	help => sub {
2319	require Pod::Usage;	2531	require Pod::Usage;
2320	Pod::Usage::pod2usage (-verbose => 2);	2532	Pod::Usage::pod2usage (-verbose => 2);
2321	},	2533	},
…		…
2346		2558
2347	print "\n";	2559	print "\n";
2348		2560
2349	printf "%-39s %-23s %s\n", "Object GUID", "Alias", "(Hex) Default Type";	2561	printf "%-39s %-23s %s\n", "Object GUID", "Alias", "(Hex) Default Type";
2350	for my $name (sort keys %rbcd_objects) {	2562	for my $name (sort keys %rbcd_objects) {
2351	my $guid = $rbcd_objects{$name};	2563	my $guid = $rbcd_objects{$name};
2352	my $type = $bcd_object_types{$name};	2564	my $type = $bcd_object_types{$name};
2353	my $tname = $bcd_types{$type};	2565	my $tname = $bcd_types{$type};
2354		2566
2355	$type = $type ? sprintf "(%08x) %s", $type, $tname : "-";	2567	$type = $type ? sprintf "(%08x) %s", $type, $tname : "-";
2356		2568
2357	printf "%-39s %-23s %s\n", $guid, $name, $type;	2569	printf "%-39s %-23s %s\n", $guid, $name, $type;
…		…
2371	BCDE_FORMAT_GUID_LIST , "guid list",	2583	BCDE_FORMAT_GUID_LIST , "guid list",
2372	BCDE_FORMAT_INTEGER , "integer",	2584	BCDE_FORMAT_INTEGER , "integer",
2373	BCDE_FORMAT_BOOLEAN , "boolean",	2585	BCDE_FORMAT_BOOLEAN , "boolean",
2374	BCDE_FORMAT_INTEGER_LIST, "integer list",	2586	BCDE_FORMAT_INTEGER_LIST, "integer list",
2375	);	2587	);
2376	my %rbcde = reverse %bcde;
2377	$_ = sprintf "%08x", $_ for values %rbcde;
2378		2588
2379	my %element;	2589	my @element;
2380		2590
		2591	for my $class (sort keys %rbcde_byclass) {
		2592	my $rbcde = $rbcde_byclass{$class};
		2593
2381	unless ($json) {	2594	unless ($json) {
2382	print "\n";	2595	print "\n";
		2596	printf "Elements applicable to class(es): $class\n";
2383	printf "%-9s %-12s %s\n", "Element", "Format", "Name Alias";	2597	printf "%-9s %-12s %s\n", "Element", "Format", "Name Alias";
2384	}	2598	}
2385	for my $name (sort keys %rbcde) {	2599	for my $name (sort keys %$rbcde) {
2386	my $id = $rbcde{$name};	2600	my $id = $rbcde->{$name};
2387	my $format = $format_name{(hex $id) & BCDE_FORMAT};	2601	my $format = $format_name{$id & BCDE_FORMAT};
2388		2602
2389	if ($json) {	2603	if ($json) {
2390	$element{$id} = [$format, $name];	2604	push @element, [$class, $id * 1, $format, $name];
2391	} else {	2605	} else {
		2606	$id = sprintf "%08x", $id;
2392	printf "%-9s %-12s %s\n", $id, $format, $name;	2607	printf "%-9s %-12s %s\n", $id, $format, $name;
		2608	}
2393	}	2609	}
2394	}	2610	}
2395	print "\n" unless $json;	2611	print "\n" unless $json;
2396		2612
2397	prjson {	2613	prjson {
2398	version => $JSON_VERSION,	2614	version => $JSON_VERSION,
2399	element => \%element,	2615	element => \@element,
		2616	class => \@bcde_typeclass,
2400	} if $json;	2617	} if $json;
2401		2618
2402	},	2619	},
2403		2620
2404	export => sub {	2621	export => sub {
…		…
2407		2624
2408	import => sub {	2625	import => sub {
2409	regf_save shift, bcd_encode rdjson;	2626	regf_save shift, bcd_encode rdjson;
2410	},	2627	},
2411		2628
		2629	create => sub {
		2630	my $path = shift;
		2631	my $stat = stat_get $path; # should actually be done at file load time
		2632	my $bcd = { };
		2633	bcd_edit $path, $bcd, @_;
		2634	regf_save $path, bcd_encode $bcd;
		2635	stat_set $path, $stat;
		2636	},
		2637
2412	edit => sub {	2638	edit => sub {
2413	my $path = shift;	2639	my $path = shift;
		2640	my $stat = stat_get $path; # should actually be done at file load time
2414	my $bcd = bcd_decode regf_load $path;	2641	my $bcd = bcd_decode regf_load $path;
2415	bcd_edit $path, $bcd, @_;	2642	bcd_edit $path, $bcd, @_;
2416	regf_save $path, bcd_encode $bcd;	2643	regf_save $path, bcd_encode $bcd;
		2644	stat_set $path, $stat;
2417	},	2645	},
2418		2646
2419	parse => sub {	2647	parse => sub {
2420	my $path = shift;	2648	my $path = shift;
2421	my $bcd = bcd_decode regf_load $path;	2649	my $bcd = bcd_decode regf_load $path;
…		…
2430	"import-regf" => sub {	2658	"import-regf" => sub {
2431	regf_save shift, rdjson;	2659	regf_save shift, rdjson;
2432	},	2660	},
2433		2661
2434	lsblk => sub {	2662	lsblk => sub {
		2663	my $json = $_[0] eq "--json";
		2664
		2665	my $lsblk = lsblk;
		2666
		2667	if ($json) {
		2668	prjson $lsblk;
		2669	} else {
2435	printf "%-10s %-8.8s %-6.6s %-3s %s\n", "DEVICE", "LABEL", "FSTYPE", "PT", "DEVICE DESCRIPTOR";	2670	printf "%-10s %-8.8s %-6.6s %-3s %s\n", "DEVICE", "LABEL", "FSTYPE", "PT", "DEVICE DESCRIPTOR";
2436		2671	for my $dev (@$lsblk) {
2437	my $lsblk = $json_coder->decode (scalar qx<lsblk --json -o PATH,KNAME,TYPE,PTTYPE,PTUUID,PARTUUID,LABEL,FSTYPE>);	2672	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",	2673	printf "%-10s %-8.8s %-6.6s %-3s %s\n",
2442	$dev->{path}, $dev->{label}, $dev->{fstype}, $dev->{pttype}, $_[0];	2674	$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	}	2675	if $bcd;
2456	}
2457	}	2676	}
2458	}	2677	}
2459	}	2678	}
2460	},	2679	},
		2680
		2681	"bcd-device" => sub {
		2682	prdev shift, "bcd_device";
		2683	},
		2684
		2685	"bcd-legacy-device" => sub {
		2686	prdev shift, "bcd_legacy_device";
		2687	},
		2688
		2689	version => sub {
		2690	print "\n",
		2691	"PBCDEDIT version $VERSION, copyright 2019 Marc A. Lehmann <pbcdedit\@schmorp.de>.\n",
		2692	"JSON schema version: $JSON_VERSION\n",
		2693	"Licensed under the GNU General Public License Version 3.0, or any later version.\n",
		2694	"\n",
		2695	$CHANGELOG,
		2696	"\n";
		2697	},
2461	);	2698	);
2462		2699
2463	my $cmd = shift;	2700	my $cmd = shift;
2464		2701
2465	unless (exists $CMD{$cmd}) {	2702	unless (exists $CMD{$cmd}) {

Diff Legend

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