jsv (1) - Linux Manuals
jsv: xxQS_NAMExx Job Submission Verifier
JSV - xxQS_NAMExx Job Submission Verifier
DESCRIPTIONJSV is an abbreviation for Job Submission Verifier. A JSV is a script or binary that can be used to verify, modify or reject a job during job submission.
CONFIGURATIONJSVs can be configured in various locations. Either a jsv_url can be provided with the -jsv submit parameter during job submission, a corresponding switch can be added to one of the sge_request files, or a jsv_url can be configured in the global cluster configuration of the xxQS_NAMExx installation.
All defined JSV instances will be executed in following order:
The Client JSVs (1-3) can be defined by xxQS_NAMExx end users, whereas the client JSV defined in the global sge_request file (4) and the server JSV (5) can only be defined by the xxQS_NAMExx administrators.
Due to the fact that (4) and (5) are defined and configured by xxQS_NAMExx administrators and executed as the last JSV instances in the sequence of JSV scripts, an administrator has a way to enforce certain policies for a cluster. However, note that (4) may be over-ridden trivially with qsub -clear.
As soon as one JSV instance rejects a job the whole process of verification is stopped and the end user will get a corresponding error message that the submission of the job has failed.
If a JSV accepts a job, or accepts a job after it applied several modifications, then the following JSV instance will get the job parameters including all modifications as input for the verification process. This is done as long as either the job is accepted or rejected.
LIFETIMEA Client or Server JSV is started as own process. This process communicates either with a xxQS_NAMExx client process or the master daemon by exchanging commands, job parameters, and other data via stdin/stdout streams.
Client JSV instances are started by client applications before a job is sent to qmaster. This instance does the job verification for the job to be submitted. After that verification the JSV process is stopped.
Server JSV instances are started for each worker thread part of the qmaster process. (For version 6.2 of xxQS_NAMExx this means that two processes are started.) Each of those processes has to verify job parameters for multiple jobs as long as the master is running, the underlying JSV configuration is not changed, and no error occurs.
TIMEOUTThe timeout is a modifiable value that will measure the response time of either the client or server JSV. In the event that the response time of the JSV is longer than timeout value specified, this will result in the JSV being re-started. The server JSV timeout value is specified through the qmaster parameter jsv_timeout. The client JSV timeout value is set through the environment variable SGE_JSV_TIMEOUT. The default value is 10 seconds, and this value must be greater than 0. If the timeout has been reached, the JSV will only try to re-start once, and if the timeout is reached again, an error will occur.
THRESHOLDThe threshold value is defined as a qmaster parameter jsv_threshold. This value measures the time for a server job verification. If this time exceeds the defined threshold then additional logging will appear in the master message file at the INFO level. This value is specified in milliseconds and has a default value of 5000. If a value of 0 is defined then this means all jobs will be logged in the message file.
PROTOCOLAfter a JSV script or binary is started it will get commands through its stdin stream, and it has to respond with certain commands on the stdout stream. Data sent via the stderr stream of a JSV instance is ignored. Each command which is sent to/by a JSV script has to be terminated by a newline character ('\n'), whereas newline characters are not allowed in the whole command string itself.
In general, commands which are exchanged between a JSV and client/qmaster have following format. Commands and arguments are case sensitive. Find the EBNF command description below.
PROTOCOL (JSV side)The following commands have to be implemented by a JSV script so that it conforms to version 1.0 of the JSV protocol, which was first implemented in xxQS_NAMExx 6.2u2:
- begin_command := BEGIN
- After a JSV instance has received all the env_commands and param_commands of a job which should be verified, the client/qmaster will trigger the verification process by sending one begin_command. After that it will wait for param_commands and env_commands which are sent back from the JSV instance to modify the job specification. As part of the verification process a JSV script or binary has to use the result_command to indicate that the verification process is finished for a job.
- env_command := ENV ' ' modifier ' ' name ' ' value
- modifier := ADD | MOD | DEL
The env_command is an optional command which has only to be implemented
by a JSV instance if the send_data_command is sent by this JSV
before a started_command was sent. Only in that case, the client
or master will use one or multiple env_commands to pass
the environment variables (name and value) to the JSV instance
to be exported to the job environment when the job
is started. Client and qmaster will only send env_commands
with the modifier ADD.
JSV instances modify the set of environment variables by sending back env_commands, and by using the modifiers ADD, MOD, and DEL.
- param_command := PARAM ' ' param_parameter ' ' value
- param_parameter := submit_parameter | pseudo_parameter
The param_command has two additional arguments which are separated
by space characters. The first argument is either a submit_parameter
as specified in
or it is a pseudo_parameter, as documented below.
The second parameter is the value of the corresponding param_parameter.
Multiple param_commands will be sent to a JSV instance after the JSV has sent a started_command. The sum of all param_commands sent represents a job specification of the job which should be verified.
submit_parameters are, for example, b (similar to the qsub -b switch), or masterq (similar to qsub -masterq switch). Find a complete list of submit_parameters in the man page. Please note that the param_parameter name and the corresponding value format is not equivalent to the qsub switch name and its argument format in all cases. E.g. the qsub -pe parameters will by available as a set of parameters with the name pe_name, pe_min, pe_max and the switch combination -soft -l will be passed to JSV scripts as l_soft parameter. For details concerning these differences consult also the man page.
- start_command := START
- The start_command has no additional arguments. This command indicates that a new job verification should be started. It is the first command which will be sent to JSV script after it has been started and it will initiate each new job verification. A JSV instance might trash cached values which are still stored due to a previous job verification. The application which sends the start_command will wait for a started_command before it continues.
- quit_command := QUIT
- The quit_command has no additional arguments. If this command is sent to a JSV instance then it should terminate itself immediately.
PROTOCOL (client/qmaster side)A JSV script or binary can send a set of commands to a client/qmaster process to indicate its state in the communication process, to change the job specification of a job which should be verified, and to report messages or errors. Below you can find the commands which are understood by the client/qmaster which implements version 1.0 of the communication protocol introduced in xxQS_NAMExx 6.2u2:
- error_command := ERROR message
- Any time a JSV script encounters an error it might report it to the client/qmaster. If the error happens during a job verification the job which is currently verified will be rejected. The JSV binary or script will also be restarted before it gets a new verification task.
- log_command := LOG log_level
- log_level := INFO | WARNING | ERROR
- log_commands can be used whenever the client or qmaster expects input from a JSV instance. This command can be used in client JSVs to send information to the user submitting the job. In client JSVs all messages, independent of the log_level, will be printed to the stdout stream of the submit client. If a server JSV receives a log_command it will add the received message to the message file, respecting the specified log_level. Please note that message might contain spaces, but no newline characters.
- param_command (find definition above)
- By sending param_commands, a JSV script can change the job specification of the job which should be verified. If a JSV instance later on sends a result_command which indicates that a JSV instance should be accepted with corrections, then the values provided with these param_commands will be used to modify the job before it is accepted by the xxQS_NAMExx system.
- result_command := RESULT result_type [ message ]
- result_type := ACCEPT | CORRECT | REJECT | REJECT_WAIT
- After the verification of a job is done, a JSV script or binary has to send a result_command which indicates what should happen with the job. If the result_type is ACCEPTED the job will be accepted as it was initially submitted by the end user. All param_commands and env_commands which might have been sent before the result_command are ignored in this case. The result_type CORRECT indicates that the job should be accepted after all modifications sent via param_commands and env_command are applied to the job. REJECT and REJECT_WAIT cause the client or qmaster instance to reject the job.
- send_data_command := SEND data_name
- data_name := ENV
If a client/qmaster receives a send_env_command from a
JSV instance before a started_command is sent, then it will
not only pass job parameters with param_commands, but also
env_commands which provide the JSV with the information about which
environment variables will be exported to the job environment if
the job is accepted and started later on.
The job environment is not passed to JSV instances by default because the job environment of the end user might contain data which might be interpreted wrongly in the JSV context, and might therefore cause errors or security issues.
- started_command := STARTED
- By sending the started_command a JSV instance indicates that it is ready to receive param_commands and env_commands for a new job verification. It will only receive env_commands if it sends a send_data_command before the started_command.
- The corresponding value for the CLIENT parameter is either qmaster or the name of a submit client like qsub, qsh, qrsh, qlogin, and so on. This parameter value can't be changed by JSV instances. It will always be sent as part of a job verification.
- Number of arguments which will be passed to the job script or command when the job execution is started. It will always be sent as part of a job verification. If no arguments should be passed to the job script or command it will have the value 0. This parameter can be changed by JSV instances. If the value of CMDARGS is bigger than the number of available CMDARGn parameters, then the missing parameters will be automatically passed as empty parameters to the job script.
- Individual command arguments, where n is an integer between 0 and CMDARGS-1.
- Either the path to the script, the command name for binary submission, STDIN for standard input, or NONE in the case of an interactive job. It will always be sent as part of a job verification.
- Either client, if the JSV which receives this param_command was started by a command-line client like qsub, or qsh, or master if it was started by the sge_qmaster process. It will always be sent as part of a job verification. This parameter value can't be changed by JSV instances.
- Defines the primary group of the user who tries to submit the job which should be verified. This parameter cannot be changed but is always sent as part of the verification process. The user name is passed as a parameter with the name USER.
- Not available in the client context (see CONTEXT). Otherwise it contains the job number of the job which will be submitted to Grid Engine when the verification process is successful. JOB_ID is an optional parameter which can't be changed by JSV instances.
- User name of the user who tries to submit the job which should be verified. Cannot be changed but is always sent as part of the verification process. The group name is passed as a parameter with the name GROUP.
- VERSION will always be sent as part of a job verification process and it will always be the first parameter which is sent. It will contain a version number of the format major.minor. In version 6.2u2 and higher the value will be 1.0, or higher if the protocol is changed in the future. The value of this parameter can't be changed.
CAVEATSSee for advice concerning shell script JSVs.
EXAMPLEHere is an example for the communication of a client with a JSV instance when the following job is submitted:
> qsub -pe p 3 -hard -l a=1,b=5 -soft -l q=all.q $SGE_ROOT/examples/jobs/sleeper.sh
Data in the first column are sent from the client/qmaster to the JSV instance. Data contained in the second column are sent from the JSV script to the client/qmaster. Newline characters which terminate each line in the communication protocol are omitted.
START SEND ENV STARTED PARAM VERSION 1.0 PARAM CONTEXT client PARAM CLIENT qsub PARAM USER ernst PARAM GROUP staff PARAM CMDNAME /sge_root/examples/jobs/sleeper.sh PARAM CMDARGS 1 PARAM CMDARG0 12 PARAM l_hard a=1,b=5 PARAM l_soft q=all.q PARAM M user [at] hostname PARAM N Sleeper PARAM o /dev/null PARAM pe_name pe1 PARAM pe_min 3 PARAM pe_max 3 PARAM S /bin/sh BEGIN RESULT STATE ACCEPT
COPYRIGHTSee for a full statement of rights and permissions.