Handle representing a netlink socket.
More...
|
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. More...
|
|
|
uint32_t | nl_socket_get_peer_port (struct nl_handle *handle) |
|
void | nl_socket_set_peer_port (struct nl_handle *handle, uint32_t port) |
|
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;
fcntl(nl_socket_get_fd(handle), F_SETFL, O_NONBLOCK);
- 2) Group Subscriptions
- 6) Cleaning up
-
struct nl_handle* nl_handle_alloc |
( |
void |
) | |
|
- Returns
- Newly allocated netlink socket handle or NULL.
Definition at line 206 of file socket.c.
References nl_cb_alloc().
209 struct nl_handle *sk;
218 sk = __alloc_handle(cb);
struct nl_handle* nl_handle_alloc_cb |
( |
struct nl_cb * |
cb) | |
|
- Parameters
-
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.
239 return __alloc_handle(cb);
void nl_handle_destroy |
( |
struct nl_handle * |
handle) | |
|
- Parameters
-
Definition at line 246 of file socket.c.
Referenced by nl_cache_mngr_free().
251 if (handle->h_fd >= 0)
254 if (!(handle->h_flags & NL_OWN_PORT))
255 release_local_port(handle->h_local.nl_pid);
257 nl_cb_put(handle->h_cb);
void nl_disable_sequence_check |
( |
struct nl_handle * |
handle) | |
|
- Parameters
-
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.
References NL_CB_CUSTOM, NL_CB_SEQ_CHECK, and nl_cb_set().
Referenced by nl_cache_mngr_alloc().
unsigned int nl_socket_use_seq |
( |
struct nl_handle * |
handle) | |
|
- Parameters
-
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.
302 return handle->h_seq_next++;
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.
328 port = generate_local_port();
329 handle->h_flags &= ~NL_OWN_PORT;
331 if (!(handle->h_flags & NL_OWN_PORT))
332 release_local_port(handle->h_local.nl_pid);
333 handle->h_flags |= NL_OWN_PORT;
336 handle->h_local.nl_pid = port;
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.
Referenced by nl_cache_mngr_add().
365 if (handle->h_fd == -1)
366 return nl_error(EBADFD,
"Socket not connected");
368 err = setsockopt(handle->h_fd, SOL_NETLINK, NETLINK_ADD_MEMBERSHIP,
369 &group,
sizeof(group));
371 return nl_error(errno,
"setsockopt(NETLINK_ADD_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.
Referenced by nl_cache_mngr_add().
392 if (handle->h_fd == -1)
393 return nl_error(EBADFD,
"Socket not connected");
395 err = setsockopt(handle->h_fd, SOL_NETLINK, NETLINK_DROP_MEMBERSHIP,
396 &group,
sizeof(group));
398 return nl_error(errno,
"setsockopt(NETLINK_DROP_MEMBERSHIP) "
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.
415 handle->h_local.nl_groups |= groups;
int nl_socket_set_nonblocking |
( |
struct nl_handle * |
handle) | |
|
- Parameters
-
- Returns
- 0 on success or a negative error code.
Definition at line 454 of file socket.c.
Referenced by nl_cache_mngr_alloc().
456 if (handle->h_fd == -1)
457 return nl_error(EBADFD,
"Socket not connected");
459 if (fcntl(handle->h_fd, F_SETFL, O_NONBLOCK) < 0)
460 return nl_error(errno,
"fcntl(F_SETFL, O_NONBLOCK) failed");
void nl_socket_enable_msg_peek |
( |
struct nl_handle * |
handle) | |
|
- Parameters
-
Definition at line 469 of file socket.c.
471 handle->h_flags |= NL_MSG_PEEK;
void nl_socket_disable_msg_peek |
( |
struct nl_handle * |
handle) | |
|
- Parameters
-
Definition at line 478 of file socket.c.
480 handle->h_flags &= ~NL_MSG_PEEK;
- 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.
References nl_cb_set().
Referenced by nl_cache_mngr_alloc().
518 return nl_cb_set(handle->h_cb, type, kind, func, arg);
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.
Referenced by nl_connect().
551 if (handle->h_fd == -1)
552 return nl_error(EBADFD,
"Socket not connected");
554 err = setsockopt(handle->h_fd, SOL_SOCKET, SO_SNDBUF,
555 &txbuf,
sizeof(txbuf));
557 return nl_error(errno,
"setsockopt(SO_SNDBUF) failed");
559 err = setsockopt(handle->h_fd, SOL_SOCKET, SO_RCVBUF,
560 &rxbuf,
sizeof(rxbuf));
562 return nl_error(errno,
"setsockopt(SO_RCVBUF) failed");
564 handle->h_flags |= NL_SOCK_BUFSIZE_SET;
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.
580 if (handle->h_fd == -1)
581 return nl_error(EBADFD,
"Socket not connected");
583 err = setsockopt(handle->h_fd, SOL_SOCKET, SO_PASSCRED,
584 &state,
sizeof(state));
586 return nl_error(errno,
"setsockopt(SO_PASSCRED) failed");
589 handle->h_flags |= NL_SOCK_PASSCRED;
591 handle->h_flags &= ~NL_SOCK_PASSCRED;
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.
607 if (handle->h_fd == -1)
608 return nl_error(EBADFD,
"Socket not connected");
610 err = setsockopt(handle->h_fd, SOL_NETLINK, NETLINK_PKTINFO,
611 &state,
sizeof(state));
613 return nl_error(errno,
"setsockopt(NETLINK_PKTINFO) failed");