/**
* Check for the given channel of the given port to see if variables are needed for recording read
* offset and write offset. If the buffer size of a channel divides the readTokens and writeTokens
* given in the argument, then there is no need for the variables. Otherwise the integer offsets
* are replaced with variables and the code to initialize these variables are generated.
*
* @param port The port to be checked.
* @param channelNumber The channel number.
* @param readTokens The number of tokens read.
* @param writeTokens The number of tokens written.
* @return Code that declares the read and write offset variables.
* @exception IllegalActionException If getting the rate or reading parameters throws it.
*/
protected String _createOffsetVariablesIfNeeded(
IOPort port, int channelNumber, int readTokens, int writeTokens)
throws IllegalActionException {
StringBuffer code = new StringBuffer();
CodeGeneratorHelper helper = (CodeGeneratorHelper) _getHelper(port.getContainer());
int bufferSize = helper.getBufferSize(port, channelNumber);
if (bufferSize != 0 && (readTokens % bufferSize != 0 || writeTokens % bufferSize != 0)) {
// Increase the buffer size of that channel to the power of two.
int newBufferSize = _ceilToPowerOfTwo(bufferSize);
helper.setBufferSize(port, channelNumber, newBufferSize);
int width;
if (port.isInput()) {
width = port.getWidth();
} else {
width = port.getWidthInside();
}
// We check again if the new bufferSize divides readTokens or
// writeTokens. If yes, we could avoid using variable to represent
// offset.
if (readTokens % newBufferSize != 0) {
// Declare the read offset variable.
StringBuffer channelReadOffset = new StringBuffer();
channelReadOffset.append(CodeGeneratorHelper.generateName(port));
if (width > 1) {
channelReadOffset.append("_" + channelNumber);
}
channelReadOffset.append("_readoffset");
String channelReadOffsetVariable = channelReadOffset.toString();
// code.append("static int " + channelReadOffsetVariable + " = "
// + helper.getReadOffset(port, channelNumber) + ";\n");
code.append("static int " + channelReadOffsetVariable + ";\n");
// Now replace the concrete offset with the variable.
helper.setReadOffset(port, channelNumber, channelReadOffsetVariable);
}
if (writeTokens % newBufferSize != 0) {
// Declare the write offset variable.
StringBuffer channelWriteOffset = new StringBuffer();
channelWriteOffset.append(CodeGeneratorHelper.generateName(port));
if (width > 1) {
channelWriteOffset.append("_" + channelNumber);
}
channelWriteOffset.append("_writeoffset");
String channelWriteOffsetVariable = channelWriteOffset.toString();
code.append("static int " + channelWriteOffsetVariable + ";\n");
// Now replace the concrete offset with the variable.
helper.setWriteOffset(port, channelNumber, channelWriteOffsetVariable);
}
}
return code.toString();
}
/**
* Create a guarded communication with a send communication. This constructor allows actors which
* are not CSPActors access to CSP functionality by providing their own
* ConditionalBranchController.
*
* @param guard The guard for the guarded communication statement represented by this object.
* @param port The IOPort containing the channel (and thus receiver) that this branch will try to
* rendezvous with.
* @param channel The channel in the IOPort that this branch is trying to rendezvous with.
* @param branchID The identification number assigned to this branch upon creation by the
* CSPActor.
* @param token The token this branch is trying to send.
* @param controller The controller that this branch uses.
* @exception IllegalActionException If the channel has more than one receiver or if the receiver
* is not of type CSPReceiver.
*/
public ConditionalSend(
boolean guard,
IOPort port,
int channel,
int branchID,
Token token,
ConditionalBranchController controller)
throws IllegalActionException {
super(guard, port, branchID, controller);
_port = port;
_channel = channel;
try {
port.workspace().getReadAccess();
if (!port.isOutput()) {
throw new IllegalActionException(
port, "ConditionalSend: " + "tokens only sent from an output port.");
}
if (channel >= port.getWidth() || channel < 0) {
throw new IllegalActionException(port, "ConditionalSend: " + "channel index out of range.");
}
Receiver[][] receivers = port.getRemoteReceivers();
if (receivers == null || receivers[channel] == null) {
throw new IllegalActionException(
port, "ConditionalSend: " + "Trying to rendezvous with null receiver");
}
if (!(receivers[channel][0] instanceof CSPReceiver)) {
throw new IllegalActionException(
port,
"ConditionalSend: "
+ "channel "
+ channel
+ " does not have a receiver "
+ "of type CSPReceiver.");
}
_setReceivers(receivers[channel]);
} finally {
port.workspace().doneReading();
}
_setToken(token);
}
/**
* Generate the initialize code for the associated SDF director.
*
* @return The generated initialize code.
* @exception IllegalActionException If the helper associated with an actor throws it while
* generating initialize code for the actor.
*/
public String generateInitializeCode() throws IllegalActionException {
StringBuffer code = new StringBuffer();
code.append(super.generateInitializeCode());
ptolemy.actor.CompositeActor container =
(ptolemy.actor.CompositeActor) getComponent().getContainer();
CodeGeneratorHelper containerHelper = (CodeGeneratorHelper) _getHelper(container);
// Generate code for creating external initial production.
Iterator outputPorts = container.outputPortList().iterator();
while (outputPorts.hasNext()) {
IOPort outputPort = (IOPort) outputPorts.next();
int rate = DFUtilities.getTokenInitProduction(outputPort);
if (rate > 0) {
for (int i = 0; i < outputPort.getWidthInside(); i++) {
if (i < outputPort.getWidth()) {
String name = outputPort.getName();
if (outputPort.isMultiport()) {
name = name + '#' + i;
}
for (int k = 0; k < rate; k++) {
code.append(CodeStream.indent(containerHelper.getReference(name + "," + k)));
code.append(" = ");
code.append(containerHelper.getReference("@" + name + "," + k));
code.append(";" + _eol);
}
}
}
// The offset of the ports connected to the output port is
// updated by outside director.
_updatePortOffset(outputPort, code, rate);
}
}
return code.toString();
}
/**
* Check to see if the buffer size for the current schedule is greater than the previous size. If
* so, set the buffer size to the current buffer size needed.
*
* @exception IllegalActionException If thrown while getting helper or buffer size.
*/
protected void _updatePortBufferSize() throws IllegalActionException {
ptolemy.domains.sdf.kernel.SDFDirector director =
(ptolemy.domains.sdf.kernel.SDFDirector) getComponent();
CompositeActor container = (CompositeActor) director.getContainer();
ptolemy.codegen.c.actor.TypedCompositeActor containerHelper =
(ptolemy.codegen.c.actor.TypedCompositeActor) _getHelper(container);
Iterator actors = container.deepEntityList().iterator();
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
CodeGeneratorHelper actorHelper = (CodeGeneratorHelper) _getHelper((NamedObj) actor);
Iterator inputPorts = actor.inputPortList().iterator();
while (inputPorts.hasNext()) {
IOPort inputPort = (IOPort) inputPorts.next();
for (int k = 0; k < inputPort.getWidth(); k++) {
int newCapacity = getBufferSize(inputPort, k);
int oldCapacity = actorHelper.getBufferSize(inputPort, k);
if (newCapacity > oldCapacity) {
actorHelper.setBufferSize(inputPort, k, newCapacity);
}
}
}
}
Iterator outputPorts = container.outputPortList().iterator();
while (outputPorts.hasNext()) {
IOPort outputPort = (IOPort) outputPorts.next();
for (int k = 0; k < outputPort.getWidthInside(); k++) {
int newCapacity = getBufferSize(outputPort, k);
int oldCapacity = containerHelper.getBufferSize(outputPort, k);
if (newCapacity > oldCapacity) {
containerHelper.setBufferSize(outputPort, k, newCapacity);
}
}
}
}
/**
* Read the control token input, transfer input tokens, and invoke prefire() of the selected
* refinement.
*
* @exception IllegalActionException If there is no director, or if the director's prefire()
* method throws it, or if this actor is not opaque.
*/
public boolean prefire() throws IllegalActionException {
if (_debugging) {
_debug("Calling prefire()");
}
try {
_workspace.getReadAccess();
super.prefire();
Case container = (Case) getContainer();
// Read from port parameters, including the control port.
Iterator portParameters = container.attributeList(PortParameter.class).iterator();
while (portParameters.hasNext()) {
PortParameter portParameter = (PortParameter) portParameters.next();
portParameter.update();
}
String controlValue = container.control.getToken().toString();
ComponentEntity refinement = container.getEntity(controlValue);
if (!(refinement instanceof Refinement)) {
refinement = container._default;
}
container._current = (Refinement) refinement;
// Transfer input tokens.
for (Iterator inputPorts = container.inputPortList().iterator();
inputPorts.hasNext() && !_stopRequested; ) {
IOPort port = (IOPort) inputPorts.next();
if (!(port instanceof ParameterPort)) {
Receiver[][] insideReceivers = port.deepGetReceivers();
for (int i = 0; i < port.getWidth(); i++) {
if (port.hasToken(i)) {
Token token = port.get(i);
if ((insideReceivers != null) && (insideReceivers[i] != null)) {
for (int j = 0; j < insideReceivers[i].length; j++) {
if (insideReceivers[i][j].getContainer().getContainer() == refinement) {
insideReceivers[i][j].put(token);
if (_debugging) {
_debug(
getFullName(),
"transferring input from "
+ port.getFullName()
+ " to "
+ (insideReceivers[i][j]).getContainer().getFullName());
}
}
}
}
}
}
}
}
if (_stopRequested) {
return false;
}
return container._current.prefire();
} finally {
_workspace.doneReading();
}
}
public ptolemy.data.Token getToken() throws IllegalActionException {
setExpression(_port.getWidth() + " * blockSize");
return super.getToken();
}
/**
* Check to see if variables are needed to represent read and write offsets for the given port.
*
* @return Code that declares the read and write offset variables.
* @exception IllegalActionException If getting the rate or reading parameters throws it.
*/
protected String _createOffsetVariablesIfNeeded() throws IllegalActionException {
StringBuffer code = new StringBuffer();
CompositeActor container = (CompositeActor) getComponent().getContainer();
boolean inline = ((BooleanToken) _codeGenerator.inline.getToken()).booleanValue();
StringBuffer tempCode = new StringBuffer();
Iterator outputPorts = container.outputPortList().iterator();
while (outputPorts.hasNext()) {
IOPort outputPort = (IOPort) outputPorts.next();
for (int i = 0; i < outputPort.getWidthInside(); i++) {
int readTokens = 0;
int writeTokens = 0;
// If each actor firing is inlined in the code, then read
// and write positions in the buffer must return to the
// previous values after one iteration of the container actor
// in order to avoid using read and write offset variables.
if (inline) {
readTokens = DFUtilities.getRate(outputPort);
writeTokens = readTokens;
// If each actor firing is wrapped in a function, then read
// and write positions in the buffer must return to the
// previous values after one firing of this actor or one
// firing of the actor that produces tokens consumed by the
// inside receiver of this actor in order to avoid using
// read and write offset variables.
} else {
readTokens = DFUtilities.getRate(outputPort);
Iterator sourcePorts = outputPort.insideSourcePortList().iterator();
label1:
while (sourcePorts.hasNext()) {
IOPort sourcePort = (IOPort) sourcePorts.next();
CodeGeneratorHelper helper =
(CodeGeneratorHelper) _getHelper(sourcePort.getContainer());
int width;
if (sourcePort.isInput()) {
width = sourcePort.getWidthInside();
} else {
width = sourcePort.getWidth();
}
for (int j = 0; j < width; j++) {
Iterator channels = helper.getSinkChannels(sourcePort, j).iterator();
while (channels.hasNext()) {
Channel channel = (Channel) channels.next();
if (channel.port == outputPort && channel.channelNumber == i) {
writeTokens = DFUtilities.getRate(sourcePort);
break label1;
}
}
}
}
}
tempCode.append(_createOffsetVariablesIfNeeded(outputPort, i, readTokens, writeTokens));
}
}
if (tempCode.length() > 0) {
code.append("\n" + _codeGenerator.comment(container.getName() + "'s offset variables"));
code.append(tempCode);
}
Iterator actors = container.deepEntityList().iterator();
while (actors.hasNext()) {
StringBuffer tempCode2 = new StringBuffer();
Actor actor = (Actor) actors.next();
Iterator inputPorts = actor.inputPortList().iterator();
while (inputPorts.hasNext()) {
IOPort inputPort = (IOPort) inputPorts.next();
for (int i = 0; i < inputPort.getWidth(); i++) {
int readTokens = 0;
int writeTokens = 0;
// If each actor firing is inlined in the code,
// then read and write positions in the buffer
// must return to the previous values after one
// iteration of the container actor in order to
// avoid using read and write offset variables.
if (inline) {
Variable firings = (Variable) ((NamedObj) actor).getAttribute("firingsPerIteration");
int firingsPerIteration = ((IntToken) firings.getToken()).intValue();
readTokens = DFUtilities.getRate(inputPort) * firingsPerIteration;
writeTokens = readTokens;
// If each actor firing is wrapped in a
// function, then read and write positions in
// the buffer must return to the previous
// values after one firing of this actor or
// one firing of the actor that produces
// tokens consumed by this actor in order to
// avoid using read and write offset
// variables.
} else {
readTokens = DFUtilities.getRate(inputPort);
Iterator sourcePorts = inputPort.sourcePortList().iterator();
label2:
while (sourcePorts.hasNext()) {
IOPort sourcePort = (IOPort) sourcePorts.next();
CodeGeneratorHelper helper =
(CodeGeneratorHelper) _getHelper(sourcePort.getContainer());
int width;
if (sourcePort.isInput()) {
width = sourcePort.getWidthInside();
} else {
width = sourcePort.getWidth();
}
for (int j = 0; j < width; j++) {
Iterator channels = helper.getSinkChannels(sourcePort, j).iterator();
while (channels.hasNext()) {
Channel channel = (Channel) channels.next();
if (channel.port == inputPort && channel.channelNumber == i) {
writeTokens = DFUtilities.getRate(sourcePort);
break label2;
}
}
}
}
}
tempCode2.append(_createOffsetVariablesIfNeeded(inputPort, i, readTokens, writeTokens));
}
}
if (tempCode2.length() > 0) {
code.append("\n" + _codeGenerator.comment(actor.getName() + "'s offset variables"));
code.append(tempCode2);
}
}
return code.toString();
}
/**
* Generate code for transferring enough tokens to fulfill the output production rate.
*
* @param outputPort The port to transfer tokens.
* @param code The string buffer that the generated code is appended to.
* @exception IllegalActionException If thrown while transferring tokens.
*/
public void generateTransferOutputsCode(IOPort outputPort, StringBuffer code)
throws IllegalActionException {
code.append(
CodeStream.indent(
_codeGenerator.comment("SDFDirector: " + "Transfer tokens to the outside.")));
int rate = DFUtilities.getTokenProductionRate(outputPort);
CompositeActor container = (CompositeActor) getComponent().getContainer();
ptolemy.codegen.c.actor.TypedCompositeActor compositeActorHelper =
(ptolemy.codegen.c.actor.TypedCompositeActor) _getHelper(container);
if (container instanceof TypedCompositeActorWithCoSimulation) {
if (_portNumber == 0) {
int numberOfOutputPorts = container.outputPortList().size();
code.append(_INDENT2 + "jobjectArray tokensToAllOutputPorts;" + _eol);
code.append(
_INDENT2
+ "jclass objClass = (*env)->FindClass(env, "
+ "\"Ljava/lang/Object;\");"
+ _eol);
code.append(
_INDENT2
+ "tokensToAllOutputPorts = "
+ "(*env)->NewObjectArray(env, "
+ numberOfOutputPorts
+ ", objClass, NULL);"
+ _eol);
}
String portName = outputPort.getName();
String tokensToThisPort = "tokensTo" + portName;
;
Type type = ((TypedIOPort) outputPort).getType();
int numberOfChannels = outputPort.getWidthInside();
code.append(_INDENT2 + "jobjectArray " + tokensToThisPort + ";" + _eol);
if (type == BaseType.INT) {
if (!_intFlag) {
code.append(_INDENT2 + "jclass objClassI = (*env)->FindClass(env, " + "\"[I\");" + _eol);
_intFlag = true;
}
code.append(
_INDENT2
+ tokensToThisPort
+ " = (*env)->NewObjectArray(env, "
+ numberOfChannels
+ ", objClassI, NULL);"
+ _eol);
} else if (type == BaseType.DOUBLE) {
if (!_doubleFlag) {
code.append(_INDENT2 + "jclass objClassD = (*env)->FindClass(env, " + "\"[D\");" + _eol);
_doubleFlag = true;
}
code.append(
_INDENT2
+ tokensToThisPort
+ " = (*env)->NewObjectArray(env, "
+ numberOfChannels
+ ", objClassD, NULL);"
+ _eol);
} else {
// FIXME: need to deal with other types
}
for (int i = 0; i < outputPort.getWidthInside(); i++) {
String tokensToOneChannel = "tokensToOneChannelOf" + portName;
if (i == 0) {
if (type == BaseType.INT) {
code.append(_INDENT2 + "jint " + tokensToOneChannel + "[" + rate + "];" + _eol);
} else if (type == BaseType.DOUBLE) {
code.append(_INDENT2 + "jdouble " + tokensToOneChannel + "[" + rate + "];" + _eol);
} else {
// FIXME: need to deal with other types
}
}
String portNameWithChannelNumber = portName;
if (outputPort.isMultiport()) {
portNameWithChannelNumber = portName + '#' + i;
}
for (int k = 0; k < rate; k++) {
code.append(
_INDENT2
+ tokensToOneChannel
+ "["
+ k
+ "] = "
+ compositeActorHelper.getReference("@" + portNameWithChannelNumber + "," + k)
+ ";"
+ _eol);
}
String tokensToOneChannelArray = "arr" + portName + i;
if (type == BaseType.INT) {
code.append(
_INDENT2
+ "jintArray "
+ tokensToOneChannelArray
+ " = "
+ "(*env)->NewIntArray(env, "
+ rate
+ ");"
+ _eol);
code.append(
_INDENT2
+ "(*env)->SetIntArrayRegion"
+ "(env, "
+ tokensToOneChannelArray
+ ", 0, "
+ rate
+ ", "
+ tokensToOneChannel
+ ");"
+ _eol);
} else if (type == BaseType.DOUBLE) {
code.append(
_INDENT2
+ "jdoubleArray "
+ tokensToOneChannelArray
+ " = "
+ "(*env)->NewDoubleArray(env, "
+ rate
+ ");"
+ _eol);
code.append(
_INDENT2
+ "(*env)->SetDoubleArrayRegion"
+ "(env, "
+ tokensToOneChannelArray
+ ", 0, "
+ rate
+ ", "
+ tokensToOneChannel
+ ");"
+ _eol);
} else {
// FIXME: need to deal with other types
}
code.append(
_INDENT2
+ "(*env)->SetObjectArrayElement"
+ "(env, "
+ tokensToThisPort
+ ", "
+ i
+ ", "
+ tokensToOneChannelArray
+ ");"
+ _eol);
code.append(
_INDENT2 + "(*env)->DeleteLocalRef(env, " + tokensToOneChannelArray + ");" + _eol);
}
code.append(
_INDENT2
+ "(*env)->SetObjectArrayElement"
+ "(env, tokensToAllOutputPorts, "
+ _portNumber
+ ", "
+ tokensToThisPort
+ ");"
+ _eol);
code.append(_INDENT2 + "(*env)->DeleteLocalRef(env, " + tokensToThisPort + ");" + _eol);
_portNumber++;
} else {
for (int i = 0; i < outputPort.getWidthInside(); i++) {
if (i < outputPort.getWidth()) {
String name = outputPort.getName();
if (outputPort.isMultiport()) {
name = name + '#' + i;
}
for (int k = 0; k < rate; k++) {
code.append(CodeStream.indent(compositeActorHelper.getReference(name + "," + k)));
code.append(" =" + _eol);
code.append(
CodeStream.indent(
_INDENT2 + compositeActorHelper.getReference("@" + name + "," + k)));
code.append(";" + _eol);
}
}
}
}
// The offset of the ports connected to the output port is
// updated by outside director.
_updatePortOffset(outputPort, code, rate);
}
/**
* Generate code for transferring enough tokens to complete an internal iteration.
*
* @param inputPort The port to transfer tokens.
* @param code The string buffer that the generated code is appended to.
* @exception IllegalActionException If thrown while transferring tokens.
*/
public void generateTransferInputsCode(IOPort inputPort, StringBuffer code)
throws IllegalActionException {
code.append(
CodeStream.indent(
_codeGenerator.comment("SDFDirector: " + "Transfer tokens to the inside.")));
int rate = DFUtilities.getTokenConsumptionRate(inputPort);
CompositeActor container = (CompositeActor) getComponent().getContainer();
ptolemy.codegen.c.actor.TypedCompositeActor compositeActorHelper =
(ptolemy.codegen.c.actor.TypedCompositeActor) _getHelper(container);
if (container instanceof TypedCompositeActorWithCoSimulation) {
Type type = ((TypedIOPort) inputPort).getType();
String portName = inputPort.getName();
for (int i = 0; i < inputPort.getWidth(); i++) {
if (i < inputPort.getWidthInside()) {
String tokensFromOneChannel = "tokensFromOneChannelOf" + portName + i;
String pointerToTokensFromOneChannel = "pointerTo" + tokensFromOneChannel;
code.append(_INDENT2);
code.append(
"jobject "
+ tokensFromOneChannel
+ " = (*env)->GetObjectArrayElement(env, "
+ portName
+ ", "
+ i
+ ");"
+ _eol);
code.append(_INDENT2);
if (type == BaseType.INT) {
code.append(
"jint * "
+ pointerToTokensFromOneChannel
+ " = (*env)->GetIntArrayElements"
+ "(env, "
+ tokensFromOneChannel
+ ", NULL);"
+ _eol);
} else if (type == BaseType.DOUBLE) {
code.append(
"jdouble * "
+ pointerToTokensFromOneChannel
+ " = (*env)->GetDoubleArrayElements"
+ "(env, "
+ tokensFromOneChannel
+ ", NULL);"
+ _eol);
} else {
// FIXME: need to deal with other types
}
String portNameWithChannelNumber = portName;
if (inputPort.isMultiport()) {
portNameWithChannelNumber = portName + '#' + i;
}
for (int k = 0; k < rate; k++) {
code.append(_INDENT2);
code.append(
compositeActorHelper.getReference("@" + portNameWithChannelNumber + "," + k));
code.append(" = " + pointerToTokensFromOneChannel + "[" + k + "];" + _eol);
}
code.append(_INDENT2);
if (type == BaseType.INT) {
code.append(
"(*env)->ReleaseIntArrayElements(env, "
+ tokensFromOneChannel
+ ", "
+ pointerToTokensFromOneChannel
+ ", 0);"
+ _eol);
} else if (type == BaseType.DOUBLE) {
code.append(
"(*env)->ReleaseDoubleArrayElements(env, "
+ tokensFromOneChannel
+ ", "
+ pointerToTokensFromOneChannel
+ ", 0);"
+ _eol);
} else {
// FIXME: need to deal with other types
}
}
}
} else {
for (int i = 0; i < inputPort.getWidth(); i++) {
if (i < inputPort.getWidthInside()) {
String name = inputPort.getName();
if (inputPort.isMultiport()) {
name = name + '#' + i;
}
for (int k = 0; k < rate; k++) {
code.append(CodeStream.indent(compositeActorHelper.getReference("@" + name + "," + k)));
code.append(" =" + _eol);
code.append(
CodeStream.indent(_INDENT2 + compositeActorHelper.getReference(name + "," + k)));
code.append(";" + _eol);
}
}
}
}
// The offset of the input port itself is updated by outside director.
_updateConnectedPortsOffset(inputPort, code, rate);
}
