/* <code/eventcom.h> -- Event Logging Common Definitions
*
* Copyright (c) 2001 Ravenbrook Limited. See end of file for license.
* $Id: //info.ravenbrook.com/project/mps/version/1.110/code/eventcom.h#5 $
*
* .sources: mps.design.telemetry
*/
#ifndef eventcom_h
#define eventcom_h
#include <limits.h>
#include "mpmtypes.h" /* for Word */
#include "eventdef.h"
/* EVENT_CLOCK -- fast event timestamp clock
*
* On platforms that support it, we want to stamp events with a very cheap
* and fast high-resolution timer.
*
* TODO: This is a sufficiently complicated nest of ifdefs that it should
* be quarantined in its own header with KEEP OUT signs attached.
* RB 2012-09-11
*/
/* TODO: Clang supposedly provides a cross-platform builtin for a fast
timer, but it doesn't seem to be present on Mac OS X 10.8. We should
use it if it ever appears.
<http://clang.llvm.org/docs/LanguageExtensions.html#builtins> */
#if defined(MPS_BUILD_LL)
#if __has_builtin(__builtin_readcyclecounter)
#error "__builtin_readcyclecounter is available but not used"
#endif /* __has_builtin(__builtin_readcyclecounter) */
#endif
/* Microsoft C provides an intrinsic for the Intel rdtsc instruction.
<http://msdn.microsoft.com/en-US/library/twchhe95%28v=vs.100%29.aspx> */
#if (defined(MPS_ARCH_I3) || defined(MPS_ARCH_I6)) && defined(MPS_BUILD_MV)
typedef unsigned __int64 EventClock;
typedef union EventClockUnion {
struct {
unsigned low, high;
} half;
unsigned __int64 whole;
} EventClockUnion;
#if _MSC_VER >= 1400
#pragma intrinsic(__rdtsc)
#define EVENT_CLOCK(lvalue) \
BEGIN \
(lvalue) = __rdtsc(); \
END
#else /* _MSC_VER < 1400 */
/* This is mostly a patch for Open Dylan's bootstrap on Windows, which is
using Microsoft Visual Studio 6 because of support for CodeView debugging
information. */
#include <windows.h> /* KILL IT WITH FIRE! */
#define EVENT_CLOCK(lvalue) \
BEGIN \
LARGE_INTEGER _count; \
QueryPerformanceCounter(&_count); \
(lvalue) = _count.QuadPart; \
END
#endif /* _MSC_VER < 1400 */
#if defined(MPS_ARCH_I3)
/* We can't use a shift to get the top half of the 64-bit event clock,
because that introduces a dependency on `__aullshr` in the C run-time. */
#define EVENT_CLOCK_PRINT(stream, clock) \
fprintf(stream, "%08lX%08lX", \
(*(EventClockUnion *)&(clock)).half.high, \
(*(EventClockUnion *)&(clock)).half.low)
#define EVENT_CLOCK_WRITE(stream, clock) \
WriteF(stream, "$W$W", \
(*(EventClockUnion *)&(clock)).half.high, \
(*(EventClockUnion *)&(clock)).half.low, \
NULL)
#elif defined(MPS_ARCH_I6)
#define EVENT_CLOCK_PRINT(stream, clock) \
fprintf(stream, "%016lX", (clock));
#define EVENT_CLOCK_WRITE(stream, clock) \
WriteF(stream, "$W", (WriteFW)(clock), NULL)
#endif
#endif /* Microsoft C on Intel */
/* If we have GCC or Clang, assemble the rdtsc instruction */
#if !defined(EVENT_CLOCK) && \
(defined(MPS_ARCH_I3) || defined(MPS_ARCH_I6)) && \
(defined(MPS_BUILD_GC) || defined(MPS_BUILD_LL))
/* Use __extension__ to enable use of a 64-bit type on 32-bit pedantic GCC */
__extension__ typedef unsigned long long EventClock;
#define EVENT_CLOCK(lvalue) \
BEGIN \
unsigned _l, _h; \
__asm__ __volatile__("rdtsc" : "=a"(_l), "=d"(_h)); \
(lvalue) = ((EventClock)_h << 32) | _l; \
END
/* The __extension__ keyword doesn't work on printf formats, so we
concatenate two 32-bit hex numbers to print the 64-bit value. */
#define EVENT_CLOCK_PRINT(stream, clock) \
fprintf(stream, "%08lX%08lX", \
(unsigned long)((clock) >> 32), \
(unsigned long)(clock))
#define EVENT_CLOCK_WRITE(stream, clock) \
WriteF(stream, "$W$W", (WriteFW)((clock) >> 32), (WriteFW)clock, NULL)
#endif /* Intel, GCC or Clang */
/* no fast clock, use plinth, probably from the C library */
#ifndef EVENT_CLOCK
typedef mps_clock_t EventClock;
#define EVENT_CLOCK(lvalue) \
BEGIN \
(lvalue) = mps_clock(); \
END
#define EVENT_CLOCK_PRINT(stream, clock) \
fprintf(stream, "%lu", (unsigned long)clock)
#define EVENT_CLOCK_WRITE(stream, clock) \
WriteF(stream, "$W", (WriteFW)clock, NULL)
#endif
/* Event Kinds --- see <design/telemetry/>
*
* All events are classified as being of one event type.
* They are small enough to be able to be used as members of a bit set.
*/
#define EventKindENUM(ENUM, X) \
ENUM(X, Arena, "Per space or arena") \
ENUM(X, Pool, "Per pool") \
ENUM(X, Trace, "Per trace or scan") \
ENUM(X, Seg, "Per seg") \
ENUM(X, Ref, "Per ref or fix") \
ENUM(X, Object, "Per alloc or object") \
ENUM(X, User, "User-invoked")
#define ENUM_DECLARE(name) \
enum name##Enum { \
name##ENUM(ENUM_DECLARE_ROW, name) \
name##LIMIT \
};
#define ENUM_DECLARE_ROW(enumName, rowName, rowDoc) \
enumName##rowName,
ENUM_DECLARE(EventKind)
/* Event type definitions
*
* Various constants for each event type to describe them, so that they
* can easily be looked up from macros by name.
*/
/* Note that enum values can be up to fifteen bits long portably. */
#define EVENT_ENUM(X, name, code, always, kind) \
Event##name##Code = code, \
Event##name##Always = always, \
Event##name##Kind = EventKind##kind,
enum EventDefinitionsEnum {
EVENT_LIST(EVENT_ENUM, X)
EventEnumWarningSuppressor /* suppress comma-at-end-of-enum warning */
};
/* Event*Struct -- Event Structures
*
* Declare the structures that are used to encode events in the internal event
* buffers and on the binary telemetry output stream.
*/
/* Types for common event fields */
typedef unsigned short EventCode;
typedef unsigned EventKind;
typedef unsigned short EventSize;
#define EventSizeMAX USHRT_MAX
/* Common prefix for all event structures. The size field allows an event
reader to skip over events whose codes it does not recognise. */
#define EVENT_ANY_FIELDS \
EventCode code; /* encoding of the event type */ \
EventSize size; /* allows reader to skip events of unknown code */ \
EventClock clock; /* when the event occurred */
typedef struct EventAnyStruct {
EVENT_ANY_FIELDS
} EventAnyStruct;
/* Event field types, for indexing by macro on the event parameter sort */
typedef void *EventFP; /* pointer to C object */
typedef Addr EventFA; /* address on the heap */
typedef Word EventFW; /* word */
typedef unsigned EventFU; /* unsigned integer */
typedef char EventFS[EventStringLengthMAX + sizeof('\0')]; /* string */
typedef double EventFD; /* double */
typedef int EventFB; /* boolean */
/* Event packing bitfield specifiers */
#define EventFP_BITFIELD
#define EventFA_BITFIELD
#define EventFW_BITFIELD
#define EventFU_BITFIELD
#define EventFS_BITFIELD
#define EventFD_BITFIELD
#define EventFB_BITFIELD : 1
#define EVENT_STRUCT_FIELD(X, index, sort, ident) \
EventF##sort f##index EventF##sort##_BITFIELD;
#define EVENT_STRUCT(X, name, _code, always, kind) \
typedef struct Event##name##Struct { \
EVENT_ANY_FIELDS \
EVENT_##name##_PARAMS(EVENT_STRUCT_FIELD, X) \
} Event##name##Struct;
EVENT_LIST(EVENT_STRUCT, X)
/* Event -- event union type
*
* Event is the type of a pointer to EventUnion, which is a union of all
* event structures. This can be used as the type of any event, decoded
* by examining event->any.code.
*/
#define EVENT_UNION_MEMBER(X, name, code, always, kind) \
Event##name##Struct name;
typedef union EventUnion {
EventAnyStruct any;
EVENT_LIST(EVENT_UNION_MEMBER, X)
} EventUnion, *Event;
#endif /* eventcom_h */
/* C. COPYRIGHT AND LICENSE
*
* Copyright (C) 2001-2002 Ravenbrook Limited <http://www.ravenbrook.com/>.
* All rights reserved. This is an open source license. Contact
* Ravenbrook for commercial licensing options.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Redistributions in any form must be accompanied by information on how
* to obtain complete source code for this software and any accompanying
* software that uses this software. The source code must either be
* included in the distribution or be available for no more than the cost
* of distribution plus a nominal fee, and must be freely redistributable
* under reasonable conditions. For an executable file, complete source
* code means the source code for all modules it contains. It does not
* include source code for modules or files that typically accompany the
* major components of the operating system on which the executable file
* runs.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
* PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/