libnl
1.1.4
|
Netlink Message Construction/Parsing Interface. More...
Modules | |
Attributes | |
Netlink Attributes Construction/Parsing Interface. | |
Data Structures | |
struct | nlmsghdr |
Netlink message header. More... | |
struct | nlmsgerr |
Netlink error message. More... | |
Macros | |
#define | NL_AUTO_PID 0 |
Will cause the netlink pid to be set to the pid assigned to the netlink handle (socket) just before sending the message off. More... | |
#define | NL_AUTO_SEQ 0 |
May be used to refer to a sequence number which should be automatically set just before sending the message off. More... | |
Size Calculations | |
int | nlmsg_msg_size (int payload) |
length of netlink message not including padding More... | |
int | nlmsg_total_size (int payload) |
length of netlink message including padding More... | |
int | nlmsg_padlen (int payload) |
length of padding at the message's tail More... | |
Payload Access | |
void * | nlmsg_data (const struct nlmsghdr *nlh) |
head of message payload More... | |
void * | nlmsg_tail (const struct nlmsghdr *nlh) |
int | nlmsg_len (const struct nlmsghdr *nlh) |
length of message payload More... | |
Attribute Access | |
struct nlattr * | nlmsg_attrdata (const struct nlmsghdr *nlh, int hdrlen) |
head of attributes data More... | |
int | nlmsg_attrlen (const struct nlmsghdr *nlh, int hdrlen) |
length of attributes data More... | |
Message Parsing | |
int | nlmsg_valid_hdr (const struct nlmsghdr *nlh, int hdrlen) |
int | nlmsg_ok (const struct nlmsghdr *nlh, int remaining) |
check if the netlink message fits into the remaining bytes More... | |
struct nlmsghdr * | nlmsg_next (struct nlmsghdr *nlh, int *remaining) |
next netlink message in message stream More... | |
int | nlmsg_parse (struct nlmsghdr *nlh, int hdrlen, struct nlattr *tb[], int maxtype, struct nla_policy *policy) |
parse attributes of a netlink message More... | |
struct nlattr * | nlmsg_find_attr (struct nlmsghdr *nlh, int hdrlen, int attrtype) |
nlmsg_find_attr - find a specific attribute in a netlink message More... | |
int | nlmsg_validate (struct nlmsghdr *nlh, int hdrlen, int maxtype, struct nla_policy *policy) |
nlmsg_validate - validate a netlink message including attributes More... | |
Message Building/Access | |
struct nl_msg * | nlmsg_alloc (void) |
Allocate a new netlink message with the default maximum payload size. More... | |
struct nl_msg * | nlmsg_alloc_size (size_t max) |
Allocate a new netlink message with maximum payload size specified. | |
struct nl_msg * | nlmsg_inherit (struct nlmsghdr *hdr) |
Allocate a new netlink message and inherit netlink message header. More... | |
struct nl_msg * | nlmsg_alloc_simple (int nlmsgtype, int flags) |
Allocate a new netlink message. More... | |
void | nlmsg_set_default_size (size_t max) |
Set the default maximum message payload size for allocated messages. More... | |
struct nl_msg * | nlmsg_convert (struct nlmsghdr *hdr) |
Convert a netlink message received from a netlink socket to a nl_msg. More... | |
void * | nlmsg_reserve (struct nl_msg *n, size_t len, int pad) |
Reserve room for additional data in a netlink message. More... | |
int | nlmsg_append (struct nl_msg *n, void *data, size_t len, int pad) |
Append data to tail of a netlink message. More... | |
int | nlmsg_expand (struct nl_msg *n, size_t newlen) |
Expand maximum payload size of a netlink message. More... | |
struct nlmsghdr * | nlmsg_put (struct nl_msg *n, uint32_t pid, uint32_t seq, int type, int payload, int flags) |
Add a netlink message header to a netlink message. More... | |
struct nlmsghdr * | nlmsg_hdr (struct nl_msg *n) |
Return actual netlink message. More... | |
void | nlmsg_free (struct nl_msg *n) |
Free a netlink message. More... | |
Attributes | |
void | nlmsg_set_proto (struct nl_msg *msg, int protocol) |
int | nlmsg_get_proto (struct nl_msg *msg) |
size_t | nlmsg_get_max_size (struct nl_msg *msg) |
void | nlmsg_set_src (struct nl_msg *msg, struct sockaddr_nl *addr) |
struct sockaddr_nl * | nlmsg_get_src (struct nl_msg *msg) |
void | nlmsg_set_dst (struct nl_msg *msg, struct sockaddr_nl *addr) |
struct sockaddr_nl * | nlmsg_get_dst (struct nl_msg *msg) |
void | nlmsg_set_creds (struct nl_msg *msg, struct ucred *creds) |
struct ucred * | nlmsg_get_creds (struct nl_msg *msg) |
Netlink Message Type Translations | |
char * | nl_nlmsgtype2str (int type, char *buf, size_t size) |
int | nl_str2nlmsgtype (const char *name) |
Netlink Message Flags Translations | |
char * | nl_nlmsg_flags2str (int flags, char *buf, size_t len) |
Direct Parsing | |
int | nl_msg_parse (struct nl_msg *msg, void(*cb)(struct nl_object *, void *), void *arg) |
Dumping | |
void | nl_msg_dump (struct nl_msg *msg, FILE *ofd) |
Dump message in human readable format to file descriptor. More... | |
Iterators | |
#define | nlmsg_for_each_attr(pos, nlh, hdrlen, rem) |
Iterate over a stream of attributes in a message. More... | |
#define | nlmsg_for_each_msg(pos, head, len, rem) |
Iterate over a stream of messages. More... | |
Standard message flags | |
#define | NLM_F_REQUEST 1 |
Must be set on all request messages (typically from user space to kernel space). | |
#define | NLM_F_MULTI 2 |
Indicates the message is part of a multipart message terminated by NLMSG_DONE. | |
#define | NLM_F_ACK 4 |
Request for an acknowledgment on success. | |
#define | NLM_F_ECHO 8 |
Echo this request. | |
Additional message flags for GET requests | |
#define | NLM_F_ROOT 0x100 |
Return the complete table instead of a single entry. | |
#define | NLM_F_MATCH 0x200 |
Return all entries matching criteria passed in message content. | |
#define | NLM_F_ATOMIC 0x400 |
Return an atomic snapshot of the table being referenced. More... | |
#define | NLM_F_DUMP (NLM_F_ROOT|NLM_F_MATCH) |
Dump all entries. | |
Additional messsage flags for NEW requests | |
#define | NLM_F_REPLACE 0x100 |
Replace existing matching config object with this request. | |
#define | NLM_F_EXCL 0x200 |
Don't replace the config object if it already exists. | |
#define | NLM_F_CREATE 0x400 |
Create config object if it doesn't already exist. | |
#define | NLM_F_APPEND 0x800 |
Add to the end of the object list. | |
Standard Message types | |
#define | NLMSG_NOOP 0x1 |
No operation, message must be ignored. | |
#define | NLMSG_ERROR 0x2 |
The message signals an error and the payload contains a nlmsgerr structure. More... | |
#define | NLMSG_DONE 0x3 |
Message terminates a multipart message. | |
#define | NLMSG_OVERRUN 0x4 |
The message signals that data got lost. | |
#define | NLMSG_MIN_TYPE 0x10 |
Lower limit of reserved message types. | |
The following information is partly extracted from RFC3549 (ftp://ftp.rfc-editor.org/in-notes/rfc3549.txt)
NLM_F_MULTI
Netlink header flag set, except for the last header which has the Netlink header type NLMSG_DONE
.#define NL_AUTO_PID 0 |
#define NL_AUTO_SEQ 0 |
#define nlmsg_for_each_attr | ( | pos, | |
nlh, | |||
hdrlen, | |||
rem | |||
) |
pos | loop counter, set to current attribute |
nlh | netlink message header |
hdrlen | length of family header |
rem | initialized to len, holds bytes currently remaining in stream |
#define nlmsg_for_each_msg | ( | pos, | |
head, | |||
len, | |||
rem | |||
) |
pos | loop counter, set to current message |
head | head of message stream |
len | length of message stream |
rem | initialized to len, holds bytes currently remaining in stream |
#define NLM_F_ATOMIC 0x400 |
This may require special privileges because it has the potential to interrupt service in the FE for a longer time.
Definition at line 106 of file netlink-kernel.h.
#define NLMSG_ERROR 0x2 |
This can be looked at as a NACK and typically it is from FEC to CPC.
Definition at line 159 of file netlink-kernel.h.
int nlmsg_msg_size | ( | int | payload | ) |
payload | length of message payload |
Definition at line 184 of file msg.c.
Referenced by nl_msg_dump(), nlmsg_padlen(), and nlmsg_total_size().
int nlmsg_total_size | ( | int | payload | ) |
payload | length of message payload |
Definition at line 193 of file msg.c.
References nlmsg_msg_size().
Referenced by nlmsg_padlen(), and nlmsg_set_default_size().
int nlmsg_padlen | ( | int | payload | ) |
payload | length of message payload |
Definition at line 202 of file msg.c.
References nlmsg_msg_size(), and nlmsg_total_size().
void* nlmsg_data | ( | const struct nlmsghdr * | nlh | ) |
nlh | netlink messsage header |
Definition at line 218 of file msg.c.
Referenced by genlmsg_put(), nfnlmsg_family(), nfnlmsg_res_id(), nl_msg_dump(), nla_put(), nla_put_nested(), nla_reserve(), and nlmsg_attrdata().
int nlmsg_len | ( | const struct nlmsghdr * | nlh | ) |
nlh | netlink message header |
Definition at line 232 of file msg.c.
References nlmsghdr::nlmsg_len.
Referenced by nl_msg_dump(), nla_put_nested(), nlmsg_attrlen(), and nlmsg_reserve().
struct nlattr* nlmsg_attrdata | ( | const struct nlmsghdr * | nlh, |
int | hdrlen | ||
) |
nlh | netlink message header |
hdrlen | length of family specific header |
Definition at line 249 of file msg.c.
References nlmsg_data().
Referenced by nl_msg_dump(), nlmsg_find_attr(), nlmsg_parse(), and nlmsg_validate().
int nlmsg_attrlen | ( | const struct nlmsghdr * | nlh, |
int | hdrlen | ||
) |
nlh | netlink message header |
hdrlen | length of family specific header |
Definition at line 260 of file msg.c.
References nlmsg_len().
Referenced by nl_msg_dump(), nlmsg_find_attr(), nlmsg_parse(), and nlmsg_validate().
int nlmsg_ok | ( | const struct nlmsghdr * | nlh, |
int | remaining | ||
) |
nlh | netlink message header |
remaining | number of bytes remaining in message stream |
Definition at line 285 of file msg.c.
References nlmsghdr::nlmsg_len.
nlh | netlink message header |
remaining | number of bytes remaining in message stream |
Definition at line 300 of file msg.c.
References nlmsghdr::nlmsg_len.
int nlmsg_parse | ( | struct nlmsghdr * | nlh, |
int | hdrlen, | ||
struct nlattr * | tb[], | ||
int | maxtype, | ||
struct nla_policy * | policy | ||
) |
nlh | netlink message header |
hdrlen | length of family specific header |
tb | destination array with maxtype+1 elements |
maxtype | maximum attribute type to be expected |
policy | validation policy |
See nla_parse()
Definition at line 319 of file msg.c.
References nla_parse(), nlmsg_attrdata(), and nlmsg_attrlen().
struct nlattr* nlmsg_find_attr | ( | struct nlmsghdr * | nlh, |
int | hdrlen, | ||
int | attrtype | ||
) |
nlh | netlink message header |
hdrlen | length of familiy specific header |
attrtype | type of attribute to look for |
Returns the first attribute which matches the specified type.
Definition at line 337 of file msg.c.
References nla_find(), nlmsg_attrdata(), and nlmsg_attrlen().
int nlmsg_validate | ( | struct nlmsghdr * | nlh, |
int | hdrlen, | ||
int | maxtype, | ||
struct nla_policy * | policy | ||
) |
nlh | netlinket message header |
hdrlen | length of familiy specific header |
maxtype | maximum attribute type to be expected |
policy | validation policy |
Definition at line 350 of file msg.c.
References nla_validate(), nlmsg_attrdata(), and nlmsg_attrlen().
struct nl_msg* nlmsg_alloc | ( | void | ) |
Allocates a new netlink message without any further payload. The maximum payload size defaults to PAGESIZE or as otherwise specified with nlmsg_set_default_size().
Definition at line 401 of file msg.c.
Referenced by nlmsg_inherit(), and rtnl_neightbl_build_change_request().
struct nl_msg* nlmsg_inherit | ( | struct nlmsghdr * | hdr | ) |
hdr | Netlink message header template |
Allocates a new netlink message and inherits the original message header. If hdr is not NULL it will be used as a template for the netlink message header, otherwise the header is left blank.
Definition at line 424 of file msg.c.
References nlmsg_alloc(), nlmsghdr::nlmsg_flags, nlmsghdr::nlmsg_pid, nlmsghdr::nlmsg_seq, and nlmsghdr::nlmsg_type.
Referenced by nl_msg_dump(), and nlmsg_alloc_simple().
struct nl_msg* nlmsg_alloc_simple | ( | int | nlmsgtype, |
int | flags | ||
) |
nlmsgtype | Netlink message type |
flags | Message flags. |
Definition at line 448 of file msg.c.
References nlmsg_inherit(), and nlmsghdr::nlmsg_type.
Referenced by flnl_lookup_build_request(), nfnlmsg_alloc_simple(), nl_send_simple(), rtnl_link_build_change_request(), rtnl_neightbl_build_change_request(), and rtnl_qdisc_build_delete_request().
void nlmsg_set_default_size | ( | size_t | max | ) |
max | Size of payload in bytes. |
Definition at line 467 of file msg.c.
References nlmsg_total_size().
struct nl_msg* nlmsg_convert | ( | struct nlmsghdr * | hdr | ) |
hdr | Netlink message received from netlink socket. |
Allocates a new netlink message and copies all of the data pointed to by hdr into the new message object.
Definition at line 484 of file msg.c.
References nlmsg_free(), and nlmsghdr::nlmsg_len.
void* nlmsg_reserve | ( | struct nl_msg * | n, |
size_t | len, | ||
int | pad | ||
) |
n | netlink message |
len | length of additional data to reserve room for |
pad | number of bytes to align data to |
Reserves room for additional data at the tail of the an existing netlink message. Eventual padding required will be zeroed out.
Definition at line 512 of file msg.c.
References nlmsg_len().
Referenced by nlmsg_append(), and nlmsg_put().
int nlmsg_append | ( | struct nl_msg * | n, |
void * | data, | ||
size_t | len, | ||
int | pad | ||
) |
n | netlink message |
data | data to add |
len | length of data |
pad | Number of bytes to align data to. |
Extends the netlink message as needed and appends the data of given length to the message.
Definition at line 549 of file msg.c.
References nlmsg_reserve().
Referenced by flnl_lookup_build_request(), nl_send_simple(), rtnl_link_build_change_request(), rtnl_neightbl_build_change_request(), and rtnl_qdisc_build_delete_request().
int nlmsg_expand | ( | struct nl_msg * | n, |
size_t | newlen | ||
) |
n | Netlink message. |
newlen | New maximum payload size. |
Reallocates the payload section of a netlink message and increases the maximum payload size of the message.
struct nlmsghdr* nlmsg_put | ( | struct nl_msg * | n, |
uint32_t | pid, | ||
uint32_t | seq, | ||
int | type, | ||
int | payload, | ||
int | flags | ||
) |
n | netlink message |
pid | netlink process id or NL_AUTO_PID |
seq | sequence number of message or NL_AUTO_SEQ |
type | message type |
payload | length of message payload |
flags | message flags |
Adds or overwrites the netlink message header in an existing message object. If payload is greater-than zero additional room will be reserved, f.e. for family specific headers. It can be accesed via nlmsg_data().
Definition at line 610 of file msg.c.
References nlmsghdr::nlmsg_flags, nlmsghdr::nlmsg_pid, nlmsg_reserve(), nlmsghdr::nlmsg_seq, and nlmsghdr::nlmsg_type.
Referenced by genlmsg_put(), and nfnlmsg_put().
struct nlmsghdr* nlmsg_hdr | ( | struct nl_msg * | n | ) |
n | netlink message |
Returns the actual netlink message casted to the type of the netlink message header.
Definition at line 643 of file msg.c.
Referenced by nl_cache_parse_and_add(), nl_msg_dump(), nl_send_auto_complete(), and nl_sendmsg().
void nlmsg_free | ( | struct nl_msg * | n | ) |
n | netlink message |
Destroys a netlink message and frees up all used memory.
Definition at line 656 of file msg.c.
Referenced by flnl_lookup(), flnl_lookup_build_request(), nfnlmsg_alloc_simple(), nl_msg_dump(), nl_send_simple(), nlmsg_convert(), rtnl_addr_add(), rtnl_addr_delete(), rtnl_class_add(), rtnl_cls_add(), rtnl_cls_change(), rtnl_cls_delete(), rtnl_link_build_change_request(), rtnl_link_change(), rtnl_neigh_add(), rtnl_neigh_change(), rtnl_neigh_delete(), rtnl_neightbl_build_change_request(), rtnl_neightbl_change(), rtnl_qdisc_add(), rtnl_qdisc_change(), rtnl_qdisc_delete(), rtnl_rule_add(), and rtnl_rule_delete().
void nl_msg_dump | ( | struct nl_msg * | msg, |
FILE * | ofd | ||
) |
msg | Message to print |
ofd | File descriptor. |
Definition at line 947 of file msg.c.
References nlmsgerr::error, nlmsgerr::msg, nl_cache_ops_associate(), nlmsg_attrdata(), nlmsg_attrlen(), nlmsg_data(), nlmsg_free(), nlmsg_hdr(), nlmsg_inherit(), nlmsghdr::nlmsg_len, nlmsg_len(), nlmsg_msg_size(), and nlmsghdr::nlmsg_type.