rt/vm/src/main/java/org/apidesign/vm4brwsr/VM.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Thu, 22 May 2014 10:48:09 +0200
branchclosure
changeset 1584 7b6295731c30
parent 1583 89b6b369c13d
child 1587 bf08bd96d408
permissions -rw-r--r--
Static compilator demo is capable to load itself from individual extension files
     1 /**
     2  * Back 2 Browser Bytecode Translator
     3  * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
     4  *
     5  * This program is free software: you can redistribute it and/or modify
     6  * it under the terms of the GNU General Public License as published by
     7  * the Free Software Foundation, version 2 of the License.
     8  *
     9  * This program is distributed in the hope that it will be useful,
    10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12  * GNU General Public License for more details.
    13  *
    14  * You should have received a copy of the GNU General Public License
    15  * along with this program. Look for COPYING file in the top folder.
    16  * If not, see http://opensource.org/licenses/GPL-2.0.
    17  */
    18 package org.apidesign.vm4brwsr;
    19 
    20 import java.io.IOException;
    21 import java.io.InputStream;
    22 import org.apidesign.bck2brwsr.core.JavaScriptBody;
    23 import org.apidesign.vm4brwsr.ByteCodeParser.ClassData;
    24 import org.apidesign.vm4brwsr.ByteCodeParser.FieldData;
    25 import org.apidesign.vm4brwsr.ByteCodeParser.MethodData;
    26 
    27 /** Generator of JavaScript from bytecode of classes on classpath of the VM.
    28  *
    29  * @author Jaroslav Tulach <jtulach@netbeans.org>
    30  */
    31 abstract class VM extends ByteCodeToJavaScript {
    32     protected final ClassDataCache classDataCache;
    33 
    34     private final Bck2Brwsr.Resources resources;
    35     private final ExportedSymbols exportedSymbols;
    36     private final StringArray invokerMethods;
    37 
    38     private VM(Appendable out, Bck2Brwsr.Resources resources, StringArray explicitlyExported) {
    39         super(out);
    40         this.resources = resources;
    41         this.classDataCache = new ClassDataCache(resources);
    42         this.exportedSymbols = new ExportedSymbols(resources, explicitlyExported);
    43         this.invokerMethods = new StringArray();
    44     }
    45 
    46     static {
    47         // uses VMLazy to load dynamic classes
    48         boolean assertsOn = false;
    49         assert assertsOn = true;
    50         if (assertsOn) {
    51             VMLazy.init();
    52             ClassPath.init();
    53         }
    54     }
    55 
    56     @Override
    57     boolean debug(String msg) throws IOException {
    58         return false;
    59     }
    60     
    61     static void compile(Appendable out, 
    62         Bck2Brwsr config
    63     ) throws IOException {
    64         String[] both = config.classes().toArray();
    65         
    66         final StringArray fixedNames = new StringArray();
    67         fixedNames.add(Class.class.getName().replace('.', '/'));
    68         fixedNames.add(ArithmeticException.class.getName().replace('.', '/'));
    69         
    70         VM vm;
    71         if (config.isExtension()) {
    72             fixedNames.add(VM.class.getName().replace('.', '/'));
    73             vm = new Extension(out, config.getResources(), both, config.exported());
    74         } else {
    75             if (config.includeVM()) {
    76                 fixedNames.add(VM.class.getName().replace('.', '/'));
    77             }
    78             vm = new Standalone(out, config.getResources(), config.exported());
    79         }            
    80         vm.doCompile(fixedNames.addAndNew(both), config.allResources());
    81     }
    82 
    83     private void doCompile(StringArray names, StringArray asBinary) throws IOException {
    84         generatePrologue();
    85         append(
    86                 "\n  var invoker = {};");
    87         generateBody(names);
    88         for (String invokerMethod: invokerMethods.toArray()) {
    89             append("\n  invoker." + invokerMethod + " = function(target) {"
    90                 + "\n    return function() {"
    91                 + "\n      return target['" + invokerMethod + "'].apply(target, arguments);"
    92                 + "\n    };"
    93                 + "\n  };"
    94             );
    95         }
    96         
    97         for (String r : asBinary.toArray()) {
    98             append("\n  ").append(getExportsObject()).append("['registerResource']('");
    99             append(r).append("', '");
   100             InputStream is = this.resources.get(r);
   101             byte[] arr = new byte[is.available()];
   102             int offset = 0;
   103             for (;;) {
   104                 if (offset == arr.length) {
   105                     byte[] tmp = new byte[arr.length * 2];
   106                     System.arraycopy(arr, 0, tmp, 0, arr.length);
   107                     arr = tmp;
   108                 }
   109                 int len = is.read(arr, offset, arr.length - offset);
   110                 if (len == -1) {
   111                     break;
   112                 }
   113                 offset += len;
   114             }
   115             if (offset != arr.length) {
   116                 byte[] tmp = new byte[offset];
   117                 System.arraycopy(arr, 0, tmp, 0, offset);
   118                 arr = tmp;
   119             }
   120             append(btoa(arr));
   121             append("');");
   122         }
   123         
   124         append("\n");
   125         generateEpilogue();
   126     }
   127 
   128     @JavaScriptBody(args = { "arr" }, body = "return btoa(arr);")
   129     private static String btoa(byte[] arr) {
   130         return javax.xml.bind.DatatypeConverter.printBase64Binary(arr);
   131     }
   132 
   133     protected abstract void generatePrologue() throws IOException;
   134 
   135     protected abstract void generateEpilogue() throws IOException;
   136 
   137     protected abstract String getExportsObject();
   138 
   139     protected abstract boolean isExternalClass(String className);
   140 
   141     @Override
   142     protected final void declaredClass(ClassData classData, String mangledName)
   143             throws IOException {
   144         if (exportedSymbols.isExported(classData)) {
   145             append("\n").append(getExportsObject()).append("['")
   146                                                .append(mangledName)
   147                                                .append("'] = ")
   148                             .append(accessClass(mangledName))
   149                .append(";\n");
   150         }
   151     }
   152 
   153     protected String generateClass(String className) throws IOException {
   154         ClassData classData = classDataCache.getClassData(className);
   155         if (classData == null) {
   156             throw new IOException("Can't find class " + className);
   157         }
   158         return compile(classData);
   159     }
   160 
   161     @Override
   162     protected void declaredField(FieldData fieldData,
   163                                  String destObject,
   164                                  String mangledName) throws IOException {
   165         if (exportedSymbols.isExported(fieldData)) {
   166             exportMember(destObject, mangledName);
   167         }
   168     }
   169 
   170     @Override
   171     protected void declaredMethod(MethodData methodData,
   172                                   String destObject,
   173                                   String mangledName) throws IOException {
   174         if (isHierarchyExported(methodData)) {
   175             exportMember(destObject, mangledName);
   176         }
   177     }
   178 
   179     private void exportMember(String destObject, String memberName)
   180             throws IOException {
   181         append("\n").append(destObject).append("['")
   182                                            .append(memberName)
   183                                            .append("'] = ")
   184                         .append(destObject).append(".").append(memberName)
   185            .append(";\n");
   186     }
   187 
   188     private void generateBody(StringArray names) throws IOException {
   189         StringArray processed = new StringArray();
   190         StringArray initCode = new StringArray();
   191         StringArray skipClass = new StringArray();
   192         for (String baseClass : names.toArray()) {
   193             references.add(baseClass);
   194             for (;;) {
   195                 String name = null;
   196                 for (String n : references.toArray()) {
   197                     if (skipClass.contains(n)) {
   198                         continue;
   199                     }
   200                     if (processed.contains(n)) {
   201                         continue;
   202                     }
   203                     name = n;
   204                 }
   205                 if (name == null) {
   206                     break;
   207                 }
   208                 InputStream is = resources.get(name + ".class");
   209                 if (is == null) {
   210                     lazyReference(this, name);
   211                     skipClass.add(name);
   212                     continue;
   213                 }
   214                 try {
   215                     String ic = generateClass(name);
   216                     processed.add(name);
   217                     initCode.add(ic == null ? "" : ic);
   218                 } catch (RuntimeException ex) {
   219                     throw new IOException("Error while compiling " + name + "\n", ex);
   220                 }
   221             }
   222 
   223             for (String resource : scripts.toArray()) {
   224                 while (resource.startsWith("/")) {
   225                     resource = resource.substring(1);
   226                 }
   227                 InputStream emul = resources.get(resource);
   228                 if (emul == null) {
   229                     throw new IOException("Can't find " + resource);
   230                 }
   231                 readResource(emul, this);
   232             }
   233             scripts = new StringArray();
   234 
   235             StringArray toInit = StringArray.asList(references.toArray());
   236             toInit.reverse();
   237 
   238             for (String ic : toInit.toArray()) {
   239                 int indx = processed.indexOf(ic);
   240                 if (indx >= 0) {
   241                     final String theCode = initCode.toArray()[indx];
   242                     if (!theCode.isEmpty()) {
   243                         append(theCode).append("\n");
   244                     }
   245                     initCode.toArray()[indx] = "";
   246                 }
   247             }
   248         }
   249     }
   250 
   251     private static void readResource(InputStream emul, Appendable out) throws IOException {
   252         try {
   253             int state = 0;
   254             for (;;) {
   255                 int ch = emul.read();
   256                 if (ch == -1) {
   257                     break;
   258                 }
   259                 if (ch < 0 || ch > 255) {
   260                     throw new IOException("Invalid char in emulation " + ch);
   261                 }
   262                 switch (state) {
   263                     case 0: 
   264                         if (ch == '/') {
   265                             state = 1;
   266                         } else {
   267                             out.append((char)ch);
   268                         }
   269                         break;
   270                     case 1:
   271                         if (ch == '*') {
   272                             state = 2;
   273                         } else {
   274                             out.append('/').append((char)ch);
   275                             state = 0;
   276                         }
   277                         break;
   278                     case 2:
   279                         if (ch == '*') {
   280                             state = 3;
   281                         }
   282                         break;
   283                     case 3:
   284                         if (ch == '/') {
   285                             state = 0;
   286                         } else {
   287                             state = 2;
   288                         }
   289                         break;
   290                 }
   291             }
   292         } finally {
   293             emul.close();
   294         }
   295     }
   296 
   297     static String toString(String name) throws IOException {
   298         StringBuilder sb = new StringBuilder();
   299 //        compile(sb, name);
   300         return sb.toString().toString();
   301     }
   302 
   303     private StringArray scripts = new StringArray();
   304     private StringArray references = new StringArray();
   305     
   306     @Override
   307     protected boolean requireReference(String cn) {
   308         if (references.contains(cn)) {
   309             return false;
   310         }
   311         references.add(cn);
   312         return true;
   313     }
   314 
   315     @Override
   316     protected void requireScript(String resourcePath) {
   317         scripts.add(resourcePath);
   318     }
   319 
   320     @Override
   321     String assignClass(String className) {
   322         return "vm." + className + " = ";
   323     }
   324     
   325     @Override
   326     String accessClass(String className) {
   327         return "vm." + className;
   328     }
   329 
   330     @Override
   331     protected String accessField(String object, String mangledName,
   332                                  String[] fieldInfoName) throws IOException {
   333         final FieldData field =
   334                 classDataCache.findField(fieldInfoName[0],
   335                                          fieldInfoName[1],
   336                                          fieldInfoName[2]);
   337         return accessNonVirtualMember(object, mangledName,
   338                                       (field != null) ? field.cls : null);
   339     }
   340 
   341     @Override
   342     protected String accessStaticMethod(
   343                              String object,
   344                              String mangledName,
   345                              String[] fieldInfoName) throws IOException {
   346         final MethodData method =
   347                 classDataCache.findMethod(fieldInfoName[0],
   348                                           fieldInfoName[1],
   349                                           fieldInfoName[2]);
   350         return accessNonVirtualMember(object, mangledName,
   351                                       (method != null) ? method.cls : null);
   352     }
   353 
   354     @Override
   355     protected String accessVirtualMethod(
   356                              String object,
   357                              String mangledName,
   358                              String[] fieldInfoName) throws IOException {
   359         final ClassData referencedClass =
   360                 classDataCache.getClassData(fieldInfoName[0]);
   361         final MethodData method =
   362                 classDataCache.findMethod(referencedClass,
   363                                           fieldInfoName[1],
   364                                           fieldInfoName[2]);
   365 
   366         if ((method != null)
   367                 && !isExternalClass(method.cls.getClassName())
   368                 && (((method.access & ByteCodeParser.ACC_FINAL) != 0)
   369                         || ((referencedClass.getAccessFlags()
   370                                  & ByteCodeParser.ACC_FINAL) != 0)
   371                         || !isHierarchyExported(method))) {
   372             return object + "." + mangledName;
   373         }
   374 
   375         return accessThroughInvoker(object, mangledName);
   376     }
   377 
   378     private String accessThroughInvoker(String object, String mangledName) {
   379         if (!invokerMethods.contains(mangledName)) {
   380             invokerMethods.add(mangledName);
   381         }
   382         return "invoker." + mangledName + '(' + object + ')';
   383     }
   384 
   385     private boolean isHierarchyExported(final MethodData methodData)
   386             throws IOException {
   387         if (exportedSymbols.isExported(methodData)) {
   388             return true;
   389         }
   390         if ((methodData.access & (ByteCodeParser.ACC_PRIVATE
   391                                       | ByteCodeParser.ACC_STATIC)) != 0) {
   392             return false;
   393         }
   394 
   395         final ExportedMethodFinder exportedMethodFinder =
   396                 new ExportedMethodFinder(exportedSymbols);
   397 
   398         classDataCache.findMethods(
   399                 methodData.cls,
   400                 methodData.getName(),
   401                 methodData.getInternalSig(),
   402                 exportedMethodFinder);
   403 
   404         return (exportedMethodFinder.getFound() != null);
   405     }
   406 
   407     private String accessNonVirtualMember(String object,
   408                                           String mangledName,
   409                                           ClassData declaringClass) {
   410         return ((declaringClass != null)
   411                     && !isExternalClass(declaringClass.getClassName()))
   412                             ? object + "." + mangledName
   413                             : object + "['" + mangledName + "']";
   414     }
   415 
   416     private static final class ExportedMethodFinder
   417             implements ClassDataCache.TraversalCallback<MethodData> {
   418         private final ExportedSymbols exportedSymbols;
   419         private MethodData found;
   420 
   421         public ExportedMethodFinder(final ExportedSymbols exportedSymbols) {
   422             this.exportedSymbols = exportedSymbols;
   423         }
   424 
   425         @Override
   426         public boolean traverse(final MethodData methodData) {
   427             try {
   428                 if (exportedSymbols.isExported(methodData)) {
   429                     found = methodData;
   430                     return false;
   431                 }
   432             } catch (final IOException e) {
   433             }
   434 
   435             return true;
   436         }
   437 
   438         public MethodData getFound() {
   439             return found;
   440         }
   441     }
   442 
   443     private static final class Standalone extends VM {
   444         private Standalone(Appendable out, Bck2Brwsr.Resources resources, StringArray explicitlyExported) {
   445             super(out, resources, explicitlyExported);
   446         }
   447 
   448         @Override
   449         protected void generatePrologue() throws IOException {
   450             append("(function VM(global) {var fillInVMSkeleton = function(vm) {");
   451         }
   452 
   453         @Override
   454         protected void generateEpilogue() throws IOException {
   455             append(
   456                   "  return vm;\n"
   457                 + "  };\n"
   458                 + "  var extensions = [];\n"
   459                 + "  function replaceAll(s, target, replacement) {\n"
   460                 + "    var pos = 0;\n"
   461                 + "    for (;;) {\n"
   462                 + "      var indx = s.indexOf(target, pos);\n"
   463                 + "      if (indx === -1) {\n"
   464                 + "        return s;\n"
   465                 + "      }\n"
   466                 + "      pos = indx + replacement.length;\n"
   467                 + "      s = s.substring(0, indx) + replacement + s.substring(indx + target.length);\n"
   468                 + "    }\n"
   469                 + "  }\n"
   470                 + "  function mangleClass(name) {\n"
   471                 + "    name = replaceAll(name, '_', '_1');\n"
   472                 + "    name = replaceAll(name, '.', '_');\n"
   473                 + "    return name;\n"
   474                 + "  };\n"
   475                 + "  global.bck2brwsr = function() {\n"
   476                 + "    var args = Array.prototype.slice.apply(arguments);\n"
   477                 + "    var resources = {};\n"
   478                 + "    function registerResource(n, a64) {\n"
   479                 + "      var str = atob(a64);\n"
   480                 + "      var arr = [];\n"
   481                 + "      for (var i = 0; i < str.length; i++) {\n"
   482                 + "        var ch = str.charCodeAt(i) & 0xff;\n"
   483                 + "        if (ch > 127) ch -= 256;\n"
   484                 + "        arr.push(ch);\n"
   485                 + "      }\n"
   486                 + "      if (!resources[n]) resources[n] = [arr];\n"
   487                 + "      else resources[n].push(arr);\n"
   488                 + "    }\n"
   489                 + "    var vm = fillInVMSkeleton({ 'registerResource' : registerResource });\n"
   490                 + "    function initVM() {\n"
   491                 + "      var clsArray = vm['java_lang_reflect_Array'];\n"
   492                 + "      if (clsArray) clsArray(false);\n"
   493                 + "    }\n"
   494                 + "    for (var i = 0; i < extensions.length; ++i) {\n"
   495                 + "      extensions[i](vm);\n"
   496                 + "    }\n"
   497                 + "    vm['registerResource'] = null;\n"
   498                 + "    var knownExtensions = extensions.length;\n"
   499                 + "    var loader = {};\n"
   500                 + "    var loadBytes = function(name, skip) {\n"
   501                 + "      skip = typeof skip == 'number' ? skip : 0;\n"
   502                 + "      var arr = resources[name];\n"
   503                 + "      if (arr) {\n"
   504                 + "        var arrSize = arr.length;\n"
   505                 + "        if (skip < arrSize) return arr[skip];\n"
   506                 + "        skip -= arrSize;\n"
   507                 + "      } else {\n"
   508                 + "        var arrSize = 0;\n"
   509                 + "      };\n"
   510                 + "      for (var i = 0; i < args.length; i++) {\n"
   511                 + "        var at = args[i];\n"
   512                 + "        var ret;\n"
   513                 + "        if (typeof at === 'function') ret = at(name, skip);\n"
   514                 + "        else ret = vm['org_apidesign_vm4brwsr_ClassPath'](false).\n"
   515                 + "          loadBytes___3BLjava_lang_String_2Ljava_lang_Object_2II(name, args, i, skip);\n"
   516                 + "        if (ret !== null) return ret;\n"
   517                 + "      }\n"
   518                 + "      while (knownExtensions < extensions.length) {\n"
   519                 + "        vm['registerResource'] = registerResource;\n"
   520                 + "        extensions[knownExtensions++](vm);\n"
   521                 + "        vm['registerResource'] = null;\n"
   522                 + "        initVM();\n"
   523                 + "      }\n"
   524                 + "      var arr = resources[name];\n"
   525                 + "      return (arr && arr.length > arrSize) ? arr[arrSize] : null;\n"
   526                 + "    }\n"
   527                 + "    var reload = function(name, arr, keep) {;\n"
   528                 + "      if (!keep) {\n"
   529                 + "        var attr = mangleClass(name);\n"
   530                 + "        delete vm[attr];\n"
   531                 + "      }\n"
   532                 + "      return vm['org_apidesign_vm4brwsr_VMLazy'](false)\n"
   533                 + "        ['load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2_3B']\n"
   534                 + "        (vm, name, args, arr);\n"
   535                 + "    };\n"
   536                 + "    loader.loadClass = function(name) {\n"
   537                 + "      var attr = mangleClass(name);\n"
   538                 + "      var fn = vm[attr];\n"
   539                 + "      if (fn) return fn(false);\n"
   540                 + "      try {\n"
   541                 + "        var arr = loadBytes(replaceAll(name, '.', '/') + '.class');\n"
   542                 + "        return reload(name, arr, true);\n"
   543                 + "      } catch (err) {\n"
   544                 + "        fn = vm[attr];\n"
   545                 + "        if (fn) return fn(false);\n"
   546                 + "        throw err;\n"
   547                 + "      }\n"
   548                 + "    }\n"
   549                 + "    if (vm['loadClass']) {\n"
   550                 + "      throw 'Cannot initialize the bck2brwsr VM twice!';\n"
   551                 + "    }\n"
   552                 + "    vm['loadClass'] = loader.loadClass;\n"
   553                 + "    vm['_reload'] = reload;\n"
   554                 + "    vm['loadBytes'] = loadBytes;\n"
   555                 + "    initVM();\n"
   556                 + "    return loader;\n"
   557                 + "  };\n");
   558             append(
   559                   "  global.bck2brwsr.registerExtension = function(extension) {\n"
   560                 + "    extensions.push(extension);\n"
   561                 + "    return null;\n"
   562                 + "  };\n");
   563             append("}(this));");
   564         }
   565 
   566         @Override
   567         protected String getExportsObject() {
   568             return "vm";
   569         }
   570 
   571         @Override
   572         protected boolean isExternalClass(String className) {
   573             return false;
   574         }
   575     }
   576 
   577     private static final class Extension extends VM {
   578         private final StringArray extensionClasses;
   579 
   580         private Extension(Appendable out, Bck2Brwsr.Resources resources,
   581                           String[] extClassesArray, StringArray explicitlyExported) {
   582             super(out, resources, explicitlyExported);
   583             this.extensionClasses = StringArray.asList(extClassesArray);
   584         }
   585 
   586         @Override
   587         protected void generatePrologue() throws IOException {
   588             append("bck2brwsr.registerExtension(function(exports) {\n"
   589                            + "  var vm = {};\n");
   590             append("  function link(n) {\n"
   591                 + "    return function() {\n"
   592                 + "      var cls = n['replace__Ljava_lang_String_2CC']"
   593                                        + "('/', '_').toString();\n"
   594                 + "      var dot = n['replace__Ljava_lang_String_2CC']"
   595                                        + "('/', '.').toString();\n"
   596                 + "      exports.loadClass(dot);\n"
   597                 + "      vm[cls] = exports[cls];\n"
   598                 + "      return vm[cls](arguments);\n"
   599                 + "    };\n"
   600                 + "  };\n"
   601             );
   602         }
   603 
   604         @Override
   605         protected void generateEpilogue() throws IOException {
   606             append("});");
   607         }
   608 
   609         @Override
   610         protected String generateClass(String className) throws IOException {
   611             if (isExternalClass(className)) {
   612                 append("\n").append(assignClass(
   613                                             className.replace('/', '_')))
   614                    .append("link('")
   615                    .append(className)
   616                    .append("');");
   617 
   618                 return null;
   619             }
   620 
   621             return super.generateClass(className);
   622         }
   623 
   624         @Override
   625         protected String getExportsObject() {
   626             return "exports";
   627         }
   628 
   629         @Override
   630         protected boolean isExternalClass(String className) {
   631             return !extensionClasses.contains(className);
   632         }
   633     }
   634     
   635     private static void lazyReference(Appendable out, String n) throws IOException {
   636         String cls = n.replace('/', '_');
   637         String dot = n.replace('/', '.');
   638         
   639         out.append("\nvm.").append(cls).append(" = function() {");
   640         out.append("\n  var instance = arguments.length == 0 || arguments[0] === true;");
   641         out.append("\n  delete vm.").append(cls).append(";");
   642         out.append("\n  var c = vm.loadClass('").append(dot).append("');");
   643         out.append("\n  return vm.").append(cls).append("(instance);");
   644         out.append("\n}");
   645     }
   646 }