events.hpp revision 1879
0N/A/*
1879N/A * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
1472N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1472N/A * or visit www.oracle.com if you need additional information or have any
1472N/A * questions.
0N/A *
0N/A */
0N/A
1879N/A#ifndef SHARE_VM_UTILITIES_EVENTS_HPP
1879N/A#define SHARE_VM_UTILITIES_EVENTS_HPP
1879N/A
1879N/A#include "memory/allocation.hpp"
1879N/A#include "utilities/top.hpp"
1879N/A
0N/A// Events and EventMark provide interfaces to log events taking place in the vm.
0N/A// This facility is extremly useful for post-mortem debugging. The eventlog
0N/A// often provides crucial information about events leading up to the crash.
0N/A//
0N/A// All arguments past the format string must be passed as an intptr_t.
0N/A//
0N/A// To log a single event use:
0N/A// Events::log("New nmethod has been created " INTPTR_FORMAT, nm);
0N/A//
0N/A// To log a block of events use:
0N/A// EventMark m("GarbageCollecting %d", (intptr_t)gc_number);
0N/A//
0N/A// The constructor to eventlog indents the eventlog until the
0N/A// destructor has been executed.
0N/A//
0N/A// IMPLEMENTATION RESTRICTION:
0N/A// Max 3 arguments are saved for each logged event.
0N/A//
0N/A
0N/Aclass Events : AllStatic {
0N/A public:
0N/A // Logs an event, format as printf
0N/A static void log(const char* format, ...) PRODUCT_RETURN;
0N/A
0N/A // Prints all events in the buffer
0N/A static void print_all(outputStream* st) PRODUCT_RETURN;
0N/A
0N/A // Prints last number events from the event buffer
0N/A static void print_last(outputStream *st, int number) PRODUCT_RETURN;
0N/A};
0N/A
0N/Aclass EventMark : public StackObj {
0N/A public:
0N/A // log a begin event, format as printf
0N/A EventMark(const char* format, ...) PRODUCT_RETURN;
0N/A // log an end event
0N/A ~EventMark() PRODUCT_RETURN;
0N/A};
0N/A
0N/Aint print_all_events(outputStream *st);
1879N/A
1879N/A#endif // SHARE_VM_UTILITIES_EVENTS_HPP