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_if.c,v 1.5 1999/08/28 00:48:35 peter Exp $
27 * @(#) $DragonFly: src/sys/netproto/atm/atm_if.c,v 1.18 2008/06/08 08:38:05 sephe Exp $
34 * ATM interface management
38 #include "kern_include.h"
43 static int atm_physif_ioctl (int, caddr_t
, caddr_t
);
44 static int atm_netif_rtdel (struct radix_node
*, void *);
45 static int atm_if_ioctl (struct ifnet
*, u_long
, caddr_t
, struct ucred
*);
46 static int atm_ifparse (char *, char *, int, int *);
51 static int (*atm_ifouttbl
[AF_MAX
+1])
52 (struct ifnet
*, KBuffer
*, struct sockaddr
*)
57 * Register an ATM physical interface
59 * Each ATM device interface must register itself here upon completing
60 * its internal initialization. This applies to both linked and loaded
61 * device drivers. The interface must be registered before a signalling
62 * manager can be attached.
65 * cup pointer to interface's common unit structure
66 * name pointer to device name string
67 * sdp pointer to interface's stack services
70 * 0 registration successful
71 * errno registration failed - reason indicated
75 atm_physif_register(Cmn_unit
*cup
, char *name
, struct stack_defn
*sdp
)
80 * See if we need to be initialized
86 * Make sure we're not already registered
88 if (cup
->cu_flags
& CUF_REGISTER
) {
95 * Make sure an interface is only registered once
97 for (pip
= atm_interface_head
; pip
!= NULL
; pip
= pip
->pif_next
) {
98 if ((cup
->cu_unit
== pip
->pif_unit
) &&
99 (strcmp(name
, pip
->pif_name
) == 0)) {
106 * Fill in physical interface parameters
109 pip
->pif_name
= name
;
110 pip
->pif_unit
= cup
->cu_unit
;
111 pip
->pif_flags
= PIF_UP
;
112 pip
->pif_services
= sdp
;
113 pip
->pif_ioctl
= atm_physif_ioctl
;
116 * Link in the interface and mark us registered
118 LINK2TAIL(pip
, struct atm_pif
, atm_interface_head
, pif_next
);
119 cup
->cu_flags
|= CUF_REGISTER
;
127 * De-register an ATM physical interface
129 * Each ATM interface must de-register itself before downing the interface.
130 * The interface's signalling manager will be detached and any network
131 * interface and VCC control blocks will be freed.
134 * cup pointer to interface's common unit structure
137 * 0 de-registration successful
138 * errno de-registration failed - reason indicated
142 atm_physif_deregister(Cmn_unit
*cup
)
144 struct atm_pif
*pip
= (struct atm_pif
*)&cup
->cu_pif
;
151 * Detach and deregister, if needed
153 if ((cup
->cu_flags
& CUF_REGISTER
)) {
156 * Detach from signalling manager
158 if (pip
->pif_sigmgr
!= NULL
) {
159 err
= atm_sigmgr_detach(pip
);
160 if (err
&& (err
!= ENOENT
)) {
167 * Make sure signalling manager is detached
169 if (pip
->pif_sigmgr
!= NULL
) {
177 UNLINK(pip
, struct atm_pif
, atm_interface_head
, pif_next
);
179 cup
->cu_flags
&= ~CUF_REGISTER
;
183 * Free all of our network interfaces
185 atm_physif_freenifs(pip
);
188 * Free unit's vcc information
195 cup
->cu_vcc
= (Cmn_vcc
*)NULL
;
204 * Free all network interfaces on a physical interface
207 * pip pointer to physical interface structure
214 atm_physif_freenifs(struct atm_pif
*pip
)
216 struct atm_nif
*nip
= pip
->pif_nif
;
222 * atm_nif_detach zeros pointers - save so we can
225 struct atm_nif
*nipp
= nip
->nif_pnext
;
228 * Clean up network i/f trails
230 atm_nif_detach ( nip
);
231 atm_free ((caddr_t
)nip
);
234 pip
->pif_nif
= (struct atm_nif
*)NULL
;
243 * Handle physical interface ioctl's
245 * See <netatm/atm_ioctl.h> for definitions.
247 * Called from a critical section.
250 * code Ioctl function (sub)code
251 * data Data block. On input contains command,
252 * on output, contains results
253 * arg Optional code specific arguments
256 * 0 Request processed successfully
257 * errno Request failed - reason code
261 atm_physif_ioctl(int code
, caddr_t data
, caddr_t arg
)
263 struct atminfreq
*aip
= (struct atminfreq
*)data
;
264 struct atmsetreq
*asr
= (struct atmsetreq
*)data
;
272 caddr_t buf
= aip
->air_buf_addr
;
273 struct air_phy_stat_rsp
*apsp
;
274 struct air_int_rsp apr
;
275 struct air_netif_rsp anr
;
276 struct air_cfg_rsp acr
;
277 int count
, len
, buf_len
= aip
->air_buf_len
;
279 char ifname
[2*IFNAMSIZ
];
280 struct in_ifaddr
*ia
;
281 struct sockaddr_dl
*sdl
;
283 switch ( aip
->air_opcode
) {
287 * Get physical interface information
289 aip
= (struct atminfreq
*)data
;
290 pip
= (struct atm_pif
*)arg
;
293 * Make sure there's room in user buffer
295 if (aip
->air_buf_len
< sizeof(apr
)) {
301 * Fill in info to be returned
303 KM_ZERO((caddr_t
)&apr
, sizeof(apr
));
304 smp
= pip
->pif_sigmgr
;
305 sip
= pip
->pif_siginst
;
306 ksnprintf(apr
.anp_intf
, sizeof(apr
.anp_intf
),
307 "%s%d", pip
->pif_name
, pip
->pif_unit
);
310 strcpy(apr
.anp_nif_pref
, /* XXX: strings */
311 pip
->pif_nif
->nif_if
.if_dname
);
316 nip
= nip
->nif_pnext
;
320 ATM_ADDR_COPY(&sip
->si_addr
, &apr
.anp_addr
);
321 ATM_ADDR_COPY(&sip
->si_subaddr
, &apr
.anp_subaddr
);
322 apr
.anp_sig_proto
= smp
->sm_proto
;
323 apr
.anp_sig_state
= sip
->si_state
;
327 * Copy data to user buffer
329 err
= copyout((caddr_t
)&apr
, aip
->air_buf_addr
, sizeof(apr
));
334 * Update buffer pointer/count
336 aip
->air_buf_addr
+= sizeof(apr
);
337 aip
->air_buf_len
-= sizeof(apr
);
342 * Get network interface information
344 aip
= (struct atminfreq
*)data
;
345 nip
= (struct atm_nif
*)arg
;
350 * Make sure there's room in user buffer
352 if (aip
->air_buf_len
< sizeof(anr
)) {
358 * Fill in info to be returned
360 KM_ZERO((caddr_t
)&anr
, sizeof(anr
));
361 ksnprintf(anr
.anp_intf
, sizeof(anr
.anp_intf
),
362 "%s", ifp
->if_xname
);
365 anr
.anp_proto_addr
= *ia
->ia_ifa
.ifa_addr
;
367 ksnprintf(anr
.anp_phy_intf
, sizeof(anr
.anp_phy_intf
),
368 "%s%d", pip
->pif_name
, pip
->pif_unit
);
371 * Copy data to user buffer
373 err
= copyout((caddr_t
)&anr
, aip
->air_buf_addr
, sizeof(anr
));
378 * Update buffer pointer/count
380 aip
->air_buf_addr
+= sizeof(anr
);
381 aip
->air_buf_len
-= sizeof(anr
);
386 * Get per interface statistics
388 pip
= (struct atm_pif
*)arg
;
391 ksnprintf ( ifname
, sizeof(ifname
),
392 "%s%d", pip
->pif_name
, pip
->pif_unit
);
395 * Cast response into users buffer
397 apsp
= (struct air_phy_stat_rsp
*)buf
;
402 len
= sizeof ( struct air_phy_stat_rsp
);
407 * Copy interface name into response
409 if ((err
= copyout ( ifname
, apsp
->app_intf
, IFNAMSIZ
)) != 0)
415 if ((err
= copyout(&pip
->pif_ipdus
, &apsp
->app_ipdus
,
416 len
- sizeof(apsp
->app_intf
))) != 0)
420 * Adjust buffer elements
425 aip
->air_buf_addr
= buf
;
426 aip
->air_buf_len
= buf_len
;
431 * Set NIF - allow user to configure 1 or more logical
432 * interfaces per physical interface.
436 * Get pointer to physical interface structure from
439 pip
= (struct atm_pif
*)arg
;
440 cup
= (Cmn_unit
*)pip
;
443 * Sanity check - are we already connected to something?
445 if ( pip
->pif_sigmgr
)
452 * Free any previously allocated NIFs
454 atm_physif_freenifs(pip
);
457 * Add list of interfaces
459 for ( count
= 0; count
< asr
->asr_nif_cnt
; count
++ )
461 nip
= (struct atm_nif
*)atm_allocate(cup
->cu_nif_pool
);
465 * Destroy any successful nifs
467 atm_physif_freenifs(pip
);
475 strcpy ( nip
->nif_name
, asr
->asr_nif_pref
);
476 nip
->nif_sel
= count
;
478 if_initname(ifp
, nip
->nif_name
, count
);
479 ifp
->if_mtu
= ATM_NIF_MTU
;
480 ifp
->if_flags
= IFF_UP
| IFF_BROADCAST
| IFF_RUNNING
;
481 ifp
->if_output
= atm_ifoutput
;
482 ifp
->if_ioctl
= atm_if_ioctl
;
483 ifp
->if_snd
.ifq_maxlen
= ifqmaxlen
;
485 * Set if_type and if_baudrate
487 ifp
->if_type
= IFT_ATM
;
488 switch ( cup
->cu_config
.ac_media
) {
490 ifp
->if_baudrate
= 100000000;
493 ifp
->if_baudrate
= 140000000;
498 ifp
->if_baudrate
= 155000000;
501 panic("AIOCF_SETNIF: unknown media");
504 if ((err
= atm_nif_attach(nip
, NULL
)) != 0) {
505 atm_free ( (caddr_t
)nip
);
508 * Destroy any successful nifs
510 atm_physif_freenifs(pip
);
514 * Set macaddr in <Link> address
517 sdl
= IF_LLSOCKADDR(ifp
);
518 sdl
->sdl_type
= IFT_ETHER
;
519 sdl
->sdl_alen
= ifp
->if_addrlen
;
520 bcopy ( (caddr_t
)&cup
->cu_config
.ac_macaddr
,
521 LLADDR(sdl
), ifp
->if_addrlen
);
527 * Get adapter configuration information
529 aip
= (struct atminfreq
*)data
;
530 pip
= (struct atm_pif
*)arg
;
531 cup
= (Cmn_unit
*)pip
;
532 acp
= &cup
->cu_config
;
535 * Make sure there's room in user buffer
537 if (aip
->air_buf_len
< sizeof(acr
)) {
543 * Fill in info to be returned
545 KM_ZERO((caddr_t
)&acr
, sizeof(acr
));
546 ksnprintf(acr
.acp_intf
, sizeof(acr
.acp_intf
),
547 "%s%d", pip
->pif_name
, pip
->pif_unit
);
548 KM_COPY((caddr_t
)acp
, (caddr_t
)&acr
.acp_cfg
,
552 * Copy data to user buffer
554 err
= copyout((caddr_t
)&acr
, aip
->air_buf_addr
,
560 * Update buffer pointer/count
562 aip
->air_buf_addr
+= sizeof(acr
);
563 aip
->air_buf_len
-= sizeof(acr
);
568 * Pass off to device-specific handler
570 cup
= (Cmn_unit
*)arg
;
574 err
= (*cup
->cu_ioctl
)(code
, data
, arg
);
586 * Register a Network Convergence Module
588 * Each ATM network convergence module must register itself here before
589 * it will receive network interface status notifications.
592 * ncp pointer to network convergence definition structure
595 * 0 registration successful
596 * errno registration failed - reason indicated
600 atm_netconv_register(struct atm_ncm
*ncp
)
606 * See if we need to be initialized
612 * Validate protocol family
614 if (ncp
->ncm_family
> AF_MAX
) {
620 * Ensure no duplicates
622 for (tdp
= atm_netconv_head
; tdp
!= NULL
; tdp
= tdp
->ncm_next
) {
623 if (tdp
->ncm_family
== ncp
->ncm_family
) {
632 LINK2TAIL(ncp
, struct atm_ncm
, atm_netconv_head
, ncm_next
);
635 * Add new interface output function
637 atm_ifouttbl
[ncp
->ncm_family
] = ncp
->ncm_ifoutput
;
645 * De-register an ATM Network Convergence Module
647 * Each ATM network convergence provider must de-register its registered
648 * service(s) before terminating. Specifically, loaded kernel modules
649 * must de-register their services before unloading themselves.
652 * ncp pointer to network convergence definition structure
655 * 0 de-registration successful
656 * errno de-registration failed - reason indicated
660 atm_netconv_deregister(struct atm_ncm
*ncp
)
667 * Remove module from list
669 UNLINKF(ncp
, struct atm_ncm
, atm_netconv_head
, ncm_next
, found
);
677 * Remove module's interface output function
679 atm_ifouttbl
[ncp
->ncm_family
] = NULL
;
687 * Attach an ATM Network Interface
689 * Before an ATM network interface can be used by the system, the owning
690 * device interface must attach the network interface using this function.
691 * The physical interface for this network interface must have been previously
692 * registered (using atm_interface_register). The network interface will be
693 * added to the kernel's interface list and to the physical interface's list.
694 * The caller is responsible for initializing the control block fields.
697 * nip pointer to atm network interface control block
700 * 0 attach successful
701 * errno attach failed - reason indicated
705 atm_nif_attach(struct atm_nif
*nip
, lwkt_serialize_t serializer
)
707 struct atm_pif
*pip
, *pip2
;
717 * Verify physical interface is registered
719 for (pip2
= atm_interface_head
; pip2
!= NULL
; pip2
= pip2
->pif_next
) {
723 if ((pip
== NULL
) || (pip2
== NULL
)) {
729 * Add to system interface list
731 if_attach(ifp
, serializer
);
734 * Add to physical interface list
736 LINK2TAIL(nip
, struct atm_nif
, pip
->pif_nif
, nif_pnext
);
739 * Notify network convergence modules of new network i/f
741 for (ncp
= atm_netconv_head
; ncp
; ncp
= ncp
->ncm_next
) {
744 err
= (*ncp
->ncm_stat
)(NCM_ATTACH
, nip
, 0);
758 * Detach an ATM Network Interface
760 * Before an ATM network interface control block can be freed, all kernel
761 * references to/from this block must be released. This function will delete
762 * all routing references to the interface and free all interface addresses
763 * for the interface. The network interface will then be removed from the
764 * kernel's interface list and from the owning physical interface's list.
765 * The caller is responsible for free'ing the control block.
768 * nip pointer to atm network interface control block
775 atm_nif_detach(struct atm_nif
*nip
)
779 struct ifnet
*ifp
= &nip
->nif_if
;
781 struct in_ifaddr
*ia
;
782 struct radix_node_head
*rnh
;
787 * Notify convergence modules of network i/f demise
789 for (ncp
= atm_netconv_head
; ncp
; ncp
= ncp
->ncm_next
) {
790 (*ncp
->ncm_stat
)(NCM_DETACH
, nip
, 0);
794 * Mark interface down
799 * Free all interface routes and addresses
806 /* Delete interface route */
809 /* Remove interface address from queues */
811 ifa_ifunlink(ifa
, ifp
);
814 /* Free interface address */
819 * Delete all remaining routes using this interface
820 * Unfortuneatly the only way to do this is to slog through
821 * the entire routing table looking for routes which point
822 * to this interface...oh well...
824 for (i
= 1; i
<= AF_MAX
; i
++) {
825 if ((rnh
= rt_tables
[i
]) == NULL
)
827 rnh
->rnh_walktree(rnh
, atm_netif_rtdel
, ifp
);
831 * Remove from system interface list (ie. if_detach())
833 TAILQ_REMOVE(&ifnet
, ifp
, if_link
);
836 * Remove from physical interface list
838 UNLINK(nip
, struct atm_nif
, nip
->nif_pif
->pif_nif
, nif_pnext
);
845 * Delete Routes for a Network Interface
847 * Called for each routing entry via the rnh->rnh_walktree() call above
848 * to delete all route entries referencing a detaching network interface.
851 * rn pointer to node in the routing table
852 * arg argument passed to rnh->rnh_walktree() - detaching interface
856 * errno failed - reason indicated
860 atm_netif_rtdel(struct radix_node
*rn
, void *arg
)
862 struct rtentry
*rt
= (struct rtentry
*)rn
;
863 struct ifnet
*ifp
= arg
;
866 if (rt
->rt_ifp
== ifp
) {
869 * Protect (sorta) against walktree recursion problems
872 if ((rt
->rt_flags
& RTF_UP
) == 0)
875 err
= rtrequest(RTM_DELETE
, rt_key(rt
), rt
->rt_gateway
,
876 rt_mask(rt
), rt
->rt_flags
,
877 (struct rtentry
**) NULL
);
879 log(LOG_WARNING
, "atm_netif_rtdel: error %d\n", err
);
888 * Set an ATM Network Interface address
890 * This is called from a device interface when processing an SIOCSIFADDR
891 * ioctl request. We just notify all convergence modules of the new address
892 * and hope everyone has non-overlapping interests, since if someone reports
893 * an error we don't go back and tell everyone to undo the change.
896 * nip pointer to atm network interface control block
897 * ifa pointer to new interface address
901 * errno set failed - reason indicated
905 atm_nif_setaddr(struct atm_nif
*nip
, struct ifaddr
*ifa
)
912 * Notify convergence modules of network i/f change
914 for (ncp
= atm_netconv_head
; ncp
; ncp
= ncp
->ncm_next
) {
915 err
= (*ncp
->ncm_stat
)(NCM_SETADDR
, nip
, (int)ifa
);
926 * ATM Interface Packet Output
928 * All ATM network interfaces must have their ifnet if_output address set to
929 * this function. Since no existing network layer code is to be modified
930 * for ATM support, this function serves as the hook to allow network output
931 * packets to be assigned to their proper outbound VCC. Each network address
932 * family which is to be supported over ATM must be assigned an output
933 * packet processing function via atm_netconv_register().
936 * ifp pointer to ifnet structure
937 * m pointer to packet buffer chain to be output
938 * dst pointer to packet's network destination address
941 * 0 packet queued to interface
942 * errno output failed - reason indicated
946 atm_ifoutput_serialized(struct ifnet
*ifp
, KBuffer
*m
, struct sockaddr
*dst
,
949 u_short fam
= dst
->sa_family
;
950 int (*func
)(struct ifnet
*, KBuffer
*,
954 * Validate address family
958 return (EAFNOSUPPORT
);
962 * Hand packet off for dst-to-VCC mapping
964 func
= atm_ifouttbl
[fam
];
967 return (EAFNOSUPPORT
);
969 return ((*func
)(ifp
, m
, dst
));
973 atm_ifoutput(struct ifnet
*ifp
, KBuffer
*m
, struct sockaddr
*dst
,
978 lwkt_serialize_enter(ifp
->if_serializer
);
979 error
= atm_ifoutput_serialized(ifp
, m
, dst
, rt
);
980 lwkt_serialize_exit(ifp
->if_serializer
);
986 * Handle interface ioctl requests.
989 * ifp pointer to network interface structure
991 * data arguments to/from ioctl
997 atm_if_ioctl(struct ifnet
*ifp
, u_long cmd
, caddr_t data
, struct ucred
*cr
)
999 struct ifreq
*ifr
= (struct ifreq
*)data
;
1000 struct atm_nif
*nip
= (struct atm_nif
*)ifp
;
1007 KM_COPY ( (caddr_t
)&(nip
->nif_pif
->pif_macaddr
),
1008 (caddr_t
)ifr
->ifr_addr
.sa_data
,
1009 sizeof(struct mac_addr
) );
1013 error
= atm_nif_setaddr ( nip
, (struct ifaddr
*)data
);
1014 ifp
->if_flags
|= IFF_UP
| IFF_RUNNING
| IFF_BROADCAST
;
1018 *(short *)data
= ifp
->if_flags
;
1035 * Parse interface name
1037 * Parses an interface name string into a name and a unit component.
1040 * name pointer to interface name string
1041 * namep address to store interface name
1042 * size size available at namep
1043 * unitp address to store interface unit number
1051 atm_ifparse(char *name
, char *namep
, int size
, int *unitp
)
1054 int len
= 0, unit
= 0;
1057 * Separate supplied string into name and unit parts.
1062 if (*cp
>= '0' && *cp
<= '9')
1069 while (*cp
&& *cp
>= '0' && *cp
<= '9')
1070 unit
= 10 * unit
+ *cp
++ - '0';
1079 * Locate ATM physical interface via name
1081 * Uses the supplied interface name string to locate a registered
1082 * ATM physical interface.
1085 * name pointer to interface name string
1088 * 0 interface not found
1089 * else pointer to atm physical interface structure
1093 atm_pifname(char *name
)
1095 struct atm_pif
*pip
;
1102 if (atm_ifparse(name
, n
, sizeof(n
), &unit
))
1103 return ((struct atm_pif
*)0);
1106 * Look for the physical interface
1108 for (pip
= atm_interface_head
; pip
; pip
= pip
->pif_next
) {
1109 if ((pip
->pif_unit
== unit
) && (strcmp(pip
->pif_name
, n
) == 0))
1118 * Locate ATM network interface via name
1120 * Uses the supplied interface name string to locate an ATM network interface.
1123 * name pointer to interface name string
1126 * 0 interface not found
1127 * else pointer to atm network interface structure
1131 atm_nifname(char *name
)
1133 struct atm_pif
*pip
;
1134 struct atm_nif
*nip
;
1141 if (atm_ifparse(name
, n
, sizeof(n
), &unit
))
1142 return ((struct atm_nif
*)0);
1145 * Search thru each physical interface
1147 for (pip
= atm_interface_head
; pip
; pip
= pip
->pif_next
) {
1149 * Looking for network interface
1151 for (nip
= pip
->pif_nif
; nip
; nip
= nip
->nif_pnext
) {
1152 struct ifnet
*ifp
= (struct ifnet
*)nip
;
1153 if ((ifp
->if_dunit
== unit
) &&
1154 (strcmp(ifp
->if_dname
, n
) == 0))