/* Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#include "precompiled.hpp"

#include "ci/ciMethodData.hpp"

#include "ci/ciReplay.hpp"

#include "ci/ciUtilities.hpp"

#include "compiler/compileBroker.hpp"

#include "memory/allocation.inline.hpp"

#include "memory/oopFactory.hpp"

#include "memory/resourceArea.hpp"

#include "utilities/copy.hpp"

#include "utilities/macros.hpp"

#ifndef PRODUCT

// ciReplay

typedef struct _ciMethodDataRecord {

  const char* klass;

  const char* method;

  const char* signature;

  int state;

  int current_mileage;

  intptr_t* data;

  int data_length;

  char* orig_data;

  int orig_data_length;

  int oops_length;

  jobject* oops_handles;

  int* oops_offsets;

} ciMethodDataRecord;

typedef struct _ciMethodRecord {

  const char* klass;

  const char* method;

  const char* signature;

  int instructions_size;

  int interpreter_invocation_count;

  int interpreter_throwout_count;

  int invocation_counter;

  int backedge_counter;

} ciMethodRecord;

class CompileReplay;

static CompileReplay* replay_state;

class CompileReplay : public StackObj {

 private:

  FILE*   stream;

  Thread* thread;

  Handle  protection_domain;

  Handle  loader;

  GrowableArray<ciMethodRecord*>     ci_method_records;

  GrowableArray<ciMethodDataRecord*> ci_method_data_records;

  const char* _error_message;

  char* bufptr;

  char* buffer;

  int   buffer_length;

  int   buffer_end;

  int   line_no;

 public:

  CompileReplay(const char* filename, TRAPS) {

    thread = THREAD;

    loader = Handle(thread, SystemDictionary::java_system_loader());

    stream = fopen(filename, "rt");

    if (stream == NULL) {

      fprintf(stderr, "ERROR: Can't open replay file %s\n", filename);

    }

    buffer_length = 32;

    buffer = NEW_RESOURCE_ARRAY(char, buffer_length);

    _error_message = NULL;

    test();

  }

  ~CompileReplay() {

    if (stream != NULL) fclose(stream);

  }

  void test() {

    strcpy(buffer, "1 2 foo 4 bar 0x9 \"this is it\"");

    bufptr = buffer;

    assert(parse_int("test") == 1, "what");

    assert(parse_int("test") == 2, "what");

    assert(strcmp(parse_string(), "foo") == 0, "what");

    assert(parse_int("test") == 4, "what");

    assert(strcmp(parse_string(), "bar") == 0, "what");

    assert(parse_intptr_t("test") == 9, "what");

    assert(strcmp(parse_quoted_string(), "this is it") == 0, "what");

  }

  bool had_error() {

    return _error_message != NULL || thread->has_pending_exception();

  }

  bool can_replay() {

    return !(stream == NULL || had_error());

  }

  void report_error(const char* msg) {

    _error_message = msg;

    // Restore the buffer contents for error reporting

    for (int i = 0; i < buffer_end; i++) {

      if (buffer[i] == '\0') buffer[i] = ' ';

    }

  }

  int parse_int(const char* label) {

    if (had_error()) {

      return 0;

    }

    int v = 0;

    int read;

    if (sscanf(bufptr, "%i%n", &v, &read) != 1) {

      report_error(label);

    } else {

      bufptr += read;

    }

    return v;

  }

  intptr_t parse_intptr_t(const char* label) {

    if (had_error()) {

      return 0;

    }

    intptr_t v = 0;

    int read;

    if (sscanf(bufptr, INTPTR_FORMAT "%n", &v, &read) != 1) {

      report_error(label);

    } else {

      bufptr += read;

    }

    return v;

  }

  void skip_ws() {

    // Skip any leading whitespace

    while (*bufptr == ' ' || *bufptr == '\t') {

      bufptr++;

    }

  }

  char* scan_and_terminate(char delim) {

    char* str = bufptr;

    while (*bufptr != delim && *bufptr != '\0') {

      bufptr++;

    }

    if (*bufptr != '\0') {

      *bufptr++ = '\0';

    }

    if (bufptr == str) {

      // nothing here

      return NULL;

    }

    return str;

  }

  char* parse_string() {

    if (had_error()) return NULL;

    skip_ws();

    return scan_and_terminate(' ');

  }

  char* parse_quoted_string() {

    if (had_error()) return NULL;

    skip_ws();

    if (*bufptr == '"') {

      bufptr++;

      return scan_and_terminate('"');

    } else {

      return scan_and_terminate(' ');

    }

  }

  const char* parse_escaped_string() {

    char* result = parse_quoted_string();

    if (result != NULL) {

      unescape_string(result);

    }

    return result;

  }

  // Look for the tag 'tag' followed by an

  bool parse_tag_and_count(const char* tag, int& length) {

    const char* t = parse_string();

    if (t == NULL) {

      return false;

    }

    if (strcmp(tag, t) != 0) {

      report_error(tag);

      return false;

    }

    length = parse_int("parse_tag_and_count");

    return !had_error();

  }

  // Parse a sequence of raw data encoded as bytes and return the

  // resulting data.

  char* parse_data(const char* tag, int& length) {

    if (!parse_tag_and_count(tag, length)) {

      return NULL;

    }

    char * result = NEW_RESOURCE_ARRAY(char, length);

    for (int i = 0; i < length; i++) {

      int val = parse_int("data");

      result[i] = val;

    }

    return result;

  }

  // Parse a standard chunk of data emitted as:

  //   'tag' <length> # # ...

  // Where each # is an intptr_t item

  intptr_t* parse_intptr_data(const char* tag, int& length) {

    if (!parse_tag_and_count(tag, length)) {

      return NULL;

    }

    intptr_t* result = NEW_RESOURCE_ARRAY(intptr_t, length);

    for (int i = 0; i < length; i++) {

      skip_ws();

      intptr_t val = parse_intptr_t("data");

      result[i] = val;

    }

    return result;

  }

  // Parse a possibly quoted version of a symbol into a symbolOop

  Symbol* parse_symbol(TRAPS) {

    const char* str = parse_escaped_string();

    if (str != NULL) {

      Symbol* sym = SymbolTable::lookup(str, (int)strlen(str), CHECK_NULL);

      return sym;

    }

    return NULL;

  }

  // Parse a valid klass name and look it up

  Klass* parse_klass(TRAPS) {

    const char* str = parse_escaped_string();

    Symbol* klass_name = SymbolTable::lookup(str, (int)strlen(str), CHECK_NULL);

    if (klass_name != NULL) {

      Klass* k = SystemDictionary::resolve_or_fail(klass_name, loader, protection_domain, true, THREAD);

      if (HAS_PENDING_EXCEPTION) {

        oop throwable = PENDING_EXCEPTION;

        java_lang_Throwable::print(throwable, tty);

        tty->cr();

        report_error(str);

        return NULL;

      }

      return k;

    }

    return NULL;

  }

  // Lookup a klass

  Klass* resolve_klass(const char* klass, TRAPS) {

    Symbol* klass_name = SymbolTable::lookup(klass, (int)strlen(klass), CHECK_NULL);

    return SystemDictionary::resolve_or_fail(klass_name, loader, protection_domain, true, CHECK_NULL);

  }

  // Parse the standard tuple of <klass> <name> <signature>

  Method* parse_method(TRAPS) {

    InstanceKlass* k = (InstanceKlass*)parse_klass(CHECK_NULL);

    Symbol* method_name = parse_symbol(CHECK_NULL);

    Symbol* method_signature = parse_symbol(CHECK_NULL);

    Method* m = k->find_method(method_name, method_signature);

    if (m == NULL) {

    }

    return m;

  }

  // Process each line of the replay file executing each command until

  // the file ends.

  void process(TRAPS) {

    line_no = 1;

    int pos = 0;

    int c = getc(stream);

    while(c != EOF) {

      if (pos + 1 >= buffer_length) {

        int newl = buffer_length * 2;

        char* newb = NEW_RESOURCE_ARRAY(char, newl);

        memcpy(newb, buffer, pos);

        buffer = newb;

        buffer_length = newl;

      }

      if (c == '\n') {

        // null terminate it, reset the pointer and process the line

        buffer[pos] = '\0';

        buffer_end = pos++;

        bufptr = buffer;

        process_command(CHECK);

        if (had_error()) {

          tty->print_cr("Error while parsing line %d: %s\n", line_no, _error_message);

          tty->print_cr("%s", buffer);

          return;

        }

        pos = 0;

        buffer_end = 0;

        line_no++;

      } else if (c == '\r') {

        // skip LF

      } else {

        buffer[pos++] = c;

      }

      c = getc(stream);

    }

  }

  void process_command(TRAPS) {

    char* cmd = parse_string();

    if (cmd == NULL) {

      return;

    }

    if (strcmp("#", cmd) == 0) {

      // ignore

    } else if (strcmp("compile", cmd) == 0) {

      process_compile(CHECK);

    } else if (strcmp("ciMethod", cmd) == 0) {

      process_ciMethod(CHECK);

    } else if (strcmp("ciMethodData", cmd) == 0) {

      process_ciMethodData(CHECK);

    } else if (strcmp("staticfield", cmd) == 0) {

      process_staticfield(CHECK);

    } else if (strcmp("ciInstanceKlass", cmd) == 0) {

      process_ciInstanceKlass(CHECK);

    } else if (strcmp("instanceKlass", cmd) == 0) {

      process_instanceKlass(CHECK);

#if INCLUDE_JVMTI

    } else if (strcmp("JvmtiExport", cmd) == 0) {

      process_JvmtiExport(CHECK);

#endif // INCLUDE_JVMTI

    } else {

      report_error("unknown command");

    }

  }

  // validation of comp_level

  bool is_valid_comp_level(int comp_level) {

    const int msg_len = 256;

    char* msg = NULL;

    if (!is_compile(comp_level)) {

      msg = NEW_RESOURCE_ARRAY(char, msg_len);

      jio_snprintf(msg, msg_len, "%d isn't compilation level", comp_level);

    } else if (!TieredCompilation && (comp_level != CompLevel_highest_tier)) {

      msg = NEW_RESOURCE_ARRAY(char, msg_len);

      switch (comp_level) {

        case CompLevel_simple:

          jio_snprintf(msg, msg_len, "compilation level %d requires Client VM or TieredCompilation", comp_level);

          break;

        case CompLevel_full_optimization:

          jio_snprintf(msg, msg_len, "compilation level %d requires Server VM", comp_level);

          break;

        default:

          jio_snprintf(msg, msg_len, "compilation level %d requires TieredCompilation", comp_level);

      }

    }

    if (msg != NULL) {

      report_error(msg);

      return false;

    }

    return true;

  }

  // compile <klass> <name> <signature> <entry_bci> <comp_level>

  void process_compile(TRAPS) {

    Method* method = parse_method(CHECK);

    int entry_bci = parse_int("entry_bci");

    const char* comp_level_label = "comp_level";

    int comp_level = parse_int(comp_level_label);

    // old version w/o comp_level

    if (had_error() && (error_message() == comp_level_label)) {

      comp_level = CompLevel_full_optimization;

    }

    if (!is_valid_comp_level(comp_level)) {

      return;

    }

    Klass* k = method->method_holder();

    ((InstanceKlass*)k)->initialize(THREAD);

    if (HAS_PENDING_EXCEPTION) {

      oop throwable = PENDING_EXCEPTION;

      java_lang_Throwable::print(throwable, tty);

      tty->cr();

      if (ReplayIgnoreInitErrors) {

        CLEAR_PENDING_EXCEPTION;

        ((InstanceKlass*)k)->set_init_state(InstanceKlass::fully_initialized);

      } else {

        return;

      }

    }

    // Make sure the existence of a prior compile doesn't stop this one

    nmethod* nm = (entry_bci != InvocationEntryBci) ? method->lookup_osr_nmethod_for(entry_bci, comp_level, true) : method->code();

    if (nm != NULL) {

      nm->make_not_entrant();

    }

    replay_state = this;

    CompileBroker::compile_method(method, entry_bci, comp_level,

                                  methodHandle(), 0, "replay", THREAD);

    replay_state = NULL;

    reset();

  }

  // ciMethod <klass> <name> <signature> <invocation_counter> <backedge_counter> <interpreter_invocation_count> <interpreter_throwout_count> <instructions_size>

  //

  //

  void process_ciMethod(TRAPS) {

    Method* method = parse_method(CHECK);

    ciMethodRecord* rec = new_ciMethod(method);

    rec->invocation_counter = parse_int("invocation_counter");

    rec->backedge_counter = parse_int("backedge_counter");

    rec->interpreter_invocation_count = parse_int("interpreter_invocation_count");

    rec->interpreter_throwout_count = parse_int("interpreter_throwout_count");

    rec->instructions_size = parse_int("instructions_size");

  }

  // ciMethodData <klass> <name> <signature> <state> <current mileage> orig <length> # # ... data <length> # # ... oops <length>

  void process_ciMethodData(TRAPS) {

    Method* method = parse_method(CHECK);

    /* jsut copied from Method, to build interpret data*/

    if (InstanceRefKlass::owns_pending_list_lock((JavaThread*)THREAD)) {

      return;

    }

    // methodOopDesc::build_interpreter_method_data(method, CHECK);

    {

      // Grab a lock here to prevent multiple

      // MethodData*s from being created.

      MutexLocker ml(MethodData_lock, THREAD);

      if (method->method_data() == NULL) {

        ClassLoaderData* loader_data = method->method_holder()->class_loader_data();

        MethodData* method_data = MethodData::allocate(loader_data, method, CHECK);

        method->set_method_data(method_data);

      }

    }

    // collect and record all the needed information for later

    ciMethodDataRecord* rec = new_ciMethodData(method);

    rec->state = parse_int("state");

    rec->current_mileage = parse_int("current_mileage");

    rec->orig_data = parse_data("orig", rec->orig_data_length);

    if (rec->orig_data == NULL) {

      return;

    }

    rec->data = parse_intptr_data("data", rec->data_length);

    if (rec->data == NULL) {

      return;

    }

    if (!parse_tag_and_count("oops", rec->oops_length)) {

      return;

    }

    rec->oops_handles = NEW_RESOURCE_ARRAY(jobject, rec->oops_length);

    rec->oops_offsets = NEW_RESOURCE_ARRAY(int, rec->oops_length);

    for (int i = 0; i < rec->oops_length; i++) {

      int offset = parse_int("offset");

      if (had_error()) {

        return;

      }

      Klass* k = parse_klass(CHECK);

      rec->oops_offsets[i] = offset;

      KlassHandle *kh = NEW_C_HEAP_OBJ(KlassHandle, mtCompiler);

      ::new ((void*)kh) KlassHandle(THREAD, k);

      rec->oops_handles[i] = (jobject)kh;

    }

  }

  // instanceKlass <name>

  //

  // Loads and initializes the klass 'name'.  This can be used to

  // create particular class loading environments

  void process_instanceKlass(TRAPS) {

    // just load the referenced class

    Klass* k = parse_klass(CHECK);

  }

  // ciInstanceKlass <name> <is_linked> <is_initialized> <length> tag # # # ...

  //

  // Load the klass 'name' and link or initialize it.  Verify that the

  // constant pool is the same length as 'length' and make sure the

  // constant pool tags are in the same state.

  void process_ciInstanceKlass(TRAPS) {

    InstanceKlass* k = (InstanceKlass *)parse_klass(CHECK);

    int is_linked = parse_int("is_linked");

    int is_initialized = parse_int("is_initialized");

    int length = parse_int("length");

    if (is_initialized) {

      k->initialize(THREAD);