libexec/rbootd/defs.h

   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  *      from: @(#)defs.h        8.1 (Berkeley) 6/4/93
  42  *
  43  * From: Utah Hdr: defs.h 3.1 92/07/06
  44  * Author: Jeff Forys, University of Utah CSS
  45  *
  46  * $FreeBSD: src/libexec/rbootd/defs.h,v 1.2.6.1 2001/02/18 02:54:11 kris Exp $
  47  * $DragonFly: src/libexec/rbootd/defs.h,v 1.3 2003/11/14 03:54:30 dillon Exp $
  48  */
  49
  50 #include "rmp.h"
  51 #include "rmp_var.h"
  52
  53 /*
  54 **  Common #define's and external variables.  All other files should
  55 **  include this.
  56 */
  57
  58 /*
  59  *  This may be defined in <sys/param.h>, if not, it's defined here.
  60  */
  61 #ifndef MAXHOSTNAMELEN
  62 #define MAXHOSTNAMELEN 256
  63 #endif
  64
  65 /*
  66  *  SIGUSR1 and SIGUSR2 are defined in <signal.h> for 4.3BSD systems.
  67  */
  68 #ifndef SIGUSR1
  69 #define SIGUSR1 SIGEMT
  70 #endif
  71 #ifndef SIGUSR2
  72 #define SIGUSR2 SIGFPE
  73 #endif
  74
  75 /*
  76  *  These can be faster & more efficient than strcmp()/strncmp()...
  77  */
  78 #define STREQN(s1,s2)           ((*s1 == *s2) && (strcmp(s1,s2) == 0))
  79 #define STRNEQN(s1,s2,n)        ((*s1 == *s2) && (strncmp(s1,s2,n) == 0))
  80
  81 /*
  82  *  Configuration file limitations.
  83  */
  84 #define C_MAXFILE       10              /* max number of boot-able files */
  85 #define C_LINELEN       1024            /* max length of line */
  86
  87 /*
  88  *  Direction of packet (used as argument to DispPkt).
  89  */
  90 #define DIR_RCVD        0
  91 #define DIR_SENT        1
  92 #define DIR_NONE        2
  93
  94 /*
  95  *  These need not be functions, so...
  96  */
  97 #define FreeStr(str)    free(str)
  98 #define FreeClient(cli) free(cli)
  99 #define GenSessID()     (++SessionID ? SessionID: ++SessionID)
 100
 101 /*
 102  *  Converting an Ethernet address to a string is done in many routines.
 103  *  Using `rmp.hp_hdr.saddr' works because this field is *never* changed;
 104  *  it will *always* contain the source address of the packet.
 105  */
 106 #define EnetStr(rptr)   GetEtherAddr(&(rptr)->rmp.hp_hdr.saddr[0])
 107
 108 /*
 109  *  Every machine we can boot will have one of these allocated for it
 110  *  (unless there are no restrictions on who we can boot).
 111  */
 112 typedef struct client_s {
 113         u_int8_t                addr[RMP_ADDRLEN];      /* addr of machine */
 114         char                    *files[C_MAXFILE];      /* boot-able files */
 115         struct client_s         *next;                  /* ptr to next */
 116 } CLIENT;
 117
 118 /*
 119  *  Every active connection has one of these allocated for it.
 120  */
 121 typedef struct rmpconn_s {
 122         struct rmp_packet       rmp;                    /* RMP packet */
 123         int                     rmplen;                 /* length of packet */
 124         struct timeval          tstamp;                 /* last time active */
 125         int                     bootfd;                 /* open boot file */
 126         struct rmpconn_s        *next;                  /* ptr to next */
 127 } RMPCONN;
 128
 129 /*
 130  *  All these variables are defined in "conf.c".
 131  */
 132 extern  char    MyHost[];               /* this hosts' name */
 133 extern  pid_t   MyPid;                  /* this processes' ID */
 134 extern  int     DebugFlg;               /* set true if debugging */
 135 extern  int     BootAny;                /* set true if we can boot anyone */
 136
 137 extern  char    *ConfigFile;            /* configuration file */
 138 extern  char    *DfltConfig;            /* default configuration file */
 139 extern  char    *DbgFile;               /* debug output file */
 140 extern  char    *PidFile;               /* file containing pid of server */
 141 extern  char    *BootDir;               /* directory w/boot files */
 142
 143 extern  FILE    *DbgFp;                 /* debug file pointer */
 144 extern  char    *IntfName;              /* interface we are attached to */
 145
 146 extern  u_int16_t SessionID;            /* generated session ID */
 147
 148 extern  char    *BootFiles[];           /* list of boot files */
 149
 150 extern  CLIENT  *Clients;               /* list of addrs we'll accept */
 151 extern  RMPCONN *RmpConns;              /* list of active connections */
 152
 153 extern  u_int8_t RmpMcastAddr[];        /* RMP multicast address */
 154
 155 void     AddConn (RMPCONN *);
 156 int      BootDone (RMPCONN *);
 157 void     BpfClose (void);
 158 char    *BpfGetIntfName (char **);
 159 int      BpfOpen (void);
 160 int      BpfRead (RMPCONN *, int);
 161 int      BpfWrite (RMPCONN *);
 162 void     DebugOff (int);
 163 void     DebugOn (int);
 164 void     DispPkt (RMPCONN *, int);
 165 void     DoTimeout (void);
 166 void     DspFlnm (u_int, char *);
 167 void     Exit (int);
 168 CLIENT  *FindClient (RMPCONN *);
 169 RMPCONN *FindConn (RMPCONN *);
 170 void     FreeClients (void);
 171 void     FreeConn (RMPCONN *);
 172 void     FreeConns (void);
 173 int      GetBootFiles (void);
 174 char    *GetEtherAddr (u_int8_t *);
 175 CLIENT  *NewClient (u_int8_t *);
 176 RMPCONN *NewConn (RMPCONN *);
 177 char    *NewStr (char *);
 178 u_int8_t *ParseAddr (char *);
 179 int      ParseConfig (void);
 180 void     ProcessPacket (RMPCONN *, CLIENT *);
 181 void     ReConfig (int);
 182 void     RemoveConn (RMPCONN *);
 183 int      SendBootRepl (struct rmp_packet *, RMPCONN *, char *[]);
 184 int      SendFileNo (struct rmp_packet *, RMPCONN *, char *[]);
 185 int      SendPacket (RMPCONN *);
 186 int      SendReadRepl (RMPCONN *);
 187 int      SendServerID (RMPCONN *);