1CONDOR_CHIRP(1) HTCondor Manual CONDOR_CHIRP(1)
2
6 condor_chirp - HTCondor Manual
7 Access files or job ClassAd from an executing job
9
12 condor_chirp <Chirp-Command>
13
15 condor_chirp is not intended for use as a command-line tool. It is most
16 often invoked by an HTCondor job, while the job is executing. It ac‐
17 cesses files or job ClassAd attributes on the access point. Files can
18 be read, written or removed. Job attributes can be read, and most at‐
19 tributes can be updated.
20 When invoked by an HTCondor job, the command-line arguments describe
22 the operation to be performed. Each of these arguments is described be‐
23 low within the section on Chirp Commands. Descriptions using the terms
24 local and remote are given from the point of view of the executing job.
25 If the input file name for put or write is a dash, condor_chirp uses
27 standard input as the source. If the output file name for fetch is a
28 dash, condor_chirp writes to standard output instead of a local file.
29 Jobs that use condor_chirp must have the attribute WantIOProxy set to
31 True in the job ClassAd. To do this, place
32 want_io_proxy = true
34 in the submit description file of the job.
36 condor_chirp only works for jobs run in the vanilla, parallel and java
38 universes.
39
41 fetch RemoteFileName LocalFileName
42 Copy the RemoteFileName from the access point to the execute
43 machine, naming it LocalFileName.
44 put [-mode mode] [-perm UnixPerm] LocalFileName RemoteFileName
46 Copy the LocalFileName from the execute machine to the submit
47 machine, naming it RemoteFileName. The optional -perm Unix‐
48 Perm argument describes the file access permissions in a Unix
49 format; 660 is an example Unix format.
50 The optional -mode mode argument is one or more of the fol‐
52 lowing characters describing the RemoteFileName file: w, open
53 for writing; a, force all writes to append; t, truncate be‐
54 fore use; c, create the file, if it does not exist; x, fail
55 if c is given and the file already exists.
56 remove RemoteFileName
58 Remove the RemoteFileName file from the access point.
59 get_job_attr JobAttributeName
61 Prints the named job ClassAd attribute to standard output.
62 set_job_attr JobAttributeName AttributeValue
64 Sets the named job ClassAd attribute with the given attribute
65 value.
66 get_job_attr_delayed JobAttributeName
68 Prints the named job ClassAd attribute to standard output,
69 potentially reading the cached value from a recent
70 set_job_attr_delayed.
71 set_job_attr_delayed JobAttributeName AttributeValue
73 Sets the named job ClassAd attribute with the given attribute
74 value, but does not immediately synchronize the value with
75 the submit side. It can take 15 minutes before the synchro‐
76 nization occurs. This has much less overhead than the non de‐
77 layed version. With this option, jobs do not need ClassAd at‐
78 tribute WantIOProxy set. With this option, job attribute
79 names are restricted to begin with the case sensitive sub‐
80 string Chirp.
81 ulog Message
83 Appends Message to the job event log.
84 read [-offset offset] [-stride length skip] RemoteFileName Length
86 Read Length bytes from RemoteFileName. Optionally, implement
87 a stride by starting the read at offset and reading length
88 bytes with a stride of skip bytes.
89 write [-offset offset] [-stride length skip] RemoteFileName Local‐
91 FileName [numbytes
92 ] Write the contents of LocalFileName to RemoteFileName. Op‐
93 tionally, start writing to the remote file at offset and
94 write length bytes with a stride of skip bytes. If the op‐
95 tional numbytes follows LocalFileName, then the write will
96 halt after numbytes input bytes have been written. Otherwise,
97 the entire contents of LocalFileName will be written.
98 rmdir [-r ] RemotePath
100 Delete the directory specified by RemotePath. If the optional
101 -r is specified, recursively delete the entire directory.
102 getdir [-l ] RemotePath
104 List the contents of the directory specified by RemotePath.
105 If -l is specified, list all metadata as well.
106 whoami Get the user's current identity.
108 whoareyou RemoteHost
110 Get the identity of RemoteHost.
111 link [-s ] OldRemotePath NewRemotePath
113 Create a hard link from OldRemotePath to NewRemotePath. If
114 the optional -s is specified, create a symbolic link instead.
115 readlink RemoteFileName
117 Read the contents of the file defined by the symbolic link
118 RemoteFileName.
119 stat RemotePath
121 Get metadata for RemotePath. Examines the target, if it is a
122 symbolic link.
123 lstat RemotePath
125 Get metadata for RemotePath. Examines the file, if it is a
126 symbolic link.
127 statfs RemotePath
129 Get file system metadata for RemotePath.
130 access RemotePath Mode
132 Check access permissions for RemotePath. Mode is one or more
133 of the characters r, w, x, or f, representing read, write,
134 execute, and existence, respectively.
135 chmod RemotePath UnixPerm
137 Change the permissions of RemotePath to UnixPerm. UnixPerm
138 describes the file access permissions in a Unix format; 660
139 is an example Unix format.
140 chown RemotePath UID GID
142 Change the ownership of RemotePath to UID and GID. Changes
143 the target of RemotePath, if it is a symbolic link.
144 lchown RemotePath UID GID
146 Change the ownership of RemotePath to UID and GID. Changes
147 the link, if RemotePath is a symbolic link.
148 truncate RemoteFileName Length
150 Truncates RemoteFileName to Length bytes.
151 utime RemotePath AccessTime ModifyTime
153 Change the access to AccessTime and modification time to Mod‐
154 ifyTime of RemotePath.
155
157 To copy a file from the access point to the execute machine while the
158 user job is running, run
159 $ condor_chirp fetch remotefile localfile
161 To print to standard output the value of the Requirements expression
163 from within a running job, run
164 $ condor_chirp get_job_attr Requirements
166 Note that the remote (submit-side) directory path is relative to the
168 submit directory, and the local (execute-side) directory is relative to
169 the current directory of the running program.
170 To append the word "foo" to a file called RemoteFile on the submit ma‐
172 chine, run
173 $ echo foo | condor_chirp put -mode wa - RemoteFile
175 To append the message "Hello World" to the job event log, run
177 $ condor_chirp ulog "Hello World"
179
181 condor_chirp will exit with a status value of 0 (zero) upon success,
182 and it will exit with the value 1 (one) upon failure.
183
185 HTCondor Team
186
188 1990-2023, Center for High Throughput Computing, Computer Sciences De‐
189 partment, University of Wisconsin-Madison, Madison, WI, US. Licensed
190 under the Apache License, Version 2.0.
191 Oct 02, 2023 CONDOR_CHIRP(1)