ijet_log.h

java 1.1 gemini 08_16

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*******************************************************************************
 * Filename:
 * ---------
 *  ijet_log.h
 *
 * Project:
 * --------
 *  MAUI
 *
 * Description:
 * ------------
 *  
 *
 * Author:
 * -------
 *  
 *
 *==============================================================================
 * 				HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!! 
 *------------------------------------------------------------------------------
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!! 
 *==============================================================================
 *******************************************************************************/


/*
 * Copyright ?2003 Sun Microsystems, Inc. All rights reserved.
 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 * 
 */

/*=========================================================================
 * SYSTEM:    KVM
 * SUBSYSTEM: Profiling
 * FILE:      log.h
 * OVERVIEW:  Definitions for gathering and printing out diagnostic
 *            virtual machine execution information at runtime.
 * AUTHOR:    Daniel Blaukopf, based on code by Antero Taivalsaari
 *            and Doug Simon
 *=======================================================================*/

/*=========================================================================
 * COMMENT: This file contains the declaration of a structure type, and
 * an instance of it. This instance contains pointers to functions that
 * are called for by other modules in the KVM in order to provide
 * diagnostic information.
 *=======================================================================*/

#ifndef __log_h
#define __log_h

/*=========================================================================
 * Logging makes use of the "fprintf" function, the first parameter of
 * which is expected to be of type "LOGFILEPTR". If LOGFILEPTR has not
 * already been defined for a platform (for example, the Palm source 
 * defines it in machine_md.h) then we assume that logging will be to
 * "stdout" using the C output routines. Thus, we define LOGFILEPTR
 * appropriately below.
 *=======================================================================*/

#ifndef LOGFILEPTR
#define LOGFILEPTR FILE*
#endif

/*=========================================================================
 * The following is the LogInterface structure, which contains pointers to
 * the functions to be called for each type of logged event.
 *=======================================================================*/

struct KVMLogInterface_ {

/*=========================================================================
* FUNCTION:      fprintf
* TYPE:          instrumentation operation
* OVERVIEW:      Record a text string. By default this function maps to
*                the fprintf() function declared in <stdio.h>.
*
* INTERFACE:
*   parameters:  as defined in <stdio.h>,
*                stream: the output stream (note: defined as a LOGFILEPTR)
*                format: the text and formatting information
*                ...: optional arguments
*   returns:     The number of characters written, or a negative value
*                if an error was encountered.
*=======================================================================*/

#ifdef CLDC11
    int (*fprintf) (LOGFILEPTR stream, const char *format, ...);
#endif /* CLDC11 */
    
/*=========================================================================
* FUNCTION:      uncaughtException
* TYPE:          instrumentation operation
* OVERVIEW:      Record the fact than an exception was thrown, but
*                no appropriate handler was found to handle it.
* 
* INTERFACE:
*   parameters:  exception: the exception object
*   returns:     <nothing>
*=======================================================================*/

    void (*uncaughtException)(THROWABLE_INSTANCE exception);

#if INCLUDEDEBUGCODE    

/*=========================================================================
* FUNCTION:      enterMethod
* TYPE:          instrumentation operation
* OVERVIEW:      Record the fact that a method has been called
*
* INTERFACE:
*   parameters:  type: any extra words describing this method
*                className: the name of the class containing the method
*                methodName: the name of the method
*                signature: the method's signature (e.g. (II)V)
*   returns:     <nothing>
*=======================================================================*/
    void (*enterMethod) (METHOD method, const char *type);

/*=========================================================================
* FUNCTION:      exitMethod
* TYPE:          instrumentation operation
* OVERVIEW:      Record the fact that a method has returned
*
* INTERFACE:
*   parameters:  className: the name of the class containing the method
*                methodName: the name of the method
*   returns:     <nothing>
*=======================================================================*/
    void (*exitMethod) (METHOD method);

/*=========================================================================
* FUNCTION:      allocateObject
* TYPE:          instrumentation operation
* OVERVIEW:      Record the fact that an object has been allocated
*
* INTERFACE:
*   parameters:  object: a pointer to the object, casted to a long
*                cells: the number of cells occupied by the object
*                type: the type of the object
*                ID: a long integer uniquely identifying the object
*                memoryFree: the amount of free memory after the
*                        allocation
*   returns:     <nothing>
*=======================================================================*/
    void (*allocateObject) (long object,
                            long cells,
                            int type,