[Libguestfs] [PATCH nbdkit v2 2/4] Rename nbdkit-reflection-plugin to nbdkit-info-plugin.
Richard W.M. Jones
rjones at redhat.com
Sat Sep 28 20:02:42 UTC 2019
See commit 2a29634aa0589037b5625032097a3a2f7b1d5c7d and
https://www.redhat.com/archives/libguestfs/2019-September/msg00366.html
---
configure.ac | 4 +-
plugins/data/nbdkit-data-plugin.pod | 2 +-
plugins/{reflection => info}/Makefile.am | 20 ++++-----
.../{reflection/reflection.c => info/info.c} | 42 +++++++++----------
.../nbdkit-info-plugin.pod} | 38 ++++++++---------
plugins/memory/nbdkit-memory-plugin.pod | 2 +-
tests/Makefile.am | 20 ++++-----
...ection-address.sh => test-info-address.sh} | 8 ++--
...flection-base64.sh => test-info-base64.sh} | 10 ++---
...est-reflection-raw.sh => test-info-raw.sh} | 6 +--
10 files changed, 76 insertions(+), 76 deletions(-)
diff --git a/configure.ac b/configure.ac
index 8e38b2d..a6387d5 100644
--- a/configure.ac
+++ b/configure.ac
@@ -837,6 +837,7 @@ non_lang_plugins="\
full \
guestfs \
gzip \
+ info \
iso \
libvirt \
linuxdisk \
@@ -846,7 +847,6 @@ non_lang_plugins="\
partitioning \
pattern \
random \
- reflection \
split \
ssh \
streaming \
@@ -913,6 +913,7 @@ AC_CONFIG_FILES([Makefile
plugins/full/Makefile
plugins/guestfs/Makefile
plugins/gzip/Makefile
+ plugins/info/Makefile
plugins/iso/Makefile
plugins/libvirt/Makefile
plugins/linuxdisk/Makefile
@@ -926,7 +927,6 @@ AC_CONFIG_FILES([Makefile
plugins/perl/Makefile
plugins/python/Makefile
plugins/random/Makefile
- plugins/reflection/Makefile
plugins/ruby/Makefile
plugins/rust/Cargo.toml
plugins/rust/Makefile
diff --git a/plugins/data/nbdkit-data-plugin.pod b/plugins/data/nbdkit-data-plugin.pod
index 6686c2d..a5ee299 100644
--- a/plugins/data/nbdkit-data-plugin.pod
+++ b/plugins/data/nbdkit-data-plugin.pod
@@ -247,12 +247,12 @@ Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
L<nbdkit(1)>,
L<nbdkit-captive(1)>,
L<nbdkit-plugin(3)>,
+L<nbdkit-info-plugin(1)>,
L<nbdkit-memory-plugin(1)>,
L<nbdkit-null-plugin(1)>,
L<nbdkit-partitioning-plugin(1)>,
L<nbdkit-pattern-plugin(1)>,
L<nbdkit-random-plugin(1)>,
-L<nbdkit-reflection-plugin(1)>,
L<nbdkit-zero-plugin(1)>,
L<https://github.com/libguestfs/nbdkit/blob/master/plugins/data/disk2data.pl>,
L<https://en.wikipedia.org/wiki/Base64>.
diff --git a/plugins/reflection/Makefile.am b/plugins/info/Makefile.am
similarity index 81%
rename from plugins/reflection/Makefile.am
rename to plugins/info/Makefile.am
index 40aa786..675533a 100644
--- a/plugins/reflection/Makefile.am
+++ b/plugins/info/Makefile.am
@@ -31,32 +31,32 @@
include $(top_srcdir)/common-rules.mk
-EXTRA_DIST = nbdkit-reflection-plugin.pod
+EXTRA_DIST = nbdkit-info-plugin.pod
-plugin_LTLIBRARIES = nbdkit-reflection-plugin.la
+plugin_LTLIBRARIES = nbdkit-info-plugin.la
-nbdkit_reflection_plugin_la_SOURCES = \
- reflection.c \
+nbdkit_info_plugin_la_SOURCES = \
+ info.c \
$(top_srcdir)/include/nbdkit-plugin.h \
$(NULL)
-nbdkit_reflection_plugin_la_CPPFLAGS = \
+nbdkit_info_plugin_la_CPPFLAGS = \
-I$(top_srcdir)/include \
$(NULL)
-nbdkit_reflection_plugin_la_CFLAGS = $(WARNINGS_CFLAGS)
-nbdkit_reflection_plugin_la_LDFLAGS = \
+nbdkit_info_plugin_la_CFLAGS = $(WARNINGS_CFLAGS)
+nbdkit_info_plugin_la_LDFLAGS = \
-module -avoid-version -shared \
-Wl,--version-script=$(top_srcdir)/plugins/plugins.syms \
$(NULL)
-nbdkit_reflection_plugin_la_LIBADD = \
+nbdkit_info_plugin_la_LIBADD = \
$(NULL)
if HAVE_POD
-man_MANS = nbdkit-reflection-plugin.1
+man_MANS = nbdkit-info-plugin.1
CLEANFILES += $(man_MANS)
-nbdkit-reflection-plugin.1: nbdkit-reflection-plugin.pod
+nbdkit-info-plugin.1: nbdkit-info-plugin.pod
$(PODWRAPPER) --section=1 --man $@ \
--html $(top_builddir)/html/$@.html \
$<
diff --git a/plugins/reflection/reflection.c b/plugins/info/info.c
similarity index 91%
rename from plugins/reflection/reflection.c
rename to plugins/info/info.c
index 6fd1962..4807287 100644
--- a/plugins/reflection/reflection.c
+++ b/plugins/info/info.c
@@ -57,7 +57,7 @@ enum mode {
static enum mode mode = MODE_EXPORTNAME;
static int
-reflection_config (const char *key, const char *value)
+info_config (const char *key, const char *value)
{
if (strcmp (key, "mode") == 0) {
if (strcasecmp (value, "exportname") == 0 ||
@@ -89,15 +89,15 @@ reflection_config (const char *key, const char *value)
return 0;
}
-#define reflection_config_help \
+#define info_config_help \
"mode=exportname|base64exportname|address Plugin mode (default exportname)."
/* Provide a way to detect if the base64 feature is supported. */
static void
-reflection_dump_plugin (void)
+info_dump_plugin (void)
{
#ifdef HAVE_BASE64
- printf ("reflection_base64=yes\n");
+ printf ("info_base64=yes\n");
#endif
}
@@ -228,7 +228,7 @@ handle_address (struct sockaddr *sa, socklen_t addrlen,
* - Leaking host information (eg. paths).
*/
static void *
-reflection_open (int readonly)
+info_open (int readonly)
{
const char *export_name;
size_t export_name_len;
@@ -286,7 +286,7 @@ reflection_open (int readonly)
/* Close the per-connection handle. */
static void
-reflection_close (void *handle)
+info_close (void *handle)
{
struct handle *h = handle;
@@ -298,7 +298,7 @@ reflection_close (void *handle)
/* Get the disk size. */
static int64_t
-reflection_get_size (void *handle)
+info_get_size (void *handle)
{
struct handle *h = handle;
@@ -306,7 +306,7 @@ reflection_get_size (void *handle)
}
static int
-reflection_can_multi_conn (void *handle)
+info_can_multi_conn (void *handle)
{
switch (mode) {
/* Safe for exportname modes since clients should only request
@@ -329,7 +329,7 @@ reflection_can_multi_conn (void *handle)
/* Cache. */
static int
-reflection_can_cache (void *handle)
+info_can_cache (void *handle)
{
/* Everything is already in memory, returning this without
* implementing .cache lets nbdkit do the correct no-op.
@@ -339,8 +339,8 @@ reflection_can_cache (void *handle)
/* Read data. */
static int
-reflection_pread (void *handle, void *buf, uint32_t count, uint64_t offset,
- uint32_t flags)
+info_pread (void *handle, void *buf, uint32_t count, uint64_t offset,
+ uint32_t flags)
{
struct handle *h = handle;
@@ -349,18 +349,18 @@ reflection_pread (void *handle, void *buf, uint32_t count, uint64_t offset,
}
static struct nbdkit_plugin plugin = {
- .name = "reflection",
+ .name = "info",
.version = PACKAGE_VERSION,
- .config = reflection_config,
- .config_help = reflection_config_help,
- .dump_plugin = reflection_dump_plugin,
+ .config = info_config,
+ .config_help = info_config_help,
+ .dump_plugin = info_dump_plugin,
.magic_config_key = "mode",
- .open = reflection_open,
- .close = reflection_close,
- .get_size = reflection_get_size,
- .can_multi_conn = reflection_can_multi_conn,
- .can_cache = reflection_can_cache,
- .pread = reflection_pread,
+ .open = info_open,
+ .close = info_close,
+ .get_size = info_get_size,
+ .can_multi_conn = info_can_multi_conn,
+ .can_cache = info_can_cache,
+ .pread = info_pread,
/* In this plugin, errno is preserved properly along error return
* paths from failed system calls.
*/
diff --git a/plugins/reflection/nbdkit-reflection-plugin.pod b/plugins/info/nbdkit-info-plugin.pod
similarity index 72%
rename from plugins/reflection/nbdkit-reflection-plugin.pod
rename to plugins/info/nbdkit-info-plugin.pod
index f971cef..3edfa73 100644
--- a/plugins/reflection/nbdkit-reflection-plugin.pod
+++ b/plugins/info/nbdkit-info-plugin.pod
@@ -1,15 +1,15 @@
=head1 NAME
-nbdkit-reflection-plugin - reflect client info back to the client
+nbdkit-info-plugin - serve client and server information
=head1 SYNOPSIS
- nbdkit reflection [mode=]exportname|base64exportname|address
+ nbdkit info [mode=]exportname|base64exportname|address
=head1 DESCRIPTION
-C<nbdkit-reflection-plugin> is a test plugin which reflects
-information sent by the client back to the client.
+C<nbdkit-info-plugin> is a test plugin which serves information about
+the client and server in a disk image back to the client.
In its default mode (C<mode=exportname>) it converts the export name
passed from the client into a disk image. C<mode=base64exportname> is
@@ -27,11 +27,11 @@ add L<nbdkit-cow-filter(1)> on top.
=head1 EXAMPLES
-Create a reflection disk. By setting the export name to C<"hello">
+Create a “reflection disk”. By setting the export name to C<"hello">
when we open it, a virtual disk of only 5 bytes containing these
characters is created. We then display the contents:
- $ nbdkit --exit-with-parent reflection mode=exportname &
+ $ nbdkit --exit-with-parent info mode=exportname &
$ nbdsh -u 'nbd://localhost/hello' -c - <<'EOF'
size = h.get_size()
print("size = %d" % size)
@@ -42,10 +42,10 @@ characters is created. We then display the contents:
size = 5
buf = b"hello"
-By running a reflection plugin, you can pass whole bootable VMs on the
+By running the info plugin, you can pass whole bootable VMs on the
qemu command line:
- $ nbdkit reflection mode=base64exportname
+ $ nbdkit info mode=base64exportname
$ qemu-system-x86_64 \
-drive 'snapshot=on,file.driver=nbd,file.host=localhost,file.port=10809,file.export=
tACwA80QtBOzCrABuRwAtgCyAL0ZfM0Q9CoqKiBIZWxsbyBmcm9tIG5iZGtp
@@ -62,10 +62,10 @@ qemu command line:
AAAAAAAAAAAAAAAAAAAAVao=
'
-Another use for the reflection plugin is to send back the client's IP
+Another use for the info plugin is to send back the client's IP
address:
- $ nbdkit reflection mode=address
+ $ nbdkit info mode=address
$ nbdsh -u 'nbd://localhost' -c 'print(h.pread(h.get_size(), 0))'
which will print something like:
@@ -78,28 +78,28 @@ which will print something like:
=item [B<mode=>]B<address>
-Reflect the client's IP address and client port number as a string in
-the usual format. For Unix sockets this sets the disk to the string
+Send the client's IP address and client port number as a string in the
+usual format. For Unix sockets this sets the disk to the string
C<"unix"> to avoid leaking host paths.
=item [B<mode=>]B<base64exportname>
-Reflect the export name passed by the client, assuming the client
-string is base64 encoded.
+Send the export name passed by the client, assuming the client string
+is base64 encoded.
This mode is only supported if nbdkit was compiled with GnuTLS E<ge>
3.6.0. You can find out by checking if:
- $ nbdkit reflection --dump-plugin
+ $ nbdkit info --dump-plugin
contains:
- reflection_base64=yes
+ info_base64=yes
=item [B<mode=>]B<exportname>
-Reflect the raw export name passed by the client. Note the export
-name cannot contain ASCII NUL characters.
+Send the raw export name passed by the client. Note the export name
+cannot contain ASCII NUL characters.
This is the default mode.
@@ -112,7 +112,7 @@ See L<nbdkit(1)/Magic parameters>.
=over 4
-=item F<$plugindir/nbdkit-reflection-plugin.so>
+=item F<$plugindir/nbdkit-info-plugin.so>
The plugin.
diff --git a/plugins/memory/nbdkit-memory-plugin.pod b/plugins/memory/nbdkit-memory-plugin.pod
index 94e5da1..31c8649 100644
--- a/plugins/memory/nbdkit-memory-plugin.pod
+++ b/plugins/memory/nbdkit-memory-plugin.pod
@@ -99,7 +99,7 @@ L<nbdkit-plugin(3)>,
L<nbdkit-loop(1)>,
L<nbdkit-data-plugin(1)>,
L<nbdkit-file-plugin(1)>,
-L<nbdkit-reflection-plugin(1)>.
+L<nbdkit-info-plugin(1)>.
=head1 AUTHORS
diff --git a/tests/Makefile.am b/tests/Makefile.am
index 7d254be..5a65db7 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -73,6 +73,9 @@ EXTRA_DIST = \
test-full.sh \
test-help.sh \
test-help-plugin.sh \
+ test-info-address.sh \
+ test-info-base64.sh \
+ test-info-raw.sh \
test-ip.sh \
test-iso.sh \
test-layers.sh \
@@ -112,9 +115,6 @@ EXTRA_DIST = \
test-rate-dynamic.sh \
test.rb \
test-readahead-copy.sh \
- test-reflection-address.sh \
- test-reflection-base64.sh \
- test-reflection-raw.sh \
test-retry.sh \
test-retry-reopen-fail.sh \
test-shutdown.sh \
@@ -537,6 +537,13 @@ disk.gz: disk
endif HAVE_GUESTFISH
endif HAVE_ZLIB
+# info plugin test.
+TESTS += \
+ test-info-address.sh \
+ test-info-base64.sh \
+ test-info-raw.sh \
+ $(NULL)
+
# iso plugin test.
if HAVE_ISO
if HAVE_GUESTFISH
@@ -611,13 +618,6 @@ test_random_CPPFLAGS = -I $(top_srcdir)/common/include
test_random_CFLAGS = $(WARNINGS_CFLAGS) $(LIBGUESTFS_CFLAGS)
test_random_LDADD = libtest.la $(LIBGUESTFS_LIBS)
-# reflection plugin test.
-TESTS += \
- test-reflection-address.sh \
- test-reflection-base64.sh \
- test-reflection-raw.sh \
- $(NULL)
-
# split files plugin test.
check_DATA += split1 split2 split3
CLEANFILES += split1 split2 split3
diff --git a/tests/test-reflection-address.sh b/tests/test-info-address.sh
similarity index 90%
rename from tests/test-reflection-address.sh
rename to tests/test-info-address.sh
index e4289a7..929dffe 100755
--- a/tests/test-reflection-address.sh
+++ b/tests/test-info-address.sh
@@ -30,7 +30,7 @@
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
-# Test the reflection plugin with mode=address.
+# Test the info plugin with mode=address.
source ./functions.sh
set -e
@@ -39,13 +39,13 @@ set -x
requires nbdsh --version
sock=`mktemp -u`
-files="reflection-address.out reflection-address.pid $sock"
+files="info-address.out info-address.pid $sock"
rm -f $files
cleanup_fn rm -f $files
# Run nbdkit.
-start_nbdkit -P reflection-address.pid -U $sock \
- reflection mode=address
+start_nbdkit -P info-address.pid -U $sock \
+ info mode=address
export sock
nbdsh -c - <<'EOF'
diff --git a/tests/test-reflection-base64.sh b/tests/test-info-base64.sh
similarity index 90%
rename from tests/test-reflection-base64.sh
rename to tests/test-info-base64.sh
index 9196deb..542fe90 100755
--- a/tests/test-reflection-base64.sh
+++ b/tests/test-info-base64.sh
@@ -30,7 +30,7 @@
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
-# Test the reflection plugin with base64-encoded export name.
+# Test the info plugin with base64-encoded export name.
source ./functions.sh
set -e
@@ -39,19 +39,19 @@ set -x
requires nbdsh -c 'import base64'
# Test if mode=base64exportname is supported in this build.
-if ! nbdkit reflection --dump-plugin | grep -sq "reflection_base64=yes"; then
+if ! nbdkit info --dump-plugin | grep -sq "info_base64=yes"; then
echo "$0: mode=base64exportname is not supported in this build"
exit 77
fi
sock=`mktemp -u`
-files="reflection-base64.out reflection-base64.pid $sock"
+files="info-base64.out info-base64.pid $sock"
rm -f $files
cleanup_fn rm -f $files
# Run nbdkit.
-start_nbdkit -P reflection-base64.pid -U $sock \
- reflection mode=base64exportname
+start_nbdkit -P info-base64.pid -U $sock \
+ info mode=base64exportname
export e sock
for e in "" "test" "/" "//" " " "/ " "?" "テスト" "-n" '\\' $'\n' "%%" \
diff --git a/tests/test-reflection-raw.sh b/tests/test-info-raw.sh
similarity index 93%
rename from tests/test-reflection-raw.sh
rename to tests/test-info-raw.sh
index dfbcd29..f937d9f 100755
--- a/tests/test-reflection-raw.sh
+++ b/tests/test-info-raw.sh
@@ -30,7 +30,7 @@
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
-# Test the reflection plugin with raw export name.
+# Test the info plugin with raw export name.
source ./functions.sh
set -e
@@ -39,12 +39,12 @@ set -x
requires nbdsh --version
sock=`mktemp -u`
-files="reflection-raw.out reflection-raw.pid $sock"
+files="info-raw.out info-raw.pid $sock"
rm -f $files
cleanup_fn rm -f $files
# Run nbdkit.
-start_nbdkit -P reflection-raw.pid -U $sock reflection
+start_nbdkit -P info-raw.pid -U $sock info
for e in "" "test" "/" "//" " " "/ " "?" "テスト" "-n" '\\' $'\n' "%%" \
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
--
2.23.0
More information about the Libguestfs
mailing list