From: "Marek Marczykowski-Górecki" <marmarek@invisiblethingslab.com>
To: Pawel Wieczorkiewicz <wipawel@amazon.de>
Cc: wipawel@amazon.com, Wei Liu <wl@xen.org>,
Ian Jackson <ian.jackson@eu.citrix.com>,
mpohlack@amazon.com, xen-devel@lists.xen.org,
xen-devel@lists.xenproject.org
Subject: Re: [Xen-devel] [PATCH v2 12/12] livepatch: Add python bindings for livepatch operations
Date: Wed, 28 Aug 2019 15:21:35 +0200 [thread overview]
Message-ID: <20190828132135.GB7015@mail-itl> (raw)
In-Reply-To: <20190827084624.116917-13-wipawel@amazon.de>
[-- Attachment #1.1: Type: text/plain, Size: 12191 bytes --]
On Tue, Aug 27, 2019 at 08:46:24AM +0000, Pawel Wieczorkiewicz wrote:
> Extend the XC python bindings library to support also all common
> livepatch operations and actions.
>
> Add the python bindings for the following operations:
> - status (pyxc_livepatch_status):
> Requires a payload name as an input.
> Returns a status dict containing a state string and a return code
> integer.
> - action (pyxc_livepatch_action):
> Requires a payload name and an action id as an input. Timeout and
> flags are optional parameters.
> Returns a return code integer.
> - upload (pyxc_livepatch_upload):
> Requires a payload name and a module's filename as an input.
> Returns a return code integer.
> - list (pyxc_livepatch_list):
> Takes no parameters.
> Returns a list of dicts containing each payload's:
> * name as a string
> * state as a string
> * return code as an integer
> * list of metadata key=value strings
>
> Each functions throws an exception error based on the errno value
> received from its corresponding libxc function call.
>
> Signed-off-by: Pawel Wieczorkiewicz <wipawel@amazon.de>
> Reviewed-by: Martin Mazein <amazein@amazon.de>
> Reviewed-by: Andra-Irina Paraschiv <andraprs@amazon.com>
> Reviewed-by: Leonard Foerster <foersleo@amazon.de>
> Reviewed-by: Norbert Manthey <nmanthey@amazon.de>
Acked-by: Marek Marczykowski-Górecki <marmarek@invisiblethingslab.com>
> ---
> Changed since v1:
> * changed PyList_Append() with PyList_SetItem() as requested by
> Marek
>
> tools/python/xen/lowlevel/xc/xc.c | 273 ++++++++++++++++++++++++++++++++++++++
> 1 file changed, 273 insertions(+)
>
> diff --git a/tools/python/xen/lowlevel/xc/xc.c b/tools/python/xen/lowlevel/xc/xc.c
> index 7f0358ba9c..d64b9372b6 100644
> --- a/tools/python/xen/lowlevel/xc/xc.c
> +++ b/tools/python/xen/lowlevel/xc/xc.c
> @@ -2011,6 +2011,230 @@ static PyObject *pyflask_access(PyObject *self, PyObject *args,
> return Py_BuildValue("i",ret);
> }
>
> +static PyObject *pyxc_livepatch_status(XcObject *self,
> + PyObject *args,
> + PyObject *kwds)
> +{
> + xen_livepatch_status_t status;
> + PyObject *info_dict = NULL;
> + char *name;
> + int rc;
> +
> + static char *kwd_list[] = { "name", NULL };
> +
> + if ( !PyArg_ParseTupleAndKeywords(args, kwds, "s", kwd_list, &name) )
> + goto error;
> +
> + rc = xc_livepatch_get(self->xc_handle, name, &status);
> + if ( rc )
> + goto error;
> +
> + info_dict = Py_BuildValue(
> + "{s:i,s:i}",
> + "state", status.state,
> + "rc", status.rc);
> +
> +error:
> + return info_dict ?: pyxc_error_to_exception(self->xc_handle);
> +}
> +
> +static PyObject *pyxc_livepatch_action(XcObject *self,
> + PyObject *args,
> + PyObject *kwds)
> +{
> + int (*action_func)(xc_interface *xch, char *name, uint32_t timeout, uint64_t flags);
> + char *name;
> + unsigned int action;
> + uint32_t timeout;
> + uint64_t flags;
> + int rc;
> +
> + static char *kwd_list[] = { "name", "action", "timeout", "flags", NULL };
> +
> + if ( !PyArg_ParseTupleAndKeywords(args, kwds, "sI|Ik", kwd_list,
> + &name, &action, &timeout, &flags) )
> + goto error;
> +
> + switch (action)
> + {
> + case LIVEPATCH_ACTION_UNLOAD:
> + action_func = xc_livepatch_unload;
> + break;
> + case LIVEPATCH_ACTION_REVERT:
> + action_func = xc_livepatch_revert;
> + break;
> + case LIVEPATCH_ACTION_APPLY:
> + action_func = xc_livepatch_apply;
> + break;
> + case LIVEPATCH_ACTION_REPLACE:
> + action_func = xc_livepatch_replace;
> + break;
> + default:
> + goto error;
> + }
> +
> + rc = action_func(self->xc_handle, name, timeout, flags);
> + if ( rc )
> + goto error;
> +
> + return Py_BuildValue("i", rc);
> +error:
> + return pyxc_error_to_exception(self->xc_handle);
> +}
> +
> +static PyObject *pyxc_livepatch_upload(XcObject *self,
> + PyObject *args,
> + PyObject *kwds)
> +{
> + unsigned char *fbuf = MAP_FAILED;
> + char *name, *filename;
> + struct stat buf;
> + int fd = 0, rc;
> + ssize_t len;
> +
> + static char *kwd_list[] = { "name", "filename", NULL };
> +
> + if ( !PyArg_ParseTupleAndKeywords(args, kwds, "ss", kwd_list,
> + &name, &filename))
> + goto error;
> +
> + fd = open(filename, O_RDONLY);
> + if ( fd < 0 )
> + goto error;
> +
> + if ( stat(filename, &buf) != 0 )
> + goto error;
> +
> + len = buf.st_size;
> + fbuf = mmap(0, len, PROT_READ, MAP_PRIVATE, fd, 0);
> + if ( fbuf == MAP_FAILED )
> + goto error;
> +
> + rc = xc_livepatch_upload(self->xc_handle, name, fbuf, len);
> + if ( rc )
> + goto error;
> +
> + if ( munmap(fbuf, len) )
> + {
> + fbuf = MAP_FAILED;
> + goto error;
> + }
> + close(fd);
> +
> + return Py_BuildValue("i", rc);;
> +error:
> + if ( fbuf != MAP_FAILED )
> + munmap(fbuf, len);
> + if ( fd >= 0 )
> + close(fd);
> + return pyxc_error_to_exception(self->xc_handle);
> +}
> +
> +static PyObject *pyxc_livepatch_list(XcObject *self)
> +{
> + PyObject *list;
> + unsigned int nr, done, left, i;
> + xen_livepatch_status_t *info = NULL;
> + char *name = NULL;
> + char *metadata = NULL;
> + uint32_t *len = NULL;
> + uint32_t *metadata_len = NULL;
> + uint64_t name_total_size, metadata_total_size;
> + off_t name_off, metadata_off;
> + int rc;
> +
> + rc = xc_livepatch_list_get_sizes(self->xc_handle, &nr,
> + &name_total_size, &metadata_total_size);
> + if ( rc )
> + goto error;
> +
> + if ( nr == 0 )
> + return PyList_New(0);
> +
> + rc = ENOMEM;
> + info = malloc(nr * sizeof(*info));
> + if ( !info )
> + goto error;
> +
> + name = malloc(name_total_size * sizeof(*name));
> + if ( !name )
> + goto error;
> +
> + len = malloc(nr * sizeof(*len));
> + if ( !len )
> + goto error;
> +
> + metadata = malloc(metadata_total_size * sizeof(*metadata));
> + if ( !metadata )
> + goto error;
> +
> + metadata_len = malloc(nr * sizeof(*metadata_len));
> + if ( !metadata_len )
> + goto error;
> +
> + rc = xc_livepatch_list(self->xc_handle, nr, 0, info,
> + name, len, name_total_size,
> + metadata, metadata_len, metadata_total_size,
> + &done, &left);
> + if ( rc )
> + goto error;
> +
> + list = PyList_New(done);
> + name_off = metadata_off = 0;
> + for ( i = 0; i < done; i++ )
> + {
> + PyObject *info_dict, *metadata_list;
> + char *name_str, *metadata_str;
> +
> + name_str = name + name_off;
> + metadata_str = metadata + metadata_off;
> +
> + metadata_list = PyList_New(0);
> + for ( char *s = metadata_str; s < metadata_str + metadata_len[i]; s += strlen(s) + 1 )
> + {
> + PyObject *field = Py_BuildValue("s", s);
> + if ( field == NULL )
> + {
> + Py_DECREF(list);
> + Py_DECREF(metadata_list);
> + rc = EFAULT;
> + goto error;
> + }
> +
> + PyList_Append(metadata_list, field);
> + Py_DECREF(field);
> + }
> +
> + info_dict = Py_BuildValue(
> + "{s:s,s:i,s:i,s:N}",
> + "name", name_str,
> + "state", info[i].state,
> + "rc", info[i].rc,
> + "metadata", metadata_list);
> +
> + if ( info_dict == NULL )
> + {
> + Py_DECREF(list);
> + Py_DECREF(metadata_list);
> + rc = EFAULT;
> + goto error;
> + }
> + PyList_SetItem(list, i, info_dict);
> + Py_DECREF(info_dict);
> +
> + name_off += len[i];
> + metadata_off += metadata_len[i];
> + }
> +
> +error:
> + free(info);
> + free(name);
> + free(len);
> + free(metadata);
> + free(metadata_len);
> + return rc ? pyxc_error_to_exception(self->xc_handle) : list;
> +}
> +
> static PyMethodDef pyxc_methods[] = {
> { "domain_create",
> (PyCFunction)pyxc_domain_create,
> @@ -2587,6 +2811,44 @@ static PyMethodDef pyxc_methods[] = {
> "Returns: [int]: 0 on all permission granted; -1 if any permissions are \
> denied\n" },
>
> + { "livepatch_status",
> + (PyCFunction)pyxc_livepatch_status,
> + METH_KEYWORDS, "\n"
> + "Gets current state and return code for a specified module.\n"
> + " name [str]: Module name to be used\n"
> + "Returns: [dict] on success; throwing an exception on error\n"
> + " state [int]: Module current state: CHECKED or APPLIED\n"
> + " rc [int]: Return code of last module's operation\n" },
> +
> + { "livepatch_upload",
> + (PyCFunction)pyxc_livepatch_upload,
> + METH_KEYWORDS, "\n"
> + "Uploads a module with specified name from filename.\n"
> + " name [str]: Module name to be used\n"
> + " filename [str]: Filename of a module to be uploaded\n"
> + "Returns: [int] 0 on success; throwing an exception on error\n" },
> +
> + { "livepatch_action",
> + (PyCFunction)pyxc_livepatch_action,
> + METH_KEYWORDS, "\n"
> + "Performs an action (unload, revert, apply or replace) on a specified \
> + module.\n"
> + " name [str]: Module name to be used\n"
> + " action [uint]: Action enum id\n"
> + " timeout [uint]: Action scheduled execution timeout\n"
> + " flags [ulong]: Flags specifying action's extra parameters\n"
> + "Returns: [int] 0 on success; throwing an exception on error\n" },
> +
> + { "livepatch_list",
> + (PyCFunction)pyxc_livepatch_list,
> + METH_NOARGS, "\n"
> + "List all uploaded livepatch modules with their current state and metadata.\n"
> + "Returns: [list of dicts] on success; throwing an exception on error\n"
> + " name [str]: Module name\n"
> + " state [int]: Module current state: CHECKED or APPLIED\n"
> + " rc [int]: Return code of last module's operation\n"
> + " metadata [list]: List of module's metadata 'key=value' strings\n" },
> +
> { NULL, NULL, 0, NULL }
> };
>
> @@ -2698,6 +2960,17 @@ PyMODINIT_FUNC initxc(void)
> PyModule_AddIntConstant(m, "XEN_SCHEDULER_CREDIT", XEN_SCHEDULER_CREDIT);
> PyModule_AddIntConstant(m, "XEN_SCHEDULER_CREDIT2", XEN_SCHEDULER_CREDIT2);
>
> + /* Expose livepatch constants to Python */
> + PyModule_AddIntConstant(m, "LIVEPATCH_ACTION_UNLOAD", LIVEPATCH_ACTION_UNLOAD);
> + PyModule_AddIntConstant(m, "LIVEPATCH_ACTION_REVERT", LIVEPATCH_ACTION_REVERT);
> + PyModule_AddIntConstant(m, "LIVEPATCH_ACTION_APPLY", LIVEPATCH_ACTION_APPLY);
> + PyModule_AddIntConstant(m, "LIVEPATCH_ACTION_REPLACE", LIVEPATCH_ACTION_REPLACE);
> +
> + PyModule_AddIntConstant(m, "LIVEPATCH_ACTION_APPLY_NODEPS", LIVEPATCH_ACTION_APPLY_NODEPS);
> +
> + PyModule_AddIntConstant(m, "LIVEPATCH_STATE_APPLIED", LIVEPATCH_STATE_APPLIED);
> + PyModule_AddIntConstant(m, "LIVEPATCH_STATE_CHECKED", LIVEPATCH_STATE_CHECKED);
> +
> #if PY_MAJOR_VERSION >= 3
> return m;
> #endif
--
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
[-- Attachment #2: Type: text/plain, Size: 157 bytes --]
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel
next prev parent reply other threads:[~2019-08-28 13:22 UTC|newest]
Thread overview: 66+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-21 8:19 [Xen-devel] [PATCH 00/14] livepatch: new features and fixes Pawel Wieczorkiewicz
2019-08-21 8:19 ` [Xen-devel] [PATCH 01/14] livepatch: Always check hypervisor build ID upon hotpatch upload Pawel Wieczorkiewicz
2019-08-21 18:16 ` Konrad Rzeszutek Wilk
2019-08-21 8:19 ` [Xen-devel] [PATCH 02/14] livepatch: Allow to override inter-modules buildid dependency Pawel Wieczorkiewicz
2019-08-21 8:19 ` [Xen-devel] [PATCH 03/14] python: Add XC binding for Xen build ID Pawel Wieczorkiewicz
2019-08-21 8:19 ` [Xen-devel] [PATCH 04/14] livepatch: Export payload structure via livepatch_payload.h Pawel Wieczorkiewicz
2019-08-21 8:19 ` [Xen-devel] [PATCH 05/14] livepatch: Implement pre-|post- apply|revert hooks Pawel Wieczorkiewicz
2019-08-21 8:19 ` [Xen-devel] [PATCH 06/14] livepatch: Add support for apply|revert action replacement hooks Pawel Wieczorkiewicz
2019-08-21 18:31 ` Konrad Rzeszutek Wilk
2019-08-21 19:06 ` Wieczorkiewicz, Pawel
2019-08-26 14:30 ` Konrad Rzeszutek Wilk
2019-08-21 8:19 ` [Xen-devel] [PATCH 07/14] livepatch: Do not enforce ELF_LIVEPATCH_FUNC section presence Pawel Wieczorkiewicz
2019-08-21 8:19 ` [Xen-devel] [PATCH 08/14] livepatch: always print XENLOG_ERR information Pawel Wieczorkiewicz
2019-08-21 8:19 ` [Xen-devel] [PATCH 09/14] livepatch: Add per-function applied/reverted state tracking marker Pawel Wieczorkiewicz
2019-08-21 18:28 ` Konrad Rzeszutek Wilk
2019-08-21 19:00 ` Wieczorkiewicz, Pawel
2019-08-21 21:34 ` Julien Grall
2019-08-22 7:44 ` Wieczorkiewicz, Pawel
2019-08-22 10:07 ` Julien Grall
2019-08-22 10:20 ` Wieczorkiewicz, Pawel
2019-08-22 10:43 ` Julien Grall
2019-08-22 11:15 ` Wieczorkiewicz, Pawel
2019-08-22 15:02 ` Julien Grall
2019-08-22 10:29 ` Julien Grall
2019-08-22 11:02 ` Wieczorkiewicz, Pawel
2019-08-22 15:30 ` Julien Grall
2019-08-22 15:42 ` Wieczorkiewicz, Pawel
2019-08-21 8:19 ` [Xen-devel] [PATCH 10/14] livepatch: Add support for inline asm hotpatching expectations Pawel Wieczorkiewicz
2019-08-21 18:30 ` Konrad Rzeszutek Wilk
2019-08-21 19:02 ` Wieczorkiewicz, Pawel
2019-08-22 10:31 ` Julien Grall
2019-08-22 11:03 ` Wieczorkiewicz, Pawel
2019-08-21 8:19 ` [Xen-devel] [PATCH 11/14] livepatch: Add support for modules .modinfo section metadata Pawel Wieczorkiewicz
2019-08-21 8:19 ` [Xen-devel] [PATCH 12/14] livepatch: Handle arbitrary size names with the list operation Pawel Wieczorkiewicz
2019-08-21 8:19 ` [Xen-devel] [PATCH 13/14] livepatch: Add metadata runtime retrieval mechanism Pawel Wieczorkiewicz
2019-08-21 8:19 ` [Xen-devel] [PATCH 14/14] livepatch: Add python bindings for livepatch operations Pawel Wieczorkiewicz
2019-08-22 21:55 ` Marek Marczykowski-Górecki
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 00/12] livepatch: new features and fixes Pawel Wieczorkiewicz
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 01/12] livepatch: Always check hypervisor build ID upon hotpatch upload Pawel Wieczorkiewicz
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 02/12] livepatch: Allow to override inter-modules buildid dependency Pawel Wieczorkiewicz
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 03/12] livepatch: Export payload structure via livepatch_payload.h Pawel Wieczorkiewicz
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 04/12] livepatch: Implement pre-|post- apply|revert hooks Pawel Wieczorkiewicz
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 05/12] livepatch: Add support for apply|revert action replacement hooks Pawel Wieczorkiewicz
2019-08-27 16:58 ` Konrad Rzeszutek Wilk
2019-08-28 7:37 ` Wieczorkiewicz, Pawel
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 06/12] livepatch: Do not enforce ELF_LIVEPATCH_FUNC section presence Pawel Wieczorkiewicz
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 07/12] livepatch: Add per-function applied/reverted state tracking marker Pawel Wieczorkiewicz
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 08/12] livepatch: Add support for inline asm hotpatching expectations Pawel Wieczorkiewicz
2019-08-29 14:34 ` Konrad Rzeszutek Wilk
2019-08-29 15:29 ` Wieczorkiewicz, Pawel
2019-08-29 15:58 ` Konrad Rzeszutek Wilk
2019-08-29 16:16 ` Wieczorkiewicz, Pawel
2019-08-29 17:49 ` Konrad Rzeszutek Wilk
2019-08-29 19:07 ` Wieczorkiewicz, Pawel
2019-08-29 20:48 ` Konrad Rzeszutek Wilk
2019-09-05 18:05 ` Konrad Rzeszutek Wilk
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 09/12] livepatch: Add support for modules .modinfo section metadata Pawel Wieczorkiewicz
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 10/12] livepatch: Handle arbitrary size names with the list operation Pawel Wieczorkiewicz
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 11/12] livepatch: Add metadata runtime retrieval mechanism Pawel Wieczorkiewicz
2019-08-29 20:48 ` Konrad Rzeszutek Wilk
2019-08-27 8:46 ` [Xen-devel] [PATCH v2 12/12] livepatch: Add python bindings for livepatch operations Pawel Wieczorkiewicz
2019-08-28 13:21 ` Marek Marczykowski-Górecki [this message]
2019-08-29 19:23 ` [Xen-devel] [PATCH v2 00/12] livepatch: new features and fixes Konrad Rzeszutek Wilk
2019-09-05 19:13 ` Konrad Rzeszutek Wilk
2019-09-06 22:52 ` Julien Grall
2019-09-06 22:42 ` Julien Grall
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=20190828132135.GB7015@mail-itl \
--to=marmarek@invisiblethingslab.com \
--cc=ian.jackson@eu.citrix.com \
--cc=mpohlack@amazon.com \
--cc=wipawel@amazon.com \
--cc=wipawel@amazon.de \
--cc=wl@xen.org \
--cc=xen-devel@lists.xen.org \
--cc=xen-devel@lists.xenproject.org \
/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).