fixed README.md wrong formatting

Author: pallotron

.github/workflows/lima.yaml

@@ -65,6 +65,14 @@ jobs:
           limactl shell vm1 sudo apt-get update
           limactl shell vm1 sudo apt-get install -y iperf3
           limactl shell vm1 sudo systemctl start iperf3.service
+          echo "Waiting for iperf3 server ..."
+          limactl shell vm1 bash -s << EOF
+            if ! timeout 10s bash -c "until ss -tln | grep -q :5201; do sleep 1; done"; then
+              echo >&2 "Timeout waiting for iperf3 port"
+              exit 1
+            fi
+          EOF
+          echo "iperf3 server is ready"
       - name: "Lima: vm1: get the IP"
         run: |
           limactl shell vm1 ip -4 -json addr show dev lima0 | jq -r .[0].addr_info[0].local | tee /tmp/vm1_iP

README.md

@@ -12,7 +12,6 @@ Unlike `vde_vmnet`, `socket_vmnet` does not depend on VDE.
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [socket_vmnet: vmnet.framework support for rootless and VDE-less QEMU](#socket_vmnet-vmnetframework-support-for-rootless-and-vde-less-qemu)
   - [Install](#install)
     - [From binary](#from-binary)
     - [From source](#from-source)
@@ -124,7 +123,8 @@ Run the following command to start the daemon:
 sudo /opt/socket_vmnet/bin/socket_vmnet --vmnet-gateway=192.168.105.1 /var/run/socket_vmnet
 ```
 
-> [!TIP] > `sudo make install` is also available in addition to `sudo make install.bin`.
+> [!TIP]
+> `sudo make install` is also available in addition to `sudo make install.bin`.
 > The former one installs the launchd service (see below) too.
 
 <details>
@@ -433,14 +433,17 @@ sudo /usr/libexec/ApplicationFirewall/socketfilterfw --add /usr/libexec/bootpd
 
 ### How to setup a vmnet host network without DHCP?
 
-You may need to disable the vmnet framework's DHCP to:
+Some users may need to disable the vmnet framework's DHCP for various scenarios, such as:
 
 - Create a host network where all VMs have static IPs.
 - Run a custom DHCP server on one VM to assign IPs to others on the same network.
 
-To disable the macOS DHCP you must use `--vmnet-mode=host` and provide a `--vmnet-network-idenfitier` UUID.
-You **_must not_** provide `--vmnet-gateway`. That is the signal to Apple's vmnet.framework to enable MacOS DHCP.
-You can use `--vmnet-network-idenfitier=random` to get a random UUID assigned.
+Disabling macOS DHCP only works in `--vmnet-mode=host` if you provide a `--vmnet-network-idenfitier`.
+For example, to create a host network without DHCP on `socket_vmnet`:
+
+```bash
+sudo /opt/socket_vmnet/bin/socket_vmnet --vmnet-mode=host --vmnet-network-identifier=$(uuidgen)
+```
 
 ## Links
 

cli.c

@@ -48,11 +48,12 @@ static void print_usage(const char *argv0) {
          "specified\n");
   printf("--vmnet-interface-id=UUID           vmnet interface ID (default: "
          "random)\n");
-  printf("--vmnet-network-identifier=UUID     vmnet network identifier (UUID string, \"random\", "
-         "or \"\")\n"
-         "                                    When vmnet mode is \"host\" and --vmnet-gateway is "
-         "not set, the internal DHCP will be disabled.\n"
-         "                                    (default: \"\")\n");
+  printf("--vmnet-network-identifier=UUID     The identifier(uuid) to uniquely identify the network. \n"
+         "                                    This property is only applicable to a vmnet_interface\n"
+         "                                    in VMNET_HOST_MODE.\n"
+         "                                    If this property is set, the vmnet_interface is added to \n"
+         "                                    an isolated network with the specified\n"
+         "                                    identifier. No DHCP service is provided on this network.\n");
 
   printf("--vmnet-nat66-prefix=PREFIX::       The IPv6 prefix to use with "
          "shared mode.\n");
@@ -143,12 +144,8 @@ struct cli_options *cli_options_parse(int argc, char *argv[]) {
       res->vmnet_nat66_prefix = strdup(optarg);
       break;
     case CLI_OPT_VMNET_NETWORK_IDENTIFIER:
-      if (strcmp(optarg, "random") == 0) {
-        uuid_generate_random(res->vmnet_network_identifier);
-      } else if (strcmp(optarg, "") == 0) {
-        uuid_clear(res->vmnet_network_identifier);
-      } else if (uuid_parse(optarg, res->vmnet_network_identifier) < 0) {
-        ERRORF("Failed to parse UUID \"%s\"", optarg);
+      if (uuid_parse(optarg, res->vmnet_network_identifier) < 0) {
+        ERRORF("Failed to parse network identifier UUID \"%s\"", optarg);
         goto error;
       }
       break;

main.c

@@ -231,22 +231,14 @@ static interface_ref start(struct state *state, struct cli_options *cliopt) {
     xpc_dictionary_set_string(dict, vmnet_shared_interface_name_key, cliopt->vmnet_interface);
   }
 
-  // no dhcp
-  if (cliopt->vmnet_mode == VMNET_HOST_MODE && cliopt->vmnet_gateway == NULL) {
-    if (!uuid_is_null(cliopt->vmnet_network_identifier)) {
+  if (!uuid_is_null(cliopt->vmnet_network_identifier)) {
       xpc_dictionary_set_uuid(dict, vmnet_network_identifier_key, cliopt->vmnet_network_identifier);
-      uuid_string_t uuid_str;
-      uuid_unparse(cliopt->vmnet_network_identifier, uuid_str);
-      INFOF("Using network identifier \"%s\" and no vmnet gateway -> NO DHCP will be enabled on "
-            "this vmnet",
-            uuid_str);
-    }
-  } else {
-    if (cliopt->vmnet_gateway != NULL) {
-      xpc_dictionary_set_string(dict, vmnet_start_address_key, cliopt->vmnet_gateway);
-      xpc_dictionary_set_string(dict, vmnet_end_address_key, cliopt->vmnet_dhcp_end);
-      xpc_dictionary_set_string(dict, vmnet_subnet_mask_key, cliopt->vmnet_mask);
-    }
+  }
+
+  if (cliopt->vmnet_gateway != NULL) {
+    xpc_dictionary_set_string(dict, vmnet_start_address_key, cliopt->vmnet_gateway);
+    xpc_dictionary_set_string(dict, vmnet_end_address_key, cliopt->vmnet_dhcp_end);
+    xpc_dictionary_set_string(dict, vmnet_subnet_mask_key, cliopt->vmnet_mask);
   }
 
   xpc_dictionary_set_uuid(dict, vmnet_interface_id_key, cliopt->vmnet_interface_id);