Welcome to Linux Knowledge Base and Tutorial
"The place where you learn linux"
Let The Music Play: Join EFF Today

 Create an AccountHome | Submit News | Your Account  

Tutorial Menu
Linux Tutorial Home
Table of Contents

· Introduction to Operating Systems
· Linux Basics
· Working with the System
· Shells and Utilities
· Editing Files
· Basic Administration
· The Operating System
· The X Windowing System
· The Computer Itself
· Networking
· System Monitoring
· Solving Problems
· Security
· Installing and Upgrading
· Linux and Windows

Glossary
MoreInfo
Man Pages
Linux Topics
Test Your Knowledge

Site Menu
Site Map
FAQ
Copyright Info
Terms of Use
Privacy Info
Disclaimer
WorkBoard
Thanks
Donations
Advertising
Masthead / Impressum
Your Account

Communication
Feedback
Forums
Private Messages
Surveys

Features
HOWTOs
News Archive
Submit News
Topics
User Articles
Web Links

Google
Google


The Web
linux-tutorial.info

Who's Online
There are currently, 270 guest(s) and 5 member(s) that are online.

You are an Anonymous user. You can register for free by clicking here

  

ip



SYNOPSIS

       #include <sys/socket.h>
       #include <netinet/in.h>

       tcp_socket = socket(PF_INET, SOCK_STREAM, 0);
       raw_socket = socket(PF_INET, SOCK_RAW, protocol);
       udp_socket = socket(PF_INET, SOCK_DGRAM, protocol);


DESCRIPTION

       Linux   implements   the  Internet  Protocol,  version  4,
       described in RFC791 and RFC1122.  ip contains  a  level  2
       multicasting  implementation  conforming  to  RFC1112.  It
       also contains an IP router including a packet filter.

       The programmer's interface is BSD sockets compatible.  For
       more information on sockets, see socket(7).

       An  IP socket is created by calling the socket(2) function
       as socket(PF_INET, socket_type, protocol).   Valid  socket
       types  are SOCK_STREAM to open a tcp(7) socket, SOCK_DGRAM
       to open a udp(7) socket, or  SOCK_RAW  to  open  a  raw(7)
       socket  to  access  the IP protocol directly.  protocol is
       the IP protocol in the IP header to be received  or  sent.
       The  only  valid values for protocol are 0 and IPPROTO_TCP
       for TCP sockets and 0 and  IPPROTO_UDP  for  UDP  sockets.
       For  SOCK_RAW  you  may  specify  a valid IANA IP protocol
       defined in RFC1700 assigned numbers.

       When a process wants to receive new  incoming  packets  or
       connections,  it should bind a socket to a local interface
       address using bind(2).  Only one IP socket may be bound to
       any  given local (address, port) pair.  When INADDR_ANY is
       specified in the bind call the socket will be bound to all
       local  interfaces. When listen(2) or connect(2) are called
       on a unbound socket the socket is automatically bound to a
       random free port with the local address set to INADDR_ANY.

       A TCP local socket address that has been bound is unavail­
       able  for some time after closing, unless the SO_REUSEADDR
       flag has been set.  Care should be taken when  using  this
       flag as it makes TCP less reliable.


ADDRESS FORMAT

       An  IP socket address is defined as a combination of an IP
       interface address and a port number. The basic IP protocol
       does  not  supply  port  numbers,  they are implemented by
       higher level protocols like udp(7)  and  tcp(7).   On  raw
       sockets sin_port is set to the IP protocol.

              struct sockaddr_in {

       reserved  ports.   Only processes with effective user id 0
       or the  CAP_NET_BIND_SERVICE  capability  may  bind(2)  to
       these sockets. Note that the raw IPv4 protocol as such has
       no concept of a port, they are only implemented by  higher
       protocols like tcp(7) and udp(7).

       sin_addr  is  the  IP  host  address.   The addr member of
       struct in_addr contains the host interface address in net­
       work  order.   in_addr  should  be only accessed using the
       inet_aton(3), inet_addr(3), inet_makeaddr(3) library func­
       tions  or  directly with the name resolver (see gethostby­
       name(3)).  IPv4 addresses are divided into unicast, broad­
       cast  and multicast addresses. Unicast addresses specify a
       single interface of a host,  broadcast  addresses  specify
       all hosts on a network and multicast addresses address all
       hosts  in  a  multicast  group.  Datagrams  to   broadcast
       addresses  can be only sent or received when the SO_BROAD­
       CAST socket flag is set.  In  the  current  implementation
       connection  oriented  sockets are only allowed to use uni­
       cast addresses.

       Note that the address and the port are  always  stored  in
       network order.  In particular, this means that you need to
       call htons(3) on the number that is assigned  to  a  port.
       All  address/port  manipulation  functions in the standard
       library work in network order.

       There  are  several  special  addresses:   INADDR_LOOPBACK
       (127.0.0.1)  always refers to the local host via the loop­
       back device; INADDR_ANY (0.0.0.0) means  any  address  for
       binding; INADDR_BROADCAST (255.255.255.255) means any host
       and has the same effect on bind as INADDR_ANY for histori­
       cal reasons.


SOCKET OPTIONS

       IP supports some protocol specific socket options that can
       be set with setsockopt(2)  and  read  with  getsockopt(2).
       The socket option level for IP is SOL_IP.  A boolean inte­
       ger flag is zero when it is false, otherwise true.

       IP_OPTIONS
              Sets or get the IP options to be  sent  with  every
              packet  from  this  socket.   The  arguments  are a
              pointer to a memory buffer containing  the  options
              and the option length.  The setsockopt(2) call sets
              the IP options associated with a socket.  The maxi­
              mum  option  size  for IPv4 is 40 bytes. See RFC791
              for the allowed options. When the  initial  connec­
              tion  request  packet for a SOCK_STREAM socket con­
              tains IP options, the IP options will be set  auto­
              Pass  an IP_PKTINFO ancillary message that contains
              a pktinfo structure that supplies some  information
              about  the  incoming  packet.   This only works for
              datagram oriented sockets.  The argument is a  flag
              that  tells  the socket whether the IP_PKTINFO mes­
              sage should be passed or not.  The  message  itself
              can  only be sent/retrieved as control message with
              a packet using recvmsg(2) or sendmsg(2).

              struct in_pktinfo {
                  unsigned int   ipi_ifindex;  /* Interface index */
                  struct in_addr ipi_spec_dst; /* Local address */
                  struct in_addr ipi_addr;     /* Header Destination address */
              };

              ipi_ifindex is the unique index  of  the  interface
              the  packet  was  received on.  ipi_spec_dst is the
              local address of the packet  and  ipi_addr  is  the
              destination  address  in  the  packet  header.   If
              IP_PKTINFO is passed to sendmsg(2) and ipi_spec_dst
              is  not  zero,  then it is used as the local source
              address for the routing table lookup and  for  set­
              ting  up IP source route options.  When ipi_ifindex
              is not zero the primary local address of the inter­
              face specified by the index overwrites ipi_spec_dst
              for the routing table lookup.

       IP_RECVTOS
              If enabled the IP_TOS ancillary message  is  passed
              with  incoming  packets.  It  contains a byte which
              specifies the Type of Service/Precedence  field  of
              the packet header.  Expects a boolean integer flag.

       IP_RECVTTL
              When this flag is set  pass  a  IP_RECVTTL  control
              message with the time to live field of the received
              packet as a byte.  Not  supported  for  SOCK_STREAM
              sockets.

       IP_RECVOPTS
              Pass  all  incoming  IP  options  to  the user in a
              IP_OPTIONS control message. The routing header  and
              other  options  are already filled in for the local
              host. Not supported for SOCK_STREAM sockets.

       IP_RETOPTS
              Identical to IP_RECVOPTS  but  returns  raw  unpro­
              cessed  options  with  timestamp  and  route record
              Linux   sends  IPTOS_LOWDELAY  datagrams  first  by
              default, but the exact  behaviour  depends  on  the
              configured queueing discipline.  Some high priority
              levels may require an effective user id of 0 or the
              CAP_NET_ADMIN capability.  The priority can also be
              set  in  a  protocol   independent   way   by   the
              (SOL_SOCKET,   SO_PRIORITY)   socket   option  (see
              socket(7)).

       IP_TTL Set or retrieve the current time to live field that
              is send in every packet send from this socket.

       IP_HDRINCL
              If  enabled the user supplies an ip header in front
              of the user data. Only valid for SOCK_RAW  sockets.
              See  raw(7) for more information. When this flag is
              enabled the values set by  IP_OPTIONS,  IP_TTL  and
              IP_TOS are ignored.

       IP_RECVERR (defined in <linux/errqueue.h>)
              Enable  extended  reliable  error  message passing.
              When enabled on a  datagram  socket  all  generated
              errors  will be queued in a per-socket error queue.
              When the user receives an error from a socket oper­
              ation   the  errors  can  be  received  by  calling
              recvmsg(2) with  the  MSG_ERRQUEUE  flag  set.  The
              sock_extended_err  structure  describing  the error
              will be passed in a ancillary message with the type
              IP_RECVERR  and  the  level SOL_IP.  This is useful
              for reliable error handling on unconnected sockets.
              The  received  data portion of the error queue con­
              tains the error packet.

              The   IP_RECVERR   control   message   contains   a
              sock_extended_err structure:

              #define SO_EE_ORIGIN_NONE       0
              #define SO_EE_ORIGIN_LOCAL      1
              #define SO_EE_ORIGIN_ICMP       2
              #define SO_EE_ORIGIN_ICMP6      3

              struct sock_extended_err {
                  u_int32_t       ee_errno;   /* error number */
                  u_int8_t        ee_origin;  /* where the error originated */
                  u_int8_t        ee_type;    /* type */
                  u_int8_t        ee_code;    /* code */
                  u_int8_t        ee_pad;
                  u_int32_t       ee_info;    /* additional information */
                  u_int32_t       ee_data;    /* other data */

              undefined.

              IP uses the sock_extended_err structure as follows:
              ee_origin  is  set  to SO_EE_ORIGIN_ICMP for errors
              received as an ICMP packet,  or  SO_EE_ORIGIN_LOCAL
              for locally generated errors. Unknown values should
              be ignored.  ee_type and ee_code are set  from  the
              type  and  code fields of the ICMP header.  ee_info
              contains the discovered MTU  for  EMSGSIZE  errors.
              The  message  also  contains the sockaddr_in of the
              node caused the error, which can be  accessed  with
              the  SO_EE_OFFENDER  macro. The sin_family field of
              the SO_EE_OFFENDER address is  AF_UNSPEC  when  the
              source was unknown.  When the error originated from
              the network, all IP  options  (IP_OPTIONS,  IP_TTL,
              etc.)  enabled  on  the socket and contained in the
              error packet are passed as  control  messages.  The
              payload of the packet causing the error is returned
              as normal payload.  Note  that  TCP  has  no  error
              queue; MSG_ERRQUEUE is illegal on SOCK_STREAM sock­
              ets.  Thus all errors are returned by socket  func­
              tion return or SO_ERROR only.

              For  raw sockets, IP_RECVERR enables passing of all
              received ICMP errors to the application,  otherwise
              errors are only reported on connected sockets

              It  sets  or  retrieves  an  integer  boolean flag.
              IP_RECVERR defaults to off.

       IP_MTU_DISCOVER
              Sets or receives the Path MTU Discovery setting for
              a socket. When enabled, Linux will perform Path MTU
              Discovery as defined in RFC1191 on this socket. The
              don't  fragment  flag  is set on all outgoing data­
              grams.  The system-wide default  is  controlled  by
              the ip_no_pmtu_disc sysctl for SOCK_STREAM sockets,
              and disabled on all  others.  For  non  SOCK_STREAM
              sockets  it  is the user's responsibility to packe­
              tize the data in MTU sized chunks  and  to  do  the
              retransmits  if  necessary.  The kernel will reject
              packets that are bigger than the known path MTU  if
              this flag is set (with EMSGSIZE ).

              Path MTU discovery flags   Meaning
              IP_PMTUDISC_WANT           Use per-route settings.
              IP_PMTUDISC_DONT           Never do Path MTU Discovery.
              IP_PMTUDISC_DO             Always do Path MTU Discovery.

              When PMTU discovery is enabled the kernel automati­
              into account for their packet retransmit  strategy.

              To  bootstrap  the  path  MTU  discovery process on
              unconnected sockets it is possible to start with  a
              big  datagram  size  (up to 64K-headers bytes long)
              and let it shrink by updates of the path MTU.

              To get an initial estimate of the path MTU  connect
              a  datagram socket to the destination address using
              connect(2) and retrieve the MTU by calling getsock­
              opt(2) with the IP_MTU option.

       IP_MTU Retrieve  the current known path MTU of the current
              socket.  Only valid when the socket has  been  con­
              nected.  Returns  an  integer. Only valid as a get­
              sockopt(2).

       IP_ROUTER_ALERT
              Pass all to-be forwarded packets with the IP Router
              Alert option set to this socket. Only valid for raw
              sockets. This is useful,  for  instance,  for  user
              space RSVP daemons. The tapped packets are not for­
              warded by the kernel, it is the users  responsibil­
              ity  to  send  them  out  again.  Socket binding is
              ignored, such packets are only filtered  by  proto­
              col.  Expects an integer flag.

       IP_MULTICAST_TTL
              Set  or  reads  the  time-to-live value of outgoing
              multicast packets  for  this  socket.  It  is  very
              important for multicast packets to set the smallest
              TTL possible.  The default is 1  which  means  that
              multicast  packets  don't  leave  the local network
              unless the user  program  explicitly  requests  it.
              Argument is an integer.

       IP_MULTICAST_LOOP
              Sets  or  reads  a boolean integer argument whether
              sent multicast packets should be looped back to the
              local sockets.

       IP_ADD_MEMBERSHIP
              Join  a  multicast  group.  Argument  is  a  struct
              ip_mreqn structure.

              struct ip_mreqn {
                  struct in_addr imr_multiaddr; /* IP multicast group address */
                  struct in_addr imr_address;   /* IP address of local interface */
                  int            imr_ifindex;   /* interface index */
              };

              a setsockopt(2).

       IP_DROP_MEMBERSHIP
              Leave a multicast group. Argument is an ip_mreqn or
              ip_mreq structure similar to IP_ADD_MEMBERSHIP.

       IP_MULTICAST_IF
              Set  the local device for a multicast socket. Argu­
              ment is an ip_mreqn or ip_mreq structure similar to
              IP_ADD_MEMBERSHIP.

              When  an  invalid  socket option is passed, ENOPRO­
              TOOPT is returned.


SYSCTLS

       The IP protocol supports the sysctl interface to configure
       some  global options. The sysctls can be accessed by read­
       ing or writing the /proc/sys/net/ipv4/* files or using the
       sysctl(2) interface.

       ip_default_ttl
              Set  the  default  time-to-live  value  of outgoing
              packets. This can be changed per  socket  with  the
              IP_TTL option.

       ip_forward
              Enable  IP  forwarding with a boolean flag. IP for­
              warding can be also set on a per interface basis.

       ip_dynaddr
              Enable  dynamic  socket  address  and  masquerading
              entry  rewriting  on interface address change. This
              is useful for dialup  interface  with  changing  IP
              addresses.  0 means no rewriting, 1 turns it on and
              2 enables verbose mode.

       ip_autoconfig
              Not documented.

       ip_local_port_range
              Contains two integers that define the default local
              port  range allocated to sockets. Allocation starts
              with the first number and ends with the second num­
              ber.   Note that these should not conflict with the
              ports used by masquerading (although  the  case  is
              handled).  Also arbitary choices may cause problems
              with some firewall packet filters that make assump­
              tions  about  the local ports in use.  First number
              should be at least >1024,  better  >4096  to  avoid
              clashes with well known ports and to minimize fire­
              wall problems.

              ipfrag_low_thresh.  Contains an  integer  with  the
              number of bytes.

       ip_always_defrag
              [New  with Kernel 2.2.13; in earlier kernel version
              the feature was controlled at compile time  by  the
              CONFIG_IP_ALWAYS_DEFRAG option]

              When  this  boolean  frag  is enabled (not equal 0)
              incoming fragments (parts of IP packets that  arose
              when  some  host  between  origin  and  destination
              decided that the packets were  too  large  and  cut
              them  into  pieces)  will  be  reassembled (defrag­
              mented) before being processed, even  if  they  are
              about to be forwarded.

              Only  enable  if  running either a firewall that is
              the sole link to  your  network  or  a  transparent
              proxy;  never ever turn on here for a normal router
              or host. Otherwise fragmented communication may  me
              disturbed when the fragments would travel over dif­
              ferent links. Defragmentation also has a large mem­
              ory and CPU time cost.

              This  is  automagically turned on when masquerading
              or transparent proxying are configured.

       neigh/*
              See arp(7).


IOCTLS

       All ioctls described in socket(7) apply to ip.

       The ioctls to  configure  firewalling  are  documented  in
       ipfw(7) from the ipchains package.

       Ioctls   to   configure   generic  device  parameters  are
       described in netdevice(7).


NOTES

       Be very careful with the SO_BROADCAST option - it  is  not
       privileged  in  Linux.  It is easy to overload the network
       with careless broadcasts. For new application protocols it
       is  better  to use a multicast group instead of broadcast­
       ing. Broadcasting is discouraged.

       Some other BSD sockets  implementations  provide  IP_RCVD­
       STADDR and IP_RECVIF socket options to get the destination
       address and the interface of received datagrams. Linux has
       the more general IP_PKTINFO for the same task.

              packet to a broadcast address  without  having  the
              SO_BROADCAST flag set.  Sending a packet via a pro­
              hibit route.  Modifying firewall  settings  without
              CAP_NET_ADMIN or effective user id 0.  Binding to a
              reserved  port  without  the   CAP_NET_BIND_SERVICE
              capacibility or effective user id 0.

       EADDRINUSE
              Tried to bind to an address already in use.

       ENOPROTOOPT and EOPNOTSUPP
              Invalid socket option passed.

       EPERM  User  doesn't have permission to set high priority,
              change  configuration,  or  send  signals  to   the
              requested process or group.

       EADDRNOTAVAIL
              A  non-existent  interface  was  requested  or  the
              requested source address was not local.

       EAGAIN Operation on a non-blocking socket would block.

       ESOCKTNOSUPPORT
              The socket is not configured or an  unknown  socket
              type was requested.

       EISCONN
              connect(2)  was  called  on  an  already  connected
              socket.

       EALREADY
              An connection operation on a non-blocking socket is
              already in progress.

       ECONNABORTED
              A connection was closed during an accept(2).

       EPIPE  The connection was unexpectedly closed or shut down
              by the other end.

       ENOENT SIOCGSTAMP was called on a socket where  no  packet
              arrived.

       EHOSTUNREACH
              No  valid  routing table entry matches the destina­
              tion address.  This error can be caused by  a  ICMP
              message from a remote router or for the local rout­
              ing table.

       ENODEV Network device not  available  or  not  capable  of
       IP_PKTINFO,     IP_MTU,    IP_MTU_DISCOVER,    IP_PKTINFO,
       IP_RECVERR and IP_ROUTER_ALERT are new  options  in  Linux
       2.2.   They  are also all Linux specific and should not be
       used in programs intended to be portable.

       struct ip_mreqn is new in Linux 2.2.  Linux 2.0 only  sup­
       ported ip_mreq.

       The sysctls were introduced with Linux 2.2.


COMPATIBILITY

       For   compatibility   with   Linux   2.0,   the   obsolete
       socket(PF_INET, SOCK_RAW, protocol) syntax is  still  sup­
       ported  to open a packet(7) socket. This is deprecated and
       should be replaced by socket(PF_PACKET,  SOCK_RAW,  proto­
       col)  instead.  The main difference is the new sockaddr_ll
       address  structure  for  generic  link  layer  information
       instead of the old sockaddr_pkt.


BUGS

       There are too many inconsistent error values.

       The  ioctls to configure IP-specific interface options and
       ARP tables are not described.

       Some versions  of  glibc  forget  to  declare  in_pktinfo.
       Workaround  currently is to copy it into your program from
       this man page.

       Receiving   the   original   destination   address    with
       MSG_ERRQUEUE  in  msg_name  by recvmsg(2) does not work in
       some 2.2 kernels.


AUTHORS

       This man page was written by Andi Kleen.


SEE ALSO

       sendmsg(2),  recvmsg(2),  socket(7),  netlink(7),  tcp(7),
       udp(7), raw(7), ipfw(7)

       RFC791 for the original IP specification.
       RFC1122 for the IPv4 host requirements.
       RFC1812 for the IPv4 router requirements.

Linux Man Page              2001-06-19                      IP(7)
  




Login
Nickname

Password

Security Code
Security Code
Type Security Code


Don't have an account yet? You can create one. As a registered user you have some advantages like theme manager, comments configuration and post comments with your name.

Help if you can!


Amazon Wish List

Did You Know?
You can help in many different ways.


Friends



Tell a Friend About Us

Bookmark and Share



Web site powered by PHP-Nuke

Is this information useful? At the very least you can help by spreading the word to your favorite newsgroups, mailing lists and forums.
All logos and trademarks in this site are property of their respective owner. The comments are property of their posters. Articles are the property of their respective owners. Unless otherwise stated in the body of the article, article content (C) 1994-2013 by James Mohr. All rights reserved. The stylized page/paper, as well as the terms "The Linux Tutorial", "The Linux Server Tutorial", "The Linux Knowledge Base and Tutorial" and "The place where you learn Linux" are service marks of James Mohr. All rights reserved.
The Linux Knowledge Base and Tutorial may contain links to sites on the Internet, which are owned and operated by third parties. The Linux Tutorial is not responsible for the content of any such third-party site. By viewing/utilizing this web site, you have agreed to our disclaimer, terms of use and privacy policy. Use of automated download software ("harvesters") such as wget, httrack, etc. causes the site to quickly exceed its bandwidth limitation and are therefore expressly prohibited. For more details on this, take a look here

PHP-Nuke Copyright © 2004 by Francisco Burzi. This is free software, and you may redistribute it under the GPL. PHP-Nuke comes with absolutely no warranty, for details, see the license.
Page Generation: 0.03 Seconds