.\" -*- nroff -*-
.\" Don't remove the line above, it tells man that tbl is needed.
.\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
.\" Permission is granted to distribute possibly modified copies
.\" of this page provided the header is included verbatim,
.\" and in case of nontrivial modification author and date
.\" of the modification is added to the header.
.\" Based on the original comments from Alexey Kuznetsov, writen with
.\" help from Matthew Wilcox. 
.\" $Id: rtnetlink.7,v 1.1 2000/10/20 13:05:11 ricardo Exp $
.TH RTNETLINK  7 "30/04/1999" "Pgina do Manual Linux" "Manual do Programador Linux" 
.SH NOME
rtnetlink, NETLINK_ROUTE \- socket Linux de roteamento IPv4.
.SH SINOPSE
.B #include <asm/types.h>
.br
.B #include <linux/netlink.h>
.br
.B #include <linux/rtnetlink.h>
.br
.B #include <sys/socket.h>

.BI "rtnetlink_socket = socket(PF_NETLINK, int " socket_type ", NETLINK_ROUTE);"

.SH DESCRIO
Rtnetlink permite que as tabelas de roteamento do kernel sejam lidas e alteradas.
 usado dentro do kernel para a comunicao entre vrios
subsistemas, apesar de que seu uso no  documentado aqui, e para
comunicao com programas do espao do usurio.
Rotas de rede, endereos ip, parmetros de ligao, configuraes de vizinhana, disciplinas
de filas, classes de trfego e classificadores de pacotes podem todos ser controlados
atravs de sockets
.B NETLINK_ROUTE.
Ele  baseado em mensagens de "netlink", veja 
.BR netlink (7)
para maiores informaes.

.\" XXX: all these macros could be moved to rtnetlink(3) 

.SH ATRIBUTOS DE ROTEAMENTO
Algumas mensagens do rnetlink tm atributos opcionais depois do cabealho inicial:

.nf
.ta 4 19 32
struct rtattr
{
	unsigned short	rta_len;	/* Comprimento da opo */
	unsigned short	rta_type;	/* Tipo da opo */
	/* Dados seguem */ 
};
.fi

Estes atributos seriam manipulados somente pelo uso de macros RTA_* ou do libnetlink,
veja
.BR rtnetlink (3).

.SH MENSAGENS
Rtnetlink consiste nos seguintes tipos de mensagens
(alm das mensagens padro do netlink):

.TP
.BR RTM_NEWLINK ", " RTM_DELLINK ", " RTM_GETLINK
Cria, remove ou obtm informaes sobre uma interface de rede especfica.
Essas mensagens contm uma estrutura
.B ifinfomsg
seguida por uma srie de estruturas
.B rtattr
.

.nf
.ta 4 19 32
struct ifinfomsg
{
	unsigned char	ifi_family;	/* AF_UNSPEC */
	unsigned char	__ifi_pad;	/* no usado */
	unsigned short	ifi_type;	/* tipo de dispositivo */ 
	int	ifi_index;		/* ndice da interface */
	unsigned int	ifi_flags;	/* flags do dispositivo  */
	unsigned int	ifi_change;	/* muda a mscara */
};
.fi

.\" XXX ifi_type
.B ifi_flags 
contm as flags do dispositivo, veja
.BR netdevice(7);
.B ifi_index
 o nico ndice de interface,
.B ifi_change
 reservado para uso futuro e deve sempre ser setado em 0xFFFFFFFF. 


.TS
tab(:);
c
l l l.
Atributos de roteamento
rta_type:tipo de valor:descrio
_
IFLA_UNSPEC:-:no-especificado.
IFLA_ADDRESS:endereo de hardware:endereo L2 da interface.  
IFLA_BROADCAST:endereo de hardware:endereo de broadcast L2.
IFLA_IFNAME:string asciiz:Nome do dispositivo.
IFLA_MTU:unsigned int:MTU do dispositivo.
IFLA_LINK:int:Tipo de ligao.
IFLA_QDISC:string asciiz:Disciplina de fila.
IFLA_STATS:T{
struct net_device_stats
T}:Estatsticas de interface.
.TE

.TP	
.BR RTM_NEWADDR ", " RTM_DELADDR ", " RTM_GETADDR	
Acrescenta, remove ou recebe informao sobre um endereo IP associado a
uma interface. No Linux 2.2, uma interface pode carregar mltiplos endereos IP,
isso substitui o conceito de apelido de dispositivo no 2.0. No Linux 2.2, essas mensagens
suportam endereos IPv4 e IPv6. Elas contm uma estrutura
.B ifaddrmsg
, opcionalmente seguida pelos atributos de roteamento
.B rtaddr
.

.nf
.ta 4 19 32
struct ifaddrmsg
{
	unsigned char	ifa_family;	/* Tipo de endereo */
	unsigned char	ifa_prefixlen;	/* Comprimento de prefixo do endereo */
	unsigned char	ifa_flags;	/* Flags do endereo */
	unsigned char	ifa_scope;	/* Escopo do endereo */
	int	ifa_index;		/* ndice da interface */
};
.fi

.B ifa_family
 o tipo de famlia de endereo (correntemente
.B AF_INET
ou
.B AF_INET6), 
.B ifa_prefixlen
 o comprimento da mscara do endereo, se definida para a famlia (como
para o IPv4), 
.B ifa_scope
 o escopo de endereo,
.B ifa_index
 o ndice da interface com a qual o endereo est associado.
.B ifa_flags
 uma palavra de flag do
.B IFA_F_SECONDARY
para endereos secundrios (interface dos antigos apelidos),
.B IFA_F_PERMANENT
para um endereo permanente setado pelo usurio e outras flags no documentadas.

.TS
tab(:);
c
l l l.
Atributos
rta_type:tipo de valor:descrio
_
IFA_UNSPEC:-:no especificado.
IFA_ADDRESS:endereo de protocolo direto:endereo da interface.
IFA_LOCAL:endereo de protocolo direto:endereo local.
IFA_LABEL:string asciiz:nome da interface.
IFA_BROADCAST:endereo do protocolo direto:endereo de broadcast.
IFA_ANYCAST:endereo de protocolo direto:endereo de anycast.
IFA_CACHEINFO:struct ifa_cacheinfo:informao de endereo.
.TE

.\" XXX struct ifa_cacheinfo

.TP	
.BR RTM_NEWROUTE ", " RTM_DELROUTE ", " RTM_GETROUTE	
Cria, remove ou recebe informao sobre uma rota de rede. Essas mensagens
contm uma estrutura
.B rtmsg
com uma seqncia opcional de estruturas
.B rtattr
a seguir.

.nf
.ta 4 19 32
struct rtmsg
{
	unsigned char	rtm_family;	/* Famlia de endereos da rota */
	unsigned char	rtm_dst_len;	/* Comprimento da origem */
	unsigned char	rtm_src_len;	/* Comprimento do destino */ 
	unsigned char	rtm_tos;	/* filtro TOS */

	unsigned char	rtm_table;	/* id da tabela de roteamento */
	unsigned char	rtm_protocol;	/* protocolo de roteamento; veja abaixo */
	unsigned char	rtm_scope;	/* veja abaixo */	
	unsigned char	rtm_type;	/* veja abaixo */

	unsigned int	rtm_flags;	
};
.fi

.TS
tab(:);
l l
l l.
rtm_type:Tipo de rota
_
RTN_UNSPEC:rota desconhecida
RTN_UNICAST:um gateway ou rota direta
RTN_LOCAL:uma rota de interface local 
RTN_BROADCAST:T{
uma rota de broadcast local (enviado como um broadcast)
T}
RTN_ANYCAST:T{
uma rota de broadcast local (enviado como um unicast)
T}
RTN_MULTICAST:uma rota de multicast 
RTN_BLACKHOLE:uma rota de perda de pacotes
RTN_UNREACHABLE:um destino no alcanvel
RTN_PROHIBIT:uma rota de rejeio de pacotes
RTN_THROW:continua a busca de roteamento em outra tabela
RTN_NAT:uma regra de traduo de endereo de rede
RTN_XRESOLVE:T{
refere-se a um resolvedor externo (no implementado)
T}
.TE

.TS
tab(:);
l l.
rtm_protocol:Origem da rota.
_
RTPROT_UNSPEC:desconhecida
RTPROT_REDIRECT:T{
por um redirecionamento de ICMP (no usado correntemente)
T}
RTPROT_KERNEL:pelo kernel
RTPROT_BOOT:durante a inicializao
RTPROT_STATIC:pelo administrador
.TE

Valores maiores que 
.B RTPROT_STATIC
no so interpretados pelo kernel, eles so apenas para informao do
usurio. Eles podem ser usados para marcar a origem de uma informao de
roteamento ou para distinguir entre mltiplos daemons de roteamento. Veja
.BR <linux/rtnetlink.h>
para os identificadores de daemons de roteamento que j so atribudos.

.B rtm_scope 
 a distncia ao destino:

.TS
tab(:);
l l.
RT_SCOPE_UNIVERSE:rota global
RT_SCOPE_SITE:T{
rota interior no sistema autnomo local 
T}
RT_SCOPE_LINK:rota nesta ligao
RT_SCOPE_HOST:rota no host local
RT_SCOPE_NOWHERE:destino no existe
.TE

Os valores entre
.B RT_SCOPE_UNIVERSE
e
.B RT_SCOPE_SITE
so disponveis para o usurio.

O
.B rtm_flags
tem os seguintes significados:

.TS
tab(:);
l l.
RTM_F_NOTIFY:T{
se a rota muda, notifica o usurio via rtnetlink
T}
RTM_F_CLONED:a rota  clonada a partir de outra rota
RTM_F_EQUALIZE:um equalizador de multicast (ainda no implementado)
.TE

.B rtm_table
especifica a tabela de roteamento

.TS
tab(:);
l l.
RT_TABLE_UNSPEC:uma tabela de roteamento no especificada
RT_TABLE_DEFAULT:a tabela padro
RT_TABLE_MAIN:a tabela principal
RT_TABLE_LOCAL:a tabela local
.TE

O usurio pode atribuir valores arbitrrios entre
.B RT_TABLE_UNSPEC
e
.BR RT_TABLE_DEFAULT .

.TS
tab(:);
c
l l l.
Atributos
rta_type:tipo de valor:descrio
_
RTA_UNSPEC:-:ignorado.
RTA_DST:endereo do protocolo:endereo de destino da rota.
RTA_SRC:endereo do protocolo:endereo da origem da rota.
RTA_IIF:int:ndice da interface de entrada.
RTA_OIF:int:ndice da interface de sada.
RTA_GATEWAY:endereo do protocolo:o gateway da rota
RTA_PRIORITY:int:prioridade da rota.
RTA_PREFSRC::
RTA_METRICS:int:mtrica da rota.
RTA_MULTIPATH::
RTA_PROTOINFO::
RTA_FLOW::
RTA_CACHEINFO::
.TE

.B Preencha esses valores!

.TP	
.BR RTM_NEWNEIGH ", " RTM_DELNEIGH  ", " RTM_GETNEIGH	
Acrescenta, remove ou recebe informao sobre uma entrada de tabela de vizinhana (por exemplo, uma entrada
ARP). A mensagem contm uma estrutura
.B ndmsg
.

.nf
.ta 4 19 32
struct ndmsg
{
	unsigned char	ndm_family;
	unsigned char	ndm_pad1;
	unsigned short	ndm_pad2;
	int	ndm_ifindex;	/* ndice da interface */
	__u16	ndm_state;	/* estado */ 
	__u8	ndm_flags;	/* flags */
	__u8	ndm_type;   
};

struct nda_cacheinfo
{
	__u32	ndm_confirmed;
	__u32	ndm_used;
	__u32	ndm_updated;
	__u32	ndm_refcnt;
};
.fi

.B ndm_state
 uma mscara de bits dos seguintes estados:

.TS
tab(:);
l l.
NUD_INCOMPLETE:uma entrada de cache resolvendo correntemente
NUD_REACHABLE:uma entrada de cache confirmada funcionando
NUD_STALE:uma entrada expirada do cache
NUD_DELAY:uma entrada aguardando por um temporizador
NUD_PROBE:uma entrada de cache que  retestada atualmente
NUD_FAILED:uma entrada de cache invlida
NUD_NOARP:um dispositivo sem cache de destino
NUD_PERMANENT:uma entrada esttica
.TE

Os
.B ndm_flags
vlidos so:

.TS
tab(:);
l l.
NTF_PROXY:uma entrada de arp do proxy
NTF_ROUTER:um roteador IPv6
.TE

.B documenta melhor os membros da estrutura

A estrutura
.B rtaddr
tem os seguintes significados para o campo
.B rta_type
:

.TS
tab(:);
l l.
NDA_UNSPEC:tipo desconhecido
NDA_DST:um endereo de destino vizinho da camada de rede do cache
NDA_LLADDR:um endereo vizinho da camada de ligao do cache
NDA_CACHEINFO:estatsticas do cache
.TE

Se o campo
.B rta_type
 
.B NDA_CACHEINFO
, ento segue o cabealho
.B struct nda_cacheinfo


.TP
.BR RTM_NEWRULE ", " RTM_DELRULE ", " RTM_GETRULE
Acrescenta, apaga ou recupera uma regra de roteamento. Carrega um
.B struct rtmsg

.TP
.BR RTM_NEWQDISC ", " RTM_DELQDISC ", " RTM_GETQDISC
Acrescenta, remove ou obtm uma disciplina de fila. A mensagem contm um
.B struct tcmsg
e pode ser seguida por uma srie de
atributos.

.nf
.ta 4 19 32
struct tcmsg
{
	unsigned char	tcm_family;
	unsigned char	tcm__pad1;
	unsigned short	tcm__pad2;
	int	tcm_ifindex;	/* ndice de interface */
	__u32	tcm_handle;	/* manipula Qdisc */ 
	__u32	tcm_parent;	/* qdisc pai */
	__u32	tcm_info;
};
.fi

.TS
tab(:);
c
l l l.
Atributos
rta_type:tipo de valor:Descrio
_
TCA_UNSPEC:-:no especificado.
TCA_KIND:string asciiz:nome da disciplina de fila.
TCA_OPTIONS:seqncia de bytes:seguem as opes especficas do qdisc.
TCA_STATS:struct tc_stats:estatsticas do qdisc.
TCA_XSTATS:qdisc specific:estatsticas especficas do mdulo.
TCA_RATE:struct tc_estimator:limite de taxa.
.TE

Alm desses, so permitidos vrios outros atributos especficos de mdulos qdisc.
Para maiores informaes, veja os arquivos de incluso apropriados.

.TP
.BR RTM_NEWTCLASS ", " RTM_DELTCLASS ", " RTM_GETTCLASS
Acrescenta, remove ou obtm uma classe de trfego. Essas mensagens contm um
.B struct tcmsg
como descrito acima.

.TP
.BR RTM_NEWTFILTER ", " RTM_DELTFILTER ", " RTM_GETTFILTER
Acrescenta, remove ou recebe informaes sobre um filtro de
trfego. Essas mensagens contm um
.B struct tcmsg
como descrito acima.

.SH VERSES

.B rtnetlink 
 uma nova implementao do Linux 2.2.

.SH BUGS
Este pgina de manual  falha e imcompleta.

.SH VEJA TAMBM
.BR netlink (7),
.BR cmsg (3),
.BR ip (7),
.BR rtnetlink (3)
.SH TRADUZIDO POR LDP-BR em 21/08/2000.
\&\fR\&\f(CWRubens de Jesus Nogueira <darkseid99@usa.net> (traduo)\fR
\&\fR\&\f(CWAndr L. Fassone Canova <lonelywolf@blv.com.br> (reviso)\fR