root/sys/netinet/ip_var.h
/*
 * Copyright (c) 1982, 1986, 1993
 *      The Regents of the University of California.  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.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
 *
 *      @(#)ip_var.h    8.2 (Berkeley) 1/9/95
 * $FreeBSD: src/sys/netinet/ip_var.h,v 1.50.2.13 2003/08/24 08:24:38 hsu Exp $
 */

#ifndef _NETINET_IP_VAR_H_
#define _NETINET_IP_VAR_H_

#ifndef _SYS_TYPES_H_
#include <sys/types.h>
#endif
#ifndef _SYS_QUEUE_H_
#include <sys/queue.h>
#endif
#ifndef _NETINET_IN_H_
#include <netinet/in.h>
#endif

#ifdef _KERNEL

#include <machine/endian.h>
#ifndef _MACHINE_PARAM_H_
#include <machine/param.h>
#endif
#ifndef _NET_ROUTE_H
#include <net/route.h>
#endif

#endif

/*
 * Overlay for ip header used by other protocols (tcp, udp).
 */
struct ipovly {
        u_char  ih_x1[9];               /* (unused) */
        u_char  ih_pr;                  /* protocol */
        u_short ih_len;                 /* protocol length */
        struct  in_addr ih_src;         /* source internet address */
        struct  in_addr ih_dst;         /* destination internet address */
};

/*
 * Ip reassembly queue structure.  Each fragment
 * being reassembled is attached to one of these structures.
 * They are timed out after ipq_ttl drops to 0, and may also
 * be reclaimed if memory becomes tight.
 */
struct ipq {
        TAILQ_ENTRY(ipq) ipq_list;      /* to other reass headers */
        u_char  ipq_ttl;                /* time for reass q to live */
        u_char  ipq_p;                  /* protocol of this fragment */
        u_short ipq_id;                 /* sequence id for reassembly */
        struct mbuf *ipq_frags;         /* to ip headers of fragments */
        struct  in_addr ipq_src,ipq_dst;
        u_char  ipq_nfrags;             /* # frags in this packet */
};

/*
 * Structure stored in mbuf in inpcb.ip_options
 * and passed to ip_output when ip options are in use.
 * The actual length of the options (including ipopt_dst)
 * is in m_len.
 */
#define MAX_IPOPTLEN    40

struct ipoption {
        struct  in_addr ipopt_dst;      /* first-hop dst if source routed */
        char    ipopt_list[MAX_IPOPTLEN];       /* options proper */
};

/*
 * Structure attached to inpcb.ip_moptions and
 * passed to ip_output when IP multicast options are in use.
 */
struct ip_moptions {
        struct  ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
        struct in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
        u_char  imo_multicast_ttl;      /* TTL for outgoing multicasts */
        u_char  imo_multicast_loop;     /* 1 => hear sends if a member */
        u_short imo_num_memberships;    /* no. memberships this socket */
        u_short imo_max_memberships;    /* max memberships this socket */
        struct  in_multi *imo_membership[IP_MAX_MEMBERSHIPS];
        u_long  imo_multicast_vif;      /* vif num outgoing multicasts */
};

/*
 * IP Statistics.
 *
 * NOTE: Make sure this struct's size is multiple cache line size.
 */
struct  ip_stats {
        u_long  ips_total;              /* total packets received */
        u_long  ips_badsum;             /* checksum bad */
        u_long  ips_tooshort;           /* packet too short */
        u_long  ips_toosmall;           /* not enough data */
        u_long  ips_badhlen;            /* ip header length < data size */
        u_long  ips_badlen;             /* ip length < ip header length */
        u_long  ips_fragments;          /* fragments received */
        u_long  ips_fragdropped;        /* frags dropped (dups, out of space) */
        u_long  ips_fragtimeout;        /* fragments timed out */
        u_long  ips_forward;            /* packets forwarded */
        u_long  ips_fastforward;        /* packets fast forwarded */
        u_long  ips_cantforward;        /* packets rcvd for unreachable dest */
        u_long  ips_redirectsent;       /* packets forwarded on same net */
        u_long  ips_noproto;            /* unknown or unsupported protocol */
        u_long  ips_delivered;          /* datagrams delivered to upper level*/
        u_long  ips_localout;           /* total ip packets generated here */
        u_long  ips_odropped;           /* lost packets due to nobufs, etc. */
        u_long  ips_reassembled;        /* total packets reassembled ok */
        u_long  ips_fragmented;         /* datagrams successfully fragmented */
        u_long  ips_ofragments;         /* output fragments created */
        u_long  ips_cantfrag;           /* don't fragment flag was set, etc. */
        u_long  ips_badoptions;         /* error in option processing */
        u_long  ips_noroute;            /* packets discarded due to no route */
        u_long  ips_badvers;            /* ip version != 4 */
        u_long  ips_rawout;             /* total raw ip packets generated */
        u_long  ips_toolong;            /* ip length > max ip packet size */
        u_long  ips_notmember;          /* multicasts for unregistered grps */
        u_long  ips_nogif;              /* no match gif found */
        u_long  ips_badaddr;            /* invalid address on header */
        u_long  ips_pad[3];             /* pad to cache line size (64B) */
};
#ifdef _KERNEL
CTASSERT((sizeof(struct ip_stats) & __VM_CACHELINE_MASK) == 0);
#endif

#ifdef _KERNEL

#define ipstat  ipstats_percpu[mycpuid]

extern struct ip_stats  ipstats_percpu[MAXCPU];

/* flags passed to ip_output as last parameter */
#define IP_FORWARDING           0x1             /* most of ip header exists */
#define IP_RAWOUTPUT            0x2             /* raw ip header exists */
#define IP_ROUTETOIF            SO_DONTROUTE    /* bypass routing tables */
#define IP_ALLOWBROADCAST       SO_BROADCAST    /* can send broadcast packets */
#define IP_DEBUGROUTE           0x10000         /* debug route */

struct ip;
struct inpcb;
struct route;
struct sockopt;
struct lwkt_port;
struct pktinfo;
union netmsg;

extern u_short  ip_id;                          /* ip packet ctr, for ids */
extern int      ip_defttl;                      /* default IP ttl */
extern int      ipforwarding;                   /* ip forwarding */
extern int      ip_porthash_trycount;
extern u_char   ip_protox[];
extern struct socket *ip_rsvpd;         /* reservation protocol daemon */
extern struct socket *ip_mrouter;       /* multicast routing daemon */
extern int      (*legal_vif_num)(int);
extern u_long   (*ip_mcast_src)(int);
extern int rsvp_on;
extern struct   pr_usrreqs rip_usrreqs;

void     ip_ctloutput(union netmsg *);
void     ip_drain(void);
int      ip_fragment(struct ip *ip, struct mbuf **m_frag, int mtu,
            u_long if_hwassist_flags, int sw_csum);
struct mbuf *
         ip_reass(struct mbuf *);
void     ip_freemoptions(struct ip_moptions *);
void     ip_init(void);
extern int       (*ip_mforward)(struct ip *, struct ifnet *, struct mbuf *,
                          struct ip_moptions *);

void     ip_hashfn(struct mbuf **, int);
void     ip_hashcheck(struct mbuf *, const struct pktinfo *);
struct mbuf *
         ip_rehashm(struct mbuf *);
void     ip_transport_redispatch(struct lwkt_port *, struct mbuf *, int);

boolean_t
         ip_lengthcheck(struct mbuf **, int);
int      ip_output(struct mbuf *,
            struct mbuf *, struct route *, int, struct ip_moptions *,
            struct inpcb *);
struct in_ifaddr *
         ip_rtaddr(struct in_addr, struct route *);
void     ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
                struct mbuf *);
struct mbuf *
         ip_srcroute(struct mbuf *);
void     ip_stripoptions(struct mbuf *);
u_int16_t ip_randomid(void);
void    rip_ctloutput(union netmsg *);
void    rip_init(void);
int     rip_input(struct mbuf **, int *, int);
int     rip_output(struct mbuf *, struct socket *, ...);
extern int (*ipip_input)(struct mbuf **, int *, int);
int     rsvp_input(struct mbuf **, int *, int);
int     ip_rsvp_init(struct socket *);
int     ip_rsvp_done(void);
extern int      (*ip_rsvp_vif)(struct socket *, struct sockopt *);
extern void     (*ip_rsvp_force_done)(struct socket *);
extern int      (*rsvp_input_p)(struct mbuf **, int *, int);

extern  struct pfil_head inet_pfil_hook;

void    in_delayed_cksum(struct mbuf *m);

static __inline uint16_t ip_newid(void);
extern int ip_do_randomid;

static __inline uint16_t
ip_newid(void)
{
    if (ip_do_randomid)
        return ip_randomid();
    else
        return __htons(ip_id++);
}

#endif /* _KERNEL */

#endif /* !_NETINET_IP_VAR_H_ */