• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/vm/services/attachListener.hpp@db9981fd3124 (annotated)

src/share/vm/services/attachListener.hpp

Wed, 23 Jan 2013 13:02:39 -0500

author

jprovino

date

Wed, 23 Jan 2013 13:02:39 -0500

changeset 4542

db9981fd3124

parent 4167

9855b7e559ae

child 4544

3c9bc17b9403

permissions

-rw-r--r--

8005915: Unify SERIALGC and INCLUDE_ALTERNATE_GCS
Summary: Rename INCLUDE_ALTERNATE_GCS to INCLUDE_ALL_GCS and replace SERIALGC with INCLUDE_ALL_GCS.
Reviewed-by: coleenp, stefank

duke@435	1	/*
jprovino@4165	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"
jprovino@4542	31	#include "utilities/macros.hpp"
stefank@2314	32
duke@435	33	// The AttachListener thread services a queue of operations that are enqueued
duke@435	34	// by client tools. Each operation is identified by a name and has up to 3
duke@435	35	// arguments. The operation name is mapped to a function which performs the
duke@435	36	// operation. The function is called with an outputStream which is can use to
duke@435	37	// write any result data (for examples the properties command serializes
duke@435	38	// properties names and values to the output stream). When the function
duke@435	39	// complets the result value and any result data is returned to the client
duke@435	40	// tool.
duke@435	41
duke@435	42	#ifndef SERVICES_KERNEL
duke@435	43
duke@435	44	class AttachOperation;
duke@435	45
duke@435	46	typedef jint (*AttachOperationFunction)(AttachOperation* op, outputStream* out);
duke@435	47
duke@435	48	struct AttachOperationFunctionInfo {
duke@435	49	const char* name;
duke@435	50	AttachOperationFunction func;
duke@435	51	};
duke@435	52	#endif // SERVICES_KERNEL
duke@435	53
duke@435	54	class AttachListener: AllStatic {
duke@435	55	public:
jprovino@4165	56	static void init() NOT_SERVICES_RETURN;
jprovino@4165	57	static void abort() NOT_SERVICES_RETURN;
duke@435	58
duke@435	59	// invoke to perform clean-up tasks when all clients detach
jprovino@4165	60	static void detachall() NOT_SERVICES_RETURN;
duke@435	61
duke@435	62	// indicates if the Attach Listener needs to be created at startup
jprovino@4165	63	static bool init_at_startup() NOT_SERVICES_RETURN_(false);
duke@435	64
duke@435	65	// indicates if we have a trigger to start the Attach Listener
jprovino@4165	66	static bool is_init_trigger() NOT_SERVICES_RETURN_(false);
duke@435	67
jprovino@4165	68	#if !INCLUDE_SERVICES
duke@435	69	static bool is_attach_supported() { return false; }
jprovino@4165	70	#else
duke@435	71	private:
duke@435	72	static volatile bool _initialized;
duke@435	73
duke@435	74	public:
duke@435	75	static bool is_initialized() { return _initialized; }
duke@435	76	static void set_initialized() { _initialized = true; }
duke@435	77
duke@435	78	// indicates if this VM supports attach-on-demand
duke@435	79	static bool is_attach_supported() { return !DisableAttachMechanism; }
duke@435	80
duke@435	81	// platform specific initialization
duke@435	82	static int pd_init();
duke@435	83
duke@435	84	// platform specific operation
duke@435	85	static AttachOperationFunctionInfo* pd_find_operation(const char* name);
duke@435	86
duke@435	87	// platform specific flag change
duke@435	88	static jint pd_set_flag(AttachOperation* op, outputStream* out);
duke@435	89
duke@435	90	// platform specific detachall
duke@435	91	static void pd_detachall();
duke@435	92
duke@435	93	// platform specific data dump
duke@435	94	static void pd_data_dump();
duke@435	95
duke@435	96	// dequeue the next operation
duke@435	97	static AttachOperation* dequeue();
jprovino@4165	98	#endif // !INCLUDE_SERVICES
duke@435	99	};
duke@435	100
jprovino@4165	101	#if INCLUDE_SERVICES
zgu@3900	102	class AttachOperation: public CHeapObj<mtInternal> {
duke@435	103	public:
duke@435	104	enum {
duke@435	105	name_length_max = 16, // maximum length of name
duke@435	106	arg_length_max = 1024, // maximum length of argument
duke@435	107	arg_count_max = 3 // maximum number of arguments
duke@435	108	};
duke@435	109
duke@435	110	// name of special operation that can be enqueued when all
duke@435	111	// clients detach
duke@435	112	static char* detachall_operation_name() { return (char*)"detachall"; }
duke@435	113
duke@435	114	private:
duke@435	115	char _name[name_length_max+1];
duke@435	116	char _arg[arg_count_max][arg_length_max+1];
duke@435	117
duke@435	118	public:
duke@435	119	const char* name() const { return _name; }
duke@435	120
duke@435	121	// set the operation name
duke@435	122	void set_name(char* name) {
duke@435	123	assert(strlen(name) <= name_length_max, "exceeds maximum name length");
duke@435	124	strcpy(_name, name);
duke@435	125	}
duke@435	126
duke@435	127	// get an argument value
duke@435	128	const char* arg(int i) const {
duke@435	129	assert(i>=0 && i<arg_count_max, "invalid argument index");
duke@435	130	return _arg[i];
duke@435	131	}
duke@435	132
duke@435	133	// set an argument value
duke@435	134	void set_arg(int i, char* arg) {
duke@435	135	assert(i>=0 && i<arg_count_max, "invalid argument index");
duke@435	136	if (arg == NULL) {
duke@435	137	_arg[i][0] = '\0';
duke@435	138	} else {
duke@435	139	assert(strlen(arg) <= arg_length_max, "exceeds maximum argument length");
duke@435	140	strcpy(_arg[i], arg);
duke@435	141	}
duke@435	142	}
duke@435	143
duke@435	144	// create an operation of a given name
duke@435	145	AttachOperation(char* name) {
duke@435	146	set_name(name);
duke@435	147	for (int i=0; i<arg_count_max; i++) {
duke@435	148	set_arg(i, NULL);
duke@435	149	}
duke@435	150	}
duke@435	151
duke@435	152	// complete operation by sending result code and any result data to the client
duke@435	153	virtual void complete(jint result, bufferedStream* result_stream) = 0;
duke@435	154	};
jprovino@4165	155	#endif // INCLUDE_SERVICES
stefank@2314	156
stefank@2314	157	#endif // SHARE_VM_SERVICES_ATTACHLISTENER_HPP