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

Diff Legend

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