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: #ifndef SHARE_VM_UTILITIES_EVENTS_HPP
stefank@2314: #define SHARE_VM_UTILITIES_EVENTS_HPP
stefank@2314: 
stefank@2314: #include "memory/allocation.hpp"
stefank@2314: #include "utilities/top.hpp"
stefank@2314: 
duke@435: // Events and EventMark provide interfaces to log events taking place in the vm.
duke@435: // This facility is extremly useful for post-mortem debugging. The eventlog
duke@435: // often provides crucial information about events leading up to the crash.
duke@435: //
duke@435: // All arguments past the format string must be passed as an intptr_t.
duke@435: //
duke@435: // To log a single event use:
duke@435: //    Events::log("New nmethod has been created " INTPTR_FORMAT, nm);
duke@435: //
duke@435: // To log a block of events use:
duke@435: //    EventMark m("GarbageCollecting %d", (intptr_t)gc_number);
duke@435: //
duke@435: // The constructor to eventlog indents the eventlog until the
duke@435: // destructor has been executed.
duke@435: //
duke@435: // IMPLEMENTATION RESTRICTION:
duke@435: //   Max 3 arguments are saved for each logged event.
duke@435: //
duke@435: 
duke@435: class Events : AllStatic {
duke@435:  public:
duke@435:   // Logs an event, format as printf
duke@435:   static void log(const char* format, ...) PRODUCT_RETURN;
duke@435: 
duke@435:   // Prints all events in the buffer
duke@435:   static void print_all(outputStream* st) PRODUCT_RETURN;
duke@435: 
duke@435:   // Prints last number events from the event buffer
duke@435:   static void print_last(outputStream *st, int number) PRODUCT_RETURN;
duke@435: };
duke@435: 
duke@435: class EventMark : public StackObj {
duke@435:  public:
duke@435:   // log a begin event, format as printf
duke@435:   EventMark(const char* format, ...) PRODUCT_RETURN;
duke@435:   // log an end event
duke@435:   ~EventMark() PRODUCT_RETURN;
duke@435: };
duke@435: 
duke@435: int print_all_events(outputStream *st);
stefank@2314: 
stefank@2314: #endif // SHARE_VM_UTILITIES_EVENTS_HPP