1 files changed, 170 insertions, 0 deletions
diff --git a/src/nm-cloud-setup/nmcs-provider.h b/src/nm-cloud-setup/nmcs-provider.h
new file mode 100644
index 00000000..36632059
--- /dev/null
+++ b/src/nm-cloud-setup/nmcs-provider.h
@@ -0,0 +1,170 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later */
+
+#ifndef __NMCS_PROVIDER_H__
+#define __NMCS_PROVIDER_H__
+
+/*****************************************************************************/
+
+#include "nm-http-client.h"
+
+/*****************************************************************************/
+
+typedef struct {
+    /* And it's exactly the same pointer that is also the key for the iface_datas
+     * dictionary. */
+    const char *hwaddr;
+
+    in_addr_t *ipv4s_arr;
+    gsize      ipv4s_len;
+
+    /* If the interface was seen, get_config() should set this to a
+     * unique, increasing, positive index. If the interface is requested,
+     * it is initialized to -1. */
+    gssize iface_idx;
+
+    in_addr_t cidr_addr;
+    in_addr_t gateway;
+    guint8    cidr_prefix;
+    bool      has_ipv4s : 1;
+    bool      has_cidr : 1;
+    bool      has_gateway : 1;
+
+    NMIPRoute **iproutes_arr;
+    gsize       iproutes_len;
+
+    /* TRUE, if the configuration was requested via hwaddrs argument to
+     * nmcs_provider_get_config(). */
+    bool was_requested : 1;
+
+} NMCSProviderGetConfigIfaceData;
+
+static inline gboolean
+nmcs_provider_get_config_iface_data_is_valid(const NMCSProviderGetConfigIfaceData *config_data)
+{
+    return config_data && config_data->iface_idx >= 0
+           && ((config_data->has_ipv4s && config_data->has_cidr) || config_data->iproutes_len);
+}
+
+NMCSProviderGetConfigIfaceData *nmcs_provider_get_config_iface_data_create(GHashTable *iface_datas,
+                                                                           gboolean was_requested,
+                                                                           const char *hwaddr);
+
+/*****************************************************************************/
+
+typedef struct {
+    /* A dictionary of (const char *) -> (NMCSProviderGetConfigIfaceData *).
+     * This is the per-interface result of get_config().
+     *
+     * The key is the same pointer as NMCSProviderGetConfigIfaceData's hwaddr. */
+    GHashTable *iface_datas;
+
+    /* The number of iface_datas that are nmcs_provider_get_config_iface_data_is_valid(). */
+    guint num_valid_ifaces;
+
+    /* the number of IPv4 addresses over all valid iface_datas. */
+    guint num_ipv4s;
+
+    guint n_iface_datas;
+
+    /* The sorted value of @iface_datas, sorted by iface_idx.
+     *
+     * Not found entries (iface_idx == -1) are sorted at the end. */
+    const NMCSProviderGetConfigIfaceData *const *iface_datas_arr;
+
+} NMCSProviderGetConfigResult;
+
+void nmcs_provider_get_config_result_free(NMCSProviderGetConfigResult *result);
+
+NM_AUTO_DEFINE_FCN0(NMCSProviderGetConfigResult *,
+                    _nm_auto_free_nmcs_provider_get_config_result,
+                    nmcs_provider_get_config_result_free);
+#define nm_auto_free_nmcs_provider_get_config_result \
+    nm_auto(_nm_auto_free_nmcs_provider_get_config_result)
+
+/*****************************************************************************/
+
+typedef struct {
+    GTask *task;
+
+    GHashTable *result_dict;
+
+    /* this cancellable should be used for the provider implementation
+     * to listen for cancellation. */
+    GCancellable *intern_cancellable;
+
+    /* the provider implementation may attach extra data. */
+    gpointer       extra_data;
+    GDestroyNotify extra_data_destroy;
+
+    gulong extern_cancelled_id;
+
+    /* the provider implementation may use this field to track the number of pending
+     * operations. */
+    guint n_pending;
+
+    bool any : 1;
+} NMCSProviderGetConfigTaskData;
+
+#define NMCS_TYPE_PROVIDER (nmcs_provider_get_type())
+#define NMCS_PROVIDER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), NMCS_TYPE_PROVIDER, NMCSProvider))
+#define NMCS_PROVIDER_CLASS(klass) \
+    (G_TYPE_CHECK_CLASS_CAST((klass), NMCS_TYPE_PROVIDER, NMCSProviderClass))
+#define NMCS_IS_PROVIDER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), NMCS_TYPE_PROVIDER))
+#define NMCS_IS_PROVIDER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), NMCS_TYPE_PROVIDER))
+#define NMCS_PROVIDER_GET_CLASS(obj) \
+    (G_TYPE_INSTANCE_GET_CLASS((obj), NMCS_TYPE_PROVIDER, NMCSProviderClass))
+
+#define NMCS_PROVIDER_HTTP_CLIENT "http-client"
+
+struct _NMCSProviderPrivate;
+
+typedef struct {
+    GObject                      parent;
+    struct _NMCSProviderPrivate *_priv;
+} NMCSProvider;
+
+typedef struct {
+    GObjectClass parent;
+    const char * _name;
+    const char * _env_provider_enabled;
+
+    void (*detect)(NMCSProvider *self, GTask *task);
+
+    void (*get_config)(NMCSProvider *self, NMCSProviderGetConfigTaskData *get_config_data);
+
+} NMCSProviderClass;
+
+GType nmcs_provider_get_type(void);
+
+/*****************************************************************************/
+
+const char *nmcs_provider_get_name(NMCSProvider *provider);
+
+NMHttpClient *nmcs_provider_get_http_client(NMCSProvider *provider);
+GMainContext *nmcs_provider_get_main_context(NMCSProvider *provider);
+
+/*****************************************************************************/
+
+void nmcs_provider_detect(NMCSProvider *      provider,
+                          GCancellable *      cancellable,
+                          GAsyncReadyCallback callback,
+                          gpointer            user_data);
+
+gboolean nmcs_provider_detect_finish(NMCSProvider *provider, GAsyncResult *result, GError **error);
+
+/*****************************************************************************/
+
+void _nmcs_provider_get_config_task_maybe_return(NMCSProviderGetConfigTaskData *get_config_data,
+                                                 GError *                       error_take);
+
+void nmcs_provider_get_config(NMCSProvider *      provider,
+                              gboolean            any,
+                              const char *const * hwaddrs,
+                              GCancellable *      cancellable,
+                              GAsyncReadyCallback callback,
+                              gpointer            user_data);
+
+NMCSProviderGetConfigResult *
+nmcs_provider_get_config_finish(NMCSProvider *provider, GAsyncResult *result, GError **error);
+
+#endif /* __NMCS_PROVIDER_H__ */