From patchwork Sun Aug 14 21:52:26 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Konrad Rzeszutek Wilk X-Patchwork-Id: 9280187 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id BCF5A600CB for ; Sun, 14 Aug 2016 21:55:44 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id AD019289FA for ; Sun, 14 Aug 2016 21:55:44 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id A18E728A21; Sun, 14 Aug 2016 21:55:44 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.2 required=2.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, UNPARSEABLE_RELAY autolearn=ham version=3.3.1 Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id C4B66289FA for ; Sun, 14 Aug 2016 21:55:43 +0000 (UTC) Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bZ3LI-0004dN-HY; Sun, 14 Aug 2016 21:53:16 +0000 Received: from mail6.bemta6.messagelabs.com ([193.109.254.103]) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bZ3LH-0004bq-Qv for xen-devel@lists.xenproject.org; Sun, 14 Aug 2016 21:53:15 +0000 Received: from [193.109.254.147] by server-10.bemta-6.messagelabs.com id A4/39-27438-B48E0B75; Sun, 14 Aug 2016 21:53:15 +0000 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFvrFLMWRWlGSWpSXmKPExsXSO6nOVdfrxYZ wg3U/hSy+b5nM5MDocfjDFZYAxijWzLyk/IoE1ozr31YxF/zwrJg/6zNrA+NDmy5GLg4hgTYm icvTu9m7GDmBnG+MEqevqEMkNjJKvPq8mw3CmcAosXXxQcYuRg4ONgETiTerHEEaRAQiJHpfn mIBqWEWeMUk0XxvNztIjbCAn8T0XxUgNSwCqhILDqxkBbF5BdwkTq0BmcnBISEgL/Hsdj1ImB MoPGFPNzPEDa4S2y/0MoHYEgKGEqcfbmOcwMi3gJFhFaNGcWpRWWqRrqGxXlJRZnpGSW5iZo6 uoYGZXm5qcXFiempOYlKxXnJ+7iZGYJgwAMEOxi/LAg4xSnIwKYny6pivCxfiS8pPqcxILM6I LyrNSS0+xCjDwaEkwdv+bEO4kGBRanpqRVpmDjBgYdISHDxKIrxLQdK8xQWJucWZ6RCpU4yKU uK8pSAJAZBERmkeXBssSi4xykoJ8zICHSLEU5BalJtZgir/ilGcg1FJmHcVyBSezLwSuOmvgB YzAS3WlwZbXJKIkJJqYExkNd/3i0WYVcmPtfb9vdPfzDQ2L+r+/pj13NW4o++/2+wt4Vi6a1n lt61bZEKFdY+eDdVzDdqg3rTAl1/KvuG9T+ONX3umXfrGefOG22zhm7mH2nxk1W65v0xwZ+pp OHHm95RKifxQHpWLy32fT/txO0UvaN493xtik7Xvf1/4tu7EtuPnF09VYinOSDTUYi4qTgQAX /sDMo0CAAA= X-Env-Sender: konrad.wilk@oracle.com X-Msg-Ref: server-8.tower-27.messagelabs.com!1471211592!43502982!1 X-Originating-IP: [141.146.126.69] X-SpamReason: No, hits=0.0 required=7.0 tests=sa_preprocessor: VHJ1c3RlZCBJUDogMTQxLjE0Ni4xMjYuNjkgPT4gMjc3MjE4\n X-StarScan-Received: X-StarScan-Version: 8.84; banners=-,-,- X-VirusChecked: Checked Received: (qmail 2168 invoked from network); 14 Aug 2016 21:53:14 -0000 Received: from aserp1040.oracle.com (HELO aserp1040.oracle.com) (141.146.126.69) by server-8.tower-27.messagelabs.com with DHE-RSA-AES256-GCM-SHA384 encrypted SMTP; 14 Aug 2016 21:53:14 -0000 Received: from userv0021.oracle.com (userv0021.oracle.com [156.151.31.71]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id u7ELr7fx029920 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Sun, 14 Aug 2016 21:53:08 GMT Received: from aserv0122.oracle.com (aserv0122.oracle.com [141.146.126.236]) by userv0021.oracle.com (8.13.8/8.13.8) with ESMTP id u7ELr7k9021733 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Sun, 14 Aug 2016 21:53:07 GMT Received: from abhmp0007.oracle.com (abhmp0007.oracle.com [141.146.116.13]) by aserv0122.oracle.com (8.14.4/8.14.4) with ESMTP id u7ELr6Md007360; Sun, 14 Aug 2016 21:53:06 GMT Received: from localhost.localdomain.com (/209.6.196.81) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sun, 14 Aug 2016 14:53:06 -0700 From: Konrad Rzeszutek Wilk To: xen-devel@lists.xenproject.org, konrad@kernel.org, ross.lagerwall@citrix.com Date: Sun, 14 Aug 2016 17:52:26 -0400 Message-Id: <1471211546-2235-10-git-send-email-konrad.wilk@oracle.com> X-Mailer: git-send-email 2.4.11 In-Reply-To: <1471211546-2235-1-git-send-email-konrad.wilk@oracle.com> References: <1471211546-2235-1-git-send-email-konrad.wilk@oracle.com> X-Source-IP: userv0021.oracle.com [156.151.31.71] Cc: Stefano Stabellini , Wei Liu , Konrad Rzeszutek Wilk , George Dunlap , Andrew Cooper , Ian Jackson , Tim Deegan , Jan Beulich Subject: [Xen-devel] [PATCH v3 9/9] livepach: Add .livepatch.hooks functions and test-case X-BeenThere: xen-devel@lists.xen.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: xen-devel-bounces@lists.xen.org Sender: "Xen-devel" X-Virus-Scanned: ClamAV using ClamSMTP From: Ross Lagerwall Add hook functions which run during patch apply and patch revert. Hook functions are used by livepatch payloads to manipulate data structures during patching, etc. One use case is the XSA91. As Martin mentions it: "If we have shadow variables, we also need an unload hook to garbage collect all the variables introduced by a hotpatch to prevent memory leaks. Potentially, we also want to pre-reserve memory for static or existing dynamic objects in the load-hook instead of on the fly. For testing and debugging, various applications are possible. In general, the hooks provide flexibility when having to deal with unforeseen cases, but their application should be rarely required (< 10%)." Furthermore include a test-case for it. Signed-off-by: Ross Lagerwall Signed-off-by: Konrad Rzeszutek Wilk --- Cc: Andrew Cooper Cc: George Dunlap Cc: Ian Jackson Cc: Jan Beulich Cc: Stefano Stabellini Cc: Tim Deegan Cc: Wei Liu v4..v11: Defered for v4.8 v12: s/xsplice/livepatch/ v13: Clarify the comments about spin_debug_enable Rename one of the hooks to lower-case (Z->z) to guarantee it being called last. Learned a lot of about 'const' --- docs/misc/livepatch.markdown | 23 +++++++++++++++++ xen/arch/x86/test/xen_hello_world.c | 35 ++++++++++++++++++++++++++ xen/common/livepatch.c | 50 ++++++++++++++++++++++++++++++++++++- xen/include/xen/livepatch_payload.h | 49 ++++++++++++++++++++++++++++++++++++ 4 files changed, 156 insertions(+), 1 deletion(-) create mode 100644 xen/include/xen/livepatch_payload.h diff --git a/docs/misc/livepatch.markdown b/docs/misc/livepatch.markdown index 590757d..0d3da21 100644 --- a/docs/misc/livepatch.markdown +++ b/docs/misc/livepatch.markdown @@ -342,6 +342,13 @@ When reverting a patch, the hypervisor iterates over each `livepatch_func` and the core code copies the data from the undo buffer (private internal copy) to `old_addr`. +It optionally may contain the address of functions to be called right before +being applied and after being reverted: + + * `.livepatch.hooks.load` - an array of function pointers. + * `.livepatch.hooks.unload` - an array of function pointers. + + ### Example of .livepatch.funcs A simple example of what a payload file can be: @@ -379,6 +386,22 @@ struct livepatch_func livepatch_hello_world = { Code must be compiled with -fPIC. +### .livepatch.hooks.load and .livepatch.hooks.unload + +This section contains an array of function pointers to be executed +before payload is being applied (.livepatch.funcs) or after reverting +the payload. This is useful to prepare data structures that need to +be modified patching. + +Each entry in this array is eight bytes. + +The type definition of the function are as follow: + +
+typedef void (*livepatch_loadcall_t)(void);  
+typedef void (*livepatch_unloadcall_t)(void);   
+
+ ### .livepatch.depends and .note.gnu.build-id To support dependencies checking and safe loading (to load the diff --git a/xen/arch/x86/test/xen_hello_world.c b/xen/arch/x86/test/xen_hello_world.c index 422bdf1..66c5b8e 100644 --- a/xen/arch/x86/test/xen_hello_world.c +++ b/xen/arch/x86/test/xen_hello_world.c @@ -4,14 +4,49 @@ */ #include "config.h" +#include #include #include #include +#include #include static char hello_world_patch_this_fnc[] = "xen_extra_version"; extern const char *xen_hello_world(void); +static unsigned int cnt; + +static void apply_hook(void) +{ + printk(KERN_DEBUG "Hook executing.\n"); +} + +static void revert_hook(void) +{ + printk(KERN_DEBUG "Hook unloaded.\n"); +} + +static void hi_func(void) +{ + printk(KERN_DEBUG "%s: Hi! (called %u times)\n", __func__, ++cnt); +}; + +/* If we are sorted we _MUST_ be the last .livepatch.hook section. */ +static void z_check_fnc(void) +{ + printk(KERN_DEBUG "%s: Hi func called %u times\n", __func__, cnt); + BUG_ON(cnt == 0 || cnt > 2); +} + +LIVEPATCH_LOAD_HOOK(apply_hook); +LIVEPATCH_UNLOAD_HOOK(revert_hook); + +/* Imbalance here. Two load and three unload. */ + +LIVEPATCH_LOAD_HOOK(hi_func); +LIVEPATCH_UNLOAD_HOOK(hi_func); + +LIVEPATCH_UNLOAD_HOOK(z_check_fnc); struct livepatch_func __section(".livepatch.funcs") livepatch_xen_hello_world = { .version = LIVEPATCH_PAYLOAD_VERSION, diff --git a/xen/common/livepatch.c b/xen/common/livepatch.c index 6f82a9e..3a22de2 100644 --- a/xen/common/livepatch.c +++ b/xen/common/livepatch.c @@ -23,6 +23,7 @@ #include #include #include +#include #include @@ -72,7 +73,11 @@ struct payload { struct livepatch_build_id dep; /* ELFNOTE_DESC(.livepatch.depends). */ void *bss; /* .bss of the payload. */ size_t bss_size; /* and its size. */ - char name[XEN_LIVEPATCH_NAME_SIZE]; /* Name of it. */ + livepatch_loadcall_t **load_funcs; /* The array of funcs to call after */ + livepatch_unloadcall_t **unload_funcs;/* load and unload of the payload. */ + unsigned int n_load_funcs; /* Nr of the funcs to load and execute. */ + unsigned int n_unload_funcs; /* Nr of funcs to call durung unload. */ + char name[XEN_LIVEPATCH_NAME_SIZE]; /* Name of it. */ }; /* Defines an outstanding patching action. */ @@ -581,6 +586,25 @@ static int prepare_payload(struct payload *payload, return rc; } + sec = livepatch_elf_sec_by_name(elf, ".livepatch.hooks.load"); + if ( sec ) + { + if ( sec->sec->sh_size % sizeof(*payload->load_funcs) ) + return -EINVAL; + + payload->load_funcs = sec->load_addr; + payload->n_load_funcs = sec->sec->sh_size / sizeof(*payload->load_funcs); + } + + sec = livepatch_elf_sec_by_name(elf, ".livepatch.hooks.unload"); + if ( sec ) + { + if ( sec->sec->sh_size % sizeof(*payload->unload_funcs) ) + return -EINVAL; + + payload->unload_funcs = sec->load_addr; + payload->n_unload_funcs = sec->sec->sh_size / sizeof(*payload->unload_funcs); + } sec = livepatch_elf_sec_by_name(elf, ELF_BUILD_ID_NOTE); if ( sec ) { @@ -1065,6 +1089,18 @@ static int apply_payload(struct payload *data) arch_livepatch_quiesce(); + /* + * Since we are running with IRQs disabled and the hooks may call common + * code - which expects the spinlocks to run with IRQs enabled - we temporarly + * disable the spin locks IRQ state checks. + */ + spin_debug_disable(); + for ( i = 0; i < data->n_load_funcs; i++ ) + data->load_funcs[i](); + spin_debug_enable(); + + ASSERT(!local_irq_is_enabled()); + for ( i = 0; i < data->nfuncs; i++ ) arch_livepatch_apply_jmp(&data->funcs[i]); @@ -1091,6 +1127,18 @@ static int revert_payload(struct payload *data) for ( i = 0; i < data->nfuncs; i++ ) arch_livepatch_revert_jmp(&data->funcs[i]); + /* + * Since we are running with IRQs disabled and the hooks may call common + * code - which expects the spinlocks to run with IRQs enabled - we temporarly + * disable the spin locks IRQ state checks. + */ + spin_debug_disable(); + for ( i = 0; i < data->n_unload_funcs; i++ ) + data->unload_funcs[i](); + spin_debug_enable(); + + ASSERT(!local_irq_is_enabled()); + arch_livepatch_revive(); /* diff --git a/xen/include/xen/livepatch_payload.h b/xen/include/xen/livepatch_payload.h new file mode 100644 index 0000000..8f38cc2 --- /dev/null +++ b/xen/include/xen/livepatch_payload.h @@ -0,0 +1,49 @@ +/* + * Copyright (C) 2016 Citrix Systems R&D Ltd. + */ + +#ifndef __XEN_LIVEPATCH_PAYLOAD_H__ +#define __XEN_LIVEPATCH_PAYLOAD_H__ + +/* + * The following definitions are to be used in patches. They are taken + * from kpatch. + */ +typedef void livepatch_loadcall_t(void); +typedef void livepatch_unloadcall_t(void); + +/* + * LIVEPATCH_LOAD_HOOK macro + * + * Declares a function pointer to be allocated in a new + * .livepatch.hook.load section. This livepatch_load_data symbol is later + * stripped by create-diff-object so that it can be declared in multiple + * objects that are later linked together, avoiding global symbol + * collision. Since multiple hooks can be registered, the + * .livepatch.hook.load section is a table of functions that will be + * executed in series by the livepatch infrastructure at patch load time. + */ +#define LIVEPATCH_LOAD_HOOK(_fn) \ + livepatch_loadcall_t *__attribute__((weak)) \ + const livepatch_load_data_##_fn __section(".livepatch.hooks.load") = _fn; + +/* + * LIVEPATCH_UNLOAD_HOOK macro + * + * Same as LOAD hook with s/load/unload/ + */ +#define LIVEPATCH_UNLOAD_HOOK(_fn) \ + livepatch_unloadcall_t *__attribute__((weak)) \ + const livepatch_unload_data_##_fn __section(".livepatch.hooks.unload") = _fn; + +#endif /* __XEN_LIVEPATCH_PAYLOAD_H__ */ + +/* + * Local variables: + * mode: C + * c-file-style: "BSD" + * c-basic-offset: 4 + * tab-width: 4 + * indent-tabs-mode: nil + * End: + */