NetBSD/sys/netiso/iso_pcb.h
dyoung 72f0a6dfb0 Eliminate address family-specific route caches (struct route, struct
route_in6, struct route_iso), replacing all caches with a struct
route.

The principle benefit of this change is that all of the protocol
families can benefit from route cache-invalidation, which is
necessary for correct routing.  Route-cache invalidation fixes an
ancient PR, kern/3508, at long last; it fixes various other PRs,
also.

Discussions with and ideas from Joerg Sonnenberger influenced this
work tremendously.  Of course, all design oversights and bugs are
mine.

DETAILS

1 I added to each address family a pool of sockaddrs.  I have
  introduced routines for allocating, copying, and duplicating,
  and freeing sockaddrs:

        struct sockaddr *sockaddr_alloc(sa_family_t af, int flags);
        struct sockaddr *sockaddr_copy(struct sockaddr *dst,
                                       const struct sockaddr *src);
        struct sockaddr *sockaddr_dup(const struct sockaddr *src, int flags);
        void sockaddr_free(struct sockaddr *sa);

  sockaddr_alloc() returns either a sockaddr from the pool belonging
  to the specified family, or NULL if the pool is exhausted.  The
  returned sockaddr has the right size for that family; sa_family
  and sa_len fields are initialized to the family and sockaddr
  length---e.g., sa_family = AF_INET and sa_len = sizeof(struct
  sockaddr_in).  sockaddr_free() puts the given sockaddr back into
  its family's pool.

  sockaddr_dup() and sockaddr_copy() work analogously to strdup()
  and strcpy(), respectively.  sockaddr_copy() KASSERTs that the
  family of the destination and source sockaddrs are alike.

  The 'flags' argumet for sockaddr_alloc() and sockaddr_dup() is
  passed directly to pool_get(9).

2 I added routines for initializing sockaddrs in each address
  family, sockaddr_in_init(), sockaddr_in6_init(), sockaddr_iso_init(),
  etc.  They are fairly self-explanatory.

3 structs route_in6 and route_iso are no more.  All protocol families
  use struct route.  I have changed the route cache, 'struct route',
  so that it does not contain storage space for a sockaddr.  Instead,
  struct route points to a sockaddr coming from the pool the sockaddr
  belongs to.  I added a new method to struct route, rtcache_setdst(),
  for setting the cache destination:

        int rtcache_setdst(struct route *, const struct sockaddr *);

  rtcache_setdst() returns 0 on success, or ENOMEM if no memory is
  available to create the sockaddr storage.

  It is now possible for rtcache_getdst() to return NULL if, say,
  rtcache_setdst() failed.  I check the return value for NULL
  everywhere in the kernel.

4 Each routing domain (struct domain) has a list of live route
  caches, dom_rtcache.  rtflushall(sa_family_t af) looks up the
  domain indicated by 'af', walks the domain's list of route caches
  and invalidates each one.
2007-05-02 20:40:22 +00:00

131 lines
5.2 KiB
C

/* $NetBSD: iso_pcb.h,v 1.17 2007/05/02 20:40:29 dyoung Exp $ */
/*-
* Copyright (c) 1991, 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.
*
* @(#)iso_pcb.h 8.1 (Berkeley) 6/10/93
*/
/***********************************************************
Copyright IBM Corporation 1987
All Rights Reserved
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation, and that the name of IBM not be
used in advertising or publicity pertaining to distribution of the
software without specific, written prior permission.
IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
IBM BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.
******************************************************************/
/*
* ARGO Project, Computer Sciences Dept., University of Wisconsin - Madison
*/
#ifndef _NETISO_ISO_PCB_H_
#define _NETISO_ISO_PCB_H_
#include <net/route.h>
#define MAXX25CRUDLEN 16 /* 16 bytes of call request user data */
/*
* Common structure pcb for argo protocol implementation.
*/
struct isopcb {
struct isopcb *isop_next, *isop_prev; /* pointers to other pcb's */
struct isopcb *isop_head; /* pointer back to chain of pcbs for
* this protocol */
struct socket *isop_socket; /* back pointer to socket */
struct sockaddr_iso *isop_laddr;
struct sockaddr_iso *isop_faddr;
struct route isop_route; /* CLNP routing entry */
struct mbuf *isop_options; /* CLNP options */
struct mbuf *isop_optindex; /* CLNP options index */
struct mbuf *isop_clnpcache; /* CLNP cached hdr */
void * isop_chan; /* actually struct pklcb * */
u_short isop_refcnt; /* mult TP4 tpcb's -> here */
u_short isop_lport; /* MISLEADLING work var */
u_short isop_tuba_cached; /* for tuba address ref cnts */
int isop_x25crud_len; /* x25 call request ud */
char isop_x25crud[MAXX25CRUDLEN];
struct ifaddr *isop_ifa; /* ESIS interface assoc w/sock */
struct mbuf *isop_mladdr; /* dynamically allocated laddr */
struct mbuf *isop_mfaddr; /* dynamically allocated faddr */
struct sockaddr_iso isop_sladdr, /* preallocated laddr */
isop_sfaddr; /* preallocated faddr */
};
#ifdef sotorawcb
/*
* Common structure pcb for raw clnp protocol access.
* Here are clnp specific extensions to the raw control block,
* and space is allocated to the necessary sockaddrs.
*/
struct rawisopcb {
struct rawcb risop_rcb; /* common control block prefix */
int risop_flags; /* flags, e.g. raw sockopts */
struct isopcb risop_isop; /* space for bound addresses, routes
* etc. */
};
#endif
#define sotoisopcb(so) ((struct isopcb *)(so)->so_pcb)
#define sotorawisopcb(so) ((struct rawisopcb *)(so)->so_pcb)
#ifdef _KERNEL
struct socket;
struct isopcb;
struct inpcb;
struct mbuf;
struct sockaddr_iso;
int iso_pcballoc (struct socket *, void *);
int iso_pcbbind (void *, struct mbuf *, struct lwp *);
int iso_pcbconnect (void *, struct mbuf *, struct lwp *);
void iso_pcbdisconnect (void *);
void iso_pcbdetach (void *);
void iso_pcbnotify(struct isopcb *, const struct sockaddr_iso *, int,
void (*)(struct isopcb *));
struct isopcb *iso_pcblookup (struct isopcb *, int, void *,
const struct sockaddr_iso *);
#endif
#endif /* !_NETISO_ISO_PCB_H_ */