/**
* SAMOA - PROTOCOL FRAMEWORK
* Copyright (C) 2005 Olivier Rütti (EPFL) (olivier.rutti@a3.epfl.ch)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
package seqSamoa.protocols.abcast;
import java.io.OutputStream;
import java.util.LinkedList;
import seqSamoa.Message;
import seqSamoa.ProtocolModule;
import seqSamoa.ProtocolStack;
import seqSamoa.ServiceCallOrResponse;
import seqSamoa.exceptions.AlreadyExistingProtocolModuleException;
import seqSamoa.services.abcast.Abcast;
import seqSamoa.services.abcast.AbcastResponseParameters;
import seqSamoa.services.commit.UpdateState;
import seqSamoa.services.commit.UpdateStateCallParameters;
import seqSamoa.services.consensus.Consensus;
import seqSamoa.services.consensus.ConsensusCallParameters;
import seqSamoa.services.consensus.ConsensusResponseParameters;
import seqSamoa.services.pt2pt.PT2PT;
import seqSamoa.services.pt2pt.PT2PTCallParameters;
import seqSamoa.services.pt2pt.PT2PTResponseParameters;
import static_recovery.common.abcast.AtomicBroadcastRR;
import uka.transport.Transportable;
import framework.Constants;
import framework.GroupCommEventArgs;
import framework.GroupCommMessage;
import framework.PID;
import framework.libraries.Trigger;
import framework.libraries.serialization.TBoolean;
/**
* This class implement the ABcast with a static set of processes in recovery
* model. The algorithm implemented is inspired by the Rodriguez and Raynal
* paper.
*
* This Protocol need a Protocol that implements PT2PT, Consensus and
* UpdateState.
*
* The service implemented is Abcast (described in util/Services.java)
*/
public class ProtocolCrashRecoveryAbcast extends ProtocolModule implements Trigger {
final private static int MAX_PROCESSES = 7;
final private static int MAX_MESSAGES = 45;
// Service provided
private Abcast abcast;
// Service required
private Consensus consensus;
private PT2PT pt2pt;
private UpdateState updateState;
// The object containing the abcast algorithm
protected AtomicBroadcastRR handlers;
// The Executer
// It ABcasts a message
protected Abcast.Executer abcastExecuter;
// The Listeners
// It listen for consensus decision
protected Consensus.Listener consensusListener;
// It listen for rpt2pt messages
protected PT2PT.Listener pt2ptListener;
/**
* Constructor.
*
* @param name
* String identifier of the protocol
* @param stack
* The stack in which the module will be
* @param abcast
* Instance of service Abcast
* @param consensus
* Instance of service Consensus
* @param pt2pt
* Instance of service PT2PT
* @param updateState
* Instance of service UpdateState
*/
public ProtocolCrashRecoveryAbcast(String name, ProtocolStack stack,
Abcast abcast, Consensus consensus, PT2PT pt2pt,
UpdateState updateState) throws AlreadyExistingProtocolModuleException {
super(name, stack);
handlers = new AtomicBroadcastRR(this, stack.getStorage(), stack.getFlowControl(), stack.getGroup(),
stack.getPID());
this.abcast = abcast;
this.consensus = consensus;
this.pt2pt = pt2pt;
this.updateState = updateState;
LinkedList<ServiceCallOrResponse> initiatedAbcast = new LinkedList<ServiceCallOrResponse>();
initiatedAbcast.add(ServiceCallOrResponse.createServiceCallOrResponse(pt2pt, true));
initiatedAbcast.add(ServiceCallOrResponse.createServiceCallOrResponse(consensus, true));
abcastExecuter = abcast.new Executer(this, initiatedAbcast) {
public void evaluate(Object params, Message dmessage) {
synchronized (this.parent) {
GroupCommEventArgs ga = new GroupCommEventArgs();
ga.addLast(dmessage.toGroupCommMessage());
handlers.handleAbcast(ga);
}
}
};
LinkedList<ServiceCallOrResponse> initiatedPt2pt = new LinkedList<ServiceCallOrResponse>();
for (int i=0;i<MAX_PROCESSES;i++)
initiatedPt2pt.add(ServiceCallOrResponse.createServiceCallOrResponse(pt2pt, true));
initiatedPt2pt.add(ServiceCallOrResponse.createServiceCallOrResponse(consensus, true));
initiatedPt2pt.add(ServiceCallOrResponse.createServiceCallOrResponse(updateState, true));
for (int i=0;i<MAX_MESSAGES;i++)
initiatedPt2pt.add(ServiceCallOrResponse.createServiceCallOrResponse(abcast, false));
pt2ptListener = pt2pt.new Listener(this, initiatedPt2pt) {
public void evaluate(PT2PTResponseParameters infos,
Transportable message) {
synchronized (this.parent) {
GroupCommEventArgs ga = new GroupCommEventArgs();
ga.addLast(message);
ga.addLast(infos.pid);
try {
handlers.handlePt2PtDeliver(ga);
} catch (Exception ex) {
throw new RuntimeException("ProtocolAbcast: "
+ "pt2ptListener: " + ex.getMessage());
}
}
}
};
LinkedList<ServiceCallOrResponse> initiatedCons = new LinkedList<ServiceCallOrResponse>();
for (int i=0;i<MAX_PROCESSES;i++)
initiatedCons.add(ServiceCallOrResponse.createServiceCallOrResponse(pt2pt, true));
initiatedCons.add(ServiceCallOrResponse.createServiceCallOrResponse(consensus, true));
for (int i=0;i<MAX_MESSAGES;i++)
initiatedCons.add(ServiceCallOrResponse.createServiceCallOrResponse(abcast, false));
consensusListener = consensus.new Listener(this, initiatedCons) {
public void evaluate(ConsensusResponseParameters infos,
Transportable message) {
synchronized (this.parent) {
GroupCommEventArgs ga = new GroupCommEventArgs();
ga.addLast(infos.id);
ga.addLast(message);
handlers.handleDecide(ga);
}
}
};
}
synchronized public void commit(Transportable o) {
GroupCommEventArgs e = new GroupCommEventArgs();
e.add(o);
try {
handlers.handleCheckpoint(e);
} catch (Exception ex) {
throw new RuntimeException("ProtocolAbcast: Commit: "
+ ex.getMessage());
}
}
synchronized public void recovery(boolean recovery) {
GroupCommEventArgs e = new GroupCommEventArgs();
e.add(new TBoolean(recovery));
try {
handlers.handleRecovery(e);
} catch (Exception ex) {
throw new RuntimeException("ProtocolAbcast: Recovery: "
+ ex.getMessage());
}
}
synchronized public void dump(OutputStream os) {
handlers.dump(os);
}
/**
* Manage the triggering of the events
*/
public void trigger(int type, GroupCommEventArgs l) {
switch (type) {
case Constants.PT2PTSEND:
Transportable message = l.remove(0);
PID pid = (PID) l.remove(0);
Transportable key = l.remove(0);
PT2PTCallParameters rparams = new PT2PTCallParameters(pid, key);
pt2pt.call(rparams, new Message(message, pt2ptListener));
break;
case Constants.KILLMESSAGE:
Transportable kkey = l.remove(0);
PT2PTCallParameters rkparams = new PT2PTCallParameters(null, kkey);
pt2pt.call(rkparams, null);
break;
case Constants.PROPOSE:
Transportable id = l.remove(0);
Transportable cmessage = l.remove(0);
ConsensusCallParameters cparams = new ConsensusCallParameters(null,
id);
consensus.call(cparams, new Message(cmessage, consensusListener));
break;
case Constants.ADELIVER:
GroupCommMessage gm = (GroupCommMessage) l.remove(0);
Message dmessage = new Message(gm);
PID apid = (PID) l.remove(0);
AbcastResponseParameters infos = new AbcastResponseParameters(apid);
abcast.response(infos, dmessage);
break;
case Constants.UPDATESTATE:
Transportable state = l.remove(0);
UpdateStateCallParameters uparams = new UpdateStateCallParameters(
state);
updateState.call(uparams, null);
break;
default:
throw new RuntimeException("Error : ProtocolAbcast : trigger"
+ type + "Trying to send an unknown event type!");
}
}
}