Socket

Handle representing a netlink socket. More...

Allocation
struct nl_handle *	nl_handle_alloc (void)
	Allocate new netlink socket handle.
struct nl_handle *	nl_handle_alloc_cb (struct nl_cb *cb)
	Allocate new socket handle with custom callbacks.
void	nl_handle_destroy (struct nl_handle *handle)
	Destroy netlink handle.

Sequence Numbers
void	nl_disable_sequence_check (struct nl_handle *handle)
	Disable sequence number checking.
unsigned int	nl_socket_use_seq (struct nl_handle *handle)
	Use next sequence number.

Source Idenficiation
uint32_t	nl_socket_get_local_port (struct nl_handle *handle)
void	nl_socket_set_local_port (struct nl_handle *handle, uint32_t port)
	Set local port of socket.

Group Subscriptions
int	nl_socket_add_membership (struct nl_handle *handle, int group)
	Join a group.
int	nl_socket_drop_membership (struct nl_handle *handle, int group)
	Leave a group.
void	nl_join_groups (struct nl_handle *handle, int groups)
	Join multicast groups (deprecated)

Peer Identfication
uint32_t	nl_socket_get_peer_port (struct nl_handle *handle)
void	nl_socket_set_peer_port (struct nl_handle *handle, uint32_t port)

File Descriptor
int	nl_socket_get_fd (struct nl_handle *handle)
int	nl_socket_set_nonblocking (struct nl_handle *handle)
	Set file descriptor of socket handle to non-blocking state.
void	nl_socket_enable_msg_peek (struct nl_handle *handle)
	Enable use of MSG_PEEK when reading from socket.
void	nl_socket_disable_msg_peek (struct nl_handle *handle)
	Disable use of MSG_PEEK when reading from socket.

Callback Handler
struct nl_cb *	nl_socket_get_cb (struct nl_handle *handle)
void	nl_socket_set_cb (struct nl_handle *handle, struct nl_cb *cb)
int	nl_socket_modify_cb (struct nl_handle *handle, enum nl_cb_type type, enum nl_cb_kind kind, nl_recvmsg_msg_cb_t func, void *arg)
	Modify the callback handler associated to the socket.

Utilities
int	nl_set_buffer_size (struct nl_handle *handle, int rxbuf, int txbuf)
	Set socket buffer size of netlink handle.
int	nl_set_passcred (struct nl_handle *handle, int state)
	Enable/disable credential passing on netlink handle.
int	nl_socket_recv_pktinfo (struct nl_handle *handle, int state)
	Enable/disable receival of additional packet information.

Detailed Description

The socket is represented in a structure called the netlink handle, besides the socket, it stores various settings and values related to the socket. Every socket handle has a mandatory association with a set of callbacks which can be used to modify the behaviour when sending/receiving data from the socket.

Socket Attributes

• Local Port: The local port is a netlink port identifying the local endpoint. It is used as source address for outgoing messages and will be addressed in replies. It must therefore be unique among all userspace applications. When the socket handle is allocated, a unique port number is generated automatically in the form of 22 bits Process Identifier + 10 bits Arbitary Number. Therefore the library is capable of generating 1024 unique local port numbers for every process. If more sockets are required, the application has to manage port numbers itself using nl_socket_set_local_port().
• Group Subscriptions: A socket can subscribe to any number of multicast groups. It will then receive a copy of all messages sent to one of the groups. This method is mainly used for event notification. Prior to kernel 2.6.14, the group subscription was done via bitmask which limited to a total number of groups of 32. With 2.6.14 a new method was added based on continous identifiers which supports an arbitary number of groups. Both methods are supported, see nl_join_groups() respectively nl_socket_add_membership() and nl_socket_drop_membership().
• Peer Port: The peer port is a netlink port identifying the peer's endpoint. If no peer port is specified, the kernel will try to autobind to a socket of the specified netlink family automatically. This is very common as typically only one listening socket exists on the kernel side. The peer port can be modified using nl_socket_set_peer_port().
• Peer Groups:
• File Descriptor: The file descriptor of the socket, it can be accessed via nl_socket_get_fd() to change socket options or monitor activity using poll()/select().
• Protocol: Once connected, the socket is bound to stick to one netlink family. This field is invisible, it is maintained automatically. (See nl_connect())
• Next Sequence Number: Next available sequence number to be used for the next message being sent out. (Initial value: UNIX time when the socket was allocated.) Sequence numbers can be used via nl_socket_use_seq().
• Expected Sequence Number: Expected sequence number in the next message received from the socket. (Initial value: Equal to next sequence number.)
• Callbacks Configuration:

1) Creating the netlink handle

struct nl_handle *handle;
 
// Allocate and initialize a new netlink handle
handle = nl_handle_alloc();
 
// Use nl_socket_get_fd() to fetch the file description, for example to
// put a socket into non-blocking i/o mode.
fcntl(nl_socket_get_fd(handle), F_SETFL, O_NONBLOCK);

2) Group Subscriptions

// Event notifications are typically sent to multicast addresses which
// represented by groups. Join a group to f.e. receive link notifications.
nl_socket_add_membership(handle, RTNLGRP_LINK);

6) Cleaning up

// Finally destroy the netlink handle
nl_handle_destroy(handle);

Function Documentation

nl_handle_alloc()

struct nl_handle * nl_handle_alloc

(

void

)

Returns

Newly allocated netlink socket handle or NULL.

Definition at line 206 of file socket.c.

{
        struct nl_cb *cb;
        struct nl_handle *sk;
 
        cb = nl_cb_alloc(default_cb);
        if (!cb) {
                nl_errno(ENOMEM);
                return NULL;
        }
 
        /* will increment cb reference count on success */
        sk = __alloc_handle(cb);
 
        nl_cb_put(cb);
 
        return sk;
}

References nl_cb_alloc().

nl_handle_alloc_cb()

struct nl_handle * nl_handle_alloc_cb

(

struct nl_cb *

cb

)

Parameters

cb	Callback handler

The reference to the callback handler is taken into account automatically, it is released again upon calling nl_handle_destroy().

Returns

Newly allocted socket handle or NULL.

Definition at line 234 of file socket.c.

{
        if (cb == NULL)
                BUG();
 
        return __alloc_handle(cb);
}

nl_handle_destroy()

void nl_handle_destroy

(

struct nl_handle *

handle

)

Parameters

handle

Netlink handle.

Definition at line 246 of file socket.c.

{
        if (!handle)
                return;
 
        if (handle->h_fd >= 0)
                close(handle->h_fd);
 
        if (!(handle->h_flags & NL_OWN_PORT))
                release_local_port(handle->h_local.nl_pid);
 
        nl_cb_put(handle->h_cb);
        free(handle);
}

Referenced by nl_cache_mngr_free().

nl_disable_sequence_check()

void nl_disable_sequence_check

(

struct nl_handle *

handle

)

Parameters

handle

Netlink handle.

Disables checking of sequence numbers on the netlink handle. This is required to allow messages to be processed which were not requested by a preceding request message, e.g. netlink events.

Note

This function modifies the NL_CB_SEQ_CHECK configuration in the callback handle associated with the socket.

Definition at line 285 of file socket.c.

{
        nl_cb_set(handle->h_cb, NL_CB_SEQ_CHECK,
                  NL_CB_CUSTOM, noop_seq_check, NULL);
}

References NL_CB_CUSTOM, NL_CB_SEQ_CHECK, and nl_cb_set().

Referenced by nl_cache_mngr_alloc().

nl_socket_use_seq()

unsigned int nl_socket_use_seq

(

struct nl_handle *

handle

)

Parameters

handle

Netlink handle

Uses the next available sequence number and increases the counter by one for subsequent calls.

Returns

Unique serial sequence number

Definition at line 300 of file socket.c.

{
        return handle->h_seq_next++;
}

nl_socket_get_local_port()

uint32_t nl_socket_get_local_port

(

struct nl_handle *

handle

)

Definition at line 312 of file socket.c.

{
        return handle->h_local.nl_pid;
}

nl_socket_set_local_port()

void nl_socket_set_local_port	(	struct nl_handle *	handle,
		uint32_t	port
	)

Parameters

handle	Netlink handle
port	Local port identifier

Assigns a local port identifier to the socket. If port is 0 a unique port identifier will be generated automatically.

Definition at line 325 of file socket.c.

{
        if (port == 0) {
                port = generate_local_port(); 
                handle->h_flags &= ~NL_OWN_PORT;
        } else  {
                if (!(handle->h_flags & NL_OWN_PORT))
                        release_local_port(handle->h_local.nl_pid);
                handle->h_flags |= NL_OWN_PORT;
        }
 
        handle->h_local.nl_pid = port;
}

nl_socket_add_membership()

int nl_socket_add_membership	(	struct nl_handle *	handle,
		int	group
	)

Parameters

handle	Netlink handle
group	Group identifier

Joins the specified group using the modern socket option which is available since kernel version 2.6.14. It allows joining an almost arbitary number of groups without limitation.

Make sure to use the correct group definitions as the older bitmask definitions for nl_join_groups() are likely to still be present for backward compatibility reasons.

Returns

0 on sucess or a negative error code.

Definition at line 361 of file socket.c.

{
        int err;
 
        if (handle->h_fd == -1)
                return nl_error(EBADFD, "Socket not connected");
 
        err = setsockopt(handle->h_fd, SOL_NETLINK, NETLINK_ADD_MEMBERSHIP,
                         &group, sizeof(group));
        if (err < 0)
                return nl_error(errno, "setsockopt(NETLINK_ADD_MEMBERSHIP) "
                                       "failed");
 
        return 0;
}

Referenced by nl_cache_mngr_add().

nl_socket_drop_membership()

int nl_socket_drop_membership	(	struct nl_handle *	handle,
		int	group
	)

Parameters

handle	Netlink handle
group	Group identifier

Leaves the specified group using the modern socket option which is available since kernel version 2.6.14.

See also

nl_socket_add_membership

Returns

0 on success or a negative error code.

Definition at line 388 of file socket.c.

{
        int err;
 
        if (handle->h_fd == -1)
                return nl_error(EBADFD, "Socket not connected");
 
        err = setsockopt(handle->h_fd, SOL_NETLINK, NETLINK_DROP_MEMBERSHIP,
                         &group, sizeof(group));
        if (err < 0)
                return nl_error(errno, "setsockopt(NETLINK_DROP_MEMBERSHIP) "
                                       "failed");
 
        return 0;
}

Referenced by nl_cache_mngr_add().

nl_join_groups()

void nl_join_groups	(	struct nl_handle *	handle,
		int	groups
	)

Parameters

handle	Netlink handle.
groups	Bitmask of groups to join.

This function defines the old way of joining multicast group which has to be done prior to calling nl_connect(). It works on any kernel version but is very limited as only 32 groups can be joined.

Definition at line 413 of file socket.c.

{
        handle->h_local.nl_groups |= groups;
}

nl_socket_get_peer_port()

uint32_t nl_socket_get_peer_port

(

struct nl_handle *

handle

)

Definition at line 426 of file socket.c.

{
        return handle->h_peer.nl_pid;
}

nl_socket_set_peer_port()

void nl_socket_set_peer_port	(	struct nl_handle *	handle,
		uint32_t	port
	)

Definition at line 431 of file socket.c.

{
        handle->h_peer.nl_pid = port;
}

nl_socket_get_fd()

int nl_socket_get_fd

(

struct nl_handle *

handle

)

Definition at line 443 of file socket.c.

{
        return handle->h_fd;
}

nl_socket_set_nonblocking()

int nl_socket_set_nonblocking

(

struct nl_handle *

handle

)

Parameters

handle

Netlink socket

Returns

0 on success or a negative error code.

Definition at line 454 of file socket.c.

{
        if (handle->h_fd == -1)
                return nl_error(EBADFD, "Socket not connected");
 
        if (fcntl(handle->h_fd, F_SETFL, O_NONBLOCK) < 0)
                return nl_error(errno, "fcntl(F_SETFL, O_NONBLOCK) failed");
 
        return 0;
}

Referenced by nl_cache_mngr_alloc().

nl_socket_enable_msg_peek()

void nl_socket_enable_msg_peek

(

struct nl_handle *

handle

)

Parameters

handle

Netlink socket

Definition at line 469 of file socket.c.

{
        handle->h_flags |= NL_MSG_PEEK;
}

nl_socket_disable_msg_peek()

void nl_socket_disable_msg_peek

(

struct nl_handle *

handle

)

Parameters

handle

Netlink socket

Definition at line 478 of file socket.c.

{
        handle->h_flags &= ~NL_MSG_PEEK;
}

nl_socket_get_cb()

struct nl_cb * nl_socket_get_cb

(

struct nl_handle *

handle

)

Definition at line 490 of file socket.c.

{
        return nl_cb_get(handle->h_cb);
}

nl_socket_set_cb()

void nl_socket_set_cb	(	struct nl_handle *	handle,
		struct nl_cb *	cb
	)

Definition at line 495 of file socket.c.

{
        if (cb == NULL)
                BUG();
 
        nl_cb_put(handle->h_cb);
        handle->h_cb = nl_cb_get(cb);
}

nl_socket_modify_cb()

int nl_socket_modify_cb	(	struct nl_handle *	handle,
		enum nl_cb_type	type,
		enum nl_cb_kind	kind,
		nl_recvmsg_msg_cb_t	func,
		void *	arg
	)

Parameters

handle	netlink handle
type	which type callback to set
kind	kind of callback
func	callback function
arg	argument to be passwd to callback function

See also

nl_cb_set

Definition at line 514 of file socket.c.

{
        return nl_cb_set(handle->h_cb, type, kind, func, arg);
}

References nl_cb_set().

Referenced by nl_cache_mngr_alloc().

nl_set_buffer_size()

int nl_set_buffer_size	(	struct nl_handle *	handle,
		int	rxbuf,
		int	txbuf
	)

Parameters

handle	Netlink handle.
rxbuf	New receive socket buffer size in bytes.
txbuf	New transmit socket buffer size in bytes.

Sets the socket buffer size of a netlink handle to the specified values rxbuf and txbuf. Providing a value of 0 assumes a good default value.

Note

It is not required to call this function prior to nl_connect().

Returns

0 on sucess or a negative error code.

Definition at line 541 of file socket.c.

{
        int err;
 
        if (rxbuf <= 0)
                rxbuf = 32768;
 
        if (txbuf <= 0)
                txbuf = 32768;
 
        if (handle->h_fd == -1)
                return nl_error(EBADFD, "Socket not connected");
        
        err = setsockopt(handle->h_fd, SOL_SOCKET, SO_SNDBUF,
                         &txbuf, sizeof(txbuf));
        if (err < 0)
                return nl_error(errno, "setsockopt(SO_SNDBUF) failed");
 
        err = setsockopt(handle->h_fd, SOL_SOCKET, SO_RCVBUF,
                         &rxbuf, sizeof(rxbuf));
        if (err < 0)
                return nl_error(errno, "setsockopt(SO_RCVBUF) failed");
 
        handle->h_flags |= NL_SOCK_BUFSIZE_SET;
 
        return 0;
}

Referenced by nl_connect().

nl_set_passcred()

int nl_set_passcred	(	struct nl_handle *	handle,
		int	state
	)

Parameters

handle	Netlink handle
state	New state (0 - disabled, 1 - enabled)

Returns

0 on success or a negative error code

Definition at line 576 of file socket.c.

{
        int err;
 
        if (handle->h_fd == -1)
                return nl_error(EBADFD, "Socket not connected");
 
        err = setsockopt(handle->h_fd, SOL_SOCKET, SO_PASSCRED,
                         &state, sizeof(state));
        if (err < 0)
                return nl_error(errno, "setsockopt(SO_PASSCRED) failed");
 
        if (state)
                handle->h_flags |= NL_SOCK_PASSCRED;
        else
                handle->h_flags &= ~NL_SOCK_PASSCRED;
 
        return 0;
}

nl_socket_recv_pktinfo()

int nl_socket_recv_pktinfo	(	struct nl_handle *	handle,
		int	state
	)

Parameters

handle	Netlink handle
state	New state (0 - disabled, 1 - enabled)

Returns

0 on success or a negative error code

Definition at line 603 of file socket.c.

{
        int err;
 
        if (handle->h_fd == -1)
                return nl_error(EBADFD, "Socket not connected");
 
        err = setsockopt(handle->h_fd, SOL_NETLINK, NETLINK_PKTINFO,
                         &state, sizeof(state));
        if (err < 0)
                return nl_error(errno, "setsockopt(NETLINK_PKTINFO) failed");
 
        return 0;
}