lib/libc/sys/setfib.2

   1 .\" Copyright (c) 2008 Cisco Systems.  All rights reserved.
   2 .\"    Author: Julian Elischer
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Neither the name of the Cisco Systems nor the names of its employees
  10 .\"    may be used to endorse or promote products derived from this software
  11 .\"    without specific prior written permission.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 19, 2012
  28 .Dt SETFIB 2
  29 .Os
  30 .Sh NAME
  31 .Nm setfib
  32 .Nd set the default FIB (routing table) for the calling process.
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In sys/socket.h
  37 .Ft int
  38 .Fn setfib "int fib"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn setfib
  42 system call sets the associated fib for all sockets opened
  43 subsequent to the call, to be that of the argument
  44 .Fa fib .
  45 The
  46 .Fa fib
  47 argument
  48 must be greater than or equal to 0
  49 and less than the current system maximum which
  50 may be retrieved by the
  51 .Va net.fibs
  52 sysctl.
  53 The system maximum is set in the kernel configuration file with
  54 .Pp
  55 .Dl options     ROUTETABLES= Ns Em N
  56 .Pp
  57 or in
  58 .Pa /boot/loader.conf
  59 with
  60 .Pp
  61 .Dl net.fibs= Ns Qq Em N
  62 .Pp
  63 where
  64 .Em N
  65 is an integer.
  66 However, this maximum is capped at 16 due to the implementation storing
  67 the fib number in a 4-bit field in
  68 .Xr mbuf 9
  69 flags.
  70 The default fib of the process will be applied to all protocol families
  71 that support multiple fibs, and ignored by those that do not.
  72 The default fib for a process may be overridden for a socket with the use
  73 of the
  74 .Dv SO_SETFIB
  75 socket option.
  76 .Sh RETURN VALUES
  77 .Rv -std setfib
  78 .Sh ERRORS
  79 The
  80 .Fn setfib
  81 system call
  82 will fail and no action will be taken and return
  83 .Er EINVAL
  84 if the
  85 .Fa fib
  86 argument is greater than the current system maximum.
  87 .Sh SEE ALSO
  88 .Xr setfib 1 ,
  89 .Xr setsockopt 2
  90 .Sh STANDARDS
  91 The
  92 .Fn setfib
  93 system call is a
  94 .Fx
  95 extension however similar extensions
  96 have been added to many other
  97 .Ux
  98 style kernels.
  99 .Sh HISTORY
 100 The
 101 .Fn setfib
 102 function appeared in
 103 .Fx 7.1 .