Re: [PATCH v22 0/7] Add vmnet.framework based network backend

[Jason Wang]

On Fri, Mar 18, 2022 at 5:30 PM Akihiko Odaki <akihiko.odaki@gmail.com> wrote:
>
> Reviewed-by: Akihiko Odaki <akihiko.odaki@gmail.com>
> Tested-by: Akihiko Odaki <akihiko.odaki@gmail.com>
>
> Thank you for this great work!

We miss 7.0 so I will queue this for 7.1

Thanks everyone!

>
> On 2022/03/18 2:28, Vladislav Yaroshchuk wrote:
> > macOS provides networking API for VMs called 'vmnet.framework':
> > https://developer.apple.com/documentation/vmnet
> >
> > We can provide its support as the new QEMU network backends which
> > represent three different vmnet.framework interface usage modes:
> >
> >    * `vmnet-shared`:
> >      allows the guest to communicate with other guests in shared mode and
> >      also with external network (Internet) via NAT. Has (macOS-provided)
> >      DHCP server; subnet mask and IP range can be configured;
> >
> >    * `vmnet-host`:
> >      allows the guest to communicate with other guests in host mode.
> >      By default has enabled DHCP as `vmnet-shared`, but providing
> >      network unique id (uuid) can make `vmnet-host` interfaces isolated
> >      from each other and also disables DHCP.
> >
> >    * `vmnet-bridged`:
> >      bridges the guest with a physical network interface.
> >
> > This backends cannot work on macOS Catalina 10.15 cause we use
> > vmnet.framework API provided only with macOS 11 and newer. Seems
> > that it is not a problem, because QEMU guarantees to work on two most
> > recent versions of macOS which now are Big Sur (11) and Monterey (12).
> >
> > Also, we have one inconvenient restriction: vmnet.framework interfaces
> > can create only privileged user:
> > `$ sudo qemu-system-x86_64 -nic vmnet-shared`
> >
> > Attempt of `vmnet-*` netdev creation being unprivileged user fails with
> > vmnet's 'general failure'.
> >
> > This happens because vmnet.framework requires `com.apple.vm.networking`
> > entitlement which is: "restricted to developers of virtualization software.
> > To request this entitlement, contact your Apple representative." as Apple
> > documentation says:
> > https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_vm_networking
> >
> > One more note: we still have quite useful but not supported
> > 'vmnet.framework' features as creating port forwarding rules, IPv6
> > NAT prefix specifying and so on.
> >
> > Nevertheless, new backends work fine and tested within `qemu-system-x86-64`
> > on macOS Bir Sur 11.5.2 host with such nic models:
> >    * e1000-82545em
> >    * virtio-net-pci
> >    * vmxnet3
> >
> > The guests were:
> >    * macOS 10.15.7
> >    * Ubuntu Bionic (server cloudimg)
> >
> >
> > This series partially reuses patches by Phillip Tennen:
> > https://patchew.org/QEMU/20210218134947.1860-1-phillip.ennen@gmail.com/
> > So I included them signed-off line into one of the commit messages and
> > also here.
> >
> > v1 -> v2:
> >   Since v1 minor typos were fixed, patches rebased onto latest master,
> >   redundant changes removed (small commits squashed)
> > v2 -> v3:
> >   - QAPI style fixes
> >   - Typos fixes in comments
> >   - `#include`'s updated to be in sync with recent master
> > v3 -> v4:
> >   - Support vmnet interfaces isolation feature
> >   - Support vmnet-host network uuid setting feature
> >   - Refactored sources a bit
> > v4 -> v5:
> >   - Missed 6.2 boat, now 7.0 candidate
> >   - Fix qapi netdev descriptions and styles
> >     (@subnetmask -> @subnet-mask)
> >   - Support vmnet-shared IPv6 prefix setting feature
> > v5 -> v6
> >   - provide detailed commit messages for commits of
> >     many changes
> >   - rename properties @dhcpstart and @dhcpend to
> >     @start-address and @end-address
> >   - improve qapi documentation about isolation
> >     features (@isolated, @net-uuid)
> > v6 -> v7:
> >   - update MAINTAINERS list
> > v7 -> v8
> >   - QAPI code style fixes
> > v8 -> v9
> >   - Fix building on Linux: add missing qapi
> >     `'if': 'CONFIG_VMNET'` statement to Netdev union
> > v9 -> v10
> >   - Disable vmnet feature for macOS < 11.0: add
> >     vmnet.framework API probe into meson.build.
> >     This fixes QEMU building on macOS < 11.0:
> >     https://patchew.org/QEMU/20220110034000.20221-1-jasowang@redhat.com/
> > v10 -> v11
> >   - Enable vmnet for macOS 10.15 with subset of available
> >     features. Disable vmnet for macOS < 10.15.
> >   - Fix typos
> > v11 -> v12
> >   - use more general macOS version check with
> >     MAC_OS_VERSION_11_0 instead of manual
> >     definition creating.
> > v12 -> v13
> >   - fix incorrect macOS version bound while
> >     'feature available since 11.0' check.
> >     Use MAC_OS_X_VERSION_MIN_REQUIRED instead of
> >     MAC_OS_X_VERSION_MAX_ALLOWED.
> > v13 -> v14
> >   - fix memory leaks
> >   - get rid of direct global mutex taking while resending
> >     packets from vmnet to QEMU, schedule a bottom half
> >     instead (it can be a thing to discuss, maybe exists a
> >     better way to perform the packets transfer)
> >   - update hmp commands
> >   - a bit refactor everything
> >   - change the email from which patches are being
> >     submitted, same to email in MAINTAINERS list
> >   - P.S. sorry for so late reply
> > v14 -> v15
> >   - restore --enable-vdi and --disable-vdi
> >     mistakenly dropped in previous series
> > v15 -> v16
> >   - common: complete sending pending packets when
> >     QEMU is ready, refactor, fix memory leaks
> >   - QAPI: change version to 7.1 (cause 7.0 feature freeze
> >     happened). This is the only change in QAPI, Markus Armbruster,
> >     please confirm if you can (decided to drop your Acked-by due
> >     to this change)
> >   - vmnet-bridged: extend "supported ifnames" message buffer len
> >   - fix behaviour dependence on debug (add "return -1" after
> >     assert_not_reached)
> >   - use PRIu64 for proper printing
> >   - NOTE: This version of patch series may be one the last
> >     I submit - JetBrains has suspended operations in
> >     Russia indefinitely due to all the awful things happened
> >     the last weeks. I may leave this company and loose the
> >     ability to work on vmnet support :(
> >     It will be perfect if someone can handle my unfinished work,
> >     if something required to fix/improve is found.
> >     Because of this, MAINTAINERS list update is dropped
> > v16 -> v17
> >   - host: move network_uuid to local variable
> >   - common: refactor, add documentation
> >   - common/send (vmnet->qemu): read new packets after QEMU
> >     send_cb invoked
> >   - common/receive (qemu->vmnet): drop redundant vmnet
> >     status checks
> >   - restore dropped commit messaged from the previous series
> > v17 -> v18
> >   - use VmnetState struct for all three operation modes
> >   - drop send_enabled flag
> >   - do not unregister vmnet event callback on cleanup,
> >     let vmnet.framework do everything itself while interface
> >     destruction
> > v18 -> v19
> >   - use positive pointers values to describe unsent packets
> >     window of VmnetState buffer
> > v19 -> v20
> >   - vmnet-host: minor but required refactor
> > v20 -> v21
> >   - vmnet-bridged: dynamically allocate valid ifnames list
> >   - QAPI schema: add `Markus Armbruster <armbru@redhat.com>`'s acked-by
> > v21 -> v22
> >   - common: fix if_desc memory leak
> >
> > Vladislav Yaroshchuk (7):
> >    net/vmnet: add vmnet dependency and customizable option
> >    net/vmnet: add vmnet backends to qapi/net
> >    net/vmnet: implement shared mode (vmnet-shared)
> >    net/vmnet: implement host mode (vmnet-host)
> >    net/vmnet: implement bridged mode (vmnet-bridged)
> >    net/vmnet: update qemu-options.hx
> >    net/vmnet: update hmp-commands.hx
> >
> >   hmp-commands.hx               |   6 +-
> >   meson.build                   |  16 +-
> >   meson_options.txt             |   2 +
> >   net/clients.h                 |  11 +
> >   net/meson.build               |   7 +
> >   net/net.c                     |  10 +
> >   net/vmnet-bridged.m           | 152 ++++++++++++++
> >   net/vmnet-common.m            | 378 ++++++++++++++++++++++++++++++++++
> >   net/vmnet-host.c              | 128 ++++++++++++
> >   net/vmnet-shared.c            | 114 ++++++++++
> >   net/vmnet_int.h               |  63 ++++++
> >   qapi/net.json                 | 133 +++++++++++-
> >   qemu-options.hx               |  25 +++
> >   scripts/meson-buildoptions.sh |   1 +
> >   14 files changed, 1042 insertions(+), 4 deletions(-)
> >   create mode 100644 net/vmnet-bridged.m
> >   create mode 100644 net/vmnet-common.m
> >   create mode 100644 net/vmnet-host.c
> >   create mode 100644 net/vmnet-shared.c
> >   create mode 100644 net/vmnet_int.h
> >
>