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 */