contrib/tcpdump/print-wb.c

   1 /*
   2  * Copyright (c) 1993, 1994, 1995, 1996
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that: (1) source code distributions
   7  * retain the above copyright notice and this paragraph in its entirety, (2)
   8  * distributions including binary code include the above copyright notice and
   9  * this paragraph in its entirety in the documentation or other materials
  10  * provided with the distribution, and (3) all advertising materials mentioning
  11  * features or use of this software display the following acknowledgement:
  12  * ``This product includes software developed by the University of California,
  13  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  14  * the University nor the names of its contributors may be used to endorse
  15  * or promote products derived from this software without specific prior
  16  * written permission.
  17  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  18  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  20  */
  21
  22 #define NETDISSECT_REWORKED
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include <tcpdump-stdinc.h>
  28
  29 #include "interface.h"
  30 #include "addrtoname.h"
  31 #include "extract.h"
  32
  33 static const char tstr[] = "[|wb]";
  34
  35 /* XXX need to add byte-swapping macros! */
  36 /* XXX - you mean like the ones in "extract.h"? */
  37
  38 /*
  39  * Largest packet size.  Everything should fit within this space.
  40  * For instance, multiline objects are sent piecewise.
  41  */
  42 #define MAXFRAMESIZE 1024
  43
  44 /*
  45  * Multiple drawing ops can be sent in one packet.  Each one starts on a
  46  * an even multiple of DOP_ALIGN bytes, which must be a power of two.
  47  */
  48 #define DOP_ALIGN 4
  49 #define DOP_ROUNDUP(x)  ((((int)(x)) + (DOP_ALIGN - 1)) & ~(DOP_ALIGN - 1))
  50 #define DOP_NEXT(d)\
  51         ((struct dophdr *)((u_char *)(d) + \
  52                           DOP_ROUNDUP(EXTRACT_16BITS(&(d)->dh_len) + sizeof(*(d)))))
  53
  54 /*
  55  * Format of the whiteboard packet header.
  56  * The transport level header.
  57  */
  58 struct pkt_hdr {
  59         uint32_t ph_src;                /* site id of source */
  60         uint32_t ph_ts;         /* time stamp (for skew computation) */
  61         uint16_t ph_version;    /* version number */
  62         u_char ph_type;         /* message type */
  63         u_char ph_flags;        /* message flags */
  64 };
  65
  66 /* Packet types */
  67 #define PT_DRAWOP       0       /* drawing operation */
  68 #define PT_ID           1       /* announcement packet */
  69 #define PT_RREQ         2       /* repair request */
  70 #define PT_RREP         3       /* repair reply */
  71 #define PT_KILL         4       /* terminate participation */
  72 #define PT_PREQ         5       /* page vector request */
  73 #define PT_PREP         7       /* page vector reply */
  74
  75 #ifdef PF_USER
  76 #undef PF_USER                  /* {Digital,Tru64} UNIX define this, alas */
  77 #endif
  78
  79 /* flags */
  80 #define PF_USER         0x01    /* hint that packet has interactive data */
  81 #define PF_VIS          0x02    /* only visible ops wanted */
  82
  83 struct PageID {
  84         uint32_t p_sid;         /* session id of initiator */
  85         uint32_t p_uid;         /* page number */
  86 };
  87
  88 struct dophdr {
  89         uint32_t  dh_ts;                /* sender's timestamp */
  90         uint16_t        dh_len;         /* body length */
  91         u_char  dh_flags;
  92         u_char  dh_type;        /* body type */
  93         /* body follows */
  94 };
  95 /*
  96  * Drawing op sub-types.
  97  */
  98 #define DT_RECT         2
  99 #define DT_LINE         3
 100 #define DT_ML           4
 101 #define DT_DEL          5
 102 #define DT_XFORM        6
 103 #define DT_ELL          7
 104 #define DT_CHAR         8
 105 #define DT_STR          9
 106 #define DT_NOP          10
 107 #define DT_PSCODE       11
 108 #define DT_PSCOMP       12
 109 #define DT_REF          13
 110 #define DT_SKIP         14
 111 #define DT_HOLE         15
 112 #define DT_MAXTYPE      15
 113
 114 /*
 115  * A drawing operation.
 116  */
 117 struct pkt_dop {
 118         struct PageID pd_page;  /* page that operations apply to */
 119         uint32_t        pd_sseq;        /* start sequence number */
 120         uint32_t        pd_eseq;        /* end sequence number */
 121         /* drawing ops follow */
 122 };
 123
 124 /*
 125  * A repair request.
 126  */
 127 struct pkt_rreq {
 128         uint32_t pr_id;           /* source id of drawops to be repaired */
 129         struct PageID pr_page;           /* page of drawops */
 130         uint32_t pr_sseq;         /* start seqno */
 131         uint32_t pr_eseq;         /* end seqno */
 132 };
 133
 134 /*
 135  * A repair reply.
 136  */
 137 struct pkt_rrep {
 138         uint32_t pr_id; /* original site id of ops  */
 139         struct pkt_dop pr_dop;
 140         /* drawing ops follow */
 141 };
 142
 143 struct id_off {
 144         uint32_t id;
 145         uint32_t off;
 146 };
 147
 148 struct pgstate {
 149         uint32_t slot;
 150         struct PageID page;
 151         uint16_t nid;
 152         uint16_t rsvd;
 153         /* seqptr's */
 154 };
 155
 156 /*
 157  * An announcement packet.
 158  */
 159 struct pkt_id {
 160         uint32_t pi_mslot;
 161         struct PageID    pi_mpage;        /* current page */
 162         struct pgstate pi_ps;
 163         /* seqptr's */
 164         /* null-terminated site name */
 165 };
 166
 167 struct pkt_preq {
 168         struct PageID  pp_page;
 169         uint32_t  pp_low;
 170         uint32_t  pp_high;
 171 };
 172
 173 struct pkt_prep {
 174         uint32_t  pp_n;           /* size of pageid array */
 175         /* pgstate's follow */
 176 };
 177
 178 static int
 179 wb_id(netdissect_options *ndo,
 180       const struct pkt_id *id, u_int len)
 181 {
 182         int i;
 183         const char *cp;
 184         const struct id_off *io;
 185         char c;
 186         int nid;
 187
 188         ND_PRINT((ndo, " wb-id:"));
 189         if (len < sizeof(*id) || (u_char *)(id + 1) > ndo->ndo_snapend)
 190                 return (-1);
 191         len -= sizeof(*id);
 192
 193         ND_PRINT((ndo, " %u/%s:%u (max %u/%s:%u) ",
 194                EXTRACT_32BITS(&id->pi_ps.slot),
 195                ipaddr_string(ndo, &id->pi_ps.page.p_sid),
 196                EXTRACT_32BITS(&id->pi_ps.page.p_uid),
 197                EXTRACT_32BITS(&id->pi_mslot),
 198                ipaddr_string(ndo, &id->pi_mpage.p_sid),
 199                EXTRACT_32BITS(&id->pi_mpage.p_uid)));
 200
 201         nid = EXTRACT_16BITS(&id->pi_ps.nid);
 202         len -= sizeof(*io) * nid;
 203         io = (struct id_off *)(id + 1);
 204         cp = (char *)(io + nid);
 205         if ((u_char *)cp + len <= ndo->ndo_snapend) {
 206                 ND_PRINT((ndo, "\""));
 207                 fn_print(ndo, (u_char *)cp, (u_char *)cp + len);
 208                 ND_PRINT((ndo, "\""));
 209         }
 210
 211         c = '<';
 212         for (i = 0; i < nid && (u_char *)(io + 1) <= ndo->ndo_snapend; ++io, ++i) {
 213                 ND_PRINT((ndo, "%c%s:%u",
 214                     c, ipaddr_string(ndo, &io->id), EXTRACT_32BITS(&io->off)));
 215                 c = ',';
 216         }
 217         if (i >= nid) {
 218                 ND_PRINT((ndo, ">"));
 219                 return (0);
 220         }
 221         return (-1);
 222 }
 223
 224 static int
 225 wb_rreq(netdissect_options *ndo,
 226         const struct pkt_rreq *rreq, u_int len)
 227 {
 228         ND_PRINT((ndo, " wb-rreq:"));
 229         if (len < sizeof(*rreq) || (u_char *)(rreq + 1) > ndo->ndo_snapend)
 230                 return (-1);
 231
 232         ND_PRINT((ndo, " please repair %s %s:%u<%u:%u>",
 233                ipaddr_string(ndo, &rreq->pr_id),
 234                ipaddr_string(ndo, &rreq->pr_page.p_sid),
 235                EXTRACT_32BITS(&rreq->pr_page.p_uid),
 236                EXTRACT_32BITS(&rreq->pr_sseq),
 237                EXTRACT_32BITS(&rreq->pr_eseq)));
 238         return (0);
 239 }
 240
 241 static int
 242 wb_preq(netdissect_options *ndo,
 243         const struct pkt_preq *preq, u_int len)
 244 {
 245         ND_PRINT((ndo, " wb-preq:"));
 246         if (len < sizeof(*preq) || (u_char *)(preq + 1) > ndo->ndo_snapend)
 247                 return (-1);
 248
 249         ND_PRINT((ndo, " need %u/%s:%u",
 250                EXTRACT_32BITS(&preq->pp_low),
 251                ipaddr_string(ndo, &preq->pp_page.p_sid),
 252                EXTRACT_32BITS(&preq->pp_page.p_uid)));
 253         return (0);
 254 }
 255
 256 static int
 257 wb_prep(netdissect_options *ndo,
 258         const struct pkt_prep *prep, u_int len)
 259 {
 260         int n;
 261         const struct pgstate *ps;
 262         const u_char *ep = ndo->ndo_snapend;
 263
 264         ND_PRINT((ndo, " wb-prep:"));
 265         if (len < sizeof(*prep)) {
 266                 return (-1);
 267         }
 268         n = EXTRACT_32BITS(&prep->pp_n);
 269         ps = (const struct pgstate *)(prep + 1);
 270         while (--n >= 0 && (u_char *)(ps + 1) <= ep) {
 271                 const struct id_off *io, *ie;
 272                 char c = '<';
 273
 274                 ND_PRINT((ndo, " %u/%s:%u",
 275                     EXTRACT_32BITS(&ps->slot),
 276                     ipaddr_string(ndo, &ps->page.p_sid),
 277                     EXTRACT_32BITS(&ps->page.p_uid)));
 278                 io = (struct id_off *)(ps + 1);
 279                 for (ie = io + ps->nid; io < ie && (u_char *)(io + 1) <= ep; ++io) {
 280                         ND_PRINT((ndo, "%c%s:%u", c, ipaddr_string(ndo, &io->id),
 281                             EXTRACT_32BITS(&io->off)));
 282                         c = ',';
 283                 }
 284                 ND_PRINT((ndo, ">"));
 285                 ps = (struct pgstate *)io;
 286         }
 287         return ((u_char *)ps <= ep? 0 : -1);
 288 }
 289
 290
 291 static const char *dopstr[] = {
 292         "dop-0!",
 293         "dop-1!",
 294         "RECT",
 295         "LINE",
 296         "ML",
 297         "DEL",
 298         "XFORM",
 299         "ELL",
 300         "CHAR",
 301         "STR",
 302         "NOP",
 303         "PSCODE",
 304         "PSCOMP",
 305         "REF",
 306         "SKIP",
 307         "HOLE",
 308 };
 309
 310 static int
 311 wb_dops(netdissect_options *ndo,
 312         const struct dophdr *dh, uint32_t ss, uint32_t es)
 313 {
 314         ND_PRINT((ndo, " <"));
 315         for ( ; ss <= es; ++ss) {
 316                 register int t = dh->dh_type;
 317
 318                 if (t > DT_MAXTYPE)
 319                         ND_PRINT((ndo, " dop-%d!", t));
 320                 else {
 321                         ND_PRINT((ndo, " %s", dopstr[t]));
 322                         if (t == DT_SKIP || t == DT_HOLE) {
 323                                 uint32_t ts = EXTRACT_32BITS(&dh->dh_ts);
 324                                 ND_PRINT((ndo, "%d", ts - ss + 1));
 325                                 if (ss > ts || ts > es) {
 326                                         ND_PRINT((ndo, "[|]"));
 327                                         if (ts < ss)
 328                                                 return (0);
 329                                 }
 330                                 ss = ts;
 331                         }
 332                 }
 333                 dh = DOP_NEXT(dh);
 334                 if ((u_char *)dh > ndo->ndo_snapend) {
 335                         ND_PRINT((ndo, "%s", tstr));
 336                         break;
 337                 }
 338         }
 339         ND_PRINT((ndo, " >"));
 340         return (0);
 341 }
 342
 343 static int
 344 wb_rrep(netdissect_options *ndo,
 345         const struct pkt_rrep *rrep, u_int len)
 346 {
 347         const struct pkt_dop *dop = &rrep->pr_dop;
 348
 349         ND_PRINT((ndo, " wb-rrep:"));
 350         if (len < sizeof(*rrep) || (u_char *)(rrep + 1) > ndo->ndo_snapend)
 351                 return (-1);
 352         len -= sizeof(*rrep);
 353
 354         ND_PRINT((ndo, " for %s %s:%u<%u:%u>",
 355             ipaddr_string(ndo, &rrep->pr_id),
 356             ipaddr_string(ndo, &dop->pd_page.p_sid),
 357             EXTRACT_32BITS(&dop->pd_page.p_uid),
 358             EXTRACT_32BITS(&dop->pd_sseq),
 359             EXTRACT_32BITS(&dop->pd_eseq)));
 360
 361         if (ndo->ndo_vflag)
 362                 return (wb_dops(ndo, (const struct dophdr *)(dop + 1),
 363                     EXTRACT_32BITS(&dop->pd_sseq),
 364                     EXTRACT_32BITS(&dop->pd_eseq)));
 365         return (0);
 366 }
 367
 368 static int
 369 wb_drawop(netdissect_options *ndo,
 370           const struct pkt_dop *dop, u_int len)
 371 {
 372         ND_PRINT((ndo, " wb-dop:"));
 373         if (len < sizeof(*dop) || (u_char *)(dop + 1) > ndo->ndo_snapend)
 374                 return (-1);
 375         len -= sizeof(*dop);
 376
 377         ND_PRINT((ndo, " %s:%u<%u:%u>",
 378             ipaddr_string(ndo, &dop->pd_page.p_sid),
 379             EXTRACT_32BITS(&dop->pd_page.p_uid),
 380             EXTRACT_32BITS(&dop->pd_sseq),
 381             EXTRACT_32BITS(&dop->pd_eseq)));
 382
 383         if (ndo->ndo_vflag)
 384                 return (wb_dops(ndo, (const struct dophdr *)(dop + 1),
 385                                 EXTRACT_32BITS(&dop->pd_sseq),
 386                                 EXTRACT_32BITS(&dop->pd_eseq)));
 387         return (0);
 388 }
 389
 390 /*
 391  * Print whiteboard multicast packets.
 392  */
 393 void
 394 wb_print(netdissect_options *ndo,
 395          register const void *hdr, register u_int len)
 396 {
 397         register const struct pkt_hdr *ph;
 398
 399         ph = (const struct pkt_hdr *)hdr;
 400         if (len < sizeof(*ph) || (u_char *)(ph + 1) > ndo->ndo_snapend) {
 401                 ND_PRINT((ndo, "%s", tstr));
 402                 return;
 403         }
 404         len -= sizeof(*ph);
 405
 406         if (ph->ph_flags)
 407                 ND_PRINT((ndo, "*"));
 408         switch (ph->ph_type) {
 409
 410         case PT_KILL:
 411                 ND_PRINT((ndo, " wb-kill"));
 412                 return;
 413
 414         case PT_ID:
 415                 if (wb_id(ndo, (struct pkt_id *)(ph + 1), len) >= 0)
 416                         return;
 417                 break;
 418
 419         case PT_RREQ:
 420                 if (wb_rreq(ndo, (struct pkt_rreq *)(ph + 1), len) >= 0)
 421                         return;
 422                 break;
 423
 424         case PT_RREP:
 425                 if (wb_rrep(ndo, (struct pkt_rrep *)(ph + 1), len) >= 0)
 426                         return;
 427                 break;
 428
 429         case PT_DRAWOP:
 430                 if (wb_drawop(ndo, (struct pkt_dop *)(ph + 1), len) >= 0)
 431                         return;
 432                 break;
 433
 434         case PT_PREQ:
 435                 if (wb_preq(ndo, (struct pkt_preq *)(ph + 1), len) >= 0)
 436                         return;
 437                 break;
 438
 439         case PT_PREP:
 440                 if (wb_prep(ndo, (struct pkt_prep *)(ph + 1), len) >= 0)
 441                         return;
 442                 break;
 443
 444         default:
 445                 ND_PRINT((ndo, " wb-%d!", ph->ph_type));
 446                 return;
 447         }
 448 }