1 /*
   2  * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #include <proc_service.h>
  26 
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30 
  31 typedef struct jvm_agent jvm_agent_t;
  32 
  33 #define JVM_DB_VERSION  1
  34 
  35 jvm_agent_t *Jagent_create(struct ps_prochandle *P, int vers);
  36 
  37 /*
  38  * Called from Jframe_iter() for each java frame.  If it returns 0, then
  39  * Jframe_iter() proceeds to the next frame.  Otherwise, the return value is
  40  * immediately returned to the caller of Jframe_iter().
  41  *
  42  * Parameters:
  43  *    'cld' is client supplied data (to maintain iterator state, if any).
  44  *    'name' is java method name.
  45  *    'bci' is byte code index. it will be -1 if not available.
  46  *    'line' is java source line number. it will be 0 if not available.
  47  *    'handle' is an abstract client handle, reserved for future expansions
  48  */
  49 
  50 typedef int java_stack_f(void *cld, const prgregset_t regs, const char* name, int bci, int line, void *handle);
  51 
  52 /*
  53  * Iterates over the java frames at the current location.  Returns -1 if no java
  54  * frames were found, or if there was some unrecoverable error.  Otherwise,
  55  * returns the last value returned from 'func'.
  56  */
  57 int Jframe_iter(jvm_agent_t *agent, prgregset_t gregs, java_stack_f *func, void* cld);
  58 
  59 void Jagent_destroy(jvm_agent_t *J);
  60 
  61 #ifdef __cplusplus
  62 } /* extern "C" */
  63 #endif /* __cplusplus */