[PATCH v4 0/3] qemu-sockets: add abstract UNIX domain socket support

[PATCH v4 0/3] qemu-sockets: add abstract UNIX domain socket support

[xiaoqiang zhao]

qemu does not support abstract UNIX domain
socket address. Add this ability to make qemu handy
when abstract address is needed.

Changes since v3: 
* rebase on master
* refine qapi document statement
* use random names to avoid name clash in unit test

Xiaoqiang Zhao (3):
  qemu-sockets: add abstract UNIX domain socket support
  tests/util-sockets: add abstract unix socket cases
  qemu-options: updates for abstract unix sockets

 chardev/char-socket.c     |  4 ++
 chardev/char.c            |  7 +++
 qapi/sockets.json         |  8 +++-
 qemu-options.hx           |  9 +++-
 tests/test-util-sockets.c | 91 +++++++++++++++++++++++++++++++++++++++
 util/qemu-sockets.c       | 39 ++++++++++++++---
 6 files changed, 148 insertions(+), 10 deletions(-)

-- 
2.17.1

[PATCH v4 1/3] qemu-sockets: add abstract UNIX domain socket support

[xiaoqiang zhao]

unix_listen/connect_saddr now support abstract address types

two aditional BOOL switches are introduced:
tight: whether to set @addrlen to the minimal string length,
       or the maximum sun_path length. default is TRUE
abstract: whether we use abstract address. default is FALSE

cli example:
-monitor unix:/tmp/unix.socket,abstract,tight=off
OR
-chardev socket,path=/tmp/unix.socket,id=unix1,abstract,tight=on

Signed-off-by: xiaoqiang zhao <zxq_yx_007@163.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
---
 chardev/char-socket.c |  4 ++++
 chardev/char.c        |  7 +++++++
 qapi/sockets.json     |  8 +++++++-
 util/qemu-sockets.c   | 39 ++++++++++++++++++++++++++++++++-------
 4 files changed, 50 insertions(+), 8 deletions(-)

diff --git a/chardev/char-socket.c b/chardev/char-socket.c
index 185fe38dda..16f2211091 100644
--- a/chardev/char-socket.c
+++ b/chardev/char-socket.c
@@ -1380,6 +1380,8 @@ static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
     const char *host = qemu_opt_get(opts, "host");
     const char *port = qemu_opt_get(opts, "port");
     const char *fd = qemu_opt_get(opts, "fd");
+    bool tight = qemu_opt_get_bool(opts, "tight", true);
+    bool abstract = qemu_opt_get_bool(opts, "abstract", false);
     SocketAddressLegacy *addr;
     ChardevSocket *sock;
 
@@ -1431,6 +1433,8 @@ static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
         addr->type = SOCKET_ADDRESS_LEGACY_KIND_UNIX;
         q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
         q_unix->path = g_strdup(path);
+        q_unix->tight = tight;
+        q_unix->abstract = abstract;
     } else if (host) {
         addr->type = SOCKET_ADDRESS_LEGACY_KIND_INET;
         addr->u.inet.data = g_new(InetSocketAddress, 1);
diff --git a/chardev/char.c b/chardev/char.c
index e77564060d..f44fda3a92 100644
--- a/chardev/char.c
+++ b/chardev/char.c
@@ -939,6 +939,13 @@ QemuOptsList qemu_chardev_opts = {
         },{
             .name = "logappend",
             .type = QEMU_OPT_BOOL,
+        },{
+            .name = "tight",
+            .type = QEMU_OPT_BOOL,
+            .def_value_str = "on",
+        },{
+            .name = "abstract",
+            .type = QEMU_OPT_BOOL,
         },
         { /* end of list */ }
     },
diff --git a/qapi/sockets.json b/qapi/sockets.json
index ea933ed4b2..cbd6ef35d0 100644
--- a/qapi/sockets.json
+++ b/qapi/sockets.json
@@ -73,12 +73,18 @@
 # Captures a socket address in the local ("Unix socket") namespace.
 #
 # @path: filesystem path to use
+# @tight: pass a socket address length confined to the minimum length of the
+#         abstract string, rather than the full sockaddr_un record length
+#         (only matters for abstract sockets, default true). (Since 5.1)
+# @abstract: whether this is an abstract address, default false. (Since 5.1)
 #
 # Since: 1.3
 ##
 { 'struct': 'UnixSocketAddress',
   'data': {
-    'path': 'str' } }
+    'path': 'str',
+    '*tight': 'bool',
+    '*abstract': 'bool' } }
 
 ##
 # @VsockSocketAddress:
diff --git a/util/qemu-sockets.c b/util/qemu-sockets.c
index 86c48b9fa5..b37d288866 100644
--- a/util/qemu-sockets.c
+++ b/util/qemu-sockets.c
@@ -863,6 +863,7 @@ static int unix_listen_saddr(UnixSocketAddress *saddr,
     char *pathbuf = NULL;
     const char *path;
     size_t pathlen;
+    size_t addrlen;
 
     sock = qemu_socket(PF_UNIX, SOCK_STREAM, 0);
     if (sock < 0) {
@@ -879,9 +880,11 @@ static int unix_listen_saddr(UnixSocketAddress *saddr,
     }
 
     pathlen = strlen(path);
-    if (pathlen > sizeof(un.sun_path)) {
+    if (pathlen > sizeof(un.sun_path) ||
+        (saddr->abstract && pathlen > (sizeof(un.sun_path) - 1))) {
         error_setg(errp, "UNIX socket path '%s' is too long", path);
         error_append_hint(errp, "Path must be less than %zu bytes\n",
+                          saddr->abstract ? sizeof(un.sun_path) - 1 :
                           sizeof(un.sun_path));
         goto err;
     }
@@ -903,7 +906,7 @@ static int unix_listen_saddr(UnixSocketAddress *saddr,
         close(fd);
     }
 
-    if (unlink(path) < 0 && errno != ENOENT) {
+    if (!saddr->abstract && unlink(path) < 0 && errno != ENOENT) {
         error_setg_errno(errp, errno,
                          "Failed to unlink socket %s", path);
         goto err;
@@ -911,9 +914,19 @@ static int unix_listen_saddr(UnixSocketAddress *saddr,
 
     memset(&un, 0, sizeof(un));
     un.sun_family = AF_UNIX;
-    memcpy(un.sun_path, path, pathlen);
+    addrlen = sizeof(un);
 
-    if (bind(sock, (struct sockaddr*) &un, sizeof(un)) < 0) {
+    if (saddr->abstract) {
+        un.sun_path[0] = '\0';
+        memcpy(&un.sun_path[1], path, pathlen);
+        if (saddr->tight) {
+            addrlen = offsetof(struct sockaddr_un, sun_path) + 1 + pathlen;
+        }
+    } else {
+        memcpy(un.sun_path, path, pathlen);
+    }
+
+    if (bind(sock, (struct sockaddr *) &un, addrlen) < 0) {
         error_setg_errno(errp, errno, "Failed to bind socket to %s", path);
         goto err;
     }
@@ -936,6 +949,7 @@ static int unix_connect_saddr(UnixSocketAddress *saddr, Error **errp)
     struct sockaddr_un un;
     int sock, rc;
     size_t pathlen;
+    size_t addrlen;
 
     if (saddr->path == NULL) {
         error_setg(errp, "unix connect: no path specified");
@@ -949,21 +963,32 @@ static int unix_connect_saddr(UnixSocketAddress *saddr, Error **errp)
     }
 
     pathlen = strlen(saddr->path);
-    if (pathlen > sizeof(un.sun_path)) {
+    if (pathlen > sizeof(un.sun_path) ||
+        (saddr->abstract && pathlen > (sizeof(un.sun_path) - 1))) {
         error_setg(errp, "UNIX socket path '%s' is too long", saddr->path);
         error_append_hint(errp, "Path must be less than %zu bytes\n",
+                          saddr->abstract ? sizeof(un.sun_path) - 1 :
                           sizeof(un.sun_path));
         goto err;
     }
 
     memset(&un, 0, sizeof(un));
     un.sun_family = AF_UNIX;
-    memcpy(un.sun_path, saddr->path, pathlen);
+    addrlen = sizeof(un);
 
+    if (saddr->abstract) {
+        un.sun_path[0] = '\0';
+        memcpy(&un.sun_path[1], saddr->path, pathlen);
+        if (saddr->tight) {
+            addrlen = offsetof(struct sockaddr_un, sun_path) + 1 + pathlen;
+        }
+    } else {
+        memcpy(un.sun_path, saddr->path, pathlen);
+    }
     /* connect to peer */
     do {
         rc = 0;
-        if (connect(sock, (struct sockaddr *) &un, sizeof(un)) < 0) {
+        if (connect(sock, (struct sockaddr *) &un, addrlen) < 0) {
             rc = -errno;
         }
     } while (rc == -EINTR);
-- 
2.17.1

[PATCH v4 2/3] tests/util-sockets: add abstract unix socket cases

[xiaoqiang zhao]

add cases to test tight and non-tight for abstract address type

Signed-off-by: xiaoqiang zhao <zxq_yx_007@163.com>
---
 tests/test-util-sockets.c | 91 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 91 insertions(+)

diff --git a/tests/test-util-sockets.c b/tests/test-util-sockets.c
index 5fd947c7bf..c21a90634a 100644
--- a/tests/test-util-sockets.c
+++ b/tests/test-util-sockets.c
@@ -227,6 +227,92 @@ static void test_socket_fd_pass_num_nocli(void)
     g_free(addr.u.fd.str);
 }
 
+static gchar *abstract_sock_name;
+
+static gpointer unix_server_thread_func(gpointer user_data)
+{
+    SocketAddress addr;
+    Error *err = NULL;
+    int fd = -1;
+    int connfd = -1;
+    struct sockaddr_un un;
+    socklen_t len = sizeof(un);
+
+    addr.type = SOCKET_ADDRESS_TYPE_UNIX;
+    addr.u.q_unix.path = abstract_sock_name;
+    addr.u.q_unix.tight = user_data != NULL;
+    addr.u.q_unix.abstract = true;
+
+    fd = socket_listen(&addr, 1, &err);
+    g_assert_cmpint(fd, >=, 0);
+    g_assert(fd_is_socket(fd));
+
+    connfd = accept(fd, (struct sockaddr *)&un, &len);
+    g_assert_cmpint(connfd, !=, -1);
+
+    close(fd);
+
+    return NULL;
+}
+
+static gpointer unix_client_thread_func(gpointer user_data)
+{
+    SocketAddress addr;
+    Error *err = NULL;
+    int fd = -1;
+
+    addr.type = SOCKET_ADDRESS_TYPE_UNIX;
+    addr.u.q_unix.path = abstract_sock_name;
+    addr.u.q_unix.tight = user_data != NULL;
+    addr.u.q_unix.abstract = true;
+
+    fd = socket_connect(&addr, &err);
+
+    g_assert_cmpint(fd, >=, 0);
+
+    close(fd);
+
+    return NULL;
+}
+
+static void test_socket_unix_abstract_good(void)
+{
+
+    GRand *r = g_rand_new();
+
+    abstract_sock_name = g_strdup_printf("unix-%d-%d", getpid(),
+    g_rand_int_range(r, 100, 1000));
+
+    /* non tight socklen serv and cli */
+    GThread *serv = g_thread_new("abstract_unix_server",
+                                 unix_server_thread_func,
+                                 NULL);
+
+    sleep(1);
+
+    GThread *cli = g_thread_new("abstruct_unix_client",
+                                unix_client_thread_func,
+                                NULL);
+
+    g_thread_join(cli);
+    g_thread_join(serv);
+
+    /* tight socklen serv and cli */
+    serv = g_thread_new("abstract_unix_server",
+                        unix_server_thread_func,
+                        (gpointer)1);
+
+    sleep(1);
+
+    cli = g_thread_new("abstruct_unix_client",
+                       unix_client_thread_func,
+                       (gpointer)1);
+
+    g_thread_join(cli);
+    g_thread_join(serv);
+
+    g_free(abstract_sock_name);
+}
 
 int main(int argc, char **argv)
 {
@@ -265,6 +351,11 @@ int main(int argc, char **argv)
                         test_socket_fd_pass_num_nocli);
     }
 
+#ifdef __linux__
+        g_test_add_func("/util/socket/unix-abstract/good",
+                        test_socket_unix_abstract_good);
+#endif
+
 end:
     return g_test_run();
 }
-- 
2.17.1

Re: [PATCH v4 2/3] tests/util-sockets: add abstract unix socket cases

[Daniel P. Berrangé]

On Fri, May 15, 2020 at 12:32:34PM +0800, xiaoqiang zhao wrote:
> add cases to test tight and non-tight for abstract address type
> 
> Signed-off-by: xiaoqiang zhao <zxq_yx_007@163.com>
> ---
>  tests/test-util-sockets.c | 91 +++++++++++++++++++++++++++++++++++++++
>  1 file changed, 91 insertions(+)
> 
> diff --git a/tests/test-util-sockets.c b/tests/test-util-sockets.c
> index 5fd947c7bf..c21a90634a 100644
> --- a/tests/test-util-sockets.c
> +++ b/tests/test-util-sockets.c
> @@ -227,6 +227,92 @@ static void test_socket_fd_pass_num_nocli(void)
>      g_free(addr.u.fd.str);
>  }
>  
> +static gchar *abstract_sock_name;
> +
> +static gpointer unix_server_thread_func(gpointer user_data)
> +{
> +    SocketAddress addr;
> +    Error *err = NULL;
> +    int fd = -1;
> +    int connfd = -1;
> +    struct sockaddr_un un;
> +    socklen_t len = sizeof(un);
> +
> +    addr.type = SOCKET_ADDRESS_TYPE_UNIX;
> +    addr.u.q_unix.path = abstract_sock_name;
> +    addr.u.q_unix.tight = user_data != NULL;
> +    addr.u.q_unix.abstract = true;
> +
> +    fd = socket_listen(&addr, 1, &err);
> +    g_assert_cmpint(fd, >=, 0);
> +    g_assert(fd_is_socket(fd));
> +
> +    connfd = accept(fd, (struct sockaddr *)&un, &len);
> +    g_assert_cmpint(connfd, !=, -1);
> +
> +    close(fd);
> +
> +    return NULL;
> +}
> +
> +static gpointer unix_client_thread_func(gpointer user_data)
> +{
> +    SocketAddress addr;
> +    Error *err = NULL;
> +    int fd = -1;
> +
> +    addr.type = SOCKET_ADDRESS_TYPE_UNIX;
> +    addr.u.q_unix.path = abstract_sock_name;
> +    addr.u.q_unix.tight = user_data != NULL;
> +    addr.u.q_unix.abstract = true;
> +
> +    fd = socket_connect(&addr, &err);
> +
> +    g_assert_cmpint(fd, >=, 0);
> +
> +    close(fd);
> +
> +    return NULL;
> +}
> +
> +static void test_socket_unix_abstract_good(void)
> +{
> +

Extra blank line

> +    GRand *r = g_rand_new();
> +
> +    abstract_sock_name = g_strdup_printf("unix-%d-%d", getpid(),
> +    g_rand_int_range(r, 100, 1000));

This g_rand_int_range should be indented more 

> +
> +    /* non tight socklen serv and cli */
> +    GThread *serv = g_thread_new("abstract_unix_server",
> +                                 unix_server_thread_func,
> +                                 NULL);
> +
> +    sleep(1);
> +
> +    GThread *cli = g_thread_new("abstruct_unix_client",

s/abstruct/abstract/

> +                                unix_client_thread_func,
> +                                NULL);
> +
> +    g_thread_join(cli);
> +    g_thread_join(serv);
> +
> +    /* tight socklen serv and cli */
> +    serv = g_thread_new("abstract_unix_server",
> +                        unix_server_thread_func,
> +                        (gpointer)1);
> +
> +    sleep(1);
> +
> +    cli = g_thread_new("abstruct_unix_client",

s/abstruct/abstract/

> +                       unix_client_thread_func,
> +                       (gpointer)1);
> +
> +    g_thread_join(cli);
> +    g_thread_join(serv);
> +
> +    g_free(abstract_sock_name);
> +}

Everything above here needs to be wrapped in ifdef __linux__ otherwise
the compiler is liable to complain about unused static functions

>  
>  int main(int argc, char **argv)
>  {
> @@ -265,6 +351,11 @@ int main(int argc, char **argv)
>                          test_socket_fd_pass_num_nocli);
>      }
>  
> +#ifdef __linux__
> +        g_test_add_func("/util/socket/unix-abstract/good",
> +                        test_socket_unix_abstract_good);

This is indented a little too much

> +#endif
> +
>  end:
>      return g_test_run();
>  }
> -- 
> 2.17.1
> 

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|

[PATCH v4 3/3] qemu-options: updates for abstract unix sockets

[xiaoqiang zhao]

add options documents changes for -chardev

Signed-off-by: xiaoqiang zhao <zxq_yx_007@163.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
---
 qemu-options.hx | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index e2dca8a4e9..e63cc1b4b4 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -2938,7 +2938,7 @@ DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
     "         [,server][,nowait][,telnet][,websocket][,reconnect=seconds][,mux=on|off]\n"
     "         [,logfile=PATH][,logappend=on|off][,tls-creds=ID][,tls-authz=ID] (tcp)\n"
     "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,websocket][,reconnect=seconds]\n"
-    "         [,mux=on|off][,logfile=PATH][,logappend=on|off] (unix)\n"
+    "         [,mux=on|off][,logfile=PATH][,logappend=on|off][,tight=on|off][,abstract=on|off] (unix)\n"
     "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
     "         [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
     "         [,logfile=PATH][,logappend=on|off]\n"
@@ -3105,9 +3105,14 @@ The available backends are:
 
         ``nodelay`` disables the Nagle algorithm.
 
-    ``unix options: path=path``
+    ``unix options: path=path[,tight=on|off][,abstract=on|off]``
         ``path`` specifies the local path of the unix socket. ``path``
         is required.
+	``tight`` whether to set @addrlen to the minimal string length,
+        or the maximum sun_path length. defaults to true. ``tight`` is
+        optional.
+	``abstract`` whether use abstract address. defaults to false.
+	``abstract`` is optional.
 
 ``-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr][,localport=localport][,ipv4][,ipv6]``
     Sends all traffic from the guest to a remote host over UDP.
-- 
2.17.1

Re: [PATCH v4 3/3] qemu-options: updates for abstract unix sockets

[Eric Blake]

On 5/14/20 11:32 PM, xiaoqiang zhao wrote:
> add options documents changes for -chardev
> 
> Signed-off-by: xiaoqiang zhao <zxq_yx_007@163.com>
> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>   qemu-options.hx | 9 +++++++--
>   1 file changed, 7 insertions(+), 2 deletions(-)

I'd suggest listing 'abstract' before 'tight', since 'tight' only 
matters for abstract.  I also have grammar suggestions:

> -    ``unix options: path=path``
> +    ``unix options: path=path[,tight=on|off][,abstract=on|off]``
>           ``path`` specifies the local path of the unix socket. ``path``
>           is required.
> +	``tight`` whether to set @addrlen to the minimal string length,
> +        or the maximum sun_path length. defaults to true. ``tight`` is
> +        optional.
> +	``abstract`` whether use abstract address. defaults to false.
> +	``abstract`` is optional.

``abstract`` specifies the use of the abstract socket namespace, rather 
than the filesystem.  Optional, defaults to false.
``tight`` sets the socket length of abstract sockets to their minimum, 
rather than the full sun_path length.  Optional, defaults to true.

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org

Re: [PATCH v4 3/3] qemu-options: updates for abstract unix sockets

[xiaoqiang zhao]

在 2020/5/16 上午1:37, Eric Blake 写道:
> On 5/14/20 11:32 PM, xiaoqiang zhao wrote:
>> add options documents changes for -chardev
>>
>> Signed-off-by: xiaoqiang zhao <zxq_yx_007@163.com>
>> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
>> ---
>>   qemu-options.hx | 9 +++++++--
>>   1 file changed, 7 insertions(+), 2 deletions(-)
>
> I'd suggest listing 'abstract' before 'tight', since 'tight' only 
> matters for abstract.  I also have grammar suggestions:
>
>> -    ``unix options: path=path``
>> +    ``unix options: path=path[,tight=on|off][,abstract=on|off]``
>>           ``path`` specifies the local path of the unix socket. ``path``
>>           is required.
>> +    ``tight`` whether to set @addrlen to the minimal string length,
>> +        or the maximum sun_path length. defaults to true. ``tight`` is
>> +        optional.
>> +    ``abstract`` whether use abstract address. defaults to false.
>> +    ``abstract`` is optional.
>
> ``abstract`` specifies the use of the abstract socket namespace, 
> rather than the filesystem.  Optional, defaults to false.
> ``tight`` sets the socket length of abstract sockets to their minimum, 
> rather than the full sun_path length.  Optional, defaults to true.
>
Reasonable,  will change in v6