merge-event-log-tags.py revision abfbbe2e1dc0d8dc01b87492427c670dab70f81f 
1#!/usr/bin/env python
2#
3# Copyright (C) 2009 The Android Open Source Project
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9#      http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16
17"""
18Usage: merge-event-log-tags.py [-o output_file] [input_files...]
19
20Merge together zero or more event-logs-tags files to produce a single
21output file, stripped of comments.  Checks that no tag numbers conflict
22and fails if they do.
23
24-h to display this usage message and exit.
25"""
26
27import cStringIO
28import getopt
29import md5
30import struct
31import sys
32
33import event_log_tags
34
35errors = []
36warnings = []
37
38output_file = None
39
40# Tags with a tag number of ? are assigned a tag in the range
41# [ASSIGN_START, ASSIGN_LIMIT).
42ASSIGN_START = 900000
43ASSIGN_LIMIT = 1000000
44
45try:
46  opts, args = getopt.getopt(sys.argv[1:], "ho:")
47except getopt.GetoptError, err:
48  print str(err)
49  print __doc__
50  sys.exit(2)
51
52for o, a in opts:
53  if o == "-h":
54    print __doc__
55    sys.exit(2)
56  elif o == "-o":
57    output_file = a
58  else:
59    print >> sys.stderr, "unhandled option %s" % (o,)
60    sys.exit(1)
61
62# Restrictions on tags:
63#
64#   Tag names must be unique.  (If the tag number and description are
65#   also the same, a warning is issued instead of an error.)
66#
67#   Explicit tag numbers must be unique.  (If the tag name is also the
68#   same, no error is issued because the above rule will issue a
69#   warning or error.)
70
71by_tagname = {}
72by_tagnum = {}
73
74for fn in args:
75  tagfile = event_log_tags.TagFile(fn)
76
77  for t in tagfile.tags:
78    tagnum = t.tagnum
79    tagname = t.tagname
80    description = t.description
81
82    if t.tagname in by_tagname:
83      orig = by_tagname[t.tagname]
84
85      if (t.tagnum == orig.tagnum and
86          t.description == orig.description):
87        # if the name and description are identical, issue a warning
88        # instead of failing (to make it easier to move tags between
89        # projects without breaking the build).
90        tagfile.AddWarning("tag \"%s\" (%s) duplicated in %s:%d" %
91                           (t.tagname, t.tagnum, orig.filename, orig.linenum),
92                           linenum=t.linenum)
93      else:
94        tagfile.AddError(
95            "tag name \"%s\" used by conflicting tag %s from %s:%d" %
96            (t.tagname, orig.tagnum, orig.filename, orig.linenum),
97            linenum=t.linenum)
98      continue
99
100    if t.tagnum is not None and t.tagnum in by_tagnum:
101      orig = by_tagnum[t.tagnum]
102
103      if t.tagname != orig.tagname:
104        tagfile.AddError(
105            "tag number %d used by conflicting tag \"%s\" from %s:%d" %
106            (t.tagnum, orig.tagname, orig.filename, orig.linenum),
107            linenum=t.linenum)
108        continue
109
110    by_tagname[t.tagname] = t
111    if t.tagnum is not None:
112      by_tagnum[t.tagnum] = t
113
114  errors.extend(tagfile.errors)
115  warnings.extend(tagfile.warnings)
116
117if errors:
118  for fn, ln, msg in errors:
119    print >> sys.stderr, "%s:%d: error: %s" % (fn, ln, msg)
120  sys.exit(1)
121
122if warnings:
123  for fn, ln, msg in warnings:
124    print >> sys.stderr, "%s:%d: warning: %s" % (fn, ln, msg)
125
126# Python's hash function (a) isn't great and (b) varies between
127# versions of python.  Using md5 is overkill here but is the same from
128# platform to platform and speed shouldn't matter in practice.
129def hashname(str):
130  d = md5.md5(str).digest()[:4]
131  return struct.unpack("!I", d)[0]
132
133# Assign a tag number to all the entries that say they want one
134# assigned.  We do this based on a hash of the tag name so that the
135# numbers should stay relatively stable as tags are added.
136
137for name, t in sorted(by_tagname.iteritems()):
138  if t.tagnum is None:
139    while True:
140      x = (hashname(name) % (ASSIGN_LIMIT - ASSIGN_START)) + ASSIGN_START
141      if x not in by_tagnum:
142        t.tagnum = x
143        by_tagnum[x] = t
144        break
145      name = "_" + name
146
147# by_tagnum should be complete now; we've assigned numbers to all tags.
148
149buffer = cStringIO.StringIO()
150for n, t in sorted(by_tagnum.iteritems()):
151  if t.description:
152    buffer.write("%d %s %s\n" % (t.tagnum, t.tagname, t.description))
153  else:
154    buffer.write("%d %s\n" % (t.tagnum, t.tagname))
155
156event_log_tags.WriteOutput(output_file, buffer)
157