3 * ===================================
4 * HARP | Host ATM Research Platform
5 * ===================================
8 * This Host ATM Research Platform ("HARP") file (the "Software") is
9 * made available by Network Computing Services, Inc. ("NetworkCS")
10 * "AS IS". NetworkCS does not provide maintenance, improvements or
11 * support of any kind.
13 * NETWORKCS MAKES NO WARRANTIES OR REPRESENTATIONS, EXPRESS OR IMPLIED,
14 * INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY
15 * AND FITNESS FOR A PARTICULAR PURPOSE, AS TO ANY ELEMENT OF THE
16 * SOFTWARE OR ANY SUPPORT PROVIDED IN CONNECTION WITH THIS SOFTWARE.
17 * In no event shall NetworkCS be responsible for any damages, including
18 * but not limited to consequential damages, arising from or relating to
19 * any use of the Software or related support.
21 * Copyright 1994-1998 Network Computing Services, Inc.
23 * Copies of this Software may be made, however, the above copyright
24 * notice must be reproduced on all copies.
26 * @(#) $FreeBSD: src/sys/netatm/atm_subr.c,v 1.7 2000/02/13 03:31:59 peter Exp $
27 * @(#) $DragonFly: src/sys/netproto/atm/atm_subr.c,v 1.17 2005/06/02 22:37:45 dillon Exp $
34 * Miscellaneous ATM subroutines
38 #include "kern_include.h"
40 #include <sys/thread2.h>
41 #include <sys/msgport2.h>
46 struct atm_pif *atm_interface_head = NULL;
47 struct atm_ncm *atm_netconv_head = NULL;
48 Atm_endpoint *atm_endpoints[ENDPT_MAX+1] = {NULL};
49 struct sp_info *atm_pool_head = NULL;
50 struct stackq_entry *atm_stackq_head = NULL, *atm_stackq_tail;
51 struct atm_sock_stat atm_sock_stat = { { 0 } };
54 int atm_dev_print = 0;
55 int atm_print_data = 0;
56 int atm_version = ATM_VERSION;
57 struct timeval atm_debugtime = {0, 0};
58 struct ifqueue atm_intrq;
60 struct sp_info atm_attributes_pool = {
61 "atm attributes pool", /* si_name */
62 sizeof(Atm_attributes), /* si_blksiz */
67 static struct callout atm_timexp_ch;
72 static void atm_compact (struct atm_time *);
73 static KTimeout_ret atm_timexp (void *);
74 static int atm_intr(struct netmsg *);
79 static struct atm_time *atm_timeq = NULL;
80 static struct atm_time atm_compactimer = {0, 0};
82 static struct sp_info atm_stackq_pool = {
83 "Service stack queue pool", /* si_name */
84 sizeof(struct stackq_entry), /* si_blksiz */
91 * Initialize ATM kernel
93 * Performs any initialization required before things really get underway.
94 * Called from ATM domain initialization or from first registration function
108 * Never called from interrupts, so no locking needed
114 atm_intrq.ifq_maxlen = ATM_INTRQ_MAX;
115 netisr_register(NETISR_ATM, cpu0_portfn, atm_intr);
118 * Initialize subsystems
125 callout_init(&atm_timexp_ch);
126 callout_reset(&atm_timexp_ch, hz / ATM_HZ, atm_timexp, NULL);
129 * Start the compaction timer
131 atm_timeout(&atm_compactimer, SPOOL_COMPACT, atm_compact);
136 * Allocate a Control Block
138 * Gets a new control block allocated from the specified storage pool,
139 * acquiring memory for new pool chunks if required. The returned control
140 * block's contents will be cleared.
143 * sip pointer to sp_info for storage pool
146 * addr pointer to allocated control block
147 * 0 allocation failed
155 struct sp_chunk *scp;
166 * Are there any free in the pool?
171 * Find first chunk with a free block
173 for (scp = sip->si_poolh; scp; scp = scp->sc_next) {
174 if (scp->sc_freeh != NULL)
181 * No free blocks - have to allocate a new
182 * chunk (but put a limit to this)
184 struct sp_link *slp_next;
188 * First time for this pool??
190 if (sip->si_chunksiz == 0) {
194 * Initialize pool information
196 n = sizeof(struct sp_chunk) +
198 (sip->si_blksiz + sizeof(struct sp_link));
199 sip->si_chunksiz = roundup(n, SPOOL_ROUNDUP);
202 * Place pool on kernel chain
204 LINK2TAIL(sip, struct sp_info, atm_pool_head, si_next);
207 if (sip->si_chunks >= sip->si_maxallow) {
213 scp = KM_ALLOC(sip->si_chunksiz, M_DEVBUF,
214 M_INTWAIT | M_NULLOK);
222 scp->sc_magic = SPOOL_MAGIC;
226 * Divy up chunk into free blocks
228 slp = (struct sp_link *)(scp + 1);
231 for (i = sip->si_blkcnt; i > 1; i--) {
232 slp_next = (struct sp_link *)((caddr_t)(slp + 1) +
234 slp->sl_u.slu_next = slp_next;
237 slp->sl_u.slu_next = NULL;
241 * Add new chunk to end of pool
244 sip->si_poolt->sc_next = scp;
250 sip->si_total += sip->si_blkcnt;
251 sip->si_free += sip->si_blkcnt;
252 if (sip->si_chunks > sip->si_maxused)
253 sip->si_maxused = sip->si_chunks;
257 * Allocate the first free block in chunk
260 scp->sc_freeh = slp->sl_u.slu_next;
266 * Save link back to pool chunk
268 slp->sl_u.slu_chunk = scp;
273 KM_ZERO(bp, sip->si_blksiz);
281 * Free a Control Block
283 * Returns a previously allocated control block back to the owners
287 * bp pointer to block to be freed
298 struct sp_chunk *scp;
304 * Get containing chunk and pool info
306 slp = (struct sp_link *)bp;
308 scp = slp->sl_u.slu_chunk;
309 if (scp->sc_magic != SPOOL_MAGIC)
310 panic("atm_free: chunk magic missing");
314 * Add block to free chain
317 scp->sc_freet->sl_u.slu_next = slp;
320 scp->sc_freeh = scp->sc_freet = slp;
321 slp->sl_u.slu_next = NULL;
331 * Storage Pool Compaction
333 * Called periodically in order to perform compaction of the
334 * storage pools. Each pool will be checked to see if any chunks
335 * can be freed, taking some care to avoid freeing too many chunks
336 * in order to avoid memory thrashing.
338 * Called from a critical section.
341 * tip pointer to timer control block (atm_compactimer)
349 struct atm_time *tip;
352 struct sp_chunk *scp;
354 struct sp_chunk *scp_prev;
357 * Check out all storage pools
359 for (sip = atm_pool_head; sip; sip = sip->si_next) {
362 * Always keep a minimum number of chunks around
364 if (sip->si_chunks <= SPOOL_MIN_CHUNK)
368 * Maximum chunks to free at one time will leave
369 * pool with at least 50% utilization, but never
370 * go below minimum chunk count.
372 i = ((sip->si_free * 2) - sip->si_total) / sip->si_blkcnt;
373 i = MIN(i, sip->si_chunks - SPOOL_MIN_CHUNK);
376 * Look for chunks to free
379 for (scp = sip->si_poolh; scp && i > 0; ) {
381 if (scp->sc_used == 0) {
384 * Found a chunk to free, so do it
387 scp_prev->sc_next = scp->sc_next;
388 if (sip->si_poolt == scp)
389 sip->si_poolt = scp_prev;
391 sip->si_poolh = scp->sc_next;
393 KM_FREE((caddr_t)scp, sip->si_chunksiz,
397 * Update pool controls
400 sip->si_total -= sip->si_blkcnt;
401 sip->si_free -= sip->si_blkcnt;
404 scp = scp_prev->sc_next;
415 * Restart the compaction timer
417 atm_timeout(&atm_compactimer, SPOOL_COMPACT, atm_compact);
424 * Release a Storage Pool
426 * Frees all dynamic storage acquired for a storage pool.
427 * This function is normally called just prior to a module's unloading.
430 * sip pointer to sp_info for storage pool
437 atm_release_pool(sip)
440 struct sp_chunk *scp, *scp_next;
444 * Free each chunk in pool
446 for (scp = sip->si_poolh; scp; scp = scp_next) {
449 * Check for memory leaks
452 panic("atm_release_pool: unfreed blocks");
454 scp_next = scp->sc_next;
456 KM_FREE((caddr_t)scp, sip->si_chunksiz, M_DEVBUF);
460 * Update pool controls
462 sip->si_poolh = NULL;
468 * Unlink pool from active chain
470 sip->si_chunksiz = 0;
471 UNLINK(sip, struct sp_info, atm_pool_head, si_next);
478 * Handle timer tick expiration
480 * Decrement tick count in first block on timer queue. If there
481 * are blocks with expired timers, call their timeout function.
482 * This function is called ATM_HZ times per second.
485 * arg argument passed on timeout() call
495 struct atm_time *tip;
499 * Decrement tick count
501 if (((tip = atm_timeq) == NULL) || (--tip->ti_ticks > 0)) {
506 * Stack queue should have been drained
509 if (atm_stackq_head != NULL)
510 panic("atm_timexp: stack queue not empty");
514 * Dispatch expired timers
516 while (((tip = atm_timeq) != NULL) && (tip->ti_ticks == 0)) {
517 void (*func)(struct atm_time *);
520 * Remove expired block from queue
522 atm_timeq = tip->ti_next;
523 tip->ti_flag &= ~TIF_QUEUED;
526 * Call timeout handler (with network interrupts locked out)
532 * Drain any deferred calls
542 callout_reset(&atm_timexp_ch, hz / ATM_HZ, atm_timexp, NULL);
547 * Schedule a control block timeout
549 * Place the supplied timer control block on the timer queue. The
550 * function (func) will be called in 't' timer ticks with the
551 * control block address as its only argument. There are ATM_HZ
552 * timer ticks per second. The ticks value stored in each block is
553 * a delta of the number of ticks from the previous block in the queue.
554 * Thus, for each tick interval, only the first block in the queue
555 * needs to have its tick value decremented.
558 * tip pointer to timer control block
559 * t number of timer ticks until expiration
560 * func pointer to function to call at expiration
567 atm_timeout(tip, t, func)
568 struct atm_time *tip;
570 void (*func)(struct atm_time *);
572 struct atm_time *tip1, *tip2;
576 * Check for double queueing error
578 if (tip->ti_flag & TIF_QUEUED)
579 panic("atm_timeout: double queueing");
582 * Make sure we delay at least a little bit
588 * Find out where we belong on the queue
591 for (tip1 = NULL, tip2 = atm_timeq; tip2 && (tip2->ti_ticks <= t);
592 tip1 = tip2, tip2 = tip1->ti_next) {
597 * Place ourselves on queue and update timer deltas
611 tip->ti_flag |= TIF_QUEUED;
623 * Remove the supplied timer control block from the timer queue.
626 * tip pointer to timer control block
629 * 0 control block successfully dequeued
630 * 1 control block not on timer queue
635 struct atm_time *tip;
637 struct atm_time *tip1, *tip2;
640 * Is control block queued?
642 if ((tip->ti_flag & TIF_QUEUED) == 0)
646 * Find control block on the queue
649 for (tip1 = NULL, tip2 = atm_timeq; tip2 && (tip2 != tip);
650 tip1 = tip2, tip2 = tip1->ti_next) {
659 * Remove block from queue and update timer deltas
665 tip1->ti_next = tip2;
668 tip2->ti_ticks += tip->ti_ticks;
673 tip->ti_flag &= ~TIF_QUEUED;
683 * Queues a stack call which must be deferred to the global stack queue.
684 * The call parameters are stored in entries which are allocated from the
685 * stack queue storage pool.
689 * func destination function
690 * token destination layer's token
691 * cvp pointer to connection vcc
692 * arg1 command argument
693 * arg2 command argument
697 * errno call not queued - reason indicated
701 atm_stack_enq(cmd, func, token, cvp, arg1, arg2)
703 void (*func)(int, void *, int, int);
709 struct stackq_entry *sqp;
714 * Get a new queue entry for this call
716 sqp = (struct stackq_entry *)atm_allocate(&atm_stackq_pool);
728 sqp->sq_token = token;
731 sqp->sq_connvc = cvp;
734 * Put new entry at end of queue
736 if (atm_stackq_head == NULL)
737 atm_stackq_head = sqp;
739 atm_stackq_tail->sq_next = sqp;
740 atm_stackq_tail = sqp;
748 * Drain the Stack Queue
750 * Dequeues and processes entries from the global stack queue.
762 struct stackq_entry *sqp, *qprev, *qnext;
767 * Loop thru entire queue until queue is empty
768 * (but panic rather loop forever)
773 for (sqp = atm_stackq_head; sqp; ) {
776 * Got an eligible entry, do STACK_CALL stuff
778 if (sqp->sq_cmd & STKCMD_UP) {
779 if (sqp->sq_connvc->cvc_downcnt) {
782 * Cant process now, skip it
790 * OK, dispatch the call
792 sqp->sq_connvc->cvc_upcnt++;
793 (*sqp->sq_func)(sqp->sq_cmd,
797 sqp->sq_connvc->cvc_upcnt--;
799 if (sqp->sq_connvc->cvc_upcnt) {
802 * Cant process now, skip it
810 * OK, dispatch the call
812 sqp->sq_connvc->cvc_downcnt++;
813 (*sqp->sq_func)(sqp->sq_cmd,
817 sqp->sq_connvc->cvc_downcnt--;
821 * Dequeue processed entry and free it
824 qnext = sqp->sq_next;
826 qprev->sq_next = qnext;
828 atm_stackq_head = qnext;
830 atm_stackq_tail = qprev;
831 atm_free((caddr_t)sqp);
837 * Make sure entire queue was drained
839 if (atm_stackq_head != NULL)
840 panic("atm_stack_drain: Queue not emptied");
846 * Process Interrupt Queue
848 * Processes entries on the ATM interrupt queue. This queue is used by
849 * device interface drivers in order to schedule events from the driver's
850 * lower (interrupt) half to the driver's stack services.
852 * The interrupt routines must store the stack processing function to call
853 * and a token (typically a driver/stack control block) at the front of the
854 * queued buffer. We assume that the function pointer and token values are
855 * both contained (and properly aligned) in the first buffer of the chain.
865 atm_intr(struct netmsg *msg)
867 struct mbuf *m = ((struct netmsg_packet *)msg)->nm_packet;
869 atm_intr_func_t func;
873 * Get function to call and token value
875 KB_DATASTART(m, cp, caddr_t);
876 func = *(atm_intr_func_t *)cp;
878 token = *(void **)cp;
879 KB_HEADADJ(m, -(sizeof(func) + sizeof(token)));
880 if (KB_LEN(m) == 0) {
882 KB_UNLINKHEAD(m, m1);
887 * Call processing function
892 * Drain any deferred calls
895 lwkt_replymsg(&msg->nm_lmsg, 0);
900 * Print a pdu buffer chain
903 * m pointer to pdu buffer chain
904 * msg pointer to message header string
911 atm_pdu_print(m, msg)
921 KB_DATASTART(m, cp, caddr_t);
922 printf("%cbfr=%p data=%p len=%d: ",
923 c, m, cp, KB_LEN(m));
925 if (atm_print_data) {
926 for (i = 0; i < KB_LEN(m); i++) {
927 printf("%2x ", (u_char)*cp++);
929 printf("<end_bfr>\n");