1 /* $NetBSD: utils.c,v 1.17 2011/02/08 20:20:28 rmind Exp $ */ 2 3 /* 4 * Copyright (c) 1988, 1992 The University of Utah and the Center 5 * for Software Science (CSS). 6 * Copyright (c) 1992, 1993 7 * The Regents of the University of California. All rights reserved. 8 * 9 * This code is derived from software contributed to Berkeley by 10 * the Center for Software Science of the University of Utah Computer 11 * Science Department. CSS requests users of this software to return 12 * to css-dist@cs.utah.edu any improvements that they make and grant 13 * CSS redistribution rights. 14 * 15 * Redistribution and use in source and binary forms, with or without 16 * modification, are permitted provided that the following conditions 17 * are met: 18 * 1. Redistributions of source code must retain the above copyright 19 * notice, this list of conditions and the following disclaimer. 20 * 2. Redistributions in binary form must reproduce the above copyright 21 * notice, this list of conditions and the following disclaimer in the 22 * documentation and/or other materials provided with the distribution. 23 * 3. Neither the name of the University nor the names of its contributors 24 * may be used to endorse or promote products derived from this software 25 * without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 37 * SUCH DAMAGE. 38 * 39 * from: @(#)utils.c 8.1 (Berkeley) 6/4/93 40 * 41 * From: Utah Hdr: utils.c 3.1 92/07/06 42 * Author: Jeff Forys, University of Utah CSS 43 */ 44 45 #include <sys/cdefs.h> 46 #ifndef lint 47 #if 0 48 static char sccsid[] = "@(#)utils.c 8.1 (Berkeley) 6/4/93"; 49 #else 50 __RCSID("$NetBSD: utils.c,v 1.17 2011/02/08 20:20:28 rmind Exp $"); 51 #endif 52 #endif /* not lint */ 53 54 #include <sys/param.h> 55 #include <sys/time.h> 56 57 #include <fcntl.h> 58 #include <signal.h> 59 #include <stdio.h> 60 #include <stdlib.h> 61 #include <string.h> 62 #include <syslog.h> 63 #include <time.h> 64 #include <unistd.h> 65 #include "defs.h" 66 67 /* 68 ** DispPkt -- Display the contents of an RMPCONN packet. 69 ** 70 ** Parameters: 71 ** rconn - packet to be displayed. 72 ** direct - direction packet is going (DIR_*). 73 ** 74 ** Returns: 75 ** Nothing. 76 ** 77 ** Side Effects: 78 ** None. 79 */ 80 void 81 DispPkt(rconn, direct) 82 RMPCONN *rconn; 83 int direct; 84 { 85 static const char BootFmt[] = "\t\tRetCode:%u SeqNo:%lx SessID:%x Vers:%u"; 86 static const char ReadFmt[] = "\t\tRetCode:%u Offset:%lx SessID:%x\n"; 87 88 struct tm *tmp; 89 struct rmp_packet *rmp; 90 int i, omask; 91 u_int32_t t; 92 93 /* 94 * Since we will be working with RmpConns as well as DbgFp, we 95 * must block signals that can affect either. 96 */ 97 omask = sigblock(sigmask(SIGHUP)|sigmask(SIGUSR1)|sigmask(SIGUSR2)); 98 99 if (DbgFp == NULL) { /* sanity */ 100 (void) sigsetmask(omask); 101 return; 102 } 103 104 /* display direction packet is going using '>>>' or '<<<' */ 105 fputs((direct==DIR_RCVD)?"<<< ":(direct==DIR_SENT)?">>> ":"", DbgFp); 106 107 /* display packet timestamp */ 108 tmp = localtime((time_t *)&rconn->tstamp.tv_sec); 109 fprintf(DbgFp, "%02d:%02d:%02d.%06ld ", tmp->tm_hour, tmp->tm_min, 110 tmp->tm_sec, (long int)rconn->tstamp.tv_usec); 111 112 /* display src or dst addr and information about network interface */ 113 fprintf(DbgFp, "Addr: %s Intf: %s\n", EnetStr(rconn), IntfName); 114 115 rmp = &rconn->rmp; 116 117 /* display IEEE 802.2 Logical Link Control header */ 118 (void) fprintf(DbgFp, "\t802.2 LLC: DSAP:%x SSAP:%x CTRL:%x\n", 119 rmp->hp_llc.dsap, rmp->hp_llc.ssap, ntohs(rmp->hp_llc.cntrl)); 120 121 /* display HP extensions to 802.2 Logical Link Control header */ 122 (void) fprintf(DbgFp, "\tHP Ext: DXSAP:%x SXSAP:%x\n", 123 ntohs(rmp->hp_llc.dxsap), ntohs(rmp->hp_llc.sxsap)); 124 125 /* 126 * Display information about RMP packet using type field to 127 * determine what kind of packet this is. 128 */ 129 switch(rmp->r_type) { 130 case RMP_BOOT_REQ: /* boot request */ 131 (void) fprintf(DbgFp, "\tBoot Request:"); 132 GETWORD(rmp->r_brq.rmp_seqno, t); 133 if (ntohs(rmp->r_brq.rmp_session) == RMP_PROBESID) { 134 if (WORDZE(rmp->r_brq.rmp_seqno)) 135 fputs(" (Send Server ID)", DbgFp); 136 else 137 fprintf(DbgFp," (Send Filename #%u)",t); 138 } 139 (void) fputc('\n', DbgFp); 140 (void) fprintf(DbgFp, BootFmt, rmp->r_brq.rmp_retcode, 141 (unsigned long)t, ntohs(rmp->r_brq.rmp_session), 142 ntohs(rmp->r_brq.rmp_version)); 143 (void) fprintf(DbgFp, "\n\t\tMachine Type: "); 144 for (i = 0; i < RMP_MACHLEN; i++) 145 (void) fputc(rmp->r_brq.rmp_machtype[i], DbgFp); 146 DspFlnm(rmp->r_brq.rmp_flnmsize, &rmp->r_brq.rmp_flnm); 147 break; 148 case RMP_BOOT_REPL: /* boot reply */ 149 fprintf(DbgFp, "\tBoot Reply:\n"); 150 GETWORD(rmp->r_brpl.rmp_seqno, t); 151 (void) fprintf(DbgFp, BootFmt, rmp->r_brpl.rmp_retcode, 152 (unsigned long)t, ntohs(rmp->r_brpl.rmp_session), 153 ntohs(rmp->r_brpl.rmp_version)); 154 DspFlnm(rmp->r_brpl.rmp_flnmsize,&rmp->r_brpl.rmp_flnm); 155 break; 156 case RMP_READ_REQ: /* read request */ 157 (void) fprintf(DbgFp, "\tRead Request:\n"); 158 GETWORD(rmp->r_rrq.rmp_offset, t); 159 (void) fprintf(DbgFp, ReadFmt, rmp->r_rrq.rmp_retcode, 160 (unsigned long)t, ntohs(rmp->r_rrq.rmp_session)); 161 (void) fprintf(DbgFp, "\t\tNoOfBytes: %u\n", 162 ntohs(rmp->r_rrq.rmp_size)); 163 break; 164 case RMP_READ_REPL: /* read reply */ 165 (void) fprintf(DbgFp, "\tRead Reply:\n"); 166 GETWORD(rmp->r_rrpl.rmp_offset, t); 167 (void) fprintf(DbgFp, ReadFmt, rmp->r_rrpl.rmp_retcode, 168 (unsigned long)t, ntohs(rmp->r_rrpl.rmp_session)); 169 (void) fprintf(DbgFp, "\t\tNoOfBytesSent: %ld\n", 170 (long)(rconn->rmplen - RMPREADSIZE(0))); 171 break; 172 case RMP_BOOT_DONE: /* boot complete */ 173 (void) fprintf(DbgFp, "\tBoot Complete:\n"); 174 (void) fprintf(DbgFp, "\t\tRetCode:%u SessID:%x\n", 175 rmp->r_done.rmp_retcode, 176 ntohs(rmp->r_done.rmp_session)); 177 break; 178 default: /* ??? */ 179 (void) fprintf(DbgFp, "\tUnknown Type:(%d)\n", 180 rmp->r_type); 181 } 182 (void) fputc('\n', DbgFp); 183 (void) fflush(DbgFp); 184 185 (void) sigsetmask(omask); /* reset old signal mask */ 186 } 187 188 189 /* 190 ** GetEtherAddr -- convert an RMP (Ethernet) address into a string. 191 ** 192 ** An RMP BOOT packet has been received. Look at the type field 193 ** and process Boot Requests, Read Requests, and Boot Complete 194 ** packets. Any other type will be dropped with a warning msg. 195 ** 196 ** Parameters: 197 ** addr - array of RMP_ADDRLEN bytes. 198 ** 199 ** Returns: 200 ** Pointer to static string representation of `addr'. 201 ** 202 ** Side Effects: 203 ** None. 204 ** 205 ** Warnings: 206 ** - The return value points to a static buffer; it must 207 ** be copied if it's to be saved. 208 */ 209 char * 210 GetEtherAddr(addr) 211 u_int8_t *addr; 212 { 213 static char Hex[] = "0123456789abcdef"; 214 static char etherstr[RMP_ADDRLEN*3]; 215 int i; 216 char *cp; 217 218 /* 219 * For each byte in `addr', convert it to "<hexchar><hexchar>:". 220 * The last byte does not get a trailing `:' appended. 221 */ 222 i = 0; 223 cp = etherstr; 224 for(;;) { 225 *cp++ = Hex[*addr >> 4 & 0xf]; 226 *cp++ = Hex[*addr++ & 0xf]; 227 if (++i == RMP_ADDRLEN) 228 break; 229 *cp++ = ':'; 230 } 231 *cp = '\0'; 232 233 return(etherstr); 234 } 235 236 237 /* 238 ** DispFlnm -- Print a string of bytes to DbgFp (often, a file name). 239 ** 240 ** Parameters: 241 ** size - number of bytes to print. 242 ** flnm - address of first byte. 243 ** 244 ** Returns: 245 ** Nothing. 246 ** 247 ** Side Effects: 248 ** - Characters are sent to `DbgFp'. 249 */ 250 void 251 DspFlnm(size, flnm) 252 u_int size; 253 char *flnm; 254 { 255 size_t i; 256 257 (void) fprintf(DbgFp, "\n\t\tFile Name (%u): <", size); 258 for (i = 0; i < size; i++) 259 (void) fputc(*flnm++, DbgFp); 260 (void) fputs(">\n", DbgFp); 261 } 262 263 264 /* 265 ** NewClient -- allocate memory for a new CLIENT. 266 ** 267 ** Parameters: 268 ** addr - RMP (Ethernet) address of new client. 269 ** 270 ** Returns: 271 ** Ptr to new CLIENT or NULL if we ran out of memory. 272 ** 273 ** Side Effects: 274 ** - Memory will be malloc'd for the new CLIENT. 275 ** - If malloc() fails, a log message will be generated. 276 */ 277 CLIENT * 278 NewClient(addr) 279 u_int8_t *addr; 280 { 281 CLIENT *ctmp; 282 283 if ((ctmp = (CLIENT *) malloc(sizeof(CLIENT))) == NULL) { 284 syslog(LOG_ERR, "NewClient: out of memory (%s)", 285 GetEtherAddr(addr)); 286 return(NULL); 287 } 288 289 memset(ctmp, 0, sizeof(CLIENT)); 290 memmove(&ctmp->addr[0], addr, RMP_ADDRLEN); 291 return(ctmp); 292 } 293 294 /* 295 ** FreeClients -- free linked list of Clients. 296 ** 297 ** Parameters: 298 ** None. 299 ** 300 ** Returns: 301 ** Nothing. 302 ** 303 ** Side Effects: 304 ** - All malloc'd memory associated with the linked list of 305 ** CLIENTS will be free'd; `Clients' will be set to NULL. 306 ** 307 ** Warnings: 308 ** - This routine must be called with SIGHUP blocked. 309 */ 310 void 311 FreeClients() 312 { 313 CLIENT *ctmp; 314 315 while (Clients != NULL) { 316 ctmp = Clients; 317 Clients = Clients->next; 318 FreeClient(ctmp); 319 } 320 } 321 322 /* 323 ** NewStr -- allocate memory for a character array. 324 ** 325 ** Parameters: 326 ** str - null terminated character array. 327 ** 328 ** Returns: 329 ** Ptr to new character array or NULL if we ran out of memory. 330 ** 331 ** Side Effects: 332 ** - Memory will be malloc'd for the new character array. 333 ** - If malloc() fails, a log message will be generated. 334 */ 335 char * 336 NewStr(str) 337 char *str; 338 { 339 char *stmp; 340 341 if ((stmp = strdup(str)) == NULL) { 342 syslog(LOG_ERR, "NewStr: out of memory (%s)", str); 343 return(NULL); 344 } 345 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 memmove((char *)rtmp, (char *)rconn, 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 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 LastFree = rtmp; 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 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 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 RMPCONN *rconn; 508 { 509 RMPCONN *rtmp; 510 511 for (rtmp = RmpConns; rtmp != NULL; rtmp = rtmp->next) 512 if (memcmp((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 RMPCONN *rconn; 538 { 539 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