org/objectweb/proactive/core/process/gridengine/GridEngineSubProcess.java

/* 
 * ################################################################
 * 
 * ProActive: The Java(TM) library for Parallel, Distributed, 
 *            Concurrent computing with Security and Mobility
 * 
 * Copyright (C) 1997-2007 INRIA/University of Nice-Sophia Antipolis
 * Contact: proactive@objectweb.org
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or any later version.
 *  
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 * USA
 *  
 *  Initial developer(s):               The ProActive Team
 *                        http://www.inria.fr/oasis/ProActive/contacts.html
 *  Contributor(s): 
 * 
 * ################################################################
 */ 
package org.objectweb.proactive.core.process.gridengine;

import org.objectweb.proactive.core.process.AbstractExternalProcessDecorator;
import org.objectweb.proactive.core.process.ExternalProcess;
import org.objectweb.proactive.core.process.MessageSink;
import org.objectweb.proactive.core.process.UniversalProcess;


public class GridEngineSubProcess extends AbstractExternalProcessDecorator {
    private static final String FILE_SEPARATOR = System.getProperty(
            "file.separator");
    public final static String DEFAULT_QSUBPATH = "/opt/gridengine/bin/glinux/qsub";
    private static final String DEFAULT_SCRIPT_LOCATION = System.getProperty(
            "user.home") + FILE_SEPARATOR + "ProActive" + FILE_SEPARATOR +
        "scripts" + FILE_SEPARATOR + "unix" + FILE_SEPARATOR + "cluster" +
        FILE_SEPARATOR + "gridEngineStartRuntime.sh ";
    protected static final String DEFAULT_HOSTS_NUMBER = "1";
    protected static final String DEFAULT_PARALLEL_ENVIRONMENT = null;
    protected String hostNumber = DEFAULT_HOSTS_NUMBER;
    protected String parallelEnvironment = DEFAULT_PARALLEL_ENVIRONMENT;
    protected String bookingDuration = null;
    protected String scriptLocation = DEFAULT_SCRIPT_LOCATION;

    //Following options are not yet included in the command
    protected String interactive = "false";
    protected String outputFile;
    protected String errorFile;
    protected int jobID;
    protected String queueName;
    protected String hostList;

    public GridEngineSubProcess() {
        super();
        setCompositionType(GIVE_COMMAND_AS_PARAMETER);
        this.hostname = null;
        this.command_path = DEFAULT_QSUBPATH;
    }

    public GridEngineSubProcess(ExternalProcess targetProcess) {
        super(targetProcess);
        this.hostname = null;
        this.command_path = DEFAULT_QSUBPATH;
    }

    //----------------------------------------------------------------------------------------
    //-----------------------Extends AbstractExternalProcessDecorator-------------------------
    //  ----------------------------------------------------------------------------------------
    public void setOutputMessageSink(MessageSink outputMessageSink) {
        if (outputMessageSink == null) {
            super.setOutputMessageSink(new SimpleMessageSink());
        } else {
            super.setOutputMessageSink(outputMessageSink);
        }
    }

    public void setBookingDuration(String d) {
        this.bookingDuration = d;
    }

    public String getHostsNumber() {
        return this.hostNumber;
    }

    public void setHostsNumber(String hostNumber) {
        checkStarted();
        if (hostNumber != null) {
            this.hostNumber = hostNumber;
        }
    }

    public String getProcessId() {
        return "gridengine_" + targetProcess.getProcessId();
    }

    public int getNodeNumber() {
        return (new Integer(getHostsNumber()).intValue());
    }

    public UniversalProcess getFinalProcess() {
        checkStarted();
        ;
        return targetProcess.getFinalProcess();
    }

    public void setScriptLocation(String location) {
        checkStarted();
        //     if (location != null) {
        this.scriptLocation = location;
        //    }
    }

    public void setParallelEnvironment(String p) {
        this.parallelEnvironment = p;
    }

    public String getParallelEnvironment() {
        return this.parallelEnvironment;
    }

    public void setHostList(String hostList) {
        checkStarted();
        this.hostList = hostList;
    }

    public String getHostList() {
        return hostList;
    }

    public void setInteractive(String interactive) {
        this.interactive = interactive;
    }

    public void setOutputFile(String string) {
        outputFile = string;
    }

    public void setErrorFile(String string) {
        errorFile = string;
    }

    public void setQueueName(String queueName) {
        checkStarted();
        if (queueName == null) {
            throw new NullPointerException();
        }
        this.queueName = queueName;
    }

    protected String parseHostname(String message) {
        //To be modified for SGE, does not work with the present code
        String result = new String();
        if (logger.isDebugEnabled()) {
            logger.debug("parseHostname() analyzing " + message);
        }
        java.util.StringTokenizer st = new java.util.StringTokenizer(message);
        if (st.countTokens() < 2) {
            return null; //at least two tokens
        }
        if (!":".equals(st.nextToken())) {
            return null; //should start with :
        }

        while (st.hasMoreTokens()) {
            result += (st.nextToken());
            result += " ";
        }
        return result;
    }

    protected String internalBuildCommand() {
        return buildEnvironmentCommand(); // + buildPSubCommand();
    }

    protected String buildCommand() {
        StringBuilder qsubCommand = new StringBuilder();

        qsubCommand.append(command_path).append(" -S /bin/bash ");

        if ((this.queueName != null) && (this.queueName.length() > 0)) {
            qsubCommand.append("-q ").append(queueName).append(" ");
        }

        if ((this.outputFile != null) && (this.outputFile.length() > 0)) {
            qsubCommand.append("-o ").append(outputFile).append(" ");
        }

        if ((this.errorFile != null) && (this.errorFile.length() > 0)) {
            qsubCommand.append("-e ").append(errorFile).append(" ");
        }

        if ((this.parallelEnvironment != null) &&
                (this.parallelEnvironment.length() > 0)) {
            qsubCommand.append("-pe ").append(parallelEnvironment).append(" ");

            if ((this.hostNumber != null) && (this.hostNumber.length() > 0)) {
                qsubCommand.append(hostNumber).append(" ");
            } else {
                qsubCommand.append("1").append(" ");
            }
        } else {
            if ((this.hostNumber != null) && (this.hostNumber.length() > 0)) {
                logger.warn(
                    "You specified hostNumber without a parallelEnvironment. Your job will fail. Please update your schema");
            }
        }
        
        if (this.bookingDuration != null) {
                qsubCommand.append(" -l s_rt=" + bookingDuration + " ") ;
        }

        qsubCommand.append(scriptLocation).append(" ");
        qsubCommand.append(targetProcess.getCommand());

        if (logger.isDebugEnabled()) {
            logger.debug("qsub command is " + qsubCommand.toString());
        }

        //System.out.println("GridEngineSubProcess.buildCommand() " + qsubCommand);
        return qsubCommand.toString();
    }

    protected String buildResourceString() {
        StringBuilder rs = new StringBuilder();
        rs.append(" -l walltime=").append(bookingDuration).append(",");
        //to specify nodes and processor per nodes, the syntax is different from
        //other resources
        rs.append("nodes=").append(hostNumber).append(":");

        return rs.toString();
    }
}

---