libexec/rbootd/rmp_var.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. 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: @(#)rmp_var.h     8.1 (Berkeley) 6/4/93
  38  *
  39  * from: Utah Hdr: rmp_var.h 3.1 92/07/06
  40  * Author: Jeff Forys, University of Utah CSS
  41  */
  42
  43 /*
  44  *  Possible values for "rmp_type" fields.
  45  */
  46
  47 #define RMP_BOOT_REQ    1       /* boot request packet */
  48 #define RMP_BOOT_REPL   129     /* boot reply packet */
  49 #define RMP_READ_REQ    2       /* read request packet */
  50 #define RMP_READ_REPL   130     /* read reply packet */
  51 #define RMP_BOOT_DONE   3       /* boot complete packet */
  52
  53 /*
  54  *  Useful constants.
  55  */
  56
  57 #define RMP_VERSION     2       /* protocol version */
  58 #define RMP_TIMEOUT     600     /* timeout connection after ten minutes */
  59 #define RMP_PROBESID    0xffff  /* session ID for probes */
  60 #define RMP_HOSTLEN     13      /* max length of server's name */
  61 #define RMP_MACHLEN     20      /* length of machine type field */
  62
  63 /*
  64  *  RMP error codes
  65  */
  66
  67 #define RMP_E_OKAY      0
  68 #define RMP_E_EOF       2       /* read reply: returned end of file */
  69 #define RMP_E_ABORT     3       /* abort operation */
  70 #define RMP_E_BUSY      4       /* boot reply: server busy */
  71 #define RMP_E_TIMEOUT   5       /* lengthen time out (not implemented) */
  72 #define RMP_E_NOFILE    16      /* boot reply: file does not exist */
  73 #define RMP_E_OPENFILE  17      /* boot reply: file open failed */
  74 #define RMP_E_NODFLT    18      /* boot reply: default file does not exist */
  75 #define RMP_E_OPENDFLT  19      /* boot reply: default file open failed */
  76 #define RMP_E_BADSID    25      /* read reply: bad session ID */
  77 #define RMP_E_BADPACKET 27      /* Bad packet detected */
  78
  79 /*
  80  *  RMPDATALEN is the maximum number of data octets that can be stuffed
  81  *  into an RMP packet.  This excludes the 802.2 LLC w/HP extensions.
  82  */
  83 #define RMPDATALEN      (RMP_MAX_PACKET - (sizeof(struct hp_hdr) + \
  84                                            sizeof(struct hp_llc)))
  85
  86 /*
  87  *  Define sizes of packets we send.  Boot and Read replies are variable
  88  *  in length depending on the length of `s'.
  89  *
  90  *  Also, define how much space `restofpkt' can take up for outgoing
  91  *  Boot and Read replies.  Boot Request packets are effectively
  92  *  limited to 255 bytes due to the preceding 1-byte length field.
  93  */
  94
  95 #define RMPBOOTSIZE(s)  (sizeof(struct hp_hdr) + sizeof(struct hp_llc) + \
  96                          sizeof(struct rmp_boot_repl) + s - sizeof(restofpkt))
  97 #define RMPREADSIZE(s)  (sizeof(struct hp_hdr) + sizeof(struct hp_llc) + \
  98                          sizeof(struct rmp_read_repl) + s - sizeof(restofpkt) \
  99                          - sizeof(u_int8_t))
 100 #define RMPDONESIZE     (sizeof(struct hp_hdr) + sizeof(struct hp_llc) + \
 101                          sizeof(struct rmp_boot_done))
 102 #define RMPBOOTDATA     255
 103 #define RMPREADDATA     (RMPDATALEN - \
 104                          (2*sizeof(u_int8_t)+sizeof(u_int16_t)+sizeof(u_word)))
 105
 106 /*
 107  * This protocol defines some field sizes as "rest of ethernet packet".
 108  * There is no easy way to specify this in C, so we use a one character
 109  * field to denote it, and index past it to the end of the packet.
 110  */
 111
 112 typedef char    restofpkt;
 113
 114 /*
 115  * Due to the RMP packet layout, we'll run into alignment problems
 116  * on machines that can't access (or don't, by default, align) words
 117  * on half-word boundaries.
 118  *
 119  * The following macros are used to deal with this problem:
 120  *      WORDZE(w)       Return True if u_word `w' is zero, False otherwise.
 121  *      ZEROWORD(w)     Set u_word `w' to zero.
 122  *      COPYWORD(w1,w2) Copy u_word `w1' to `w2'.
 123  *      GETWORD(w,i)    Copy u_word `w' into int `i'.
 124  *      PUTWORD(i,w)    Copy int `i' into u_word `w'.
 125  *
 126  * N.B. Endianness is handled by use of ntohl/htonl
 127  */
 128
 129 #define _WORD_HIGHPART  0
 130 #define _WORD_LOWPART   1
 131
 132 typedef struct _uword { u_int16_t val[2]; }     u_word;
 133
 134 #define WORDZE(w) \
 135         ((w.val[_WORD_HIGHPART] == 0) && (w.val[_WORD_LOWPART] == 0))
 136 #define ZEROWORD(w) \
 137         (w).val[_WORD_HIGHPART] = (w).val[_WORD_LOWPART] = 0
 138 #define COPYWORD(w1, w2) \
 139         { (w2).val[_WORD_HIGHPART] = (w1).val[_WORD_HIGHPART]; \
 140           (w2).val[_WORD_LOWPART] = (w1).val[_WORD_LOWPART]; \
 141         }
 142 #define GETWORD(w, i) \
 143         (i) = (((u_int32_t)ntohs((w).val[_WORD_HIGHPART])) << 16) | ntohs((w).val[_WORD_LOWPART])
 144 #define PUTWORD(i, w) \
 145         { (w).val[_WORD_HIGHPART] = htons((u_int16_t) ((i >> 16) & 0xffff)); \
 146           (w).val[_WORD_LOWPART] = htons((u_int16_t) (i & 0xffff)); \
 147         }
 148
 149 /*
 150  * Packet structures.
 151  */
 152
 153 struct rmp_raw {                /* generic RMP packet */
 154         u_int8_t  rmp_type;             /* packet type */
 155         u_int8_t  rmp_rawdata[RMPDATALEN-1];
 156 };
 157
 158 struct rmp_boot_req {           /* boot request */
 159         u_int8_t  rmp_type;             /* packet type (RMP_BOOT_REQ) */
 160         u_int8_t  rmp_retcode;          /* return code (0) */
 161         u_word    rmp_seqno;            /* sequence number (real time clock) */
 162         u_int16_t rmp_session;          /* session id (normally 0) */
 163         u_int16_t rmp_version;          /* protocol version (RMP_VERSION) */
 164         char      rmp_machtype[RMP_MACHLEN];    /* machine type */
 165         u_int8_t  rmp_flnmsize;         /* length of rmp_flnm */
 166         restofpkt rmp_flnm;             /* name of file to be read */
 167 };
 168
 169 struct rmp_boot_repl {          /* boot reply */
 170         u_int8_t  rmp_type;             /* packet type (RMP_BOOT_REPL) */
 171         u_int8_t  rmp_retcode;          /* return code (normally 0) */
 172         u_word    rmp_seqno;            /* sequence number (from boot req) */
 173         u_int16_t rmp_session;          /* session id (generated) */
 174         u_int16_t rmp_version;          /* protocol version (RMP_VERSION) */
 175         u_int8_t  rmp_flnmsize;         /* length of rmp_flnm */
 176         restofpkt rmp_flnm;             /* name of file (from boot req) */
 177 };
 178
 179 struct rmp_read_req {           /* read request */
 180         u_int8_t  rmp_type;             /* packet type (RMP_READ_REQ) */
 181         u_int8_t  rmp_retcode;          /* return code (0) */
 182         u_word    rmp_offset;           /* file relative byte offset */
 183         u_int16_t rmp_session;          /* session id (from boot repl) */
 184         u_int16_t rmp_size;             /* max no of bytes to send */
 185 };
 186
 187 struct rmp_read_repl {          /* read reply */
 188         u_int8_t  rmp_type;             /* packet type (RMP_READ_REPL) */
 189         u_int8_t  rmp_retcode;          /* return code (normally 0) */
 190         u_word    rmp_offset;           /* byte offset (from read req) */
 191         u_int16_t rmp_session;          /* session id (from read req) */
 192         restofpkt rmp_data;             /* data (max size from read req) */
 193         u_int8_t  rmp_unused;           /* padding to 16-bit boundary */
 194 };
 195
 196 struct rmp_boot_done {          /* boot complete */
 197         u_int8_t  rmp_type;             /* packet type (RMP_BOOT_DONE) */
 198         u_int8_t  rmp_retcode;          /* return code (0) */
 199         u_word    rmp_unused;           /* not used (0) */
 200         u_int16_t rmp_session;          /* session id (from read repl) */
 201 };
 202
 203 struct rmp_packet {
 204         struct hp_hdr hp_hdr;
 205         struct hp_llc hp_llc;
 206         union {
 207                 struct rmp_boot_req     rmp_brq;        /* boot request */
 208                 struct rmp_boot_repl    rmp_brpl;       /* boot reply */
 209                 struct rmp_read_req     rmp_rrq;        /* read request */
 210                 struct rmp_read_repl    rmp_rrpl;       /* read reply */
 211                 struct rmp_boot_done    rmp_done;       /* boot complete */
 212                 struct rmp_raw          rmp_raw;        /* raw data */
 213         } rmp_proto;
 214 };
 215
 216 /*
 217  *  Make life easier...
 218  */
 219
 220 #define r_type  rmp_proto.rmp_raw.rmp_type
 221 #define r_data  rmp_proto.rmp_raw.rmp_rawdata
 222 #define r_brq   rmp_proto.rmp_brq
 223 #define r_brpl  rmp_proto.rmp_brpl
 224 #define r_rrq   rmp_proto.rmp_rrq
 225 #define r_rrpl  rmp_proto.rmp_rrpl
 226 #define r_done  rmp_proto.rmp_done