src/share/vm/services/attachListener.hpp

Tue, 09 Oct 2012 10:09:34 -0700

author
mikael
date
Tue, 09 Oct 2012 10:09:34 -0700
changeset 4153
b9a9ed0f8eeb
parent 3900
d2a62e0f25eb
child 4167
9855b7e559ae
permissions
-rw-r--r--

7197424: update copyright year to match last edit in jdk8 hotspot repository
Summary: Update copyright year to 2012 for relevant files
Reviewed-by: dholmes, coleenp

duke@435 1 /*
mikael@4153 2 * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
trims@1907 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907 20 * or visit www.oracle.com if you need additional information or have any
trims@1907 21 * questions.
duke@435 22 *
duke@435 23 */
duke@435 24
stefank@2314 25 #ifndef SHARE_VM_SERVICES_ATTACHLISTENER_HPP
stefank@2314 26 #define SHARE_VM_SERVICES_ATTACHLISTENER_HPP
stefank@2314 27
stefank@2314 28 #include "memory/allocation.hpp"
stefank@2314 29 #include "utilities/debug.hpp"
stefank@2314 30 #include "utilities/ostream.hpp"
stefank@2314 31
duke@435 32 // The AttachListener thread services a queue of operations that are enqueued
duke@435 33 // by client tools. Each operation is identified by a name and has up to 3
duke@435 34 // arguments. The operation name is mapped to a function which performs the
duke@435 35 // operation. The function is called with an outputStream which is can use to
duke@435 36 // write any result data (for examples the properties command serializes
duke@435 37 // properties names and values to the output stream). When the function
duke@435 38 // complets the result value and any result data is returned to the client
duke@435 39 // tool.
duke@435 40
duke@435 41 #ifndef SERVICES_KERNEL
duke@435 42
duke@435 43 class AttachOperation;
duke@435 44
duke@435 45 typedef jint (*AttachOperationFunction)(AttachOperation* op, outputStream* out);
duke@435 46
duke@435 47 struct AttachOperationFunctionInfo {
duke@435 48 const char* name;
duke@435 49 AttachOperationFunction func;
duke@435 50 };
duke@435 51 #endif // SERVICES_KERNEL
duke@435 52
duke@435 53 class AttachListener: AllStatic {
duke@435 54 public:
duke@435 55 static void init() KERNEL_RETURN;
duke@435 56 static void abort() KERNEL_RETURN;
duke@435 57
duke@435 58 // invoke to perform clean-up tasks when all clients detach
duke@435 59 static void detachall() KERNEL_RETURN;
duke@435 60
duke@435 61 // indicates if the Attach Listener needs to be created at startup
kamg@2511 62 static bool init_at_startup() KERNEL_RETURN_(false);
duke@435 63
duke@435 64 // indicates if we have a trigger to start the Attach Listener
kamg@2511 65 static bool is_init_trigger() KERNEL_RETURN_(false);
duke@435 66
duke@435 67 #ifdef SERVICES_KERNEL
duke@435 68 static bool is_attach_supported() { return false; }
duke@435 69 #else // SERVICES_KERNEL
duke@435 70 private:
duke@435 71 static volatile bool _initialized;
duke@435 72
duke@435 73 public:
duke@435 74 static bool is_initialized() { return _initialized; }
duke@435 75 static void set_initialized() { _initialized = true; }
duke@435 76
duke@435 77 // indicates if this VM supports attach-on-demand
duke@435 78 static bool is_attach_supported() { return !DisableAttachMechanism; }
duke@435 79
duke@435 80 // platform specific initialization
duke@435 81 static int pd_init();
duke@435 82
duke@435 83 // platform specific operation
duke@435 84 static AttachOperationFunctionInfo* pd_find_operation(const char* name);
duke@435 85
duke@435 86 // platform specific flag change
duke@435 87 static jint pd_set_flag(AttachOperation* op, outputStream* out);
duke@435 88
duke@435 89 // platform specific detachall
duke@435 90 static void pd_detachall();
duke@435 91
duke@435 92 // platform specific data dump
duke@435 93 static void pd_data_dump();
duke@435 94
duke@435 95 // dequeue the next operation
duke@435 96 static AttachOperation* dequeue();
duke@435 97 #endif // SERVICES_KERNEL
duke@435 98 };
duke@435 99
duke@435 100 #ifndef SERVICES_KERNEL
zgu@3900 101 class AttachOperation: public CHeapObj<mtInternal> {
duke@435 102 public:
duke@435 103 enum {
duke@435 104 name_length_max = 16, // maximum length of name
duke@435 105 arg_length_max = 1024, // maximum length of argument
duke@435 106 arg_count_max = 3 // maximum number of arguments
duke@435 107 };
duke@435 108
duke@435 109 // name of special operation that can be enqueued when all
duke@435 110 // clients detach
duke@435 111 static char* detachall_operation_name() { return (char*)"detachall"; }
duke@435 112
duke@435 113 private:
duke@435 114 char _name[name_length_max+1];
duke@435 115 char _arg[arg_count_max][arg_length_max+1];
duke@435 116
duke@435 117 public:
duke@435 118 const char* name() const { return _name; }
duke@435 119
duke@435 120 // set the operation name
duke@435 121 void set_name(char* name) {
duke@435 122 assert(strlen(name) <= name_length_max, "exceeds maximum name length");
duke@435 123 strcpy(_name, name);
duke@435 124 }
duke@435 125
duke@435 126 // get an argument value
duke@435 127 const char* arg(int i) const {
duke@435 128 assert(i>=0 && i<arg_count_max, "invalid argument index");
duke@435 129 return _arg[i];
duke@435 130 }
duke@435 131
duke@435 132 // set an argument value
duke@435 133 void set_arg(int i, char* arg) {
duke@435 134 assert(i>=0 && i<arg_count_max, "invalid argument index");
duke@435 135 if (arg == NULL) {
duke@435 136 _arg[i][0] = '\0';
duke@435 137 } else {
duke@435 138 assert(strlen(arg) <= arg_length_max, "exceeds maximum argument length");
duke@435 139 strcpy(_arg[i], arg);
duke@435 140 }
duke@435 141 }
duke@435 142
duke@435 143 // create an operation of a given name
duke@435 144 AttachOperation(char* name) {
duke@435 145 set_name(name);
duke@435 146 for (int i=0; i<arg_count_max; i++) {
duke@435 147 set_arg(i, NULL);
duke@435 148 }
duke@435 149 }
duke@435 150
duke@435 151 // complete operation by sending result code and any result data to the client
duke@435 152 virtual void complete(jint result, bufferedStream* result_stream) = 0;
duke@435 153 };
duke@435 154 #endif // SERVICES_KERNEL
stefank@2314 155
stefank@2314 156 #endif // SHARE_VM_SERVICES_ATTACHLISTENER_HPP

mercurial