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