/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
* Copyright (C) 2007 - 2008 Novell, Inc.
* Copyright (C) 2007 - 2011 Red Hat, Inc.
*/
#ifndef __NETWORKMANAGER_DEVICE_PRIVATE_H__
#define __NETWORKMANAGER_DEVICE_PRIVATE_H__
#include "nm-device.h"
/* This file should only be used by subclasses of NMDevice */
typedef enum {
NM_DEVICE_STAGE_STATE_INIT = 0,
NM_DEVICE_STAGE_STATE_PENDING = 1,
NM_DEVICE_STAGE_STATE_COMPLETED = 2,
} NMDeviceStageState;
typedef enum {
NM_DEVICE_IP_STATE_NONE,
NM_DEVICE_IP_STATE_WAIT,
NM_DEVICE_IP_STATE_CONF,
NM_DEVICE_IP_STATE_DONE,
NM_DEVICE_IP_STATE_FAIL,
} NMDeviceIPState;
enum NMActStageReturn {
NM_ACT_STAGE_RETURN_FAILURE = 0, /* Hard failure of activation */
NM_ACT_STAGE_RETURN_SUCCESS, /* Activation stage done */
NM_ACT_STAGE_RETURN_POSTPONE, /* Long-running operation in progress */
NM_ACT_STAGE_RETURN_IP_WAIT, /* IP config stage is waiting (state IP_WAIT) */
NM_ACT_STAGE_RETURN_IP_DONE, /* IP config stage is done (state IP_DONE),
* For the ip-config stage, this is similar to
* NM_ACT_STAGE_RETURN_SUCCESS, except that no
* IP config should be committed. */
NM_ACT_STAGE_RETURN_IP_FAIL, /* IP config stage failed (state IP_FAIL), activation may proceed */
};
#define NM_DEVICE_CAP_NONSTANDARD_CARRIER 0x80000000
#define NM_DEVICE_CAP_IS_NON_KERNEL 0x40000000
#define NM_DEVICE_CAP_INTERNAL_MASK 0xc0000000
void nm_device_arp_announce(NMDevice *self);
NMSettings *nm_device_get_settings(NMDevice *self);
NMManager *nm_device_get_manager(NMDevice *self);
gboolean nm_device_set_ip_ifindex(NMDevice *self, int ifindex);
gboolean nm_device_set_ip_iface(NMDevice *self, const char *iface);
void nm_device_activate_schedule_stage3_ip_config_start(NMDevice *device);
gboolean nm_device_activate_stage3_ip_start(NMDevice *self, int addr_family);
gboolean nm_device_bring_up(NMDevice *self, gboolean wait, gboolean *no_firmware);
void nm_device_take_down(NMDevice *self, gboolean block);
gboolean nm_device_take_over_link(NMDevice *self, int ifindex, char **old_name, GError **error);
gboolean nm_device_hw_addr_set(NMDevice * device,
const char *addr,
const char *detail,
gboolean set_permanent);
gboolean nm_device_hw_addr_set_cloned(NMDevice *device, NMConnection *connection, gboolean is_wifi);
gboolean nm_device_hw_addr_reset(NMDevice *device, const char *detail);
void nm_device_set_firmware_missing(NMDevice *self, gboolean missing);
void nm_device_activate_schedule_stage1_device_prepare(NMDevice *device, gboolean do_sync);
void nm_device_activate_schedule_stage2_device_config(NMDevice *device, gboolean do_sync);
void
nm_device_activate_schedule_ip_config_result(NMDevice *device, int addr_family, NMIPConfig *config);
void nm_device_activate_schedule_ip_config_timeout(NMDevice *device, int addr_family);
NMDeviceIPState nm_device_activate_get_ip_state(NMDevice *self, int addr_family);
static inline gboolean
nm_device_activate_ip4_state_in_conf(NMDevice *self)
{
return nm_device_activate_get_ip_state(self, AF_INET) == NM_DEVICE_IP_STATE_CONF;
}
static inline gboolean
nm_device_activate_ip4_state_in_wait(NMDevice *self)
{
return nm_device_activate_get_ip_state(self, AF_INET) == NM_DEVICE_IP_STATE_WAIT;
}
static inline gboolean
nm_device_activate_ip4_state_done(NMDevice *self)
{
return nm_device_activate_get_ip_state(self, AF_INET) == NM_DEVICE_IP_STATE_DONE;
}
static inline gboolean
nm_device_activate_ip6_state_in_conf(NMDevice *self)
{
return nm_device_activate_get_ip_state(self, AF_INET6) == NM_DEVICE_IP_STATE_CONF;
}
static inline gboolean
nm_device_activate_ip6_state_in_wait(NMDevice *self)
{
return nm_device_activate_get_ip_state(self, AF_INET6) == NM_DEVICE_IP_STATE_WAIT;
}
static inline gboolean
nm_device_activate_ip6_state_done(NMDevice *self)
{
return nm_device_activate_get_ip_state(self, AF_INET6) == NM_DEVICE_IP_STATE_DONE;
}
void nm_device_set_dhcp_anycast_address(NMDevice *device, const char *addr);
gboolean nm_device_dhcp4_renew(NMDevice *device, gboolean release);
gboolean nm_device_dhcp6_renew(NMDevice *device, gboolean release);
void nm_device_recheck_available_connections(NMDevice *device);
void
nm_device_master_check_slave_physical_port(NMDevice *self, NMDevice *slave, NMLogDomain log_domain);
void nm_device_set_carrier(NMDevice *self, gboolean carrier);
void nm_device_queue_recheck_assume(NMDevice *device);
void nm_device_queue_recheck_available(NMDevice * device,
NMDeviceStateReason available_reason,
NMDeviceStateReason unavailable_reason);
void nm_device_set_dev2_ip_config(NMDevice *device, int addr_family, NMIPConfig *config);
gboolean nm_device_hw_addr_is_explict(NMDevice *device);
void nm_device_ip_method_failed(NMDevice *self, int addr_family, NMDeviceStateReason reason);
gboolean nm_device_sysctl_ip_conf_set(NMDevice * self,
int addr_family,
const char *property,
const char *value);
NMIP4Config *nm_device_ip4_config_new(NMDevice *self);
NMIP6Config *nm_device_ip6_config_new(NMDevice *self);
NMIPConfig *nm_device_ip_config_new(NMDevice *self, int addr_family);
NML3ConfigData *nm_device_create_l3_config_data(NMDevice *self);
/*****************************************************************************/
gint64 nm_device_get_configured_mtu_from_connection_default(NMDevice * self,
const char *property_name,
guint32 max_mtu);
guint32 nm_device_get_configured_mtu_from_connection(NMDevice * device,
GType setting_type,
NMDeviceMtuSource *out_source);
guint32 nm_device_get_configured_mtu_for_wired(NMDevice * self,
NMDeviceMtuSource *out_source,
gboolean * out_force);
guint32 nm_device_get_configured_mtu_wired_parent(NMDevice * self,
NMDeviceMtuSource *out_source,
gboolean * out_force);
void nm_device_commit_mtu(NMDevice *self);
/*****************************************************************************/
#define NM_DEVICE_DEFINE_LINK_TYPES(...) \
((NM_NARG(__VA_ARGS__) == 0) ? NULL : ({ \
static const NMLinkType _types[NM_NARG(__VA_ARGS__) + 1] = { \
__VA_ARGS__ _NM_MACRO_COMMA_IF_ARGS(__VA_ARGS__) NM_LINK_TYPE_NONE, \
}; \
\
nm_assert(_types[NM_NARG(__VA_ARGS__)] == NM_LINK_TYPE_NONE); \
_types; \
}))
gboolean _nm_device_hash_check_invalid_keys(GHashTable * hash,
const char * setting_name,
GError ** error,
const char *const *whitelist);
#define nm_device_hash_check_invalid_keys(hash, setting_name, error, ...) \
_nm_device_hash_check_invalid_keys(hash, setting_name, error, NM_MAKE_STRV(__VA_ARGS__))
gboolean nm_device_match_parent(NMDevice *device, const char *parent);
gboolean nm_device_match_parent_hwaddr(NMDevice * device,
NMConnection *connection,
gboolean fail_if_no_hwaddr);
/*****************************************************************************/
void nm_device_auth_request(NMDevice * self,
GDBusMethodInvocation * context,
NMConnection * connection,
const char * permission,
gboolean allow_interaction,
GCancellable * cancellable,
NMManagerDeviceAuthRequestFunc callback,
gpointer user_data);
#endif /* NM_DEVICE_PRIVATE_H */