hydra

Class ClientMgr

java.lang.Object

hydra.ClientMgr

public class ClientMgr
extends Object

Creates, starts, and stops client vms, among other things.

Constructor Summary

Constructors

Constructor and Description
ClientMgr()

Method Summary

Modifier and Type	Method and Description
protected static void	_reboot(String srcName, int srcVmid, int srcActionId, String reason, RebootInfo target) Reboots the target host.
protected static void	_startClientVm(String srcName, int srcVmid, int srcActionId, String reason, int syncMode, ClientVmInfo target) Starts the target client VM.
protected static void	_stopClientVm(String srcName, int srcVmid, int srcActionId, String reason, int syncMode, int stopMode, int startMode, ClientVmInfo target) Stops the target client VM.
protected static ClientVmRecord	bounceUnitTestVm(int pid) Does kill type stops for unit test vms followed by immediate restart.
protected static boolean	clientVmsPermanentlyStopped()
protected static Map	createClients(Collection cds, Map tgs) Creates client vm records from a set of client descriptions and threadgroups.
static List<List<String>>	getClientMapping() Returns the client mapping.
protected static ClientVmRecord	getClientVm(int vmid) Returns client vm records with the given id from the master list.
protected static Vector	getClientVmids() Returns the VM IDs (as Integers) for all client VMs, regardless of whether the VMs are currently started or stopped.
static Map	getClientVms() Returns the master list of client vm records (vmid,vm).
protected static Vector	getOtherClientVmids(int vmid) Returns the VM IDs (as Integers) for all client VMs except the given one, regardless of whether the VMs are currently started or stopped.
protected static int	getPid(int vmid) Used by new client processes to get an accurate PID (needed for Linux) before they start their client threads.
protected static Integer	getVmid(int pid) Used by hydra clients to get the VM ID corresponding to a PID.
protected static Integer	getVmid(String host, int pid) Used by hydra clients to get the VM ID corresponding to a host and PID.
protected static boolean	hasDynamicActions() Returns true if there are uninterruptible dynamic actions.
static void	printProcessStacks() Prints process stacks for all live client vms.
protected static void	printProcessStacks(ClientVmRecord vm) Prints process stacks for a specific client vm.
protected static void	reboot(String srcName, int srcVmid, int srcActionId, String reason, RebootInfo target) Reboots the target host.
protected static void	refuseDynamicActions() Tells the test to refuse any further dynamic actions.
static HydraThreadGroupInfo	registerClient(int vmid, int tid, RemoteTestModuleIF mod) Used by new client threads to tell master they are ready and to get their threadgroup information.
static void	registerClientDisconnect(int vmid) Used by a dynamic action thread to tell master a JVM has finished disconnecting.
protected static ClientVmInfo	reserveClientVmForStart(String srcName, int srcVmid, ClientVmInfo target) Reserves a client VM matching the specified target info for future start.
protected static ClientVmInfo	reserveClientVmForStop(String srcName, int srcVmid, int syncMode, int stopMode, ClientVmInfo target) Reserves a client VM matching the specified target info for future stop.
protected static RebootInfo	reserveForReboot(String srcName, int srcVmid, String target, boolean liveOnly) Reserves the host for future reboot.
protected static void	runClientShutdownHooks(Map vms) run client shutdown hooks without shutting down the clients
protected static void	startClients(String purpose, Map vms) Fires up the given client vms for the stated purpose.
protected static void	startClientVm(String srcName, int srcVmid, int srcActionId, String reason, int syncMode, ClientVmInfo target) Starts the target client VM.
protected static void	stopClients(Map vms, boolean closeConnection, boolean runShutdownHook) Tells the given client vms to exit.
protected static void	stopClientVm(String srcName, int srcVmid, int srcActionId, String reason, int syncMode, int stopMode, int startMode, ClientVmInfo target) Stops the target client VM.
protected static void	waitForClientsToDie(Map vms) Waits Prms.maxClientShutdownWaitSec for the given client vms to come down.
protected static void	waitForClientsToRegister(Map vms) Waits Prms.maxClientStartupWaitSec for the given client vms to register all their client threads with master.
protected static void	waitForClientToDisconnect(ClientVmRecord vm) Waits Prms.maxClientShutdownWaitSec for the given client vm to disconnect.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientMgr

public ClientMgr()

Method Detail

getClientVm

protected static ClientVmRecord getClientVm(int vmid)

Returns client vm records with the given id from the master list.

getClientVms

public static Map getClientVms()

Returns the master list of client vm records (vmid,vm).

getClientMapping

public static List<List<String>> getClientMapping()

Returns the client mapping.

createClients

protected static Map createClients(Collection cds,
                                   Map tgs)

Creates client vm records from a set of client descriptions and threadgroups.

Returns:

map of client vm records, indexed by vmid

startClients

protected static void startClients(String purpose,
                                   Map vms)

Fires up the given client vms for the stated purpose.

waitForClientsToRegister

protected static void waitForClientsToRegister(Map vms)

Waits Prms.maxClientStartupWaitSec for the given client vms to register all their client threads with master.

getVmid

protected static Integer getVmid(String host,
                                 int pid)

Used by hydra clients to get the VM ID corresponding to a host and PID. There are no guarantees that the VM ID is valid for dynamic actions.

getVmid

protected static Integer getVmid(int pid)

Used by hydra clients to get the VM ID corresponding to a PID. There are no guarantees that the VM ID is valid for dynamic actions.

getPid

protected static int getPid(int vmid)

Used by new client processes to get an accurate PID (needed for Linux) before they start their client threads. This method must block until the master has recorded the PID for the newly started vm.

registerClient

public static HydraThreadGroupInfo registerClient(int vmid,
                                                  int tid,
                                                  RemoteTestModuleIF mod)

Used by new client threads to tell master they are ready and to get their threadgroup information. The last thread to show up triggers the vm to go live.

registerClientDisconnect

public static void registerClientDisconnect(int vmid)

Used by a dynamic action thread to tell master a JVM has finished disconnecting.

stopClients

protected static void stopClients(Map vms,
                                  boolean closeConnection,
                                  boolean runShutdownHook)

Tells the given client vms to exit. Optionally asks clients to disconnect from GemFire before exiting.

Disconnect should only be used if all client threads are finished doing work, to prevent spurious error reporting.

runClientShutdownHooks

protected static void runClientShutdownHooks(Map vms)

run client shutdown hooks without shutting down the clients

waitForClientsToDie

protected static void waitForClientsToDie(Map vms)

Waits Prms.maxClientShutdownWaitSec for the given client vms to come down.

waitForClientToDisconnect

protected static void waitForClientToDisconnect(ClientVmRecord vm)

Waits Prms.maxClientShutdownWaitSec for the given client vm to disconnect.

printProcessStacks

public static void printProcessStacks()

Prints process stacks for all live client vms. Throw in the master also.

printProcessStacks

protected static void printProcessStacks(ClientVmRecord vm)

Prints process stacks for a specific client vm.

reserveClientVmForStop

protected static ClientVmInfo reserveClientVmForStop(String srcName,
                                                     int srcVmid,
                                                     int syncMode,
                                                     int stopMode,
                                                     ClientVmInfo target)
                                              throws ClientVmNotFoundException

Reserves a client VM matching the specified target info for future stop. Returns null if no match is found.

Parameters:

srcName - Thread name for the invoking client.

srcVmid - Logical VM id for the invoking client.

syncMode - Synchronization mode for the dynamic stop.

stopMode - Stop mode for the dynamic stop.

target - Information used to select the target client VM.

Returns:

Fully specified information for the selected VM.

Throws:

ClientVmNotFoundException - if no match could be made.

IllegalArgumentException - if the target info is inconsistent with any known VM or forces deadlock.

DynamicActionException - if the test is terminating and refuses to allow any further dynamic actions.

reserveClientVmForStart

protected static ClientVmInfo reserveClientVmForStart(String srcName,
                                                      int srcVmid,
                                                      ClientVmInfo target)
                                               throws ClientVmNotFoundException

Reserves a client VM matching the specified target info for future start. Returns null if no match is found.

Parameters:

srcName - Thread name for the invoking client.

srcVmid - Logical VM id for the invoking client.

target - Information used to select the target client VM.

Returns:

Fully specified information for the selected VM.

Throws:

ClientVmNotFoundException - if no match could be made.

IllegalArgumentException - if the target info is inconsistent with any known VM.

DynamicActionException - if the test is terminating and refuses to allow any further dynamic actions.

stopClientVm

protected static void stopClientVm(String srcName,
                                   int srcVmid,
                                   int srcActionId,
                                   String reason,
                                   int syncMode,
                                   int stopMode,
                                   int startMode,
                                   ClientVmInfo target)

Stops the target client VM. Exceptions and hangs are handled here in case the source invoked asynchronously or has in turn become a target.

Creates and runs a thread to carry out the action asynchronously on behalf of the master. If the action is synchronous, it uses a remote signal to notify the source when it is complete. All exceptions are handled in the thread. None are thrown back to the client. Clients are left to time out on their own in the case of a hang.

startClientVm

protected static void startClientVm(String srcName,
                                    int srcVmid,
                                    int srcActionId,
                                    String reason,
                                    int syncMode,
                                    ClientVmInfo target)

Starts the target client VM. Exceptions and hangs are handled here in case the source invoked asynchronously or has in turn become a target.

Creates and runs a thread to carry out the action asynchronously on behalf of the master. If the action is synchronous, it uses a remote signal to notify the source when it is complete. All exceptions are handled in the thread. None are thrown back to the client. Clients are left to time out on their own in the case of a hang.

_stopClientVm

protected static void _stopClientVm(String srcName,
                                    int srcVmid,
                                    int srcActionId,
                                    String reason,
                                    int syncMode,
                                    int stopMode,
                                    int startMode,
                                    ClientVmInfo target)

Stops the target client VM. Throws no exceptions.

_startClientVm

protected static void _startClientVm(String srcName,
                                     int srcVmid,
                                     int srcActionId,
                                     String reason,
                                     int syncMode,
                                     ClientVmInfo target)

Starts the target client VM. Throws no exceptions.

bounceUnitTestVm

protected static ClientVmRecord bounceUnitTestVm(int pid)
                                          throws RemoteException

Does kill type stops for unit test vms followed by immediate restart. Returns the new vm record. Does not bother to synchronize since this is taken care of in the unit test controller (see dunit.VM).

Throws:

RemoteException

getClientVmids

protected static Vector getClientVmids()

Returns the VM IDs (as Integers) for all client VMs, regardless of whether the VMs are currently started or stopped.

getOtherClientVmids

protected static Vector getOtherClientVmids(int vmid)

Returns the VM IDs (as Integers) for all client VMs except the given one, regardless of whether the VMs are currently started or stopped.

clientVmsPermanentlyStopped

protected static boolean clientVmsPermanentlyStopped()

refuseDynamicActions

protected static void refuseDynamicActions()

Tells the test to refuse any further dynamic actions. Invoked when the test is terminating task execution.

hasDynamicActions

protected static boolean hasDynamicActions()

Returns true if there are uninterruptible dynamic actions.

reserveForReboot

protected static RebootInfo reserveForReboot(String srcName,
                                             int srcVmid,
                                             String target,
                                             boolean liveOnly)
                                      throws RebootHostNotFoundException

Reserves the host for future reboot.

Parameters:

srcName - Thread name for the invoking client.

srcVmid - Logical VM id for the invoking client.

target - The host to reboot.

liveOnly - Whether to return only processes that were live at reboot.

Returns:

Info about processes running on the host.

Throws:

RebootHostNotFoundException - if the host is not available.

IllegalArgumentException - if the host is not used in the test.

DynamicActionException - if the test is terminating and refuses to allow any further dynamic actions.

reboot

protected static void reboot(String srcName,
                             int srcVmid,
                             int srcActionId,
                             String reason,
                             RebootInfo target)

Reboots the target host. Exceptions and hangs are handled here even though the method is only invoked in synchronous mode from the client.

Creates and runs a thread to carry out the action asynchronously on behalf of the master. Since the action is synchronous, it uses a remote signal to notify the source when it is complete. All exceptions are handled in the thread. None are thrown back to the client. Clients are left to time out on their own in the case of a hang.

_reboot

protected static void _reboot(String srcName,
                              int srcVmid,
                              int srcActionId,
                              String reason,
                              RebootInfo target)

Reboots the target host. Throws no exceptions.