xref: /original-bsd/sys/deprecated/netimp/if_imp.c (revision 28e1c762)
1 /*	if_imp.c	4.12	82/03/10	*/
2 
3 #include "imp.h"
4 #if NIMP > 0
5 /*
6  * ARPAnet IMP interface driver.
7  *
8  * The IMP-host protocol is handled here, leaving
9  * hardware specifics to the lower level interface driver.
10  *
11  * TODO:
12  *	rethink coupling between this module and device driver
13  *	pass more error indications up to protocol modules
14  */
15 #include "../h/param.h"
16 #include "../h/systm.h"
17 #include "../h/mbuf.h"
18 #include "../h/pte.h"
19 #include "../h/buf.h"
20 #include "../h/protosw.h"
21 #include "../h/socket.h"
22 #include "../h/ubareg.h"
23 #include "../h/ubavar.h"
24 #include "../h/cpu.h"
25 #include "../h/mtpr.h"
26 #include "../h/vmmac.h"
27 #include "../net/in.h"
28 #include "../net/in_systm.h"
29 #include "../net/if.h"
30 #include "../net/if_imp.h"
31 #include "../net/if_imphost.h"
32 #include "../net/ip.h"
33 #include "../net/ip_var.h"
34 
35 /*
36  * IMP software status per interface.
37  * (partially shared with the hardware specific module)
38  *
39  * Each interface is referenced by a network interface structure,
40  * imp_if, which the routing code uses to locate the interface.
41  * This structure contains the output queue for the interface, its
42  * address, ...  IMP specific structures used in connecting the
43  * IMP software modules to the hardware specific interface routines
44  * are stored here.  The common structures are made visible to the
45  * interface driver by passing a pointer to the hardware routine
46  * at "attach" time.
47  *
48  * NOTE: imp_if and imp_cb are assumed adjacent in hardware code.
49  */
50 struct imp_softc {
51 	struct	ifnet imp_if;		/* network visible interface */
52 	struct	impcb imp_cb;		/* hooks to hardware module */
53 	u_char	imp_state;		/* current state of IMP */
54 	char	imp_dropcnt;		/* used during initialization */
55 } imp_softc[NIMP];
56 
57 /*
58  * Messages from IMP regarding why
59  * it's going down.
60  */
61 static char *impmessage[] = {
62 	"in 30 seconds",
63 	"for hardware PM",
64 	"to reload software",
65 	"for emergency reset"
66 };
67 
68 int	impdown(), impinit(), impoutput();
69 
70 /*
71  * IMP attach routine.  Called from hardware device attach routine
72  * at configuration time with a pointer to the UNIBUS device structure.
73  * Sets up local state and returns pointer to base of ifnet+impcb
74  * structures.  This is then used by the device's attach routine
75  * set up its back pointers.
76  */
77 impattach(ui)
78 	struct uba_device *ui;
79 {
80 	struct imp_softc *sc = &imp_softc[ui->ui_unit];
81 	register struct ifnet *ifp = &sc->imp_if;
82 
83 COUNT(IMPATTACH);
84 	/* UNIT COULD BE AMBIGUOUS */
85 	ifp->if_unit = ui->ui_unit;
86 	ifp->if_name = "imp";
87 	ifp->if_mtu = IMP_MTU;
88 	ifp->if_net = ui->ui_flags;
89 	/* the host and imp fields will be filled in by the imp */
90 	ifp->if_addr = if_makeaddr(ifp->if_net, 0);
91 	ifp->if_init = impinit;
92 	ifp->if_output = impoutput;
93 	/* reset is handled at the hardware level */
94 	if_attach(ifp);
95 	/* kludge to hand pointers back to hardware attach routine */
96 	return ((int)&sc->imp_if);
97 }
98 
99 /*
100  * IMP initialization routine: call hardware module to
101  * setup UNIBUS resources, init state and get ready for
102  * NOOPs the IMP should send us, and that we want to drop.
103  */
104 impinit(unit)
105 	int unit;
106 {
107 	register struct imp_softc *sc = &imp_softc[unit];
108 
109 	if ((*sc->imp_cb.ic_init)(unit) == 0) {
110 		sc->imp_state = IMPS_DOWN;
111 		return;
112 	}
113 	sc->imp_state = IMPS_INIT;
114 	sc->imp_dropcnt = IMP_DROPCNT;
115 	impnoops(sc);
116 }
117 
118 struct sockproto impproto = { PF_IMPLINK };
119 struct sockaddr_in impdst = { AF_IMPLINK };
120 struct sockaddr_in impsrc = { AF_IMPLINK };
121 
122 /*
123  * ARPAnet 1822 input routine.
124  * Called from hardware input interrupt routine to handle 1822
125  * IMP-host messages.  Type 0 messages (non-control) are
126  * passed to higher level protocol processors on the basis
127  * of link number.  Other type messages (control) are handled here.
128  */
129 impinput(unit, m)
130 	int unit;
131 	register struct mbuf *m;
132 {
133 	int s;
134 	register struct imp_leader *ip;
135 	register struct imp_softc *sc = &imp_softc[unit];
136 	register struct host *hp;
137 	register struct ifqueue *inq;
138 	struct control_leader *cp;
139 	struct in_addr addr;
140 	struct mbuf *next;
141 
142 COUNT(IMPINPUT);
143 	/*
144 	 * Verify leader length.  Be careful with control
145 	 * message which don't get a length included.
146 	 * We should generate a "bad leader" message
147 	 * to the IMP about messages too short.
148 	 */
149 	if (m->m_len < sizeof(struct control_leader) &&
150 	    (m = m_pullup(m, sizeof(struct control_leader))) == 0)
151 		return;
152 	cp = mtod(m, struct control_leader *);
153 	if (cp->dl_mtype == IMPTYPE_DATA)
154 		if (m->m_len < sizeof(struct imp_leader) &&
155 		    (m = m_pullup(m, sizeof(struct imp_leader))) == 0)
156 			return;
157 	ip = mtod(m, struct imp_leader *);
158 
159 	/*
160 	 * Check leader type -- should notify IMP
161 	 * in case of failure...
162 	 */
163 	if (ip->il_format != IMP_NFF) {
164 		sc->imp_if.if_collisions++;	/* XXX */
165 		goto drop;
166 	}
167 
168 	/*
169 	 * Certain messages require a host structure.
170 	 * Do this in one shot here.
171 	 */
172 	switch (ip->il_mtype) {
173 
174 	case IMPTYPE_RFNM:
175 	case IMPTYPE_INCOMPLETE:
176 	case IMPTYPE_HOSTDEAD:
177 	case IMPTYPE_HOSTUNREACH:
178 	case IMPTYPE_BADDATA:
179 #ifdef notdef
180 		addr.s_net = ip->il_network;
181 #else
182 		addr.s_net = 0;
183 #endif
184 		addr.s_imp = ip->il_imp;
185 		addr.s_host = ip->il_host;
186 		hp = hostlookup(addr);
187 		break;
188 	}
189 
190 	switch (ip->il_mtype) {
191 
192 	/*
193 	 * Data for a protocol.  Dispatch to the appropriate
194 	 * protocol routine (running at software interrupt).
195 	 * If this isn't a raw interface, advance pointer
196 	 * into mbuf past leader (done below).
197 	 */
198 	case IMPTYPE_DATA:
199 		ip->il_length =
200 			(ntohs(ip->il_length) >> 3) - sizeof(struct imp_leader);
201 		break;
202 
203 	/*
204 	 * IMP leader error.  Reset the IMP and discard the packet.
205 	 */
206 	case IMPTYPE_BADLEADER:
207 		/*
208 		 * According to 1822 document, this message
209 		 * will be generated in response to the
210 		 * first noop sent to the IMP after
211 		 * the host resets the IMP interface.
212 		 */
213 		if (sc->imp_state != IMPS_INIT) {
214 			impmsg(sc, "leader error");
215 			hostreset(sc->imp_if.if_net);	/* XXX */
216 			impnoops(sc);
217 		}
218 		goto rawlinkin;
219 
220 	/*
221 	 * IMP going down.  Print message, and if not immediate,
222 	 * set off a timer to insure things will be reset at the
223 	 * appropriate time.
224 	 */
225 	case IMPTYPE_DOWN:
226 		if ((ip->il_link & IMP_DMASK) == 0) {
227 			sc->imp_state = IMPS_GOINGDOWN;
228 			timeout(impdown, sc, 30 * hz);
229 		}
230 		impmsg(sc, "going down %s", impmessage[ip->il_link&IMP_DMASK]);
231 		goto rawlinkin;
232 
233 	/*
234 	 * A NOP usually seen during the initialization sequence.
235 	 * Compare the local address with that in the message.
236 	 * Reset the local address notion if it doesn't match.
237 	 */
238 	case IMPTYPE_NOOP: {
239 		register struct in_addr *sin;
240 
241 		if (sc->imp_state == IMPS_DOWN) {
242 			sc->imp_state = IMPS_INIT;
243 			sc->imp_dropcnt = IMP_DROPCNT;
244 		}
245 		if (sc->imp_state != IMPS_INIT || --sc->imp_dropcnt > 0)
246 			goto rawlinkin;
247 		sc->imp_state = IMPS_UP;
248 		sin = &sc->imp_if.if_addr;
249 		sc->imp_if.if_host[0] = sin->s_host = ip->il_host;
250 		sin->s_imp = ip->il_imp;
251 		impmsg(sc, "reset (host %d/imp %d)", ip->il_host,
252 			ntohs(ip->il_imp));
253 		/* restart output in case something was q'd */
254 		(*sc->imp_cb.ic_start)(sc->imp_if.if_unit);
255 		goto rawlinkin;
256 	}
257 
258 	/*
259 	 * RFNM or INCOMPLETE message, record in
260 	 * host table and prime output routine.
261 	 *
262 	 * SHOULD NOTIFY PROTOCOL ABOUT INCOMPLETES.
263 	 */
264 	case IMPTYPE_RFNM:
265 	case IMPTYPE_INCOMPLETE:
266 		if (hp && hp->h_rfnm)
267 			if (next = hostdeque(hp))
268 				(void) impsnd(sc, next);
269 		goto rawlinkin;
270 
271 	/*
272 	 * Host or IMP can't be reached.  Flush any packets
273 	 * awaiting transmission and release the host structure.
274 	 *
275 	 * TODO: NOTIFY THE PROTOCOL
276 	 */
277 	case IMPTYPE_HOSTDEAD:
278 		impmsg(sc, "host dead");	/* XXX */
279 		goto common;			/* XXX */
280 
281 	/* SHOULD SIGNAL ROUTING DAEMON */
282 	case IMPTYPE_HOSTUNREACH:
283 		impmsg(sc, "host unreachable");	/* XXX */
284 	common:
285 		if (hp)
286 			hostfree(hp);		/* won't work right */
287 		goto rawlinkin;
288 
289 	/*
290 	 * Error in data.  Clear RFNM status for this host and send
291 	 * noops to the IMP to clear the interface.
292 	 */
293 	case IMPTYPE_BADDATA:
294 		impmsg(sc, "data error");
295 		if (hp)
296 			hp->h_rfnm = 0;
297 		impnoops(sc);
298 		goto rawlinkin;
299 
300 	/*
301 	 * Interface reset.
302 	 */
303 	case IMPTYPE_RESET:
304 		impmsg(sc, "interface reset");
305 		impnoops(sc);
306 		goto rawlinkin;
307 
308 	default:
309 		sc->imp_if.if_collisions++;		/* XXX */
310 		goto rawlinkin;
311 	}
312 
313 	/*
314 	 * Queue on protocol's input queue.
315 	 */
316 	switch (ip->il_link) {
317 
318 #ifdef INET
319 	case IMPLINK_IP:
320 		m->m_len -= sizeof(struct imp_leader);
321 		m->m_off += sizeof(struct imp_leader);
322 		setipintr();
323 		inq = &ipintrq;
324 		break;
325 #endif
326 
327 	default:
328 	rawlinkin:
329 		impproto.sp_protocol = ip->il_link;
330 		impdst.sin_addr = sc->imp_if.if_addr;
331 		impsrc.sin_addr.s_net = ip->il_network;
332 		impsrc.sin_addr.s_host = ip->il_host;
333 		impsrc.sin_addr.s_imp = ip->il_imp;
334 		raw_input(m, &impproto, &impdst, &impsrc);
335 		return;
336 	}
337 	IF_ENQUEUE(inq, m);
338 	return;
339 
340 drop:
341 	m_freem(m);
342 }
343 
344 /*
345  * Bring the IMP down after notification.
346  */
347 impdown(sc)
348 	struct imp_softc *sc;
349 {
350 	sc->imp_state = IMPS_DOWN;
351 	impmsg(sc, "marked down");
352 	/* notify protocols with messages waiting? */
353 }
354 
355 /*VARARGS*/
356 impmsg(sc, fmt, a1, a2)
357 	struct imp_softc *sc;
358 	char *fmt;
359 {
360 	printf("imp%d: ", sc->imp_if.if_unit);
361 	printf(fmt, a1, a2);
362 	printf("\n");
363 }
364 
365 /*
366  * ARPAnet 1822 output routine.
367  * Called from higher level protocol routines to set up messages for
368  * transmission to the imp.  Sets up the header and calls impsnd to
369  * enqueue the message for this IMP's hardware driver.
370  */
371 impoutput(ifp, m0, pf)
372 	register struct ifnet *ifp;
373 	struct mbuf *m0;
374 {
375 	register struct imp_leader *imp;
376 	register struct mbuf *m = m0;
377 	int x, dhost, dimp, dlink, len, dnet;
378 
379 COUNT(IMPOUTPUT);
380 	/*
381 	 * Don't even try if the IMP is unavailable.
382 	 */
383 	x = imp_softc[ifp->if_unit].imp_state;
384 	if (x == IMPS_DOWN || x == IMPS_GOINGDOWN)
385 		goto drop;
386 
387 	switch (pf) {
388 
389 #ifdef INET
390 	case PF_INET: {
391 		register struct ip *ip = mtod(m0, struct ip *);
392 
393 		dnet = ip->ip_dst.s_net;
394 		dhost = ip->ip_dst.s_host;
395 		dimp = ip->ip_dst.s_imp;
396 		dlink = IMPLINK_IP;
397 		len = ntohs(ip->ip_len);
398 		break;
399 	}
400 #endif
401 	case PF_IMPLINK:
402 		goto leaderexists;
403 
404 	default:
405 		printf("imp%d: can't encapsulate pf%d\n", ifp->if_unit, pf);
406 		goto drop;
407 	}
408 
409 	/*
410 	 * Add IMP leader.  If there's not enough space in the
411 	 * first mbuf, allocate another.  If that should fail, we
412 	 * drop this sucker.
413 	 */
414 	if (m->m_off > MMAXOFF ||
415 	    MMINOFF + sizeof(struct imp_leader) > m->m_off) {
416 		m = m_get(M_DONTWAIT);
417 		if (m == 0)
418 			goto drop;
419 		m->m_next = m0;
420 		m->m_off = MMINOFF;
421 		m->m_len = sizeof(struct imp_leader);
422 	} else {
423 		m->m_off -= sizeof(struct imp_leader);
424 		m->m_len += sizeof(struct imp_leader);
425 	}
426 	imp = mtod(m, struct imp_leader *);
427 	imp->il_format = IMP_NFF;
428 	imp->il_mtype = IMPTYPE_DATA;
429 #ifdef notdef
430 	imp->il_network = dnet;
431 #else
432 	imp->il_network = 0;
433 #endif
434 	imp->il_host = dhost;
435 	imp->il_imp = dimp;
436 	imp->il_length = htons((len + sizeof(struct imp_leader)) << 3);
437 	imp->il_link = dlink;
438 	imp->il_flags = imp->il_htype = imp->il_subtype = 0;
439 
440 leaderexists:
441 	/*
442 	 * Hand message to impsnd to perform RFNM counting
443 	 * and eventual transmission.
444 	 */
445 	return (impsnd(ifp, m));
446 drop:
447 	m_freem(m0);
448 	return (0);
449 }
450 
451 /*
452  * Put a message on an interface's output queue.
453  * Perform RFNM counting: no more than 8 message may be
454  * in flight to any one host.
455  */
456 impsnd(ifp, m)
457 	struct ifnet *ifp;
458 	struct mbuf *m;
459 {
460 	register struct imp_leader *ip;
461 	register struct host *hp;
462 	struct impcb *icp;
463 	int x;
464 
465 COUNT(IMPSND);
466 	ip = mtod(m, struct imp_leader *);
467 
468 	/*
469 	 * Do RFNM counting for data messages
470 	 * (no more than 8 outstanding to any host)
471 	 */
472 	x = splimp();
473 	if (ip->il_mtype == IMPTYPE_DATA) {
474 		struct in_addr addr;
475 
476 #ifdef notdef
477                 addr.s_net = ip->il_network;
478 #else
479 		addr.s_net = 0;
480 #endif
481                 addr.s_host = ip->il_host;
482                 addr.s_imp = ip->il_imp;
483 		if ((hp = hostlookup(addr)) == 0)
484 			hp = hostenter(addr);
485 
486 		/*
487 		 * If IMP would block, queue until RFNM
488 		 */
489 		if (hp) {
490 			if (hp->h_rfnm < 8) {
491 				hp->h_rfnm++;
492 				goto enque;
493 			}
494 			if (hp->h_qcnt < 8) {	/* high water mark */
495 				HOST_ENQUE(hp, m);
496 				goto start;
497 			}
498 		}
499 drop:
500 		m_freem(m);
501 		splx(x);
502 		return (0);
503 	}
504 enque:
505 	IF_ENQUEUE(&ifp->if_snd, m);
506 start:
507 	splx(x);
508 	icp = &imp_softc[ifp->if_unit].imp_cb;
509 	if (icp->ic_oactive == 0)
510 		(*icp->ic_start)(ifp->if_unit);
511 	return (1);
512 }
513 
514 /*
515  * Put three 1822 NOOPs at the head of the output queue.
516  * Part of host-IMP initialization procedure.
517  * (Should return success/failure, but noone knows
518  * what to do with this, so why bother?)
519  */
520 impnoops(sc)
521 	register struct imp_softc *sc;
522 {
523 	register i;
524 	register struct mbuf *m;
525 	register struct control_leader *cp;
526 	int x;
527 
528 COUNT(IMPNOOPS);
529 	sc->imp_state = IMPS_INIT;
530 	sc->imp_dropcnt = IMP_DROPCNT;
531 	for (i = 0; i < IMP_DROPCNT + 1; i++ ) {
532 		if ((m = m_getclr(M_DONTWAIT)) == 0)
533 			return;
534 		m->m_off = MMINOFF;
535 		m->m_len = sizeof(struct control_leader);
536 		cp = mtod(m, struct control_leader *);
537 		cp->dl_format = IMP_NFF;
538                 cp->dl_link = i;
539                 cp->dl_mtype = IMPTYPE_NOOP;
540 		x = splimp();
541 		IF_PREPEND(&sc->imp_if.if_snd, m);
542 		splx(x);
543 	}
544 	if (sc->imp_cb.ic_oactive == 0)
545 		(*sc->imp_cb.ic_start)(sc->imp_if.if_unit);
546 }
547 
548 #ifdef IMPLEADERS
549 printleader(routine, ip)
550 	char *routine;
551 	register struct imp_leader *ip;
552 {
553 	printf("%s: ", routine);
554 	printbyte((char *)ip, 12);
555 	printf("<fmt=%x,net=%x,flags=%x,mtype=", ip->il_format, ip->il_network,
556 		ip->il_flags);
557 	if (ip->il_mtype <= IMPTYPE_READY)
558 		printf("%s,", impleaders[ip->il_mtype]);
559 	else
560 		printf("%x,", ip->il_mtype);
561 	printf("htype=%x,host=%x,imp=%x,link=", ip->il_htype, ip->il_host,
562 		ip->il_impno);
563 	if (ip->il_link == IMPLINK_IP)
564 		printf("ip,");
565 	else
566 		printf("%x,", ip->il_link);
567 	printf("subtype=%x,len=%x>\n",ip->il_subtype,ntohs(ip->il_length)>>3);
568 }
569 
570 printbyte(cp, n)
571 	register char *cp;
572 	int n;
573 {
574 	register i, j, c;
575 
576 	for (i=0; i<n; i++) {
577 		c = *cp++;
578 		for (j=0; j<2; j++)
579 			putchar("0123456789abcdef"[(c>>((1-j)*4))&0xf]);
580 		putchar(' ');
581 	}
582 	putchar('\n');
583 }
584 #endif
585 #endif
586