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

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 | 73 ++++++++++++++++++++++++++++++++++++++++++++
 qga/commands-win32.c |  6 ++++
 qga/qapi-schema.json | 68 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 147 insertions(+)

On Wed, Jun 12, 2024 at 7:36 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 | 73 ++++++++++++++++++++++++++++++++++++++++++++
>  qga/commands-win32.c |  6 ++++
>  qga/qapi-schema.json | 68 +++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 147 insertions(+)
>
> diff --git a/qga/commands-posix.c b/qga/commands-posix.c
> index 6169bbf7a0..ffae88ca69 100644
> --- a/qga/commands-posix.c
> +++ b/qga/commands-posix.c
> @@ -2747,6 +2747,73 @@ GuestCpuStatsList *qmp_guest_get_cpustats(Error
> **errp)
>      return head;
>  }
>
> +char *hexToIPAddress(unsigned int hexValue, char ipAddress[16]);
> +char *hexToIPAddress(unsigned int hexValue, char ipAddress[16])
> +{
> +    unsigned int byte1 = (hexValue >> 24) & 0xFF;
> +    unsigned int byte2 = (hexValue >> 16) & 0xFF;
> +    unsigned int byte3 = (hexValue >> 8) & 0xFF;
> +    unsigned int byte4 = hexValue & 0xFF;
> +
> +    snprintf(ipAddress, 16, "%u.%u.%u.%u", byte4, byte3, byte2, byte1);
> +
> +    return ipAddress;
> +}
> +
> +GuestNetworkRouteStatList *qmp_guest_network_get_route(Error **errp)
> +{
> +    GuestNetworkRouteStatList *head = NULL, **tail = &head;
> +    const char *routeFile = "/proc/net/route";
> +    FILE *fp;
> +    size_t n;
> +    char *line = NULL;
> +
> +    fp = fopen(routeFile, "r");
> +    if (fp == NULL) {
> +        error_setg_errno(errp, errno, "open(\"%s\")", routeFile);
> +        return NULL;
> +    }
> +
> +    while (getline(&line, &n, fp) != -1) {
> +        GuestNetworkRouteStat *networkroute;
> +        int i;
> +        char Iface[16];
> +        unsigned int Destination, Gateway, Mask, Flags;
> +        int RefCnt, Use, Metric, MTU, Window, IRTT;
> +
> +        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;
> +        }
> +
> +        networkroute = g_new0(GuestNetworkRouteStat, 1);
> +
> +        char DestAddress[16];
> +        char GateAddress[16];
> +        char MaskAddress[16];
> +
> +        networkroute->iface = g_strdup(Iface);
> +        networkroute->destination = g_strdup(hexToIPAddress(Destination,
> DestAddress));
> +        networkroute->gateway = g_strdup(hexToIPAddress(Gateway,
> GateAddress));
> +        networkroute->mask = g_strdup(hexToIPAddress(Mask, MaskAddress));
> +        networkroute->metric = Metric;
> +        networkroute->flags = Flags;
> +        networkroute->refcnt = RefCnt;
> +        networkroute->use = Use;
> +        networkroute->mtu = MTU;
> +        networkroute->window = Window;
> +        networkroute->irtt = IRTT;
> +
> +        QAPI_LIST_APPEND(tail, networkroute);
> +    }
> +
> +    free(line);
> +    fclose(fp);
> +    return head;
> +}
> +
>  #else /* defined(__linux__) */
>
>  void qmp_guest_suspend_disk(Error **errp)
> @@ -3118,6 +3185,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..195f6cd4e7 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -1789,3 +1789,71 @@
>  { 'command': 'guest-get-cpustats',
>    'returns': ['GuestCpuStats']
>  }
> +
> +##
> +# @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 metricls
> +#
> +# @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: 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.
> +#
> +# @routes: A list of network route information.
> +#
> +# Since: 9.1
> +##
> +{ 'struct': 'GuestNetworkRoute',
> +  'data': { 'routes': ['GuestNetworkRouteStat'] } }
>

This struct is unused anymore, so remove it and
rename GuestNetworkRouteStat to GuestNetworkRoute.


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