[thirdparty/lldpd.git] / src / daemon / lldpd.h

/* -*- mode: c; c-file-style: "openbsd" -*- */
/*
 * Copyright (c) 2008 Vincent Bernat <bernat@luffy.cx>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef _LLDPD_H
#define _LLDPD_H
#define _GNU_SOURCE 1

#if HAVE_CONFIG_H
#  include <config.h>
#endif

#ifdef HAVE_VALGRIND_VALGRIND_H
# include <valgrind/valgrind.h>
#else
# define RUNNING_ON_VALGRIND 0
#endif

#include <stdlib.h>
#include <stddef.h>
#include <string.h>
#include <sys/queue.h>
#include <sys/types.h>
#include <net/ethernet.h>
#include <netinet/in.h>
#include <sys/un.h>

#include "lldp-tlv.h"
#if defined (ENABLE_CDP) || defined (ENABLE_FDP)
#  include "cdp.h"
#endif
#ifdef ENABLE_SONMP
#  include "sonmp.h"
#endif
#ifdef ENABLE_EDP
#  include "edp.h"
#endif

#include "../compat/compat.h"
#include "../marshal.h"
#include "../log.h"
#include "../ctl.h"
#include "../lldpd-structs.h"

/* We don't want to import event2/event.h. We only need those as
   opaque structs. */
struct event;
struct event_base;

#define SYSFS_CLASS_NET "/sys/class/net/"
#define SYSFS_CLASS_DMI "/sys/class/dmi/id/"
#define LLDPD_TTL		120
#define LLDPD_TX_INTERVAL	30
#define LLDPD_TX_MSGDELAY	1
#define LLDPD_PID_FILE		"/var/run/lldpd.pid"

#define USING_AGENTX_SUBAGENT_MODULE 1

#define PROTO_SEND_SIG struct lldpd *, struct lldpd_hardware *
#define PROTO_DECODE_SIG struct lldpd *, char *, int, struct lldpd_hardware *, struct lldpd_chassis **, struct lldpd_port **
#define PROTO_GUESS_SIG char *, int

struct protocol {
	int		 mode;		/* > 0 mode identifier (unique per protocol) */
	int		 enabled;	/* Is this protocol enabled? */
	char		*name;		/* Name of protocol */
	char		 arg;		/* Argument to enable this protocol */
	int(*send)(PROTO_SEND_SIG);	/* How to send a frame */
	int(*decode)(PROTO_DECODE_SIG); /* How to decode a frame */
	int(*guess)(PROTO_GUESS_SIG);   /* Can be NULL, use MAC address in this case */
	u_int8_t	 mac[ETH_ALEN];  /* Destination MAC address used by this protocol */
};

#define SMART_HIDDEN(port) (port->p_hidden_in)

struct lldpd {
	int			 g_sock;
	struct event_base	*g_base;
#ifdef USE_SNMP
#endif

	struct lldpd_config	 g_config;

	struct protocol		*g_protocols;
	time_t			 g_lastsent;
	int			 g_lastrid;
	struct event		*g_main_loop;
#ifdef USE_SNMP
	int			 g_snmp;
	struct event		*g_snmp_timeout;
	void			*g_snmp_fds;
	char			*g_snmp_agentx;
#endif /* USE_SNMP */

	/* Unix socket handling */
	int			 g_ctl;
	struct event		*g_ctl_event;

	char			*g_lsb_release;

#define LOCAL_CHASSIS(cfg) ((struct lldpd_chassis *)(TAILQ_FIRST(&cfg->g_chassis)))
	TAILQ_HEAD(, lldpd_chassis) g_chassis;
	TAILQ_HEAD(, lldpd_hardware) g_hardware;
};

/* lldpd.c */
struct lldpd_hardware	*lldpd_get_hardware(struct lldpd *,
    char *, int, struct lldpd_ops *);
struct lldpd_hardware	*lldpd_alloc_hardware(struct lldpd *, char *, int);
void	 lldpd_hardware_cleanup(struct lldpd*, struct lldpd_hardware *);
struct lldpd_mgmt *lldpd_alloc_mgmt(int family, void *addr, size_t addrsize, u_int32_t iface);
void	 lldpd_recv(struct lldpd *, struct lldpd_hardware *, int);
void	 lldpd_loop(struct lldpd *);
int	 lldpd_main(int, char **);

/* event.c */
void	 levent_loop(struct lldpd *);
void	 levent_hardware_init(struct lldpd_hardware *);
void	 levent_hardware_add_fd(struct lldpd_hardware *, int);
void	 levent_hardware_release(struct lldpd_hardware *);
void	 levent_ctl_notify(char *, int, struct lldpd_port *);
void	 levent_send_now(struct lldpd *);

/* lldp.c */
int	 lldp_send(PROTO_SEND_SIG);
int	 lldp_decode(PROTO_DECODE_SIG);

/* cdp.c */
#ifdef ENABLE_CDP
int	 cdpv1_send(PROTO_SEND_SIG);
int	 cdpv2_send(PROTO_SEND_SIG);
int	 cdpv1_guess(PROTO_GUESS_SIG);
int	 cdpv2_guess(PROTO_GUESS_SIG);
#endif
#if defined (ENABLE_CDP) || defined (ENABLE_FDP)
int	 cdp_decode(PROTO_DECODE_SIG);
#endif
#ifdef ENABLE_FDP
int	 fdp_send(PROTO_SEND_SIG);
#endif

#ifdef ENABLE_SONMP
/* sonmp.c */
int	 sonmp_send(PROTO_SEND_SIG);
int	 sonmp_decode(PROTO_DECODE_SIG);
#endif

#ifdef ENABLE_EDP
/* edp.c */
int	 edp_send(PROTO_SEND_SIG);
int	 edp_decode(PROTO_DECODE_SIG);
#endif

/* dmi.c */
#ifdef ENABLE_LLDPMED
char	*dmi_hw(void);
char	*dmi_fw(void);
char	*dmi_sn(void);
char	*dmi_manuf(void);
char	*dmi_model(void);
char	*dmi_asset(void);
#endif

#ifdef USE_SNMP
/* agent.c */
void		 agent_shutdown(void);
void		 agent_init(struct lldpd *, char *);
void		 agent_notify(struct lldpd_hardware *, int, struct lldpd_port *);
#endif

/* agent_priv.c */
void		 agent_priv_register_domain(void);

/* client.c */
int
client_handle_client(struct lldpd *cfg,
    ssize_t(*send)(void *, int, void *, size_t),
    void *,
    enum hmsg_type type, void *buffer, size_t n,
    int*);

/* priv.c */
void	 priv_init(char*, int, uid_t, gid_t);
void	 priv_ctl_cleanup(void);
char   	*priv_gethostbyname(void);
int    	 priv_open(char*);
#ifdef HOST_OS_LINUX
int    	 priv_ethtool(char*, void*, size_t);
#endif
int    	 priv_iface_init(int);
int	 priv_iface_multicast(const char *, u_int8_t *, int);
int	 priv_snmp_socket(struct sockaddr_un *);

/* privsep_fdpass.c */
int	 receive_fd(int);
void	 send_fd(int, int);

/* interfaces-*.c */
void     interfaces_update(struct lldpd *);

#ifdef HOST_OS_LINUX
/* netlink stuff */
struct netlink_interface {
	TAILQ_ENTRY(netlink_interface) next;
	int   index;		/* Index */
	char *name;		/* Name */
	char *alias;		/* Alias */
	int   flags;		/* Flags */
	int   mtu;		/* MTU */
	char *address;		/* MAC address */
	int   type;		/* Type (ARPHDR_*) */
	int   link;		/* Support interface */
	int   master;		/* Master interface */
	int   txqueue;		/* TX queue len */
};
struct netlink_address {
	TAILQ_ENTRY(netlink_address) next;
	int index;		/* Index */
	int flags;		/* Flags */
	struct sockaddr_storage address; /* Address */
};
TAILQ_HEAD(netlink_interface_list, netlink_interface);
TAILQ_HEAD(netlink_address_list, netlink_address);
struct netlink_interface_list *netlink_get_interfaces(void);
struct netlink_address_list *netlink_get_addresses(void);
void netlink_free_interfaces(struct netlink_interface_list *);
void netlink_free_addresses(struct netlink_address_list *);
#endif

#endif /* _LLDPD_H */
Commit	Line	Data
4b292b55 VB	1	/* -- mode: c; c-file-style: "openbsd" -- */
	2	/*
	3	* Copyright (c) 2008 Vincent Bernat <bernat@luffy.cx>
	4	*
	5	* Permission to use, copy, modify, and/or distribute this software for any
	6	* purpose with or without fee is hereby granted, provided that the above
	7	* copyright notice and this permission notice appear in all copies.
	8	*
	9	* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
	10	* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
	11	* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
	12	* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
	13	* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
	14	* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
	15	* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
	16	*/
	17
	18	#ifndef _LLDPD_H
	19	#define _LLDPD_H
5d6aba3e	20	#define _GNU_SOURCE 1
4b292b55 VB	21
	22	#if HAVE_CONFIG_H
	23	# include <config.h>
	24	#endif
	25
	26	#ifdef HAVE_VALGRIND_VALGRIND_H
	27	# include <valgrind/valgrind.h>
	28	#else
	29	# define RUNNING_ON_VALGRIND 0
	30	#endif
	31
4b292b55 VB	32	#include <stdlib.h>
	33	#include <stddef.h>
	34	#include <string.h>
	35	#include <sys/queue.h>
e12c2365	36	#include <sys/types.h>
4b292b55 VB	37	#include <net/ethernet.h>
4b292b55 VB	38	#include <netinet/in.h>
4b292b55 VB	39	#include <sys/un.h>
	40
	41	#include "lldp-tlv.h"
	42	#if defined (ENABLE_CDP) \|\| defined (ENABLE_FDP)
	43	# include "cdp.h"
	44	#endif
	45	#ifdef ENABLE_SONMP
	46	# include "sonmp.h"
	47	#endif
	48	#ifdef ENABLE_EDP
	49	# include "edp.h"
	50	#endif
	51
	52	#include "../compat/compat.h"
	53	#include "../marshal.h"
	54	#include "../log.h"
	55	#include "../ctl.h"
	56	#include "../lldpd-structs.h"
	57
	58	/* We don't want to import event2/event.h. We only need those as
	59	opaque structs. */
	60	struct event;
	61	struct event_base;
	62
	63	#define SYSFS_CLASS_NET "/sys/class/net/"
	64	#define SYSFS_CLASS_DMI "/sys/class/dmi/id/"
	65	#define LLDPD_TTL 120
8843f168	66	#define LLDPD_TX_INTERVAL 30
4b292b55 VB	67	#define LLDPD_TX_MSGDELAY 1
	68	#define LLDPD_PID_FILE "/var/run/lldpd.pid"
	69
	70	#define USING_AGENTX_SUBAGENT_MODULE 1
	71
	72	#define PROTO_SEND_SIG struct lldpd , struct lldpd_hardware
	73	#define PROTO_DECODE_SIG struct lldpd , char , int, struct lldpd_hardware , struct lldpd_chassis , struct lldpd_port *
	74	#define PROTO_GUESS_SIG char *, int
	75
	76	struct protocol {
	77	int mode; /* > 0 mode identifier (unique per protocol) */
	78	int enabled; /* Is this protocol enabled? */
	79	char name; / Name of protocol */
	80	char arg; /* Argument to enable this protocol */
	81	int(send)(PROTO_SEND_SIG); / How to send a frame */
	82	int(decode)(PROTO_DECODE_SIG); / How to decode a frame */
	83	int(guess)(PROTO_GUESS_SIG); / Can be NULL, use MAC address in this case */
	84	u_int8_t mac[ETH_ALEN]; /* Destination MAC address used by this protocol */
	85	};
	86
4b292b55 VB	87	#define SMART_HIDDEN(port) (port->p_hidden_in)
	88
	89	struct lldpd {
	90	int g_sock;
4b292b55 VB	91	struct event_base *g_base;
	92	#ifdef USE_SNMP
	93	#endif
	94
8ec333bd VB	95	struct lldpd_config g_config;
8ec333bd VB	96
4b292b55 VB	97	struct protocol *g_protocols;
	98	time_t g_lastsent;
	99	int g_lastrid;
4b292b55 VB	100	struct event *g_main_loop;
	101	#ifdef USE_SNMP
	102	int g_snmp;
	103	struct event *g_snmp_timeout;
	104	void *g_snmp_fds;
	105	char *g_snmp_agentx;
	106	#endif /* USE_SNMP */
	107
	108	/* Unix socket handling */
	109	int g_ctl;
	110	struct event *g_ctl_event;
	111
4b292b55	112	char *g_lsb_release;
4b292b55 VB	113
	114	#define LOCAL_CHASSIS(cfg) ((struct lldpd_chassis *)(TAILQ_FIRST(&cfg->g_chassis)))
	115	TAILQ_HEAD(, lldpd_chassis) g_chassis;
	116	TAILQ_HEAD(, lldpd_hardware) g_hardware;
	117	};
	118
4b292b55 VB	119	/* lldpd.c */
	120	struct lldpd_hardware lldpd_get_hardware(struct lldpd ,
	121	char , int, struct lldpd_ops );
e12c2365	122	struct lldpd_hardware lldpd_alloc_hardware(struct lldpd , char *, int);
4b292b55 VB	123	void lldpd_hardware_cleanup(struct lldpd, struct lldpd_hardware );
	124	struct lldpd_mgmt lldpd_alloc_mgmt(int family, void addr, size_t addrsize, u_int32_t iface);
	125	void lldpd_recv(struct lldpd , struct lldpd_hardware , int);
	126	void lldpd_loop(struct lldpd *);
	127	int lldpd_main(int, char **);
	128
	129	/* event.c */
	130	void levent_loop(struct lldpd *);
	131	void levent_hardware_init(struct lldpd_hardware *);
	132	void levent_hardware_add_fd(struct lldpd_hardware *, int);
	133	void levent_hardware_release(struct lldpd_hardware *);
4e90a9e0	134	void levent_ctl_notify(char , int, struct lldpd_port );
47287a61	135	void levent_send_now(struct lldpd *);
4b292b55 VB	136
	137	/* lldp.c */
	138	int lldp_send(PROTO_SEND_SIG);
	139	int lldp_decode(PROTO_DECODE_SIG);
	140
	141	/* cdp.c */
	142	#ifdef ENABLE_CDP
	143	int cdpv1_send(PROTO_SEND_SIG);
	144	int cdpv2_send(PROTO_SEND_SIG);
	145	int cdpv1_guess(PROTO_GUESS_SIG);
	146	int cdpv2_guess(PROTO_GUESS_SIG);
	147	#endif
	148	#if defined (ENABLE_CDP) \|\| defined (ENABLE_FDP)
	149	int cdp_decode(PROTO_DECODE_SIG);
	150	#endif
	151	#ifdef ENABLE_FDP
	152	int fdp_send(PROTO_SEND_SIG);
	153	#endif
	154
	155	#ifdef ENABLE_SONMP
	156	/* sonmp.c */
	157	int sonmp_send(PROTO_SEND_SIG);
	158	int sonmp_decode(PROTO_DECODE_SIG);
	159	#endif
	160
	161	#ifdef ENABLE_EDP
	162	/* edp.c */
	163	int edp_send(PROTO_SEND_SIG);
	164	int edp_decode(PROTO_DECODE_SIG);
	165	#endif
	166
4b292b55 VB	167	/* dmi.c */
4b292b55 VB	168	#ifdef ENABLE_LLDPMED
4b292b55 VB	169	char *dmi_hw(void);
	170	char *dmi_fw(void);
	171	char *dmi_sn(void);
	172	char *dmi_manuf(void);
	173	char *dmi_model(void);
	174	char *dmi_asset(void);
	175	#endif
4b292b55	176
25de85a4	177	#ifdef USE_SNMP
4b292b55 VB	178	/* agent.c */
	179	void agent_shutdown(void);
	180	void agent_init(struct lldpd , char );
25de85a4 VB	181	void agent_notify(struct lldpd_hardware , int, struct lldpd_port );
25de85a4 VB	182	#endif
4b292b55 VB	183
	184	/* agent_priv.c */
	185	void agent_priv_register_domain(void);
	186
	187	/* client.c */
e0478a46 VB	188	int
	189	client_handle_client(struct lldpd *cfg,
	190	ssize_t(send)(void , int, void *, size_t),
	191	void *,
4e90a9e0 VB	192	enum hmsg_type type, void *buffer, size_t n,
4e90a9e0 VB	193	int*);
4b292b55 VB	194
	195	/* priv.c */
	196	void priv_init(char*, int, uid_t, gid_t);
	197	void priv_ctl_cleanup(void);
	198	char *priv_gethostbyname(void);
	199	int priv_open(char*);
e12c2365 VB	200	#ifdef HOST_OS_LINUX
	201	int priv_ethtool(char, void, size_t);
	202	#endif
	203	int priv_iface_init(int);
4b292b55 VB	204	int priv_iface_multicast(const char , u_int8_t , int);
	205	int priv_snmp_socket(struct sockaddr_un *);
	206
	207	/* privsep_fdpass.c */
	208	int receive_fd(int);
	209	void send_fd(int, int);
	210
e12c2365 VB	211	/* interfaces-.c /
	212	void interfaces_update(struct lldpd *);
	213
	214	#ifdef HOST_OS_LINUX
	215	/* netlink stuff */
	216	struct netlink_interface {
	217	TAILQ_ENTRY(netlink_interface) next;
	218	int index; /* Index */
	219	char name; / Name */
	220	char alias; / Alias */
	221	int flags; /* Flags */
	222	int mtu; /* MTU */
	223	char address; / MAC address */
	224	int type; /* Type (ARPHDR_) /
	225	int link; /* Support interface */
	226	int master; /* Master interface */
	227	int txqueue; /* TX queue len */
	228	};
	229	struct netlink_address {
	230	TAILQ_ENTRY(netlink_address) next;
	231	int index; /* Index */
	232	int flags; /* Flags */
	233	struct sockaddr_storage address; /* Address */
	234	};
	235	TAILQ_HEAD(netlink_interface_list, netlink_interface);
	236	TAILQ_HEAD(netlink_address_list, netlink_address);
	237	struct netlink_interface_list *netlink_get_interfaces(void);
	238	struct netlink_address_list *netlink_get_addresses(void);
	239	void netlink_free_interfaces(struct netlink_interface_list *);
	240	void netlink_free_addresses(struct netlink_address_list *);
	241	#endif
	242
4b292b55	243	#endif /* _LLDPD_H */