proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2026-01-07 03:52:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

lib: document vrf_socket(), vrf_bind()

Browse Source 
These two don't really do what you might expect, document them

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
This commit is contained in:
Quentin Young 2019-12-18 15:58:08 -05:00
parent 490810d52a
commit 79a80af8b4
2 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
lib/vrf.c
View File

@ -555,7 +555,6 @@ void vrf_terminate(void)
}
}
/* Create a socket for the VRF. */
int vrf_socket(int domain, int type, int protocol, vrf_id_t vrf_id,
const char *interfacename)
{

25
lib/vrf.h
View File

@ -218,13 +218,36 @@ extern void vrf_terminate(void);
* or call network operations
*/
/* Create a socket serving for the given VRF */
/*
* Create a new socket associated with a VRF.
*
* This is a wrapper that ensures correct behavior when using namespace VRFs.
* In the namespace case, the socket is created within the namespace. In the
* non-namespace case, this is equivalent to socket().
*
* If name is provided, this is provided to vrf_bind() to bind the socket to
* the VRF. This is only relevant when using VRF-lite.
*
* Summary:
* - Namespace: pass vrf_id but not name
* - VRF-lite: pass vrf_id and name of VRF device to bind to
* - VRF-lite, no binding: pass vrf_id but not name, or just use socket()
*/
extern int vrf_socket(int domain, int type, int protocol, vrf_id_t vrf_id,
const char *name);
extern int vrf_sockunion_socket(const union sockunion *su, vrf_id_t vrf_id,
const char *name);
/*
* Binds a socket to a VRF device.
*
* If name is null, the socket is not bound, irrespective of any other
* arguments.
*
* name should be the name of the VRF device. vrf_id should be the
* corresponding vrf_id (the ifindex of the device).
*/
extern int vrf_bind(vrf_id_t vrf_id, int fd, const char *name);
/* VRF ioctl operations */