From patchwork Tue Jun 27 12:27:46 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?b?SsO8cmdlbiBHcm/Dnw==?= X-Patchwork-Id: 13294417 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 394CDEB64D9 for ; Tue, 27 Jun 2023 12:28:33 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.556119.868376 (Exim 4.92) (envelope-from ) id 1qE7nf-0000vg-Qq; Tue, 27 Jun 2023 12:28:03 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 556119.868376; Tue, 27 Jun 2023 12:28:03 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qE7nf-0000vZ-Ns; Tue, 27 Jun 2023 12:28:03 +0000 Received: by outflank-mailman (input) for mailman id 556119; Tue, 27 Jun 2023 12:28:02 +0000 Received: from se1-gles-flk1-in.inumbo.com ([94.247.172.50] helo=se1-gles-flk1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qE7ne-0000v0-AG for xen-devel@lists.xenproject.org; Tue, 27 Jun 2023 12:28:02 +0000 Received: from smtp-out1.suse.de (smtp-out1.suse.de [2001:67c:2178:6::1c]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id 0d0004b8-14e6-11ee-8611-37d641c3527e; Tue, 27 Jun 2023 14:27:59 +0200 (CEST) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out1.suse.de (Postfix) with ESMTPS id B1BF821887; Tue, 27 Jun 2023 12:27:58 +0000 (UTC) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id 74F0E13462; Tue, 27 Jun 2023 12:27:58 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id s4b7Gs7VmmQ0SAAAMHmgww (envelope-from ); Tue, 27 Jun 2023 12:27:58 +0000 X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 0d0004b8-14e6-11ee-8611-37d641c3527e DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=susede1; t=1687868878; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=W8JQBKjxhniaE/zxcvmS+z9dFa/XBunKMQ4z3sK0ltY=; b=dI6hkgyC+J6T/bu9T6u67G7T5QDTGGnb3FQ8f3ZJh1b3yuEBFux4rXRAaLOn3Az3GLprPj 5GhV7mYYhD1LHlQDy+MBCxVv01no491R8uPmmzK3N2L0EBLECVp+HbYk3HrvjOSQC3V3Ys nxOye7hzlyFycf93taGbHdq869eDO6Y= From: Juergen Gross To: xen-devel@lists.xenproject.org Cc: Juergen Gross , Wei Liu , Julien Grall , Anthony PERARD , Julien Grall Subject: [PATCH v4 1/5] tools/xenstore: remove no longer needed functions from xs_lib.c Date: Tue, 27 Jun 2023 14:27:46 +0200 Message-Id: <20230627122750.2007-2-jgross@suse.com> X-Mailer: git-send-email 2.35.3 In-Reply-To: <20230627122750.2007-1-jgross@suse.com> References: <20230627122750.2007-1-jgross@suse.com> MIME-Version: 1.0 xs_daemon_tdb() in xs_lib.c is no longer used at all, so it can be removed. xs_domain_dev() and xs_write_all() are not used by xenstored, so they can be moved to tools/libs/store/xs.c. xs_daemon_rootdir() is used by xenstored only and it only calls xs_daemon_rundir(), so replace its use cases with xs_daemon_rundir() and remove it from xs_lib.c. xs_daemon_socket_ro() is needed in libxenstore only, so move it to tools/libs/store/xs.c. Move functions used by xenstore-client only to xenstore_client.c. Signed-off-by: Juergen Gross Acked-by: Julien Grall --- V2: - move xs_write_all(), too V3: - remove xs_daemon_rootdir(), move xs_daemon_socket_ro() --- tools/include/xenstore.h | 3 + tools/include/xenstore_lib.h | 3 - tools/libs/store/xs.c | 43 ++++++++ tools/xenstore/xenstore_client.c | 129 ++++++++++++++++++++++ tools/xenstore/xenstored_control.c | 4 +- tools/xenstore/xenstored_core.c | 3 +- tools/xenstore/xs_lib.c | 166 ----------------------------- tools/xenstore/xs_lib.h | 19 ---- 8 files changed, 178 insertions(+), 192 deletions(-) diff --git a/tools/include/xenstore.h b/tools/include/xenstore.h index 2b3f69fb61..a442252849 100644 --- a/tools/include/xenstore.h +++ b/tools/include/xenstore.h @@ -113,6 +113,9 @@ void *xs_read(struct xs_handle *h, xs_transaction_t t, bool xs_write(struct xs_handle *h, xs_transaction_t t, const char *path, const void *data, unsigned int len); +/* Simple write function: loops for you. */ +bool xs_write_all(int fd, const void *data, unsigned int len); + /* Create a new directory. * Returns false on failure, or success if it already exists. */ diff --git a/tools/include/xenstore_lib.h b/tools/include/xenstore_lib.h index 2266009ec1..43eec87379 100644 --- a/tools/include/xenstore_lib.h +++ b/tools/include/xenstore_lib.h @@ -47,9 +47,6 @@ const char *xs_daemon_rundir(void); const char *xs_daemon_socket(void); const char *xs_daemon_socket_ro(void); -/* Simple write function: loops for you. */ -bool xs_write_all(int fd, const void *data, unsigned int len); - /* Convert strings to permissions. False if a problem. */ bool xs_strings_to_perms(struct xs_permissions *perms, unsigned int num, const char *strings); diff --git a/tools/libs/store/xs.c b/tools/libs/store/xs.c index 76ffb1be45..bb93246bfb 100644 --- a/tools/libs/store/xs.c +++ b/tools/libs/store/xs.c @@ -311,6 +311,26 @@ struct xs_handle *xs_domain_open(void) return xs_open(0); } +static const char *xs_domain_dev(void) +{ + char *s = getenv("XENSTORED_PATH"); + if (s) + return s; +#if defined(__RUMPUSER_XEN__) || defined(__RUMPRUN__) + return "/dev/xen/xenbus"; +#elif defined(__linux__) + if (access("/dev/xen/xenbus", F_OK) == 0) + return "/dev/xen/xenbus"; + return "/proc/xen/xenbus"; +#elif defined(__NetBSD__) + return "/kern/xen/xenbus"; +#elif defined(__FreeBSD__) + return "/dev/xen/xenstore"; +#else + return "/dev/xen/xenbus"; +#endif +} + struct xs_handle *xs_open(unsigned long flags) { struct xs_handle *xsh = NULL; @@ -431,6 +451,24 @@ out_false: #ifdef XSTEST #define read_all read_all_choice #define xs_write_all write_all_choice +#else +/* Simple routine for writing to sockets, etc. */ +bool xs_write_all(int fd, const void *data, unsigned int len) +{ + while (len) { + int done; + + done = write(fd, data, len); + if (done < 0 && errno == EINTR) + continue; + if (done <= 0) + return false; + data += done; + len -= done; + } + + return true; +} #endif static int get_error(const char *errorstring) @@ -1328,6 +1366,11 @@ error: return ret; } +const char *xs_daemon_socket_ro(void) +{ + return xs_daemon_socket(); +} + #ifdef USE_PTHREAD static void *read_thread(void *arg) { diff --git a/tools/xenstore/xenstore_client.c b/tools/xenstore/xenstore_client.c index de788b3e0a..27fda81401 100644 --- a/tools/xenstore/xenstore_client.c +++ b/tools/xenstore/xenstore_client.c @@ -8,6 +8,7 @@ * */ +#include #include #include #include @@ -40,12 +41,140 @@ enum mode { MODE_watch, }; +/* Sanitising (quoting) possibly-binary strings. */ +struct expanding_buffer { + char *buf; + int avail; +}; + static char *output_buf = NULL; static int output_pos = 0; static struct expanding_buffer ebuf; static int output_size = 0; +/* Ensure that given expanding buffer has at least min_avail characters. */ +static char *expanding_buffer_ensure(struct expanding_buffer *ebuf, + int min_avail) +{ + int want; + char *got; + + if ( ebuf->avail >= min_avail ) + return ebuf->buf; + + if ( min_avail >= INT_MAX/3 ) + return 0; + + want = ebuf->avail + min_avail + 10; + got = realloc(ebuf->buf, want); + if ( !got ) + return 0; + + ebuf->buf = got; + ebuf->avail = want; + return ebuf->buf; +} + +/* sanitise_value() may return NULL if malloc fails. */ +static char *sanitise_value(struct expanding_buffer *ebuf, + const char *val, unsigned len) +{ + int used, remain, c; + unsigned char *ip; + +#define ADD(c) (ebuf->buf[used++] = (c)) +#define ADDF(f,c) (used += sprintf(ebuf->buf+used, (f), (c))) + + assert(len < INT_MAX/5); + + ip = (unsigned char *)val; + used = 0; + remain = len; + + if ( !expanding_buffer_ensure(ebuf, remain + 1) ) + return NULL; + + while ( remain-- > 0 ) + { + c= *ip++; + + if ( c >= ' ' && c <= '~' && c != '\\' ) + { + ADD(c); + continue; + } + + if ( !expanding_buffer_ensure(ebuf, used + remain + 5) ) + /* for "\\nnn\0" */ + return 0; + + ADD('\\'); + switch (c) + { + case '\t': ADD('t'); break; + case '\n': ADD('n'); break; + case '\r': ADD('r'); break; + case '\\': ADD('\\'); break; + default: + if ( c < 010 ) ADDF("%03o", c); + else ADDF("x%02x", c); + } + } + + ADD(0); + assert(used <= ebuf->avail); + return ebuf->buf; + +#undef ADD +#undef ADDF +} + +/* *out_len_r on entry is ignored; out must be at least strlen(in)+1 bytes. */ +static void unsanitise_value(char *out, unsigned *out_len_r, const char *in) +{ + const char *ip; + char *op; + unsigned c; + int n; + + for ( ip = in, op = out; (c = *ip++); *op++ = c ) + { + if ( c == '\\' ) + { + c = *ip++; + +#define GETF(f) do \ +{ \ + n = 0; \ + sscanf(ip, f "%n", &c, &n); \ + ip += n; \ +} while ( 0 ) + + switch ( c ) + { + case 't': c= '\t'; break; + case 'n': c= '\n'; break; + case 'r': c= '\r'; break; + case '\\': c= '\\'; break; + case 'x': GETF("%2x"); break; + case '0': case '4': + case '1': case '5': + case '2': case '6': + case '3': case '7': --ip; GETF("%3o"); break; + case 0: --ip; break; + default:; + } +#undef GETF + } + } + + *op = 0; + + if ( out_len_r ) + *out_len_r = op - out; +} + /* make sure there is at least 'len' more space in output_buf */ static void expand_buffer(size_t len) { diff --git a/tools/xenstore/xenstored_control.c b/tools/xenstore/xenstored_control.c index ed80924ee4..6ef800ff64 100644 --- a/tools/xenstore/xenstored_control.c +++ b/tools/xenstore/xenstored_control.c @@ -560,7 +560,7 @@ static FILE *lu_dump_open(const void *ctx) char *filename; int fd; - filename = talloc_asprintf(ctx, "%s/state_dump", xs_daemon_rootdir()); + filename = talloc_asprintf(ctx, "%s/state_dump", xs_daemon_rundir()); if (!filename) return NULL; @@ -583,7 +583,7 @@ static void lu_get_dump_state(struct lu_dump_state *state) state->size = 0; state->filename = talloc_asprintf(NULL, "%s/state_dump", - xs_daemon_rootdir()); + xs_daemon_rundir()); if (!state->filename) barf("Allocation failure"); diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c index 07fbac55ac..a78cbf1116 100644 --- a/tools/xenstore/xenstored_core.c +++ b/tools/xenstore/xenstored_core.c @@ -2888,10 +2888,9 @@ int main(int argc, char *argv[]) reopen_log(); - /* make sure xenstored directories exist */ + /* Make sure xenstored directory exists. */ /* Errors ignored here, will be reported when we open files */ mkdir(xs_daemon_rundir(), 0755); - mkdir(xs_daemon_rootdir(), 0755); if (dofork) { openlog("xenstored", 0, LOG_DAEMON); diff --git a/tools/xenstore/xs_lib.c b/tools/xenstore/xs_lib.c index b9941c567c..826fa7b5a8 100644 --- a/tools/xenstore/xs_lib.c +++ b/tools/xenstore/xs_lib.c @@ -32,11 +32,6 @@ const char *xs_daemon_rundir(void) return (s ? s : XEN_RUN_STORED); } -const char *xs_daemon_rootdir(void) -{ - return xs_daemon_rundir(); -} - static const char *xs_daemon_path(void) { static char buf[PATH_MAX]; @@ -49,61 +44,11 @@ static const char *xs_daemon_path(void) return buf; } -const char *xs_daemon_tdb(void) -{ - static char buf[PATH_MAX]; - snprintf(buf, sizeof(buf), "%s/tdb", xs_daemon_rootdir()); - return buf; -} - const char *xs_daemon_socket(void) { return xs_daemon_path(); } -const char *xs_daemon_socket_ro(void) -{ - return xs_daemon_path(); -} - -const char *xs_domain_dev(void) -{ - char *s = getenv("XENSTORED_PATH"); - if (s) - return s; -#if defined(__RUMPUSER_XEN__) || defined(__RUMPRUN__) - return "/dev/xen/xenbus"; -#elif defined(__linux__) - if (access("/dev/xen/xenbus", F_OK) == 0) - return "/dev/xen/xenbus"; - return "/proc/xen/xenbus"; -#elif defined(__NetBSD__) - return "/kern/xen/xenbus"; -#elif defined(__FreeBSD__) - return "/dev/xen/xenstore"; -#else - return "/dev/xen/xenbus"; -#endif -} - -/* Simple routines for writing to sockets, etc. */ -bool xs_write_all(int fd, const void *data, unsigned int len) -{ - while (len) { - int done; - - done = write(fd, data, len); - if (done < 0 && errno == EINTR) - continue; - if (done <= 0) - return false; - data += done; - len -= done; - } - - return true; -} - /* Convert strings to permissions. False if a problem. */ bool xs_strings_to_perms(struct xs_permissions *perms, unsigned int num, const char *strings) @@ -179,114 +124,3 @@ unsigned int xs_count_strings(const char *strings, unsigned int len) return num; } - -char *expanding_buffer_ensure(struct expanding_buffer *ebuf, int min_avail) -{ - int want; - char *got; - - if (ebuf->avail >= min_avail) - return ebuf->buf; - - if (min_avail >= INT_MAX/3) - return 0; - - want = ebuf->avail + min_avail + 10; - got = realloc(ebuf->buf, want); - if (!got) - return 0; - - ebuf->buf = got; - ebuf->avail = want; - return ebuf->buf; -} - -char *sanitise_value(struct expanding_buffer *ebuf, - const char *val, unsigned len) -{ - int used, remain, c; - unsigned char *ip; - -#define ADD(c) (ebuf->buf[used++] = (c)) -#define ADDF(f,c) (used += sprintf(ebuf->buf+used, (f), (c))) - - assert(len < INT_MAX/5); - - ip = (unsigned char *)val; - used = 0; - remain = len; - - if (!expanding_buffer_ensure(ebuf, remain + 1)) - return NULL; - - while (remain-- > 0) { - c= *ip++; - - if (c >= ' ' && c <= '~' && c != '\\') { - ADD(c); - continue; - } - - if (!expanding_buffer_ensure(ebuf, used + remain + 5)) - /* for "\\nnn\0" */ - return 0; - - ADD('\\'); - switch (c) { - case '\t': ADD('t'); break; - case '\n': ADD('n'); break; - case '\r': ADD('r'); break; - case '\\': ADD('\\'); break; - default: - if (c < 010) ADDF("%03o", c); - else ADDF("x%02x", c); - } - } - - ADD(0); - assert(used <= ebuf->avail); - return ebuf->buf; - -#undef ADD -#undef ADDF -} - -void unsanitise_value(char *out, unsigned *out_len_r, const char *in) -{ - const char *ip; - char *op; - unsigned c; - int n; - - for (ip = in, op = out; (c = *ip++); *op++ = c) { - if (c == '\\') { - c = *ip++; - -#define GETF(f) do { \ - n = 0; \ - sscanf(ip, f "%n", &c, &n); \ - ip += n; \ - } while (0) - - switch (c) { - case 't': c= '\t'; break; - case 'n': c= '\n'; break; - case 'r': c= '\r'; break; - case '\\': c= '\\'; break; - case 'x': GETF("%2x"); break; - case '0': case '4': - case '1': case '5': - case '2': case '6': - case '3': case '7': --ip; GETF("%3o"); break; - case 0: --ip; break; - default:; - } -#undef GETF - } - } - - *op = 0; - - if (out_len_r) - *out_len_r = op - out; -} diff --git a/tools/xenstore/xs_lib.h b/tools/xenstore/xs_lib.h index efa05997d6..5b9874d741 100644 --- a/tools/xenstore/xs_lib.h +++ b/tools/xenstore/xs_lib.h @@ -21,10 +21,6 @@ #include "xenstore_lib.h" -const char *xs_daemon_rootdir(void); -const char *xs_domain_dev(void); -const char *xs_daemon_tdb(void); - /* Convert permissions to a string (up to len MAX_STRLEN(unsigned int)+1). */ bool xs_perm_to_string(const struct xs_permissions *perm, char *buffer, size_t buf_len); @@ -32,19 +28,4 @@ bool xs_perm_to_string(const struct xs_permissions *perm, /* Given a string and a length, count how many strings (nul terms). */ unsigned int xs_count_strings(const char *strings, unsigned int len); -/* Sanitising (quoting) possibly-binary strings. */ -struct expanding_buffer { - char *buf; - int avail; -}; - -/* Ensure that given expanding buffer has at least min_avail characters. */ -char *expanding_buffer_ensure(struct expanding_buffer *, int min_avail); - -/* sanitise_value() may return NULL if malloc fails. */ -char *sanitise_value(struct expanding_buffer *, const char *val, unsigned len); - -/* *out_len_r on entry is ignored; out must be at least strlen(in)+1 bytes. */ -void unsanitise_value(char *out, unsigned *out_len_r, const char *in); - #endif /* XS_LIB_H */ From patchwork Tue Jun 27 12:27:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?b?SsO8cmdlbiBHcm/Dnw==?= X-Patchwork-Id: 13294418 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 70EA4C001B0 for ; Tue, 27 Jun 2023 12:28:33 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.556120.868386 (Exim 4.92) (envelope-from ) id 1qE7nm-0001Db-1m; Tue, 27 Jun 2023 12:28:10 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 556120.868386; Tue, 27 Jun 2023 12:28:10 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qE7nl-0001DU-Uv; Tue, 27 Jun 2023 12:28:09 +0000 Received: by outflank-mailman (input) for mailman id 556120; Tue, 27 Jun 2023 12:28:08 +0000 Received: from se1-gles-flk1-in.inumbo.com ([94.247.172.50] helo=se1-gles-flk1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qE7nk-0000v0-MS for xen-devel@lists.xenproject.org; Tue, 27 Jun 2023 12:28:08 +0000 Received: from smtp-out2.suse.de (smtp-out2.suse.de [2001:67c:2178:6::1d]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id 106e5414-14e6-11ee-8611-37d641c3527e; Tue, 27 Jun 2023 14:28:04 +0200 (CEST) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out2.suse.de (Postfix) with ESMTPS id 825151F459; Tue, 27 Jun 2023 12:28:04 +0000 (UTC) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id 241AF13462; Tue, 27 Jun 2023 12:28:04 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id onBEB9TVmmRISAAAMHmgww (envelope-from ); Tue, 27 Jun 2023 12:28:04 +0000 X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 106e5414-14e6-11ee-8611-37d641c3527e DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=susede1; t=1687868884; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=vfUPsy9njdIloFdqX3w6ZfeC7y44yYDbvFPwWQK9nb8=; b=rIxp7663taH4q3mmcIazK8w1MEZIb0HrQLio5/jQy6oYtJm4G6al3dWbfIw4M2hqfWxkmM MUfscWkkWUy8JXL+XP7Hoj2Dc/OtjQaI1PkxuubTIwnYbJIjAHOqQ/5WQGPdvDzN+b7d2C D+pzT0bbFfYUufYqbkKAJCwNPZNdDws= From: Juergen Gross To: xen-devel@lists.xenproject.org Cc: Juergen Gross , Andrew Cooper , George Dunlap , Jan Beulich , Julien Grall , Stefano Stabellini , Wei Liu , Anthony PERARD , Julien Grall Subject: [PATCH v4 2/5] tools/xenstore: replace xs_lib.c with a header Date: Tue, 27 Jun 2023 14:27:47 +0200 Message-Id: <20230627122750.2007-3-jgross@suse.com> X-Mailer: git-send-email 2.35.3 In-Reply-To: <20230627122750.2007-1-jgross@suse.com> References: <20230627122750.2007-1-jgross@suse.com> MIME-Version: 1.0 Instead of including the same small C source in multiple binaries from 2 source directories, use a header file with inline functions as a replacement. As some of the functions are exported by libxenstore, rename the inline functions from xs_*() do xenstore_*() and add xs_*() wrappers to libxenstore. With that no sources required to build libxenstore are left in tools/xenstore, so the file COPYING can be removed now. Signed-off-by: Juergen Gross Acked-by: Julien Grall --- V3: - new patch --- MAINTAINERS | 1 + tools/include/xen-tools/xenstore-common.h | 128 ++++++ tools/libs/store/Makefile | 4 - tools/libs/store/xs.c | 28 +- tools/xenstore/COPYING | 514 ---------------------- tools/xenstore/Makefile | 2 +- tools/xenstore/Makefile.common | 2 +- tools/xenstore/xenstore_client.c | 4 +- tools/xenstore/xenstored_control.c | 9 +- tools/xenstore/xenstored_core.c | 15 +- tools/xenstore/xs_lib.c | 126 ------ tools/xenstore/xs_lib.h | 31 -- 12 files changed, 168 insertions(+), 696 deletions(-) create mode 100644 tools/include/xen-tools/xenstore-common.h delete mode 100644 tools/xenstore/COPYING delete mode 100644 tools/xenstore/xs_lib.c delete mode 100644 tools/xenstore/xs_lib.h diff --git a/MAINTAINERS b/MAINTAINERS index 7a07949e1d..d21c2fa8ee 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -656,6 +656,7 @@ F: tools/helpers/init-xenstore-domain.c F: tools/include/xenstore-compat/ F: tools/include/xenstore.h F: tools/include/xenstore_lib.h +F: tools/include/xen-tools/xenstore-common.h F: tools/libs/store/ F: tools/xenstore/ diff --git a/tools/include/xen-tools/xenstore-common.h b/tools/include/xen-tools/xenstore-common.h new file mode 100644 index 0000000000..8cb097a8fc --- /dev/null +++ b/tools/include/xen-tools/xenstore-common.h @@ -0,0 +1,128 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* Common functions for libxenstore, xenstored and xenstore-clients. */ + +#ifndef __XEN_TOOLS_XENSTORE_COMMON__ +#define __XEN_TOOLS_XENSTORE_COMMON__ + +#include +#include +#include +#include + +static inline const char *xenstore_daemon_rundir(void) +{ + char *s = getenv("XENSTORED_RUNDIR"); + + return s ? s : XEN_RUN_STORED; +} + +static inline const char *xenstore_daemon_path(void) +{ + static char buf[PATH_MAX]; + char *s = getenv("XENSTORED_PATH"); + + if ( s ) + return s; + + if ( snprintf(buf, sizeof(buf), "%s/socket", xenstore_daemon_rundir()) >= + PATH_MAX ) + return NULL; + + return buf; +} + +/* Convert strings to permissions. False if a problem. */ +static inline bool xenstore_strings_to_perms(struct xs_permissions *perms, + unsigned int num, + const char *strings) +{ + const char *p; + char *end; + unsigned int i; + + for ( p = strings, i = 0; i < num; i++ ) + { + /* "r", "w", or "b" for both. */ + switch ( *p ) + { + case 'r': + perms[i].perms = XS_PERM_READ; + break; + + case 'w': + perms[i].perms = XS_PERM_WRITE; + break; + + case 'b': + perms[i].perms = XS_PERM_READ|XS_PERM_WRITE; + break; + + case 'n': + perms[i].perms = XS_PERM_NONE; + break; + + default: + errno = EINVAL; + return false; + } + + p++; + perms[i].id = strtol(p, &end, 0); + if ( *end || !*p ) + { + errno = EINVAL; + return false; + } + + p = end + 1; + } + + return true; +} + +/* Convert permissions to a string (up to len MAX_STRLEN(unsigned int)+1). */ +static inline bool xenstore_perm_to_string(const struct xs_permissions *perm, + char *buffer, size_t buf_len) +{ + switch ( (int)perm->perms & ~XS_PERM_IGNORE ) + { + case XS_PERM_WRITE: + *buffer = 'w'; + break; + + case XS_PERM_READ: + *buffer = 'r'; + break; + + case XS_PERM_READ|XS_PERM_WRITE: + *buffer = 'b'; + break; + + case XS_PERM_NONE: + *buffer = 'n'; + break; + + default: + errno = EINVAL; + return false; + } + + snprintf(buffer + 1, buf_len - 1, "%i", (int)perm->id); + + return true; +} + +/* Given a string and a length, count how many strings (nul terms). */ +static inline unsigned int xenstore_count_strings(const char *strings, + unsigned int len) +{ + unsigned int num; + const char *p; + + for ( p = strings, num = 0; p < strings + len; p++ ) + if ( *p == '\0' ) + num++; + + return num; +} +#endif /* __XEN_TOOLS_XENSTORE_COMMON__ */ diff --git a/tools/libs/store/Makefile b/tools/libs/store/Makefile index daed9d148f..c1a1508713 100644 --- a/tools/libs/store/Makefile +++ b/tools/libs/store/Makefile @@ -9,7 +9,6 @@ ifeq ($(CONFIG_Linux),y) LDLIBS += -ldl endif -OBJS-y += xs_lib.o OBJS-y += xs.o LIBHEADER = xenstore.h xenstore_lib.h @@ -21,9 +20,6 @@ CFLAGS += -include $(XEN_ROOT)/tools/config.h CFLAGS += $(CFLAGS_libxentoolcore) CFLAGS += -DXEN_RUN_STORED="\"$(XEN_RUN_STORED)\"" -vpath xs_lib.c $(XEN_ROOT)/tools/xenstore -CFLAGS += -iquote $(XEN_ROOT)/tools/xenstore - xs.opic: CFLAGS += -DUSE_PTHREAD ifeq ($(CONFIG_Linux),y) xs.opic: CFLAGS += -DUSE_DLSYM diff --git a/tools/libs/store/xs.c b/tools/libs/store/xs.c index bb93246bfb..140b9a2839 100644 --- a/tools/libs/store/xs.c +++ b/tools/libs/store/xs.c @@ -34,8 +34,8 @@ #include #include #include +#include #include "xenstore.h" -#include "xs_lib.h" #include #include @@ -627,7 +627,7 @@ static char **xs_directory_common(char *strings, unsigned int len, char *p, **ret; /* Count the strings. */ - *num = xs_count_strings(strings, len); + *num = xenstore_count_strings(strings, len); /* Transfer to one big alloc for easy freeing. */ ret = malloc(*num * sizeof(char *) + len); @@ -775,7 +775,7 @@ struct xs_permissions *xs_get_permissions(struct xs_handle *h, return NULL; /* Count the strings: each one perms then domid. */ - *num = xs_count_strings(strings, len); + *num = xenstore_count_strings(strings, len); /* Transfer to one big alloc for easy freeing. */ ret = malloc(*num * sizeof(struct xs_permissions)); @@ -784,7 +784,7 @@ struct xs_permissions *xs_get_permissions(struct xs_handle *h, return NULL; } - if (!xs_strings_to_perms(ret, *num, strings)) { + if (!xenstore_strings_to_perms(ret, *num, strings)) { free_no_errno(ret); ret = NULL; } @@ -811,7 +811,7 @@ bool xs_set_permissions(struct xs_handle *h, for (i = 0; i < num_perms; i++) { char buffer[MAX_STRLEN(unsigned int)+1]; - if (!xs_perm_to_string(&perms[i], buffer, sizeof(buffer))) + if (!xenstore_perm_to_string(&perms[i], buffer, sizeof(buffer))) goto unwind; iov[i+1].iov_base = strdup(buffer); @@ -977,7 +977,7 @@ static char **read_watch_internal(struct xs_handle *h, unsigned int *num, assert(msg->hdr.type == XS_WATCH_EVENT); strings = msg->body; - num_strings = xs_count_strings(strings, msg->hdr.len); + num_strings = xenstore_count_strings(strings, msg->hdr.len); ret = malloc(sizeof(char*) * num_strings + msg->hdr.len); if (!ret) { @@ -1366,11 +1366,27 @@ error: return ret; } +const char *xs_daemon_socket(void) +{ + return xenstore_daemon_path(); +} + const char *xs_daemon_socket_ro(void) { return xs_daemon_socket(); } +const char *xs_daemon_rundir(void) +{ + return xenstore_daemon_rundir(); +} + +bool xs_strings_to_perms(struct xs_permissions *perms, unsigned int num, + const char *strings) +{ + return xenstore_strings_to_perms(perms, num, strings); +} + #ifdef USE_PTHREAD static void *read_thread(void *arg) { diff --git a/tools/xenstore/COPYING b/tools/xenstore/COPYING deleted file mode 100644 index c764b2e329..0000000000 --- a/tools/xenstore/COPYING +++ /dev/null @@ -1,514 +0,0 @@ -This license (LGPL) applies to the xenstore library which interfaces -with the xenstore daemon (as stated in xs.c, xenstore.h, xs_lib.c and -xenstore_lib.h). The remaining files in the directory are licensed as -stated in the comments (as of this writing, GPL, see ../../COPYING). - - - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations -below. - - When we speak of free software, we are referring to freedom of use, -not price. Our General Public Licenses are designed to make sure that -you have the freedom to distribute copies of free software (and charge -for this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it -becomes a de-facto standard. To achieve this, non-free programs must -be allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control -compilation and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at least - three years, to give the same user the materials specified in - Subsection 6a, above, for a charge no more than the cost of - performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply, and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License -may add an explicit geographical distribution limitation excluding those -countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser General Public License from time to time. -Such new versions will be similar in spirit to the present version, -but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY -KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU -FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR -CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE -LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms -of the ordinary General Public License). - - To apply these terms, attach the following notices to the library. -It is safest to attach them to the start of each source file to most -effectively convey the exclusion of warranty; and each file should -have at least the "copyright" line and a pointer to where the full -notice is found. - - - - Copyright (C) - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; If not, see . - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or -your school, if any, to sign a "copyright disclaimer" for the library, -if necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James - Random Hacker. - - , 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it! - - diff --git a/tools/xenstore/Makefile b/tools/xenstore/Makefile index 56723139a1..dc39b6cb31 100644 --- a/tools/xenstore/Makefile +++ b/tools/xenstore/Makefile @@ -44,7 +44,7 @@ xenstored: $(XENSTORED_OBJS-y) $(CLIENTS): xenstore ln -f xenstore $@ -xenstore: xenstore_client.o xs_lib.o +xenstore: xenstore_client.o $(CC) $(LDFLAGS) $^ $(LDLIBS) -o $@ $(APPEND_LDFLAGS) xenstore-control: xenstore_control.o diff --git a/tools/xenstore/Makefile.common b/tools/xenstore/Makefile.common index b18f95c103..f71c9bfd55 100644 --- a/tools/xenstore/Makefile.common +++ b/tools/xenstore/Makefile.common @@ -2,7 +2,7 @@ XENSTORED_OBJS-y := xenstored_core.o xenstored_watch.o xenstored_domain.o XENSTORED_OBJS-y += xenstored_transaction.o xenstored_control.o -XENSTORED_OBJS-y += xs_lib.o talloc.o utils.o tdb.o hashtable.o +XENSTORED_OBJS-y += talloc.o utils.o tdb.o hashtable.o XENSTORED_OBJS-$(CONFIG_Linux) += xenstored_posix.o XENSTORED_OBJS-$(CONFIG_NetBSD) += xenstored_posix.o diff --git a/tools/xenstore/xenstore_client.c b/tools/xenstore/xenstore_client.c index 27fda81401..a104cf6487 100644 --- a/tools/xenstore/xenstore_client.c +++ b/tools/xenstore/xenstore_client.c @@ -23,7 +23,7 @@ #include -#include "xs_lib.h" +#include #define PATH_SEP '/' #define MAX_PATH_LEN 256 @@ -361,7 +361,7 @@ static void do_ls(struct xs_handle *h, char *path, int cur_depth, int show_perms for (i = 0; i < nperms; i++) { if (i) putchar(','); - xs_perm_to_string(perms+i, buf, sizeof(buf)); + xenstore_perm_to_string(perms+i, buf, sizeof(buf)); fputs(buf, stdout); } putchar(')'); diff --git a/tools/xenstore/xenstored_control.c b/tools/xenstore/xenstored_control.c index 6ef800ff64..0d131e2ebc 100644 --- a/tools/xenstore/xenstored_control.c +++ b/tools/xenstore/xenstored_control.c @@ -31,10 +31,10 @@ #include #include #include +#include #include "utils.h" #include "talloc.h" -#include "xs_lib.h" #include "xenstored_core.h" #include "xenstored_control.h" #include "xenstored_domain.h" @@ -560,7 +560,8 @@ static FILE *lu_dump_open(const void *ctx) char *filename; int fd; - filename = talloc_asprintf(ctx, "%s/state_dump", xs_daemon_rundir()); + filename = talloc_asprintf(ctx, "%s/state_dump", + xenstore_daemon_rundir()); if (!filename) return NULL; @@ -583,7 +584,7 @@ static void lu_get_dump_state(struct lu_dump_state *state) state->size = 0; state->filename = talloc_asprintf(NULL, "%s/state_dump", - xs_daemon_rundir()); + xenstore_daemon_rundir()); if (!state->filename) barf("Allocation failure"); @@ -1017,7 +1018,7 @@ int do_control(const void *ctx, struct connection *conn, if (cmd == ARRAY_SIZE(cmds)) return EINVAL; - num = xs_count_strings(in->buffer, in->used); + num = xenstore_count_strings(in->buffer, in->used); if (cmds[cmd].max_pars) num = min(num, cmds[cmd].max_pars); vec = talloc_array(ctx, char *, num); diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c index a78cbf1116..62deee9cb9 100644 --- a/tools/xenstore/xenstored_core.c +++ b/tools/xenstore/xenstored_core.c @@ -42,11 +42,11 @@ #include #include +#include #include "utils.h" #include "list.h" #include "talloc.h" -#include "xs_lib.h" #include "xenstored_core.h" #include "xenstored_watch.h" #include "xenstored_transaction.h" @@ -1201,7 +1201,8 @@ static char *perms_to_strings(const void *ctx, const struct node_perms *perms, char buffer[MAX_STRLEN(unsigned int) + 1]; for (*len = 0, i = 0; i < perms->num; i++) { - if (!xs_perm_to_string(&perms->p[i], buffer, sizeof(buffer))) + if (!xenstore_perm_to_string(&perms->p[i], buffer, + sizeof(buffer))) return NULL; strings = talloc_realloc(ctx, strings, char, @@ -1279,7 +1280,7 @@ static int send_directory_part(const void *ctx, struct connection *conn, struct node *node; char gen[24]; - if (xs_count_strings(in->buffer, in->used) != 2) + if (xenstore_count_strings(in->buffer, in->used) != 2) return EINVAL; /* First arg is node name. */ @@ -1766,7 +1767,7 @@ static int do_set_perms(const void *ctx, struct connection *conn, char *name, *permstr; struct node *node; - perms.num = xs_count_strings(in->buffer, in->used); + perms.num = xenstore_count_strings(in->buffer, in->used); if (perms.num < 2) return EINVAL; @@ -1779,7 +1780,7 @@ static int do_set_perms(const void *ctx, struct connection *conn, perms.p = talloc_array(ctx, struct xs_permissions, perms.num); if (!perms.p) return ENOMEM; - if (!xs_strings_to_perms(perms.p, perms.num, permstr)) + if (!xenstore_strings_to_perms(perms.p, perms.num, permstr)) return errno; if (domain_alloc_permrefs(&perms) < 0) @@ -2575,7 +2576,7 @@ static void destroy_fds(void) static void init_sockets(void) { struct sockaddr_un addr; - const char *soc_str = xs_daemon_socket(); + const char *soc_str = xenstore_daemon_path(); if (!soc_str) barf_perror("Failed to obtain xs domain socket"); @@ -2890,7 +2891,7 @@ int main(int argc, char *argv[]) /* Make sure xenstored directory exists. */ /* Errors ignored here, will be reported when we open files */ - mkdir(xs_daemon_rundir(), 0755); + mkdir(xenstore_daemon_rundir(), 0755); if (dofork) { openlog("xenstored", 0, LOG_DAEMON); diff --git a/tools/xenstore/xs_lib.c b/tools/xenstore/xs_lib.c deleted file mode 100644 index 826fa7b5a8..0000000000 --- a/tools/xenstore/xs_lib.c +++ /dev/null @@ -1,126 +0,0 @@ -/* - Common routines between Xen store user library and daemon. - Copyright (C) 2005 Rusty Russell IBM Corporation - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; If not, see . -*/ - -#include -#include -#include -#include -#include -#include -#include "xs_lib.h" - -/* Common routines for the Xen store daemon and client library. */ - -const char *xs_daemon_rundir(void) -{ - char *s = getenv("XENSTORED_RUNDIR"); - return (s ? s : XEN_RUN_STORED); -} - -static const char *xs_daemon_path(void) -{ - static char buf[PATH_MAX]; - char *s = getenv("XENSTORED_PATH"); - if (s) - return s; - if (snprintf(buf, sizeof(buf), "%s/socket", - xs_daemon_rundir()) >= PATH_MAX) - return NULL; - return buf; -} - -const char *xs_daemon_socket(void) -{ - return xs_daemon_path(); -} - -/* Convert strings to permissions. False if a problem. */ -bool xs_strings_to_perms(struct xs_permissions *perms, unsigned int num, - const char *strings) -{ - const char *p; - char *end; - unsigned int i; - - for (p = strings, i = 0; i < num; i++) { - /* "r", "w", or "b" for both. */ - switch (*p) { - case 'r': - perms[i].perms = XS_PERM_READ; - break; - case 'w': - perms[i].perms = XS_PERM_WRITE; - break; - case 'b': - perms[i].perms = XS_PERM_READ|XS_PERM_WRITE; - break; - case 'n': - perms[i].perms = XS_PERM_NONE; - break; - default: - errno = EINVAL; - return false; - } - p++; - perms[i].id = strtol(p, &end, 0); - if (*end || !*p) { - errno = EINVAL; - return false; - } - p = end + 1; - } - return true; -} - -/* Convert permissions to a string (up to len MAX_STRLEN(unsigned int)+1). */ -bool xs_perm_to_string(const struct xs_permissions *perm, - char *buffer, size_t buf_len) -{ - switch ((int)perm->perms & ~XS_PERM_IGNORE) { - case XS_PERM_WRITE: - *buffer = 'w'; - break; - case XS_PERM_READ: - *buffer = 'r'; - break; - case XS_PERM_READ|XS_PERM_WRITE: - *buffer = 'b'; - break; - case XS_PERM_NONE: - *buffer = 'n'; - break; - default: - errno = EINVAL; - return false; - } - snprintf(buffer+1, buf_len-1, "%i", (int)perm->id); - return true; -} - -/* Given a string and a length, count how many strings (nul terms). */ -unsigned int xs_count_strings(const char *strings, unsigned int len) -{ - unsigned int num; - const char *p; - - for (p = strings, num = 0; p < strings + len; p++) - if (*p == '\0') - num++; - - return num; -} diff --git a/tools/xenstore/xs_lib.h b/tools/xenstore/xs_lib.h deleted file mode 100644 index 5b9874d741..0000000000 --- a/tools/xenstore/xs_lib.h +++ /dev/null @@ -1,31 +0,0 @@ -/* - Common routines between Xen store user library and daemon. - Copyright (C) 2005 Rusty Russell IBM Corporation - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; If not, see . -*/ - -#ifndef XS_LIB_H -#define XS_LIB_H - -#include "xenstore_lib.h" - -/* Convert permissions to a string (up to len MAX_STRLEN(unsigned int)+1). */ -bool xs_perm_to_string(const struct xs_permissions *perm, - char *buffer, size_t buf_len); - -/* Given a string and a length, count how many strings (nul terms). */ -unsigned int xs_count_strings(const char *strings, unsigned int len); - -#endif /* XS_LIB_H */ From patchwork Tue Jun 27 12:27:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?b?SsO8cmdlbiBHcm/Dnw==?= X-Patchwork-Id: 13294419 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id AC1CCEB64D9 for ; Tue, 27 Jun 2023 12:28:38 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.556121.868396 (Exim 4.92) (envelope-from ) id 1qE7np-0001VZ-EG; Tue, 27 Jun 2023 12:28:13 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 556121.868396; Tue, 27 Jun 2023 12:28:13 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qE7np-0001VS-BE; Tue, 27 Jun 2023 12:28:13 +0000 Received: by outflank-mailman (input) for mailman id 556121; Tue, 27 Jun 2023 12:28:11 +0000 Received: from se1-gles-sth1-in.inumbo.com ([159.253.27.254] helo=se1-gles-sth1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qE7nn-0000fg-F7 for xen-devel@lists.xenproject.org; Tue, 27 Jun 2023 12:28:11 +0000 Received: from smtp-out2.suse.de (smtp-out2.suse.de [195.135.220.29]) by se1-gles-sth1.inumbo.com (Halon) with ESMTPS id 13cd77f5-14e6-11ee-b237-6b7b168915f2; Tue, 27 Jun 2023 14:28:10 +0200 (CEST) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out2.suse.de (Postfix) with ESMTPS id 239A71F898; Tue, 27 Jun 2023 12:28:10 +0000 (UTC) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id E5DE813462; Tue, 27 Jun 2023 12:28:09 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id NNmaNtnVmmRUSAAAMHmgww (envelope-from ); Tue, 27 Jun 2023 12:28:09 +0000 X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 13cd77f5-14e6-11ee-b237-6b7b168915f2 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=susede1; t=1687868890; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=0lmDSOzNGqLK8c7swzzgALv2u+YxRV1MuLwjYxjFGHE=; b=bF1QIufFwxbQP98F0CexJQ2K4a47Nln9sij4V+maV48RhSR4AV8uHGJG5qFBB7N1ZrSU43 g4ovhg/wud13xYCEilBrkXQ/eO5tkRY1eQY6tafulmz+A9Ygm1oFpz2xFl9s5P5CQcm3XP bKTmWWXQEk9pbxmp2GyR1j+7J5zmBA8= From: Juergen Gross To: xen-devel@lists.xenproject.org Cc: Juergen Gross , Wei Liu , Julien Grall , Anthony PERARD Subject: [PATCH v4 3/5] tools/xenstore: split out environment specific live update code Date: Tue, 27 Jun 2023 14:27:48 +0200 Message-Id: <20230627122750.2007-4-jgross@suse.com> X-Mailer: git-send-email 2.35.3 In-Reply-To: <20230627122750.2007-1-jgross@suse.com> References: <20230627122750.2007-1-jgross@suse.com> MIME-Version: 1.0 Instead of using #ifdef in xenstored_control.c split out the code of environment specific functions (daemon or Mini-OS) to dedicated source files. Signed-off-by: Juergen Gross Reviewed-by: Julien Grall --- V4: - split lu_destroy() in common and specific parts (Julien Grall) --- tools/xenstore/Makefile.common | 8 +- tools/xenstore/xenstored_control.c | 247 +-------------------------- tools/xenstore/xenstored_lu.h | 56 ++++++ tools/xenstore/xenstored_lu_daemon.c | 130 ++++++++++++++ tools/xenstore/xenstored_lu_minios.c | 118 +++++++++++++ 5 files changed, 312 insertions(+), 247 deletions(-) create mode 100644 tools/xenstore/xenstored_lu.h create mode 100644 tools/xenstore/xenstored_lu_daemon.c create mode 100644 tools/xenstore/xenstored_lu_minios.c diff --git a/tools/xenstore/Makefile.common b/tools/xenstore/Makefile.common index f71c9bfd55..c42796fe34 100644 --- a/tools/xenstore/Makefile.common +++ b/tools/xenstore/Makefile.common @@ -4,10 +4,10 @@ XENSTORED_OBJS-y := xenstored_core.o xenstored_watch.o xenstored_domain.o XENSTORED_OBJS-y += xenstored_transaction.o xenstored_control.o XENSTORED_OBJS-y += talloc.o utils.o tdb.o hashtable.o -XENSTORED_OBJS-$(CONFIG_Linux) += xenstored_posix.o -XENSTORED_OBJS-$(CONFIG_NetBSD) += xenstored_posix.o -XENSTORED_OBJS-$(CONFIG_FreeBSD) += xenstored_posix.o -XENSTORED_OBJS-$(CONFIG_MiniOS) += xenstored_minios.o +XENSTORED_OBJS-$(CONFIG_Linux) += xenstored_posix.o xenstored_lu_daemon.o +XENSTORED_OBJS-$(CONFIG_NetBSD) += xenstored_posix.o xenstored_lu_daemon.o +XENSTORED_OBJS-$(CONFIG_FreeBSD) += xenstored_posix.o xenstored_lu_daemon.o +XENSTORED_OBJS-$(CONFIG_MiniOS) += xenstored_minios.o xenstored_lu_minios.o # Include configure output (config.h) CFLAGS += -include $(XEN_ROOT)/tools/config.h diff --git a/tools/xenstore/xenstored_control.c b/tools/xenstore/xenstored_control.c index 0d131e2ebc..8f1f31fd6a 100644 --- a/tools/xenstore/xenstored_control.c +++ b/tools/xenstore/xenstored_control.c @@ -38,63 +38,21 @@ #include "xenstored_core.h" #include "xenstored_control.h" #include "xenstored_domain.h" +#include "xenstored_lu.h" #include "xenstored_watch.h" -/* Mini-OS only knows about MAP_ANON. */ -#ifndef MAP_ANONYMOUS -#define MAP_ANONYMOUS MAP_ANON -#endif - #ifndef NO_LIVE_UPDATE -struct live_update { - /* For verification the correct connection is acting. */ - struct connection *conn; - - /* Pointer to the command used to request LU */ - struct buffered_data *in; - -#ifdef __MINIOS__ - void *kernel; - unsigned int kernel_size; - unsigned int kernel_off; - - void *dump_state; - unsigned long dump_size; -#else - char *filename; -#endif - - char *cmdline; - - /* Start parameters. */ - bool force; - unsigned int timeout; - time_t started_at; -}; - -static struct live_update *lu_status; - -struct lu_dump_state { - void *buf; - unsigned int size; -#ifndef __MINIOS__ - int fd; - char *filename; -#endif -}; +struct live_update *lu_status; static int lu_destroy(void *data) { -#ifdef __MINIOS__ - if (lu_status->dump_state) - munmap(lu_status->dump_state, lu_status->dump_size); -#endif + lu_destroy_arch(data); lu_status = NULL; return 0; } -static const char *lu_begin(struct connection *conn) +const char *lu_begin(struct connection *conn) { if (lu_status) return "live-update session already active."; @@ -431,203 +389,6 @@ static const char *lu_cmdline(const void *ctx, struct connection *conn, return NULL; } -#ifdef __MINIOS__ -static const char *lu_binary_alloc(const void *ctx, struct connection *conn, - unsigned long size) -{ - const char *ret; - - syslog(LOG_INFO, "live-update: binary size %lu\n", size); - - ret = lu_begin(conn); - if (ret) - return ret; - - lu_status->kernel = talloc_size(lu_status, size); - if (!lu_status->kernel) - return "Allocation failure."; - - lu_status->kernel_size = size; - lu_status->kernel_off = 0; - - errno = 0; - return NULL; -} - -static const char *lu_binary_save(const void *ctx, struct connection *conn, - unsigned int size, const char *data) -{ - if (!lu_status || lu_status->conn != conn) - return "Not in live-update session."; - - if (lu_status->kernel_off + size > lu_status->kernel_size) - return "Too much kernel data."; - - memcpy(lu_status->kernel + lu_status->kernel_off, data, size); - lu_status->kernel_off += size; - - errno = 0; - return NULL; -} - -static const char *lu_arch(const void *ctx, struct connection *conn, - char **vec, int num) -{ - if (num == 2 && !strcmp(vec[0], "-b")) - return lu_binary_alloc(ctx, conn, atol(vec[1])); - if (num > 2 && !strcmp(vec[0], "-d")) - return lu_binary_save(ctx, conn, atoi(vec[1]), vec[2]); - - errno = EINVAL; - return NULL; -} - -static FILE *lu_dump_open(const void *ctx) -{ - lu_status->dump_size = ROUNDUP(talloc_total_size(NULL) * 2, - XC_PAGE_SHIFT); - lu_status->dump_state = mmap(NULL, lu_status->dump_size, - PROT_READ | PROT_WRITE, - MAP_PRIVATE | MAP_ANONYMOUS, -1, 0); - if (lu_status->dump_state == MAP_FAILED) - return NULL; - - return fmemopen(lu_status->dump_state, lu_status->dump_size, "w"); -} - -static void lu_dump_close(FILE *fp) -{ - size_t size; - - size = ftell(fp); - size = ROUNDUP(size, XC_PAGE_SHIFT); - munmap(lu_status->dump_state + size, lu_status->dump_size - size); - lu_status->dump_size = size; - - fclose(fp); -} - -static void lu_get_dump_state(struct lu_dump_state *state) -{ -} - -static void lu_close_dump_state(struct lu_dump_state *state) -{ -} - -static char *lu_exec(const void *ctx, int argc, char **argv) -{ - return "NYI"; -} -#else -static const char *lu_binary(const void *ctx, struct connection *conn, - const char *filename) -{ - const char *ret; - struct stat statbuf; - - syslog(LOG_INFO, "live-update: binary %s\n", filename); - - if (stat(filename, &statbuf)) - return "File not accessible."; - if (!(statbuf.st_mode & (S_IXOTH | S_IXGRP | S_IXUSR))) - return "File not executable."; - - ret = lu_begin(conn); - if (ret) - return ret; - - lu_status->filename = talloc_strdup(lu_status, filename); - if (!lu_status->filename) - return "Allocation failure."; - - errno = 0; - return NULL; -} - -static const char *lu_arch(const void *ctx, struct connection *conn, - char **vec, int num) -{ - if (num == 2 && !strcmp(vec[0], "-f")) - return lu_binary(ctx, conn, vec[1]); - - errno = EINVAL; - return NULL; -} - -static FILE *lu_dump_open(const void *ctx) -{ - char *filename; - int fd; - - filename = talloc_asprintf(ctx, "%s/state_dump", - xenstore_daemon_rundir()); - if (!filename) - return NULL; - - fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR); - if (fd < 0) - return NULL; - - return fdopen(fd, "w"); -} - -static void lu_dump_close(FILE *fp) -{ - fclose(fp); -} - -static void lu_get_dump_state(struct lu_dump_state *state) -{ - struct stat statbuf; - - state->size = 0; - - state->filename = talloc_asprintf(NULL, "%s/state_dump", - xenstore_daemon_rundir()); - if (!state->filename) - barf("Allocation failure"); - - state->fd = open(state->filename, O_RDONLY); - if (state->fd < 0) - return; - if (fstat(state->fd, &statbuf) != 0) - goto out_close; - state->size = statbuf.st_size; - - state->buf = mmap(NULL, state->size, PROT_READ, MAP_PRIVATE, - state->fd, 0); - if (state->buf == MAP_FAILED) { - state->size = 0; - goto out_close; - } - - return; - - out_close: - close(state->fd); -} - -static void lu_close_dump_state(struct lu_dump_state *state) -{ - assert(state->filename != NULL); - - munmap(state->buf, state->size); - close(state->fd); - - unlink(state->filename); - talloc_free(state->filename); -} - -static char *lu_exec(const void *ctx, int argc, char **argv) -{ - argv[0] = lu_status->filename; - execvp(argv[0], argv); - - return "Error activating new binary."; -} -#endif - static bool lu_check_lu_allowed(void) { struct connection *conn; diff --git a/tools/xenstore/xenstored_lu.h b/tools/xenstore/xenstored_lu.h new file mode 100644 index 0000000000..1c09b9b639 --- /dev/null +++ b/tools/xenstore/xenstored_lu.h @@ -0,0 +1,56 @@ +/* SPDX-License-Identifier: MIT */ + +/* + * Live Update interfaces for Xen Store Daemon. + * Copyright (C) 2022 Juergen Gross, SUSE LLC + */ + +#ifndef NO_LIVE_UPDATE +struct live_update { + /* For verification the correct connection is acting. */ + struct connection *conn; + + /* Pointer to the command used to request LU */ + struct buffered_data *in; + +#ifdef __MINIOS__ + void *kernel; + unsigned int kernel_size; + unsigned int kernel_off; + + void *dump_state; + unsigned long dump_size; +#else + char *filename; +#endif + + char *cmdline; + + /* Start parameters. */ + bool force; + unsigned int timeout; + time_t started_at; +}; + +struct lu_dump_state { + void *buf; + unsigned int size; +#ifndef __MINIOS__ + int fd; + char *filename; +#endif +}; + +extern struct live_update *lu_status; + +/* Live update private interfaces. */ +void lu_get_dump_state(struct lu_dump_state *state); +void lu_close_dump_state(struct lu_dump_state *state); +FILE *lu_dump_open(const void *ctx); +void lu_dump_close(FILE *fp); +char *lu_exec(const void *ctx, int argc, char **argv); +const char *lu_arch(const void *ctx, struct connection *conn, char **vec, + int num); +const char *lu_begin(struct connection *conn); +void lu_destroy_arch(void *data); +#endif diff --git a/tools/xenstore/xenstored_lu_daemon.c b/tools/xenstore/xenstored_lu_daemon.c new file mode 100644 index 0000000000..310fb8c2e6 --- /dev/null +++ b/tools/xenstore/xenstored_lu_daemon.c @@ -0,0 +1,130 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ + +/* + * Live Update for Xen Store Daemon. + * Copyright (C) 2022 Juergen Gross, SUSE LLC + */ + +#include +#include +#include +#include +#include +#include + +#include "talloc.h" +#include "xenstored_core.h" +#include "xenstored_lu.h" + +#ifndef NO_LIVE_UPDATE +void lu_get_dump_state(struct lu_dump_state *state) +{ + struct stat statbuf; + + state->size = 0; + + state->filename = talloc_asprintf(NULL, "%s/state_dump", + xenstore_daemon_rundir()); + if (!state->filename) + barf("Allocation failure"); + + state->fd = open(state->filename, O_RDONLY); + if (state->fd < 0) + return; + if (fstat(state->fd, &statbuf) != 0) + goto out_close; + state->size = statbuf.st_size; + + state->buf = mmap(NULL, state->size, PROT_READ, MAP_PRIVATE, + state->fd, 0); + if (state->buf == MAP_FAILED) { + state->size = 0; + goto out_close; + } + + return; + + out_close: + close(state->fd); +} + +void lu_close_dump_state(struct lu_dump_state *state) +{ + assert(state->filename != NULL); + + munmap(state->buf, state->size); + close(state->fd); + + unlink(state->filename); + talloc_free(state->filename); +} + +FILE *lu_dump_open(const void *ctx) +{ + char *filename; + int fd; + + filename = talloc_asprintf(ctx, "%s/state_dump", + xenstore_daemon_rundir()); + if (!filename) + return NULL; + + fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR); + if (fd < 0) + return NULL; + + return fdopen(fd, "w"); +} + +void lu_dump_close(FILE *fp) +{ + fclose(fp); +} + +char *lu_exec(const void *ctx, int argc, char **argv) +{ + argv[0] = lu_status->filename; + execvp(argv[0], argv); + + return "Error activating new binary."; +} + +void lu_destroy_arch(void *data) +{ +} + +static const char *lu_binary(const void *ctx, struct connection *conn, + const char *filename) +{ + const char *ret; + struct stat statbuf; + + syslog(LOG_INFO, "live-update: binary %s\n", filename); + + if (stat(filename, &statbuf)) + return "File not accessible."; + if (!(statbuf.st_mode & (S_IXOTH | S_IXGRP | S_IXUSR))) + return "File not executable."; + + ret = lu_begin(conn); + if (ret) + return ret; + + lu_status->filename = talloc_strdup(lu_status, filename); + if (!lu_status->filename) + return "Allocation failure."; + + errno = 0; + return NULL; +} + +const char *lu_arch(const void *ctx, struct connection *conn, char **vec, + int num) +{ + if (num == 2 && !strcmp(vec[0], "-f")) + return lu_binary(ctx, conn, vec[1]); + + errno = EINVAL; + return NULL; +} +#endif diff --git a/tools/xenstore/xenstored_lu_minios.c b/tools/xenstore/xenstored_lu_minios.c new file mode 100644 index 0000000000..88fb9e0f38 --- /dev/null +++ b/tools/xenstore/xenstored_lu_minios.c @@ -0,0 +1,118 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ + +/* + * Live Update for Xen Store Daemon. + * Copyright (C) 2022 Juergen Gross, SUSE LLC + */ + +#include +#include +#include +#include +#include +#include +#include + +#include "talloc.h" +#include "xenstored_lu.h" + +/* Mini-OS only knows about MAP_ANON. */ +#ifndef MAP_ANONYMOUS +#define MAP_ANONYMOUS MAP_ANON +#endif + +#ifndef NO_LIVE_UPDATE +void lu_get_dump_state(struct lu_dump_state *state) +{ +} + +void lu_close_dump_state(struct lu_dump_state *state) +{ +} + +FILE *lu_dump_open(const void *ctx) +{ + lu_status->dump_size = ROUNDUP(talloc_total_size(NULL) * 2, + XC_PAGE_SHIFT); + lu_status->dump_state = mmap(NULL, lu_status->dump_size, + PROT_READ | PROT_WRITE, + MAP_PRIVATE | MAP_ANONYMOUS, -1, 0); + if (lu_status->dump_state == MAP_FAILED) + return NULL; + + return fmemopen(lu_status->dump_state, lu_status->dump_size, "w"); +} + +void lu_dump_close(FILE *fp) +{ + size_t size; + + size = ftell(fp); + size = ROUNDUP(size, XC_PAGE_SHIFT); + munmap(lu_status->dump_state + size, lu_status->dump_size - size); + lu_status->dump_size = size; + + fclose(fp); +} + +char *lu_exec(const void *ctx, int argc, char **argv) +{ + return "NYI"; +} + +void lu_destroy_arch(void *data) +{ + if (lu_status->dump_state) + munmap(lu_status->dump_state, lu_status->dump_size); +} + +static const char *lu_binary_alloc(const void *ctx, struct connection *conn, + unsigned long size) +{ + const char *ret; + + syslog(LOG_INFO, "live-update: binary size %lu\n", size); + + ret = lu_begin(conn); + if (ret) + return ret; + + lu_status->kernel = talloc_size(lu_status, size); + if (!lu_status->kernel) + return "Allocation failure."; + + lu_status->kernel_size = size; + lu_status->kernel_off = 0; + + errno = 0; + return NULL; +} + +static const char *lu_binary_save(const void *ctx, struct connection *conn, + unsigned int size, const char *data) +{ + if (!lu_status || lu_status->conn != conn) + return "Not in live-update session."; + + if (lu_status->kernel_off + size > lu_status->kernel_size) + return "Too much kernel data."; + + memcpy(lu_status->kernel + lu_status->kernel_off, data, size); + lu_status->kernel_off += size; + + errno = 0; + return NULL; +} + +const char *lu_arch(const void *ctx, struct connection *conn, char **vec, + int num) +{ + if (num == 2 && !strcmp(vec[0], "-b")) + return lu_binary_alloc(ctx, conn, atol(vec[1])); + if (num > 2 && !strcmp(vec[0], "-d")) + return lu_binary_save(ctx, conn, atoi(vec[1]), vec[2]); + + errno = EINVAL; + return NULL; +} +#endif From patchwork Tue Jun 27 12:27:49 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?b?SsO8cmdlbiBHcm/Dnw==?= X-Patchwork-Id: 13294420 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id C76A3EB64D9 for ; Tue, 27 Jun 2023 12:28:41 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.556124.868407 (Exim 4.92) (envelope-from ) id 1qE7nw-0001zf-MT; Tue, 27 Jun 2023 12:28:20 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 556124.868407; Tue, 27 Jun 2023 12:28:20 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qE7nw-0001zM-JX; Tue, 27 Jun 2023 12:28:20 +0000 Received: by outflank-mailman (input) for mailman id 556124; Tue, 27 Jun 2023 12:28:19 +0000 Received: from se1-gles-flk1-in.inumbo.com ([94.247.172.50] helo=se1-gles-flk1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qE7nu-0000v0-ST for xen-devel@lists.xenproject.org; Tue, 27 Jun 2023 12:28:19 +0000 Received: from smtp-out1.suse.de (smtp-out1.suse.de [195.135.220.28]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id 1724a9d1-14e6-11ee-8611-37d641c3527e; Tue, 27 Jun 2023 14:28:16 +0200 (CEST) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out1.suse.de (Postfix) with ESMTPS id C0E5B21887; Tue, 27 Jun 2023 12:28:15 +0000 (UTC) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id 8A3C213462; Tue, 27 Jun 2023 12:28:15 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id uKU4IN/VmmRnSAAAMHmgww (envelope-from ); Tue, 27 Jun 2023 12:28:15 +0000 X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 1724a9d1-14e6-11ee-8611-37d641c3527e DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=susede1; t=1687868895; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Uded6oY6Ay2EcxlEmvhHiri4cvIDg6QKAnrdw83iZnM=; b=saQL5MENUDALuquTVxuF4iTrFJFw2K5xvb2fEVOZCGgQwZ/suLGaLeq/GALETaQVyxQqjh P0nXw2xEX+F2HtoiQ33s0LU4G0n7mT77OBs3pt9PBgIDiG7+Yc6UsDK0l9KIuTZRgkjfYr ftfHe8x3IFrmCJhJajsBB/gqNww8Akk= From: Juergen Gross To: xen-devel@lists.xenproject.org Cc: Juergen Gross , Wei Liu , Julien Grall , Anthony PERARD Subject: [PATCH v4 4/5] tools/xenstore: split out rest of live update control code Date: Tue, 27 Jun 2023 14:27:49 +0200 Message-Id: <20230627122750.2007-5-jgross@suse.com> X-Mailer: git-send-email 2.35.3 In-Reply-To: <20230627122750.2007-1-jgross@suse.com> References: <20230627122750.2007-1-jgross@suse.com> MIME-Version: 1.0 Move the rest of live update related code from xenstored_control.c to a dedicated new source file. Signed-off-by: Juergen Gross Acked-by: Julien Grall --- tools/xenstore/Makefile.common | 2 +- tools/xenstore/xenstored_control.c | 417 ----------------------------- tools/xenstore/xenstored_control.h | 8 - tools/xenstore/xenstored_core.c | 1 + tools/xenstore/xenstored_lu.c | 408 ++++++++++++++++++++++++++++ tools/xenstore/xenstored_lu.h | 25 ++ 6 files changed, 435 insertions(+), 426 deletions(-) create mode 100644 tools/xenstore/xenstored_lu.c diff --git a/tools/xenstore/Makefile.common b/tools/xenstore/Makefile.common index c42796fe34..657a16849e 100644 --- a/tools/xenstore/Makefile.common +++ b/tools/xenstore/Makefile.common @@ -1,7 +1,7 @@ # Makefile shared with stubdom XENSTORED_OBJS-y := xenstored_core.o xenstored_watch.o xenstored_domain.o -XENSTORED_OBJS-y += xenstored_transaction.o xenstored_control.o +XENSTORED_OBJS-y += xenstored_transaction.o xenstored_control.o xenstored_lu.o XENSTORED_OBJS-y += talloc.o utils.o tdb.o hashtable.o XENSTORED_OBJS-$(CONFIG_Linux) += xenstored_posix.o xenstored_lu_daemon.o diff --git a/tools/xenstore/xenstored_control.c b/tools/xenstore/xenstored_control.c index 8f1f31fd6a..145a0e5aff 100644 --- a/tools/xenstore/xenstored_control.c +++ b/tools/xenstore/xenstored_control.c @@ -16,21 +16,13 @@ along with this program; If not, see . */ -#include -#include #include #include #include #include #include -#include -#include #include -#include -#include -#include #include -#include #include #include "utils.h" @@ -39,77 +31,6 @@ #include "xenstored_control.h" #include "xenstored_domain.h" #include "xenstored_lu.h" -#include "xenstored_watch.h" - -#ifndef NO_LIVE_UPDATE -struct live_update *lu_status; - -static int lu_destroy(void *data) -{ - lu_destroy_arch(data); - lu_status = NULL; - - return 0; -} - -const char *lu_begin(struct connection *conn) -{ - if (lu_status) - return "live-update session already active."; - - lu_status = talloc_zero(conn, struct live_update); - if (!lu_status) - return "Allocation failure."; - lu_status->conn = conn; - talloc_set_destructor(lu_status, lu_destroy); - - return NULL; -} - -struct connection *lu_get_connection(void) -{ - return lu_status ? lu_status->conn : NULL; -} - -unsigned int lu_write_response(FILE *fp) -{ - struct xsd_sockmsg msg; - - assert(lu_status); - - msg = lu_status->in->hdr.msg; - - msg.len = sizeof("OK"); - if (fp && fwrite(&msg, sizeof(msg), 1, fp) != 1) - return 0; - if (fp && fwrite("OK", msg.len, 1, fp) != 1) - return 0; - - return sizeof(msg) + msg.len; -} - -bool lu_is_pending(void) -{ - return lu_status != NULL; -} - -#else -struct connection *lu_get_connection(void) -{ - return NULL; -} - -unsigned int lu_write_response(FILE *fp) -{ - /* Unsupported */ - return 0; -} - -bool lu_is_pending(void) -{ - return false; -} -#endif struct cmd_s { char *cmd; @@ -360,344 +281,6 @@ static int do_control_print(const void *ctx, struct connection *conn, return 0; } -#ifndef NO_LIVE_UPDATE -static const char *lu_abort(const void *ctx, struct connection *conn) -{ - syslog(LOG_INFO, "live-update: abort\n"); - - if (!lu_status) - return "No live-update session active."; - - /* Destructor will do the real abort handling. */ - talloc_free(lu_status); - - return NULL; -} - -static const char *lu_cmdline(const void *ctx, struct connection *conn, - const char *cmdline) -{ - syslog(LOG_INFO, "live-update: cmdline %s\n", cmdline); - - if (!lu_status || lu_status->conn != conn) - return "Not in live-update session."; - - lu_status->cmdline = talloc_strdup(lu_status, cmdline); - if (!lu_status->cmdline) - return "Allocation failure."; - - return NULL; -} - -static bool lu_check_lu_allowed(void) -{ - struct connection *conn; - time_t now = time(NULL); - unsigned int ta_total = 0, ta_long = 0; - - list_for_each_entry(conn, &connections, list) { - if (conn->ta_start_time) { - ta_total++; - if (now - conn->ta_start_time >= lu_status->timeout) - ta_long++; - } - } - - /* - * Allow LiveUpdate if one of the following conditions is met: - * - There is no active transactions - * - All transactions are long running (e.g. they have been - * active for more than lu_status->timeout sec) and the admin as - * requested to force the operation. - */ - return ta_total ? (lu_status->force && ta_long == ta_total) : true; -} - -static const char *lu_reject_reason(const void *ctx) -{ - char *ret = NULL; - struct connection *conn; - time_t now = time(NULL); - - list_for_each_entry(conn, &connections, list) { - unsigned long tdiff = now - conn->ta_start_time; - - if (conn->ta_start_time && (tdiff >= lu_status->timeout)) { - ret = talloc_asprintf(ctx, "%s\nDomain %u: %ld s", - ret ? : "Domains with long running transactions:", - conn->id, tdiff); - } - } - - return ret ? (const char *)ret : "Overlapping transactions"; -} - -static const char *lu_dump_state(const void *ctx, struct connection *conn) -{ - FILE *fp; - const char *ret; - struct xs_state_record_header end; - struct xs_state_preamble pre; - - fp = lu_dump_open(ctx); - if (!fp) - return "Dump state open error"; - - memcpy(pre.ident, XS_STATE_IDENT, sizeof(pre.ident)); - pre.version = htobe32(XS_STATE_VERSION); - pre.flags = XS_STATE_FLAGS; - if (fwrite(&pre, sizeof(pre), 1, fp) != 1) { - ret = "Dump write error"; - goto out; - } - - ret = dump_state_global(fp); - if (ret) - goto out; - ret = dump_state_connections(fp); - if (ret) - goto out; - ret = dump_state_nodes(fp, ctx); - if (ret) - goto out; - - end.type = XS_STATE_TYPE_END; - end.length = 0; - if (fwrite(&end, sizeof(end), 1, fp) != 1) - ret = "Dump write error"; - - out: - lu_dump_close(fp); - - return ret; -} - -void lu_read_state(void) -{ - struct lu_dump_state state = {}; - struct xs_state_record_header *head; - void *ctx = talloc_new(NULL); /* Work context for subfunctions. */ - struct xs_state_preamble *pre; - - syslog(LOG_INFO, "live-update: read state\n"); - lu_get_dump_state(&state); - if (state.size == 0) - barf_perror("No state found after live-update"); - - pre = state.buf; - if (memcmp(pre->ident, XS_STATE_IDENT, sizeof(pre->ident)) || - pre->version != htobe32(XS_STATE_VERSION) || - pre->flags != XS_STATE_FLAGS) - barf("Unknown record identifier"); - for (head = state.buf + sizeof(*pre); - head->type != XS_STATE_TYPE_END && - (void *)head - state.buf < state.size; - head = (void *)head + sizeof(*head) + head->length) { - switch (head->type) { - case XS_STATE_TYPE_GLOBAL: - read_state_global(ctx, head + 1); - break; - case XS_STATE_TYPE_CONN: - read_state_connection(ctx, head + 1); - break; - case XS_STATE_TYPE_WATCH: - read_state_watch(ctx, head + 1); - break; - case XS_STATE_TYPE_TA: - xprintf("live-update: ignore transaction record\n"); - break; - case XS_STATE_TYPE_NODE: - read_state_node(ctx, head + 1); - break; - default: - xprintf("live-update: unknown state record %08x\n", - head->type); - break; - } - } - - lu_close_dump_state(&state); - - talloc_free(ctx); - - /* - * We may have missed the VIRQ_DOM_EXC notification and a domain may - * have died while we were live-updating. So check all the domains are - * still alive. - */ - check_domains(); -} - -static const char *lu_activate_binary(const void *ctx) -{ - int argc; - char **argv; - unsigned int i; - - if (lu_status->cmdline) { - argc = 4; /* At least one arg + progname + "-U" + NULL. */ - for (i = 0; lu_status->cmdline[i]; i++) - if (isspace(lu_status->cmdline[i])) - argc++; - argv = talloc_array(ctx, char *, argc); - if (!argv) - return "Allocation failure."; - - i = 0; - argc = 1; - argv[1] = strtok(lu_status->cmdline, " \t"); - while (argv[argc]) { - if (!strcmp(argv[argc], "-U")) - i = 1; - argc++; - argv[argc] = strtok(NULL, " \t"); - } - - if (!i) { - argv[argc++] = "-U"; - argv[argc] = NULL; - } - } else { - for (i = 0; i < orig_argc; i++) - if (!strcmp(orig_argv[i], "-U")) - break; - - argc = orig_argc; - argv = talloc_array(ctx, char *, orig_argc + 2); - if (!argv) - return "Allocation failure."; - - memcpy(argv, orig_argv, orig_argc * sizeof(*argv)); - if (i == orig_argc) - argv[argc++] = "-U"; - argv[argc] = NULL; - } - - domain_deinit(); - - return lu_exec(ctx, argc, argv); -} - -static bool do_lu_start(struct delayed_request *req) -{ - time_t now = time(NULL); - const char *ret; - struct buffered_data *saved_in; - struct connection *conn = req->data; - - /* - * Cancellation may have been requested asynchronously. In this - * case, lu_status will be NULL. - */ - if (!lu_status) { - ret = "Cancellation was requested"; - goto out; - } - - assert(lu_status->conn == conn); - - if (!lu_check_lu_allowed()) { - if (now < lu_status->started_at + lu_status->timeout) - return false; - if (!lu_status->force) { - ret = lu_reject_reason(req); - goto out; - } - } - - assert(req->in == lu_status->in); - /* Dump out internal state, including "OK" for live update. */ - ret = lu_dump_state(req->in, conn); - if (!ret) { - /* Perform the activation of new binary. */ - ret = lu_activate_binary(req->in); - } - - /* We will reach this point only in case of failure. */ - out: - /* - * send_reply() will send the response for conn->in. Save the current - * conn->in and restore it afterwards. - */ - saved_in = conn->in; - conn->in = req->in; - send_reply(conn, XS_CONTROL, ret, strlen(ret) + 1); - conn->in = saved_in; - talloc_free(lu_status); - - return true; -} - -static const char *lu_start(const void *ctx, struct connection *conn, - bool force, unsigned int to) -{ - syslog(LOG_INFO, "live-update: start, force=%d, to=%u\n", force, to); - - if (!lu_status || lu_status->conn != conn) - return "Not in live-update session."; - -#ifdef __MINIOS__ - if (lu_status->kernel_size != lu_status->kernel_off) - return "Kernel not complete."; -#endif - - lu_status->force = force; - lu_status->timeout = to; - lu_status->started_at = time(NULL); - lu_status->in = conn->in; - - errno = delay_request(conn, conn->in, do_lu_start, conn, false); - - return NULL; -} - -static int do_control_lu(const void *ctx, struct connection *conn, - char **vec, int num) -{ - const char *ret = NULL; - unsigned int i; - bool force = false; - unsigned int to = 0; - - if (num < 1) - return EINVAL; - - if (!strcmp(vec[0], "-a")) { - if (num == 1) - ret = lu_abort(ctx, conn); - else - return EINVAL; - } else if (!strcmp(vec[0], "-c")) { - if (num == 2) - ret = lu_cmdline(ctx, conn, vec[1]); - else - return EINVAL; - } else if (!strcmp(vec[0], "-s")) { - for (i = 1; i < num; i++) { - if (!strcmp(vec[i], "-F")) - force = true; - else if (!strcmp(vec[i], "-t") && i < num - 1) { - i++; - to = atoi(vec[i]); - } else - return EINVAL; - } - ret = lu_start(ctx, conn, force, to); - if (!ret) - return errno; - } else { - ret = lu_arch(ctx, conn, vec, num); - if (!ret && errno) - return errno; - } - - if (!ret) - ret = "OK"; - send_reply(conn, XS_CONTROL, ret, strlen(ret) + 1); - return 0; -} -#endif - static int do_control_help(const void *, struct connection *, char **, int); static struct cmd_s cmds[] = { diff --git a/tools/xenstore/xenstored_control.h b/tools/xenstore/xenstored_control.h index a8cb76559b..faa955968d 100644 --- a/tools/xenstore/xenstored_control.h +++ b/tools/xenstore/xenstored_control.h @@ -18,11 +18,3 @@ int do_control(const void *ctx, struct connection *conn, struct buffered_data *in); -void lu_read_state(void); - -struct connection *lu_get_connection(void); - -/* Write the "OK" response for the live-update command */ -unsigned int lu_write_response(FILE *fp); - -bool lu_is_pending(void); diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c index 62deee9cb9..31a862b715 100644 --- a/tools/xenstore/xenstored_core.c +++ b/tools/xenstore/xenstored_core.c @@ -52,6 +52,7 @@ #include "xenstored_transaction.h" #include "xenstored_domain.h" #include "xenstored_control.h" +#include "xenstored_lu.h" #include "tdb.h" #ifndef NO_SOCKETS diff --git a/tools/xenstore/xenstored_lu.c b/tools/xenstore/xenstored_lu.c new file mode 100644 index 0000000000..b20d0d37ea --- /dev/null +++ b/tools/xenstore/xenstored_lu.c @@ -0,0 +1,408 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ + +/* + * Live Update interfaces for Xen Store Daemon. + * Copyright (C) 2022 Juergen Gross, SUSE LLC + */ + +#include +#include +#include +#include +#include +#include + +#include "talloc.h" +#include "xenstored_core.h" +#include "xenstored_domain.h" +#include "xenstored_lu.h" +#include "xenstored_watch.h" + +#ifndef NO_LIVE_UPDATE +struct live_update *lu_status; + +static int lu_destroy(void *data) +{ + lu_destroy_arch(data); + lu_status = NULL; + + return 0; +} + +const char *lu_begin(struct connection *conn) +{ + if (lu_status) + return "live-update session already active."; + + lu_status = talloc_zero(conn, struct live_update); + if (!lu_status) + return "Allocation failure."; + lu_status->conn = conn; + talloc_set_destructor(lu_status, lu_destroy); + + return NULL; +} + +struct connection *lu_get_connection(void) +{ + return lu_status ? lu_status->conn : NULL; +} + +unsigned int lu_write_response(FILE *fp) +{ + struct xsd_sockmsg msg; + + assert(lu_status); + + msg = lu_status->in->hdr.msg; + + msg.len = sizeof("OK"); + if (fp && fwrite(&msg, sizeof(msg), 1, fp) != 1) + return 0; + if (fp && fwrite("OK", msg.len, 1, fp) != 1) + return 0; + + return sizeof(msg) + msg.len; +} + +bool lu_is_pending(void) +{ + return lu_status != NULL; +} + +void lu_read_state(void) +{ + struct lu_dump_state state = {}; + struct xs_state_record_header *head; + void *ctx = talloc_new(NULL); /* Work context for subfunctions. */ + struct xs_state_preamble *pre; + + syslog(LOG_INFO, "live-update: read state\n"); + lu_get_dump_state(&state); + if (state.size == 0) + barf_perror("No state found after live-update"); + + pre = state.buf; + if (memcmp(pre->ident, XS_STATE_IDENT, sizeof(pre->ident)) || + pre->version != htobe32(XS_STATE_VERSION) || + pre->flags != XS_STATE_FLAGS) + barf("Unknown record identifier"); + for (head = state.buf + sizeof(*pre); + head->type != XS_STATE_TYPE_END && + (void *)head - state.buf < state.size; + head = (void *)head + sizeof(*head) + head->length) { + switch (head->type) { + case XS_STATE_TYPE_GLOBAL: + read_state_global(ctx, head + 1); + break; + case XS_STATE_TYPE_CONN: + read_state_connection(ctx, head + 1); + break; + case XS_STATE_TYPE_WATCH: + read_state_watch(ctx, head + 1); + break; + case XS_STATE_TYPE_TA: + xprintf("live-update: ignore transaction record\n"); + break; + case XS_STATE_TYPE_NODE: + read_state_node(ctx, head + 1); + break; + default: + xprintf("live-update: unknown state record %08x\n", + head->type); + break; + } + } + + lu_close_dump_state(&state); + + talloc_free(ctx); + + /* + * We may have missed the VIRQ_DOM_EXC notification and a domain may + * have died while we were live-updating. So check all the domains are + * still alive. + */ + check_domains(); +} + +static const char *lu_abort(const void *ctx, struct connection *conn) +{ + syslog(LOG_INFO, "live-update: abort\n"); + + if (!lu_status) + return "No live-update session active."; + + /* Destructor will do the real abort handling. */ + talloc_free(lu_status); + + return NULL; +} + +static const char *lu_cmdline(const void *ctx, struct connection *conn, + const char *cmdline) +{ + syslog(LOG_INFO, "live-update: cmdline %s\n", cmdline); + + if (!lu_status || lu_status->conn != conn) + return "Not in live-update session."; + + lu_status->cmdline = talloc_strdup(lu_status, cmdline); + if (!lu_status->cmdline) + return "Allocation failure."; + + return NULL; +} + +static bool lu_check_lu_allowed(void) +{ + struct connection *conn; + time_t now = time(NULL); + unsigned int ta_total = 0, ta_long = 0; + + list_for_each_entry(conn, &connections, list) { + if (conn->ta_start_time) { + ta_total++; + if (now - conn->ta_start_time >= lu_status->timeout) + ta_long++; + } + } + + /* + * Allow LiveUpdate if one of the following conditions is met: + * - There is no active transactions + * - All transactions are long running (e.g. they have been + * active for more than lu_status->timeout sec) and the admin as + * requested to force the operation. + */ + return ta_total ? (lu_status->force && ta_long == ta_total) : true; +} + +static const char *lu_reject_reason(const void *ctx) +{ + char *ret = NULL; + struct connection *conn; + time_t now = time(NULL); + + list_for_each_entry(conn, &connections, list) { + unsigned long tdiff = now - conn->ta_start_time; + + if (conn->ta_start_time && (tdiff >= lu_status->timeout)) { + ret = talloc_asprintf(ctx, "%s\nDomain %u: %ld s", + ret ? : "Domains with long running transactions:", + conn->id, tdiff); + } + } + + return ret ? (const char *)ret : "Overlapping transactions"; +} + +static const char *lu_dump_state(const void *ctx, struct connection *conn) +{ + FILE *fp; + const char *ret; + struct xs_state_record_header end; + struct xs_state_preamble pre; + + fp = lu_dump_open(ctx); + if (!fp) + return "Dump state open error"; + + memcpy(pre.ident, XS_STATE_IDENT, sizeof(pre.ident)); + pre.version = htobe32(XS_STATE_VERSION); + pre.flags = XS_STATE_FLAGS; + if (fwrite(&pre, sizeof(pre), 1, fp) != 1) { + ret = "Dump write error"; + goto out; + } + + ret = dump_state_global(fp); + if (ret) + goto out; + ret = dump_state_connections(fp); + if (ret) + goto out; + ret = dump_state_nodes(fp, ctx); + if (ret) + goto out; + + end.type = XS_STATE_TYPE_END; + end.length = 0; + if (fwrite(&end, sizeof(end), 1, fp) != 1) + ret = "Dump write error"; + + out: + lu_dump_close(fp); + + return ret; +} + +static const char *lu_activate_binary(const void *ctx) +{ + int argc; + char **argv; + unsigned int i; + + if (lu_status->cmdline) { + argc = 4; /* At least one arg + progname + "-U" + NULL. */ + for (i = 0; lu_status->cmdline[i]; i++) + if (isspace(lu_status->cmdline[i])) + argc++; + argv = talloc_array(ctx, char *, argc); + if (!argv) + return "Allocation failure."; + + i = 0; + argc = 1; + argv[1] = strtok(lu_status->cmdline, " \t"); + while (argv[argc]) { + if (!strcmp(argv[argc], "-U")) + i = 1; + argc++; + argv[argc] = strtok(NULL, " \t"); + } + + if (!i) { + argv[argc++] = "-U"; + argv[argc] = NULL; + } + } else { + for (i = 0; i < orig_argc; i++) + if (!strcmp(orig_argv[i], "-U")) + break; + + argc = orig_argc; + argv = talloc_array(ctx, char *, orig_argc + 2); + if (!argv) + return "Allocation failure."; + + memcpy(argv, orig_argv, orig_argc * sizeof(*argv)); + if (i == orig_argc) + argv[argc++] = "-U"; + argv[argc] = NULL; + } + + domain_deinit(); + + return lu_exec(ctx, argc, argv); +} + +static bool do_lu_start(struct delayed_request *req) +{ + time_t now = time(NULL); + const char *ret; + struct buffered_data *saved_in; + struct connection *conn = req->data; + + /* + * Cancellation may have been requested asynchronously. In this + * case, lu_status will be NULL. + */ + if (!lu_status) { + ret = "Cancellation was requested"; + goto out; + } + + assert(lu_status->conn == conn); + + if (!lu_check_lu_allowed()) { + if (now < lu_status->started_at + lu_status->timeout) + return false; + if (!lu_status->force) { + ret = lu_reject_reason(req); + goto out; + } + } + + assert(req->in == lu_status->in); + /* Dump out internal state, including "OK" for live update. */ + ret = lu_dump_state(req->in, conn); + if (!ret) { + /* Perform the activation of new binary. */ + ret = lu_activate_binary(req->in); + } + + /* We will reach this point only in case of failure. */ + out: + /* + * send_reply() will send the response for conn->in. Save the current + * conn->in and restore it afterwards. + */ + saved_in = conn->in; + conn->in = req->in; + send_reply(conn, XS_CONTROL, ret, strlen(ret) + 1); + conn->in = saved_in; + talloc_free(lu_status); + + return true; +} + +static const char *lu_start(const void *ctx, struct connection *conn, + bool force, unsigned int to) +{ + syslog(LOG_INFO, "live-update: start, force=%d, to=%u\n", force, to); + + if (!lu_status || lu_status->conn != conn) + return "Not in live-update session."; + +#ifdef __MINIOS__ + if (lu_status->kernel_size != lu_status->kernel_off) + return "Kernel not complete."; +#endif + + lu_status->force = force; + lu_status->timeout = to; + lu_status->started_at = time(NULL); + lu_status->in = conn->in; + + errno = delay_request(conn, conn->in, do_lu_start, conn, false); + + return NULL; +} + +int do_control_lu(const void *ctx, struct connection *conn, char **vec, + int num) +{ + const char *ret = NULL; + unsigned int i; + bool force = false; + unsigned int to = 0; + + if (num < 1) + return EINVAL; + + if (!strcmp(vec[0], "-a")) { + if (num == 1) + ret = lu_abort(ctx, conn); + else + return EINVAL; + } else if (!strcmp(vec[0], "-c")) { + if (num == 2) + ret = lu_cmdline(ctx, conn, vec[1]); + else + return EINVAL; + } else if (!strcmp(vec[0], "-s")) { + for (i = 1; i < num; i++) { + if (!strcmp(vec[i], "-F")) + force = true; + else if (!strcmp(vec[i], "-t") && i < num - 1) { + i++; + to = atoi(vec[i]); + } else + return EINVAL; + } + ret = lu_start(ctx, conn, force, to); + if (!ret) + return errno; + } else { + ret = lu_arch(ctx, conn, vec, num); + if (!ret && errno) + return errno; + } + + if (!ret) + ret = "OK"; + send_reply(conn, XS_CONTROL, ret, strlen(ret) + 1); + return 0; +} +#endif diff --git a/tools/xenstore/xenstored_lu.h b/tools/xenstore/xenstored_lu.h index 1c09b9b639..d633a765a3 100644 --- a/tools/xenstore/xenstored_lu.h +++ b/tools/xenstore/xenstored_lu.h @@ -43,6 +43,16 @@ struct lu_dump_state { extern struct live_update *lu_status; +struct connection *lu_get_connection(void); +bool lu_is_pending(void); +void lu_read_state(void); + +/* Write the "OK" response for the live-update command */ +unsigned int lu_write_response(FILE *fp); + +int do_control_lu(const void *ctx, struct connection *conn, char **vec, + int num); + /* Live update private interfaces. */ void lu_get_dump_state(struct lu_dump_state *state); void lu_close_dump_state(struct lu_dump_state *state); @@ -53,4 +63,19 @@ const char *lu_arch(const void *ctx, struct connection *conn, char **vec, int num); const char *lu_begin(struct connection *conn); void lu_destroy_arch(void *data); +#else +static inline struct connection *lu_get_connection(void) +{ + return NULL; +} + +static inline unsigned int lu_write_response(FILE *fp) +{ + return 0; +} + +static inline bool lu_is_pending(void) +{ + return false; +} #endif From patchwork Tue Jun 27 12:27:50 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?b?SsO8cmdlbiBHcm/Dnw==?= X-Patchwork-Id: 13294421 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id C1A05EB64D9 for ; Tue, 27 Jun 2023 12:28:47 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.556125.868417 (Exim 4.92) (envelope-from ) id 1qE7o1-0002Sl-6H; Tue, 27 Jun 2023 12:28:25 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 556125.868417; Tue, 27 Jun 2023 12:28:25 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qE7o1-0002SX-2v; Tue, 27 Jun 2023 12:28:25 +0000 Received: by outflank-mailman (input) for mailman id 556125; Tue, 27 Jun 2023 12:28:23 +0000 Received: from se1-gles-flk1-in.inumbo.com ([94.247.172.50] helo=se1-gles-flk1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qE7nz-0000v0-LY for xen-devel@lists.xenproject.org; Tue, 27 Jun 2023 12:28:23 +0000 Received: from smtp-out1.suse.de (smtp-out1.suse.de [2001:67c:2178:6::1c]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id 1a80c782-14e6-11ee-8611-37d641c3527e; Tue, 27 Jun 2023 14:28:21 +0200 (CEST) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out1.suse.de (Postfix) with ESMTPS id 6D8EE218A4; Tue, 27 Jun 2023 12:28:21 +0000 (UTC) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id 35CEF13462; Tue, 27 Jun 2023 12:28:21 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id 39t/C+XVmmR1SAAAMHmgww (envelope-from ); Tue, 27 Jun 2023 12:28:21 +0000 X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 1a80c782-14e6-11ee-8611-37d641c3527e DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=susede1; t=1687868901; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=e+AL7E5KGOqOlaCDidWTO0QIZcUe7+XVvrp9pgAXvoM=; b=BFwqQtf0BAyRSjltwM8CyjuFCUtkGt++g9NhlznjMqA71ucns9m2yBP9R1i7VbM0WLoISc cOLOPAp/r3x7JcvTnSEgJjzQh/v+Lf9kYI9RD7+DKGhsOJjVGo8Zp/AoR/WT/hL/Z6ZnzO H6SdL0G9jzZitf8HOzp99ZGBeyZa0Ng= From: Juergen Gross To: xen-devel@lists.xenproject.org Cc: Juergen Gross , Wei Liu , Julien Grall , Anthony PERARD , Julien Grall Subject: [PATCH v4 5/5] tools/xenstore: remove unused stuff from list.h Date: Tue, 27 Jun 2023 14:27:50 +0200 Message-Id: <20230627122750.2007-6-jgross@suse.com> X-Mailer: git-send-email 2.35.3 In-Reply-To: <20230627122750.2007-1-jgross@suse.com> References: <20230627122750.2007-1-jgross@suse.com> MIME-Version: 1.0 Remove the hlist defines/functions and the rcu related functions from tools/xenstore/list.h, as they are not used. Signed-off-by: Juergen Gross Acked-by: Julien Grall --- tools/xenstore/list.h | 227 ------------------------------------------ 1 file changed, 227 deletions(-) diff --git a/tools/xenstore/list.h b/tools/xenstore/list.h index a464a38b61..d722a91220 100644 --- a/tools/xenstore/list.h +++ b/tools/xenstore/list.h @@ -88,48 +88,6 @@ static inline void list_add_tail(struct list_head *new, struct list_head *head) __list_add(new, head->prev, head); } -/* - * Insert a new entry between two known consecutive entries. - * - * This is only for internal list manipulation where we know - * the prev/next entries already! - */ -static __inline__ void __list_add_rcu(struct list_head * new, - struct list_head * prev, - struct list_head * next) -{ - new->next = next; - new->prev = prev; - next->prev = new; - prev->next = new; -} - -/** - * list_add_rcu - add a new entry to rcu-protected list - * @new: new entry to be added - * @head: list head to add it after - * - * Insert a new entry after the specified head. - * This is good for implementing stacks. - */ -static __inline__ void list_add_rcu(struct list_head *new, struct list_head *head) -{ - __list_add_rcu(new, head, head->next); -} - -/** - * list_add_tail_rcu - add a new entry to rcu-protected list - * @new: new entry to be added - * @head: list head to add it before - * - * Insert a new entry before the specified head. - * This is useful for implementing queues. - */ -static __inline__ void list_add_tail_rcu(struct list_head *new, struct list_head *head) -{ - __list_add_rcu(new, head->prev, head); -} - /* * Delete a list entry by making the prev/next entries * point to each other. @@ -156,23 +114,6 @@ static inline void list_del(struct list_head *entry) entry->prev = LIST_POISON2; } -/** - * list_del_rcu - deletes entry from list without re-initialization - * @entry: the element to delete from the list. - * - * Note: list_empty on entry does not return true after this, - * the entry is in an undefined state. It is useful for RCU based - * lockfree traversal. - * - * In particular, it means that we can not poison the forward - * pointers that may still be used for walking the list. - */ -static inline void list_del_rcu(struct list_head *entry) -{ - __list_del(entry->prev, entry->next); - entry->prev = LIST_POISON2; -} - /** * list_del_init - deletes entry from list and reinitialize it. * @entry: the element to delete from the list. @@ -339,172 +280,4 @@ static inline void list_splice_init(struct list_head *list, &pos->member != (head); \ pos = n, n = list_entry(n->member.next, typeof(*n), member)) - -/* - * Double linked lists with a single pointer list head. - * Mostly useful for hash tables where the two pointer list head is - * too wasteful. - * You lose the ability to access the tail in O(1). - */ - -struct hlist_head { - struct hlist_node *first; -}; - -struct hlist_node { - struct hlist_node *next, **pprev; -}; - -#define HLIST_HEAD_INIT { .first = NULL } -#define HLIST_HEAD(name) struct hlist_head name = { .first = NULL } -#define INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL) -#define INIT_HLIST_NODE(ptr) ((ptr)->next = NULL, (ptr)->pprev = NULL) - -static __inline__ int hlist_unhashed(struct hlist_node *h) -{ - return !h->pprev; -} - -static __inline__ int hlist_empty(struct hlist_head *h) -{ - return !h->first; -} - -static __inline__ void __hlist_del(struct hlist_node *n) -{ - struct hlist_node *next = n->next; - struct hlist_node **pprev = n->pprev; - *pprev = next; - if (next) - next->pprev = pprev; -} - -static __inline__ void hlist_del(struct hlist_node *n) -{ - __hlist_del(n); - n->next = LIST_POISON1; - n->pprev = LIST_POISON2; -} - -/** - * hlist_del_rcu - deletes entry from hash list without re-initialization - * @entry: the element to delete from the hash list. - * - * Note: list_unhashed() on entry does not return true after this, - * the entry is in an undefined state. It is useful for RCU based - * lockfree traversal. - * - * In particular, it means that we can not poison the forward - * pointers that may still be used for walking the hash list. - */ -static inline void hlist_del_rcu(struct hlist_node *n) -{ - __hlist_del(n); - n->pprev = LIST_POISON2; -} - -static __inline__ void hlist_del_init(struct hlist_node *n) -{ - if (n->pprev) { - __hlist_del(n); - INIT_HLIST_NODE(n); - } -} - -#define hlist_del_rcu_init hlist_del_init - -static __inline__ void hlist_add_head(struct hlist_node *n, struct hlist_head *h) -{ - struct hlist_node *first = h->first; - n->next = first; - if (first) - first->pprev = &n->next; - h->first = n; - n->pprev = &h->first; -} - -static __inline__ void hlist_add_head_rcu(struct hlist_node *n, struct hlist_head *h) -{ - struct hlist_node *first = h->first; - n->next = first; - n->pprev = &h->first; - if (first) - first->pprev = &n->next; - h->first = n; -} - -/* next must be != NULL */ -static __inline__ void hlist_add_before(struct hlist_node *n, struct hlist_node *next) -{ - n->pprev = next->pprev; - n->next = next; - next->pprev = &n->next; - *(n->pprev) = n; -} - -static __inline__ void hlist_add_after(struct hlist_node *n, - struct hlist_node *next) -{ - next->next = n->next; - *(next->pprev) = n; - n->next = next; -} - -#define hlist_entry(ptr, type, member) container_of(ptr,type,member) - -/* Cannot easily do prefetch unfortunately */ -#define hlist_for_each(pos, head) \ - for (pos = (head)->first; pos; pos = pos->next) - -#define hlist_for_each_safe(pos, n, head) \ - for (pos = (head)->first; n = pos ? pos->next : 0, pos; \ - pos = n) - -/** - * hlist_for_each_entry - iterate over list of given type - * @tpos: the type * to use as a loop counter. - * @pos: the &struct hlist_node to use as a loop counter. - * @head: the head for your list. - * @member: the name of the hlist_node within the struct. - */ -#define hlist_for_each_entry(tpos, pos, head, member) \ - for (pos = (head)->first; \ - pos && ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \ - pos = pos->next) - -/** - * hlist_for_each_entry_continue - iterate over a hlist continuing after existing point - * @tpos: the type * to use as a loop counter. - * @pos: the &struct hlist_node to use as a loop counter. - * @member: the name of the hlist_node within the struct. - */ -#define hlist_for_each_entry_continue(tpos, pos, member) \ - for (pos = (pos)->next; \ - pos && ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \ - pos = pos->next) - -/** - * hlist_for_each_entry_from - iterate over a hlist continuing from existing point - * @tpos: the type * to use as a loop counter. - * @pos: the &struct hlist_node to use as a loop counter. - * @member: the name of the hlist_node within the struct. - */ -#define hlist_for_each_entry_from(tpos, pos, member) \ - for (; pos && ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \ - pos = pos->next) - -/** - * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry - * @tpos: the type * to use as a loop counter. - * @pos: the &struct hlist_node to use as a loop counter. - * @n: another &struct hlist_node to use as temporary storage - * @head: the head for your list. - * @member: the name of the hlist_node within the struct. - */ -#define hlist_for_each_entry_safe(tpos, pos, n, head, member) \ - for (pos = (head)->first; \ - pos && ({ n = pos->next; 1; }) && \ - ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \ - pos = n) - #endif