[PATCH v3 0/1] Optimize Code

[PATCH v3 0/1] Optimize Code

[Dehan Meng]

v2 -> v3
- Remove this declaration and make the function 'hexToIPAddress' as static.
- Define 'IFNAMSIZ' from kernel instead of a hardcode
- Remove 'GUEST_NETWORK_ROUTE_TYPE_LINUX'
- Set flags 'has_xxx' for checking if a field exists or has a value set

v1 -> v2
- Replace snprintf() to g_strdup_printf() to avoid memory problems.
- Remove the parameter 'char ipAddress[16]' in function 'char *hexToIPAddress()'.
- Add a piece of logic to skip traversing the first line of the file

Dehan Meng (1):
  qga/linux: Add new api 'guest-network-get-route'

 qga/commands-posix.c | 81 ++++++++++++++++++++++++++++++++++++++++++++
 qga/commands-win32.c |  6 ++++
 qga/qapi-schema.json | 80 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 167 insertions(+)

-- 
2.40.1

[PATCH v3 1/1] qga/linux: Add new api 'guest-network-get-route'

[Dehan Meng]

The Route information of the Linux VM needs to be used
by administrators and users when debugging network problems
and troubleshooting.

Signed-off-by: Dehan Meng <demeng@redhat.com>
---
 qga/commands-posix.c | 81 ++++++++++++++++++++++++++++++++++++++++++++
 qga/commands-win32.c |  6 ++++
 qga/qapi-schema.json | 80 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 167 insertions(+)

diff --git a/qga/commands-posix.c b/qga/commands-posix.c
index 6169bbf7a0..3ac517423f 100644
--- a/qga/commands-posix.c
+++ b/qga/commands-posix.c
@@ -2747,6 +2747,81 @@ GuestCpuStatsList *qmp_guest_get_cpustats(Error **errp)
     return head;
 }
 
+static char *hexToIPAddress(unsigned int hexValue)
+{
+    unsigned int byte1 = (hexValue >> 24) & 0xFF;
+    unsigned int byte2 = (hexValue >> 16) & 0xFF;
+    unsigned int byte3 = (hexValue >> 8) & 0xFF;
+    unsigned int byte4 = hexValue & 0xFF;
+
+    return g_strdup_printf("%u.%u.%u.%u", byte4, byte3, byte2, byte1);
+}
+
+GuestNetworkRouteList *qmp_guest_network_get_route(Error **errp)
+{
+    GuestNetworkRouteList *head = NULL, **tail = &head;
+    const char *routeFile = "/proc/net/route";
+    FILE *fp;
+    size_t n;
+    char *line = NULL;
+    int firstLine = 1;
+
+    fp = fopen(routeFile, "r");
+    if (fp == NULL) {
+        error_setg_errno(errp, errno, "open(\"%s\")", routeFile);
+        free(line);
+        return NULL;
+    }
+
+    while (getline(&line, &n, fp) != -1) {
+        if (firstLine) {
+            firstLine = 0;
+            continue;
+        }
+        GuestNetworkRoute *route = NULL;
+        GuestNetworkRouteStat *networkroute;
+        int i;
+	char Iface[IFNAMSIZ];
+        unsigned int Destination, Gateway, Mask, Flags;
+        int RefCnt, Use, Metric, MTU, Window, IRTT;
+
+        /* Parse the line and extract the values */
+        i = (sscanf(line, "%s %X %X %x %d %d %d %X %d %d %d",
+                    Iface, &Destination, &Gateway, &Flags, &RefCnt,
+                    &Use, &Metric, &Mask, &MTU, &Window, &IRTT) == 11);
+        if (i == EOF) {
+            continue;
+        }
+
+        route = g_new0(GuestNetworkRoute, 1);
+
+        networkroute = &route->u.q_linux;
+        networkroute->iface = g_strdup(Iface);
+        networkroute->destination = hexToIPAddress(Destination);
+        networkroute->gateway = hexToIPAddress(Gateway);
+        networkroute->mask = hexToIPAddress(Mask);
+        networkroute->metric = Metric;
+	networkroute->has_flags = true;
+        networkroute->flags = Flags;
+        networkroute->has_refcnt = true;
+        networkroute->refcnt = RefCnt;
+        networkroute->has_use = true;
+        networkroute->use = Use;
+        networkroute->has_mtu = true;
+        networkroute->mtu = MTU;
+        networkroute->has_window = true;
+        networkroute->window = Window;
+        networkroute->has_irtt = true;
+        networkroute->irtt = IRTT;
+
+        QAPI_LIST_APPEND(tail, route);
+    }
+
+    free(line);
+    fclose(fp);
+    return head;
+}
+
 #else /* defined(__linux__) */
 
 void qmp_guest_suspend_disk(Error **errp)
@@ -3118,6 +3193,12 @@ GuestCpuStatsList *qmp_guest_get_cpustats(Error **errp)
     return NULL;
 }
 
+GuestNetworkRouteList *qmp_guest_network_get_route(Error **errp)
+{
+    error_setg(errp, QERR_UNSUPPORTED);
+    return NULL;
+}
+
 #endif /* CONFIG_FSFREEZE */
 
 #if !defined(CONFIG_FSTRIM)
diff --git a/qga/commands-win32.c b/qga/commands-win32.c
index 697c65507c..e62c04800a 100644
--- a/qga/commands-win32.c
+++ b/qga/commands-win32.c
@@ -2522,3 +2522,9 @@ GuestCpuStatsList *qmp_guest_get_cpustats(Error **errp)
     error_setg(errp, QERR_UNSUPPORTED);
     return NULL;
 }
+
+GuestNetworkRouteList *qmp_guest_network_get_route(Error **errp)
+{
+    error_setg(errp, QERR_UNSUPPORTED);
+    return NULL;
+}
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 876e2a8ea8..eed9539bb7 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -1789,3 +1789,83 @@
 { 'command': 'guest-get-cpustats',
   'returns': ['GuestCpuStats']
 }
+
+##
+# @GuestNetworkRouteType:
+#
+# An enumeration of OS type
+#
+# Since: 8.2
+##
+{ 'enum': 'GuestNetworkRouteType',
+  'data': [ 'linux' ] }
+
+##
+# @GuestNetworkRouteStat:
+#
+# Route information, currently, only linux supported.
+#
+# @iface: The destination network or host's egress network interface in the routing table
+#
+# @destination: The IP address of the target network or host, The final destination of the packet
+#
+# @gateway: The IP address of the next hop router
+#
+# @mask: Subnet Mask
+#
+# @metric: Route metric
+#
+# @flags: Route flags (not for windows)
+#
+# @irtt: Initial round-trip delay (not for windows)
+#
+# @refcnt: The route's reference count (not for windows)
+#
+# @use: Route usage count (not for windows)
+#
+# @window: TCP window size, used for flow control (not for windows)
+#
+# @mtu: Data link layer maximum packet size (not for windows)
+#
+# Since: 8.2
+
+##
+{ 'struct': 'GuestNetworkRouteStat',
+  'data': {'iface': 'str',
+           'destination': 'str',
+           'gateway': 'str',
+           'metric': 'int',
+           'mask': 'str',
+           '*irtt': 'int',
+           '*flags': 'uint64',
+           '*refcnt': 'int',
+           '*use': 'int',
+           '*window': 'int',
+           '*mtu': 'int'
+           }}
+
+##
+# @GuestNetworkRoute:
+#
+# Get route information of system.
+#
+# - @linux: Linux style network route
+#
+# Since: 8.2
+##
+{ 'union': 'GuestNetworkRoute',
+  'base': { 'type': 'GuestNetworkRouteType' },
+  'discriminator': 'type',
+  'data': { 'linux': 'GuestNetworkRouteStat' } }
+
+##
+# @guest-network-get-route:
+#
+# Retrieve information about route of network.
+# Returns: List of route info of guest.
+#
+# Since: 8.2
+##
+{ 'command': 'guest-network-get-route',
+  'returns': ['GuestNetworkRoute']
+}
-- 
2.40.1

Re: [PATCH v3 1/1] qga/linux: Add new api 'guest-network-get-route'

[Konstantin Kostiuk]

[-- Attachment #1: Type: text/plain, Size: 6883 bytes --]

On Thu, Feb 29, 2024 at 8:48 AM Dehan Meng <demeng@redhat.com> wrote:

> The Route information of the Linux VM needs to be used
> by administrators and users when debugging network problems
> and troubleshooting.
>
> Signed-off-by: Dehan Meng <demeng@redhat.com>
> ---
>  qga/commands-posix.c | 81 ++++++++++++++++++++++++++++++++++++++++++++
>  qga/commands-win32.c |  6 ++++
>  qga/qapi-schema.json | 80 +++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 167 insertions(+)
>
> diff --git a/qga/commands-posix.c b/qga/commands-posix.c
> index 6169bbf7a0..3ac517423f 100644
> --- a/qga/commands-posix.c
> +++ b/qga/commands-posix.c
> @@ -2747,6 +2747,81 @@ GuestCpuStatsList *qmp_guest_get_cpustats(Error
> **errp)
>      return head;
>  }
>
> +static char *hexToIPAddress(unsigned int hexValue)
> +{
> +    unsigned int byte1 = (hexValue >> 24) & 0xFF;
> +    unsigned int byte2 = (hexValue >> 16) & 0xFF;
> +    unsigned int byte3 = (hexValue >> 8) & 0xFF;
> +    unsigned int byte4 = hexValue & 0xFF;
> +
> +    return g_strdup_printf("%u.%u.%u.%u", byte4, byte3, byte2, byte1);
> +}
> +
> +GuestNetworkRouteList *qmp_guest_network_get_route(Error **errp)
> +{
> +    GuestNetworkRouteList *head = NULL, **tail = &head;
> +    const char *routeFile = "/proc/net/route";
> +    FILE *fp;
> +    size_t n;
> +    char *line = NULL;
> +    int firstLine = 1;
> +
> +    fp = fopen(routeFile, "r");
> +    if (fp == NULL) {
> +        error_setg_errno(errp, errno, "open(\"%s\")", routeFile);
> +        free(line);
> +        return NULL;
> +    }
> +
> +    while (getline(&line, &n, fp) != -1) {
> +        if (firstLine) {
> +            firstLine = 0;
> +            continue;
> +        }
> +        GuestNetworkRoute *route = NULL;
> +        GuestNetworkRouteStat *networkroute;
> +        int i;
> +       char Iface[IFNAMSIZ];
>

Looks like an indentation issue

> +        unsigned int Destination, Gateway, Mask, Flags;
> +        int RefCnt, Use, Metric, MTU, Window, IRTT;
> +
> +        /* Parse the line and extract the values */
> +        i = (sscanf(line, "%s %X %X %x %d %d %d %X %d %d %d",
> +                    Iface, &Destination, &Gateway, &Flags, &RefCnt,
> +                    &Use, &Metric, &Mask, &MTU, &Window, &IRTT) == 11);
> +        if (i == EOF) {
> +            continue;
> +        }
> +
> +        route = g_new0(GuestNetworkRoute, 1);
> +
> +        networkroute = &route->u.q_linux;
> +        networkroute->iface = g_strdup(Iface);
> +        networkroute->destination = hexToIPAddress(Destination);
> +        networkroute->gateway = hexToIPAddress(Gateway);
> +        networkroute->mask = hexToIPAddress(Mask);
> +        networkroute->metric = Metric;
> +       networkroute->has_flags = true;
>

Looks like an indentation issue


> +        networkroute->flags = Flags;
> +        networkroute->has_refcnt = true;
> +        networkroute->refcnt = RefCnt;
> +        networkroute->has_use = true;
> +        networkroute->use = Use;
> +        networkroute->has_mtu = true;
> +        networkroute->mtu = MTU;
> +        networkroute->has_window = true;
> +        networkroute->window = Window;
> +        networkroute->has_irtt = true;
> +        networkroute->irtt = IRTT;
> +
> +        QAPI_LIST_APPEND(tail, route);
> +    }
> +
> +    free(line);
> +    fclose(fp);
> +    return head;
> +}
> +
>  #else /* defined(__linux__) */
>
>  void qmp_guest_suspend_disk(Error **errp)
> @@ -3118,6 +3193,12 @@ GuestCpuStatsList *qmp_guest_get_cpustats(Error
> **errp)
>      return NULL;
>  }
>
> +GuestNetworkRouteList *qmp_guest_network_get_route(Error **errp)
> +{
> +    error_setg(errp, QERR_UNSUPPORTED);
> +    return NULL;
> +}
> +
>  #endif /* CONFIG_FSFREEZE */
>
>  #if !defined(CONFIG_FSTRIM)
> diff --git a/qga/commands-win32.c b/qga/commands-win32.c
> index 697c65507c..e62c04800a 100644
> --- a/qga/commands-win32.c
> +++ b/qga/commands-win32.c
> @@ -2522,3 +2522,9 @@ GuestCpuStatsList *qmp_guest_get_cpustats(Error
> **errp)
>      error_setg(errp, QERR_UNSUPPORTED);
>      return NULL;
>  }
> +
> +GuestNetworkRouteList *qmp_guest_network_get_route(Error **errp)
> +{
> +    error_setg(errp, QERR_UNSUPPORTED);
> +    return NULL;
> +}
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index 876e2a8ea8..eed9539bb7 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -1789,3 +1789,83 @@
>  { 'command': 'guest-get-cpustats',
>    'returns': ['GuestCpuStats']
>  }
> +
> +##
> +# @GuestNetworkRouteType:
> +#
> +# An enumeration of OS type
> +#
> +# Since: 8.2
> +##
> +{ 'enum': 'GuestNetworkRouteType',
> +  'data': [ 'linux' ] }
> +
> +##
> +# @GuestNetworkRouteStat:
> +#
> +# Route information, currently, only linux supported.
> +#
> +# @iface: The destination network or host's egress network interface in
> the routing table
> +#
> +# @destination: The IP address of the target network or host, The final
> destination of the packet
> +#
> +# @gateway: The IP address of the next hop router
> +#
> +# @mask: Subnet Mask
> +#
> +# @metric: Route metric
> +#
> +# @flags: Route flags (not for windows)
> +#
> +# @irtt: Initial round-trip delay (not for windows)
> +#
> +# @refcnt: The route's reference count (not for windows)
> +#
> +# @use: Route usage count (not for windows)
> +#
> +# @window: TCP window size, used for flow control (not for windows)
> +#
> +# @mtu: Data link layer maximum packet size (not for windows)
> +#
> +# Since: 8.2
>

Update to 9.1


> +
> +##
> +{ 'struct': 'GuestNetworkRouteStat',
> +  'data': {'iface': 'str',
> +           'destination': 'str',
> +           'gateway': 'str',
> +           'metric': 'int',
> +           'mask': 'str',
> +           '*irtt': 'int',
> +           '*flags': 'uint64',
> +           '*refcnt': 'int',
> +           '*use': 'int',
> +           '*window': 'int',
> +           '*mtu': 'int'
> +           }}
> +
> +##
> +# @GuestNetworkRoute:
> +#
> +# Get route information of system.
> +#
> +# - @linux: Linux style network route
> +#
> +# Since: 8.2
> +##
> +{ 'union': 'GuestNetworkRoute',
> +  'base': { 'type': 'GuestNetworkRouteType' },
> +  'discriminator': 'type',
> +  'data': { 'linux': 'GuestNetworkRouteStat' } }
>

As GuestNetworkRouteStat has optional fields that are missing in Windows
we guest-network-get-route can return an array of routes.
So we don't need this enum.


> +
> +##
> +# @guest-network-get-route:
> +#
> +# Retrieve information about route of network.
> +# Returns: List of route info of guest.
> +#
> +# Since: 8.2
> +##
> +{ 'command': 'guest-network-get-route',
> +  'returns': ['GuestNetworkRoute']
> +}
> --
> 2.40.1
>
>

[-- Attachment #2: Type: text/html, Size: 9251 bytes --]