/*

 * Copyright 1997-2007 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 *

 */

# include "incls/_precompiled.incl"

# include "incls/_debug.cpp.incl"

#ifndef ASSERT

#  ifdef _DEBUG

   // NOTE: don't turn the lines below into a comment -- if you're getting

   // a compile error here, change the settings to define ASSERT

   ASSERT should be defined when _DEBUG is defined.  It is not intended to be used for debugging

   functions that do not slow down the system too much and thus can be left in optimized code.

   On the other hand, the code should not be included in a production version.

#  endif // _DEBUG

#endif // ASSERT

#ifdef _DEBUG

#  ifndef ASSERT

     configuration error: ASSERT must be defined in debug version

#  endif // ASSERT

#endif // _DEBUG

#ifdef PRODUCT

#  if -defined _DEBUG || -defined ASSERT

     configuration error: ASSERT et al. must not be defined in PRODUCT version

#  endif

#endif // PRODUCT

void warning(const char* format, ...) {

  // In case error happens before init or during shutdown

  if (tty == NULL) ostream_init();

  tty->print("%s warning: ", VM_Version::vm_name());

  va_list ap;

  va_start(ap, format);

  tty->vprint_cr(format, ap);

  va_end(ap);

  if (BreakAtWarning) BREAKPOINT;

}

#ifndef PRODUCT

#define is_token_break(ch) (isspace(ch) || (ch) == ',')

static const char* last_file_name = NULL;

static int         last_line_no   = -1;

// assert/guarantee/... may happen very early during VM initialization.

// Don't rely on anything that is initialized by Threads::create_vm(). For

// example, don't use tty.

bool assert_is_suppressed(const char* file_name, int line_no) {

  // The following 1-element cache requires that passed-in

  // file names are always only constant literals.

  if (file_name == last_file_name && line_no == last_line_no)  return true;

  int file_name_len = (int)strlen(file_name);

  char separator = os::file_separator()[0];

  const char* base_name = strrchr(file_name, separator);

  if (base_name == NULL)

    base_name = file_name;

  // scan the SuppressErrorAt option

  const char* cp = SuppressErrorAt;

  for (;;) {

    const char* sfile;

    int sfile_len;

    int sline;

    bool noisy;

    while ((*cp) != '\0' && is_token_break(*cp))  cp++;

    if ((*cp) == '\0')  break;

    sfile = cp;

    while ((*cp) != '\0' && !is_token_break(*cp) && (*cp) != ':')  cp++;

    sfile_len = cp - sfile;

    if ((*cp) == ':')  cp++;

    sline = 0;

    while ((*cp) != '\0' && isdigit(*cp)) {

      sline *= 10;

      sline += (*cp) - '0';

      cp++;

    }

    // "file:line!" means the assert suppression is not silent

    noisy = ((*cp) == '!');

    while ((*cp) != '\0' && !is_token_break(*cp))  cp++;

    // match the line

    if (sline != 0) {

      if (sline != line_no)  continue;

    }

    // match the file

    if (sfile_len > 0) {

      const char* look = file_name;

      const char* look_max = file_name + file_name_len - sfile_len;

      const char* foundp;

      bool match = false;

      while (!match

             && (foundp = strchr(look, sfile[0])) != NULL

             && foundp <= look_max) {

        match = true;

        for (int i = 1; i < sfile_len; i++) {

          if (sfile[i] != foundp[i]) {

            match = false;

            break;

          }

        }

        look = foundp + 1;

      }

      if (!match)  continue;

    }

    // got a match!

    if (noisy) {

      fdStream out(defaultStream::output_fd());

      out.print_raw("[error suppressed at ");

      out.print_raw(base_name);

      char buf[16];

      jio_snprintf(buf, sizeof(buf), ":%d]", line_no);

      out.print_raw_cr(buf);

    } else {

      // update 1-element cache for fast silent matches

      last_file_name = file_name;

      last_line_no   = line_no;

    }

    return true;

  }

  if (!is_error_reported()) {

    // print a friendly hint:

    fdStream out(defaultStream::output_fd());

    out.print_raw_cr("# To suppress the following error report, specify this argument");

    out.print_raw   ("# after -XX: or in .hotspotrc:  SuppressErrorAt=");

    out.print_raw   (base_name);

    char buf[16];

    jio_snprintf(buf, sizeof(buf), ":%d", line_no);

    out.print_raw_cr(buf);

  }

  return false;

}

#undef is_token_break

#else

// Place-holder for non-existent suppression check:

#define assert_is_suppressed(file_name, line_no) (false)

#endif //PRODUCT

void report_assertion_failure(const char* file_name, int line_no, const char* message) {

  if (Debugging || assert_is_suppressed(file_name, line_no))  return;

  VMError err(ThreadLocalStorage::get_thread_slow(), message, file_name, line_no);

  err.report_and_die();

}

void report_fatal(const char* file_name, int line_no, const char* message) {

  if (Debugging || assert_is_suppressed(file_name, line_no))  return;

  VMError err(ThreadLocalStorage::get_thread_slow(), message, file_name, line_no);

  err.report_and_die();

}

void report_fatal_vararg(const char* file_name, int line_no, const char* format, ...) {

  char buffer[256];

  va_list ap;

  va_start(ap, format);

  jio_vsnprintf(buffer, sizeof(buffer), format, ap);

  va_end(ap);

  report_fatal(file_name, line_no, buffer);

}

// Used by report_vm_out_of_memory to detect recursion.

static jint _exiting_out_of_mem = 0;

// Just passing the flow to VMError to handle error

void report_vm_out_of_memory(const char* file_name, int line_no, size_t size, const char* message) {

  if (Debugging || assert_is_suppressed(file_name, line_no))  return;

  // We try to gather additional information for the first out of memory

  // error only; gathering additional data might cause an allocation and a

  // recursive out_of_memory condition.

  const jint exiting = 1;

  // If we succeed in changing the value, we're the first one in.

  bool first_time_here = Atomic::xchg(exiting, &_exiting_out_of_mem) != exiting;

  if (first_time_here) {

    Thread* thread = ThreadLocalStorage::get_thread_slow();

    VMError(thread, size, message, file_name, line_no).report_and_die();

  }

  vm_abort();

}

void report_vm_out_of_memory_vararg(const char* file_name, int line_no, size_t size, const char* format, ...) {

  char buffer[256];

  va_list ap;

  va_start(ap, format);

  jio_vsnprintf(buffer, sizeof(buffer), format, ap);

  va_end(ap);

  report_vm_out_of_memory(file_name, line_no, size, buffer);

}

void report_should_not_call(const char* file_name, int line_no) {

  if (Debugging || assert_is_suppressed(file_name, line_no))  return;

  VMError err(ThreadLocalStorage::get_thread_slow(), "ShouldNotCall()", file_name, line_no);

  err.report_and_die();

}

void report_should_not_reach_here(const char* file_name, int line_no) {

  if (Debugging || assert_is_suppressed(file_name, line_no))  return;

  VMError err(ThreadLocalStorage::get_thread_slow(), "ShouldNotReachHere()", file_name, line_no);

  err.report_and_die();

}

void report_unimplemented(const char* file_name, int line_no) {

  if (Debugging || assert_is_suppressed(file_name, line_no))  return;

  VMError err(ThreadLocalStorage::get_thread_slow(), "Unimplemented()", file_name, line_no);

  err.report_and_die();

}

void report_untested(const char* file_name, int line_no, const char* msg) {

#ifndef PRODUCT

  warning("Untested: %s in %s: %d\n", msg, file_name, line_no);

#endif // PRODUCT

}

void report_java_out_of_memory(const char* message) {

  static jint out_of_memory_reported = 0;

  // A number of threads may attempt to report OutOfMemoryError at around the

  // same time. To avoid dumping the heap or executing the data collection

  // commands multiple times we just do it once when the first threads reports

  // the error.

  if (Atomic::cmpxchg(1, &out_of_memory_reported, 0) == 0) {

    // create heap dump before OnOutOfMemoryError commands are executed

    if (HeapDumpOnOutOfMemoryError) {

      tty->print_cr("java.lang.OutOfMemoryError: %s", message);

      HeapDumper::dump_heap();

    }

    if (OnOutOfMemoryError && OnOutOfMemoryError[0]) {

      VMError err(message);

      err.report_java_out_of_memory();

    }

  }

}

extern "C" void ps();

static bool error_reported = false;

// call this when the VM is dying--it might loosen some asserts

void set_error_reported() {

  error_reported = true;

}

bool is_error_reported() {

    return error_reported;

}

// ------ helper functions for debugging go here ------------

#ifndef PRODUCT

// All debug entries should be wrapped with a stack allocated

// Command object. It makes sure a resource mark is set and

// flushes the logfile to prevent file sharing problems.

class Command : public StackObj {

 private:

  ResourceMark rm;

  ResetNoHandleMark rnhm;

  HandleMark   hm;

  bool debug_save;

 public:

  static int level;

  Command(const char* str) {

    debug_save = Debugging;

    Debugging = true;

    if (level++ > 0)  return;

    tty->cr();

    tty->print_cr("\"Executing %s\"", str);

  }

  ~Command() { tty->flush(); Debugging = debug_save; level--; }

};

int Command::level = 0;

extern "C" void blob(CodeBlob* cb) {

  Command c("blob");

  cb->print();

}

extern "C" void dump_vtable(address p) {

  Command c("dump_vtable");

  klassOop k = (klassOop)p;

  instanceKlass::cast(k)->vtable()->print();

}

extern "C" void nm(intptr_t p) {

  // Actually we look through all CodeBlobs (the nm name has been kept for backwards compatability)

  Command c("nm");

  CodeBlob* cb = CodeCache::find_blob((address)p);

  if (cb == NULL) {

    tty->print_cr("NULL");

  } else {

    cb->print();

  }

}

extern "C" void disnm(intptr_t p) {

  Command c("disnm");

  CodeBlob* cb = CodeCache::find_blob((address) p);

  cb->print();

  Disassembler::decode(cb);

}

extern "C" void printnm(intptr_t p) {

  char buffer[256];

  sprintf(buffer, "printnm: " INTPTR_FORMAT, p);

  Command c(buffer);

  CodeBlob* cb = CodeCache::find_blob((address) p);

  if (cb->is_nmethod()) {

    nmethod* nm = (nmethod*)cb;

    nm->print_nmethod(true);

  }

}

extern "C" void universe() {

  Command c("universe");

  Universe::print();

}

extern "C" void verify() {

  // try to run a verify on the entire system

  // note: this may not be safe if we're not at a safepoint; for debugging,

  // this manipulates the safepoint settings to avoid assertion failures

  Command c("universe verify");

  bool safe = SafepointSynchronize::is_at_safepoint();

  if (!safe) {

    tty->print_cr("warning: not at safepoint -- verify may fail");

    SafepointSynchronize::set_is_at_safepoint();

  }

  // Ensure Eden top is correct before verification

  Universe::heap()->prepare_for_verify();

  Universe::verify(true);

  if (!safe) SafepointSynchronize::set_is_not_at_safepoint();

}

extern "C" void pp(void* p) {

  Command c("pp");

  FlagSetting fl(PrintVMMessages, true);

  if (Universe::heap()->is_in(p)) {

    oop obj = oop(p);

    obj->print();

  } else {

    tty->print("%#p", p);

  }

}

// pv: print vm-printable object

extern "C" void pa(intptr_t p)   { ((AllocatedObj*) p)->print(); }

extern "C" void findpc(intptr_t x);

extern "C" void ps() { // print stack

  Command c("ps");

  // Prints the stack of the current Java thread

  JavaThread* p = JavaThread::active();

  tty->print(" for thread: ");

  p->print();

  tty->cr();

  if (p->has_last_Java_frame()) {

    // If the last_Java_fp is set we are in C land and

    // can call the standard stack_trace function.

    p->trace_stack();

  } else {

    frame f = os::current_frame();

    RegisterMap reg_map(p);

    f = f.sender(&reg_map);

    tty->print("(guessing starting frame id=%#p based on current fp)\n", f.id());

    p->trace_stack_from(vframe::new_vframe(&f, &reg_map, p));

  pd_ps(f);

  }

}

extern "C" void psf() { // print stack frames

  {

    Command c("psf");

    JavaThread* p = JavaThread::active();

    tty->print(" for thread: ");

    p->print();

    tty->cr();

    if (p->has_last_Java_frame()) {

      p->trace_frames();

    }

  }

}

extern "C" void threads() {

  Command c("threads");

  Threads::print(false, true);

}

extern "C" void psd() {

  Command c("psd");

  SystemDictionary::print();

}

extern "C" void safepoints() {

  Command c("safepoints");

  SafepointSynchronize::print_state();

}

extern "C" void pss() { // print all stacks

  Command c("pss");

  Threads::print(true, true);

}

extern "C" void debug() {               // to set things up for compiler debugging

  Command c("debug");

  WizardMode = true;

  PrintVMMessages = PrintCompilation = true;

  PrintInlining = PrintAssembly = true;

  tty->flush();

}

extern "C" void ndebug() {              // undo debug()

  Command c("ndebug");

  PrintCompilation = false;

  PrintInlining = PrintAssembly = false;

  tty->flush();

}

extern "C" void flush()  {

  Command c("flush");

  tty->flush();

}

extern "C" void events() {

  Command c("events");

  Events::print_last(tty, 50);

}

extern "C" void nevents(int n) {

  Command c("events");

  Events::print_last(tty, n);

}

// Given a heap address that was valid before the most recent GC, if

// the oop that used to contain it is still live, prints the new

// location of the oop and the address. Useful for tracking down

// certain kinds of naked oop and oop map bugs.

extern "C" void pnl(intptr_t old_heap_addr) {

  // Print New Location of old heap address

  Command c("pnl");

#ifndef VALIDATE_MARK_SWEEP

  tty->print_cr("Requires build with VALIDATE_MARK_SWEEP defined (debug build) and RecordMarkSweepCompaction enabled");

#else

  MarkSweep::print_new_location_of_heap_address((HeapWord*) old_heap_addr);

#endif

}

extern "C" methodOop findm(intptr_t pc) {

  Command c("findm");

  nmethod* nm = CodeCache::find_nmethod((address)pc);

  return (nm == NULL) ? (methodOop)NULL : nm->method();

}

extern "C" nmethod* findnm(intptr_t addr) {

  Command c("findnm");

  return  CodeCache::find_nmethod((address)addr);

}

static address same_page(address x, address y) {

  intptr_t page_bits = -os::vm_page_size();

  if ((intptr_t(x) & page_bits) == (intptr_t(y) & page_bits)) {

    return x;

  } else if (x > y) {

    return (address)(intptr_t(y) | ~page_bits) + 1;