Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit abfbbe2e authored by Doug Zongker's avatar Doug Zongker
Browse files

allow EventLog tag numbers to be auto-assigned 

With this change, you can specify "?" in place of a tag number in a
.logtags file and the build system will assign numbers to these tags.
(The numbers used shouldn't matter since we translate them back to tag
names whenever the logs are read back.)

This is pretty straightforward to do:

- make merge-event-log-tags.py assign numbers to any tags that specify
  "?"

- make the generated java files depend on the merged output

- make java-event-log-tags.py read both the original .logtags and the
  merged output, and fill in tag numbers for any "?" using the merged
  version.

Change-Id: Icc6ccd705db461d570fc929922a830aa6deaca48
parent 4f71b8f4

core/base_rules.mk

+1 −1
Original line number Diff line number Diff line
@@ -220,7 +220,7 @@ ifneq ($(strip $(filter $(LOCAL_MODULE_CLASS),APPS JAVA_LIBRARIES)),) 
logtags_java_sources := $(patsubst %.logtags,%.java,$(addprefix $(intermediates.COMMON)/src/, $(logtags_sources)))

logtags_sources := $(addprefix $(TOP_DIR)$(LOCAL_PATH)/, $(logtags_sources))



$(logtags_java_sources): $(intermediates.COMMON)/src/%.java: $(TOPDIR)$(LOCAL_PATH)/%.logtags

$(logtags_java_sources): $(intermediates.COMMON)/src/%.java: $(TOPDIR)$(LOCAL_PATH)/%.logtags $(TARGET_OUT)/etc/event-log-tags

	$(transform-logtags-to-java)



endif

core/definitions.mk

+1 −1
Original line number Diff line number Diff line
@@ -752,7 +752,7 @@ endef 
define transform-logtags-to-java

@mkdir -p $(dir $@)

@echo "logtags: $@ <= $<"

$(hide) $(JAVATAGS) -o $@ $<

$(hide) $(JAVATAGS) -o $@ $^

endef

tools/event_log_tags.py

+8 −5
Original line number Diff line number Diff line
@@ -75,10 +75,13 @@ class TagFile(object): 
          self.options[parts[1]] = parts[2:]

          continue



        if parts[0] == "?":

          tag = None

        else:

          try:

            tag = int(parts[0])

          except ValueError:

          self.AddError("\"%s\" isn't an integer tag" % (parts[0],))

            self.AddError("\"%s\" isn't an integer tag or '?'" % (parts[0],))

            continue



        tagname = parts[1]

tools/java-event-log-tags.py

+13 −3
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ 
# limitations under the License.



"""

Usage: java-event-log-tags.py [-o output_file] <input_file>

Usage: java-event-log-tags.py [-o output_file] <input_file> <merged_tags_file>



Generate a java class containing constants for each of the event log

tags in the given input file.
@@ -50,14 +50,24 @@ for o, a in opts: 
    print >> sys.stderr, "unhandled option %s" % (o,)

    sys.exit(1)



if len(args) != 1:

  print "need exactly one input file, not %d" % (len(args),)

if len(args) != 2:

  print "need exactly two input files, not %d" % (len(args),)

  print __doc__

  sys.exit(1)



fn = args[0]

tagfile = event_log_tags.TagFile(fn)



# Load the merged tag file (which should have numbers assigned for all

# tags.  Use the numbers from the merged file to fill in any missing

# numbers from the input file.

merged_fn = args[1]

merged_tagfile = event_log_tags.TagFile(merged_fn)

merged_by_name = dict([(t.tagname, t) for t in merged_tagfile.tags])

for t in tagfile.tags:

  if t.tagnum is None:

    t.tagnum = merged_by_name[t.tagname].tagnum



if "java_package" not in tagfile.options:

  tagfile.AddError("java_package option not specified", linenum=0)

tools/merge-event-log-tags.py

+65 −12
Original line number Diff line number Diff line
@@ -26,16 +26,22 @@ and fails if they do. 


import cStringIO

import getopt

import md5

import struct

import sys



import event_log_tags



by_tagnum = {}

errors = []

warnings = []



output_file = None



# Tags with a tag number of ? are assigned a tag in the range

# [ASSIGN_START, ASSIGN_LIMIT).

ASSIGN_START = 900000

ASSIGN_LIMIT = 1000000



try:

  opts, args = getopt.getopt(sys.argv[1:], "ho:")

except getopt.GetoptError, err:
@@ -53,6 +59,18 @@ for o, a in opts: 
    print >> sys.stderr, "unhandled option %s" % (o,)

    sys.exit(1)



# Restrictions on tags:

#

#   Tag names must be unique.  (If the tag number and description are

#   also the same, a warning is issued instead of an error.)

#

#   Explicit tag numbers must be unique.  (If the tag name is also the

#   same, no error is issued because the above rule will issue a

#   warning or error.)



by_tagname = {}

by_tagnum = {}



for fn in args:

  tagfile = event_log_tags.TagFile(fn)
@@ -61,23 +79,36 @@ for fn in args: 
    tagname = t.tagname

    description = t.description



    if t.tagnum in by_tagnum:

      orig = by_tagnum[t.tagnum]

    if t.tagname in by_tagname:

      orig = by_tagname[t.tagname]



      if (t.tagname == orig.tagname and

      if (t.tagnum == orig.tagnum and

          t.description == orig.description):

        # if the name and description are identical, issue a warning

        # instead of failing (to make it easier to move tags between

        # projects without breaking the build).

        tagfile.AddWarning("tag %d \"%s\" duplicated in %s:%d" %

                           (t.tagnum, t.tagname, orig.filename, orig.linenum),

        tagfile.AddWarning("tag \"%s\" (%s) duplicated in %s:%d" %

                           (t.tagname, t.tagnum, orig.filename, orig.linenum),

                           linenum=t.linenum)

      else:

        tagfile.AddError("tag %d used by conflicting \"%s\" from %s:%d" %

        tagfile.AddError(

            "tag name \"%s\" used by conflicting tag %s from %s:%d" %

            (t.tagname, orig.tagnum, orig.filename, orig.linenum),

            linenum=t.linenum)

      continue



    if t.tagnum is not None and t.tagnum in by_tagnum:

      orig = by_tagnum[t.tagnum]



      if t.tagname != orig.tagname:

        tagfile.AddError(

            "tag number %d used by conflicting tag \"%s\" from %s:%d" %

            (t.tagnum, orig.tagname, orig.filename, orig.linenum),

            linenum=t.linenum)

        continue



    by_tagname[t.tagname] = t

    if t.tagnum is not None:

      by_tagnum[t.tagnum] = t



  errors.extend(tagfile.errors)
@@ -92,9 +123,31 @@ if warnings: 
  for fn, ln, msg in warnings:

    print >> sys.stderr, "%s:%d: warning: %s" % (fn, ln, msg)



# Python's hash function (a) isn't great and (b) varies between

# versions of python.  Using md5 is overkill here but is the same from

# platform to platform and speed shouldn't matter in practice.

def hashname(str):

  d = md5.md5(str).digest()[:4]

  return struct.unpack("!I", d)[0]



# Assign a tag number to all the entries that say they want one

# assigned.  We do this based on a hash of the tag name so that the

# numbers should stay relatively stable as tags are added.



for name, t in sorted(by_tagname.iteritems()):

  if t.tagnum is None:

    while True:

      x = (hashname(name) % (ASSIGN_LIMIT - ASSIGN_START)) + ASSIGN_START

      if x not in by_tagnum:

        t.tagnum = x

        by_tagnum[x] = t

        break

      name = "_" + name



# by_tagnum should be complete now; we've assigned numbers to all tags.



buffer = cStringIO.StringIO()

for n in sorted(by_tagnum):

  t = by_tagnum[n]

for n, t in sorted(by_tagnum.iteritems()):

  if t.description:

    buffer.write("%d %s %s\n" % (t.tagnum, t.tagname, t.description))

  else: