Write the magic number 0xf5f5dcdc into a script snapshot file and use this to distinguish whether a…

runtime/bin/dartutils.cc

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #include "bin/dartutils.h"
 
 #include "bin/extensions.h"
 #include "bin/directory.h"
 #include "bin/file.h"
 #include "bin/io_buffer.h"
 #include "include/dart_api.h"
 #include "platform/assert.h"
 #include "platform/globals.h"
 
 const char* DartUtils::original_working_directory = NULL;
 const char* DartUtils::kDartScheme = "dart:";
 const char* DartUtils::kDartExtensionScheme = "dart-ext:";
 const char* DartUtils::kAsyncLibURL = "dart:async";
 const char* DartUtils::kBuiltinLibURL = "dart:builtin";
 const char* DartUtils::kCoreLibURL = "dart:core";
 const char* DartUtils::kIOLibURL = "dart:io";
 const char* DartUtils::kIOLibPatchURL = "dart:io-patch";
 const char* DartUtils::kUriLibURL = "dart:uri";
 const char* DartUtils::kUtfLibURL = "dart:utf";
 
 const char* DartUtils::kIdFieldName = "_id";
 
+uint8_t DartUtils::magic_number[] = { 0xf5, 0xf5, 0xdc, 0xdc };
 
 static bool IsWindowsHost() {
 #if defined(TARGET_OS_WINDOWS)
   return true;
 #else  // defined(TARGET_OS_WINDOWS)
   return false;
 #endif  // defined(TARGET_OS_WINDOWS)
 }
 
 
@@ skipping 142 matching lines @@
   }
   // Calculate the canonical path.
   const char* canon_url_str = GetCanonicalPath(library_url_str, url_str);
   Dart_Handle canon_url = NewString(canon_url_str);
   free(const_cast<char*>(canon_url_str));
 
   return canon_url;
 }
 
 
-Dart_Handle DartUtils::ReadStringFromFile(const char* filename) {
+static const uint8_t* ReadFile(const char* filename,
+                               intptr_t* file_len,
+                               const char** error_msg) {
   File* file = File::Open(filename, File::kRead);
   if (file == NULL) {
     const char* format = "Unable to open file: %s";
     intptr_t len = snprintf(NULL, 0, format, filename);
     // TODO(iposva): Allocate from the zone instead of leaking error string
     // here. On the other hand the binary is about the exit anyway.
-    char* error_msg = reinterpret_cast<char*>(malloc(len + 1));
-    snprintf(error_msg, len + 1, format, filename);
+    char* msg = reinterpret_cast<char*>(malloc(len + 1));
+    snprintf(msg, len + 1, format, filename);
+    *error_msg = msg;
+    return NULL;
+  }
+  *file_len = file->Length();
+  uint8_t* text_buffer = reinterpret_cast<uint8_t*>(malloc(*file_len));
+  if (text_buffer == NULL) {
+    delete file;
+    *error_msg = "Unable to allocate buffer";
+    return NULL;
+  }
+  if (!file->ReadFully(text_buffer, *file_len)) {
+    delete file;
+    free(text_buffer);
+    *error_msg = "Unable to fully read contents";
+    return NULL;
+  }
+  delete file;
+  return text_buffer;
+}
+
+
+Dart_Handle DartUtils::ReadStringFromFile(const char* filename) {
+  const char* error_msg = NULL;
+  intptr_t len;
+  const uint8_t* text_buffer = ReadFile(filename, &len, &error_msg);
+  if (text_buffer == NULL) {
     return Dart_Error(error_msg);
   }
-  intptr_t len = file->Length();
-  uint8_t* text_buffer = reinterpret_cast<uint8_t*>(malloc(len));
-  if (text_buffer == NULL) {
-    delete file;
-    return Dart_Error("Unable to allocate buffer");
-  }
-  if (!file->ReadFully(text_buffer, len)) {
-    delete file;
-    free(text_buffer);
-    return Dart_Error("Unable to fully read contents");
-  }
-  delete file;
   Dart_Handle str = Dart_NewStringFromUTF8(text_buffer, len);
-  free(text_buffer);
   return str;
 }
 
 
 Dart_Handle DartUtils::ResolveScriptUri(Dart_Handle script_uri,
                                         Dart_Handle builtin_lib) {
   const int kNumArgs = 3;
   Dart_Handle dart_args[kNumArgs];
   dart_args[0] = NewString(original_working_directory);
   dart_args[1] = script_uri;
@@ skipping 93 matching lines @@
   }
   result = DartUtils::LoadSource(NULL,
                                  library,
                                  url,
                                  tag,
                                  url_string);
   return result;
 }
 
 
-static Dart_Handle ReadSource(Dart_Handle script_uri,
-                              Dart_Handle builtin_lib) {
-  Dart_Handle script_path = DartUtils::FilePathFromUri(script_uri, builtin_lib);
-  if (Dart_IsError(script_path)) {
-    return script_path;
+const uint8_t* DartUtils::SniffForMagicNumber(const uint8_t* text_buffer,
+                                              bool* is_snapshot) {
+  intptr_t len = sizeof(magic_number);
+  for (intptr_t i = 0; i < len; i++) {
+    if (text_buffer[i] != magic_number[i]) {
+      *is_snapshot = false;
+      return text_buffer;
+    }
   }
-  const char* script_path_cstr;
-  Dart_StringToCString(script_path, &script_path_cstr);
-  Dart_Handle source = DartUtils::ReadStringFromFile(script_path_cstr);
-  return source;
+  *is_snapshot = true;
+  return text_buffer + len;
+}
+
+
+void DartUtils::WriteMagicNumber(File* file) {
+  // Write a magic number and version information into the snapshot file.
+  bool bytes_written = file->WriteFully(magic_number, sizeof(magic_number));
+  ASSERT(bytes_written);
 }
 
 
 Dart_Handle DartUtils::LoadScript(const char* script_uri,
                                   Dart_Handle builtin_lib) {
   Dart_Handle resolved_script_uri;
   resolved_script_uri = ResolveScriptUri(NewString(script_uri), builtin_lib);
   if (Dart_IsError(resolved_script_uri)) {
     return resolved_script_uri;
   }
-  Dart_Handle source = ReadSource(resolved_script_uri, builtin_lib);
-  if (Dart_IsError(source)) {
-    return source;
+  Dart_Handle script_path = DartUtils::FilePathFromUri(resolved_script_uri,

[Ivan Posva, 2013/03/20 06:18:00]

Does this mean that script snapshots can be loaded from URIs recognized by the
standalone VM?

[siva, 2013/03/20 20:57:20]

Yes, that was the intent. I wanted to make the code as uniform as possible for
both the regular script and script snapshot case.

On 2013/03/20 06:18:00, Ivan Posva wrote:

+                                                       builtin_lib);
+  if (Dart_IsError(script_path)) {
+    return script_path;
   }
-  return Dart_LoadEmbeddedScript(resolved_script_uri, source, 0, 0);
+  const char* script_path_cstr;
+  Dart_StringToCString(script_path, &script_path_cstr);
+  const char* error_msg = NULL;
+  intptr_t len;
+  const uint8_t* text_buffer = ReadFile(script_path_cstr, &len, &error_msg);
+  if (text_buffer == NULL) {
+    return Dart_Error(error_msg);
+  }
+  bool is_snapshot = false;
+  text_buffer = SniffForMagicNumber(text_buffer, &is_snapshot);
+  if (is_snapshot) {
+    return Dart_LoadScriptFromSnapshot(text_buffer);

[Ivan Posva, 2013/03/20 06:18:00]

I am wondering whether we should be passing the length of the buffer as well to
make sure it matches the expected length.

[siva, 2013/03/20 20:57:20]

Done.

+  } else {
+    Dart_Handle source = Dart_NewStringFromUTF8(text_buffer, len);
+    return Dart_LoadEmbeddedScript(resolved_script_uri, source, 0, 0);
+  }
 }
 
 
 Dart_Handle DartUtils::LoadSource(CommandLineOptions* url_mapping,
                                   Dart_Handle library,
                                   Dart_Handle url,
                                   Dart_LibraryTag tag,
                                   const char* url_string) {
   if (url_mapping != NULL && IsDartSchemeURL(url_string)) {
     const char* mapped_url_string = MapLibraryUrl(url_mapping, url_string);
@@ skipping 331 matching lines @@
 
 CObject* CObject::NewOSError(OSError* os_error) {
   CObject* error_message =
       new CObjectString(CObject::NewString(os_error->message()));
   CObjectArray* result = new CObjectArray(CObject::NewArray(3));
   result->SetAt(0, new CObjectInt32(CObject::NewInt32(kOSError)));
   result->SetAt(1, new CObjectInt32(CObject::NewInt32(os_error->code())));
   result->SetAt(2, error_message);
   return result;
 }