condor_chirp

Access files or job ClassAd from an executing job

Synopsis

condor_chirp [-help]

condor_chirp fetch RemoteFileName LocalFileName

condor_chirp put [-mode
mode] [-perm
UnixPerm] LocalFileName RemoteFileName

condor_chirp remove RemoteFileName

condor_chirp get_job_attr JobAttributeName

condor_chirp set_job_attr JobAttributeName AttributeValue

condor_chirp ulog Message

Description

condor_chirp is run from a user job while executing. It accesses files or job ClassAd attributes on the submit machine. Files can be read, written or removed. Job attributes can be read, and most attributes can be updated.

Descriptions using the terms local and remote are given from the point of view of the executing program.

If the input file name for put is a dash, condor_chirp uses standard input as the source. If the output file name for fetch is a dash, condor_chirp writes to standard output instead of a local file.

Jobs that use condor_chirp must have the attribute WantIOProxy set to True in the job ad. To do this, place

+WantIOProxy = true

in the submit description file for the job.

condor_chirp only works for jobs run in the vanilla, parallel and java universes.

The optional -mode/SPAN>mode argument is one or more of the following characters describing the RemoteFileName file.

• w: open for writing
• a: force all writes to append
• t: truncate before use
• c: create the file, if it does not exist
• x: fail if 'c' is given, and the file already exists

The optional -perm/SPAN>UnixPerm argument describes the file access permissions in a Unix format (for example, 660).

Options

[-help] Display usage information and exit.
[fetch] Copy the RemoteFileName from the submit machine to the execute machine.
[remove] Remove the RemoteFileName file from the submit machine.
[put] Copy the LocalFileName from the execute machine to the submit machine. Perm is the unix permission to open the file with.
[get_job_attr] Prints the named job ClassAd attribute to standard output.
[set_job_attr] Sets the named job ClassAd attribute with the given attribute value.
[ulog] Appends a message to the job's user log.

Examples

To copy a file from the submit machine to the execute machine while the user job is running, run

% condor_chirp fetch remotefile localfile

To print to standard output the value of the Requirements expression from within a running job, run

% condor_chirp get_job_attr Requirements

Note that the remote (submit-side) directory path is relative to the submit directory, and the local (execute-side) directory is relative to the current directory of the running program.

To append the word "foo" to a file on the submit machine, run

% echo foo | condor_chirp put -mode wat - RemoteFile

To append the message "Hello World" to the user log, run

% condor_chirp ulog "Hello World"

Exit Status

condor_chirp will exit with a status value of 0 (zero) upon success, and it will exit with the value 1 (one) upon failure.

Author

Condor Team, University of Wisconsin-Madison

Copyright

Copyright ©990-2010 Condor Team, Computer Sciences Department, University of Wisconsin-Madison, Madison, WI. All Rights Reserved. Licensed under the Apache License, Version 2.0.

See the Condor Version 7.5.6 or http://www.condorproject.org/license for additional notices.