[ovs.git] / lib / rtnetlink.h

/*
 * Copyright (c) 2009, 2015 Nicira, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef RTNETLINK_LINK_H
#define RTNETLINK_LINK_H 1

#include <stdbool.h>
#include <stdint.h>
#include <linux/if_ether.h>

#include "openvswitch/types.h"

struct ofpbuf;
struct nln_notifier;

/* These functions are Linux specific, so they should be used directly only by
 * Linux-specific code. */

/* A digested version of an rtnetlink_link message sent down by the kernel to
 * indicate that a network device's status (link or address) has been changed.
 */
struct rtnetlink_change {
    /* Copied from struct nlmsghdr. */
    int nlmsg_type;             /* e.g. RTM_NEWLINK, RTM_DELLINK. */

    /* Common attributes. */
    int if_index;               /* Index of network device. */
    const char *ifname;         /* Name of network device. */

    /* Network device link status. */
    int master_ifindex;         /* Ifindex of datapath master (0 if none). */
    int mtu;                    /* Current MTU. */
    struct eth_addr mac;
    unsigned int ifi_flags;     /* Flags of network device. */

    /* Network device address status. */
    /* xxx To be added when needed. */
};

/* Function called to report that a netdev has changed.  'change' describes the
 * specific change.  It may be null if the buffer of change information
 * overflowed, in which case the function must assume that every device may
 * have changed.  'aux' is as specified in the call to
 * rtnetlink_notifier_register().  */
typedef
void rtnetlink_notify_func(const struct rtnetlink_change *change,
                           void *aux);

bool rtnetlink_type_is_rtnlgrp_link(uint16_t type);
bool rtnetlink_type_is_rtnlgrp_addr(uint16_t type);
bool rtnetlink_parse(struct ofpbuf *buf, struct rtnetlink_change *change);
struct nln_notifier *
rtnetlink_notifier_create(rtnetlink_notify_func *, void *aux);
void rtnetlink_notifier_destroy(struct nln_notifier *);
void rtnetlink_run(void);
void rtnetlink_wait(void);
#endif /* rtnetlink.h */
Commit	Line	Data
	1	/*
	2	* Copyright (c) 2009, 2015 Nicira, Inc.
	3	*
	4	* Licensed under the Apache License, Version 2.0 (the "License");
	5	* you may not use this file except in compliance with the License.
	6	* You may obtain a copy of the License at:
	7	*
	8	* http://www.apache.org/licenses/LICENSE-2.0
	9	*
	10	* Unless required by applicable law or agreed to in writing, software
	11	* distributed under the License is distributed on an "AS IS" BASIS,
	12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	13	* See the License for the specific language governing permissions and
	14	* limitations under the License.
	15	*/
	16
	17	#ifndef RTNETLINK_LINK_H
	18	#define RTNETLINK_LINK_H 1
	19
	20	#include <stdbool.h>
	21	#include <stdint.h>
	22	#include <linux/if_ether.h>
	23
	24	#include "openvswitch/types.h"
	25
	26	struct ofpbuf;
	27	struct nln_notifier;
	28
	29	/* These functions are Linux specific, so they should be used directly only by
	30	* Linux-specific code. */
	31
	32	/* A digested version of an rtnetlink_link message sent down by the kernel to
	33	* indicate that a network device's status (link or address) has been changed.
	34	*/
	35	struct rtnetlink_change {
	36	/* Copied from struct nlmsghdr. */
	37	int nlmsg_type; /* e.g. RTM_NEWLINK, RTM_DELLINK. */
	38
	39	/* Common attributes. */
	40	int if_index; /* Index of network device. */
	41	const char ifname; / Name of network device. */
	42
	43	/* Network device link status. */
	44	int master_ifindex; /* Ifindex of datapath master (0 if none). */
	45	int mtu; /* Current MTU. */
	46	struct eth_addr mac;
	47	unsigned int ifi_flags; /* Flags of network device. */
	48
	49	/* Network device address status. */
	50	/* xxx To be added when needed. */
	51	};
	52
	53	/* Function called to report that a netdev has changed. 'change' describes the
	54	* specific change. It may be null if the buffer of change information
	55	* overflowed, in which case the function must assume that every device may
	56	* have changed. 'aux' is as specified in the call to
	57	* rtnetlink_notifier_register(). */
	58	typedef
	59	void rtnetlink_notify_func(const struct rtnetlink_change *change,
	60	void *aux);
	61
	62	bool rtnetlink_type_is_rtnlgrp_link(uint16_t type);
	63	bool rtnetlink_type_is_rtnlgrp_addr(uint16_t type);
	64	bool rtnetlink_parse(struct ofpbuf buf, struct rtnetlink_change change);
	65	struct nln_notifier *
	66	rtnetlink_notifier_create(rtnetlink_notify_func , void aux);
	67	void rtnetlink_notifier_destroy(struct nln_notifier *);
	68	void rtnetlink_run(void);
	69	void rtnetlink_wait(void);
	70	#endif /* rtnetlink.h */