mirror of https://github.com/BOINC/boinc.git
91 lines
2.9 KiB
HTML
91 lines
2.9 KiB
HTML
<title>Generating work</title>
|
|
<body bgcolor=ffffff>
|
|
<h2>Generating work</h2>
|
|
<p>
|
|
Workunits and results can be created using either a utility program
|
|
or a C++ function.
|
|
In either case you must first <a href=key_setup.html>generate a key pair</a>
|
|
for file upload authentication.
|
|
<hr>
|
|
The utility program is
|
|
<pre>
|
|
create_work
|
|
-appname name // application name
|
|
-wu_name name // workunit name
|
|
-wu_template filename // WU template filename
|
|
-result_template filename // result template filename
|
|
-nresults n // # of results to create
|
|
-db_name x // database name
|
|
-db_passwd x // database password
|
|
-upload_url x // URL for output file upload
|
|
-download_url x // base URL for input file download
|
|
-download_dir x // where to move input files
|
|
-rsc_fpops x // est. # floating-point ops
|
|
-rsc_iops x // est. # integer ops
|
|
-rsc_memory x // est. RAM working set size, bytes
|
|
-rsc_disk x // est. disk space required
|
|
-keyfile x // path of upload private key
|
|
-delay_bound x // delay bound for result completion
|
|
infile_1 ... infile_m // input files
|
|
</pre>
|
|
<p>
|
|
The workunit template file is processed as follows:
|
|
<ul>
|
|
<li>
|
|
Within a <file_info> element,
|
|
<number>x</number> identifies the order of the file.
|
|
It is replaced with elements giving
|
|
the filename, download URL, MD5 checksum, and size.
|
|
file.
|
|
<li>
|
|
Within a <file_ref> element,
|
|
<file_number>x</file_number> is replaced with the filename.
|
|
</ul>
|
|
<p>
|
|
The result file template is macro-substituted as follows:
|
|
<ul>
|
|
<li>
|
|
<OUTFILE_n> is replaced with a string of the form
|
|
"wuname_resultnum_n" where wuname is the workunit name and resultnum is
|
|
the ordinal number of the result (0, 1, ...).
|
|
<li>
|
|
<UPLOAD_URL> is replaced with the upload URL.
|
|
</ul>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
The C++ library (backend_lib.C,h) provides the functions:
|
|
<pre>
|
|
int read_key_file(char* path, R_RSA_PRIVATE_KEY& key);
|
|
|
|
int create_work(
|
|
WORKUNIT&,
|
|
char* wu_template, // contents, not path
|
|
char* result_template_filename, // path
|
|
int nresults,
|
|
char* infile_dir, // where input files are
|
|
char** infiles, // array of input file names
|
|
int ninfiles
|
|
R_RSA_PRIVATE_KEY& key, // upload authentication key
|
|
char* upload_url,
|
|
char* download_url
|
|
);
|
|
</pre>
|
|
<p>
|
|
<b>read_key_file()</b> reads a private key from a file.
|
|
Use this to read the file upload authentication key.
|
|
<p>
|
|
<b>create_work()</b>
|
|
creates a workunit and one or more results.
|
|
The arguments are similar to those of the utility program;
|
|
some of the information is passed in the WORKUNIT structure,
|
|
namely the following fields:
|
|
<pre>
|
|
name
|
|
rsc_fpops
|
|
rsc_iops
|
|
rsc_memory
|
|
rsc_disk
|
|
delay_bound
|
|
</pre>
|