wiretap/netscaler.c

   1 /* netscaler.c
   2  *
   3  * $Id$
   4  *
   5  * Wiretap Library
   6  * Copyright (c) 2006 by Ravi Kondamuru <Ravi.Kondamuru@citrix.com>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26 #include <errno.h>
  27 #include <string.h>
  28 #include "wtap-int.h"
  29 #include "file_wrappers.h"
  30 #include "buffer.h"
  31 #include "netscaler.h"
  32
  33 /* Defines imported from netscaler code: nstypes.h */
  34
  35 #define ns_min(a, b)    ((a<b)?a:b)
  36
  37 /* Defines imported from netscaler code: nsperfrc.h */
  38
  39 #define NSPR_SIGSTR_V10 "NetScaler Performance Data"
  40 #define NSPR_SIGSTR_V20 "NetScaler V20 Performance Data"
  41 #define NSPR_SIGSTR     NSPR_SIGSTR_V20
  42 /* Defined but not used */
  43 #define NSPR_SIGSTR_V21 "NetScaler V21 Performance Data"
  44 #define NSPR_SIGSTR_V22 "NetScaler V22 Performance Data"
  45
  46 #define NSPR_PAGESIZE   8192
  47
  48 /* The different record types
  49 ** NOTE: The Record Type is two byte fields and unused space is recognized by
  50 ** either bytes being zero, therefore no record should any byte value as
  51 ** zero.
  52 **
  53 ** New Performance Record Type is only one byte.
  54 */
  55 #define NSPR_UNUSEDSPACE_V10    0x0000  /* rest of the page is unused */
  56 #define NSPR_UNUSEDSPACE_V20    0x00    /* rest of the page is unused */
  57 #define NSPR_SIGNATURE_V10      0x0101  /* signature */
  58 #define NSPR_SIGNATURE_V20      0x01    /* signature */
  59 #define NSPR_ABSTIME_V10        0x0107  /* data capture time in secs from 1970*/
  60 #define NSPR_ABSTIME_V20        0x07    /* data capture time in secs from 1970*/
  61 #define NSPR_RELTIME_V10        0x0108  /* relative time in ms from last time */
  62 #define NSPR_RELTIME_V20        0x08    /* relative time in ms from last time */
  63 #define NSPR_RELTIMEHR_V10      0x0109  /* high resolution relative time */
  64 #define NSPR_RELTIMEHR_V20      0x09    /* high resolution relative time */
  65 #define NSPR_SYSTARTIME_V10     0x010A  /* system start time */
  66 #define NSPR_SYSTARTIME_V20     0x0A    /* system start time */
  67 #define NSPR_RELTIME2B_V10      0x010B  /* relative time in ms from last time */
  68 #define NSPR_RELTIME2B_V20      0x0B    /* relative time in ms from last time */
  69
  70
  71 /* The high resolution relative time format.
  72 ** The MS 2 bits of the high resoltion time is defined as follows:
  73 ** 00 : time value is in second
  74 ** 01 : time value is in mili second
  75 ** 10 : time value is in micro second
  76 ** 11 : time value is in nano second
  77 */
  78 #define NSPR_HRTIME_MASKTM      0x3FFFFFFF /* mask to get time value */
  79 #define NSPR_HRTIME_MASKFMT     0xC0000000 /* time value format mask */
  80 #define NSPR_HRTIME_SEC         0x00000000 /* time value in second */
  81 #define NSPR_HRTIME_MSEC        0x40000000 /* time value in mili second */
  82 #define NSPR_HRTIME_USEC        0x80000000 /* time value in micro second */
  83 #define NSPR_HRTIME_NSEC        0xC0000000 /* time value in nano second */
  84
  85
  86 typedef  struct nspr_header_v10
  87 {
  88         guint16 ph_RecordType;  /* Record Type */
  89         guint16 ph_RecordSize;  /* Record Size including header */
  90 } nspr_header_v10_t;
  91 #define nspr_header_v10_s       sizeof(nspr_header_v10_t)
  92
  93 /* This is V20 short header (2 bytes long) to be included where needed */
  94 #define NSPR_HEADER_V20(prefix) \
  95     guint8 prefix##_RecordType;    /* Record Type */ \
  96         guint8 prefix##_RecordSize     /* Record Size including header */       \
  97                                         /* end of declaration */
  98
  99 /* This is new long header (3 bytes long) to be included where needed */
 100 #define NSPR_HEADER3B_V20(prefix) \
 101         guint8  prefix##_RecordType;    /* Record Type */ \
 102         guint8  prefix##_RecordSizeLow; /* Record Size including header */ \
 103         guint8  prefix##_RecordSizeHigh /* Record Size including header */ \
 104                                         /* end of declaration */
 105 #define NSPR_HEADER3B_V21 NSPR_HEADER3B_V20
 106 #define NSPR_HEADER3B_V22 NSPR_HEADER3B_V20
 107
 108 typedef  struct nspr_hd_v20
 109 {
 110         NSPR_HEADER3B_V20(phd);         /* long performance header */
 111
 112 } nspr_hd_v20_t;
 113 #define nspr_hd_v20_s   sizeof(nspr_hd_v20_t)
 114
 115
 116 /*
 117 ** How to know if header size is short or long?
 118 ** The short header size can be 0-127 bytes long. If MS Bit of ph_RecordSize
 119 ** is set then record size has 2 bytes
 120 */
 121 #define NSPR_V20RECORDSIZE_2BYTES       0x80
 122
 123 /* Performance Data Header with device number */
 124 typedef  struct nspr_headerdev_v10
 125 {
 126         guint16 ph_RecordType;  /* Record Type */
 127         guint16 ph_RecordSize;  /* Record Size including header */
 128         guint32 ph_DevNo;       /* Network Device (NIC/CONN) number */
 129 } nspr_headerdev_v10_t;
 130 #define nspr_headerdev_v10_s    sizeof(nspr_headerdev_v10_t)
 131
 132 typedef struct nspr_hd_v10
 133 {
 134         nspr_header_v10_t phd;  /* performance header */
 135 } nspr_hd_v10_t;
 136 #define nspr_hd_v10_s   sizeof(nspr_hd_v10_t)
 137
 138 typedef struct nspr_hdev_v10
 139 {
 140         nspr_headerdev_v10_t phd;       /* performance header */
 141 } nspr_hdev_v10_t;
 142 #define nspr_hdev_v10_s sizeof(nspr_hdev_v10_t)
 143
 144 /* if structure has defined phd as first field, it can use following names */
 145 #define nsprRecordType          phd.ph_RecordType
 146 #define nsprRecordSize          phd.ph_RecordSize
 147 #define nsprReserved            phd.ph_Reserved
 148 #define nsprRecordTypeOrg       phd.ph_Reserved
 149 #define nsprDevNo               phd.ph_DevNo
 150
 151 /* NSPR_SIGNATURE_V10 structure */
 152 #define NSPR_SIGSIZE_V10        56      /* signature value size in bytes */
 153
 154
 155 typedef struct nspr_signature_v10
 156 {
 157         nspr_header_v10_t phd;  /* performance header */
 158         guint8  sig_EndianType; /* Endian Type for the data */
 159         guint8  sig_Reserved0;
 160         guint16 sig_Reserved1;
 161         gchar   sig_Signature[NSPR_SIGSIZE_V10];        /* Signature value */
 162 } nspr_signature_v10_t;
 163 #define nspr_signature_v10_s    sizeof(nspr_signature_v10_t)
 164
 165 /* NSPR_SIGNATURE_V20 structure */
 166 typedef struct nspr_signature_v20
 167 {
 168         NSPR_HEADER_V20(sig);   /* short performance header */
 169         guint8  sig_EndianType; /* Endian Type for the data */
 170         gchar   sig_Signature[1]; /* Signature value */
 171 } nspr_signature_v20_t;
 172 #define nspr_signature_v20_s    (sizeof(nspr_signature_v20_t) -1)
 173
 174 /* NSPR_ABSTIME_V10 and NSPR_SYSTARTIME_V10 structure */
 175 typedef struct nspr_abstime_v10
 176 {
 177         nspr_header_v10_t phd;  /* performance header */
 178         guint32 abs_RelTime;    /* relative time is ms from last time */
 179         guint32 abs_Time;       /* absolute time in seconds from 1970 */
 180 } nspr_abstime_v10_t;
 181 #define nspr_abstime_v10_s      sizeof(nspr_abstime_v10_t)
 182
 183
 184 /* NSPR_ABSTIME_V20 and NSPR_SYSTARTIME_V20 structure */
 185 typedef struct nspr_abstime_v20
 186 {
 187         NSPR_HEADER_V20(abs);   /* short performance header */
 188         guint16 abs_RelTime;    /* relative time is ms from last time */
 189         guint32 abs_Time;       /* absolute time in seconds from 1970 */
 190 } nspr_abstime_v20_t;
 191 #define nspr_abstime_v20_s      sizeof(nspr_abstime_v20_t)
 192
 193
 194
 195 /* full packet trace structure */
 196 typedef struct  nspr_pktracefull_v10
 197 {
 198         nspr_headerdev_v10_t phd;       /* performance header */
 199         guint32 fp_RelTimeHr;   /* High resolution relative time */
 200         guint8  fp_Data[1];     /* packet data starts here */
 201 } nspr_pktracefull_v10_t;
 202 #define nspr_pktracefull_v10_s  (nspr_hdev_v10_s + 4)
 203
 204 /* new full packet trace structure v20 */
 205 typedef struct  nspr_pktracefull_v20
 206 {
 207         NSPR_HEADER3B_V20(fp);  /* long performance header */
 208         guint8  fp_DevNo;       /* Network Device (NIC) number */
 209         guint32 fp_RelTimeHr;   /* High resolution relative time */
 210         guint8  fp_Data[4];     /* packet data starts here */
 211 } nspr_pktracefull_v20_t;
 212 #define nspr_pktracefull_v20_s  (sizeof(nspr_pktracefull_v20_t) - 4)
 213
 214 /* new full packet trace structure v21 */
 215 typedef struct  nspr_pktracefull_v21
 216 {
 217         NSPR_HEADER3B_V21(fp);  /* long performance header */
 218         guint8  fp_DevNo;       /* Network Device (NIC) number */
 219         guint32 fp_RelTimeHr;   /* High resolution relative time */
 220         guint32 fp_PcbDevNo;    /* PCB devno */
 221         guint32 fp_lPcbDevNo;   /* link PCB devno */
 222         guint8  fp_Data[4];     /* packet data starts here */
 223 } nspr_pktracefull_v21_t;
 224 #define nspr_pktracefull_v21_s  (sizeof(nspr_pktracefull_v21_t) - 4)
 225
 226 /* new full packet trace structure v22 */
 227 typedef struct  nspr_pktracefull_v22
 228 {
 229         NSPR_HEADER3B_V22(fp);  /* long performance header */
 230         guint8  fp_DevNo;       /* Network Device (NIC) number */
 231         guint32 fp_RelTimeHr;   /* High resolution relative time */
 232         guint32 fp_PcbDevNo;    /* PCB devno */
 233         guint32 fp_lPcbDevNo;   /* link PCB devno */
 234         guint16 fp_VlanTag;
 235         guint8  fp_Data[4];     /* packet data starts here */
 236 } nspr_pktracefull_v22_t;
 237 #define nspr_pktracefull_v22_s  (sizeof(nspr_pktracefull_v22_t) - 4)
 238
 239 typedef struct  nspr_pktracefull_v23
 240 {
 241         NSPR_HEADER3B_V22(fp);  /* long performance header */
 242         guint8  fp_DevNo;       /* Network Device (NIC) number */
 243         guint32 fp_AbsTimeLowHdr;       /* High resolution low time */
 244         guint32 fp_AbsTimeHighHdr; /* Higher value of the absolute time */
 245         guint32 fp_PcbDevNo;    /* PCB devno */
 246         guint32 fp_lPcbDevNo;   /* link PCB devno */
 247         guint16 fp_VlanTag; /* vlan tag */
 248         guint16 fp_Coreid; /* coreid of the packet */
 249         guint8  fp_Data[4];     /* packet data starts here */
 250 } nspr_pktracefull_v23_t;
 251 #define nspr_pktracefull_v23_s  (sizeof(nspr_pktracefull_v23_t) - 4)
 252
 253 /* partial packet trace structure */
 254 typedef struct  nspr_pktracepart_v10
 255 {
 256         nspr_headerdev_v10_t phd;       /* performance header */
 257         guint32 pp_RelTimeHr;   /* High resolution relative time */
 258         guint16 pp_PktSizeOrg;  /* Original packet size */
 259         guint16 pp_PktOffset;   /* starting offset in packet */
 260         guint8  pp_Data[1];     /* packet data starts here */
 261 } nspr_pktracepart_v10_t;
 262 #define nspr_pktracepart_v10_s  (nspr_pktracefull_v10_s + 4)
 263
 264 /* new partial packet trace structure */
 265 typedef struct  nspr_pktracepart_v20
 266 {
 267         NSPR_HEADER3B_V20(pp);  /* long performance header */
 268         guint8  pp_DevNo;       /* Network Device (NIC) number */
 269         guint32 pp_RelTimeHr;   /* High resolution relative time */
 270         guint16 pp_PktSizeOrg;  /* Original packet size */
 271         guint16 pp_PktOffset;   /* starting offset in packet */
 272         guint8  pp_Data[4];     /* packet data starts here */
 273 } nspr_pktracepart_v20_t;
 274 #define nspr_pktracepart_v20_s  (sizeof(nspr_pktracepart_v20_t) -4)
 275
 276 /* new partial packet trace structure */
 277 typedef struct  nspr_pktracepart_v21
 278 {
 279         NSPR_HEADER3B_V21(pp);  /* long performance header */
 280         guint8  pp_DevNo;       /* Network Device (NIC) number */
 281         guint32 pp_RelTimeHr;   /* High resolution relative time */
 282         guint16 pp_PktSizeOrg;  /* Original packet size */
 283         guint16 pp_PktOffset;   /* starting offset in packet */
 284         guint32 pp_PcbDevNo;    /* PCB devno */
 285         guint32 pp_lPcbDevNo;   /* link PCB devno */
 286         guint8  pp_Data[4];     /* packet data starts here */
 287 } nspr_pktracepart_v21_t;
 288 #define nspr_pktracepart_v21_s  (sizeof(nspr_pktracepart_v21_t) -4)
 289
 290 /* new partial packet trace structure v22 */
 291 typedef struct  nspr_pktracepart_v22
 292 {
 293         NSPR_HEADER3B_V22(pp);  /* long performance header */
 294         guint8  pp_DevNo;       /* Network Device (NIC) number */
 295         guint32 pp_RelTimeHr;   /* High resolution relative time */
 296         guint16 pp_PktSizeOrg;  /* Original packet size */
 297         guint16 pp_PktOffset;   /* starting offset in packet */
 298         guint32 pp_PcbDevNo;    /* PCB devno */
 299         guint32 pp_lPcbDevNo;   /* link PCB devno */
 300         guint16 pp_VlanTag;     /* Vlan Tag */
 301         guint8  pp_Data[4];     /* packet data starts here */
 302 } nspr_pktracepart_v22_t;
 303 #define nspr_pktracepart_v22_s  (sizeof(nspr_pktracepart_v22_t) -4)
 304
 305 typedef struct  nspr_pktracepart_v23
 306 {
 307         NSPR_HEADER3B_V22(pp);  /* long performance header */
 308         guint8  pp_DevNo;       /* Network Device (NIC) number */
 309         guint32 pp_AbsTimeLowHdr;       /* High resolution low time */
 310         guint32 pp_AbsTimeHighHdr; /* Higher value of the absolute time */
 311         guint16 pp_PktSizeOrg;  /* Original packet size */
 312         guint16 pp_PktOffset;   /* starting offset in packet */
 313         guint32 pp_PcbDevNo;    /* PCB devno */
 314         guint32 pp_lPcbDevNo;   /* link PCB devno */
 315         guint16 pp_VlanTag;     /* vlan tag */
 316         guint16 pp_Coreid; /* Coreid of the packet */
 317         guint8  pp_Data[4];     /* packet data starts here */
 318 } nspr_pktracepart_v23_t;
 319 #define nspr_pktracepart_v23_s  (sizeof(nspr_pktracepart_v23_t) -4)
 320
 321 #define myoffsetof(type,fieldname) (&(((type*)0)->fieldname))
 322
 323 #define __TNO(enumprefix,structprefix,structname,hdrname,structfieldname) \
 324         guint8 enumprefix##_##hdrname##_offset = (guint8)GPOINTER_TO_INT(myoffsetof(nspr_##structname##_t,structprefix##_##structfieldname));
 325
 326 #define __TNL(enumprefix,structprefix,structname,hdrname,structfieldname) \
 327         guint8 enumprefix##_##hdrname##_len = (guint8)sizeof(((nspr_##structname##_t*)0)->structprefix##_##structfieldname);
 328
 329 #define __TNV1O(enumprefix,structprefix,structname,hdrname,structfieldname) \
 330         guint8 enumprefix##_##hdrname##_offset = (guint8)GPOINTER_TO_INT(myoffsetof(nspr_##structname##_t,structfieldname));
 331
 332 #define __TNV1L(enumprefix,structprefix,structname,hdrname,structfieldname) \
 333         guint8 enumprefix##_##hdrname##_len = (guint8)sizeof(((nspr_##structname##_t*)0)->structfieldname);
 334
 335 #define TRACE_V10_REC_LEN_OFF(enumprefix,structprefix,structname) \
 336                 __TNV1O(enumprefix,structprefix,structname,dir,phd.ph_RecordType)\
 337                 __TNV1L(enumprefix,structprefix,structname,dir,phd.ph_RecordType)\
 338                 __TNV1O(enumprefix,structprefix,structname,nicno,phd.ph_DevNo)\
 339                 __TNV1L(enumprefix,structprefix,structname,nicno,phd.ph_DevNo)\
 340                 __TNO(enumprefix,structprefix,structname,eth,Data)
 341
 342 #define TRACE_V20_REC_LEN_OFF(enumprefix,structprefix,structname) \
 343                 __TNO(enumprefix,structprefix,structname,dir,RecordType)\
 344                 __TNL(enumprefix,structprefix,structname,dir,RecordType)\
 345                 __TNO(enumprefix,structprefix,structname,nicno,DevNo)\
 346                 __TNL(enumprefix,structprefix,structname,nicno,DevNo)\
 347                 __TNO(enumprefix,structprefix,structname,eth,Data)
 348
 349 #define TRACE_V21_REC_LEN_OFF(enumprefix,structprefix,structname) \
 350                 TRACE_V20_REC_LEN_OFF(enumprefix,structprefix,structname)\
 351                 __TNO(enumprefix,structprefix,structname,pcb,PcbDevNo)\
 352                 __TNO(enumprefix,structprefix,structname,l_pcb,lPcbDevNo)
 353
 354 #define TRACE_V22_REC_LEN_OFF(enumprefix,structprefix,structname) \
 355                 TRACE_V21_REC_LEN_OFF(enumprefix,structprefix,structname)\
 356                 __TNO(enumprefix,structprefix,structname,vlantag,VlanTag)
 357
 358 #define TRACE_V23_REC_LEN_OFF(enumprefix,structprefix,structname) \
 359                 TRACE_V22_REC_LEN_OFF(enumprefix,structprefix,structname)\
 360                 __TNO(enumprefix,structprefix,structname,coreid,Coreid)
 361
 362
 363         TRACE_V10_REC_LEN_OFF(v10_part,pp,pktracepart_v10)
 364         TRACE_V10_REC_LEN_OFF(v10_full,fp,pktracefull_v10)
 365         TRACE_V20_REC_LEN_OFF(v20_part,pp,pktracepart_v20)
 366         TRACE_V20_REC_LEN_OFF(v20_full,fp,pktracefull_v20)
 367         TRACE_V21_REC_LEN_OFF(v21_part,pp,pktracepart_v21)
 368         TRACE_V21_REC_LEN_OFF(v21_full,fp,pktracefull_v21)
 369         TRACE_V22_REC_LEN_OFF(v22_part,pp,pktracepart_v22)
 370         TRACE_V22_REC_LEN_OFF(v22_full,fp,pktracefull_v22)
 371         TRACE_V23_REC_LEN_OFF(v23_part,pp,pktracepart_v23)
 372         TRACE_V23_REC_LEN_OFF(v23_full,fp,pktracefull_v23)
 373
 374 #undef __TNV1O
 375 #undef __TNV1L
 376 #undef __TNO
 377 #undef __TNL
 378
 379
 380 #define ns_setabstime(nstrace, AbsoluteTime, RelativeTimems)    \
 381         do { \
 382                 (nstrace)->nspm_curtime = AbsoluteTime; \
 383                 (nstrace)->nspm_curtimemsec += RelativeTimems; \
 384                 (nstrace)->nspm_curtimelastmsec = nstrace->nspm_curtimemsec; \
 385         } while(0)
 386
 387
 388 #define ns_setrelativetime(nstrace, RelativeTimems)     \
 389         do { \
 390                 guint32 rsec; \
 391                 (nstrace)->nspm_curtimemsec += RelativeTimems; \
 392                 rsec = (guint32)((nstrace)->nspm_curtimemsec - (nstrace)->nspm_curtimelastmsec)/1000; \
 393                 (nstrace)->nspm_curtime += rsec; \
 394                 (nstrace)->nspm_curtimelastmsec += rsec * 1000; \
 395         } while (0)
 396
 397
 398 typedef struct {
 399         gchar *pnstrace_buf;
 400         gint32 nstrace_buf_offset;
 401         gint32 nstrace_buflen;
 402         /* Performance Monitor Time variables */
 403         guint32 nspm_curtime;           /* current time since 1970 */
 404         guint64 nspm_curtimemsec;       /* current time in mili second */
 405         guint64 nspm_curtimelastmsec;   /* nspm_curtime last update time in milisec */
 406         guint64 nsg_creltime;
 407         guint64 file_size;
 408 } nstrace_t;
 409
 410 guint32 nspm_signature_isv10(gchar *sigp);
 411 guint32 nspm_signature_isv20(gchar *sigp);
 412 guint32 nspm_signature_version(wtap*, gchar*, gint32);
 413 gboolean nstrace_read(wtap *wth, int *err, gchar **err_info,
 414                  gint64 *data_offset);
 415 gboolean nstrace_read_v10(wtap *wth, int *err, gchar **err_info,
 416                  gint64 *data_offset);
 417 gboolean nstrace_read_v20(wtap *wth, int *err, gchar **err_info,
 418                  gint64 *data_offset);
 419 gboolean nstrace_seek_read(wtap *wth, gint64 seek_off,
 420                       union wtap_pseudo_header *pseudo_header,
 421                       guchar *pd, int length,
 422                       int *err, gchar **err_info _U_);
 423 void nstrace_close(wtap *wth);
 424 void nstrace_sequential_close(wtap *wth);
 425
 426 gboolean nstrace_set_start_time_v10(wtap *wth);
 427 gboolean nstrace_set_start_time_v20(wtap *wth);
 428 gboolean nstrace_set_start_time(wtap *wth);
 429 guint64 ns_hrtime2nsec(guint32 tm);
 430
 431 static gboolean nstrace_dump(wtap_dumper *wdh, const struct wtap_pkthdr *phdr,
 432         const union wtap_pseudo_header *pseudo_header, const guchar *pd, int *err);
 433
 434
 435 #define GET_READ_PAGE_SIZE(remaining_file_size) ((gint32)((remaining_file_size>NSPR_PAGESIZE)?NSPR_PAGESIZE:remaining_file_size))
 436
 437
 438 guint64 ns_hrtime2nsec(guint32 tm)
 439 {
 440         guint32 val = tm & NSPR_HRTIME_MASKTM;
 441         switch(tm & NSPR_HRTIME_MASKFMT)
 442         {
 443         case NSPR_HRTIME_SEC:   return (guint64)val*1000000000;
 444         case NSPR_HRTIME_MSEC:  return (guint64)val*1000000;
 445         case NSPR_HRTIME_USEC:  return (guint32)val*1000;
 446         case NSPR_HRTIME_NSEC:  return val;
 447         }
 448         return tm;
 449 }
 450
 451
 452 /*
 453 ** Netscaler trace format open routines
 454 */
 455 int nstrace_open(wtap *wth, int *err, gchar **err_info)
 456 {
 457         gchar *nstrace_buf;
 458         gint64 file_size;
 459         gint32 page_size;
 460         nstrace_t *nstrace;
 461         int bytes_read;
 462
 463         errno = WTAP_ERR_CANT_READ;
 464
 465         if ((file_size = wtap_file_size(wth, err)) == -1)
 466                 return 0;
 467
 468         nstrace_buf = g_malloc(NSPR_PAGESIZE);
 469         page_size = GET_READ_PAGE_SIZE(file_size);
 470
 471         switch ((wth->file_type = nspm_signature_version(wth, nstrace_buf, page_size)))
 472         {
 473         case WTAP_FILE_NETSCALER_1_0:
 474                 wth->file_encap = WTAP_ENCAP_NSTRACE_1_0;
 475                 break;
 476
 477         case WTAP_FILE_NETSCALER_2_0:
 478                 wth->file_encap = WTAP_ENCAP_NSTRACE_2_0;
 479                 break;
 480
 481         default:
 482                 *err = WTAP_ERR_UNSUPPORTED;
 483                 *err_info = g_strdup_printf("nstrace: file type %d unsupported", wth->file_type);
 484                 g_free(nstrace_buf);
 485                 return 0;
 486         }
 487
 488         if ((file_seek(wth->fh, 0, SEEK_SET, err)) == -1)
 489         {
 490                 *err = file_error(wth->fh);
 491                 g_free(nstrace_buf);
 492                 return 0;
 493         }
 494
 495         bytes_read = file_read(nstrace_buf, 1, page_size, wth->fh);
 496         if (bytes_read != page_size)
 497         {
 498                 *err = file_error(wth->fh);
 499                 g_free(nstrace_buf);
 500                 return 0;
 501         }
 502
 503         wth->subtype_read = nstrace_read;
 504         wth->subtype_seek_read = nstrace_seek_read;
 505         wth->subtype_close = nstrace_close;
 506
 507         nstrace = (nstrace_t *)g_malloc(sizeof(nstrace_t));
 508         wth->priv = (void *)nstrace;
 509         nstrace->pnstrace_buf = nstrace_buf;
 510         nstrace->nstrace_buflen = page_size;
 511         nstrace->nstrace_buf_offset = 0;
 512         nstrace->nspm_curtime = 0;
 513         nstrace->nspm_curtimemsec = 0;
 514         nstrace->nspm_curtimelastmsec = 0;
 515         nstrace->nsg_creltime = 0;
 516         nstrace->file_size = file_size;
 517
 518
 519         /* Set the start time by looking for the abstime record */
 520         if ((nstrace_set_start_time(wth)) == FALSE)
 521         {
 522                 /* Reset the read pointer to start of the file. */
 523                 if ((file_seek(wth->fh, 0, SEEK_SET, err)) == -1)
 524                 {
 525                         *err = file_error(wth->fh);
 526                         g_free(nstrace->pnstrace_buf);
 527                         g_free(nstrace);
 528                         return 0;
 529                 }
 530
 531                 /* Read the first page of data */
 532                 bytes_read = file_read(nstrace_buf, 1, page_size, wth->fh);
 533                 if (bytes_read != page_size)
 534                 {
 535                         *err = file_error(wth->fh);
 536                         g_free(nstrace->pnstrace_buf);
 537                         g_free(nstrace);
 538                         return 0;
 539                 }
 540
 541                 /* reset the buffer offset */
 542                 nstrace->nstrace_buf_offset = 0;
 543         }
 544
 545         wth->tsprecision = WTAP_FILE_TSPREC_NSEC;
 546         wth->phdr.ts.secs = nstrace->nspm_curtime;
 547         wth->phdr.ts.nsecs = 0;
 548
 549         *err = 0;
 550         return 1;
 551 }
 552
 553
 554 #define nspm_signature_func(ver) \
 555         guint32 nspm_signature_isv##ver(gchar *sigp) {\
 556                 return strncmp(sigp,NSPR_SIGSTR_V##ver,(sizeof(NSPR_SIGSTR_V##ver)-1));\
 557         }
 558
 559 nspm_signature_func(10)
 560 nspm_signature_func(20)
 561
 562 /*
 563 ** Check signature and return the version number of the signature.
 564 ** If not found, it returns 0. At the time of return from this function
 565 ** we might not be at the first page. So after a call to this function, there
 566 ** has to be a file seek to return to the start of the first page.
 567 */
 568 guint32
 569 nspm_signature_version(wtap *wth, gchar *nstrace_buf, gint32 len)
 570 {
 571         gchar *dp = nstrace_buf;
 572         int bytes_read;
 573
 574         bytes_read = file_read(dp, 1, len, wth->fh);
 575         if (bytes_read == len) {
 576
 577                 for ( ; len > (gint32)(ns_min(sizeof(NSPR_SIGSTR_V10), sizeof(NSPR_SIGSTR_V20))); dp++, len--)
 578                 {
 579 #define sigv10p ((nspr_signature_v10_t*)dp)
 580                         if ((pletohs(&sigv10p->nsprRecordType) == NSPR_SIGNATURE_V10) &&
 581                                 (pletohs(&sigv10p->nsprRecordSize) <= len) &&
 582                                 ((gint32)sizeof(NSPR_SIGSTR_V10) <= len) &&
 583                                 (!nspm_signature_isv10(sigv10p->sig_Signature)))
 584                                 return WTAP_FILE_NETSCALER_1_0;
 585 #undef  sigv10p
 586
 587 #define sigv20p ((nspr_signature_v20_t*)dp)
 588                         if ((sigv20p->sig_RecordType == NSPR_SIGNATURE_V20) &&
 589                                 (sigv20p->sig_RecordSize <= len) &&
 590                                 ((gint32)sizeof(NSPR_SIGSTR_V20) <= len) &&
 591                                 (!nspm_signature_isv20(sigv20p->sig_Signature)))
 592                                 return WTAP_FILE_NETSCALER_2_0;
 593 #undef  sigv20p
 594                 }
 595         }
 596
 597         return 0;       /* no version found */
 598 }
 599
 600 #define nspr_getv10recordtype(hdp) (pletohs(&hdp->nsprRecordType))
 601 #define nspr_getv10recordsize(hdp) (pletohs(&hdp->nsprRecordSize))
 602 #define nspr_getv20recordtype(hdp) (hdp->phd_RecordType)
 603 #define nspr_getv20recordsize(hdp) \
 604         (((hdp)->phd_RecordSizeLow & NSPR_V20RECORDSIZE_2BYTES)? \
 605                 (((hdp)->phd_RecordSizeHigh * NSPR_V20RECORDSIZE_2BYTES)+ \
 606                  ((hdp)->phd_RecordSizeLow & ~NSPR_V20RECORDSIZE_2BYTES)) : \
 607                   (hdp)->phd_RecordSizeLow)
 608
 609
 610 #define nstrace_set_start_time_ver(ver) \
 611         gboolean nstrace_set_start_time_v##ver(wtap *wth) \
 612         {\
 613                 nstrace_t *nstrace = (nstrace_t *)wth->priv;\
 614                 gchar* nstrace_buf = nstrace->pnstrace_buf;\
 615                 gint32 nstrace_buf_offset = nstrace->nstrace_buf_offset;\
 616                 gint32 nstrace_buflen = nstrace->nstrace_buflen;\
 617                 int bytes_read;\
 618                 do\
 619                 {\
 620                         while (nstrace_buf_offset < nstrace_buflen)\
 621                         {\
 622                                 nspr_hd_v##ver##_t *fp = (nspr_hd_v##ver##_t *) &nstrace_buf[nstrace_buf_offset];\
 623                                 switch (nspr_getv##ver##recordtype(fp))\
 624                                 {\
 625                                         case NSPR_ABSTIME_V##ver:\
 626                                                 ns_setabstime(nstrace, pletohl(&((nspr_abstime_v##ver##_t *) fp)->abs_Time), pletohs(&((nspr_abstime_v##ver##_t *) fp)->abs_RelTime));\
 627                                                 nstrace->nstrace_buf_offset = nstrace_buf_offset + nspr_getv##ver##recordsize(fp);\
 628                                                 nstrace->nstrace_buflen = nstrace_buflen;\
 629                                                 return TRUE;\
 630                                         case NSPR_UNUSEDSPACE_V10:\
 631                                                 nstrace_buf_offset = nstrace_buflen;\
 632                                                 break;\
 633                                         default:\
 634                                                 nstrace_buf_offset += nspr_getv##ver##recordsize(fp);\
 635                                 }\
 636                         }\
 637                         nstrace_buf_offset = 0;\
 638                         wth->data_offset += nstrace_buflen;\
 639                         nstrace_buflen = GET_READ_PAGE_SIZE((nstrace->file_size - wth->data_offset));\
 640                 }while((nstrace_buflen > 0) && (bytes_read = file_read(nstrace_buf, 1, nstrace_buflen, wth->fh)) && bytes_read == nstrace_buflen); \
 641                 return FALSE;\
 642         }
 643
 644 nstrace_set_start_time_ver(10)
 645 nstrace_set_start_time_ver(20)
 646
 647 #undef nspr_getv10recordtype
 648 #undef nspr_getv20recordtype
 649 #undef nspr_getv10recordsize
 650
 651 /*
 652 ** Set the start time of the trace file. We look for the first ABSTIME record. We use that
 653 ** to set the start time. Apart from that we also make sure that we remember the position of
 654 ** the next record after the ABSTIME record. Inorder to report correct time values, all trace
 655 ** records before the ABSTIME record are ignored.
 656 */
 657 gboolean nstrace_set_start_time(wtap *wth)
 658 {
 659         if (wth->file_type == WTAP_FILE_NETSCALER_1_0)
 660                 return nstrace_set_start_time_v10(wth);
 661         else if (wth->file_type == WTAP_FILE_NETSCALER_2_0)
 662                 return nstrace_set_start_time_v20(wth);
 663
 664         return FALSE;
 665 }
 666
 667 #define __TNO(enumprefix,structprefix,structname,hdrname,structfieldname) \
 668         wth->pseudo_header.nstr.hdrname##_offset =  enumprefix##_##hdrname##_offset;
 669
 670 #define __TNL(enumprefix,structprefix,structname,hdrname,structfieldname) \
 671         wth->pseudo_header.nstr.hdrname##_len = enumprefix##_##hdrname##_len;
 672
 673 #define __TNV1O(enumprefix,structprefix,structname,hdrname,structfieldname) \
 674         __TNO(enumprefix,structprefix,structname,hdrname,structfieldname)
 675
 676 #define __TNV1L(enumprefix,structprefix,structname,hdrname,structfieldname) \
 677         __TNL(enumprefix,structprefix,structname,hdrname,structfieldname)
 678
 679
 680
 681 /*
 682 ** Netscaler trace format read routines.
 683 */
 684 gboolean nstrace_read_v10(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
 685 {
 686         nstrace_t *nstrace = (nstrace_t *)wth->priv;
 687         guint64 nsg_creltime = nstrace->nsg_creltime;
 688         gchar *nstrace_buf = nstrace->pnstrace_buf;
 689         gint32 nstrace_buf_offset = nstrace->nstrace_buf_offset;
 690         gint32 nstrace_buflen = nstrace->nstrace_buflen;
 691         nspr_pktracefull_v10_t *fp;
 692         nspr_pktracepart_v10_t *pp;
 693         int bytes_read;
 694
 695         *err = 0;
 696         *err_info = NULL;
 697         do
 698         {
 699                 while ((nstrace_buf_offset < nstrace_buflen) &&
 700                         ((nstrace_buflen - nstrace_buf_offset) >= ((gint32)sizeof(fp->nsprRecordType))))
 701                 {
 702
 703                         fp = (nspr_pktracefull_v10_t *) &nstrace_buf[nstrace_buf_offset];
 704                         pp = (nspr_pktracepart_v10_t *) fp;
 705
 706                         switch (pletohs(&fp->nsprRecordType))
 707                         {
 708                         case NSPR_PDPKTRACEFULLTX_V10:
 709                         case NSPR_PDPKTRACEFULLTXB_V10:
 710                         case NSPR_PDPKTRACEFULLRX_V10:
 711
 712                                 nsg_creltime += ns_hrtime2nsec(pletohl(&fp->fp_RelTimeHr));
 713                                 wth->phdr.ts.secs = nstrace->nspm_curtime + (guint32) (nsg_creltime / 1000000000);
 714                                 wth->phdr.ts.nsecs = (guint32) (nsg_creltime % 1000000000);
 715
 716                                 wth->phdr.len = pletohs(&fp->nsprRecordSize);
 717                                 wth->phdr.caplen = wth->phdr.len;
 718
 719
 720                                 TRACE_V10_REC_LEN_OFF(v10_full,fp,pktracefull_v10);
 721
 722                                 buffer_assure_space(wth->frame_buffer, wth->phdr.caplen);
 723                                 memcpy(buffer_start_ptr(wth->frame_buffer), fp, wth->phdr.caplen);
 724                                 *data_offset = wth->data_offset + nstrace_buf_offset;
 725
 726                                 nstrace->nstrace_buf_offset = nstrace_buf_offset + wth->phdr.len;
 727                                 nstrace->nstrace_buflen = nstrace_buflen;
 728                                 nstrace->nsg_creltime = nsg_creltime;
 729
 730                                 return TRUE;
 731
 732                         case NSPR_PDPKTRACEPARTTX_V10:
 733                         case NSPR_PDPKTRACEPARTTXB_V10:
 734                         case NSPR_PDPKTRACEPARTRX_V10:
 735
 736                                 nsg_creltime += ns_hrtime2nsec(pletohl(&pp->pp_RelTimeHr));
 737                                 wth->phdr.ts.secs = nstrace->nspm_curtime + (guint32) (nsg_creltime / 1000000000);
 738                                 wth->phdr.ts.nsecs = (guint32) (nsg_creltime % 1000000000);
 739
 740                                 wth->phdr.len =  pletohs(&pp->pp_PktSizeOrg) + nspr_pktracepart_v10_s;
 741                                 wth->phdr.caplen =  pletohs(&pp->nsprRecordSize);
 742
 743                                 TRACE_V10_REC_LEN_OFF(v10_part,pp,pktracepart_v10);
 744
 745                                 buffer_assure_space(wth->frame_buffer, wth->phdr.caplen);
 746                                 memcpy(buffer_start_ptr(wth->frame_buffer), pp, wth->phdr.caplen);
 747                                 *data_offset = wth->data_offset + nstrace_buf_offset;
 748
 749                                 nstrace->nstrace_buf_offset = nstrace_buf_offset + wth->phdr.caplen;
 750                                 nstrace->nsg_creltime = nsg_creltime;
 751                                 nstrace->nstrace_buflen = nstrace_buflen;
 752
 753                                 return TRUE;
 754
 755                         case NSPR_ABSTIME_V10:
 756
 757                                 ns_setabstime(nstrace, pletohl(&((nspr_abstime_v10_t *) fp)->abs_Time), pletohl(&((nspr_abstime_v10_t *) fp)->abs_RelTime));
 758                                 nstrace_buf_offset += pletohs(&fp->nsprRecordSize);
 759                                 break;
 760
 761                         case NSPR_RELTIME_V10:
 762
 763                                 ns_setrelativetime(nstrace, ((nspr_abstime_v10_t *) fp)->abs_RelTime);
 764                                 nstrace_buf_offset += pletohs(&fp->nsprRecordSize);
 765                                 break;
 766
 767                         case NSPR_UNUSEDSPACE_V10:
 768
 769                                 nstrace_buf_offset = nstrace_buflen;
 770                                 break;
 771
 772                         default:
 773
 774                                 nstrace_buf_offset += pletohs(&fp->nsprRecordSize);
 775                                 break;
 776                         }
 777                 }
 778
 779                 nstrace_buf_offset = 0;
 780                 wth->data_offset += nstrace_buflen;
 781                 nstrace_buflen = GET_READ_PAGE_SIZE((nstrace->file_size - wth->data_offset));
 782         }while((nstrace_buflen > 0) && (bytes_read = file_read(nstrace_buf, 1, nstrace_buflen, wth->fh)) && (bytes_read == nstrace_buflen));
 783
 784         return FALSE;
 785 }
 786
 787 #define TIMEDEFV20(fp,type) \
 788         do {\
 789                 nsg_creltime += ns_hrtime2nsec(pletohl(&fp->type##_RelTimeHr));\
 790                 wth->phdr.ts.secs = nstrace->nspm_curtime + (guint32) (nsg_creltime / 1000000000);\
 791                 wth->phdr.ts.nsecs = (guint32) (nsg_creltime % 1000000000);\
 792         }while(0)
 793
 794 #define TIMEDEFV23(fp,type) \
 795         do {\
 796                 /* access _AbsTimeHighHdr as a 64bit value */\
 797                 nsg_creltime = (((guint64)fp->type##_AbsTimeHighHdr<<32) | (fp->type##_AbsTimeLowHdr));\
 798                 wth->phdr.ts.secs = (guint32) (nsg_creltime / 1000000000);\
 799                 wth->phdr.ts.nsecs = (guint32) (nsg_creltime % 1000000000);\
 800         }while(0)
 801
 802 #define TIMEDEFV21(fp,type) TIMEDEFV20(fp,type)
 803 #define TIMEDEFV22(fp,type) TIMEDEFV20(fp,type)
 804
 805 #define PPSIZEDEFV20(pp,ver) \
 806         do {\
 807                 wth->phdr.len = pletohs(&pp->pp_PktSizeOrg) + nspr_pktracepart_v##ver##_s;\
 808                 wth->phdr.caplen = nspr_getv20recordsize((nspr_hd_v20_t *)pp);\
 809         }while(0)
 810
 811 #define PPSIZEDEFV21(pp,ver) PPSIZEDEFV20(pp,ver)
 812 #define PPSIZEDEFV22(pp,ver) PPSIZEDEFV20(pp,ver)
 813 #define PPSIZEDEFV23(pp,ver) PPSIZEDEFV20(pp,ver)
 814
 815 #define FPSIZEDEFV20(fp,ver)\
 816         do {\
 817                 wth->phdr.len = nspr_getv20recordsize((nspr_hd_v20_t *)fp);\
 818                 wth->phdr.caplen = wth->phdr.len;\
 819         }while(0)
 820
 821 #define FPSIZEDEFV21(pp,ver) FPSIZEDEFV20(fp,ver)
 822 #define FPSIZEDEFV22(pp,ver) FPSIZEDEFV20(fp,ver)
 823 #define FPSIZEDEFV23(pp,ver) FPSIZEDEFV20(fp,ver)
 824
 825 #define PACKET_DESCRIBE(FPTIMEDEF,SIZEDEF,ver,enumprefix,type,structname,TYPE)\
 826         do {\
 827                 nspr_##structname##_t *fp= (nspr_##structname##_t*)&nstrace_buf[nstrace_buf_offset];\
 828                 TIMEDEFV##ver(fp,type);\
 829                 SIZEDEF##ver(fp,ver);\
 830                 TRACE_V##ver##_REC_LEN_OFF(enumprefix,type,structname);\
 831                 buffer_assure_space(wth->frame_buffer, wth->phdr.caplen);\
 832                 memcpy(buffer_start_ptr(wth->frame_buffer), fp, wth->phdr.caplen);\
 833                 *data_offset = wth->data_offset + nstrace_buf_offset;\
 834                 nstrace->nstrace_buf_offset = nstrace_buf_offset + nspr_getv20recordsize((nspr_hd_v20_t *)fp);\
 835                 nstrace->nstrace_buflen = nstrace_buflen;\
 836                 nstrace->nsg_creltime = nsg_creltime;\
 837                 wth->pseudo_header.nstr.rec_type = NSPR_HEADER_VERSION##TYPE;\
 838                 return TRUE;\
 839         }while(0)
 840
 841 gboolean nstrace_read_v20(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
 842 {
 843         nstrace_t *nstrace = (nstrace_t *)wth->priv;
 844         guint64 nsg_creltime = nstrace->nsg_creltime;
 845         gchar *nstrace_buf = nstrace->pnstrace_buf;
 846         gint32 nstrace_buf_offset = nstrace->nstrace_buf_offset;
 847         gint32 nstrace_buflen = nstrace->nstrace_buflen;
 848         nspr_pktracefull_v20_t *fp20;
 849         nspr_pktracefull_v21_t *fp21;
 850         int bytes_read;
 851
 852         *err = 0;
 853         *err_info = NULL;
 854         do
 855         {
 856                 while ((nstrace_buf_offset < nstrace_buflen) &&
 857                         ((nstrace_buflen - nstrace_buf_offset) >= ((gint32)sizeof(fp21->fp_RecordType))))
 858                 {
 859                         fp21 = (nspr_pktracefull_v21_t *) &nstrace_buf[nstrace_buf_offset];
 860
 861                         switch (fp21->fp_RecordType)
 862                         {
 863
 864 #define GENERATE_CASE(type,acttype) \
 865                 case NSPR_PDPKTRACEFULLTX_V##type:\
 866                 case NSPR_PDPKTRACEFULLTXB_V##type:\
 867                 case NSPR_PDPKTRACEFULLRX_V##type:\
 868                         PACKET_DESCRIBE(TIMEDEF,FPSIZEDEFV,type,v##type##_full,fp,pktracefull_v##type,acttype);
 869                                 GENERATE_CASE(23,203);
 870                                 GENERATE_CASE(22,202);
 871                                 GENERATE_CASE(21,201);
 872                                 GENERATE_CASE(20,200);
 873 #undef GENERATE_CASE
 874
 875 #define GENERATE_CASE(type,acttype) \
 876                 case NSPR_PDPKTRACEPARTTX_V##type:\
 877                 case NSPR_PDPKTRACEPARTTXB_V##type:\
 878                 case NSPR_PDPKTRACEPARTRX_V##type:\
 879                         PACKET_DESCRIBE(TIMEDEF,PPSIZEDEFV,type,v##type##_part,pp,pktracepart_v##type,acttype);
 880                                 GENERATE_CASE(23,203);
 881                                 GENERATE_CASE(22,202);
 882                                 GENERATE_CASE(21,201);
 883                                 GENERATE_CASE(20,200);
 884 #undef GENERATE_CASE
 885
 886                                 case NSPR_ABSTIME_V20:
 887                                 {
 888                                         fp20 = (nspr_pktracefull_v20_t *) &nstrace_buf[nstrace_buf_offset];
 889                                         nstrace_buf_offset += nspr_getv20recordsize((nspr_hd_v20_t *)fp20);
 890                                         ns_setabstime(nstrace, pletohl(&((nspr_abstime_v20_t *) fp20)->abs_Time), pletohs(&((nspr_abstime_v20_t *) fp20)->abs_RelTime));
 891                                         break;
 892                                 }
 893
 894                                 case NSPR_RELTIME_V20:
 895                                 {
 896                                         fp20 = (nspr_pktracefull_v20_t *) &nstrace_buf[nstrace_buf_offset];
 897                                         ns_setrelativetime(nstrace, pletohs(&((nspr_abstime_v20_t *) fp20)->abs_RelTime));
 898                                         nstrace_buf_offset += nspr_getv20recordsize((nspr_hd_v20_t *)fp20);
 899                                         break;
 900                         }
 901
 902                                 case NSPR_UNUSEDSPACE_V20:
 903                                 {
 904                                         if (nstrace_buf_offset >= NSPR_PAGESIZE/2)
 905                                                 nstrace_buf_offset = nstrace_buflen;
 906                                         else
 907                                                 nstrace_buf_offset = NSPR_PAGESIZE/2;
 908                                         break;
 909                         }
 910
 911                                 default:
 912                                 {
 913                                         fp20 = (nspr_pktracefull_v20_t *) &nstrace_buf[nstrace_buf_offset];
 914                                         nstrace_buf_offset += nspr_getv20recordsize((nspr_hd_v20_t *)fp20);
 915                                         break;
 916                                 }
 917                         }
 918         }
 919
 920                 nstrace_buf_offset = 0;
 921             wth->data_offset += nstrace_buflen;
 922         nstrace_buflen = GET_READ_PAGE_SIZE((nstrace->file_size - wth->data_offset));
 923         }while((nstrace_buflen > 0) && (bytes_read = file_read(nstrace_buf, 1, nstrace_buflen, wth->fh)) && (bytes_read == nstrace_buflen));
 924
 925         return FALSE;
 926 }
 927
 928 #undef __TNO
 929 #undef __TNL
 930 #undef __TNV1O
 931 #undef __TNV1L
 932
 933
 934
 935 gboolean nstrace_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
 936 {
 937
 938         if (wth->file_type == WTAP_FILE_NETSCALER_1_0)
 939                 return nstrace_read_v10(wth, err, err_info, data_offset);
 940         else if (wth->file_type == WTAP_FILE_NETSCALER_2_0)
 941                 return nstrace_read_v20(wth, err, err_info, data_offset);
 942
 943         return FALSE;
 944 }
 945
 946
 947 #define __TNO(enumprefix,structprefix,structname,hdrname,structfieldname) \
 948         pseudo_header->nstr.hdrname##_offset = (guint8) enumprefix##_##hdrname##_offset;
 949 #define __TNL(enumprefix,structprefix,structname,hdrname,structfieldname) \
 950         pseudo_header->nstr.hdrname##_len = (guint8) enumprefix##_##hdrname##_len;;
 951
 952 #define __TNV1O(enumprefix,structprefix,structname,hdrname,structfieldname) \
 953         __TNO(enumprefix,structprefix,structname,hdrname,structfieldname)
 954 #define __TNV1L(enumprefix,structprefix,structname,hdrname,structfieldname) \
 955         __TNL(enumprefix,structprefix,structname,hdrname,structfieldname)
 956
 957
 958 gboolean nstrace_seek_read(wtap *wth, gint64 seek_off,
 959     union wtap_pseudo_header *pseudo_header, guchar *pd, int length,
 960     int *err, gchar **err_info _U_)
 961 {
 962         int bytes_read;
 963
 964         *err = 0;
 965
 966         if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
 967                 return FALSE;
 968
 969         /*
 970         ** Read the packet data.
 971         */
 972         bytes_read = file_read(pd, 1, length, wth->random_fh);
 973         if (bytes_read != length)
 974                 return FALSE;
 975
 976         if (wth->file_type == WTAP_FILE_NETSCALER_1_0)
 977         {
 978
 979 #define GENERATE_CASE_FULL(type,acttype) \
 980                 case NSPR_PDPKTRACEFULLTX_V##type:\
 981                 case NSPR_PDPKTRACEFULLTXB_V##type:\
 982                 case NSPR_PDPKTRACEFULLRX_V##type:\
 983                         TRACE_V##type##_REC_LEN_OFF(v##type##_full,fp,pktracefull_v##type);\
 984                         pseudo_header->nstr.rec_type = NSPR_HEADER_VERSION##acttype;\
 985                         break;\
 986
 987 #define GENERATE_CASE_PART(type,acttype) \
 988                 case NSPR_PDPKTRACEPARTTX_V##type:\
 989                 case NSPR_PDPKTRACEPARTTXB_V##type:\
 990                 case NSPR_PDPKTRACEPARTRX_V##type:\
 991                         TRACE_V##type##_REC_LEN_OFF(v##type##_part,pp,pktracepart_v##type);\
 992                         pseudo_header->nstr.rec_type = NSPR_HEADER_VERSION##acttype;\
 993                         break;\
 994
 995                 switch (pletohs(&(( nspr_header_v10_t*)pd)->ph_RecordType))
 996                 {
 997                         GENERATE_CASE_FULL(10,100)
 998                         GENERATE_CASE_PART(10,100)
 999                 }
1000         } else if (wth->file_type == WTAP_FILE_NETSCALER_2_0)
1001         {
1002                 switch ((( nspr_hd_v20_t*)pd)->phd_RecordType)
1003                 {
1004                         GENERATE_CASE_FULL(20,200)
1005                         GENERATE_CASE_PART(20,200)
1006                         GENERATE_CASE_FULL(21,201)
1007                         GENERATE_CASE_PART(21,201)
1008                         GENERATE_CASE_FULL(22,202)
1009                         GENERATE_CASE_PART(22,202)
1010                         GENERATE_CASE_FULL(23,203)
1011                         GENERATE_CASE_PART(23,203)
1012                 }
1013         }
1014
1015         return TRUE;
1016 }
1017
1018 #undef __TNL
1019 #undef __TNO
1020 #undef __TNV1L
1021 #undef __TNV1O
1022
1023
1024 /*
1025 ** Netscaler trace format close routines.
1026 */
1027 void nstrace_close(wtap *wth)
1028 {
1029         nstrace_t *nstrace = (nstrace_t *)wth->priv;
1030
1031         g_free(nstrace->pnstrace_buf);
1032 }
1033
1034
1035 typedef struct {
1036         guint16 page_offset;
1037         guint16 page_len;
1038         guint32 absrec_time;
1039 } nstrace_dump_t;
1040
1041 /* Returns 0 if we could write the specified encapsulation type,
1042 ** an error indication otherwise. */
1043 int nstrace_10_dump_can_write_encap(int encap)
1044 {
1045         if (encap == WTAP_ENCAP_NSTRACE_1_0)
1046                 return 0;
1047
1048         return WTAP_ERR_UNSUPPORTED_ENCAP;
1049 }
1050
1051
1052 /* Returns 0 if we could write the specified encapsulation type,
1053 ** an error indication otherwise. */
1054 int nstrace_20_dump_can_write_encap(int encap)
1055 {
1056         if (encap == WTAP_ENCAP_NSTRACE_2_0)
1057                 return 0;
1058
1059         return WTAP_ERR_UNSUPPORTED_ENCAP;
1060 }
1061
1062
1063 /* Returns TRUE on success, FALSE on failure; sets "*err" to an error code on
1064 ** failure */
1065 gboolean nstrace_dump_open(wtap_dumper *wdh, gboolean cant_seek, int *err)
1066 {
1067         nstrace_dump_t *nstrace;
1068
1069         if (cant_seek)
1070         {
1071                 *err = WTAP_ERR_CANT_WRITE_TO_PIPE;
1072                 return FALSE;
1073         }
1074
1075         wdh->subtype_write = nstrace_dump;
1076
1077         nstrace = (nstrace_dump_t *)g_malloc(sizeof(nstrace_dump_t));
1078         wdh->priv = (void *)nstrace;
1079         nstrace->page_offset = 0;
1080         nstrace->page_len = NSPR_PAGESIZE;
1081         nstrace->absrec_time = 0;
1082
1083         return TRUE;
1084 }
1085
1086
1087 static gboolean nstrace_add_signature(wtap_dumper *wdh, int *err)
1088 {
1089         nstrace_dump_t *nstrace = (nstrace_dump_t *)wdh->priv;
1090
1091         if (wdh->file_type == WTAP_FILE_NETSCALER_1_0)
1092         {
1093                 nspr_signature_v10_t sig10;
1094
1095                 /* populate the record */
1096                 sig10.phd.ph_RecordType = htoles(NSPR_SIGNATURE_V10);
1097                 sig10.phd.ph_RecordSize = htoles(nspr_signature_v10_s);
1098                 memcpy(sig10.sig_Signature, NSPR_SIGSTR_V10, NSPR_SIGSIZE_V10);
1099
1100                 /* Write the record into the file */
1101                 if (!wtap_dump_file_write(wdh, &sig10, nspr_signature_v10_s,
1102                     err))
1103                         return FALSE;
1104
1105                 /* Move forward the page offset */
1106                 nstrace->page_offset += (guint16) nspr_signature_v10_s;
1107
1108         } else if (wdh->file_type == WTAP_FILE_NETSCALER_2_0)
1109         {
1110                 gchar sig[nspr_signature_v20_s + sizeof(NSPR_SIGSTR_V20)];
1111                 nspr_signature_v20_t *sig20;
1112
1113                 sig20 = (nspr_signature_v20_t *)&sig;
1114                 sig20->sig_RecordType = NSPR_SIGNATURE_V20;
1115                 sig20->sig_RecordSize = nspr_signature_v20_s + sizeof(NSPR_SIGSTR_V20);
1116                 memcpy(sig20->sig_Signature, NSPR_SIGSTR_V20, sizeof(NSPR_SIGSTR_V20));
1117
1118                 /* Write the record into the file */
1119                 if (!wtap_dump_file_write(wdh, sig20, sig20->sig_RecordSize,
1120                     err))
1121                         return FALSE;
1122
1123                 /* Move forward the page offset */
1124                 nstrace->page_offset += (guint16) sig20->sig_RecordSize;
1125
1126         } else
1127         {
1128                 g_assert_not_reached();
1129                 return FALSE;
1130         }
1131
1132         return TRUE;
1133 }
1134
1135
1136 static gboolean
1137 nstrace_add_abstime(wtap_dumper *wdh, const struct wtap_pkthdr *phdr,
1138      const guchar *pd, int *err)
1139 {
1140         nstrace_dump_t *nstrace = (nstrace_dump_t *)wdh->priv;
1141         guint64 nsg_creltime;
1142
1143         if (wdh->file_type == WTAP_FILE_NETSCALER_1_0)
1144         {
1145                 nspr_abstime_v10_t abs10;
1146                 nspr_pktracefull_v10_t fp10;
1147
1148                 /* populate the record */
1149                 abs10.phd.ph_RecordType = htoles(NSPR_ABSTIME_V10);
1150                 abs10.phd.ph_RecordSize = htoles(nspr_abstime_v10_s);
1151
1152                 memcpy(&fp10, pd, nspr_pktracefull_v10_s);
1153                 nsg_creltime = ns_hrtime2nsec(fp10.fp_RelTimeHr);
1154
1155                 abs10.abs_RelTime = 0;
1156                 abs10.abs_Time = htolel((guint32)phdr->ts.secs - (guint32)(nsg_creltime/1000000000));
1157
1158                 /* Write the record into the file */
1159                 if (!wtap_dump_file_write(wdh, &abs10, nspr_abstime_v10_s, err))
1160                         return FALSE;
1161
1162                 /* Move forward the page offset */
1163                 nstrace->page_offset += nspr_abstime_v10_s;
1164
1165         } else if (wdh->file_type == WTAP_FILE_NETSCALER_2_0)
1166         {
1167                 nspr_abstime_v20_t abs20;
1168                 nspr_pktracefull_v20_t fp20;
1169
1170                 abs20.abs_RecordType = NSPR_ABSTIME_V20;
1171                 abs20.abs_RecordSize = nspr_abstime_v20_s;
1172
1173                 memcpy(&fp20, pd, nspr_pktracefull_v20_s);
1174                 nsg_creltime = ns_hrtime2nsec(fp20.fp_RelTimeHr);
1175
1176                 abs20.abs_RelTime = 0;
1177                 abs20.abs_Time = htolel((guint32)phdr->ts.secs - (guint32)(nsg_creltime/1000000000));
1178
1179                 /* Write the record into the file */
1180                 if (!wtap_dump_file_write(wdh, &abs20, nspr_abstime_v20_s, err))
1181                         return FALSE;
1182
1183                 /* Move forward the page offset */
1184                 nstrace->page_offset += nspr_abstime_v20_s;
1185
1186         } else
1187         {
1188                 g_assert_not_reached();
1189                 return FALSE;
1190         }
1191
1192         return TRUE;
1193 }
1194
1195
1196 /* Write a record for a packet to a dump file.
1197    Returns TRUE on success, FALSE on failure. */
1198 static gboolean nstrace_dump(wtap_dumper *wdh, const struct wtap_pkthdr *phdr,
1199     const union wtap_pseudo_header *pseudo_header, const guchar *pd, int *err)
1200 {
1201         nstrace_dump_t *nstrace = (nstrace_dump_t *)wdh->priv;
1202
1203         if (nstrace->page_offset == 0)
1204         {
1205                 /* Add the signature record and abs time record */
1206                 if (wdh->file_type == WTAP_FILE_NETSCALER_1_0)
1207                 {
1208                         if (!nstrace_add_signature(wdh, err) ||
1209                             !nstrace_add_abstime(wdh, phdr, pd, err))
1210                                 return FALSE;
1211                 } else if (wdh->file_type == WTAP_FILE_NETSCALER_2_0)
1212                 {
1213                         if (!nstrace_add_signature(wdh, err) ||
1214                             !nstrace_add_abstime(wdh, phdr, pd, err))
1215                                 return FALSE;
1216                 } else
1217                 {
1218                         g_assert_not_reached();
1219                         return FALSE;
1220                 }
1221         }
1222
1223         switch (pseudo_header->nstr.rec_type)
1224         {
1225         case NSPR_HEADER_VERSION100:
1226
1227                 if (wdh->file_type == WTAP_FILE_NETSCALER_1_0)
1228                 {
1229                         if (nstrace->page_offset + phdr->caplen >= nstrace->page_len)
1230                         {
1231                                 /* Start on the next page */
1232                                 if (fseek(wdh->fh, (nstrace->page_len - nstrace->page_offset), SEEK_CUR) == -1)
1233                                 {
1234                                         *err = errno;
1235                                         return FALSE;
1236                                 }
1237
1238                                 nstrace->page_offset = 0;
1239
1240                                 /* Possibly add signature and abstime records and increment offset */
1241                                 if (!nstrace_add_signature(wdh, err))
1242                                         return FALSE;
1243                         }
1244
1245                         /* Write the actual record as is */
1246                         if (!wtap_dump_file_write(wdh, pd, phdr->caplen, err))
1247                                 return FALSE;
1248
1249                         nstrace->page_offset += (guint16) phdr->caplen;
1250                 } else if (wdh->file_type == WTAP_FILE_NETSCALER_2_0)
1251                 {
1252                         *err = WTAP_ERR_UNSUPPORTED_FILE_TYPE;
1253                         return FALSE;
1254                 }
1255
1256                 break;
1257
1258         case NSPR_HEADER_VERSION200:
1259         case NSPR_HEADER_VERSION201:
1260         case NSPR_HEADER_VERSION202:
1261         case NSPR_HEADER_VERSION203:
1262
1263                 if (wdh->file_type == WTAP_FILE_NETSCALER_1_0)
1264                 {
1265                         *err = WTAP_ERR_UNSUPPORTED_FILE_TYPE;
1266                         return FALSE;
1267                 } else if (wdh->file_type == WTAP_FILE_NETSCALER_2_0)
1268                 {
1269                         if (nstrace->page_offset + phdr->caplen >= nstrace->page_len)
1270                         {
1271                                 /* Start on the next page */
1272                                 if (fseek(wdh->fh, (nstrace->page_len - nstrace->page_offset), SEEK_CUR) == -1)
1273                                 {
1274                                         *err = errno;
1275                                         return FALSE;
1276                                 }
1277
1278                                 nstrace->page_offset = 0;
1279
1280                                 /* Possibly add signature and abstime records and increment offset */
1281                                 if (!nstrace_add_signature(wdh, err))
1282                                         return FALSE;
1283                         }
1284
1285                         /* Write the actual record as is */
1286                         if (!wtap_dump_file_write(wdh, pd, phdr->caplen, err))
1287                                 return FALSE;
1288
1289                         nstrace->page_offset += (guint16) phdr->caplen;
1290                 }
1291
1292                 break;
1293
1294         default:
1295                 g_assert_not_reached();
1296                 return FALSE;
1297         }
1298
1299         return TRUE;
1300 }
1301