freebsd-skq/sys/netatm/port.h
bmilekic 4b6a7bddad * Rename M_WAIT mbuf subsystem flag to M_TRYWAIT.
This is because calls with M_WAIT (now M_TRYWAIT) may not wait
  forever when nothing is available for allocation, and may end up
  returning NULL. Hopefully we now communicate more of the right thing
  to developers and make it very clear that it's necessary to check whether
  calls with M_(TRY)WAIT also resulted in a failed allocation.
  M_TRYWAIT basically means "try harder, block if necessary, but don't
  necessarily wait forever." The time spent blocking is tunable with
  the kern.ipc.mbuf_wait sysctl.
  M_WAIT is now deprecated but still defined for the next little while.

* Fix a typo in a comment in mbuf.h

* Fix some code that was actually passing the mbuf subsystem's M_WAIT to
  malloc(). Made it pass M_WAITOK instead. If we were ever to redefine the
  value of the M_WAIT flag, this could have became a big problem.
2000-12-21 21:44:31 +00:00

565 lines
16 KiB
C

/*
*
* ===================================
* HARP | Host ATM Research Platform
* ===================================
*
*
* This Host ATM Research Platform ("HARP") file (the "Software") is
* made available by Network Computing Services, Inc. ("NetworkCS")
* "AS IS". NetworkCS does not provide maintenance, improvements or
* support of any kind.
*
* NETWORKCS MAKES NO WARRANTIES OR REPRESENTATIONS, EXPRESS OR IMPLIED,
* INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE, AS TO ANY ELEMENT OF THE
* SOFTWARE OR ANY SUPPORT PROVIDED IN CONNECTION WITH THIS SOFTWARE.
* In no event shall NetworkCS be responsible for any damages, including
* but not limited to consequential damages, arising from or relating to
* any use of the Software or related support.
*
* Copyright 1994-1998 Network Computing Services, Inc.
*
* Copies of this Software may be made, however, the above copyright
* notice must be reproduced on all copies.
*
* @(#) $FreeBSD$
*
*/
/*
* System Configuration
* --------------------
*
* Porting aides
*
*/
#ifndef _NETATM_PORT_H
#define _NETATM_PORT_H
/*
* Try to ensure that this system is supported
*/
#if (defined(BSD) && (BSD >= 199103))
/* 4.3 BSD Net2 based */
#elif defined(sun)
/* SunOS4.x */
#else
/* Ooops */
#error "Undefined/unsupported system type"
#endif
/*
* Kernel memory management
*
* KM_ALLOC(size, type, flags)
* Returns an allocated kernel memory chunk of size bytes.
* KM_FREE(addr, size, type)
* Free a kernel memory chunk of size bytes.
* KM_CMP(b1, b2, len)
* Compares len bytes of data from b1 against b2.
* KM_COPY(from, to, len)
* Copies len bytes of data from from to to.
* KM_ZERO(addr, len)
* Zeros len bytes of data from addr.
*
*/
#ifdef _KERNEL
#if (defined(BSD) && (BSD >= 199103))
#include <sys/malloc.h>
#define KM_ALLOC(size, type, flags) malloc((size), (type), (flags))
#define KM_FREE(addr, size, type) free((addr), (type))
#elif defined(sun)
#include <sys/kmem_alloc.h>
#define KM_ALLOC(size, type, flags) kmem_alloc(size)
#define KM_FREE(addr, size, type) kmem_free((addr), (size))
#endif
#if defined(BSD)
#define KM_CMP(b1, b2, len) bcmp((void *)(b1), (void *)(b2),\
(len))
#define KM_COPY(from, to, len) bcopy((void *)(from), (void *)(to),\
(len))
#define KM_ZERO(addr, len) bzero((void *)(addr), (len))
#endif
#define XM_COPY(f, t, l) KM_COPY((f), (t), (l))
#else
/*
* User-space memory management
*
* UM_ALLOC(size) Returns an allocated kernel memory chunk of size bytes.
* UM_FREE(addr) Free a kernel memory chunk of size bytes.
* UM_COPY(from, to, len)
* Copies len bytes of data from from to to.
* UM_ZERO(addr, len) Zeros len bytes of data from addr.
*
*/
#if (defined(BSD) && (BSD >= 199103))
#define UM_ALLOC(size) malloc((size_t)(size))
#define UM_FREE(addr) free((void *)(addr))
#define UM_COPY(from, to, len) bcopy((void *)(from), (void *)(to),\
(size_t)(len))
#define UM_ZERO(addr, len) bzero((void *)(addr), (size_t)(len))
#elif defined(sun)
#define UM_ALLOC(size) malloc(size)
#define UM_FREE(addr) free((char *)(addr))
#define UM_COPY(from, to, len) bcopy((char *)(from), (char *)(to), (len))
#define UM_ZERO(addr, len) bzero((char *)(addr), (len))
#endif
#define XM_COPY(f, t, l) UM_COPY((f), (t), (l))
#endif /* _KERNEL */
#ifdef _KERNEL
/*
* Kernel buffers
*
* KBuffer Typedef for a kernel buffer.
*
* KB_NEXT(bfr) Access next buffer in chain (r/w).
* KB_LEN(bfr) Access length of data in this buffer (r/w).
* KB_QNEXT(bfr) Access next buffer in queue (r/w).
*
* KB_ALLOC(bfr, size, flags, type)
* Allocates a new kernel buffer of at least size bytes.
* KB_ALLOCPKT(bfr, size, flags, type)
* Allocates a new kernel packet header buffer of at
* least size bytes.
* KB_ALLOCEXT(bfr, size, flags, type)
* Allocates a new kernel buffer with external storage
* of at least size bytes.
* KB_FREEONE(bfr, nxt) Free buffer bfr and set next buffer in chain in nxt.
* KB_FREEALL(bfr) Free bfr's entire buffer chain.
* KB_COPY(bfr, off, len, new, flags)
* Copy len bytes of user data from buffer bfr starting at
* byte offset off and return new buffer chain in new.
* If len is KB_COPYALL, copy until end of chain.
* KB_COPYDATA(bfr, off, len, datap)
* Copy data from buffer bfr starting at byte offset off
* for len bytes into the data area pointed to by datap.
* Returns the number of bytes not copied to datap.
* KB_PULLUP(bfr, n, new)
* Get at least the first n bytes of data in the buffer
* chain headed by bfr contiguous in the first buffer.
* Returns the (potentially new) head of the chain in new.
* On failure the chain is freed and NULL is returned.
* KB_LINKHEAD(new, head)
* Link the kernel buffer new at the head of the buffer
* chain headed by head. If both new and head are
* packet header buffers, new will become the packet
* header for the chain.
* KB_LINK(new, prev)
* Link the kernel buffer new into the buffer chain
* after the buffer prev.
* KB_UNLINKHEAD(head, next)
* Unlink the kernel buffer from the head of the buffer
* chain headed by head. The buffer head will be freed
* and the new chain head will be placed in next.
* KB_UNLINK(old, prev, next)
* Unlink the kernel buffer old with previous buffer prev
* from its buffer chain. The following buffer in the
* chain will be placed in next and the buffer old will
* be freed.
* KB_ISPKT(bfr) Tests whether bfr is a packet header buffer.
* KB_ISEXT(bfr) Tests whether bfr has external storage.
* KB_BFRSTART(bfr, x, t)
* Sets x (cast to type t) to point to the start of the
* buffer space in bfr.
* KB_BFREND(bfr, x, t)
* Sets x (cast to type t) to point one byte past the end
* of the buffer space in bfr.
* KB_BFRLEN(bfr) Returns length of buffer space in bfr.
* KB_DATASTART(bfr, x, t)
* Sets x (cast to type t) to point to the start of the
* buffer data contained in bfr.
* KB_DATAEND(bfr, x, t)
* Sets x (cast to type t) to point one byte past the end
* of the buffer data contained in bfr.
* KB_HEADSET(bfr, n) Sets the start address for buffer data in buffer bfr to
* n bytes from the beginning of the buffer space.
* KB_HEADMOVE(bfr, n) Adjust buffer data controls to move data down (n > 0)
* or up (n < 0) n bytes in the buffer bfr.
* KB_HEADADJ(bfr, n) Adjust buffer data controls to add (n > 0) or subtract
* (n < 0) n bytes of data to/from the beginning of bfr.
* KB_TAILADJ(bfr, n) Adjust buffer data controls to add (n > 0) or subtract
* (n < 0) n bytes of data to/from the end of bfr.
* KB_TAILALIGN(bfr, n) Set buffer data controls to place an object of size n
* at the end of bfr, longword aligned.
* KB_HEADROOM(bfr, n) Set n to the amount of buffer space available before
* the start of data in bfr.
* KB_TAILROOM(bfr, n) Set n to the amount of buffer space available after
* the end of data in bfr.
* KB_PLENGET(bfr, n) Set n to bfr's packet length.
* KB_PLENSET(bfr, n) Set bfr's packet length to n.
* KB_PLENADJ(bfr, n) Adjust total packet length by n bytes.
*
*/
#if defined(BSD)
#include <sys/mbuf.h>
typedef struct mbuf KBuffer;
#define KB_F_WAIT M_TRYWAIT
#define KB_F_NOWAIT M_DONTWAIT
#define KB_T_HEADER MT_HEADER
#define KB_T_DATA MT_DATA
#define KB_COPYALL M_COPYALL
#if BSD >= 199103
#define KB_NEXT(bfr) (bfr)->m_next
#define KB_LEN(bfr) (bfr)->m_len
#define KB_QNEXT(bfr) (bfr)->m_nextpkt
#define KB_ALLOC(bfr, size, flags, type) { \
if ((size) <= MLEN) { \
MGET((bfr), (flags), (type)); \
} else \
(bfr) = NULL; \
}
#define KB_ALLOCPKT(bfr, size, flags, type) { \
if ((size) <= MHLEN) { \
MGETHDR((bfr), (flags), (type)); \
} else \
(bfr) = NULL; \
}
#define KB_ALLOCEXT(bfr, size, flags, type) { \
if ((size) <= MCLBYTES) { \
MGET((bfr), (flags), (type)); \
if ((bfr) != NULL) { \
MCLGET((bfr), (flags)); \
if (((bfr)->m_flags & M_EXT) == 0) { \
m_freem((bfr)); \
(bfr) = NULL; \
} \
} \
} else \
(bfr) = NULL; \
}
#define KB_FREEONE(bfr, nxt) { \
(nxt) = m_free(bfr); \
}
#define KB_FREEALL(bfr) { \
m_freem(bfr); \
}
#define KB_COPY(bfr, off, len, new, flags) { \
(new) = m_copym((bfr), (off), (len), (flags)); \
}
#define KB_COPYDATA(bfr, off, len, datap) \
(m_copydata((bfr), (off), (len), (datap)), 0)
#define KB_PULLUP(bfr, n, new) { \
(new) = m_pullup((bfr), (n)); \
}
#define KB_LINKHEAD(new, head) { \
if ((head) && KB_ISPKT(new) && KB_ISPKT(head)) {\
M_COPY_PKTHDR((new), (head)); \
(head)->m_flags &= ~M_PKTHDR; \
} \
(new)->m_next = (head); \
}
#define KB_LINK(new, prev) { \
(new)->m_next = (prev)->m_next; \
(prev)->m_next = (new); \
}
#define KB_UNLINKHEAD(head, next) { \
MFREE((head), (next)); \
}
#define KB_UNLINK(old, prev, next) { \
MFREE((old), (next)); \
(prev)->m_next = (next); \
}
#define KB_ISPKT(bfr) (((bfr)->m_flags & M_PKTHDR) != 0)
#define KB_ISEXT(bfr) (((bfr)->m_flags & M_EXT) != 0)
#define KB_BFRSTART(bfr, x, t) { \
if ((bfr)->m_flags & M_EXT) \
(x) = (t)((bfr)->m_ext.ext_buf); \
else if ((bfr)->m_flags & M_PKTHDR) \
(x) = (t)(&(bfr)->m_pktdat); \
else \
(x) = (t)((bfr)->m_dat); \
}
#define KB_BFREND(bfr, x, t) { \
if ((bfr)->m_flags & M_EXT) \
(x) = (t)((bfr)->m_ext.ext_buf + (bfr)->m_ext.ext_size);\
else if ((bfr)->m_flags & M_PKTHDR) \
(x) = (t)(&(bfr)->m_pktdat + MHLEN); \
else \
(x) = (t)((bfr)->m_dat + MLEN); \
}
#define KB_BFRLEN(bfr) \
(((bfr)->m_flags & M_EXT) ? (bfr)->m_ext.ext_size : \
(((bfr)->m_flags & M_PKTHDR) ? MHLEN : MLEN))
#define KB_DATASTART(bfr, x, t) { \
(x) = mtod((bfr), t); \
}
#define KB_DATAEND(bfr, x, t) { \
(x) = (t)(mtod((bfr), caddr_t) + (bfr)->m_len); \
}
#define KB_HEADSET(bfr, n) { \
if ((bfr)->m_flags & M_EXT) \
(bfr)->m_data = (bfr)->m_ext.ext_buf + (n); \
else if ((bfr)->m_flags & M_PKTHDR) \
(bfr)->m_data = (bfr)->m_pktdat + (n); \
else \
(bfr)->m_data = (bfr)->m_dat + (n); \
}
#define KB_HEADMOVE(bfr, n) { \
(bfr)->m_data += (n); \
}
#define KB_HEADADJ(bfr, n) { \
(bfr)->m_len += (n); \
(bfr)->m_data -= (n); \
}
#define KB_TAILADJ(bfr, n) { \
(bfr)->m_len += (n); \
}
#define KB_TAILALIGN(bfr, n) { \
(bfr)->m_len = (n); \
if ((bfr)->m_flags & M_EXT) \
(bfr)->m_data = (caddr_t)(((u_int)(bfr)->m_ext.ext_buf \
+ (bfr)->m_ext.ext_size - (n)) & ~(sizeof(long) - 1));\
else \
(bfr)->m_data = (caddr_t)(((u_int)(bfr)->m_dat + MLEN - (n)) \
& ~(sizeof(long) - 1)); \
}
#define KB_HEADROOM(bfr, n) { \
/* n = M_LEADINGSPACE(bfr) XXX */ \
(n) = ((bfr)->m_flags & M_EXT ? (bfr)->m_data - (bfr)->m_ext.ext_buf : \
(bfr)->m_flags & M_PKTHDR ? (bfr)->m_data - (bfr)->m_pktdat : \
(bfr)->m_data - (bfr)->m_dat); \
}
#define KB_TAILROOM(bfr, n) { \
(n) = M_TRAILINGSPACE(bfr); \
}
#define KB_PLENGET(bfr, n) { \
(n) = (bfr)->m_pkthdr.len; \
}
#define KB_PLENSET(bfr, n) { \
(bfr)->m_pkthdr.len = (n); \
}
#define KB_PLENADJ(bfr, n) { \
(bfr)->m_pkthdr.len += (n); \
}
#else /* ! BSD >= 199103 */
#define KB_NEXT(bfr) (bfr)->m_next
#define KB_LEN(bfr) (bfr)->m_len
#define KB_QNEXT(bfr) (bfr)->m_act
#define KB_ALLOC(bfr, size, flags, type) { \
if ((size) <= MLEN) { \
MGET((bfr), (flags), (type)); \
} else \
(bfr) = NULL; \
}
#define KB_ALLOCPKT(bfr, size, flags, type) { \
if ((size) <= MLEN) { \
MGET((bfr), (flags), (type)); \
} else \
(bfr) = NULL; \
}
#define KB_ALLOCEXT(bfr, size, flags, type) { \
if ((size) <= MCLBYTES) { \
MGET((bfr), (flags), (type)); \
if ((bfr) != NULL) { \
MCLGET(bfr); \
if ((bfr)->m_len != MCLBYTES) { \
m_freem((bfr)); \
(bfr) = NULL; \
} \
} \
} else \
(bfr) = NULL; \
}
#define KB_FREEONE(bfr, nxt) { \
(nxt) = m_free(bfr); \
}
#define KB_FREEALL(bfr) { \
m_freem(bfr); \
}
#define KB_COPY(bfr, off, len, new, flags) { \
(new) = m_copy((bfr), (off), (len)); \
}
#define KB_COPYDATA(bfr, off, len, datap) \
m_cpytoc((bfr), (off), (len), (datap))
#define KB_PULLUP(bfr, n, new) { \
(new) = m_pullup((bfr), (n)); \
}
#define KB_LINKHEAD(new, head) { \
(new)->m_next = (head); \
}
#define KB_LINK(new, prev) { \
(new)->m_next = (prev)->m_next; \
(prev)->m_next = (new); \
}
#define KB_UNLINKHEAD(head, next) { \
MFREE((head), (next)); \
}
#define KB_UNLINK(old, prev, next) { \
MFREE((old), (next)); \
(prev)->m_next = (next); \
}
#define KB_ISPKT(bfr) (0)
#define KB_ISEXT(bfr) M_HASCL(bfr)
#define KB_BFRSTART(bfr, x, t) { \
if (M_HASCL(bfr)) { \
if ((bfr)->m_cltype == MCL_STATIC) \
(x) = (t)(mtod((bfr), int) & ~(MCLBYTES - 1)); \
else \
(x) = (t)NULL; \
} else \
(x) = (t)((bfr)->m_dat); \
}
#define KB_BFREND(bfr, x, t) { \
if (M_HASCL(bfr)) { \
if ((bfr)->m_cltype == MCL_STATIC) \
(x) = (t)((mtod((bfr), int) & ~(MCLBYTES - 1)) \
+ MCLBYTES); \
else \
(x) = (t)NULL; \
} else \
(x) = (t)((bfr)->m_dat + MLEN); \
}
#define KB_BFRLEN(bfr) \
(M_HASCL(bfr) ? (((bfr)->m_cltype == MCL_STATIC) ? MCLBYTES : 0) : MLEN)
#define KB_DATASTART(bfr, x, t) { \
(x) = mtod((bfr), t); \
}
#define KB_DATAEND(bfr, x, t) { \
(x) = (t)(mtod((bfr), caddr_t) + (bfr)->m_len); \
}
#define KB_HEADSET(bfr, n) { \
if (M_HASCL(bfr)) { \
/* Assume cluster buffer is empty XXX */\
(bfr)->m_off += (n); \
} else \
(bfr)->m_off = MMINOFF + (n); \
}
#define KB_HEADMOVE(bfr, n) { \
(bfr)->m_off += (n); \
}
#define KB_HEADADJ(bfr, n) { \
(bfr)->m_len += (n); \
(bfr)->m_off -= (n); \
}
#define KB_TAILADJ(bfr, n) { \
(bfr)->m_len += (n); \
}
#define KB_TAILALIGN(bfr, n) { \
(bfr)->m_len = (n); \
if (M_HASCL(bfr)) { \
if ((bfr)->m_cltype == MCL_STATIC) \
(bfr)->m_off = (int)(((mtod((bfr), int) \
& ~(MCLBYTES - 1)) + MCLBYTES - (n)) \
& ~(sizeof(long) - 1)) - (int)(bfr); \
/* Out of luck for loaned buffers */ \
} else \
(bfr)->m_off = (MMAXOFF - (n)) & ~(sizeof(long) - 1); \
}
#define KB_HEADROOM(bfr, n) { \
if (M_HASCL(bfr)) { \
if ((bfr)->m_cltype == MCL_STATIC) \
(n) = mtod((bfr), int) & (MCLBYTES - 1); \
else \
(n) = 0; \
} else \
(n) = (bfr)->m_off - MMINOFF; \
}
#define KB_TAILROOM(bfr, n) { \
if (M_HASCL(bfr)) { \
if ((bfr)->m_cltype == MCL_STATIC) \
(n) = MCLBYTES - ((mtod((bfr), int) + (bfr)->m_len) \
& (MCLBYTES - 1)); \
else \
(n) = 0; \
} else \
(n) = MMAXOFF - ((bfr)->m_off + (bfr)->m_len); \
}
#define KB_PLENGET(bfr, n) { \
struct mbuf *zz; \
for ((n) = 0, zz = (bfr); zz; zz = zz->m_next) \
(n) += zz->m_len; \
}
#define KB_PLENSET(bfr, n) { \
}
#define KB_PLENADJ(bfr, n) { \
}
#endif /* ! BSD >= 199103 */
#endif /* defined(BSD) */
/*
* Kernel time
*
* KTimeout_ret Typedef for timeout() function return
*
* KT_TIME(t) Sets t to the current time.
*
*/
#if (defined(BSD) && (BSD >= 199306))
typedef void KTimeout_ret;
#else
typedef int KTimeout_ret;
#endif
#if (defined(BSD) && (BSD >= 199103))
#define KT_TIME(t) microtime(&t)
#elif defined(sun)
#define KT_TIME(t) uniqtime(&t)
#else
#define KT_TIME(t) ((t) = time)
#endif
#endif /* _KERNEL */
#ifndef NTOHL
#if BYTE_ORDER == BIG_ENDIAN
#define NTOHL(x) (x)
#define NTOHS(x) (x)
#define HTONL(x) (x)
#define HTONS(x) (x)
#else
#define NTOHL(x) (x) = ntohl((u_long)(x))
#define NTOHS(x) (x) = ntohs((u_short)(x))
#define HTONL(x) (x) = htonl((u_long)(x))
#define HTONS(x) (x) = htons((u_short)(x))
#endif
#endif /* NTOHL */
#ifndef MAX
#define MAX(a,b) max((a),(b))
#endif
#ifndef MIN
#define MIN(a,b) min((a),(b))
#endif
#if (!(defined(BSD) && (BSD >= 199306)))
#ifndef __BIT_TYPES_DEFINED__
#define __BIT_TYPES_DEFINED__
typedef char int8_t;
typedef unsigned char u_int8_t;
typedef short int16_t;
typedef unsigned short u_int16_t;
typedef int int32_t;
typedef unsigned int u_int32_t;
#endif
#endif
#endif /* _NETATM_PORT_H */