include/net/netlink.h

16  * Message Format:
34  *   struct nlmsghdr			netlink message header
36  * Message Construction:
37  *   nlmsg_new()			create a new netlink message
38  *   nlmsg_put()			add a netlink message to an skb
40  *   nlmsg_end()			finalize netlink message
41  *   nlmsg_get_pos()			return current position in message
42  *   nlmsg_trim()			trim part of message
43  *   nlmsg_cancel()			cancel message construction
44  *   nlmsg_free()			free a netlink message
46  * Message Sending:
47  *   nlmsg_multicast()			multicast message to several groups
48  *   nlmsg_unicast()			unicast a message to a single socket
49  *   nlmsg_notify()			send notification message
51  * Message Length Calculations:
52  *   nlmsg_msg_size(payload)		length of message w/o padding
53  *   nlmsg_total_size(payload)		length of message w/ padding
56  * Message Payload Access:
57  *   nlmsg_data(nlh)			head of message payload
58  *   nlmsg_len(nlh)			length of message payload
62  * Message Parsing:
64  *   nlmsg_next(nlh, remaining)		get next netlink message
65  *   nlmsg_parse()			parse attributes of a message
66  *   nlmsg_find_attr()			find an attribute in a message
68  *   nlmsg_validate()			validate netlink message incl. attrs
470  * @nlh: Netlink message header of original request
485  * enum netlink_validation - netlink message/attribute validation levels
487  *	extra data at the end of the message, attributes being longer than
561  * nlmsg_msg_size - length of netlink message not including padding
562  * @payload: length of message payload
570  * nlmsg_total_size - length of netlink message including padding
571  * @payload: length of message payload
579  * nlmsg_padlen - length of padding at the message's tail
580  * @payload: length of message payload
588  * nlmsg_data - head of message payload
589  * @nlh: netlink message header
597  * nlmsg_len - length of message payload
598  * @nlh: netlink message header
607  * @nlh: netlink message header
619  * @nlh: netlink message header
628  * nlmsg_ok - check if the netlink message fits into the remaining bytes
629  * @nlh: netlink message header
630  * @remaining: number of bytes remaining in message stream
640  * nlmsg_next - next netlink message in message stream
641  * @nlh: netlink message header
642  * @remaining: number of bytes remaining in message stream
644  * Returns the next netlink message in the message stream and
645  * decrements remaining by the size of the current message.
734  * __nlmsg_parse - parse attributes of a netlink message
735  * @nlh: netlink message header
762  * nlmsg_parse - parse attributes of a netlink message
763  * @nlh: netlink message header
782  * nlmsg_parse_deprecated - parse attributes of a netlink message
783  * @nlh: netlink message header
802  * nlmsg_parse_deprecated_strict - parse attributes of a netlink message
803  * @nlh: netlink message header
823  * nlmsg_find_attr - find a specific attribute in a netlink message
824  * @nlh: netlink message header
883  * nlmsg_validate_deprecated - validate a netlink message including attributes
884  * @nlh: netlinket message header
907  * @nlh: netlink message header
917  * nlmsg_seq - return the seq number of netlink message
918  * @nlh: netlink message header
920  * Returns 0 if netlink message is NULL
930  * @nlh: netlink message header
939  * nlmsg_put - Add a new netlink message to an skb
940  * @skb: socket buffer to store message in
942  * @seq: sequence number of message
943  * @type: message type
944  * @payload: length of message payload
945  * @flags: message flags
948  * the message header and payload.
961  * @skb: socket buffer to store message in
962  * @size: length of message payload
964  * Append data to an existing nlmsg, used when constructing a message
981  * nlmsg_put_answer - Add a new callback based netlink message to an skb
982  * @skb: socket buffer to store message in
984  * @type: message type
985  * @payload: length of message payload
986  * @flags: message flags
989  * the message header and payload.
1001  * nlmsg_new - Allocate a new netlink message
1002  * @payload: size of the message payload
1014  * nlmsg_new_large - Allocate a new netlink message with non-contiguous
1016  * @payload: size of the message payload
1028  * nlmsg_end - Finalize a netlink message
1029  * @skb: socket buffer the message is stored in
1030  * @nlh: netlink message header
1032  * Corrects the netlink message header to include the appeneded
1034  * the message.
1042  * nlmsg_get_pos - return current position in netlink message
1043  * @skb: socket buffer the message is stored in
1045  * Returns a pointer to the current tail of the message.
1053  * nlmsg_trim - Trim message to a mark
1054  * @skb: socket buffer the message is stored in
1057  * Trims the message to the provided mark.
1068  * nlmsg_cancel - Cancel construction of a netlink message
1069  * @skb: socket buffer the message is stored in
1070  * @nlh: netlink message header
1072  * Removes the complete netlink message including all
1081  * nlmsg_free - free a netlink message
1082  * @skb: socket buffer of netlink message
1090  * nlmsg_multicast_filtered - multicast a netlink message with filter function
1092  * @skb: netlink message as socket buffer
1120  * nlmsg_multicast - multicast a netlink message
1122  * @skb: netlink message as socket buffer
1135  * nlmsg_unicast - unicast a netlink message
1136  * @sk: netlink socket to spread message to
1137  * @skb: netlink message as socket buffer
1153  * @pos: loop counter, set to current message
1154  * @head: head of message stream
1155  * @len: length of message stream
1166  * @nlh: netlink message header to write the flag to
1169  * and if it did, advertises it in the netlink message header.
1173  * each message that is generated.
1954  * @skb: socket buffer the message is stored in
2008  * @skb: socket buffer the message is stored in
2029  * @skb: socket buffer the message is stored in