tools/ftsanity.py

   1 #!/usr/bin/env python
   2 """
   3 Check the sanity of field definitions in Wireshark.
   4 """
   5 import sys
   6
   7 try:
   8     from optparse import OptionParser
   9 except ImportError:
  10     sys.exit("Need python 2.3.")
  11
  12 try:
  13     import commands
  14 except ImportError:
  15     sys.exit("Need to run on Unix.")
  16
  17
  18 errors = 0
  19
  20 class Proto:
  21     """Data for a protocol."""
  22     def __init__(self, line):
  23         data = line.split("\t")
  24         assert len(data) == 3
  25         assert data[0] == "P"
  26         self.name = data[1]
  27         self.abbrev = data[2]
  28
  29 class Field:
  30     """Data for a field."""
  31     def __init__(self, line):
  32         data = line.split("\t")
  33         assert len(data) == 8
  34         assert data[0] == "F"
  35         self.name = data[1]
  36         self.abbrev = data[2]
  37         self.ftype = data[3]
  38         self.parent = data[4]
  39         self.blurb = data[5]
  40         self.base = data[6]
  41         self.bitmask = int(data[7])
  42
  43
  44
  45 def gather_data(tshark):
  46     """Calls tshark and gathers data."""
  47     cmd = "%s -G fields3" % (tshark,)
  48     (status, output) = commands.getstatusoutput(cmd)
  49
  50     if status != 0:
  51         sys.exit("Failed: " + cmd)
  52
  53     lines = output.split("\n")
  54     protos = [Proto(x) for x in lines if x[0] == "P"]
  55     fields = [Field(x) for x in lines if x[0] == "F"]
  56
  57     return protos, fields
  58
  59
  60 def check_fields(fields):
  61     """Looks for problems in field definitions."""
  62     global errors
  63     for field in fields:
  64         if field.bitmask != 0:
  65             if field.ftype.find("FT_UINT") != 0 and \
  66                     field.ftype.find("FT_INT") != 0 and \
  67                     field.ftype != "FT_BOOLEAN":
  68                 print "%s has a bitmask 0x%x but is type %s" % \
  69                         (field.abbrev, field.bitmask, field.ftype)
  70                 errors += 1
  71
  72 def run(tshark):
  73     """Run the tests."""
  74     global errors
  75     protos, fields = gather_data(tshark)
  76
  77     check_fields(fields)
  78
  79     if errors > 0:
  80         sys.exit("%d errors found" % (errors,))
  81     else:
  82         print "Success."
  83
  84 def main():
  85     """Parse the command-line."""
  86     usage = "%prog tshark"
  87     parser = OptionParser(usage=usage)
  88
  89     (options, args) = parser.parse_args()
  90
  91     if len(args) != 1:
  92         parser.error("Need location of tshark.")
  93
  94     run(args[0])
  95
  96 if __name__ == "__main__":
  97     main()