From: Joe Lawrence <joe.lawrence@redhat.com>
To: Petr Mladek <pmladek@suse.com>
Cc: Jiri Kosina <jikos@kernel.org>,
Josh Poimboeuf <jpoimboe@redhat.com>,
Miroslav Benes <mbenes@suse.cz>, Jason Baron <jbaron@akamai.com>,
Evgenii Shatokhin <eshatokhin@virtuozzo.com>,
live-patching@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v14 09/11] livepatch: Atomic replace and cumulative patches documentation
Date: Wed, 5 Dec 2018 15:20:34 -0500 [thread overview]
Message-ID: <20181205202034.a66aulfbkl4abr3q@redhat.com> (raw)
In-Reply-To: <20181129094431.7801-10-pmladek@suse.com>
On Thu, Nov 29, 2018 at 10:44:29AM +0100, Petr Mladek wrote:
> User documentation for the atomic replace feature. It makes it easier
> to maintain livepatches using so-called cumulative patches.
>
> Signed-off-by: Petr Mladek <pmladek@suse.com>
> ---
Acked-by: Joe Lawrence <joe.lawrence@redhat.com>
> Documentation/livepatch/cumulative-patches.txt | 105 +++++++++++++++++++++++++
> 1 file changed, 105 insertions(+)
> create mode 100644 Documentation/livepatch/cumulative-patches.txt
>
> diff --git a/Documentation/livepatch/cumulative-patches.txt b/Documentation/livepatch/cumulative-patches.txt
> new file mode 100644
> index 000000000000..a8089f7fe306
> --- /dev/null
> +++ b/Documentation/livepatch/cumulative-patches.txt
> @@ -0,0 +1,105 @@
> +===================================
> +Atomic Replace & Cumulative Patches
> +===================================
> +
> +There might be dependencies between livepatches. If multiple patches need
> +to do different changes to the same function(s) then we need to define
> +an order in which the patches will be installed. And function implementations
> +from any newer livepatch must be done on top of the older ones.
> +
> +This might become a maintenance nightmare. Especially if anyone would want
> +to remove a patch that is in the middle of the stack.
> +
> +An elegant solution comes with the feature called "Atomic Replace". It allows
> +to create so called "Cumulative Patches". They include all wanted changes
^^^^^^^^^
re-wording suggestion: "creation of"
> +from all older livepatches and completely replace them in one transition.
> +
> +Usage
> +-----
> +
> +The atomic replace can be enabled by setting "replace" flag in struct klp_patch,
> +for example:
> +
> + static struct klp_patch patch = {
> + .mod = THIS_MODULE,
> + .objs = objs,
> + .replace = true,
> + };
> +
> +Such a patch is added on top of the livepatch stack when enabled.
> +
> +All processes are then migrated to use the code only from the new patch.
> +Once the transition is finished, all older patches are automatically
> +disabled and removed from the stack of patches.
> +
> +Ftrace handlers are transparently removed from functions that are no
> +longer modified by the new cumulative patch.
> +
> +As a result, the livepatch authors might maintain sources only for one
> +cumulative patch. It helps to keep the patch consistent while adding or
> +removing various fixes or features.
> +
> +Users could keep only the last patch installed on the system after
> +the transition to has finished. It helps to clearly see what code is
> +actually in use. Also the livepatch might then be seen as a "normal"
> +module that modifies the kernel behavior. The only difference is that
> +it can be updated at runtime without breaking its functionality.
> +
> +
> +Features
> +--------
> +
> +The atomic replace allows:
> +
> + + Atomically revert some functions in a previous patch while
> + upgrading other functions.
> +
> + + Remove eventual performance impact caused by core redirection
> + for functions that are no longer patched.
> +
> + + Decrease user confusion about stacking order and what code
> + is actually in use.
> +
> +
> +Limitations:
> +------------
> +
> + + Once the operation finishes, there is no straightforward way
> + to reverse it and restore the replaced patches atomically.
> +
> + A good practice is to set .replace flag in any released livepatch.
> + Then re-adding an older livepatch is equivalent to downgrading
> + to that patch. This is safe as long as the livepatches do _not_ do
> + extra modifications in (un)patching callbacks or in the module_init()
> + or module_exit() functions, see below.
> +
> + Also note that the replaced patch can be removed and loaded again
> + only when the transition was not forced.
> +
> +
> + + Only the (un)patching callbacks from the _new_ cumulative livepatch are
> + executed. Any callbacks from the replaced patches are ignored.
> +
> + In other words, the cumulative patch is responsible for doing any actions
> + that are necessary to properly replace any older patch.
> +
> + As a result, it might be dangerous to replace newer cumulative patches by
> + older ones. The old livepatches might not provide the necessary callbacks.
> +
> + This might be seen as a limitation in some scenarios. But it makes the life
^^^^^^^^
s/the life/life
> + easier in many others. Only the new cumulative livepatch knows what
> + fixes/features are added/removed and what special actions are necessary
> + for a smooth transition.
> +
> + In any case, it would be a nightmare to think about the order of
> + the various callbacks and their interactions if the callbacks from all
> + enabled patches were called.
> +
> +
> + + There is no special handling of shadow variables. Livepatch authors
> + must create their own rules how to pass them from one cumulative
> + patch to the other. Especially they should not blindly remove them
^^^^^^^^^^^^^^^
rewording suggestion: "Especially that they"
> + in module_exit() functions.
> +
> + A good practice might be to remove shadow variables in the post-unpatch
> + callback. It is called only when the livepatch is properly disabled.
> --
> 2.13.7
>
-- Joe
next prev parent reply other threads:[~2018-12-05 20:20 UTC|newest]
Thread overview: 77+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-11-29 9:44 [PATCH v14 00/11] livepatch: Atomic replace feature Petr Mladek
2018-11-29 9:44 ` [PATCH v14 01/11] livepatch: Change unsigned long old_addr -> void *old_func in struct klp_func Petr Mladek
2018-12-03 13:24 ` Miroslav Benes
2018-12-05 18:45 ` Joe Lawrence
2018-12-06 11:08 ` Alice Ferrazzi
2018-11-29 9:44 ` [PATCH v14 02/11] livepatch: Shuffle klp_enable_patch()/klp_disable_patch() code Petr Mladek
2018-12-03 13:36 ` Miroslav Benes
2018-12-05 18:45 ` Joe Lawrence
2018-11-29 9:44 ` [PATCH v14 03/11] livepatch: Consolidate klp_free functions Petr Mladek
2018-12-03 14:59 ` Miroslav Benes
2018-12-04 14:00 ` Petr Mladek
2018-12-13 22:35 ` Josh Poimboeuf
2018-12-14 9:37 ` Miroslav Benes
2018-12-05 19:02 ` Joe Lawrence
2018-12-06 8:15 ` Petr Mladek
2018-12-06 14:23 ` Joe Lawrence
2018-12-13 22:10 ` Josh Poimboeuf
2018-12-14 9:32 ` Petr Mladek
2018-12-14 14:23 ` Josh Poimboeuf
2018-11-29 9:44 ` [PATCH v14 04/11] livepatch: Refuse to unload only livepatches available during a forced transition Petr Mladek
2018-12-03 15:29 ` Miroslav Benes
2018-12-06 8:46 ` Petr Mladek
2018-12-06 9:18 ` Miroslav Benes
2018-12-05 19:05 ` Joe Lawrence
2018-12-13 22:17 ` Josh Poimboeuf
2018-11-29 9:44 ` [PATCH v14 05/11] livepatch: Simplify API by removing registration step Petr Mladek
2018-12-04 12:54 ` Miroslav Benes
2018-12-04 14:47 ` Petr Mladek
2018-12-04 15:32 ` Miroslav Benes
2018-12-05 19:32 ` Joe Lawrence
2018-12-06 8:28 ` Petr Mladek
2018-12-06 9:23 ` Miroslav Benes
2018-12-06 10:14 ` Petr Mladek
2018-12-06 14:36 ` Joe Lawrence
2018-12-13 22:29 ` Josh Poimboeuf
2018-12-14 9:40 ` Petr Mladek
2018-12-14 14:24 ` Josh Poimboeuf
2019-01-03 11:47 ` Petr Mladek
2018-12-13 22:46 ` Josh Poimboeuf
2018-12-14 10:02 ` Petr Mladek
2018-12-14 14:27 ` Josh Poimboeuf
2018-11-29 9:44 ` [PATCH v14 06/11] livepatch: Use lists to manage patches, objects and functions Petr Mladek
2018-12-04 14:13 ` Miroslav Benes
2018-12-05 19:34 ` Joe Lawrence
2018-11-29 9:44 ` [PATCH v14 07/11] livepatch: Add atomic replace Petr Mladek
2018-12-04 15:27 ` Miroslav Benes
2018-12-05 19:37 ` Joe Lawrence
2018-12-13 22:55 ` Josh Poimboeuf
2018-12-17 15:27 ` Petr Mladek
2019-01-03 12:47 ` Petr Mladek
2019-01-03 13:37 ` Josh Poimboeuf
2018-11-29 9:44 ` [PATCH v14 08/11] livepatch: Remove Nop structures when unused Petr Mladek
2018-12-04 16:08 ` Miroslav Benes
2018-12-05 20:17 ` Joe Lawrence
2018-12-13 23:00 ` Josh Poimboeuf
2018-12-17 15:54 ` Petr Mladek
2018-12-17 16:11 ` Josh Poimboeuf
2018-11-29 9:44 ` [PATCH v14 09/11] livepatch: Atomic replace and cumulative patches documentation Petr Mladek
2018-12-04 16:12 ` Miroslav Benes
2018-12-05 20:20 ` Joe Lawrence [this message]
2018-11-29 9:44 ` [PATCH v14 10/11] livepatch: Remove ordering and refuse loading conflicting patches Petr Mladek
2018-12-05 10:27 ` Miroslav Benes
2018-12-05 20:24 ` Joe Lawrence
2018-12-13 23:06 ` Josh Poimboeuf
2018-12-17 16:07 ` Petr Mladek
2018-12-17 16:27 ` Josh Poimboeuf
2018-12-18 8:51 ` Petr Mladek
2018-11-29 9:44 ` [PATCH v14 11/11] selftests/livepatch: introduce tests Petr Mladek
2018-12-05 11:38 ` Miroslav Benes
2018-12-05 20:27 ` Joe Lawrence
2018-12-08 16:54 ` Alice Ferrazzi
2018-12-05 20:49 ` [PATCH v14 00/11] livepatch: Atomic replace feature Joe Lawrence
2018-12-06 7:54 ` Petr Mladek
2018-12-06 9:32 ` Miroslav Benes
2018-12-06 10:15 ` Petr Mladek
2018-12-06 12:37 ` Petr Mladek
2018-12-06 14:29 ` Joe Lawrence
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20181205202034.a66aulfbkl4abr3q@redhat.com \
--to=joe.lawrence@redhat.com \
--cc=eshatokhin@virtuozzo.com \
--cc=jbaron@akamai.com \
--cc=jikos@kernel.org \
--cc=jpoimboe@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=live-patching@vger.kernel.org \
--cc=mbenes@suse.cz \
--cc=pmladek@suse.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).