com.gemstone.org.jgroups.stack.Protocol Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gemfire-jgroups Show documentation
Show all versions of gemfire-jgroups Show documentation
SnappyData store based off Pivotal GemFireXD
The newest version!
/** Notice of modification as required by the LGPL
* This file was modified by Gemstone Systems Inc. on
* $Date$
**/
// $Id: Protocol.java,v 1.34 2005/10/27 16:05:04 belaban Exp $
package com.gemstone.org.jgroups.stack;
import com.gemstone.org.jgroups.util.GemFireTracer;
import com.gemstone.org.jgroups.Event;
import com.gemstone.org.jgroups.util.Queue;
import com.gemstone.org.jgroups.util.QueueClosedException;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
class UpHandler extends Thread {
private Queue mq=null;
private Protocol handler=null;
private ProtocolObserver observer=null;
protected final GemFireTracer log=GemFireTracer.getLog(this.getClass());
public UpHandler(Queue mq, Protocol handler, ProtocolObserver observer) {
super(GemFireTracer.GROUP, "TempName"); // GemStoneAddition
this.mq=mq;
this.handler=handler;
this.observer=observer;
if(handler != null)
setName("UpHandler (" + handler.getName() + ')');
else
setName("UpHandler");
setDaemon(true);
}
public void setObserver(ProtocolObserver observer) {
this.observer=observer;
}
/** Removes events from mq and calls handler.up(evt) */
@Override // GemStoneAddition
public void run() {
Event evt;
while(!mq.closed()) {
try {
evt=(Event)mq.remove();
if(evt == null) {
if(log.isWarnEnabled()) log.warn("removed null event");
continue;
}
if(observer != null) { // call debugger hook (if installed)
if(observer.up(evt, mq.size()) == false) { // false means discard event
return;
}
}
handler.up(evt);
}
catch(QueueClosedException queue_closed) {
break;
}
catch (VirtualMachineError err) { // GemStoneAddition
// If this ever returns, rethrow the error. We're poisoned
// now, so don't let this thread continue.
throw err;
}
catch(Throwable e) {
if(log.isWarnEnabled()) log.warn(getName() + " caught exception", e);
}
}
}
}
class DownHandler extends Thread {
private Queue mq=null;
private Protocol handler=null;
private ProtocolObserver observer=null;
protected final GemFireTracer log=GemFireTracer.getLog(this.getClass());
public DownHandler(Queue mq, Protocol handler, ProtocolObserver observer) {
super(GemFireTracer.GROUP, "TempName"); // GemStoneAddition
this.mq=mq;
this.handler=handler;
this.observer=observer;
if(handler != null)
setName("DownHandler (" + handler.getName() + ')');
else
setName("DownHandler");
setDaemon(true);
}
public void setObserver(ProtocolObserver observer) {
this.observer=observer;
}
/** Removes events from mq and calls handler.down(evt) */
@Override // GemStoneAddition
public void run() {
Event evt;
while(!mq.closed()) {
try {
evt=(Event)mq.remove();
if(evt == null) {
if(log.isWarnEnabled()) log.warn("removed null event");
continue;
}
if(observer != null) { // call debugger hook (if installed)
if(observer.down(evt, mq.size()) == false) { // false means discard event
continue;
}
}
int type=evt.getType();
if(type == Event.START || type == Event.STOP) {
if(handler.handleSpecialDownEvent(evt) == false)
continue;
}
handler.down(evt);
}
catch(QueueClosedException queue_closed) {
break;
}
catch (VirtualMachineError err) { // GemStoneAddition
// If this ever returns, rethrow the error. We're poisoned
// now, so don't let this thread continue.
throw err;
}
catch(Throwable e) {
if(log.isWarnEnabled()) log.warn(getName() + " caught exception", e);
}
}
}
}
/**
* The Protocol class provides a set of common services for protocol layers. Each layer has to
* be a subclass of Protocol and override a number of methods (typically just up(),
* Down and getName. Layers are stacked in a certain order to form
* a protocol stack. Events are passed from lower
* layers to upper ones and vice versa. E.g. a Message received by the UDP layer at the bottom
* will be passed to its higher layer as an Event. That layer will in turn pass the Event to
* its layer and so on, until a layer handles the Message and sends a response or discards it,
* the former resulting in another Event being passed down the stack.
* Each layer has 2 FIFO queues, one for up Events and one for down Events. When an Event is
* received by a layer (calling the internal upcall ReceiveUpEvent), it is placed
* in the up-queue where it will be retrieved by the up-handler thread which will invoke method
* Up of the layer. The same applies for Events traveling down the stack. Handling
* of the up-handler and down-handler threads and the 2 FIFO queues is donw by the Protocol
* class, subclasses will almost never have to override this behavior.
* The important thing to bear in mind is that Events have to passed on between layers in FIFO
* order which is guaranteed by the Protocol implementation and must be guranteed by subclasses
* implementing their on Event queuing.
* Note that each class implementing interface Protocol MUST provide an empty, public
* constructor !
*/
public abstract class Protocol {
protected final Properties props=new Properties();
protected Protocol up_prot=null;
public /*GemStoneAddition*/ Protocol down_prot=null;
public ProtocolStack stack=null; // GemStoneAddition - need this to be public
protected final Queue up_queue=new Queue();
protected final Queue down_queue=new Queue();
protected UpHandler up_handler=null;
protected int up_thread_prio=-1;
protected DownHandler down_handler=null;
protected int down_thread_prio=-1;
protected ProtocolObserver observer=null; // hook for debugger
private final static long THREAD_JOIN_TIMEOUT=1000;
protected boolean down_thread=true; // determines whether the down_handler thread should be started
protected boolean up_thread=true; // determines whether the up_handler thread should be started
//GemStoneAddition - turn stats off
public/*GemStoneAddition*/ boolean stats=false; // determines whether to collect statistics (and expose them via JMX)
public final GemFireTracer log=GemFireTracer.getLog(this.getClass()); // GemStoneAddition (also made public for performance)
public static boolean trace=GemFireTracer.DEBUG;
//protected boolean trace=log.isTraceEnabled();
public/*GemStoneAddition*/ boolean warn=log.isWarnEnabled();
// start GemStoneAddition
static protected final int enumUDP = 1;
static protected final int enumPING = 2;
static protected final int enumNAKACK = 3;
static protected final int enumUNICAST = 4;
static protected final int enumSTABLE = 5;
static protected final int enumFRAG2 = 6;
static protected final int enumGMS = 7;
static protected final int enumFC = 8;
static protected final int enumVIEWSYNC = 9;
static protected final int enumFD = 10;
static protected final int enumTCPGOSSIP = 11;
static protected final int enumDISCOVERY = 12;
static protected final int enumDirAck = 13;
public int getProtocolEnum() {
return -1; // not defined
}
// end GemStone addition
public long nanoTime() {
return System.nanoTime();
}
/**
* Configures the protocol initially. A configuration string consists of name=value
* items, separated by a ';' (semicolon), e.g.:
* "loopback=false;unicast_inport=4444"
*
*/
public boolean setProperties(Properties props) {
if(props != null)
this.props.putAll(props);
return true;
}
/** Called by Configurator. Removes 2 properties which are used by the Protocol directly and then
* calls setProperties(), which might invoke the setProperties() method of the actual protocol instance.
*/
public boolean setPropertiesInternal(Properties props) {
String str;
this.props.putAll(props);
str=props.getProperty("down_thread");
if(str != null) {
down_thread=Boolean.valueOf(str).booleanValue();
props.remove("down_thread");
}
str=props.getProperty("down_thread_prio");
if(str != null) {
down_thread_prio=Integer.parseInt(str);
props.remove("down_thread_prio");
}
str=props.getProperty("up_thread");
if(str != null) {
up_thread=Boolean.valueOf(str).booleanValue();
props.remove("up_thread");
}
str=props.getProperty("up_thread_prio");
if(str != null) {
up_thread_prio=Integer.parseInt(str);
props.remove("up_thread_prio");
}
str=props.getProperty("stats");
if(str != null) {
stats=Boolean.valueOf(str).booleanValue();
props.remove("stats");
}
return setProperties(props);
}
public Properties getProperties() {
return props;
}
public boolean isTrace() {
return trace;
}
@SuppressFBWarnings(value="ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD",justification="GemFire doesn't use this method")
public void setTrace(boolean trace) {
Protocol/*GemStoneModification*/.trace=trace;
}
public boolean isWarn() {
return warn;
}
public void setWarn(boolean warn) {
this.warn=warn;
}
public boolean upThreadEnabled() {
return up_thread;
}
public boolean downThreadEnabled() {
return down_thread;
}
public boolean statsEnabled() {
return stats;
}
public void enableStats(boolean flag) {
stats=flag;
}
public void resetStats() {
;
}
public String printStats() {
return null;
}
public Map dumpStats() {
return null;
}
public void setObserver(ProtocolObserver observer) {
this.observer=observer;
observer.setProtocol(this);
if(up_handler != null)
up_handler.setObserver(observer);
if(down_handler != null)
down_handler.setObserver(observer);
}
/**
* Called after instance has been created (null constructor) and before protocol is started.
* Properties are already set. Other protocols are not yet connected and events cannot yet be sent.
* @exception Exception Thrown if protocol cannot be initialized successfully. This will cause the
* ProtocolStack to fail, so the channel constructor will throw an exception
*/
public void init() throws Exception {
}
/**
* This method is called on a {@link com.gemstone.org.jgroups.Channel#connect(String)}. Starts work.
* Protocols are connected and queues are ready to receive events.
* Will be called from bottom to top. This call will replace
* the START and START_OK events.
* @exception Exception Thrown if protocol cannot be started successfully. This will cause the ProtocolStack
* to fail, so {@link com.gemstone.org.jgroups.Channel#connect(String)} will throw an exception
*/
public void start() throws Exception {
}
/**
* This method is called on a {@link com.gemstone.org.jgroups.Channel#disconnect()}. Stops work (e.g. by closing multicast socket).
* Will be called from top to bottom. This means that at the time of the method invocation the
* neighbor protocol below is still working. This method will replace the
* STOP, STOP_OK, CLEANUP and CLEANUP_OK events. The ProtocolStack guarantees that
* when this method is called all messages in the down queue will have been flushed
*/
public void stop() {
}
/**
* This method is called on a {@link com.gemstone.org.jgroups.Channel#close()}.
* Does some cleanup; after the call the VM will terminate
*/
public void destroy() {
}
public Queue getUpQueue() {
return up_queue;
} // used by Debugger (ProtocolView)
public Queue getDownQueue() {
return down_queue;
} // used by Debugger (ProtocolView)
/** List of events that are required to be answered by some layer above.
@return Vector (of Integers) */
public Vector requiredUpServices() {
return null;
}
/** List of events that are required to be answered by some layer below.
@return Vector (of Integers) */
public Vector requiredDownServices() {
return null;
}
/** List of events that are provided to layers above (they will be handled when sent down from
above).
@return Vector (of Integers) */
public Vector providedUpServices() {
return null;
}
/** List of events that are provided to layers below (they will be handled when sent down from
below).
@return Vector (of Integers) */
public Vector providedDownServices() {
return null;
}
public abstract String getName(); // all protocol names have to be unique !
public Protocol getUpProtocol() {
return up_prot;
}
public Protocol getDownProtocol() {
return down_prot;
}
public void setUpProtocol(Protocol up_prot) {
this.up_prot=up_prot;
}
public void setDownProtocol(Protocol down_prot) {
this.down_prot=down_prot;
}
public void setProtocolStack(ProtocolStack stack) {
this.stack=stack;
}
/** Used internally. If overridden, call this method first. Only creates the up_handler thread
if up_thread is true */
public void startUpHandler() {
if(up_thread) {
if(up_handler == null) {
up_handler=new UpHandler(up_queue, this, observer);
if(up_thread_prio >= 0) {
try {
up_handler.setPriority(up_thread_prio);
}
catch (VirtualMachineError err) { // GemStoneAddition
// If this ever returns, rethrow the error. We're poisoned
// now, so don't let this thread continue.
throw err;
}
catch(Throwable t) {
if(log.isErrorEnabled()) log.error("priority " + up_thread_prio +
" could not be set for thread", t);
}
}
up_handler.setDaemon(true); // GemStoneAddition
up_handler.start();
}
}
}
/** Used internally. If overridden, call this method first. Only creates the down_handler thread
if down_thread is true */
public void startDownHandler() {
if(down_thread) {
if(down_handler == null) {
down_handler=new DownHandler(down_queue, this, observer);
if(down_thread_prio >= 0) {
try {
down_handler.setPriority(down_thread_prio);
}
catch (VirtualMachineError err) { // GemStoneAddition
// If this ever returns, rethrow the error. We're poisoned
// now, so don't let this thread continue.
throw err;
}
catch(Throwable t) {
if(log.isErrorEnabled()) log.error("priority " + down_thread_prio +
" could not be set for thread", t);
}
}
down_handler.setDaemon(true); // GemStoneAddition
down_handler.start();
}
}
}
/** Used internally. If overridden, call parent's method first */
public void stopInternal() {
up_queue.close(false); // this should terminate up_handler thread
if(up_handler != null && up_handler.isAlive()) {
boolean interrupted = Thread.interrupted(); // GemStoneAddition
try {
up_handler.join(THREAD_JOIN_TIMEOUT);
}
catch(InterruptedException ex) {
interrupted = true; // GemStoneAddition
}
finally { // GemStoneAddition
if (interrupted) {
Thread.currentThread().interrupt();
}
}
if(up_handler != null && up_handler.isAlive()) {
up_handler.interrupt(); // still alive ? let's just kill it without mercy...
interrupted = Thread.interrupted(); // GemStoneAddition
try {
up_handler.join(THREAD_JOIN_TIMEOUT);
}
catch(InterruptedException ex) {
interrupted = true;; // GemStoneAddition
}
finally { // GemStoneAddition
if (interrupted) {
Thread.currentThread().interrupt();
}
}
if(up_handler != null && up_handler.isAlive())
if(log.isErrorEnabled()) log.error("up_handler thread for " + getName() +
" was interrupted (in order to be terminated), but is still alive");
}
}
up_handler=null;
down_queue.close(false); // this should terminate down_handler thread
if(down_handler != null && down_handler.isAlive()) {
boolean interrupted = Thread.interrupted(); // GemStoneAddition
try {
down_handler.join(THREAD_JOIN_TIMEOUT);
}
catch(InterruptedException ex) {
interrupted = true; // GemStoneAddition
}
finally { // GemStoneAddition
if (interrupted) {
Thread.currentThread().interrupt();
}
}
if(down_handler != null && down_handler.isAlive()) {
down_handler.interrupt(); // still alive ? let's just kill it without mercy...
interrupted = Thread.interrupted(); // GemStoneAddition
try {
down_handler.join(THREAD_JOIN_TIMEOUT);
}
catch(InterruptedException ex) {
interrupted = true;
}
finally { // GemStoneAddition
if (interrupted) {
Thread.currentThread().interrupt();
}
}
if(down_handler != null && down_handler.isAlive())
if(log.isErrorEnabled()) log.error("down_handler thread for " + getName() +
" was interrupted (in order to be terminated), but is is still alive");
}
}
down_handler=null;
}
/** GemStoneAddition - for bypassing the stack */
public void tunnelEventUp(Event evt) {
receiveUpEvent(evt);
}
/** GemStoneAddition - for bypassing the stack */
public void tunnelEventDown(Event evt) {
receiveDownEvent(evt);
}
/**
* Internal method, should not be called by clients. Used by ProtocolStack. I would have
* used the 'friends' modifier, but this is available only in C++ ... If the up_handler thread
* is not available (down_thread == false), then directly call the up() method: we will run on the
* caller's thread (e.g. the protocol layer below us).
*/
protected void receiveUpEvent(Event evt) {
if(up_handler == null) {
long sTime = 0;
// gemstone addition
// This captures the total time spent in the current stack, including the
// time spent in the upper stacks.
if (stack.enableJgStackStats)
sTime = startJgStackEventTime();
if(observer != null) { // call debugger hook (if installed)
if(observer.up(evt, up_queue.size()) == false) { // false means discard event
return;
}
}
up(evt);
// gemstone addition
if (stack.enableJgStackStats)
endJgStackEventTime(sTime, true);
return;
}
try {
up_queue.add(evt);
}
catch(Exception e) {
if(log.isWarnEnabled()) log.warn("caught unexpected exception", e);
}
}
/**
* Internal method, should not be called by clients. Used by ProtocolStack. I would have
* used the 'friends' modifier, but this is available only in C++ ... If the down_handler thread
* is not available (down_thread == false), then directly call the down() method: we will run on the
* caller's thread (e.g. the protocol layer above us).
*/
protected void receiveDownEvent(Event evt) {
if(down_handler == null) {
long sTime = 0;
// gemstone addition
// This captures the total time spent in the current stack, including the
// time spent in the lower stacks.
if (stack.enableJgStackStats)
sTime = startJgStackEventTime();
if(observer != null) { // call debugger hook (if installed)
if(observer.down(evt, down_queue.size()) == false) { // false means discard event
return;
}
}
int type=evt.getType();
if(type == Event.START || type == Event.STOP) {
if(handleSpecialDownEvent(evt) == false)
return;
}
down(evt);
// gemstone addition
if (stack.enableJgStackStats)
endJgStackEventTime(sTime, false);
return;
}
try {
down_queue.add(evt);
}
catch(Exception e) {
if(log.isWarnEnabled()) log.warn("caught unexpected exception", e);
}
}
// start GemStoneAddition
// private void logStatEvent(boolean isUp, Event evt) {
// com.gemstone.gemfire.distributed.internal.DMStats stats = stack.gemfireStats;
// if (stats == null)
// return;
// String protName = this.getName();
// switch (evt.getType()) {
// case Event.MSG:
// if (protName.equals("UDP")) {
// if (isUp)
// stats.incjgUDPup(1);
// else
// stats.incjgUDPdown(1);
// }
// else if (protName.equals("NAKACK")) {
// if (isUp)
// stats.incjgNAKACKup(1);
// else
// stats.incjgNAKACKdown(1);
// }
// else if (protName.equals("UNICAST")) {
// if (isUp)
// stats.incjgUNICASTup(1);
// else
// stats.incjgUNICASTdown(1);
// }
// else if (protName.equals("STABLE")) {
// if (isUp)
// stats.incjgSTABLEup(1);
// else
// stats.incjgSTABLEdown(1);
// }
// else if (protName.equals("FRAG2")) {
// if (isUp)
// stats.incjgFRAG2up(1);
// else
// stats.incjgFRAG2down(1);
// }
// else if (protName.equals("GMS")) {
// if (isUp)
// stats.incjgGMSup(1);
// else
// stats.incjgGMSdown(1);
// }
// else if (protName.equals("FC")) {
// if (isUp)
// stats.incjgFCup(1);
// else
// stats.incjgFCdown(1);
// }
// else {
// log.warn("passUp not tracking events for protocol = " + protName);
// }
// break;
// default:
// // TODO: handle other types of events?
// break;
// }
// }
// end GemStone Addition
// start GemStoneAddition
/**
* Start a JGroups timing interval.
*
* @return a timer value to be passed to endTimeEvent
*/
protected long startJgStackEventTime() {
return nanoTime();
}
/**
* log the time delay for a passUp or passDown
*
* @param isUp true if this was an up event
* @param start the start time for this interval
*/
protected void endJgStackEventTime(long start, boolean isUp)
{
}
/**
* Causes the event to be forwarded to the next layer up in the hierarchy. Typically called
* by the implementation of Up (when done).
*/
public void passUp(Event evt) {
if(observer != null) { // call debugger hook (if installed)
if(observer.passUp(evt) == false) { // false means don't pass up (=discard) event
return;
}
}
// GemStoneAddition - removed obsolete threading model
up_prot.up(evt);
// start GemStoneAddition
// logStatEvent(true, evt);
// end GemStoneAddition
}
/**
* Causes the event to be forwarded to the next layer down in the hierarchy.Typically called
* by the implementation of Down (when done).
*/
public void passDown(Event evt) {
if(observer != null) { // call debugger hook (if installed)
if(observer.passDown(evt) == false) { // false means don't pass down (=discard) event
return;
}
}
if (down_prot != null) {
int type=evt.getType();
if(type == Event.START || type == Event.STOP) {
if (down_prot.handleSpecialDownEvent(evt) == false)
return;
}
down_prot.down(evt);
}
// start GemStoneAddition
// logStatEvent(false, evt);
// end GemStoneAddition
}
/**
* An event was received from the layer below. Usually the current layer will want to examine
* the event type and - depending on its type - perform some computation
* (e.g. removing headers from a MSG event type, or updating the internal membership list
* when receiving a VIEW_CHANGE event).
* Finally the event is either a) discarded, or b) an event is sent down
* the stack using passDown() or c) the event (or another event) is sent up
* the stack using passUp().
*/
public void up(Event evt) {
passUp(evt);
}
/**
* An event is to be sent down the stack. The layer may want to examine its type and perform
* some action on it, depending on the event's type. If the event is a message MSG, then
* the layer may need to add a header to it (or do nothing at all) before sending it down
* the stack using passDown(). In case of a GET_ADDRESS event (which tries to
* retrieve the stack's address from one of the bottom layers), the layer may need to send
* a new response event back up the stack using passUp().
*/
public void down(Event evt) {
passDown(evt);
}
/** These are special internal events that should not be handled by protocols
* @return boolean True: the event should be passed further down the stack. False: the event should
* be discarded (not passed down the stack)
*/
protected boolean handleSpecialDownEvent(Event evt) {
switch(evt.getType()) {
case Event.START:
try {
start();
// if we're the transport protocol, reply with a START_OK up the stack
if(down_prot == null) {
passUp(new Event(Event.START_OK, Boolean.TRUE));
return false; // don't pass down the stack
}
else
return true; // pass down the stack
}
catch(Exception e) {
passUp(new Event(Event.START_OK, new Exception("exception caused by " + getName() + ".start()", e)));
return false;
}
case Event.STOP:
stop();
if(down_prot == null) {
passUp(new Event(Event.STOP_OK, Boolean.TRUE));
return false; // don't pass down the stack
}
else
return true; // pass down the stack
default:
return true; // pass down by default
}
}
}