route.h File Reference

#include <stdint.h>
#include <Net/ipv6.h>
#include <Fs/vfs.h>

Include dependency graph for route.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_route_entry_
struct	_route_entry6_
struct	_route_entry_info_
struct	_au_route_result_
struct	_au_route_result6_

Macros
#define	RTF_UP   0x01
#define	RTF_HOST   0x02
#define	RTF_GATEWAY   0x04
#define	RTF_LOCAL   0x08
#define	RTF_CONNECTED   0x10

Typedefs
typedef struct _route_entry_	AuRouteEntry
typedef struct _route_entry6_	AuRouteEntry6
typedef struct _route_entry_info_	AuRouteEntryInfo
typedef struct _au_route_result_	AuRouteResult
typedef struct _au_route_result6_	AuRouteResult6

Functions
void	AuRouteTableInitialise ()
	AuRouteTableInitialise – initialise the kernel route table.
AuRouteEntry *	AuRouteTableCreateEntry ()
	AuRouteTableCreateEntry – create a new route table entry and return.
void	AuRouteTableAdd (AuRouteEntry *entry)
	AuRouteTableAdd – add an entry to route table. Allows default route (dest==0 && netmask==0). Replaces an existing entry with the same dest/netmask/ifname.
void	AuRouteTableDelete (AuRouteEntry *entry)
	AuRouteTableDelete – delete an entry from route table (including default 0/0).
AU_EXTERN AU_EXPORT int	AuRouteSetFlag4 (const char *ifname, uint32_t dest, uint32_t netmask, int up)
int	AuRouteTableGetNumEntry ()
	AuRouteTableGetNumEntry – returns the number route entry present in the system.
void	AuRouteTablePopulate (AuRouteEntry *whereToPopulate, int entryIndex)
	AuRouteTablePopulate – populates a given memory pointer with route table entry indexed by entryIndex number.
AuRouteEntry *	AuRouteTableDoRouteLookup (uint32_t address)
	AuRouteTableDoRouteLookup – longest-prefix match; skip !RTF_UP. Prefer LOCAL over CONNECTED over default when prefixes tie.
int	AuRouteLookup4 (uint32_t address, AuRouteResult *out)
void	AuRouteTable6Initialise ()
AuRouteEntry6 *	AuRouteTable6CreateEntry ()
void	AuRouteTable6Add (AuRouteEntry6 *entry)
void	AuRouteTable6Delete (AuRouteEntry6 *entry)
AuRouteEntry6 *	AuRouteTableDoRouteLookup6 (const ip6_addr *address)
int	AuRouteLookup6 (const ip6_addr *address, AuRouteResult6 *out)

Macro Definition Documentation

RTF_CONNECTED

#define RTF_CONNECTED   0x10

RTF_GATEWAY

#define RTF_GATEWAY   0x04

RTF_HOST

#define RTF_HOST   0x02

RTF_LOCAL

#define RTF_LOCAL   0x08

RTF_UP

#define RTF_UP   0x01

BSD 2-Clause License

Copyright (c) 2022-2024, Manas Kamal Choudhury All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Typedef Documentation

AuRouteEntry

typedef struct _route_entry_ AuRouteEntry

AuRouteEntry6

typedef struct _route_entry6_ AuRouteEntry6

AuRouteEntryInfo

typedef struct _route_entry_info_ AuRouteEntryInfo

AuRouteResult

typedef struct _au_route_result_ AuRouteResult

AuRouteResult6

typedef struct _au_route_result6_ AuRouteResult6

Function Documentation

AuRouteLookup4()

int AuRouteLookup4 ( uint32_t  address, AuRouteResult *  out  )

extern

AuRouteLookup6()

int AuRouteLookup6 ( const ip6_addr *  address, AuRouteResult6 *  out  )

extern

AuRouteSetFlag4()

AU_EXTERN AU_EXPORT int AuRouteSetFlag4	(	const char *	ifname,
		uint32_t	dest,
		uint32_t	netmask,
		int	up
	)

AuRouteTable6Add()

void AuRouteTable6Add ( AuRouteEntry6 *  entry )

extern

AuRouteTable6CreateEntry()

AuRouteEntry6 * AuRouteTable6CreateEntry ( )

extern

AuRouteTable6Delete()

void AuRouteTable6Delete ( AuRouteEntry6 *  entry )

extern

AuRouteTable6Initialise()

void AuRouteTable6Initialise ( )

extern

AuRouteTableAdd()

void AuRouteTableAdd ( AuRouteEntry *  entry )

extern

AuRouteTableAdd – add an entry to route table. Allows default route (dest==0 && netmask==0). Replaces an existing entry with the same dest/netmask/ifname.

AuRouteTableCreateEntry()

AuRouteEntry * AuRouteTableCreateEntry ( )

extern

AuRouteTableCreateEntry – create a new route table entry and return.

AuRouteTableDelete()

void AuRouteTableDelete ( AuRouteEntry *  entry )

extern

AuRouteTableDelete – delete an entry from route table (including default 0/0).

AuRouteTableDoRouteLookup()

AuRouteEntry * AuRouteTableDoRouteLookup ( uint32_t  address )

extern

AuRouteTableDoRouteLookup – longest-prefix match; skip !RTF_UP. Prefer LOCAL over CONNECTED over default when prefixes tie.

AuRouteTableDoRouteLookup6()

AuRouteEntry6 * AuRouteTableDoRouteLookup6 ( const ip6_addr *  address )

extern

AuRouteTableGetNumEntry()

int AuRouteTableGetNumEntry ( )

extern

AuRouteTableGetNumEntry – returns the number route entry present in the system.

AuRouteTableInitialise()

void AuRouteTableInitialise ( )

extern

AuRouteTableInitialise – initialise the kernel route table.

AuRouteTablePopulate()

void AuRouteTablePopulate ( AuRouteEntry *  whereToPopulate, int  entryIndex  )

extern

AuRouteTablePopulate – populates a given memory pointer with route table entry indexed by entryIndex number.