3 # Copyright (C) 2009 The Android Open Source Project
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
9 # http://www.apache.org/licenses/LICENSE-2.0
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.
18 Usage: merge-event-log-tags.py [-o output_file] [input_files...]
20 Merge together zero or more event-logs-tags files to produce a single
21 output file, stripped of comments. Checks that no tag numbers conflict
24 -h to display this usage message and exit.
42 pre_merged_file = None
44 # Tags with a tag number of ? are assigned a tag in the range
45 # [ASSIGN_START, ASSIGN_LIMIT).
47 ASSIGN_LIMIT = 1000000
50 opts, args = getopt.getopt(sys.argv[1:], "ho:m:")
51 except getopt.GetoptError, err:
65 print >> sys.stderr, "unhandled option %s" % (o,)
68 # Restrictions on tags:
70 # Tag names must be unique. (If the tag number and description are
71 # also the same, a warning is issued instead of an error.)
73 # Explicit tag numbers must be unique. (If the tag name is also the
74 # same, no error is issued because the above rule will issue a
82 for t in event_log_tags.TagFile(pre_merged_file).tags:
83 pre_merged_tags[t.tagname] = t
86 tagfile = event_log_tags.TagFile(fn)
88 for t in tagfile.tags:
91 description = t.description
93 if t.tagname in by_tagname:
94 orig = by_tagname[t.tagname]
96 # Allow an explicit tag number to define an implicit tag number
97 if orig.tagnum is None:
98 orig.tagnum = t.tagnum
99 elif t.tagnum is None:
100 t.tagnum = orig.tagnum
102 if (t.tagnum == orig.tagnum and
103 t.description == orig.description):
104 # if the name and description are identical, issue a warning
105 # instead of failing (to make it easier to move tags between
106 # projects without breaking the build).
107 tagfile.AddWarning("tag \"%s\" (%s) duplicated in %s:%d" %
108 (t.tagname, t.tagnum, orig.filename, orig.linenum),
112 "tag name \"%s\" used by conflicting tag %s from %s:%d" %
113 (t.tagname, orig.tagnum, orig.filename, orig.linenum),
117 if t.tagnum is not None and t.tagnum in by_tagnum:
118 orig = by_tagnum[t.tagnum]
120 if t.tagname != orig.tagname:
122 "tag number %d used by conflicting tag \"%s\" from %s:%d" %
123 (t.tagnum, orig.tagname, orig.filename, orig.linenum),
127 by_tagname[t.tagname] = t
128 if t.tagnum is not None:
129 by_tagnum[t.tagnum] = t
131 errors.extend(tagfile.errors)
132 warnings.extend(tagfile.warnings)
135 for fn, ln, msg in errors:
136 print >> sys.stderr, "%s:%d: error: %s" % (fn, ln, msg)
140 for fn, ln, msg in warnings:
141 print >> sys.stderr, "%s:%d: warning: %s" % (fn, ln, msg)
143 # Python's hash function (a) isn't great and (b) varies between
144 # versions of python. Using md5 is overkill here but is the same from
145 # platform to platform and speed shouldn't matter in practice.
147 d = hashlib.md5(str).digest()[:4]
148 return struct.unpack("!I", d)[0]
150 # Assign a tag number to all the entries that say they want one
151 # assigned. We do this based on a hash of the tag name so that the
152 # numbers should stay relatively stable as tags are added.
154 # If we were provided pre-merged tags (w/ the -m option), then don't
155 # ever try to allocate one, just fail if we don't have a number
157 for name, t in sorted(by_tagname.iteritems()):
161 t.tagnum = pre_merged_tags[t.tagname]
163 print >> sys.stderr, ("Error: Tag number not defined for tag `%s'."
164 +" Have you done a full build?") % t.tagname
168 x = (hashname(name) % (ASSIGN_LIMIT - ASSIGN_START - 1)) + ASSIGN_START
169 if x not in by_tagnum:
175 # by_tagnum should be complete now; we've assigned numbers to all tags.
177 buffer = cStringIO.StringIO()
178 for n, t in sorted(by_tagnum.iteritems()):
180 buffer.write("%d %s %s\n" % (t.tagnum, t.tagname, t.description))
182 buffer.write("%d %s\n" % (t.tagnum, t.tagname))
184 event_log_tags.WriteOutput(output_file, buffer)