Allow PNaCl NMF to set translator optimization options for experimentation.

ppapi/native_client/src/trusted/plugin/json_manifest.cc

 /*
  * Copyright (c) 2012 The Chromium Authors. All rights reserved.
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 #include <algorithm>
 
 #include "native_client/src/trusted/plugin/json_manifest.h"
 
 #include <stdlib.h>
 
 #include "native_client/src/include/nacl_base.h"
 #include "native_client/src/include/nacl_macros.h"
 #include "native_client/src/include/nacl_string.h"
 #include "native_client/src/include/portability.h"
 #include "native_client/src/shared/platform/nacl_check.h"
 #include "native_client/src/trusted/plugin/plugin_error.h"
+#include "native_client/src/trusted/plugin/pnacl_options.h"
 #include "native_client/src/trusted/plugin/utility.h"
 #include "ppapi/cpp/dev/url_util_dev.h"
 #include "ppapi/cpp/var.h"
 #include "third_party/jsoncpp/source/include/json/reader.h"
 
 namespace plugin {
 
 namespace {
 // Top-level section name keys
 const char* const kProgramKey =     "program";
 const char* const kInterpreterKey = "interpreter";
 const char* const kFilesKey =       "files";
 
 // ISA Dictionary keys
 const char* const kX8632Key =       "x86-32";
 const char* const kX8664Key =       "x86-64";
 const char* const kArmKey =         "arm";
 const char* const kPortableKey =    "portable";
 
 // Url Resolution keys
 const char* const kPnaclTranslateKey = "pnacl-translate";
 const char* const kUrlKey =            "url";
 
-// Cache support keys
+// Pnacl keys
 const char* const kCacheIdentityKey = "sha256";
+const char* const kOptLevelKey = "-O";
+const char* const kPnaclExperimentalFlags = "experimental_flags";
 
 // Sample manifest file:
 // {
 //   "program": {
 //     "x86-32": {"url": "myprogram_x86-32.nexe"},
 //     "x86-64": {"url": "myprogram_x86-64.nexe"},
 //     "arm": {"url": "myprogram_arm.nexe"},
 //     "portable": {
 //       "pnacl-translate": {
 //         "url": "myprogram.pexe",
-//         "sha256": "..."
+//         "sha256": "...",
+//         "-O": 0
 //       }
 //     }
 //   },
 //   "interpreter": {
 //     "x86-32": {"url": "interpreter_x86-32.nexe"},
 //     "x86-64": {"url": "interpreter_x86-64.nexe"},
 //     "arm": {"url": "interpreter_arm.nexe"}
 //   },
 //   "files": {
 //     "foo.txt": {
@@ skipping 182 matching lines @@
       return false;
     }
   }
 
   // TODO(elijahtaylor) add ISA resolver here if we expand ISAs to include
   // micro-architectures that can resolve to multiple valid sandboxes.
   bool has_isa = dictionary.isMember(sandbox_isa);
   bool has_portable = dictionary.isMember(kPortableKey);
 
   if (!has_isa && !has_portable) {
-    error_info->SetReport(ERROR_MANIFEST_PROGRAM_MISSING_ARCH,
-                          nacl::string("manifest: no version of ") + parent_key+
+    error_info->SetReport(
+        ERROR_MANIFEST_PROGRAM_MISSING_ARCH,
+        nacl::string("manifest: no version of ") + parent_key +
         " given for current arch and no portable version found.");
     return false;
   }
 
   return true;
 }
 
-void GrabUrlAndCacheIdentity(const Json::Value& url_spec,
-                             nacl::string* url,
-                             nacl::string* cache_identity) {
+void GrabUrlAndPnaclOptions(const Json::Value& url_spec,
+                            nacl::string* url,
+                            PnaclOptions* pnacl_options) {
   *url = url_spec[kUrlKey].asString();
   if (url_spec.isMember(kCacheIdentityKey)) {
-    *cache_identity = url_spec[kCacheIdentityKey].asString();
+    pnacl_options->set_bitcode_hash(url_spec[kCacheIdentityKey].asString());
+  }
+  if (url_spec.isMember(kOptLevelKey)) {
+    uint32_t opt_raw = url_spec[kOptLevelKey].asUInt();
+    // Clamp the opt value to fit into an int8_t.
+    if (opt_raw > 3)
+      opt_raw = 3;
+    pnacl_options->set_opt_level(static_cast<int8_t>(opt_raw));
+  }
+  if (url_spec.isMember(kPnaclExperimentalFlags)) {
+    pnacl_options->set_experimental_flags(
+        url_spec[kPnaclExperimentalFlags].asString());
   }
 }
 
 bool GetURLFromISADictionary(const Json::Value& dictionary,
                              const nacl::string& parent_key,
                              const nacl::string& sandbox_isa,
                              bool prefer_portable,
                              nacl::string* url,
-                             nacl::string* cache_identity,
-                             ErrorInfo* error_info,
-                             bool* pnacl_translate) {
-  if (url == NULL || cache_identity == NULL ||
-      error_info == NULL || pnacl_translate == NULL)
+                             PnaclOptions* pnacl_options,
+                             ErrorInfo* error_info) {
+  if (url == NULL || pnacl_options == NULL || error_info == NULL)
     return false;
 
   if (!IsValidISADictionary(dictionary, parent_key, sandbox_isa, error_info))
     return false;
 
   *url = "";
-  *cache_identity = "";
-  *pnacl_translate = false;
 
   // The call to IsValidISADictionary() above guarantees that either
   // sandbox_isa or kPortableKey is present in the dictionary.
   bool has_portable = dictionary.isMember(kPortableKey);
   bool has_isa = dictionary.isMember(sandbox_isa);
   nacl::string chosen_isa;
   if ((has_portable && prefer_portable) || !has_isa) {
     chosen_isa = kPortableKey;
   } else {
     chosen_isa = sandbox_isa;
   }
   const Json::Value& isa_spec = dictionary[chosen_isa];
   // Check if this requires a pnacl-translate, otherwise just grab the URL.
   // We may have pnacl-translate for isa-specific bitcode for CPU tuning.
   if (isa_spec.isMember(kPnaclTranslateKey)) {
-    GrabUrlAndCacheIdentity(isa_spec[kPnaclTranslateKey], url, cache_identity);
-    *pnacl_translate = true;
+    GrabUrlAndPnaclOptions(isa_spec[kPnaclTranslateKey], url, pnacl_options);
+    pnacl_options->set_translate(true);
   } else {
-    GrabUrlAndCacheIdentity(isa_spec, url, cache_identity);
-    *pnacl_translate = false;
+    *url = isa_spec[kUrlKey].asString();
+    pnacl_options->set_translate(false);
   }
 
   return true;
 }
 
 bool GetKeyUrl(const Json::Value& dictionary,
                const nacl::string& key,
                const nacl::string& sandbox_isa,
                const Manifest* manifest,
                bool prefer_portable,
                nacl::string* full_url,
-               nacl::string* cache_identity,
-               ErrorInfo* error_info,
-               bool* pnacl_translate) {
+               PnaclOptions* pnacl_options,
+               ErrorInfo* error_info) {
   CHECK(full_url != NULL && error_info != NULL);
   if (!dictionary.isMember(key)) {
     error_info->SetReport(ERROR_MANIFEST_RESOLVE_URL,
                           "file key not found in manifest");
     return false;
   }
   const Json::Value& isa_dict = dictionary[key];
   nacl::string relative_url;
   if (!GetURLFromISADictionary(isa_dict, key, sandbox_isa, prefer_portable,
-                               &relative_url, cache_identity,
-                               error_info, pnacl_translate)) {
+                               &relative_url, pnacl_options, error_info)) {
     return false;
   }
   return manifest->ResolveURL(relative_url, full_url, error_info);
 }
 
 }  // namespace
 
 bool JsonManifest::Init(const nacl::string& manifest_json,
                         ErrorInfo* error_info) {
   if (error_info == NULL) {
@@ skipping 100 matching lines @@
         "could not resolve url '" + relative_url +
         "' relative to manifest base url '" + manifest_base_url_.c_str() +
         "'.");
     return false;
   }
   *full_url = resolved_url.AsString();
   return true;
 }
 
 bool JsonManifest::GetProgramURL(nacl::string* full_url,
-                                 nacl::string* cache_identity,
-                                 ErrorInfo* error_info,
-                                 bool* pnacl_translate) const {
-  if (full_url == NULL || cache_identity == NULL ||
-      error_info == NULL || pnacl_translate == NULL)
+                                 PnaclOptions* pnacl_options,
+                                 ErrorInfo* error_info) const {
+  if (full_url == NULL || pnacl_options == NULL || error_info == NULL)
     return false;
 
   Json::Value program = dictionary_[kProgramKey];
 
   nacl::string nexe_url;
   nacl::string error_string;
 
   if (!GetURLFromISADictionary(program,
                                kProgramKey,
                                sandbox_isa_,
                                prefer_portable_,
                                &nexe_url,
-                               cache_identity,
-                               error_info,
-                               pnacl_translate)) {
+                               pnacl_options,
+                               error_info)) {
     return false;
   }
 
   return ResolveURL(nexe_url, full_url, error_info);
 }
 
 bool JsonManifest::GetFileKeys(std::set<nacl::string>* keys) const {
   if (!dictionary_.isMember(kFilesKey)) {
     // trivial success: no keys when there is no "files" section.
     return true;
   }
   const Json::Value& files = dictionary_[kFilesKey];
   CHECK(files.isObject());
   Json::Value::Members members = files.getMemberNames();
   for (size_t i = 0; i < members.size(); ++i) {
     keys->insert(members[i]);
   }
   return true;
 }
 
 bool JsonManifest::ResolveKey(const nacl::string& key,
                               nacl::string* full_url,
-                              nacl::string* cache_identity,
-                              ErrorInfo* error_info,
-                              bool* pnacl_translate) const {
+                              PnaclOptions* pnacl_options,
+                              ErrorInfo* error_info) const {
   NaClLog(3, "JsonManifest::ResolveKey(%s)\n", key.c_str());
   // key must be one of kProgramKey or kFileKey '/' file-section-key
 
-  if (full_url == NULL || cache_identity == NULL ||
-      error_info == NULL || pnacl_translate == NULL)
+  if (full_url == NULL || pnacl_options == NULL || error_info == NULL)
     return false;
 
   if (key == kProgramKey) {
     return GetKeyUrl(dictionary_, key, sandbox_isa_, this, prefer_portable_,
-                     full_url, cache_identity, error_info, pnacl_translate);
+                     full_url, pnacl_options, error_info);
   }
   nacl::string::const_iterator p = find(key.begin(), key.end(), '/');
   if (p == key.end()) {
     error_info->SetReport(ERROR_MANIFEST_RESOLVE_URL,
                           nacl::string("ResolveKey: invalid key, no slash: ")
                           + key);
     return false;
   }
 
   // generalize to permit other sections?
@@ skipping 14 matching lines @@
         nacl::string("ResolveKey: no \"files\" dictionary"));
     return false;
   }
   if (!files.isMember(rest)) {
     error_info->SetReport(
         ERROR_MANIFEST_RESOLVE_URL,
         nacl::string("ResolveKey: no such \"files\" entry: ") + key);
     return false;
   }
   return GetKeyUrl(files, rest, sandbox_isa_, this, prefer_portable_,
-                   full_url, cache_identity, error_info, pnacl_translate);
+                   full_url, pnacl_options, error_info);
 }
 
 }  // namespace plugin