[GR-33179] Experimental bytecode interpreter

PullRequest: graalpython/2245

Author: msimacek

.gitignore

@@ -53,6 +53,7 @@ language
 /request_cache/
 /org.eclipse.jdt.core.prefs
 Python3.g4.stamp
+python.gram.stamp
 *.orig
 /*.diff
 /testenv

ci.jsonnet

@@ -1 +1 @@
-{ "overlay": "25178436615d9a3ee1cca03ec10f4d90fe66fe63" }
+{ "overlay": "a3f5acbe1104349cce9ec62e9b39f0c5c8403d92" }

docs/contributor/CONTRIBUTING.md

@@ -199,10 +199,14 @@ print its path as the last output, if successful.
 If you made changes to the parser, you may have to regenerate the golden files
 like so:
 
-    find graalpython -name *.scope -delete
-    find graalpython -name *.tast -delete
+    find graalpython -name '*.scope' -delete
+    find graalpython -name '*.tast' -delete
     mx punittest com.oracle.graal.python.test.parser
 
+If you made changes to the bytecode compiler, you may have to regenerate its golden files:
+
+    find graalpython -name '*.co' -delete
+    mx punittest com.oracle.graal.python.test.compiler
 
 ### Benchmarking
 

graalpython/com.oracle.graal.python.annotations/src/com/oracle/graal/python/annotations/GenerateEnumConstants.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * The Universal Permissive License (UPL), Version 1.0
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.oracle.graal.python.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Target;
+
+@Target(ElementType.TYPE)
+public @interface GenerateEnumConstants {
+}

graalpython/com.oracle.graal.python.benchmarks/python/harness.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2018, 2022, Oracle and/or its affiliates. All rights reserved.
 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 #
 # The Universal Permissive License (UPL), Version 1.0

graalpython/com.oracle.graal.python.benchmarks/python/meso/richards3.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # Copyright 2008-2010 Isaac Gouy
 # Copyright (c) 2013, 2014, Regents of the University of California
-# Copyright (c) 2017, 2021, Oracle and/or its affiliates.
+# Copyright (c) 2017, 2022, Oracle and/or its affiliates.
 # All rights reserved.
 #
 # Revised BSD license

graalpython/com.oracle.graal.python.benchmarks/python/micro/codeobject-interpretation.py

@@ -0,0 +1,136 @@
+# Copyright (c) 2021, 2022, Oracle and/or its affiliates. All rights reserved.
+# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+#
+# The Universal Permissive License (UPL), Version 1.0
+#
+# Subject to the condition set forth below, permission is hereby granted to any
+# person obtaining a copy of this software, associated documentation and/or
+# data (collectively the "Software"), free of charge and under any and all
+# copyright rights in the Software, and any and all patent rights owned or
+# freely licensable by each licensor hereunder covering either (i) the
+# unmodified Software as contributed to or provided by such licensor, or (ii)
+# the Larger Works (as defined below), to deal in both
+#
+# (a) the Software, and
+#
+# (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+# one is included with the Software each a "Larger Work" to which the Software
+# is contributed by such licensors),
+#
+# without restriction, including without limitation the rights to copy, create
+# derivative works of, display, perform, and distribute the Software and make,
+# use, sell, offer for sale, import, export, have made, and have sold the
+# Software and the Larger Work(s), and to sublicense the foregoing rights on
+# either these or other terms.
+#
+# This license is subject to the following condition:
+#
+# The above copyright notice and either this complete permission notice or at a
+# minimum a reference to the UPL must be included in all copies or substantial
+# portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+import marshal
+import pydoc_data.topics
+
+# pollute the profile of the bytecode loop
+exec("""
+import sys
+def foo(): pass
+len(sys.__name__)
+print(sys, flush=False)
+pass
+""")
+
+CODESTR1 = "\n".join(["""
+# import sys
+def foo(): pass
+len(foo.__name__)
+"""] * 100)
+
+CODESTR2 = "\n".join(["""
+def bar(): pass
+x = None
+len([])
+y = x
+"""] * 100)
+
+with open(pydoc_data.topics.__file__, "r") as f:
+    CODESTR3 = f.read()
+
+JUST_PYC_1 = marshal.dumps(compile(CODESTR1, "1", "exec"))
+JUST_PYC_2 = marshal.dumps(compile(CODESTR2, "2", "exec"))
+JUST_PYC_3 = marshal.dumps(compile(CODESTR3, pydoc_data.topics.__file__, "exec"))
+
+CODEOBJECTS = []
+
+
+def __setup__(num):
+    __cleanup__(num)
+
+
+def __cleanup__(num):
+    CODEOBJECTS.clear()
+    for _ in range(0, num, 3):
+        CODEOBJECTS.append(marshal.loads(JUST_PYC_1))
+        CODEOBJECTS.append(marshal.loads(JUST_PYC_2))
+        CODEOBJECTS.append(marshal.loads(JUST_PYC_3))
+
+
+def measure(num):
+    for i in range(num):
+        exec(CODEOBJECTS[i])
+
+
+def __benchmark__(num=2000):
+    measure(num)
+
+# I've written the bytecode benchmark to simulate loading thousands of modules. I
+# always execute thousands of iterations, to make it somewhat like loading a big
+# project with many pyc files, but not so large that the compiler would have time
+# to compile many of the operations involved in loading code.
+#
+# If we compare unmarshalling a code object from a bytes that has bytecode vs one
+# that has SST, we see that unmarshalling 10_000 bytecode code objects is 2-3x
+# faster than unmarshalling the SST. This is for two bits of code with 300 lines
+# of statements (creating functions, imports, assignments, calling
+# functions). This is just loading, not running. CPython on the same two codes is
+# more than 10x faster still.
+#
+# If we compare executing 10_000 times (cycling through the code objects so each
+# call target is not executed more than 10 times), the AST interpreter is faster
+# by around 20%.
+#
+# Loading artificial bytecode data with just dummy content (~2000 NOPs, PUSH/POP,
+# LOAD/STORE instructions...), CPython is ~15x faster unmarshalling it.
+#
+# Just opening files and reading their contents of that artificial bytecode data
+# (like the importlib would do with pyc files), CPython is ~13x faster than we
+# are. For CPython, this operation is 10x slower than unmarshalling the already
+# loaded bytes. For us the loading is ~8x slower than unmarshalling.
+#
+# Opening the files *and* loading the bytecode data yields that CPython is ~14x
+# faster than us.
+#
+# Now, if we preload that artificial code before the benchmark and just execute
+# those code objects 10_000 times, CPython is a whopping 20-30x faster than we
+# are. But the numbers are so small, it's hard to say (CPython 0.006-0.008s,
+# Graal 0.16-0.19s). OTOH, it's hard to argue that we would ever load more
+# modules than this during some application startup. Since this models quite well
+# what might happen when we load a big Python application consisting of many pyc
+# files, that seems a problem.
+#
+# Now, combining those: Loading + executing prepared bytes: is ~25-30x slower for
+# us than on CPython. Combining all three operations, CPython is 13-16x faster
+# than us. The large amount of time spent loading files helps us a little to skew
+# it into that ratio.
+#
+# The ratios don't quite add up, because doing more work also gives libgraal more
+# time to optimize parts of the work. It's still interesting, since this one-shot
+# loading of many pyc files is crucial for our perceived startup performance.

graalpython/com.oracle.graal.python.pegparser.generator/Makefile

@@ -0,0 +1,30 @@
+QUIETLY$(MX_VERBOSE) = @
+
+PARSER_PATH ?= ../com.oracle.graal.python.pegparser/src/com/oracle/graal/python/pegparser
+ifdef MX_PYTHON
+PYTHON_EXE ?= ${MX_PYTHON}
+else ifdef MX_PYTHON_VERSION
+PYTHON_EXE ?= python${MX_PYTHON_VERSION}
+else
+PYTHON_EXE ?= python3
+endif
+
+TARGET=${PARSER_PATH}/Parser.java
+
+GRAMMAR=${PARSER_PATH}/python.gram
+TOKENS=${PARSER_PATH}/Tokens
+
+PEGEN_FILES=$(shell find pegen pegjava -name '*.py')
+
+STAMP=${GRAMMAR}.stamp
+
+.PHONY: default clean
+default: ${STAMP}
+
+${STAMP}: ${GRAMMAR} ${TOKENS} ${PEGEN_FILES} main_parser_gen.py
+	$(QUIETLY) ${PYTHON_EXE} main_parser_gen.py ${GRAMMAR} ${TOKENS} ${TARGET}
+	$(QUIETLY) touch $@
+
+clean:
+	$(QUIETLY) rm -f ${TARGET}
+	$(QUIETLY) rm -f ${STAMP}