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