duke@435: /*
stefank@2314:  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
duke@435:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435:  *
duke@435:  * This code is free software; you can redistribute it and/or modify it
duke@435:  * under the terms of the GNU General Public License version 2 only, as
duke@435:  * published by the Free Software Foundation.
duke@435:  *
duke@435:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@435:  * version 2 for more details (a copy is included in the LICENSE file that
duke@435:  * accompanied this code).
duke@435:  *
duke@435:  * You should have received a copy of the GNU General Public License version
duke@435:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@435:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
duke@435:  *
duke@435:  */
duke@435: 
stefank@2314: #include "precompiled.hpp"
stefank@2314: #include "memory/allocation.inline.hpp"
stefank@2314: #include "runtime/mutexLocker.hpp"
stefank@2314: #include "runtime/osThread.hpp"
stefank@2314: #include "runtime/threadLocalStorage.hpp"
stefank@2314: #include "runtime/timer.hpp"
stefank@2314: #include "utilities/events.hpp"
stefank@2314: #ifdef TARGET_OS_FAMILY_linux
stefank@2314: # include "thread_linux.inline.hpp"
stefank@2314: #endif
stefank@2314: #ifdef TARGET_OS_FAMILY_solaris
stefank@2314: # include "thread_solaris.inline.hpp"
stefank@2314: #endif
stefank@2314: #ifdef TARGET_OS_FAMILY_windows
stefank@2314: # include "thread_windows.inline.hpp"
stefank@2314: #endif
duke@435: 
duke@435: 
duke@435: #ifndef PRODUCT
duke@435: 
duke@435: ////////////////////////////////////////////////////////////////////////////
duke@435: // Event
duke@435: 
duke@435: typedef u4 EventID;
duke@435: 
duke@435: class Event VALUE_OBJ_CLASS_SPEC  {
duke@435:  private:
duke@435:   jlong       _time_tick;
duke@435:   intx        _thread_id;
duke@435:   const char* _format;
duke@435:   int         _indent;
duke@435:   intptr_t    _arg_1;
duke@435:   intptr_t    _arg_2;
duke@435:   intptr_t    _arg_3;
duke@435: 
duke@435:   // only EventBuffer::add_event() can assign event id
duke@435:   friend class EventBuffer;
duke@435:   EventID     _id;
duke@435: 
duke@435:  public:
duke@435: 
duke@435:   void clear() { _format = NULL; }
duke@435: 
duke@435:   EventID id() const { return _id; }
duke@435: 
duke@435:   void fill(int indent, const char* format, intptr_t arg_1, intptr_t arg_2, intptr_t arg_3) {
duke@435:     _format = format;
duke@435:     _arg_1  = arg_1;
duke@435:     _arg_2  = arg_2;
duke@435:     _arg_3  = arg_3;
duke@435: 
duke@435:     _indent = indent;
duke@435: 
duke@435:     _thread_id = os::current_thread_id();
duke@435:     _time_tick = os::elapsed_counter();
duke@435:   }
duke@435: 
duke@435:   void print_on(outputStream *st) {
duke@435:     if (_format == NULL) return;
duke@435:     st->print("  %d", _thread_id);
duke@435:     st->print("  %3.2g   ", (double)_time_tick / os::elapsed_frequency());
duke@435:     st->fill_to(20);
duke@435:     for (int index = 0; index < _indent; index++) {
duke@435:       st->print("| ");
duke@435:     }
duke@435:     st->print_cr(_format, _arg_1, _arg_2, _arg_3);
duke@435:   }
duke@435: };
duke@435: 
duke@435: ////////////////////////////////////////////////////////////////////////////
duke@435: // EventBuffer
duke@435: //
duke@435: // Simple lock-free event queue. Every event has a unique 32-bit id.
duke@435: // It's fine if two threads add events at the same time, because they
duke@435: // will get different event id, and then write to different buffer location.
duke@435: // However, it is assumed that add_event() is quick enough (or buffer size
duke@435: // is big enough), so when one thread is adding event, there can't be more
duke@435: // than "size" events created by other threads; otherwise we'll end up having
duke@435: // two threads writing to the same location.
duke@435: 
duke@435: class EventBuffer : AllStatic {
duke@435:  private:
duke@435:   static Event* buffer;
duke@435:   static int    size;
duke@435:   static jint   indent;
duke@435:   static volatile EventID _current_event_id;
duke@435: 
duke@435:   static EventID get_next_event_id() {
duke@435:     return (EventID)Atomic::add(1, (jint*)&_current_event_id);
duke@435:   }
duke@435: 
duke@435:  public:
duke@435:   static void inc_indent() { Atomic::inc(&indent); }
duke@435:   static void dec_indent() { Atomic::dec(&indent); }
duke@435: 
duke@435:   static bool get_event(EventID id, Event* event) {
duke@435:     int index = (int)(id % size);
duke@435:     if (buffer[index].id() == id) {
duke@435:       memcpy(event, &buffer[index], sizeof(Event));
duke@435:       // check id again; if buffer[index] is being updated by another thread,
duke@435:       // event->id() will contain different value.
duke@435:       return (event->id() == id);
duke@435:     } else {
duke@435:       // id does not match - id is invalid, or event is overwritten
duke@435:       return false;
duke@435:     }
duke@435:   }
duke@435: 
duke@435:   // add a new event to the queue; if EventBuffer is full, this call will
duke@435:   // overwrite the oldest event in the queue
duke@435:   static EventID add_event(const char* format,
duke@435:                            intptr_t arg_1, intptr_t arg_2, intptr_t arg_3) {
duke@435:     // assign a unique id
duke@435:     EventID id = get_next_event_id();
duke@435: 
duke@435:     // event will be copied to buffer[index]
duke@435:     int index = (int)(id % size);
duke@435: 
duke@435:     // first, invalidate id, buffer[index] can't have event with id = index + 2
duke@435:     buffer[index]._id = index + 2;
duke@435: 
duke@435:     // make sure everyone has seen that buffer[index] is invalid
duke@435:     OrderAccess::fence();
duke@435: 
duke@435:     // ... before updating its value
duke@435:     buffer[index].fill(indent, format, arg_1, arg_2, arg_3);
duke@435: 
duke@435:     // finally, set up real event id, now buffer[index] contains valid event
duke@435:     OrderAccess::release_store(&(buffer[index]._id), id);
duke@435: 
duke@435:     return id;
duke@435:   }
duke@435: 
duke@435:   static void print_last(outputStream *st, int number) {
duke@435:     st->print_cr("[Last %d events in the event buffer]", number);
duke@435:     st->print_cr("-<thd>-<elapsed sec>-<description>---------------------");
duke@435: 
duke@435:     int count = 0;
duke@435:     EventID id = _current_event_id;
duke@435:     while (count < number) {
duke@435:       Event event;
duke@435:       if (get_event(id, &event)) {
duke@435:          event.print_on(st);
duke@435:       }
duke@435:       id--;
duke@435:       count++;
duke@435:     }
duke@435:   }
duke@435: 
duke@435:   static void print_all(outputStream* st) {
duke@435:     print_last(st, size);
duke@435:   }
duke@435: 
duke@435:   static void init() {
duke@435:     // Allocate the event buffer
duke@435:     size   = EventLogLength;
duke@435:     buffer = NEW_C_HEAP_ARRAY(Event, size);
duke@435: 
duke@435:     _current_event_id = 0;
duke@435: 
duke@435:     // Clear the event buffer
duke@435:     for (int index = 0; index < size; index++) {
duke@435:       buffer[index]._id = index + 1;       // index + 1 is invalid id
duke@435:       buffer[index].clear();
duke@435:     }
duke@435:   }
duke@435: };
duke@435: 
duke@435: Event*           EventBuffer::buffer;
duke@435: int              EventBuffer::size;
duke@435: volatile EventID EventBuffer::_current_event_id;
duke@435: int              EventBuffer::indent;
duke@435: 
duke@435: ////////////////////////////////////////////////////////////////////////////
duke@435: // Events
duke@435: 
duke@435: // Events::log() is safe for signal handlers
duke@435: void Events::log(const char* format, ...) {
duke@435:   if (LogEvents) {
duke@435:     va_list ap;
duke@435:     va_start(ap, format);
duke@435:     intptr_t arg_1 = va_arg(ap, intptr_t);
duke@435:     intptr_t arg_2 = va_arg(ap, intptr_t);
duke@435:     intptr_t arg_3 = va_arg(ap, intptr_t);
duke@435:     va_end(ap);
duke@435: 
duke@435:     EventBuffer::add_event(format, arg_1, arg_2, arg_3);
duke@435:   }
duke@435: }
duke@435: 
duke@435: void Events::print_all(outputStream *st) {
duke@435:   EventBuffer::print_all(st);
duke@435: }
duke@435: 
duke@435: void Events::print_last(outputStream *st, int number) {
duke@435:   EventBuffer::print_last(st, number);
duke@435: }
duke@435: 
duke@435: ///////////////////////////////////////////////////////////////////////////
duke@435: // EventMark
duke@435: 
duke@435: EventMark::EventMark(const char* format, ...) {
duke@435:   if (LogEvents) {
duke@435:     va_list ap;
duke@435:     va_start(ap, format);
duke@435:     intptr_t arg_1 = va_arg(ap, intptr_t);
duke@435:     intptr_t arg_2 = va_arg(ap, intptr_t);
duke@435:     intptr_t arg_3 = va_arg(ap, intptr_t);
duke@435:     va_end(ap);
duke@435: 
duke@435:     EventBuffer::add_event(format, arg_1, arg_2, arg_3);
duke@435:     EventBuffer::inc_indent();
duke@435:   }
duke@435: }
duke@435: 
duke@435: EventMark::~EventMark() {
duke@435:   if (LogEvents) {
duke@435:     EventBuffer::dec_indent();
duke@435:     EventBuffer::add_event("done", 0, 0, 0);
duke@435:   }
duke@435: }
duke@435: 
duke@435: ///////////////////////////////////////////////////////////////////////////
duke@435: 
duke@435: void eventlog_init() {
duke@435:   EventBuffer::init();
duke@435: }
duke@435: 
duke@435: int print_all_events(outputStream *st) {
duke@435:   EventBuffer::print_all(st);
duke@435:   return 1;
duke@435: }
duke@435: 
duke@435: #else
duke@435: 
duke@435: void eventlog_init() {}
duke@435: int print_all_events(outputStream *st) { return 0; }
duke@435: 
duke@435: #endif // PRODUCT