xref: /freebsd/libexec/rbootd/utils.c (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
1 /*
2  * Copyright (c) 1988, 1992 The University of Utah and the Center
3  *	for Software Science (CSS).
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * the Center for Software Science of the University of Utah Computer
9  * Science Department.  CSS requests users of this software to return
10  * to css-dist@cs.utah.edu any improvements that they make and grant
11  * CSS redistribution rights.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. All advertising materials mentioning features or use of this software
22  *    must display the following acknowledgement:
23  *	This product includes software developed by the University of
24  *	California, Berkeley and its contributors.
25  * 4. Neither the name of the University nor the names of its contributors
26  *    may be used to endorse or promote products derived from this software
27  *    without specific prior written permission.
28  *
29  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39  * SUCH DAMAGE.
40  *
41  *	@(#)utils.c	8.2 (Berkeley) 2/22/94
42  *
43  * Utah $Hdr: utils.c 3.1 92/07/06$
44  * Author: Jeff Forys, University of Utah CSS
45  */
46 
47 #ifndef lint
48 static char sccsid[] = "@(#)utils.c	8.2 (Berkeley) 2/22/94";
49 #endif /* not lint */
50 
51 #include <sys/param.h>
52 #include <sys/time.h>
53 
54 #include <fcntl.h>
55 #include <signal.h>
56 #include <stdio.h>
57 #include <stdlib.h>
58 #include <string.h>
59 #include <syslog.h>
60 #include <time.h>
61 #include <unistd.h>
62 #include "defs.h"
63 
64 /*
65 **  DispPkt -- Display the contents of an RMPCONN packet.
66 **
67 **	Parameters:
68 **		rconn - packet to be displayed.
69 **		direct - direction packet is going (DIR_*).
70 **
71 **	Returns:
72 **		Nothing.
73 **
74 **	Side Effects:
75 **		None.
76 */
77 void
78 DispPkt(rconn, direct)
79 	RMPCONN *rconn;
80 	int direct;
81 {
82 	static char BootFmt[] = "\t\tRetCode:%u SeqNo:%lx SessID:%x Vers:%u";
83 	static char ReadFmt[] = "\t\tRetCode:%u Offset:%lx SessID:%x\n";
84 
85 	struct tm *tmp;
86 	register struct rmp_packet *rmp;
87 	int i, omask;
88 	u_int t;
89 
90 	/*
91 	 *  Since we will be working with RmpConns as well as DbgFp, we
92 	 *  must block signals that can affect either.
93 	 */
94 	omask = sigblock(sigmask(SIGHUP)|sigmask(SIGUSR1)|sigmask(SIGUSR2));
95 
96 	if (DbgFp == NULL) {			/* sanity */
97 		(void) sigsetmask(omask);
98 		return;
99 	}
100 
101 	/* display direction packet is going using '>>>' or '<<<' */
102 	fputs((direct==DIR_RCVD)?"<<< ":(direct==DIR_SENT)?">>> ":"", DbgFp);
103 
104 	/* display packet timestamp */
105 	tmp = localtime((time_t *)&rconn->tstamp.tv_sec);
106 	fprintf(DbgFp, "%02d:%02d:%02d.%06ld   ", tmp->tm_hour, tmp->tm_min,
107 	        tmp->tm_sec, rconn->tstamp.tv_usec);
108 
109 	/* display src or dst addr and information about network interface */
110 	fprintf(DbgFp, "Addr: %s   Intf: %s\n", EnetStr(rconn), IntfName);
111 
112 	rmp = &rconn->rmp;
113 
114 	/* display IEEE 802.2 Logical Link Control header */
115 	(void) fprintf(DbgFp, "\t802.2 LLC: DSAP:%x SSAP:%x CTRL:%x\n",
116 	               rmp->hp_llc.dsap, rmp->hp_llc.ssap, rmp->hp_llc.cntrl);
117 
118 	/* display HP extensions to 802.2 Logical Link Control header */
119 	(void) fprintf(DbgFp, "\tHP Ext:    DXSAP:%x SXSAP:%x\n",
120 	               rmp->hp_llc.dxsap, rmp->hp_llc.sxsap);
121 
122 	/*
123 	 *  Display information about RMP packet using type field to
124 	 *  determine what kind of packet this is.
125 	 */
126 	switch(rmp->r_type) {
127 		case RMP_BOOT_REQ:		/* boot request */
128 			(void) fprintf(DbgFp, "\tBoot Request:");
129 			GETWORD(rmp->r_brq.rmp_seqno, t);
130 			if (rmp->r_brq.rmp_session == RMP_PROBESID) {
131 				if (WORDZE(rmp->r_brq.rmp_seqno))
132 					fputs(" (Send Server ID)", DbgFp);
133 				else
134 					fprintf(DbgFp," (Send Filename #%u)",t);
135 			}
136 			(void) fputc('\n', DbgFp);
137 			(void) fprintf(DbgFp, BootFmt, rmp->r_brq.rmp_retcode,
138 			        t, rmp->r_brq.rmp_session,
139 			        rmp->r_brq.rmp_version);
140 			(void) fprintf(DbgFp, "\n\t\tMachine Type: ");
141 			for (i = 0; i < RMP_MACHLEN; i++)
142 				(void) fputc(rmp->r_brq.rmp_machtype[i], DbgFp);
143 			DspFlnm(rmp->r_brq.rmp_flnmsize, &rmp->r_brq.rmp_flnm);
144 			break;
145 		case RMP_BOOT_REPL:		/* boot reply */
146 			fprintf(DbgFp, "\tBoot Reply:\n");
147 			GETWORD(rmp->r_brpl.rmp_seqno, t);
148 			(void) fprintf(DbgFp, BootFmt, rmp->r_brpl.rmp_retcode,
149 			        t, rmp->r_brpl.rmp_session,
150 			        rmp->r_brpl.rmp_version);
151 			DspFlnm(rmp->r_brpl.rmp_flnmsize,&rmp->r_brpl.rmp_flnm);
152 			break;
153 		case RMP_READ_REQ:		/* read request */
154 			(void) fprintf(DbgFp, "\tRead Request:\n");
155 			GETWORD(rmp->r_rrq.rmp_offset, t);
156 			(void) fprintf(DbgFp, ReadFmt, rmp->r_rrq.rmp_retcode,
157 			        t, rmp->r_rrq.rmp_session);
158 			(void) fprintf(DbgFp, "\t\tNoOfBytes: %u\n",
159 			        rmp->r_rrq.rmp_size);
160 			break;
161 		case RMP_READ_REPL:		/* read reply */
162 			(void) fprintf(DbgFp, "\tRead Reply:\n");
163 			GETWORD(rmp->r_rrpl.rmp_offset, t);
164 			(void) fprintf(DbgFp, ReadFmt, rmp->r_rrpl.rmp_retcode,
165 			        t, rmp->r_rrpl.rmp_session);
166 			(void) fprintf(DbgFp, "\t\tNoOfBytesSent: %d\n",
167 			        rconn->rmplen - RMPREADSIZE(0));
168 			break;
169 		case RMP_BOOT_DONE:		/* boot complete */
170 			(void) fprintf(DbgFp, "\tBoot Complete:\n");
171 			(void) fprintf(DbgFp, "\t\tRetCode:%u SessID:%x\n",
172 			        rmp->r_done.rmp_retcode,
173 			        rmp->r_done.rmp_session);
174 			break;
175 		default:			/* ??? */
176 			(void) fprintf(DbgFp, "\tUnknown Type:(%d)\n",
177 				rmp->r_type);
178 	}
179 	(void) fputc('\n', DbgFp);
180 	(void) fflush(DbgFp);
181 
182 	(void) sigsetmask(omask);		/* reset old signal mask */
183 }
184 
185 
186 /*
187 **  GetEtherAddr -- convert an RMP (Ethernet) address into a string.
188 **
189 **	An RMP BOOT packet has been received.  Look at the type field
190 **	and process Boot Requests, Read Requests, and Boot Complete
191 **	packets.  Any other type will be dropped with a warning msg.
192 **
193 **	Parameters:
194 **		addr - array of RMP_ADDRLEN bytes.
195 **
196 **	Returns:
197 **		Pointer to static string representation of `addr'.
198 **
199 **	Side Effects:
200 **		None.
201 **
202 **	Warnings:
203 **		- The return value points to a static buffer; it must
204 **		  be copied if it's to be saved.
205 **		- For speed, we assume a u_char consists of 8 bits.
206 */
207 char *
208 GetEtherAddr(addr)
209 	u_char *addr;
210 {
211 	static char Hex[] = "0123456789abcdef";
212 	static char etherstr[RMP_ADDRLEN*3];
213 	register int i;
214 	register char *cp1, *cp2;
215 
216 	/*
217 	 *  For each byte in `addr', convert it to "<hexchar><hexchar>:".
218 	 *  The last byte does not get a trailing `:' appended.
219 	 */
220 	i = 0;
221 	cp1 = (char *)addr;
222 	cp2 = etherstr;
223 	for(;;) {
224 		*cp2++ = Hex[*cp1 >> 4 & 0xf];
225 		*cp2++ = Hex[*cp1++ & 0xf];
226 		if (++i == RMP_ADDRLEN)
227 			break;
228 		*cp2++ = ':';
229 	}
230 	*cp2 = '\0';
231 
232 	return(etherstr);
233 }
234 
235 
236 /*
237 **  DispFlnm -- Print a string of bytes to DbgFp (often, a file name).
238 **
239 **	Parameters:
240 **		size - number of bytes to print.
241 **		flnm - address of first byte.
242 **
243 **	Returns:
244 **		Nothing.
245 **
246 **	Side Effects:
247 **		- Characters are sent to `DbgFp'.
248 */
249 void
250 DspFlnm(size, flnm)
251 	register u_int size;
252 	register char *flnm;
253 {
254 	register int i;
255 
256 	(void) fprintf(DbgFp, "\n\t\tFile Name (%d): <", size);
257 	for (i = 0; i < size; i++)
258 		(void) fputc(*flnm++, DbgFp);
259 	(void) fputs(">\n", DbgFp);
260 }
261 
262 
263 /*
264 **  NewClient -- allocate memory for a new CLIENT.
265 **
266 **	Parameters:
267 **		addr - RMP (Ethernet) address of new client.
268 **
269 **	Returns:
270 **		Ptr to new CLIENT or NULL if we ran out of memory.
271 **
272 **	Side Effects:
273 **		- Memory will be malloc'd for the new CLIENT.
274 **		- If malloc() fails, a log message will be generated.
275 */
276 CLIENT *
277 NewClient(addr)
278 	u_char *addr;
279 {
280 	CLIENT *ctmp;
281 
282 	if ((ctmp = (CLIENT *) malloc(sizeof(CLIENT))) == NULL) {
283 		syslog(LOG_ERR, "NewClient: out of memory (%s)",
284 		       GetEtherAddr(addr));
285 		return(NULL);
286 	}
287 
288 	bzero(ctmp, sizeof(CLIENT));
289 	bcopy(addr, &ctmp->addr[0], RMP_ADDRLEN);
290 	return(ctmp);
291 }
292 
293 /*
294 **  FreeClient -- free linked list of Clients.
295 **
296 **	Parameters:
297 **		None.
298 **
299 **	Returns:
300 **		Nothing.
301 **
302 **	Side Effects:
303 **		- All malloc'd memory associated with the linked list of
304 **		  CLIENTS will be free'd; `Clients' will be set to NULL.
305 **
306 **	Warnings:
307 **		- This routine must be called with SIGHUP blocked.
308 */
309 void
310 FreeClients()
311 {
312 	register CLIENT *ctmp;
313 
314 	while (Clients != NULL) {
315 		ctmp = Clients;
316 		Clients = Clients->next;
317 		FreeClient(ctmp);
318 	}
319 }
320 
321 /*
322 **  NewStr -- allocate memory for a character array.
323 **
324 **	Parameters:
325 **		str - null terminated character array.
326 **
327 **	Returns:
328 **		Ptr to new character array or NULL if we ran out of memory.
329 **
330 **	Side Effects:
331 **		- Memory will be malloc'd for the new character array.
332 **		- If malloc() fails, a log message will be generated.
333 */
334 char *
335 NewStr(str)
336 	char *str;
337 {
338 	char *stmp;
339 
340 	if ((stmp = (char *)malloc((unsigned) (strlen(str)+1))) == NULL) {
341 		syslog(LOG_ERR, "NewStr: out of memory (%s)", str);
342 		return(NULL);
343 	}
344 
345 	(void) strcpy(stmp, str);
346 	return(stmp);
347 }
348 
349 /*
350 **  To save time, NewConn and FreeConn maintain a cache of one RMPCONN
351 **  in `LastFree' (defined below).
352 */
353 
354 static RMPCONN *LastFree = NULL;
355 
356 /*
357 **  NewConn -- allocate memory for a new RMPCONN connection.
358 **
359 **	Parameters:
360 **		rconn - initialization template for new connection.
361 **
362 **	Returns:
363 **		Ptr to new RMPCONN or NULL if we ran out of memory.
364 **
365 **	Side Effects:
366 **		- Memory may be malloc'd for the new RMPCONN (if not cached).
367 **		- If malloc() fails, a log message will be generated.
368 */
369 RMPCONN *
370 NewConn(rconn)
371 	RMPCONN *rconn;
372 {
373 	RMPCONN *rtmp;
374 
375 	if (LastFree == NULL) {		/* nothing cached; make a new one */
376 		if ((rtmp = (RMPCONN *) malloc(sizeof(RMPCONN))) == NULL) {
377 			syslog(LOG_ERR, "NewConn: out of memory (%s)",
378 			       EnetStr(rconn));
379 			return(NULL);
380 		}
381 	} else {			/* use the cached RMPCONN */
382 		rtmp = LastFree;
383 		LastFree = NULL;
384 	}
385 
386 	/*
387 	 *  Copy template into `rtmp', init file descriptor to `-1' and
388 	 *  set ptr to next elem NULL.
389 	 */
390 	bcopy((char *)rconn, (char *)rtmp, sizeof(RMPCONN));
391 	rtmp->bootfd = -1;
392 	rtmp->next = NULL;
393 
394 	return(rtmp);
395 }
396 
397 /*
398 **  FreeConn -- Free memory associated with an RMPCONN connection.
399 **
400 **	Parameters:
401 **		rtmp - ptr to RMPCONN to be free'd.
402 **
403 **	Returns:
404 **		Nothing.
405 **
406 **	Side Effects:
407 **		- Memory associated with `rtmp' may be free'd (or cached).
408 **		- File desc associated with `rtmp->bootfd' will be closed.
409 */
410 void
411 FreeConn(rtmp)
412 	register RMPCONN *rtmp;
413 {
414 	/*
415 	 *  If the file descriptor is in use, close the file.
416 	 */
417 	if (rtmp->bootfd >= 0) {
418 		(void) close(rtmp->bootfd);
419 		rtmp->bootfd = -1;
420 	}
421 
422 	if (LastFree == NULL)		/* cache for next time */
423 		rtmp = LastFree;
424 	else				/* already one cached; free this one */
425 		free((char *)rtmp);
426 }
427 
428 /*
429 **  FreeConns -- free linked list of RMPCONN connections.
430 **
431 **	Parameters:
432 **		None.
433 **
434 **	Returns:
435 **		Nothing.
436 **
437 **	Side Effects:
438 **		- All malloc'd memory associated with the linked list of
439 **		  connections will be free'd; `RmpConns' will be set to NULL.
440 **		- If LastFree is != NULL, it too will be free'd & NULL'd.
441 **
442 **	Warnings:
443 **		- This routine must be called with SIGHUP blocked.
444 */
445 void
446 FreeConns()
447 {
448 	register RMPCONN *rtmp;
449 
450 	while (RmpConns != NULL) {
451 		rtmp = RmpConns;
452 		RmpConns = RmpConns->next;
453 		FreeConn(rtmp);
454 	}
455 
456 	if (LastFree != NULL) {
457 		free((char *)LastFree);
458 		LastFree = NULL;
459 	}
460 }
461 
462 /*
463 **  AddConn -- Add a connection to the linked list of connections.
464 **
465 **	Parameters:
466 **		rconn - connection to be added.
467 **
468 **	Returns:
469 **		Nothing.
470 **
471 **	Side Effects:
472 **		- RmpConn will point to new connection.
473 **
474 **	Warnings:
475 **		- This routine must be called with SIGHUP blocked.
476 */
477 void
478 AddConn(rconn)
479 	register RMPCONN *rconn;
480 {
481 	if (RmpConns != NULL)
482 		rconn->next = RmpConns;
483 	RmpConns = rconn;
484 }
485 
486 /*
487 **  FindConn -- Find a connection in the linked list of connections.
488 **
489 **	We use the RMP (Ethernet) address as the basis for determining
490 **	if this is the same connection.  According to the Remote Maint
491 **	Protocol, we can only have one connection with any machine.
492 **
493 **	Parameters:
494 **		rconn - connection to be found.
495 **
496 **	Returns:
497 **		Matching connection from linked list or NULL if not found.
498 **
499 **	Side Effects:
500 **		None.
501 **
502 **	Warnings:
503 **		- This routine must be called with SIGHUP blocked.
504 */
505 RMPCONN *
506 FindConn(rconn)
507 	register RMPCONN *rconn;
508 {
509 	register RMPCONN *rtmp;
510 
511 	for (rtmp = RmpConns; rtmp != NULL; rtmp = rtmp->next)
512 		if (bcmp((char *)&rconn->rmp.hp_hdr.saddr[0],
513 		         (char *)&rtmp->rmp.hp_hdr.saddr[0], RMP_ADDRLEN) == 0)
514 			break;
515 
516 	return(rtmp);
517 }
518 
519 /*
520 **  RemoveConn -- Remove a connection from the linked list of connections.
521 **
522 **	Parameters:
523 **		rconn - connection to be removed.
524 **
525 **	Returns:
526 **		Nothing.
527 **
528 **	Side Effects:
529 **		- If found, an RMPCONN will cease to exist and it will
530 **		  be removed from the linked list.
531 **
532 **	Warnings:
533 **		- This routine must be called with SIGHUP blocked.
534 */
535 void
536 RemoveConn(rconn)
537 	register RMPCONN *rconn;
538 {
539 	register RMPCONN *thisrconn, *lastrconn;
540 
541 	if (RmpConns == rconn) {		/* easy case */
542 		RmpConns = RmpConns->next;
543 		FreeConn(rconn);
544 	} else {				/* must traverse linked list */
545 		lastrconn = RmpConns;			/* set back ptr */
546 		thisrconn = lastrconn->next;		/* set current ptr */
547 		while (thisrconn != NULL) {
548 			if (rconn == thisrconn) {		/* found it */
549 				lastrconn->next = thisrconn->next;
550 				FreeConn(thisrconn);
551 				break;
552 			}
553 			lastrconn = thisrconn;
554 			thisrconn = thisrconn->next;
555 		}
556 	}
557 }
558