Skip to contentSkip to conversation

add description for jumping back to the original kernel in man page

PATCH Superseded Gioh Kim 2 participants 3 messages Feb 15, 2018 – Feb 16, 2018

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Gioh Kim

author
#0 lore raw

PATCH 1/1 add description for jumping back to the original kernel in man page

"--load-preserve-context", "--load-jump-back-helper" and "--entry" options are described separately but there is not any description how to use them.

---
 kexec/kexec.8 | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
kexec/kexec.8 +30 -0
index e0131b4..b7ac028 100644
@@ -30,6 +30,9 @@ when configuring the kernel. The
 option enables the
 .B kexec
 system call.
+After booting into another kernel, you can jump back to the first kernel with enabling
+.B CONFIG_KEXEC_JUMP
+option (x86 only).
 .SH USAGE
 Using
 .B kexec
@@ -102,6 +105,30 @@ command:
 .BR kexec \ \-e
 .RE
 
+After booting the kernel, you can jump back to the first kernel if you enable
+.B CONFIG_KEXEC_JUMP
+kernel option and specify \-\-load\-preserve\-context option.
+You can see
+.BR "kexec_jump_back_entry=<address>"
+kernel parameter in /proc/cmdline file, for example:
+
+.RS
+.BR "kexec_jump_back_entry=0x00000000000810d2"
+.RE
+
+Frist you need to prepare jump with \-\-load\-jump\-back\-helper and \-\-entry options.
+
+.RS
+.B kexec
+.RB \-\-load\-jump\-back\-helper \-\-entry=0x810d2
+.RE
+
+Then the first kernel can be rebooted using the command:
+
+.RS
+.BR kexec \ \-e
+.RE
+
 .SH OPTIONS
 .TP
 .B \-d\ (\-\-debug)
@@ -173,6 +200,9 @@ Specify the jump back address. (0 means it's not jump back or preserve context)
 .TP
 .BI \-\-load\-preserve\-context
 Load the new kernel and preserve context of current kernel during kexec.
+(kexec returns error if
+.B CONFIG_KEXEC_JUMP
+is not enabled)
 .TP
 .BI \-\-load\-jump\-back\-helper
 Load a helper image to jump back to original kernel.
Signature · 7 lines
2.14.1


_______________________________________________
kexec mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/kexec
#1 lore raw

Hi,

Some nitpicks inline..

Quoted 14 lines · Gioh Kim

"--load-preserve-context", "--load-jump-back-helper" and "--entry" options are described separately but there is not any description how to use them.

---
 kexec/kexec.8 | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
kexec/kexec.8 +0 -0
index e0131b4..b7ac028 100644

kexec/kexec.8 when configuring the kernel. The · line 33

Quoted 4 lines
kexec/kexec.8 +1 -0
@@ -30,6 +30,9 @@ when configuring the kernel. The
 option enables the
 .B kexec
 system call.
+After booting into another kernel, you can jump back to the first kernel with enabling

I would suggest using the already prevalent naming conventions - primary kernel and secondary kernel for the two kernels.

kexec/kexec.8 when configuring the kernel. The · line 35

Quoted 2 lines
kexec/kexec.8 +2 -0
+.B CONFIG_KEXEC_JUMP
+option (x86 only).

I think this is also supported on sh architecture, so may be you can reword this to something like:
(currently only x86 and sh architectures are supported).

kexec/kexec.8 command: · line 110

Quoted 10 lines
kexec/kexec.8 +3 -0
 .SH USAGE
 Using
 .B kexec
@@ -102,6 +105,30 @@ command:
 .BR kexec \ \-e
 .RE
 
+After booting the kernel, you can jump back to the first kernel if you enable
+.B CONFIG_KEXEC_JUMP
+kernel option and specify \-\-load\-preserve\-context option.

Do we need to repeat the details of CONFIG_KEXEC_JUMP here and below, as we have already the captured the same above.

kexec/kexec.8 command: · line 111

Quoted 1 line
kexec/kexec.8 +1 -0
+You can see

^^^ specify (instead of see)

kexec/kexec.8 command: · line 116

Quoted 5 lines
kexec/kexec.8 +5 -0
+.BR "kexec_jump_back_entry=<address>"
+kernel parameter in /proc/cmdline file, for example:
+
+.RS
+.BR "kexec_jump_back_entry=0x00000000000810d2"

Better to specify literal addr instead of specifying a value here.

kexec/kexec.8 command: · line 119

Quoted 3 lines
kexec/kexec.8 +3 -0
+.RE
+
+Frist you need to prepare jump with \-\-load\-jump\-back\-helper and \-\-entry options.

^^^ First (rather than Frist)

kexec/kexec.8 command: · line 123

Quoted 4 lines
kexec/kexec.8 +4 -0
+
+.RS
+.B kexec
+.RB \-\-load\-jump\-back\-helper \-\-entry=0x810d2

Better to use literal addr instead of specifying a particular value here, to keep the man page generic.

Regards,
Bhupesh

Quoted 22 lines
kexec/kexec.8 +11 -1
+.RE
+
+Then the first kernel can be rebooted using the command:
+
+.RS
+.BR kexec \ \-e
+.RE
+
 .SH OPTIONS
 .TP
 .B \-d\ (\-\-debug)
@@ -173,6 +200,9 @@ Specify the jump back address. (0 means it's not jump back or preserve context)
 .TP
 .BI \-\-load\-preserve\-context
 Load the new kernel and preserve context of current kernel during kexec.
+(kexec returns error if
+.B CONFIG_KEXEC_JUMP
+is not enabled)
 .TP
 .BI \-\-load\-jump\-back\-helper
 Load a helper image to jump back to original kernel.
--
Quoted 2 lines

2.14.1

_______________________________________________
kexec mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/kexec

author
#2 lore raw
Quoted 3 lines · Bhupesh SHARMA

Hi,

Some nitpicks inline..

I thank you again for your review.
I'll send the second version patch soon.

Quoted 98 lines · Gioh Kim
Quoted 14 lines

"--load-preserve-context", "--load-jump-back-helper" and "--entry" options are described separately but there is not any description how to use them.

---
 kexec/kexec.8 | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
kexec/kexec.8 +0 -0
index e0131b4..b7ac028 100644

kexec/kexec.8 when configuring the kernel. The · line 33

Quoted 4 lines
kexec/kexec.8 +1 -0
@@ -30,6 +30,9 @@ when configuring the kernel. The
 option enables the
 .B kexec
 system call.
+After booting into another kernel, you can jump back to the first kernel with enabling

I would suggest using the already prevalent naming conventions - primary kernel and secondary kernel for the two kernels.

kexec/kexec.8 when configuring the kernel. The · line 35

Quoted 2 lines
kexec/kexec.8 +2 -0
+.B CONFIG_KEXEC_JUMP
+option (x86 only).

I think this is also supported on sh architecture, so may be you can reword this to something like:
(currently only x86 and sh architectures are supported).

kexec/kexec.8 command: · line 110

Quoted 10 lines
kexec/kexec.8 +3 -0
 .SH USAGE
 Using
 .B kexec
@@ -102,6 +105,30 @@ command:
 .BR kexec \ \-e
 .RE
 
+After booting the kernel, you can jump back to the first kernel if you enable
+.B CONFIG_KEXEC_JUMP
+kernel option and specify \-\-load\-preserve\-context option.

Do we need to repeat the details of CONFIG_KEXEC_JUMP here and below, as we have already the captured the same above.

kexec/kexec.8 command: · line 111

Quoted 1 line
kexec/kexec.8 +1 -0
+You can see

^^^ specify (instead of see)

kexec/kexec.8 command: · line 116

Quoted 5 lines
kexec/kexec.8 +5 -0
+.BR "kexec_jump_back_entry=<address>"
+kernel parameter in /proc/cmdline file, for example:
+
+.RS
+.BR "kexec_jump_back_entry=0x00000000000810d2"

Better to specify literal addr instead of specifying a value here.

kexec/kexec.8 command: · line 119

Quoted 3 lines
kexec/kexec.8 +3 -0
+.RE
+
+Frist you need to prepare jump with \-\-load\-jump\-back\-helper and \-\-entry options.

^^^ First (rather than Frist)

kexec/kexec.8 command: · line 123

Quoted 4 lines
kexec/kexec.8 +4 -0
+
+.RS
+.B kexec
+.RB \-\-load\-jump\-back\-helper \-\-entry=0x810d2

Better to use literal addr instead of specifying a particular value here, to keep the man page generic.

Regards,
Bhupesh

Quoted 24 lines
kexec/kexec.8 +11 -1
+.RE
+
+Then the first kernel can be rebooted using the command:
+
+.RS
+.BR kexec \ \-e
+.RE
+
 .SH OPTIONS
 .TP
 .B \-d\ (\-\-debug)
@@ -173,6 +200,9 @@ Specify the jump back address. (0 means it's not jump back or preserve context)
 .TP
 .BI \-\-load\-preserve\-context
 Load the new kernel and preserve context of current kernel during kexec.
+(kexec returns error if
+.B CONFIG_KEXEC_JUMP
+is not enabled)
 .TP
 .BI \-\-load\-jump\-back\-helper
 Load a helper image to jump back to original kernel.
--

2.14.1

Signature · 20 lines
GIOH KIM
Linux Kernel Entwickler

ProfitBricks GmbH
Greifswalder Str. 207
D - 10405 Berlin

Tel:       +49 176 2697 8962
Fax:      +49 30 577 008 299
Email:    [email protected]
URL:      https://www.profitbricks.de

Sitz der Gesellschaft: Berlin
Registergericht: Amtsgericht Charlottenburg, HRB 125506 B
Geschäftsführer: Achim Weiss, Matthias Steinberg

_______________________________________________
kexec mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/kexec