Skip to contentSkip to conversation

x86_64, i386: Add command line length to boot protocol

PATCH In review Bernhard Walle 5 participants 8 messages Mar 6, 2007 – Mar 12, 2007 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 x86_64, i386: Add command line length to boot protocol

Because the command line is increased to 2048 characters after 2.6.21, it's not possible for boot loaders and userspace tools to determine the length of the command line the kernel can understand. The benefit of knowing the length is that users can be warned if the command line size is too long which prevents surprise if things don't work after bootup.

This patch updates the boot protocol to contain a field called "cmdline_size" that contain the length of the command line (excluding the terminating zero).

The patch also adds missing fields (of protocol version 2.05) to the x86_64 setup code.

Cc Alon Bar-Lev <[email protected]>
Cc Andi Kleen <[email protected]>
---
 Documentation/i386/boot.txt |   23 +++++++++++++++++------
 arch/i386/boot/setup.S      |    7 ++++++-
 arch/x86_64/boot/setup.S    |   15 ++++++++++++++-
 3 files changed, 37 insertions(+), 8 deletions(-)
Documentation/i386/boot.txt +17 -6
Index: longer-cmdline-boot-proto-mm/Documentation/i386/boot.txt
===================================================================
@@ -2,7 +2,7 @@
 		     ----------------------------
 
 		    H. Peter Anvin <[email protected]>
-			Last update 2007-01-26
+			Last update 2007-03-06
 
 On the i386 platform, the Linux kernel uses a rather complicated boot
 convention.  This has evolved partially due to historical aspects, as
@@ -35,9 +35,13 @@ Protocol 2.03:	(Kernel 2.4.18-pre1) Expl
 		initrd address available to the bootloader.
 
 Protocol 2.04:	(Kernel 2.6.14) Extend the syssize field to four bytes.
+
 Protocol 2.05:	(Kernel 2.6.20) Make protected mode kernel relocatable.
 		Introduce relocatable_kernel and kernel_alignment fields.
 
+Protocol 2.06:	(Kernel 2.6.22) Added a field that contains the size of
+		the boot command line
+
 
 **** MEMORY LAYOUT
 
@@ -133,6 +137,8 @@ Offset	Proto	Name		Meaning
 022C/4	2.03+	initrd_addr_max	Highest legal initrd address
 0230/4	2.05+	kernel_alignment Physical addr alignment required for kernel
 0234/1	2.05+	relocatable_kernel Whether kernel is relocatable or not
+0235/3	N/A	pad2		Unused
+0238/4	2.06+	cmdline_size	Maximum size of the kernel command line
 
 (1) For backwards compatibility, if the setup_sects field contains 0, the
     real value is 4.
@@ -233,6 +239,12 @@ filled out, however:
 	if your ramdisk is exactly 131072 bytes long and this field is
 	0x37FFFFFF, you can start your ramdisk at 0x37FE0000.)
 
+  cmdline_size:
+	The maximum size of the command line without the terminating
+	zero. This means that the command line can contain at most
+	cmdline_size characters. With protocol version 2.05 and
+	earlier, the maximum size was 255.
+
 
 **** THE KERNEL COMMAND LINE
 
@@ -241,11 +253,10 @@ loader to communicate with the kernel.  
 relevant to the boot loader itself, see "special command line options"
 below.
 
-The kernel command line is a null-terminated string currently up to
-255 characters long, plus the final null.  A string that is too long
-will be automatically truncated by the kernel, a boot loader may allow
-a longer command line to be passed to permit future kernels to extend
-this limit.
+The kernel command line is a null-terminated string. The maximum
+length can be retrieved from the field cmdline_size.  Before protocol
+version 2.06, the maximum was 255 characters.  A string that is too
+long will be automatically truncated by the kernel.
 
 If the boot protocol version is 2.02 or later, the address of the
 kernel command line is given by the header field cmd_line_ptr (see
arch/i386/boot/setup.S +6 -1
Index: longer-cmdline-boot-proto-mm/arch/i386/boot/setup.S
===================================================================
@@ -52,6 +52,7 @@
 #include <asm/boot.h>
 #include <asm/e820.h>
 #include <asm/page.h>
+#include <asm/setup.h>
 	
 /* Signature words to ensure LILO loaded us right */
 #define SIG1	0xAA55
@@ -81,7 +82,7 @@ start:
 # This is the setup header, and it must start at %cs:2 (old 0x9020:2)
 
 		.ascii	"HdrS"		# header signature
-		.word	0x0205		# header version number (>= 0x0105)
+		.word	0x0206		# header version number (>= 0x0105)
 					# or else old loadlin-1.5 will fail)
 realmode_swtch:	.word	0, 0		# default_switch, SETUPSEG
 start_sys_seg:	.word	SYSSEG
@@ -171,6 +172,10 @@ relocatable_kernel:    .byte 0
 pad2:			.byte 0
 pad3:			.word 0
 
+cmdline_size:   .long   COMMAND_LINE_SIZE-1     #length of the command line,
+                                                #added with boot protocol
+                                                #version 2.06
+
 trampoline:	call	start_of_setup
 		.align 16
 					# The offset at this point is 0x240
arch/x86_64/boot/setup.S +14 -1
Index: longer-cmdline-boot-proto-mm/arch/x86_64/boot/setup.S
===================================================================
@@ -51,6 +51,7 @@
 #include <asm/boot.h>
 #include <asm/e820.h>
 #include <asm/page.h>
+#include <asm/setup.h>
 
 /* Signature words to ensure LILO loaded us right */
 #define SIG1	0xAA55
@@ -80,7 +81,7 @@ start:
 # This is the setup header, and it must start at %cs:2 (old 0x9020:2)
 
 		.ascii	"HdrS"		# header signature
-		.word	0x0204		# header version number (>= 0x0105)
+		.word	0x0206		# header version number (>= 0x0105)
 					# or else old loadlin-1.5 will fail)
 realmode_swtch:	.word	0, 0		# default_switch, SETUPSEG
 start_sys_seg:	.word	SYSSEG
@@ -155,6 +156,18 @@ cmd_line_ptr:	.long 0			# (Header versio
 					# low memory 0x10000 or higher.
 
 ramdisk_max:	.long 0xffffffff
+
+kernel_alignment:  .long CONFIG_PHYSICAL_START 	#physical addr alignment
+						#(not relocatable =>
+						#fixed start == alignment)
+
+relocatable_kernel:     .byte 0                 #x86_64 is currently not
+pad2:			.byte 0                 #relocatable
+pad3:			.word 0
+
+cmdline_size:   .long   COMMAND_LINE_SIZE-1     #length of the command line,
+                                                #added with boot protocol
+                                                #version 2.06
 	
 trampoline:	call	start_of_setup
 		.align 16
#1 lore raw
Quoted 1 line · Bernhard Walle

+cmdline_size: .long COMMAND_LINE_SIZE-1 #length of the command line,

Why a long? It's unlikely that someone is going to have a command line bigger than 0xffff.

Dave

Signature · 1 line
http://www.codemonkey.org.uk
#2 lore raw
Quoted 6 lines · Dave Jones
Quoted 1 line · Bernhard Walle

+cmdline_size: .long COMMAND_LINE_SIZE-1 #length of the command line,

Why a long? It's unlikely that someone is going to have a command line bigger than 0xffff.

Well, I could imagine overflowing that. Describing your numa setup, excluding few bad bits of ram using memmap=exact, set up your boot over iscsi on cmdline.... these are likely to eat insane ammount of cmdline space.
Pavel

Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#3 lore raw
Quoted 5 lines · Pavel Machek
Quoted 4 lines · Dave Jones
Quoted 1 line · Bernhard Walle

+cmdline_size: .long COMMAND_LINE_SIZE-1 #length of the command line,

Quoted 7 lines
Quoted 2 lines

Why a long? It's unlikely that someone is going to have a command line bigger than 0xffff.

Well, I could imagine overflowing that. Describing your numa setup, excluding few bad bits of ram using memmap=exact, set up your boot over iscsi on cmdline.... these are likely to eat insane ammount of cmdline space.

65535 characters? Are you for real?
Stop and think about just how big that is. If you have to create a boot command line that long, you have serious, serious issues.

Dave

Signature · 1 line
http://www.codemonkey.org.uk
#4 lore raw

Hi!

Quoted 5 lines
Quoted 5 lines
Quoted 4 lines
Quoted 1 line

+cmdline_size: .long COMMAND_LINE_SIZE-1 #length of the command line,

Why a long? It's unlikely that someone is going to have a command line bigger than 0xffff.

Quoted 8 lines
Quoted 4 lines

Well, I could imagine overflowing that. Describing your numa setup, excluding few bad bits of ram using memmap=exact, set up your boot over iscsi on cmdline.... these are likely to eat insane ammount of cmdline space.

65535 characters? Are you for real?
Stop and think about just how big that is. If you have to create a boot command line that long, you have serious, serious issues.

Well, it is about the same size as my .config...

I agree we are unlikely to hit it any time soon... I could imagine some (ab)uses, like fixed_acpi_bios=<lots of hex digits>, but those are ugly. I could also imagine some uses where entire embedded machine is described at kernel commandline.

Yes, all those are ugly/unlikely. OTOH saving 2 bytes does not seem like that great goal.
Pavel

Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#5 lore raw
Quoted 5 lines · Pavel Machek
Quoted 3 lines

65535 characters? Are you for real?
Stop and think about just how big that is. If you have to create a boot command line that long, you have serious, serious issues.

Well, it is about the same size as my .config...

So? That has *nothing* to do with the boot command line

Quoted 3 lines

I agree we are unlikely to hit it any time soon... I could imagine some (ab)uses, like fixed_acpi_bios=<lots of hex digits>, but those are ugly.

That's beyond ugly, and rapidly heading towards 'loony'.

Quoted 2 lines

I could also imagine some uses where entire embedded machine is described at kernel commandline.

There are far better ways to get configuration into the kernel than the boot command line.

Anyways, I'm tired of arguing for the sake of arguing. I really could care less.

Dave

Signature · 1 line
http://www.codemonkey.org.uk
#6 lore raw
In reply to Bernhard Walle

Documentation/i386/boot.txt loader to communicate with the kernel. · line 259

Quoted 4 lines · Bernhard Walle
Documentation/i386/boot.txt +4 -0
+The kernel command line is a null-terminated string. The maximum
+length can be retrieved from the field cmdline_size.  Before protocol
+version 2.06, the maximum was 255 characters.  A string that is too
+long will be automatically truncated by the kernel.

This is incorrect.
Since 2.02, the maximum was null terminated string truncated by kernel.

Best Regards,
Alon Bar-Lev.

#7 lore raw
In reply to Bernhard Walle
Quoted 5 lines · Bernhard Walle

Because the command line is increased to 2048 characters after 2.6.21, it's not possible for boot loaders and userspace tools to determine the length of the command line the kernel can understand. The benefit of knowing the length is that users can be warned if the command line size is too long which prevents surprise if things don't work after bootup.

This makes sense to me. It can be used in kexec bootloader to warn user if command line size exceeds than supported by kernel.

Quoted 7 lines

This patch updates the boot protocol to contain a field called "cmdline_size" that contain the length of the command line (excluding the terminating zero).

The patch also adds missing fields (of protocol version 2.05) to the x86_64 setup code.

Today I have posted the x86_64 relocatable kernel patches which also fill in missing 2.05 fields for x86_64.

[..]

Quoted 11 lines

#define SIG1 0xAA55

arch/i386/boot/setup.S +1 -1
@@ -81,7 +82,7 @@ start:
 # This is the setup header, and it must start at %cs:2 (old 0x9020:2)
 
 		.ascii	"HdrS"		# header signature
-		.word	0x0205		# header version number (>= 0x0105)
+		.word	0x0206		# header version number (>= 0x0105)
 					# or else old loadlin-1.5 will fail)
 realmode_swtch:	.word	0, 0		# default_switch, SETUPSEG
 start_sys_seg:	.word	SYSSEG

arch/i386/boot/setup.S relocatable_kernel: .byte 0 · line 178

Quoted 7 lines
arch/i386/boot/setup.S +4 -0
@@ -171,6 +172,10 @@ relocatable_kernel:    .byte 0
 pad2:			.byte 0
 pad3:			.word 0
 
+cmdline_size:   .long   COMMAND_LINE_SIZE-1     #length of the command line,
+                                                #added with boot protocol
+                                                #version 2.06
+

I think you will not require more than two bytes to represent supported command line size so you can use replace pad3 and use these two bytes. These were anyway padding bytes to be used for other requirements.

[..]

arch/i386/boot/setup.S cmd_line_ptr: .long 0 # (Header versio · line 163

Quoted 12 lines
arch/i386/boot/setup.S +5 -0
 					# or else old loadlin-1.5 will fail)
 realmode_swtch:	.word	0, 0		# default_switch, SETUPSEG
 start_sys_seg:	.word	SYSSEG
@@ -155,6 +156,18 @@ cmd_line_ptr:	.long 0			# (Header versio
 					# low memory 0x10000 or higher.
 
 ramdisk_max:	.long 0xffffffff
+
+kernel_alignment:  .long CONFIG_PHYSICAL_START 	#physical addr alignment
+						#(not relocatable =>
+						#fixed start == alignment)
+

This is wrong. CONFIG_PHYSICAL_START is not alignment. On x86_64 alignment required is 2MB. (0x200000).

Thanks
Vivek