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