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.
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.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * from: @(#)utils.c 8.1 (Berkeley) 6/4/93
39 * From: Utah Hdr: utils.c 3.1 92/07/06
40 * Author: Jeff Forys, University of Utah CSS
42 * @(#)utils.c 8.1 (Berkeley) 6/4/93
43 * $FreeBSD: src/libexec/rbootd/utils.c,v 1.5 1999/08/28 00:09:46 peter Exp $
46 #include <sys/param.h>
60 ** DispPkt -- Display the contents of an RMPCONN packet.
63 ** rconn - packet to be displayed.
64 ** direct - direction packet is going (DIR_*).
73 DispPkt(RMPCONN *rconn, int direct)
75 static char BootFmt[] = "\t\tRetCode:%u SeqNo:%lx SessID:%x Vers:%u";
76 static char ReadFmt[] = "\t\tRetCode:%u Offset:%lx SessID:%x\n";
79 struct rmp_packet *rmp;
84 * Since we will be working with RmpConns as well as DbgFp, we
85 * must block signals that can affect either.
87 omask = sigblock(sigmask(SIGHUP)|sigmask(SIGUSR1)|sigmask(SIGUSR2));
89 if (DbgFp == NULL) { /* sanity */
90 (void) sigsetmask(omask);
94 /* display direction packet is going using '>>>' or '<<<' */
95 fputs((direct==DIR_RCVD)?"<<< ":(direct==DIR_SENT)?">>> ":"", DbgFp);
97 /* display packet timestamp */
98 tmp = localtime((time_t *)&rconn->tstamp.tv_sec);
99 fprintf(DbgFp, "%02d:%02d:%02d.%06ld ", tmp->tm_hour, tmp->tm_min,
100 tmp->tm_sec, rconn->tstamp.tv_usec);
102 /* display src or dst addr and information about network interface */
103 fprintf(DbgFp, "Addr: %s Intf: %s\n", EnetStr(rconn), IntfName);
107 /* display IEEE 802.2 Logical Link Control header */
108 (void) fprintf(DbgFp, "\t802.2 LLC: DSAP:%x SSAP:%x CTRL:%x\n",
109 rmp->hp_llc.dsap, rmp->hp_llc.ssap, ntohs(rmp->hp_llc.cntrl));
111 /* display HP extensions to 802.2 Logical Link Control header */
112 (void) fprintf(DbgFp, "\tHP Ext: DXSAP:%x SXSAP:%x\n",
113 ntohs(rmp->hp_llc.dxsap), ntohs(rmp->hp_llc.sxsap));
116 * Display information about RMP packet using type field to
117 * determine what kind of packet this is.
119 switch(rmp->r_type) {
120 case RMP_BOOT_REQ: /* boot request */
121 (void) fprintf(DbgFp, "\tBoot Request:");
122 GETWORD(rmp->r_brq.rmp_seqno, t);
123 if (ntohs(rmp->r_brq.rmp_session) == RMP_PROBESID) {
124 if (WORDZE(rmp->r_brq.rmp_seqno))
125 fputs(" (Send Server ID)", DbgFp);
127 fprintf(DbgFp," (Send Filename #%u)",t);
129 (void) fputc('\n', DbgFp);
130 (void) fprintf(DbgFp, BootFmt, rmp->r_brq.rmp_retcode,
131 t, ntohs(rmp->r_brq.rmp_session),
132 ntohs(rmp->r_brq.rmp_version));
133 (void) fprintf(DbgFp, "\n\t\tMachine Type: ");
134 for (i = 0; i < RMP_MACHLEN; i++)
135 (void) fputc(rmp->r_brq.rmp_machtype[i], DbgFp);
136 DspFlnm(rmp->r_brq.rmp_flnmsize, &rmp->r_brq.rmp_flnm);
138 case RMP_BOOT_REPL: /* boot reply */
139 fprintf(DbgFp, "\tBoot Reply:\n");
140 GETWORD(rmp->r_brpl.rmp_seqno, t);
141 (void) fprintf(DbgFp, BootFmt, rmp->r_brpl.rmp_retcode,
142 t, ntohs(rmp->r_brpl.rmp_session),
143 ntohs(rmp->r_brpl.rmp_version));
144 DspFlnm(rmp->r_brpl.rmp_flnmsize,&rmp->r_brpl.rmp_flnm);
146 case RMP_READ_REQ: /* read request */
147 (void) fprintf(DbgFp, "\tRead Request:\n");
148 GETWORD(rmp->r_rrq.rmp_offset, t);
149 (void) fprintf(DbgFp, ReadFmt, rmp->r_rrq.rmp_retcode,
150 t, ntohs(rmp->r_rrq.rmp_session));
151 (void) fprintf(DbgFp, "\t\tNoOfBytes: %u\n",
152 ntohs(rmp->r_rrq.rmp_size));
154 case RMP_READ_REPL: /* read reply */
155 (void) fprintf(DbgFp, "\tRead Reply:\n");
156 GETWORD(rmp->r_rrpl.rmp_offset, t);
157 (void) fprintf(DbgFp, ReadFmt, rmp->r_rrpl.rmp_retcode,
158 t, ntohs(rmp->r_rrpl.rmp_session));
159 (void) fprintf(DbgFp, "\t\tNoOfBytesSent: %zd\n",
160 rconn->rmplen - RMPREADSIZE(0));
162 case RMP_BOOT_DONE: /* boot complete */
163 (void) fprintf(DbgFp, "\tBoot Complete:\n");
164 (void) fprintf(DbgFp, "\t\tRetCode:%u SessID:%x\n",
165 rmp->r_done.rmp_retcode,
166 ntohs(rmp->r_done.rmp_session));
169 (void) fprintf(DbgFp, "\tUnknown Type:(%d)\n",
172 (void) fputc('\n', DbgFp);
173 (void) fflush(DbgFp);
175 (void) sigsetmask(omask); /* reset old signal mask */
180 ** GetEtherAddr -- convert an RMP (Ethernet) address into a string.
182 ** An RMP BOOT packet has been received. Look at the type field
183 ** and process Boot Requests, Read Requests, and Boot Complete
184 ** packets. Any other type will be dropped with a warning msg.
187 ** addr - array of RMP_ADDRLEN bytes.
190 ** Pointer to static string representation of `addr'.
196 ** - The return value points to a static buffer; it must
197 ** be copied if it's to be saved.
200 GetEtherAddr(u_int8_t *addr)
202 static char Hex[] = "0123456789abcdef";
203 static char etherstr[RMP_ADDRLEN*3];
208 * For each byte in `addr', convert it to "<hexchar><hexchar>:".
209 * The last byte does not get a trailing `:' appended.
214 *cp++ = Hex[*addr >> 4 & 0xf];
215 *cp++ = Hex[*addr++ & 0xf];
216 if (++i == RMP_ADDRLEN)
227 ** DispFlnm -- Print a string of bytes to DbgFp (often, a file name).
230 ** size - number of bytes to print.
231 ** flnm - address of first byte.
237 ** - Characters are sent to `DbgFp'.
240 DspFlnm(u_int size, char *flnm)
244 (void) fprintf(DbgFp, "\n\t\tFile Name (%u): <", size);
245 for (i = 0; i < size; i++)
246 (void) fputc(*flnm++, DbgFp);
247 (void) fputs(">\n", DbgFp);
252 ** NewClient -- allocate memory for a new CLIENT.
255 ** addr - RMP (Ethernet) address of new client.
258 ** Ptr to new CLIENT or NULL if we ran out of memory.
261 ** - Memory will be malloc'd for the new CLIENT.
262 ** - If malloc() fails, a log message will be generated.
265 NewClient(u_int8_t *addr)
269 if ((ctmp = (CLIENT *) malloc(sizeof(CLIENT))) == NULL) {
270 syslog(LOG_ERR, "NewClient: out of memory (%s)",
275 memset(ctmp, 0, sizeof(CLIENT));
276 memmove(&ctmp->addr[0], addr, RMP_ADDRLEN);
281 ** FreeClient -- free linked list of Clients.
290 ** - All malloc'd memory associated with the linked list of
291 ** CLIENTS will be free'd; `Clients' will be set to NULL.
294 ** - This routine must be called with SIGHUP blocked.
301 while (Clients != NULL) {
303 Clients = Clients->next;
309 ** NewStr -- allocate memory for a character array.
312 ** str - null terminated character array.
315 ** Ptr to new character array or NULL if we ran out of memory.
318 ** - Memory will be malloc'd for the new character array.
319 ** - If malloc() fails, a log message will be generated.
326 if ((stmp = (char *)malloc((unsigned) (strlen(str)+1))) == NULL) {
327 syslog(LOG_ERR, "NewStr: out of memory (%s)", str);
331 (void) strcpy(stmp, str);
336 ** To save time, NewConn and FreeConn maintain a cache of one RMPCONN
337 ** in `LastFree' (defined below).
340 static RMPCONN *LastFree = NULL;
343 ** NewConn -- allocate memory for a new RMPCONN connection.
346 ** rconn - initialization template for new connection.
349 ** Ptr to new RMPCONN or NULL if we ran out of memory.
352 ** - Memory may be malloc'd for the new RMPCONN (if not cached).
353 ** - If malloc() fails, a log message will be generated.
356 NewConn(RMPCONN *rconn)
360 if (LastFree == NULL) { /* nothing cached; make a new one */
361 if ((rtmp = (RMPCONN *) malloc(sizeof(RMPCONN))) == NULL) {
362 syslog(LOG_ERR, "NewConn: out of memory (%s)",
366 } else { /* use the cached RMPCONN */
372 * Copy template into `rtmp', init file descriptor to `-1' and
373 * set ptr to next elem NULL.
375 memmove((char *)rtmp, (char *)rconn, sizeof(RMPCONN));
383 ** FreeConn -- Free memory associated with an RMPCONN connection.
386 ** rtmp - ptr to RMPCONN to be free'd.
392 ** - Memory associated with `rtmp' may be free'd (or cached).
393 ** - File desc associated with `rtmp->bootfd' will be closed.
396 FreeConn(RMPCONN *rtmp)
399 * If the file descriptor is in use, close the file.
401 if (rtmp->bootfd >= 0) {
402 (void) close(rtmp->bootfd);
406 if (LastFree == NULL) /* cache for next time */
408 else /* already one cached; free this one */
413 ** FreeConns -- free linked list of RMPCONN connections.
422 ** - All malloc'd memory associated with the linked list of
423 ** connections will be free'd; `RmpConns' will be set to NULL.
424 ** - If LastFree is != NULL, it too will be free'd & NULL'd.
427 ** - This routine must be called with SIGHUP blocked.
434 while (RmpConns != NULL) {
436 RmpConns = RmpConns->next;
440 if (LastFree != NULL) {
441 free((char *)LastFree);
447 ** AddConn -- Add a connection to the linked list of connections.
450 ** rconn - connection to be added.
456 ** - RmpConn will point to new connection.
459 ** - This routine must be called with SIGHUP blocked.
462 AddConn(RMPCONN *rconn)
464 if (RmpConns != NULL)
465 rconn->next = RmpConns;
470 ** FindConn -- Find a connection in the linked list of connections.
472 ** We use the RMP (Ethernet) address as the basis for determining
473 ** if this is the same connection. According to the Remote Maint
474 ** Protocol, we can only have one connection with any machine.
477 ** rconn - connection to be found.
480 ** Matching connection from linked list or NULL if not found.
486 ** - This routine must be called with SIGHUP blocked.
489 FindConn(RMPCONN *rconn)
493 for (rtmp = RmpConns; rtmp != NULL; rtmp = rtmp->next)
494 if (bcmp((char *)&rconn->rmp.hp_hdr.saddr[0],
495 (char *)&rtmp->rmp.hp_hdr.saddr[0], RMP_ADDRLEN) == 0)
502 ** RemoveConn -- Remove a connection from the linked list of connections.
505 ** rconn - connection to be removed.
511 ** - If found, an RMPCONN will cease to exist and it will
512 ** be removed from the linked list.
515 ** - This routine must be called with SIGHUP blocked.
518 RemoveConn(RMPCONN *rconn)
520 RMPCONN *thisrconn, *lastrconn;
522 if (RmpConns == rconn) { /* easy case */
523 RmpConns = RmpConns->next;
525 } else { /* must traverse linked list */
526 lastrconn = RmpConns; /* set back ptr */
527 thisrconn = lastrconn->next; /* set current ptr */
528 while (thisrconn != NULL) {
529 if (rconn == thisrconn) { /* found it */
530 lastrconn->next = thisrconn->next;
534 lastrconn = thisrconn;
535 thisrconn = thisrconn->next;