/*

 * Copyright (c) 2013, 2019, 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 "jvm.h"

#include "ci/ciMethodData.hpp"

#include "ci/ciReplay.hpp"

#include "ci/ciSymbol.hpp"

#include "ci/ciKlass.hpp"

#include "ci/ciUtilities.inline.hpp"

#include "classfile/symbolTable.hpp"

#include "compiler/compileBroker.hpp"

#include "memory/allocation.inline.hpp"

#include "memory/oopFactory.hpp"

#include "memory/resourceArea.hpp"

#include "oops/constantPool.hpp"

#include "oops/method.inline.hpp"

#include "oops/oop.inline.hpp"

#include "runtime/fieldDescriptor.inline.hpp"

#include "runtime/handles.inline.hpp"

#include "utilities/copy.hpp"

#include "utilities/macros.hpp"

#include "utilities/utf8.hpp"

#ifndef PRODUCT

// ciReplay

typedef struct _ciMethodDataRecord {

  const char* _klass_name;

  const char* _method_name;

  const char* _signature;

  int _state;

  int _current_mileage;

  intptr_t* _data;

  char*     _orig_data;

  Klass**   _classes;

  Method**  _methods;

  int*      _classes_offsets;

  int*      _methods_offsets;

  int       _data_length;

  int       _orig_data_length;

  int       _classes_length;

  int       _methods_length;

} ciMethodDataRecord;

typedef struct _ciMethodRecord {

  const char* _klass_name;

  const char* _method_name;

  const char* _signature;

  int _instructions_size;

  int _interpreter_invocation_count;

  int _interpreter_throwout_count;

  int _invocation_counter;

  int _backedge_counter;

} ciMethodRecord;

typedef struct _ciInlineRecord {

  const char* _klass_name;

  const char* _method_name;

  const char* _signature;

  int _inline_depth;

  int _inline_bci;

} ciInlineRecord;

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;

  // Use pointer because we may need to return inline records

  // without destroying them.

  GrowableArray<ciInlineRecord*>*    _ci_inline_records;

  const char* _error_message;

  char* _bufptr;

  char* _buffer;

  int   _buffer_length;

  int   _buffer_pos;

  // "compile" data

  ciKlass* _iklass;

  Method*  _imethod;

  int      _entry_bci;

  int      _comp_level;

 public:

  CompileReplay(const char* filename, TRAPS) {

    _thread = THREAD;

    _loader = Handle(_thread, SystemDictionary::java_system_loader());

    _protection_domain = Handle();

    _stream = fopen(filename, "rt");

    if (_stream == NULL) {

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

    }

    _ci_inline_records = NULL;

    _error_message = NULL;

    _buffer_length = 32;

    _buffer = NEW_RESOURCE_ARRAY(char, _buffer_length);

    _bufptr = _buffer;

    _buffer_pos = 0;

    _imethod = NULL;

    _iklass  = NULL;

    _entry_bci  = 0;

    _comp_level = 0;

    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_pos; 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) {

    int read_size = 0;

    if (!parse_tag_and_count(tag, read_size)) {

      return NULL;

    }

    int actual_size = sizeof(MethodData);

    char *result = NEW_RESOURCE_ARRAY(char, actual_size);

    int i = 0;

    if (read_size != actual_size) {

      tty->print_cr("Warning: ciMethodData parsing sees MethodData size %i in file, current is %i", read_size,

                    actual_size);

      // Replay serializes the entire MethodData, but the data is at the end.

      // If the MethodData instance size has changed, we can pad or truncate in the beginning

      int padding = actual_size - read_size;

      if (padding > 0) {

        // pad missing data with zeros

        tty->print_cr("- Padding MethodData");

        for (; i < padding; i++) {

          result[i] = 0;

        }

      } else if (padding < 0) {

        // drop some data

        tty->print_cr("- Truncating MethodData");

        for (int j = 0; j < -padding; j++) {

          int val = parse_int("data");

          // discard val

        }

      }

    }

    assert(i < actual_size, "At least some data must remain to be copied");

    for (; i < actual_size; i++) {

      int val = parse_int("data");

      result[i] = val;

    }

    length = actual_size;

    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) {

      return sym;

    }

    return NULL;

  }

  // Parse a valid klass name and look it up

  Klass* parse_klass(TRAPS) {

    const char* str = parse_escaped_string();

    if (klass_name != NULL) {

      Klass* k = NULL;

      if (_iklass != NULL) {

        k = (Klass*)_iklass->find_klass(ciSymbol::make(klass_name->as_C_string()))->constant_encoding();

      } else {

        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);

        if (ReplayIgnoreInitErrors) {

          CLEAR_PENDING_EXCEPTION;

          _error_message = NULL;

        }

        return NULL;

      }

      return k;

    }

    return NULL;

  }

  // Lookup a klass

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

    return SystemDictionary::resolve_or_fail(klass_name, _loader, _protection_domain, true, THREAD);

  }

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

  Method* parse_method(TRAPS) {

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

    if (k == NULL) {

      report_error("Can't find holder klass");

      return 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) {

      report_error("Can't find method");

    }

    return m;

  }

  int get_line(int c) {

    while(c != EOF) {

      if (_buffer_pos + 1 >= _buffer_length) {

        int new_length = _buffer_length * 2;

        // Next call will throw error in case of OOM.

        _buffer = REALLOC_RESOURCE_ARRAY(char, _buffer, _buffer_length, new_length);

        _buffer_length = new_length;

      }

      if (c == '\n') {

        c = getc(_stream); // get next char

        break;

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

        // skip LF

      } else {

        _buffer[_buffer_pos++] = c;

      }

      c = getc(_stream);

    }

    // null terminate it, reset the pointer

    _buffer[_buffer_pos] = '\0'; // NL or EOF

    _buffer_pos = 0;

    _bufptr = _buffer;

    return c;

  }

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

  // the file ends.

  void process(TRAPS) {

    int line_no = 1;

    int c = getc(_stream);

    while(c != EOF) {

      c = get_line(c);

      process_command(THREAD);

      if (had_error()) {

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

        if (ReplayIgnoreInitErrors) {

          CLEAR_PENDING_EXCEPTION;

          _error_message = NULL;

        } else {

          return;

        }

      }

      line_no++;

    }

  }

  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> inline <count> <depth> <bci> <klass> <name> <signature> ...

  void* process_inline(ciMethod* imethod, Method* m, int entry_bci, int comp_level, TRAPS) {

    _imethod    = m;

    _iklass     = imethod->holder();

    _entry_bci  = entry_bci;

    _comp_level = comp_level;

    int line_no = 1;

    int c = getc(_stream);

    while(c != EOF) {

      c = get_line(c);

      // Expecting only lines with "compile" command in inline replay file.

      char* cmd = parse_string();