2002-08-21 23:49:33 +00:00
|
|
|
<title>Storage</title>
|
2002-08-20 23:54:17 +00:00
|
|
|
<body bgcolor=ffffff>
|
2002-08-21 23:49:33 +00:00
|
|
|
<h2>Storage</h2>
|
2002-08-19 18:43:10 +00:00
|
|
|
<h3>Files</h3>
|
2002-04-30 22:22:54 +00:00
|
|
|
<p>
|
2002-08-19 18:43:10 +00:00
|
|
|
The BOINC storage model is based on <b>files</b>.
|
|
|
|
|
The inputs and
|
2002-07-29 19:01:38 +00:00
|
|
|
outputs of applications, and the applications executables, are files.
|
2002-04-30 22:22:54 +00:00
|
|
|
<p>
|
2002-08-19 18:43:10 +00:00
|
|
|
A file is described by an XML element of the form
|
2002-05-17 22:33:57 +00:00
|
|
|
<pre>
|
2002-07-29 19:01:38 +00:00
|
|
|
<file_info>
|
|
|
|
|
<name>foobar</name>
|
|
|
|
|
<url>http://a.b.c/foobar</url>
|
|
|
|
|
<url>http://x.y.z/foobar</url>
|
2002-05-17 22:33:57 +00:00
|
|
|
...
|
2002-07-29 19:01:38 +00:00
|
|
|
<md5_cksum>123123123123</md5_cksum>
|
|
|
|
|
<nbytes>134423</nbytes>
|
|
|
|
|
<max_nbytes>200000</max_nbytes>
|
2002-08-30 00:10:40 +00:00
|
|
|
<status>1</status>
|
|
|
|
|
[ <generated_locally/> ]
|
2002-07-29 19:01:38 +00:00
|
|
|
[ <executable/> ]
|
|
|
|
|
[ <upload_when_present/> ]
|
|
|
|
|
[ <sticky/> ]
|
2002-08-30 00:10:40 +00:00
|
|
|
[ <signature_required/> ]
|
|
|
|
|
[ <a href=pers_file_xfer.html><persistent_file_xfer> ... </persistent_file_xfer></a> ]
|
2002-07-29 19:01:38 +00:00
|
|
|
</file_info>
|
2002-08-19 18:43:10 +00:00
|
|
|
</pre>
|
|
|
|
|
The components are as follows:
|
2002-04-30 22:22:54 +00:00
|
|
|
<ul>
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> The <b><name></b> element gives the file's name, which
|
2002-08-20 23:54:17 +00:00
|
|
|
must be unique within the project.
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> Each <b><url></b> element gives a URL where the file is
|
2002-07-29 19:01:38 +00:00
|
|
|
(or will be) located on a data server.
|
2002-08-21 23:49:33 +00:00
|
|
|
<li> The <b><md5_cksum></b> element is the MD5 checksum of the file.
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> The <b><nbytes></b> element is the size of the file in
|
2002-07-29 19:01:38 +00:00
|
|
|
bytes (may be greater than 2^32).
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> The <b><max_nbytes></b> element is the maximum allowable
|
|
|
|
|
size of the file in bytes (may be greater than 2^32).
|
|
|
|
|
This is used to prevent flooding data servers with bogus data.
|
2002-08-30 00:10:40 +00:00
|
|
|
<li> The <b><status></b> element is 0 if the file is not present,
|
|
|
|
|
1 if the file is present, or a negative error code if there was a
|
|
|
|
|
problem in downloading or generating the file.
|
|
|
|
|
<li> The <b><generated_locally></b> element, if present,
|
|
|
|
|
indicates that the file will be generated by an application on
|
|
|
|
|
the client, as opposed to being downloaded.
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> The <b><executable></b> element, if present, indicates
|
2002-07-29 19:01:38 +00:00
|
|
|
that the file protections should be set to allow execution.
|
2002-08-30 00:10:40 +00:00
|
|
|
<li> The <b><upload_when_present></b> element, if present,
|
|
|
|
|
indicates that the file should be uploaded after it is created.
|
|
|
|
|
<li> The <b><sticky></b> element, if present, indicates that
|
|
|
|
|
the file should be retained on the client after its initial use.
|
|
|
|
|
<li> The <b><signature_required></b> element, if present,
|
|
|
|
|
indicates that the file should be verified with an RSA signature.
|
|
|
|
|
This generally only applies to executable files.
|
2002-04-30 22:22:54 +00:00
|
|
|
</ul>
|
2002-07-29 19:01:38 +00:00
|
|
|
These attributes allow the specification of various types of files: for
|
|
|
|
|
example, input or output files that are retained for use as input to
|
2002-08-20 23:54:17 +00:00
|
|
|
later computations.
|
2002-04-30 22:22:54 +00:00
|
|
|
<p>
|
2002-08-19 18:43:10 +00:00
|
|
|
Once a file is created (on a data server or a participant host) it
|
2002-08-20 23:54:17 +00:00
|
|
|
is immutable.
|
2002-07-29 19:01:38 +00:00
|
|
|
<h3>File references</h3>
|
2002-04-30 22:22:54 +00:00
|
|
|
<p>
|
2002-08-19 18:43:10 +00:00
|
|
|
Files may be associated with <a href="work.html">workunits</a>,
|
|
|
|
|
<a href="result.html">results</a> and
|
|
|
|
|
<a href="app.html">application versions</a>.
|
|
|
|
|
Each such association is represented by an XML element of the form
|
2002-05-17 22:33:57 +00:00
|
|
|
<pre>
|
2002-07-29 19:01:38 +00:00
|
|
|
<file_ref>
|
|
|
|
|
<file_name>foobar</file_name>
|
|
|
|
|
[ <open_name>input</open_name> ]
|
|
|
|
|
[ <fd>2</fd> ]
|
|
|
|
|
[ <main_program/> ]
|
|
|
|
|
</file_ref>
|
2002-08-19 18:43:10 +00:00
|
|
|
</pre>
|
|
|
|
|
The components are as follows:
|
2002-05-17 22:33:57 +00:00
|
|
|
<ul>
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> The <b><file_name></b> element specifies a file.
|
|
|
|
|
<li> The <b><open_name></b> element, if present, is the name by
|
2002-08-21 23:49:33 +00:00
|
|
|
which the application will refer to the file.
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> The <b><fd></b> element, if present, indicates the file
|
|
|
|
|
descriptor number by which the application will access the file.
|
|
|
|
|
<li> The <b><main_program></b> element is used for files
|
|
|
|
|
associated with application versions.
|
|
|
|
|
It indicates that this file is the application's main program.
|
2002-05-17 22:33:57 +00:00
|
|
|
</ul>
|
