Skip to content

Commit

Permalink
Bug 1343417 - Verify bytecode documentation in js/src/vm/Opcodes.h in…
Browse files Browse the repository at this point in the history 
… make check. r=nbp
  • Loading branch information
@arai-a
arai-a committed Apr 3, 2017
1 parent ac0ae74 commit bdbfda6
Show file tree
Hide file tree
Showing 5 changed files with 422 additions and 277 deletions.
43 changes: 43 additions & 0 deletions config/check_js_opcode.py
View file
@@ -0,0 +1,43 @@
# vim: set ts=8 sts=4 et sw=4 tw=99:
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

#----------------------------------------------------------------------------
# This script checks bytecode documentation in js/src/vm/Opcodes.h
#----------------------------------------------------------------------------

from __future__ import print_function

import os
import sys

scriptname = os.path.basename(__file__);
topsrcdir = os.path.dirname(os.path.dirname(__file__))

def log_pass(text):
print('TEST-PASS | {} | {}'.format(scriptname, text))

def log_fail(text):
print('TEST-UNEXPECTED-FAIL | {} | {}'.format(scriptname, text))

def check_opcode():
sys.path.insert(0, os.path.join(topsrcdir, 'js', 'src', 'vm'))
import opcode

try:
opcode.get_opcodes(topsrcdir)
except Exception as e:
log_fail(e.args[0])

log_pass('ok')
return True

def main():
if not check_opcode():
sys.exit(1)

sys.exit(0)

if __name__ == '__main__':
main()
5 changes: 4 additions & 1 deletion js/src/Makefile.in
View file
Expand Up @@ -93,14 +93,17 @@ check-masm::
check-js-msg::
(cd $(topsrcdir) && $(PYTHON) $(topsrcdir)/config/check_js_msg_encoding.py);

check-opcode::
(cd $(topsrcdir) && $(PYTHON) $(topsrcdir)/config/check_js_opcode.py);

check-jit-test::
$(JITTEST_SANITIZER_ENV) $(wildcard $(RUN_TEST_PROGRAM)) $(PYTHON) -u $(srcdir)/jit-test/jit_test.py \
--no-slow --no-progress --format=automation --jitflags=all \
$(JITTEST_VALGRIND_FLAG) \
$(JITTEST_EXTRA_ARGS) \
$(DIST)/bin/$(JS_SHELL_NAME)$(BIN_SUFFIX) $(JITTEST_TEST_ARGS)

check:: check-style check-masm check-js-msg
check:: check-style check-masm check-js-msg check-opcode

check-jstests:
$(wildcard $(RUN_TEST_PROGRAM)) $(PYTHON) -u $(srcdir)/tests/jstests.py \
Expand Down
4 changes: 2 additions & 2 deletions js/src/vm/Opcodes.h
View file
Expand Up @@ -431,7 +431,7 @@
* Push a well-known symbol onto the operand stack.
* Category: Literals
* Type: Constants
* Operands: uint8_t n, the JS::SymbolCode of the symbol to use
* Operands: uint8_t symbol (the JS::SymbolCode of the symbol to use)
* Stack: => symbol
*/ \
macro(JSOP_SYMBOL, 45, "symbol", NULL, 2, 0, 1, JOF_UINT8) \
Expand Down Expand Up @@ -586,7 +586,7 @@
* Category: Literals
* Type: Constants
* Operands: uint32_t atomIndex
* Stack: => string
* Stack: => atom
*/ \
macro(JSOP_STRING, 61, "string", NULL, 5, 0, 1, JOF_ATOM) \
/*
Expand Down
290 changes: 16 additions & 274 deletions js/src/vm/make_opcode_doc.py
View file
Expand Up @@ -13,280 +13,14 @@
from __future__ import print_function
import re
import sys
from xml.sax.saxutils import escape

SOURCE_BASE = 'http://dxr.mozilla.org/mozilla-central/source'

def error(message):
print("Error: {message}".format(message=message), file=sys.stderr)
sys.exit(1)

quoted_pat = re.compile(r"([^A-Za-z0-9]|^)'([^']+)'")
js_pat = re.compile(r"([^A-Za-z0-9]|^)(JS[A-Z0-9_\*]+)")
def codify(text):
text = re.sub(quoted_pat, '\\1<code>\\2</code>', text)
text = re.sub(js_pat, '\\1<code>\\2</code>', text)

return text

space_star_space_pat = re.compile('^\s*\* ?', re.M)
def get_comment_body(comment):
return re.sub(space_star_space_pat, '', comment).split('\n')

def get_stack_count(stack):
if stack == "":
return 0
if '...' in stack:
return -1
return len(stack.split(','))

def parse_index(comment):
index = []
current_types = None
category_name = ''
category_pat = re.compile('\[([^\]]+)\]')
for line in get_comment_body(comment):
m = category_pat.search(line)
if m:
category_name = m.group(1)
if category_name == 'Index':
continue
current_types = []
index.append((category_name, current_types))
else:
type_name = line.strip()
if type_name and current_types is not None:
current_types.append((type_name, []))

return index

class OpcodeInfo:
def __init__(self):
self.name = ''
self.value = ''
self.length = ''
self.length_override = ''
self.nuses = ''
self.nuses_override = ''
self.ndefs = ''
self.ndefs_override = ''
self.flags = ''
self.operands = ''
self.stack_uses = ''
self.stack_defs = ''

self.desc = ''

self.category_name = ''
self.type_name = ''

self.group = []
self.sort_key = ''

def find_by_name(list, name):
for (n, body) in list:
if n == name:
return body

return None

def add_to_index(index, opcode):
types = find_by_name(index, opcode.category_name)
if types is None:
error("Category is not listed in index: "
"{name}".format(name=opcode.category_name))
opcodes = find_by_name(types, opcode.type_name)
if opcodes is None:
if opcode.type_name:
error("Type is not listed in {category}: "
"{name}".format(category=opcode.category_name,
name=opcode.type_name))
types.append((opcode.type_name, [opcode]))
return

opcodes.append(opcode)

def format_desc(descs):
current_type = ''
desc = ''
for (type, line) in descs:
if type != current_type:
if current_type:
desc += '</{name}>\n'.format(name=current_type)
current_type = type
if type:
desc += '<{name}>'.format(name=current_type)
if current_type:
desc += line + "\n"
if current_type:
desc += '</{name}>'.format(name=current_type)

return desc

tag_pat = re.compile('^\s*[A-Za-z]+:\s*|\s*$')
def get_tag_value(line):
return re.sub(tag_pat, '', line)

def get_opcodes(dir):
iter_pat = re.compile(r"/\*(.*?)\*/" # either a documentation comment...
r"|"
r"macro\(" # or a macro(...) call
r"([^,]+),\s*" # op
r"([0-9]+),\s*" # val
r"[^,]+,\s*" # name
r"[^,]+,\s*" # image
r"([0-9\-]+),\s*" # length
r"([0-9\-]+),\s*" # nuses
r"([0-9\-]+),\s*" # ndefs
r"([^\)]+)" # format
r"\)", re.S)
stack_pat = re.compile('^(.*?)\s*=>\s*(.*?)$')
import os
sys.path.insert(0, os.path.dirname(os.path.realpath(__file__)))
import opcode

index = []

opcode = OpcodeInfo()
merged = opcode

with open('{dir}/js/src/vm/Opcodes.h'.format(dir=dir), 'r') as f:
data = f.read()

for m in re.finditer(iter_pat, data):
comment = m.group(1)
name = m.group(2)

if comment:
if '[Index]' in comment:
index = parse_index(comment)
continue

if 'Operands:' not in comment:
continue

state = 'desc'
stack = ''
descs = []

for line in get_comment_body(comment):
if line.startswith(' Category:'):
state = 'category'
opcode.category_name = get_tag_value(line)
elif line.startswith(' Type:'):
state = 'type'
opcode.type_name = get_tag_value(line)
elif line.startswith(' Operands:'):
state = 'operands'
opcode.operands = get_tag_value(line)
elif line.startswith(' Stack:'):
state = 'stack'
stack = get_tag_value(line)
elif line.startswith(' len:'):
state = 'len'
opcode.length_override = get_tag_value(line)
elif line.startswith(' nuses:'):
state = 'nuses'
opcode.nuses_override = get_tag_value(line)
elif line.startswith(' ndefs:'):
state = 'ndefs'
opcode.ndefs_override = get_tag_value(line)
elif state == 'desc':
if line.startswith(' '):
descs.append(('pre', escape(line[1:])))
else:
line = line.strip()
if line == '':
descs.append(('', line))
else:
descs.append(('p', codify(escape(line))))
elif line.startswith(' '):
if state == 'operands':
opcode.operands += line.strip()
elif state == 'stack':
stack += line.strip()
elif state == 'len':
opcode.length_override += line.strip()
elif state == 'nuses':
opcode.nuses_override += line.strip()
elif state == 'ndefs':
opcode.ndefs_override += line.strip()

opcode.desc = format_desc(descs)

m2 = stack_pat.search(stack)
if m2:
opcode.stack_uses = m2.group(1)
opcode.stack_defs = m2.group(2)

merged = opcode
elif name and not name.startswith('JSOP_UNUSED'):
opcode.name = name
opcode.value = int(m.group(3))
opcode.length = m.group(4)
opcode.nuses = m.group(5)
opcode.ndefs = m.group(6)

flags = []
for flag in m.group(7).split('|'):
if flag != 'JOF_BYTE':
flags.append(flag.replace('JOF_', ''))
opcode.flags = ', '.join(flags)

if merged == opcode:
opcode.sort_key = opcode.name
if opcode.category_name == '':
error("Category is not specified for "
"{name}".format(name=opcode.name))
add_to_index(index, opcode)
else:
if merged.length != opcode.length:
error("length should be same for merged section: "
"{value1}({name1}) != "
"{value2}({name2})".format(name1=merged.name,
value1=merged.length,
name2=opcode.name,
value2=opcode.length))
if merged.nuses != opcode.nuses:
error("nuses should be same for merged section: "
"{value1}({name1}) != "
"{value2}({name2})".format(name1=merged.name,
value1=merged.nuses,
name2=opcode.name,
value2=opcode.nuses))
if merged.ndefs != opcode.ndefs:
error("ndefs should be same for merged section: "
"{value1}({name1}) != "
"{value2}({name2})".format(name1=merged.name,
value1=merged.ndefs,
name2=opcode.name,
value2=opcode.ndefs))
merged.group.append(opcode)
if opcode.name < merged.name:
merged.sort_key = opcode.name

# Verify stack notation.
nuses = int(merged.nuses)
ndefs = int(merged.ndefs)

stack_nuses = get_stack_count(merged.stack_uses)
stack_ndefs = get_stack_count(merged.stack_defs)

if nuses != -1 and stack_nuses != -1 and nuses != stack_nuses:
error("nuses should match stack notation: {name}: "
"{nuses} != {stack_nuses} "
"(stack_nuses)".format(name=name,
nuses=nuses,
stack_nuses=stack_nuses,
stack_uses=merged.stack_uses))
if ndefs != -1 and stack_ndefs != -1 and ndefs != stack_ndefs:
error("ndefs should match stack notation: {name}: "
"{ndefs} != {stack_ndefs} "
"(stack_ndefs)".format(name=name,
ndefs=ndefs,
stack_ndefs=stack_ndefs,
stack_defs=merged.stack_defs))

opcode = OpcodeInfo()
from xml.sax.saxutils import escape

return index
SOURCE_BASE = 'http://dxr.mozilla.org/mozilla-central/source'

def override(value, override_value):
if override_value != '':
Expand All @@ -295,10 +29,12 @@ def override(value, override_value):
return value

def format_flags(flags):
if flags == '':
flags = filter(lambda x: x != 'JOF_BYTE', flags)
if len(flags) == 0:
return ''

return ' ({flags})'.format(flags=flags)
flags = map(lambda x: x.replace('JOF_', ''), flags)
return ' ({flags})'.format(flags=', '.join(flags))

def print_opcode(opcode):
names_template = '{name} [-{nuses}, +{ndefs}]{flags}'
Expand Down Expand Up @@ -394,5 +130,11 @@ def print_doc(index):
file=sys.stderr)
sys.exit(1)
dir = sys.argv[1]
index = get_opcodes(dir)

try:
index, _ = opcode.get_opcodes(dir)
except Exception as e:
print("Error: {}".format(e.args[0]), file=sys.stderr)
sys.exit(1)

print_doc(index)

0 comments on commit bdbfda6

Please sign in to comment.