Skip to contentSkip to conversation

x86, relocs: move ELF relocation handling to C

PATCH Superseded Kees Cook 4 participants 6 messages Jun 11, 2013 – Jun 12, 2013 x86

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 x86, relocs: move ELF relocation handling to C

Moves the relocation handling into C, after decompression. This requires that the decompressed size is passed to the decompression routine as well so that relocations can be found. Only kernels that need relocation support will use the code.

Based on work by Neill Clift and Michael Davidson.

---
 arch/x86/Kconfig                     |    4 +-
 arch/x86/Makefile                    |    8 ++--
 arch/x86/boot/compressed/head_32.S   |   31 ++------------
 arch/x86/boot/compressed/head_64.S   |    1 +
 arch/x86/boot/compressed/misc.c      |   77 +++++++++++++++++++++++++++++++++-
 arch/x86/include/asm/page_32_types.h |    2 +
 arch/x86/include/asm/page_64_types.h |    5 ---
 arch/x86/include/asm/page_types.h    |    6 +++
 8 files changed, 94 insertions(+), 40 deletions(-)
arch/x86/Kconfig +2 -2
index 685692c..b4797b9 100644
@@ -1695,13 +1695,13 @@ config RELOCATABLE
 	  it has been loaded at and the compile time physical address
 	  (CONFIG_PHYSICAL_START) is ignored.
 
-# Relocation on x86-32 needs some additional build support
+# Relocation on x86 needs some additional build support
 config X86_NEED_RELOCS
 	def_bool y
 	depends on X86_32 && RELOCATABLE
 
 config PHYSICAL_ALIGN
-	hex "Alignment value to which kernel should be aligned" if X86_32
+	hex "Alignment value to which kernel should be aligned"
 	default "0x1000000"
 	range 0x2000 0x1000000
 	---help---
arch/x86/Makefile +4 -4
index 5c47726..43f8cef 100644
@@ -16,6 +16,10 @@ endif
 # e.g.: obj-y += foo_$(BITS).o
 export BITS
 
+ifdef CONFIG_X86_NEED_RELOCS
+        LDFLAGS_vmlinux := --emit-relocs
+endif
+
 ifeq ($(CONFIG_X86_32),y)
         BITS := 32
         UTS_MACHINE := i386
@@ -25,10 +29,6 @@ ifeq ($(CONFIG_X86_32),y)
         KBUILD_AFLAGS += $(biarch)
         KBUILD_CFLAGS += $(biarch)
 
-        ifdef CONFIG_RELOCATABLE
-                LDFLAGS_vmlinux := --emit-relocs
-        endif
-
         KBUILD_CFLAGS += -msoft-float -mregparm=3 -freg-struct-return
 
         # Never want PIC in a 32-bit kernel, prevent breakage with GCC built
arch/x86/boot/compressed/head_32.S +3 -28
index 1e3184f..5d6f689 100644
@@ -181,8 +181,9 @@ relocated:
 /*
  * Do the decompression, and jump to the new kernel..
  */
-	leal	z_extract_offset_negative(%ebx), %ebp
 				/* push arguments for decompress_kernel: */
+	pushl	$z_output_len	/* decompressed length */
+	leal	z_extract_offset_negative(%ebx), %ebp
 	pushl	%ebp		/* output address */
 	pushl	$z_input_len	/* input_len */
 	leal	input_data(%ebx), %eax
@@ -191,33 +192,7 @@ relocated:
 	pushl	%eax		/* heap area */
 	pushl	%esi		/* real mode pointer */
 	call	decompress_kernel
-	addl	$20, %esp
-
-#if CONFIG_RELOCATABLE
-/*
- * Find the address of the relocations.
- */
-	leal	z_output_len(%ebp), %edi
-
-/*
- * Calculate the delta between where vmlinux was compiled to run
- * and where it was actually loaded.
- */
-	movl	%ebp, %ebx
-	subl	$LOAD_PHYSICAL_ADDR, %ebx
-	jz	2f	/* Nothing to be done if loaded at compiled addr. */
-/*
- * Process relocations.
- */
-
-1:	subl	$4, %edi
-	movl	(%edi), %ecx
-	testl	%ecx, %ecx
-	jz	2f
-	addl	%ebx, -__PAGE_OFFSET(%ebx, %ecx)
-	jmp	1b
-2:
-#endif
+	addl	$24, %esp
 
 /*
  * Jump to the decompressed kernel.
arch/x86/boot/compressed/head_64.S +1 -0
index 16f24e6..6632693 100644
@@ -340,6 +340,7 @@ relocated:
 	leaq	input_data(%rip), %rdx  /* input_data */
 	movl	$z_input_len, %ecx	/* input_len */
 	movq	%rbp, %r8		/* output target address */
+	movq	$z_output_len, %r9	/* decompressed length */
 	call	decompress_kernel
 	popq	%rsi
 
arch/x86/boot/compressed/misc.c +76 -1

95 lines not on this page · raw message

arch/x86/include/asm/page_32_types.h +2 -0
index ef17af0..f48b17d 100644
@@ -15,6 +15,8 @@
  */
 #define __PAGE_OFFSET		_AC(CONFIG_PAGE_OFFSET, UL)
 
+#define __START_KERNEL_map	__PAGE_OFFSET
+
 #define THREAD_SIZE_ORDER	1
 #define THREAD_SIZE		(PAGE_SIZE << THREAD_SIZE_ORDER)
 
arch/x86/include/asm/page_64_types.h +0 -5
index 6c896fb..43dcd80 100644
@@ -32,11 +32,6 @@
  */
 #define __PAGE_OFFSET           _AC(0xffff880000000000, UL)
 
-#define __PHYSICAL_START	((CONFIG_PHYSICAL_START +	 	\
-				  (CONFIG_PHYSICAL_ALIGN - 1)) &	\
-				 ~(CONFIG_PHYSICAL_ALIGN - 1))
-
-#define __START_KERNEL		(__START_KERNEL_map + __PHYSICAL_START)
 #define __START_KERNEL_map	_AC(0xffffffff80000000, UL)
 
 /* See Documentation/x86/x86_64/mm.txt for a description of the memory map. */
arch/x86/include/asm/page_types.h +6 -0
index 54c9787..086c2fa 100644
@@ -33,6 +33,12 @@
 	(((current->personality & READ_IMPLIES_EXEC) ? VM_EXEC : 0 ) | \
 	 VM_READ | VM_WRITE | VM_MAYREAD | VM_MAYWRITE | VM_MAYEXEC)
 
+#define __PHYSICAL_START	((CONFIG_PHYSICAL_START +		\
+				  (CONFIG_PHYSICAL_ALIGN - 1)) &	\
+				 ~(CONFIG_PHYSICAL_ALIGN - 1))
+
+#define __START_KERNEL		(__START_KERNEL_map + __PHYSICAL_START)
+
 #ifdef CONFIG_X86_64
 #include <asm/page_64_types.h>
 #else
Signature · 6 lines
1.7.9.5


-- 
Kees Cook
Chrome OS Security
#1 lore raw

Hello Kees,

Quoted 8 lines · Kees Cook

Moves the relocation handling into C, after decompression. This requires that the decompressed size is passed to the decompression routine as well so that relocations can be found. Only kernels that need relocation support will use the code.

Based on work by Neill Clift and Michael Davidson.

How does the kernel benefit from this? Are there problems with the current assembly code? Are you planning to improve the relocation code?

Pekka

author
#2 lore raw
Quoted 8 lines · Pekka Enberg

Hello Kees,

Quoted 5 lines · Kees Cook

Moves the relocation handling into C, after decompression. This requires that the decompressed size is passed to the decompression routine as well so that relocations can be found. Only kernels that need relocation support will use the code.

Quoted 6 lines
Quoted 3 lines

Based on work by Neill Clift and Michael Davidson.

How does the kernel benefit from this? Are there problems with the current assembly code? Are you planning to improve the relocation code?

Yes, this is continuing the work needed for 64-bit relocations, ultimately needed by KASLR. As part of the work, I was asked to move the relocation logic from assembly into C. Doing this means that there isn't any need for duplicating the logic in the 64-bit path (e.g. head_64.S).

Since the other relocation work is already in the tree, I wanted to get these last two pieces in (one was a fix for the __vvar_page -- separate patch, the other is this one, allowing 64-bit relocations to operate while also moving the logic into C).

-Kees

--
Kees Cook
Chrome OS Security

Reviewed-by
#3 lore raw
Quoted 22 lines · Kees Cook
Quoted 8 lines · Pekka Enberg

Hello Kees,

Quoted 5 lines · Kees Cook

Moves the relocation handling into C, after decompression. This requires that the decompressed size is passed to the decompression routine as well so that relocations can be found. Only kernels that need relocation support will use the code.

Quoted 6 lines
Quoted 3 lines

Based on work by Neill Clift and Michael Davidson.

How does the kernel benefit from this? Are there problems with the current assembly code? Are you planning to improve the relocation code?

Yes, this is continuing the work needed for 64-bit relocations, ultimately needed by KASLR. As part of the work, I was asked to move the relocation logic from assembly into C. Doing this means that there isn't any need for duplicating the logic in the 64-bit path (e.g. head_64.S).

Quoted 4 lines

Since the other relocation work is already in the tree, I wanted to get these last two pieces in (one was a fix for the __vvar_page -- separate patch, the other is this one, allowing 64-bit relocations to operate while also moving the logic into C).

OK, that's definitely changelog material.

I'm not that familiar with the code your touching but FWIW:

#4 lore raw
In reply to Kees Cook
Quoted 192 lines · Kees Cook

Moves the relocation handling into C, after decompression. This requires that the decompressed size is passed to the decompression routine as well so that relocations can be found. Only kernels that need relocation support will use the code.

Based on work by Neill Clift and Michael Davidson.

---
 arch/x86/Kconfig                     |    4 +-
 arch/x86/Makefile                    |    8 ++--
 arch/x86/boot/compressed/head_32.S   |   31 ++------------
 arch/x86/boot/compressed/head_64.S   |    1 +
 arch/x86/boot/compressed/misc.c      |   77 +++++++++++++++++++++++++++++++++-
 arch/x86/include/asm/page_32_types.h |    2 +
 arch/x86/include/asm/page_64_types.h |    5 ---
 arch/x86/include/asm/page_types.h    |    6 +++
 8 files changed, 94 insertions(+), 40 deletions(-)
arch/x86/Kconfig +2 -2
index 685692c..b4797b9 100644
@@ -1695,13 +1695,13 @@ config RELOCATABLE
          it has been loaded at and the compile time physical address
          (CONFIG_PHYSICAL_START) is ignored.
 
-# Relocation on x86-32 needs some additional build support
+# Relocation on x86 needs some additional build support
 config X86_NEED_RELOCS
        def_bool y
        depends on X86_32 && RELOCATABLE
 
 config PHYSICAL_ALIGN
-       hex "Alignment value to which kernel should be aligned" if X86_32
+       hex "Alignment value to which kernel should be aligned"
        default "0x1000000"
        range 0x2000 0x1000000
        ---help---
arch/x86/Makefile +4 -4
index 5c47726..43f8cef 100644
@@ -16,6 +16,10 @@ endif
 # e.g.: obj-y += foo_$(BITS).o
 export BITS
 
+ifdef CONFIG_X86_NEED_RELOCS
+        LDFLAGS_vmlinux := --emit-relocs
+endif
+
 ifeq ($(CONFIG_X86_32),y)
         BITS := 32
         UTS_MACHINE := i386
@@ -25,10 +29,6 @@ ifeq ($(CONFIG_X86_32),y)
         KBUILD_AFLAGS += $(biarch)
         KBUILD_CFLAGS += $(biarch)
 
-        ifdef CONFIG_RELOCATABLE
-                LDFLAGS_vmlinux := --emit-relocs
-        endif
-
         KBUILD_CFLAGS += -msoft-float -mregparm=3 -freg-struct-return
 
         # Never want PIC in a 32-bit kernel, prevent breakage with GCC built
arch/x86/boot/compressed/head_32.S +3 -28
index 1e3184f..5d6f689 100644
@@ -181,8 +181,9 @@ relocated:
 /*
  * Do the decompression, and jump to the new kernel..
  */
-       leal    z_extract_offset_negative(%ebx), %ebp
                                /* push arguments for decompress_kernel: */
+       pushl   $z_output_len   /* decompressed length */
+       leal    z_extract_offset_negative(%ebx), %ebp
        pushl   %ebp            /* output address */
        pushl   $z_input_len    /* input_len */
        leal    input_data(%ebx), %eax
@@ -191,33 +192,7 @@ relocated:
        pushl   %eax            /* heap area */
        pushl   %esi            /* real mode pointer */
        call    decompress_kernel
-       addl    $20, %esp
-
-#if CONFIG_RELOCATABLE
-/*
- * Find the address of the relocations.
- */
-       leal    z_output_len(%ebp), %edi
-
-/*
- * Calculate the delta between where vmlinux was compiled to run
- * and where it was actually loaded.
- */
-       movl    %ebp, %ebx
-       subl    $LOAD_PHYSICAL_ADDR, %ebx
-       jz      2f      /* Nothing to be done if loaded at compiled addr. */
-/*
- * Process relocations.
- */
-
-1:     subl    $4, %edi
-       movl    (%edi), %ecx
-       testl   %ecx, %ecx
-       jz      2f
-       addl    %ebx, -__PAGE_OFFSET(%ebx, %ecx)
-       jmp     1b
-2:
-#endif
+       addl    $24, %esp
 
 /*
  * Jump to the decompressed kernel.
arch/x86/boot/compressed/head_64.S +1 -0
index 16f24e6..6632693 100644
@@ -340,6 +340,7 @@ relocated:
        leaq    input_data(%rip), %rdx  /* input_data */
        movl    $z_input_len, %ecx      /* input_len */
        movq    %rbp, %r8               /* output target address */
+       movq    $z_output_len, %r9      /* decompressed length */
        call    decompress_kernel
        popq    %rsi
 
arch/x86/boot/compressed/misc.c +57 -0
index 7cb56c6..b756a04 100644
@@ -267,6 +267,79 @@ static void error(char *x)
                asm("hlt");
 }
 
+#if CONFIG_X86_NEED_RELOCS
+static void handle_relocations(void *output, unsigned long output_len)
+{
+       int *reloc;
+       unsigned long delta, map, ptr;
+       unsigned long min_addr = (unsigned long)output;
+       unsigned long max_addr = min_addr + output_len;
+
+       /*
+        * Calculate the delta between where vmlinux was linked to load
+        * and where it was actually loaded.
+        */
+       delta = min_addr - LOAD_PHYSICAL_ADDR;
+       if (!delta) {
+               debug_putstr("No relocation needed... ");
+               return;
+       }
+       debug_putstr("Performing relocations... ");
+
+       /*
+        * The kernel contains a table of relocation addresses. Those
+        * addresses have the final load address of the kernel in virtual
+        * memory. We are currently working in the self map. So we need to
+        * create an adjustment for kernel memory addresses to the self map.
+        * This will involve subtracting out the base address of the kernel.
+        */
+       map = delta - __START_KERNEL_map;
+
+       /*
+        * Process relocations: 32 bit relocations first then 64 bit after.
+        * Two sets of binary relocations are added to the end of the kernel
+        * before compression. Each relocation table entry is the kernel
+        * address of the location which needs to be updated stored as a
+        * 32-bit value which is sign extended to 64 bits.
+        *
+        * Format is:
+        *
+        * kernel bits...
+        * 0 - zero terminator for 64 bit relocations
+        * 64 bit relocation repeated
+        * 0 - zero terminator for 32 bit relocations
+        * 32 bit relocation repeated
+        *
+        * So we work backwards from the end of the decompressed image.
+        */
+       for (reloc = output + output_len - sizeof(*reloc); *reloc; reloc--) {
+               int extended = *reloc;
+               extended += map;
+
+               ptr = (unsigned long)extended;
+               if (ptr < min_addr || ptr > max_addr)
+                       error("32-bit relocation outside of kernel!\n");
+
+               *(uint32_t *)ptr += delta;
+       }
+#ifdef CONFIG_X86_64
+       for (reloc--; *reloc; reloc--) {

arch/x86/boot/compressed/misc.c static void error(char *x) · line 336

Quoted 10 lines
arch/x86/boot/compressed/misc.c +10 -0
+               long extended = *reloc;
+               extended += map;
+
+               ptr = (unsigned long)extended;
+               if (ptr < min_addr || ptr > max_addr)
+                       error("64-bit relocation outside of kernel!\n");
+
+               *(uint64_t *)ptr += delta;
+       }
+#endif

it seems those lines for x86_64 are never used.
as X86_NEED_RELOCS is not defined for x86_64

arch/x86/boot/compressed/misc.c static void error(char *x) · line 341

Quoted 10 lines
arch/x86/boot/compressed/misc.c +5 -0
 config X86_NEED_RELOCS
        def_bool y
        depends on X86_32 && RELOCATABLE
 
 
+}
+#else
+static inline void handle_relocations(void *output, unsigned long output_len)
+{ }
+#endif

Can you make it clear that this patch only affect x86_32 in patch title?

Yinghai

#5 lore raw
Quoted 9 lines · Yinghai Lu

it seems those lines for x86_64 are never used.
as X86_NEED_RELOCS is not defined for x86_64

Quoted 3 lines

config X86_NEED_RELOCS

        def_bool y
        depends on X86_32 && RELOCATABLE
Quoted 8 lines

arch/x86/boot/compressed/misc.c static void error(char *x) · line 341

Quoted 5 lines
arch/x86/boot/compressed/misc.c +5 -0
+}
+#else
+static inline void handle_relocations(void *output, unsigned long output_len)
+{ }
+#endif

Can you make it clear that this patch only affect x86_32 in patch title?

I am not sure this belongs in the patch title, as it is preparatory work for x86-64. It should be mentioned in the patch description body, though.

-hpa