\input texinfo

@setfilename guile-netlink.info

@documentencoding UTF-8

@settitle guile-netlink

@include version.texi

@copying

Copyright @copyright{} 2020 Julien Lepiller

@quotation

Permission is granted to copy, distribute and/or modify this document

under the terms of the GNU Free Documentation License, Version 1.3 or

any later version published by the Free Software Foundation; with no

Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A

copy of the license is included in the section entitled ``GNU Free

Documentation License''.

@end quotation

@end copying

@titlepage

@end titlepage

@contents

@node Top

@top guile-netlink

This document describes guile-netlink version @value{VERSION}, a guile

implementation of the netlink protocol.

@menu

* Introduction::           What is netlink?

* API Reference::          Description of the library interface.

* IP Library::             High-level functions for network devices.

@detailmenu

--- The Detailed Node Listing ---

API Reference

* Common API::             Common functions and data types for defining netlink

                           protocols.

* Netlink API::            Common structures and data types for every protocols.

* Rtnetlink API::          The ROUTE_NETLINK protocol.

IP Library

* Link::                   Actions on network links.

* Addr::                   Actions on network addresses.

* Route::                  Actions on network routes.

@end detailmenu

@end menu

@node Introduction

@chapter Introduction

Netlink is an inter-process communication protocol that can be used for

communication between processes, or with the kernel.  It is implemented by

Linux.

Many protocols exist on top of Netlink.  The most famous are used to configure

network-related functions in the kernel, such as firewall, route table or

IP addresses of interfaces.

This library implements the low-level bits of the code by providing data

structures that are close to their C counterpart, and basic procedures to

initiate communication.

@node API Reference

@chapter API Reference

@node Common API

@section Common API

Guile-netlink implements a common API for expressing other protocols.  This

section describes how to use this API to augment guile-netlink with additional

protocols.

@node Data Types

@subsection Data Types

Guile-netlink defines data types that are used in the various Netlink protocols.

We need to be able to serialize and deserialize data that guile-netlink

understands, but we also want to let users of guile-netlink extend this process

easily.  This need has lead to the creating of the following data structure,

defined in @code{(netlink data}).

@deffn {Datatype} nl-data

@table @asis

@item @code{data}

The data that is held by this record.

@item @code{size-proc}

A procedure that takes a data (of the same type as the data recorded in the

@code{data} field) and returns the size of its serialization.

@item @code{serialization-proc}

A procedure that takes a data (of the same type as the data recorded in the

@code{data} field), the position at which to start serializing, and a

bytevector in which to serialize.  This procedure should modify the bytevector

and its return value is ignored.

@end table

@end deffn

The module also defines the following function, that takes a @code{nl-data}

structure and provides its serialization in a bytevector:

@deffn {Scheme Procedure} serialize @var{data} @var{pos} @var{bv}

Takes a @code{nl-data} structure as @var{data}, a position @var{pos} in

the bytevector @var{bv}, and returns an unspecified value.

This function updates the bytevector and adds the serialization of @var{data}

into @var{bv} at @var{pos}.

@end deffn

By providing a @code{nl-data} structure, we defer the knowledge of how to

serialize the data to the structure itself, instead of the @code{serialize}

function.  This allows for more flexibility and extensibility, as the user

of the procedure can pass any kind of data, even if it is not yet supported by

guile-netlink.

Similarly, we need to be able to deserialize netlink answers into a data

structure.  To do so, we also defer the knowledge of the datastructure to

deserialize to, to a decoder structure that is passed to the deserialization

procedure.  @code{(netlink data)} also defines the following procedures to

deserialize data:

@deffn {Scheme Procedure} deserialize @var{type} @var{decoder} @var{bv} @var{pos}

Takes a bytevector @var{bv} and starts deserializing the data starting at

position @var{pos}.  To do so, it uses the @var{type} variable as the lookup

key in the @var{decoder}.  @var{type} is a symbol that represents the type of

data to deserialize to.

The decoder is a structure that associates each known type to its deserializer

(a function that takes a decoder, a bytevector and a position and returns some

data) and an alist that associates a type (an integer, as returned by the

protocol in use) to the proper decoder of that type.

@end deffn

@deffn {Scheme Procedure} get-current-deserialize @var{decoder} @var{current-type}

Takes a decoder and a type, and returns the deserialization procedure associated

with the type (a symbol) in @var{decoder}.

@end deffn

@deffn {Scheme Procedure} get-next-deserialize @var{decoder} @var{current-type} @

    @var{target-type}

Takes a decoder, a type (a symbol that represents the type of data being

deserialized) and another type (an integer as returned by the protocol), and

returns the deserialization procedure needed to continue decoding the data

associated with the currently being deserialized data.

For example, when decoding an answer in the netlink protocol, we first deserialize

the header into a @code{message} structure.  That header contains a type field

that contains an integer constant representing the type of data of the body.

Similarly, when deserializing a routing attribute in the rtnetlink protocol,

we first find a header of the attribute that defines an integer constant

corresponding to the type of attribute in the body.

By knowing the context in which the type is declared, this procedure can return

the correct deserializing procedure.  For instance, when deserializing a

@code{message}, type @code{16} means @code{RTM_NEWLINK} in the rtnetlink

protocol, whereas it means @code{IFLA_OPERSTATE} when deserializing a

@code{route-attribute}.

@end deffn

guile-netlink provides the following default decoder for the rtnetlink

protocol in @code{(netlink deserialize)}:

@deffn {Scheme Variable} %default-route-decoder

Contains the default decoder for the NETLINK_ROUTE protocol.

@end deffn

For convenience, guile-netlink defines the following structures that can be used

to create a custom decoder.

@deffn {Scheme Variable} %default-message-decoder

Contains the default association list for the common message types of netlink,

associating each of them to a deserialization procedure.

@end deffn

@deffn {Scheme Procedure} default-route-attr-decoder @var{deserialize-addr}

Creates the default association list for a route protocol, given the specified

address deserializer.  This is useful because the @code{IFA_ADDRESS},

@code{IFA_BROADCAST}, etc, contain a different type of address depending on

the message type or its header.  This is defined an @code{(netlink route attrs)}

and used by the following variables:

@end deffn

@deffn {Scheme Variable} %default-route-link-attr-decoder

Contains the default association list for the known types of routing attributes

for link messages.  This list is defined in @code{(netlink route attrs)}.

@end deffn

@node Constants

@subsection Constants

Guile-netlink defines constants used by the Netlink protocols in the

@code{(netlink constant)} module.  The constants are the ones present in the

kernel and are too numerous to list here.  Please see the source for the

complete list.

The module also defines the following macro:

@deffn {Scheme Macro} define-enum @var{integer->symbol} @var{name-spec} ...

This macros defines an enumeration.  @var{integer->symbol} is the name of

a procedure that is publicly defined, that takes an integer and returns the

associated symbol in the enumeration.

The macro also publicly defines variables whose names are in @var{name-spec}

to an integer.

A @var{name-spec} is either a single name, and the associated value is 0 for

the first @var{name-spec}, or one more than the previous @var{name-spec}.

It can also be a pair of a name and an integer, in which case the associated

value is that integer.  For instance:

@example

(define-enum get-foo FOO0 FOO1 (FOO10 10) FOO11 FOO12)

(get-foo 9) -> #<unspecified>

(get-foo 0) -> FOO0

FOO11 -> 11

@end example

@end deffn

@node Netlink Connections

@subsection Netlink Connections

The @code{(netlink connection)} module defines the following procedures, used

to connect and communicate with another process or the kernel using a netlink

socket.

@deffn {Scheme Procedure} get-addr @var{family} @var{pid} @var{groups}

Return a bytevector that represents a netlink address.  @var{family}

should be @code{AF_NETLINK}, @var{pid} is the PID of the process with which

to communicate or 0 for the kernel. @var{groups} is an integer representing

the set of broadcast groups to which the connection subscribes.

@end deffn

@deffn {Scheme Procedure} connect @var{proto} @var{addr}

Creates a netlink socket for @var{proto} and binds it to @var{addr}.

@var{proto} is the integer representing the protocol.  For instance, rtnetlink

can be selected by usin @code{NETLINK_ROUTE} (defined in

@code{(netlink constant)}).

@var{addr} is a bytevector, as returned by @code{get-addr}.

@end deffn

@deffn {Scheme Procedure} connect-route [#:groups @code{0}]

This procedure is a wrapper for @code{connect} that creates a socket for the

rtnetlink protocol, binds it to the kernel and returns it.  By passing the

optional @var{groups} keyword, you can select broadcast groups to subscribe to.

@end deffn

@deffn {Scheme Procedure} close-socket @var{socket}

Closes a netlink socket.  The socket cannot be used afterwards.

@end deffn

@deffn {Scheme Procedure} send-msg @var{msg} @var{sock} [#:@var{addr}]

Send @var{msg} (it must be of type message, @xref{Netlink Headers}) to

@var{addr} using @var{sock}.  If not passed, @var{addr} is the address of

the kernel.

@end deffn

@deffn {Scheme Procedure} receive-msg @var{sock} [#:@var{addr}]

Receives a message from @var{sock} from @var{addr}.  This procedure is blocking.

If not passed, @var{addr} defaults to the address of the kernel.  This

procedure returns the message as a bytevector, that you can deserialize with

@code{deserialize} (@xref{Data Types})

@end deffn

@deffn {Scheme Procedure} receive-and-decode-msg @var{sock} @var{decoder} @

    [#:@var{addr}]

Receives one or more messages from @var{sock} from @var{addr}.  this procedure

is blocking.  If not passed, @var{addr} defaults to the address of the kernel.

This procedure returns a list of messages that were decoded using @var{decoder}.

When the answer has the @code{NLM_F_MULTI} flag, this procedure decodes the next

message, until it receives a @code{NLMSG_DONE} message.  It returns the list

of every netlink messages it received, including the @code{NLMSG_DONE}.

@end deffn

@node Netlink API

@section Netlink API

This section introduces the data structures used for all the netlink protocols.

First, we introduce the structure of a netlink message, then we present the

standard types of netlink messages, that can be used with every protocol.

@node Netlink Headers

@subsection Netlink Headers

The @code{(netlink message)} module defines the message structure that contains

a netlink message.  It is composed of a header and a body, and is the data

structure to pass to @code{send-msg} (@xref{Netlink Connections}).

This module defines the following data structure:

@deffn {Datatype} message

@table @asis

@item @code{type}

The type of data in the body of the message.  For instance, @code{RTM_GETLINK}.

@item @code{flags}

The set of flags that are set in the header.  For instance,

@code{(logior NLM_F_REQUEST NLM_F_DUMP)}.

@item @code{seq}

The sequence number of the message.  If this message is an answer to a request,

it must keep the same sequence number.  Otherwise, you must generate a new and

unique sequence number, to track the answers.

@item @code{pid}

The PID of the receiving process, or 0 for the kernel.

@item @code{data}

The actual body, as an @code{nl-data} structure.

@end table

@end deffn

@node Standard Message Types

@subsection Standard Message Types

The @code{(netlink standard)} module defines the set of standard message types

and their data type.

@deffn {Datatype} error-message

@table @asis

@item @code{err}

The error code, as a negative number.

@item @code{hdr}

The message on which this error applies.

@end table

@deffn {Scheme Variable} no-data

This variable defines the absence of data.  This is useful when a structure

is expecting a body part, but the protocol specifically defines that it should

not take any data in some cases.  For instance, a @code{NLMSG_NOOP} message

takes no data, so the @code{data} field of the message will contain this

@code{no-data} value.

@end deffn

@end deffn

@node Rtnetlink API

@section Rtnetlink API

@cindex rtnetlink

@cindex ROUTE_NETLINK

This section describes the support for rtnetlink in guile-netlink.  Rtnetlink

is the protocol responsible for everything related to network routing.  It

allows you to manage links, addresses, routing tables, neighbor chaces,

routing rules, queueing disciplines, traffic classes, traffic filters and

more.

@node Routing Attributes

@subsection Routing Attributes

The @code{(netlink route attrs)} module defines the following data types:

@deffn {Datatype} route-attr

This defines a header structure for the attribute, as well as its body.

@table @asis

@item @code{type}

This is the type of the attribute, for instance @code{IFLA_ADDRESS}.

@item @code{data}

This is the body of the attribute, ie.@: its value.

@end table

@end deffn

The module also defines additional data types that are not represented as

a record, but by a simple type.  For each of the following types, there is

a @code{make-*-route-attr} procedure to produce a @code{nl-data} value

for this type.  There is also @code{deserialize-route-attr-data-*} procedure

to deserialize a value of this type.

@table @asis

@item @code{u8}

A one-byte unsigned integer

@item @code{u16}

A two-bytes unsigned integer

@item @code{u32}

A four-bytes unsigned integer

@item @code{s32}

A four-bytes signed integer

@item @code{string}

A string

@item @code{ethernet}

An ethernet address.  Its value is a string that represents that address,

for instnace @code{"01:23:45:67:89:ab"}

@item @code{ipv4}

An IPv4 address.  Its value is a string that represents that address,

for instnace @code{"192.0.2.152"}

@item @code{ipv6}

An IPv6 address.  Its value is a string that represents that address,

for instnace @code{"2001:db8::0123:4567:89ab:cdef"}

@item @code{bv}

A bytevector.  This is used by default when the type is not supported.

@end table

@node Link Messages

@subsection Link Messages

The @code{(netlink route link)} package defines the following data type:

@deffn {Datatype} link-message

This datatype represents a link message with its routing attributes.  This type

of message is expected when using the @var{RTM_*LINK} message types.

@table @asis

@item @code{family}

The network family, defined as @code{AF_UNSPEC} in the rtnetlink documentation,

although it holds different values in practice.

@item @code{type}

The device type.

@item @code{index}

The index of the device.  This is used to select a specific device by its index,

or 0 to not filter by device index.

@item @code{flags}

The device flags.  See @code{man 7 netdevices} for a list.

@item @code{attrs}

A list of attributes.  This field must contain a list of @code{nl-data}

structures, not a structure by itself.

@end table

@end deffn

@node Address Messages

@subsection Address Messages

The @code{(netlink route addr)} package defines the following data type:

@deffn {Datatype} addr-message

This datatype represents an address message with its routing attributes.  This

type of message is expected when using the @var{RTM_*ADDR} message types.

@table @asis

@item @code{family}

The network family, either @code{AF_INET} for IPv4 addresses, or @code{AF_INET6}

for IPv6 addresses.

@item @code{prefix-len}

The prefix length, i.e.@: the length of the prefix mask, in bits, if defined

for the address family.

@item @code{flags}

Address flags.  This can be a flag word of @code{IFA_F_SECONDARY} for secondary

address (old alias interface), @code{IFA_F_PERMANENT} for a permanent

address set by the user and other undocumented flags.

@item @code{scope}

The address scope.

@item @code{index}

The index of the device this address is for.

@item @code{attrs}

A list of attributes.  This field must contain a list of @code{nl-data}

structures, not a structure by itself.

@end table

@end deffn

@node IP Library

@chapter IP Library

This library comes with higher-level procedures that let you access and modify

the state of network on your computer.

@node Link

@section Link

The @code{(ip link)} module introduces procedures to access and modify the

network links on your machine.  They are equivalent to the @command{ip link}

family of commands, from @code{iproute2}.

@deffn {Datatype} <link>

Datatype representing the status of a network link.

get-links                                                           

            print-link                                                          

            <link> make-link link?                                              

            link-name link-id link-type link-flags link-mtu link-qdisc          

            link-state link-mode link-group link-qlen link-addr link-brd

@table @asis

@item @code{name}

Name of the link, such as @code{"enp1s0"}.

@item @code{id}

Index of the link, a unique number used to identify the link.

@item @code{type}

Type of the link, as an integer.

@item @code{flags}

Flags associated with the device, as a list of symbols, such as

@code{'(UP LOOPBACK)}.

@item @code{mtu}

MTU of the link, as an integer.

@item @code{qdisc}

Queuing discipline of the link, as a string, such as @code{"noqueue"}.

@item @code{state}

State of the link, as an integer.  Use @code{int->operstate} from

@code{(netlink constant)} to get a symbol, such as @code{IF_OPER_UP}.

@item @code{mode}

Mode of the link.  0 means @code{DORMANT}, 1 means @code{DEFAULT}.

@item @code{group}

Identifier of the group it belongs to.  0 for @code{default}.

@item @code{qlen}

Size of the queue.

@item @code{addr}

Ethernet address of the link, as a string.

@item @code{brd}

Broadcast (ethernet) address of the link, as a string.

@end table

@end deffn

@deffn {Scheme Procedure} get-links

Returns the list of existing links in the system, as a list of @code{<link>}

objects.

@end deffn

@deffn {Sceme Procedure} print-link @var{link}

Display @var{link} on the standard output, using a format similar to

@command{ip link} from @code{iproute2}.

@end deffn

@deffn {Scheme Procedure} link-set @var{device} [#:up @code{#f}] @

  [#:down @code{#f}] [#:type @code{#f}] [#:arp-on @code{#f}] @

  [#:arp-off @code{#f}] [#:dynamic-on @code{#f}] [#:dynamic-off @code{#f}] @

  [#:multicast-on @code{#f}] [#:multicast-off @code{#f}] @

  [#:allmulticast-on @code{#f}] [#:allmulticast-off @code{#f}] @

  [#:promisc-on @code{#f}] [#:promisc-off @code{#f}] [#:trailers-on @code{#f}] @

  [#:trailers-off @code{#f}] [#:carrier-on @code{#f}] [#:carrier-off @code{#f}] @

  [#:txqueuelen @code{#f}] [#:name @code{#f}] [#:address @code{#f}] @

  [#:broadcast @code{#f}] [#:mtu @code{#f}] [#:netns @code{#f}]

Modify an existing link and set its flags and attributes to the ones specified

by the various keywords.  When a keyword is omited, the corresponding attribute

is not changed.

@var{device} can be a device index (as a number) or a device name (as a string).

Do not set @code{#:up} and @code{#:down} at the same time.  Do not set

@code{*-on} and @code{*-off} at the same time.

@end deffn

@deffn {Scheme Procedure} link-show [#:device @code{#f}] [#:group @code{#f}] @

  [#:up @code{#f}] [#:master @code{#f}] [#:vrf @code{#f}] [#:type @code{#f}]

Print the set of devices on standard output.  Setting any of the keyword to a

non-false value will filter the results to only show results that match the

corresponding value.  You may set more than one keyword.

@end deffn

@deffn {Scheme Procedure} link-add @var{name} @var{type} [#:type-args @code{'()}]

Add a new link with given name and type.  Additional arguments can be passed to

control the state of the link at creation. @var{type-args} is an association

list containing additional values for the given type.

When @var{type} is @code{"vlan"}, @var{type-args} can contain a number associated

with @code{'id}: the VLAN id to be created.

When @var{type} is @code{"veth"}, @var{type-args} can contain a string associated

with @code{'peer}: the name of the peer.

The following is an example in which we create a new veth (virtual ethernet)

pair and give them a name:

@example

;; same as "ip l add v0p0 type veth peer v0p1"

(link-add "v0p0" "veth" #:type-args '((peer . "v0p1")))

@end example

@end deffn

@deffn {Scheme Procedure} link-del @var{device}

Delete a link.  @var{device} can contain the name of the link, as a string,

or its index, as a number.

@end deffn

@node Addr

@section Addr

The @code{(ip addr)} module introduces procedures to access and modify the

network addresses on your machine.  They are equivalent to the @command{ip addr}

family of commands, from @code{iproute2}.

@deffn {Scheme Procedure} addr-add @var{device} @var{cidr} [@var{#:ipv6?} #f]

Add the address given in @var{cidr} to @var{device}. @var{device} can

contain the name of the link, as a string, or its index, as a number.

@var{cidr} must be a string containing the address and prefix length, in

CIDR notation (@code{addr/prefix}).

@example

(addr-add "enp1s0" "192.0.2.15/24")

@end example

If you wish to add an IPv6 address instead, set @code{#:ipv6} to @code{#t},

as in the following example.

@example

(addr-add "enp1s0" "2001:db8::1a4c/64" #:ipv6? #t)

@end example

Note that using the wrong ip type with the wrong value for the @code{#:ipv6?}

flag will result in a @code{Bad address} exception from inet-pton.

@end deffn

@deffn {Scheme Procedure} addr-del @var{device} @var{cidr} [@var{#:ipv6?} #f]

Delete the address given in @var{cidr} from @var{device}. @var{device} can

contain the name of the link, as a string, or its index, as a number.

@var{cidr} must be a string containing the address and prefix length, in

CIDR notation (@code{addr/prefix}).

@example

(addr-del "enp1s0" "192.0.2.15/24")

@end example

If you wish to remove an IPv6 address instead, set @code{#:ipv6} to @code{#t},

as in the following example.

@example

(addr-del "enp1s0" "2001:db8::1a4c/64" #:ipv6? #t)

@end example

Note that using the wrong ip type with the wrong value for the @code{#:ipv6?}

flag will result in a @code{Bad address} exception from inet-pton.

@end deffn

@deffn {Scheme Procedure} addr-show [@var{device}]

Print the list of addresses for each device on standard output.  Setting

@code{device} to a link name or link identifier will restrict the output

to addresses of that device.

@end deffn

@node Route

@section Route

The @code{(ip route)} module introduces procedures to access and modify the

network routes on your machine.  They are equivalent to the @command{ip route}

family of commands, from @code{iproute2}.

@deffn {Scheme Procedure} route-add @var{dest} [@var{#:ipv6?} #f] @

    [@var{#:device} #f] [@var{#:table} RT_TABLE_MAIN] [@var{#:protocol} #f] @

    [@var{#:scope} RT_SCOPE_LINK] [@var{#:type} RTN_UNICAST] @

    [@var{#:priority} #f] [@var{#:src} #f] [@var{#:via} #f]

Add the route described by the argmuents.  @var{dest} is the destination network,

in cidr notation (@code{addr/prefix}) or the string @code{"default"}.

@var{#:device} is the name or index of a network link. @var{#:table} is the

index of a routing table, one of @code{RT_TABLE_COMPAT}, @code{RT_TABLE_DEFAULT},

@code{RT_TABLE_MAIN} or @code{RT_TABLE_LOCAL}, as defined in

@code{(netlink constant)}.

If it is set, @var{#:protocol} must be the routing protocol, @code{RTPROT_*},

as defined in @code{(netlink constant)}.

@var{#:scope} must be the scope of the route, one of @code{RT_SCOPE_*}, as

defined in @code{(netlink constant)}.

@var{#:type} must be the type of route, one of @code{RTN_*}, as defined in

@code{(netlink constant)}.

If set, @var{#:priority} is a number specifying the priority of the rule

when the kernel is looking for a matching rule.  This is also known as the

metric of the route.

If set, @var{#:src} is the source address in cidr notation, or as a single

address.

If set, @var{#:via} is the gateway address.  This is not in cidr notation, as

the gateway is a single address, not a network.

@example

(route-add "default" #:device "enp1s0" #:via "192.0.2.1")

(route-add "192.0.2.0/24" #:device "enp1s0" #:src "192.0.2.15")

@end example

If you wish to add an IPv6 route instead, set @code{#:ipv6} to @code{#t},

as in the following example.

@example

(addr-add "2001:db8::/64" #:device "enp1s0" #:src "2001:db8::1a4c" #:ipv6? #t)

@end example

Note that using the wrong ip type with the wrong value for the @code{#:ipv6?}

flag will result in a @code{Bad address} exception from inet-pton.

@end deffn

@deffn {Scheme Procedure} route-del @var{dest} [@var{#:ipv6?} #f] @

    [@var{#:device} #f] [@var{#:table} RT_TABLE_MAIN] [@var{#:protocol} #f] @

    [@var{#:scope} #f] [@var{#:type} #f] [@var{#:priority} #f] @

    [@var{#:src} #f] [@var{#:via} #f]

Delete the route given in arguments.  The arguments follow the same structure

as @code{route-add}.  By specifying more arguments, you can narrow down the

search for the rule to delete further.  Each call will only remove one route,

so being more precise ensures you target the rule you wish to delete.  It

is not clear which route is deleted if multiple routes match your query.

@end deffn

@deffn {Scheme Procedure} route-show [@var{#:table} RT_TABLE_MAIN] @

    [@var{#:family} AF_UNSPEC]

Print the list of routes on standard output.  Note that, contrary to

@command{ip route show}, we show both IPv4 and IPv6 routes.  To narrow down the

number of routes displayed, you can specify the family as in this example.

@example

(route-show #:family AF_INET6)

@end example

@end deffn

@bye