Package edu.rit.pj.cluster

Class NonPjJobFrontend

java.lang.Object

edu.rit.pj.cluster.NonPjJobFrontend

All Implemented Interfaces:

JobFrontendRef, Runnable

public class NonPjJobFrontend
extends Object
implements Runnable, JobFrontendRef

Class NonPjJobFrontend provides the message handler for a job frontend process that communicates with the Job Scheduler to allocate backend nodes but does not run a PJ program.

Version:

20-Jun-2012

Author:

Alan Kaminsky

Constructor Summary

Constructors

Constructor	Description
NonPjJobFrontend(String username, int Np)	Construct a new non-PJ job frontend object.

Method Summary

Modifier and Type	Method	Description
void	assignBackend(JobSchedulerRef theJobScheduler, String name, String host, String jvm, String classpath, String[] jvmflags, String shellCommand, int Nt)	Assign a backend process to the job.
void	assignJobNumber(JobSchedulerRef theJobScheduler, int jobnum, String pjhost)	Assign a job number to the job.
void	backendFinished(JobBackendRef theJobBackend)	Report that a backend process has finished executing the job.
void	backendReady(JobBackendRef theJobBackend, int rank, InetSocketAddress middlewareAddress, InetSocketAddress worldAddress, InetSocketAddress frontendAddress)	Report that a backend process is ready to commence executing the job.
void	cancelJob(JobBackendRef theJobBackend, String errmsg)	Cancel the job.
void	cancelJob(JobSchedulerRef theJobScheduler, String errmsg)	Cancel the job.
void	close()	Close communication with this Job Frontend.
List<String>	getBackendNames()	Obtain a list of the backend names assigned to this Non-PJ Job Frontend.
int	getJobNumber()	Obtain the job number assigned to this Non-PJ Job Frontend.
void	inputFileClose(JobBackendRef theJobBackend, int ffd)	Close the given input file.
void	inputFileOpen(JobBackendRef theJobBackend, int bfd, File file)	Open the given input file for reading.
void	inputFileRead(JobBackendRef theJobBackend, int ffd, int len)	Read bytes from the given input file.
void	inputFileSkip(JobBackendRef theJobBackend, int ffd, long len)	Skip bytes from the given input file.
void	outputFileClose(JobBackendRef theJobBackend, int ffd)	Close the given output file.
void	outputFileFlush(JobBackendRef theJobBackend, int ffd)	Flush accumulated bytes to the given output file.
void	outputFileOpen(JobBackendRef theJobBackend, int bfd, File file, boolean append)	Open the given output file for writing or appending.
void	outputFileWrite(JobBackendRef theJobBackend, int ffd, byte[] buf, int off, int len)	Write the given bytes to the given output file.
void	renewLease(JobBackendRef theJobBackend)	Renew the lease on the job.
void	renewLease(JobSchedulerRef theJobScheduler)	Renew the lease on the job.
void	reportComment(JobBackendRef theJobBackend, int rank, String comment)	Report a comment for a process.
void	requestResource(JobBackendRef theJobBackend, String resourceName)	Request the given resource from this job frontend's class loader.
void	run()	Run this Non-PJ Job Frontend.
void	terminateJobFinished(int status)	Terminate this Non-PJ Job Frontend immediately, sending a "job finished" message to the Job Scheduler.

Methods inherited from class java.lang.Object

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

Constructor Details

NonPjJobFrontend

public NonPjJobFrontend(String username,
 int Np)
                 throws IOException

Construct a new non-PJ job frontend object. The job frontend object will contact the Job Scheduler Daemon specified by the "pj.host" and "pj.port" Java system properties. See class PJProperties for further information.

The non-PJ job frontend object will ask the Job Scheduler Daemon to run one process per node and to use all CPUs on each node. Other possibilities are not supported.

Parameters:

username - User name.

Np - Number of processes (>= 1).

Throws:

JobSchedulerException - (subclass of IOException) Thrown if the job frontend object could not contact the Job Scheduler Daemon.

IOException - Thrown if an I/O error occurred.

IOException - if any.

Method Details

getJobNumber

public int getJobNumber()
                 throws InterruptedException

Obtain the job number assigned to this Non-PJ Job Frontend. This method blocks until the requested number of backend processes (a constructor parameter) have been assigned.

Returns:

Job number.

Throws:

InterruptedException - Thrown if the calling thread is interrupted while blocked in this method.

InterruptedException - if any.

getBackendNames

public List<String> getBackendNames()
                             throws InterruptedException

Obtain a list of the backend names assigned to this Non-PJ Job Frontend. This method blocks until the requested number of backend processes (a constructor parameter) have been assigned. The returned list is unmodifiable.

Returns:

List of backend names.

Throws:

InterruptedException - Thrown if the calling thread is interrupted while blocked in this method.

InterruptedException - if any.

run

public void run()

Run this Non-PJ Job Frontend.

Specified by:

run in interface Runnable

terminateJobFinished

public void terminateJobFinished(int status)

Terminate this Non-PJ Job Frontend immediately, sending a "job finished" message to the Job Scheduler. This method must only be called by a thread other than the thread calling run(). This method calls System.exit(status) to terminate the process.

Parameters:

status - Status value for System.exit().

assignBackend

public void assignBackend(JobSchedulerRef theJobScheduler,
 String name,
 String host,
 String jvm,
 String classpath,
 String[] jvmflags,
 String shellCommand,
 int Nt)
                   throws IOException

Assign a backend process to the job. Assign a backend process to the job.

Specified by:

assignBackend in interface JobFrontendRef

Parameters:

theJobScheduler - Job Scheduler that is calling this method.

name - Backend node name.

host - Host name for SSH remote login.

jvm - Full pathname of Java Virtual Machine.

classpath - Java class path for PJ Library.

jvmflags - Array of JVM command line flags.

shellCommand - Shell command string.

Nt - Number of CPUs assigned to the process.

Throws:

IOException - Thrown if an I/O error occurred.

assignJobNumber

public void assignJobNumber(JobSchedulerRef theJobScheduler,
 int jobnum,
 String pjhost)
                     throws IOException

Assign a job number to the job. The host name for the job frontend's middleware channel group is also specified. Assign a job number to the job. The host name for the job frontend's middleware channel group is also specified.

Specified by:

assignJobNumber in interface JobFrontendRef

Parameters:

theJobScheduler - Job Scheduler that is calling this method.

jobnum - Job number.

pjhost - Host name for middleware channel group.

Throws:

IOException - Thrown if an I/O error occurred.

cancelJob

public void cancelJob(JobSchedulerRef theJobScheduler,
 String errmsg)
               throws IOException

Cancel the job. Cancel the job.

Specified by:

cancelJob in interface JobFrontendRef

Parameters:

theJobScheduler - Job Scheduler that is calling this method.

errmsg - Error message string.

Throws:

IOException - Thrown if an I/O error occurred.

renewLease

public void renewLease(JobSchedulerRef theJobScheduler)
                throws IOException

Renew the lease on the job.

Specified by:

renewLease in interface JobFrontendRef

Parameters:

theJobScheduler - Job Scheduler that is calling this method.

Throws:

IOException - Thrown if an I/O error occurred.

IOException - if any.

backendFinished

public void backendFinished(JobBackendRef theJobBackend)
                     throws IOException

Report that a backend process has finished executing the job. Report that a backend process has finished executing the job.

Specified by:

backendFinished in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

Throws:

IOException - Thrown if an I/O error occurred.

backendReady

public void backendReady(JobBackendRef theJobBackend,
 int rank,
 InetSocketAddress middlewareAddress,
 InetSocketAddress worldAddress,
 InetSocketAddress frontendAddress)
                  throws IOException

Report that a backend process is ready to commence executing the job. Report that a backend process is ready to commence executing the job.

Specified by:

backendReady in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

rank - Rank of the job backend process.

middlewareAddress - Host/port to which the job backend process is listening for middleware messages.

worldAddress - Host/port to which the job backend process is listening for the world communicator.

frontendAddress - Host/port to which the job backend process is listening for the frontend communicator, or null if the frontend communicator does not exist.

Throws:

IOException - Thrown if an I/O error occurred.

cancelJob

public void cancelJob(JobBackendRef theJobBackend,
 String errmsg)
               throws IOException

Cancel the job. Cancel the job.

Specified by:

cancelJob in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

errmsg - Error message string.

Throws:

IOException - Thrown if an I/O error occurred.

renewLease

public void renewLease(JobBackendRef theJobBackend)
                throws IOException

Renew the lease on the job. Renew the lease on the job.

Specified by:

renewLease in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

Throws:

IOException - Thrown if an I/O error occurred.

requestResource

public void requestResource(JobBackendRef theJobBackend,
 String resourceName)
                     throws IOException

Request the given resource from this job frontend's class loader. Request the given resource from this job frontend's class loader.

Specified by:

requestResource in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

resourceName - Resource name.

Throws:

IOException - Thrown if an I/O error occurred.

outputFileOpen

public void outputFileOpen(JobBackendRef theJobBackend,
 int bfd,
 File file,
 boolean append)
                    throws IOException

Open the given output file for writing or appending. Open the given output file for writing or appending.

Specified by:

outputFileOpen in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

bfd - Backend file descriptor.

file - File.

append - True to append, false to overwrite.

Throws:

IOException - Thrown if an I/O error occurred.

outputFileWrite

public void outputFileWrite(JobBackendRef theJobBackend,
 int ffd,
 byte[] buf,
 int off,
 int len)
                     throws IOException

Write the given bytes to the given output file. ffd = 1 refers to the job's standard output stream; ffd = 2 refers to the job's standard error stream; other values refer to a previously opened file. Write the given bytes to the given output file. ffd = 1 refers to the job's standard output stream; ffd = 2 refers to the job's standard error stream; other values refer to a previously opened file.

Specified by:

outputFileWrite in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

ffd - Frontend file descriptor.

buf - Array of bytes to write.

off - Index of first byte to write.

len - Number of bytes to write.

Throws:

IOException - Thrown if an I/O error occurred.

outputFileFlush

public void outputFileFlush(JobBackendRef theJobBackend,
 int ffd)
                     throws IOException

Flush accumulated bytes to the given output file. Flush accumulated bytes to the given output file.

Specified by:

outputFileFlush in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

ffd - Frontend file descriptor.

Throws:

IOException - Thrown if an I/O error occurred.

outputFileClose

public void outputFileClose(JobBackendRef theJobBackend,
 int ffd)
                     throws IOException

Close the given output file. Close the given output file.

Specified by:

outputFileClose in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

ffd - Frontend file descriptor.

Throws:

IOException - Thrown if an I/O error occurred.

inputFileOpen

public void inputFileOpen(JobBackendRef theJobBackend,
 int bfd,
 File file)
                   throws IOException

Open the given input file for reading. Open the given input file for reading.

Specified by:

inputFileOpen in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

bfd - Backend file descriptor.

file - File.

Throws:

IOException - Thrown if an I/O error occurred.

inputFileRead

public void inputFileRead(JobBackendRef theJobBackend,
 int ffd,
 int len)
                   throws IOException

Read bytes from the given input file. ffd = 1 refers to the job's standard input stream; other values refer to a previously opened file. Read bytes from the given input file. ffd = 1 refers to the job's standard input stream; other values refer to a previously opened file.

Specified by:

inputFileRead in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

ffd - Frontend file descriptor.

len - Number of bytes to read.

Throws:

IOException - Thrown if an I/O error occurred.

inputFileSkip

public void inputFileSkip(JobBackendRef theJobBackend,
 int ffd,
 long len)
                   throws IOException

Skip bytes from the given input file. Skip bytes from the given input file.

Specified by:

inputFileSkip in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

ffd - Frontend file descriptor.

len - Number of bytes to skip.

Throws:

IOException - Thrown if an I/O error occurred.

inputFileClose

public void inputFileClose(JobBackendRef theJobBackend,
 int ffd)
                    throws IOException

Close the given input file. Close the given input file.

Specified by:

inputFileClose in interface JobFrontendRef

Parameters:

theJobBackend - Job Backend that is calling this method.

ffd - Frontend file descriptor.

Throws:

IOException - Thrown if an I/O error occurred.

reportComment

public void reportComment(JobBackendRef theJobBackend,
 int rank,
 String comment)
                   throws IOException

Report a comment for a process. Report a comment for a process.

Specified by:

reportComment in interface JobFrontendRef

Parameters:

theJobBackend - Job backend that is calling this method.

rank - Process rank.

comment - Comment string.

Throws:

IOException - Thrown if an I/O error occurred.

close

public void close()

Close communication with this Job Frontend.

Specified by:

close in interface JobFrontendRef