2002-08-20 23:54:17 +00:00
|
|
|
<title>Results</title>
|
|
|
|
|
<body bgcolor=ffffff>
|
|
|
|
|
<h2>Results</h2>
|
2002-05-17 22:33:57 +00:00
|
|
|
<p>
|
2002-08-19 18:43:10 +00:00
|
|
|
A <b>result</b> describes an instance of a computation, either to be
|
|
|
|
|
performed, in progress, or completed.
|
|
|
|
|
Results are stored in the <b>result</b> table of the BOINC DB.
|
|
|
|
|
The attributes of a result include:
|
2002-07-15 05:34:32 +00:00
|
|
|
|
2002-07-29 19:01:38 +00:00
|
|
|
<ul>
|
2002-08-20 23:54:17 +00:00
|
|
|
<li> The name of the result (unique across all results in the project).
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> The name of the associated workunit.
|
|
|
|
|
<li> The time when the completed result should be reported to a
|
|
|
|
|
scheduling server.
|
|
|
|
|
This is assigned by the project, and is used by
|
2002-08-20 23:54:17 +00:00
|
|
|
clients to prioritize operations and to initiate scheduler RPCs.
|
2002-08-19 18:43:10 +00:00
|
|
|
There is no guarantee that the result will actually be reported by this time.
|
|
|
|
|
<li> An XML document listing the names of its output files; see below.
|
|
|
|
|
<li> An XML document giving the sizes and checksums of its output
|
2002-07-29 19:01:38 +00:00
|
|
|
files (filled in after the result is completed).
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> The stderr output of the result.
|
|
|
|
|
<li> The host that computed the result.
|
|
|
|
|
<li> The times when the result was dispatched and received.
|
|
|
|
|
<li> The exit status of the application.
|
|
|
|
|
<li> The reported CPU time.
|
|
|
|
|
<li> Its <b>state</b>. Values include:
|
2002-05-17 22:33:57 +00:00
|
|
|
<ul>
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> Inactive (not ready to dispatch)
|
|
|
|
|
<li> Unsent (ready to dispatch, but not dispatched)
|
|
|
|
|
<li> In progress (dispatched, not done)
|
|
|
|
|
<li> Done successfully
|
|
|
|
|
<li> Timed out
|
|
|
|
|
<li> Done with error
|
2002-05-17 22:33:57 +00:00
|
|
|
</ul>
|
|
|
|
|
</ul>
|
2002-08-21 23:49:33 +00:00
|
|
|
<p>
|
|
|
|
|
Results are normally created using the
|
|
|
|
|
<a href=tools_work.html>create_work</a> utility.
|
|
|
|
|
<p>
|
2002-07-29 19:01:38 +00:00
|
|
|
The XML document listing the output files has the form: <pre>
|
|
|
|
|
<file_info>...</file_info>
|
2002-05-17 22:33:57 +00:00
|
|
|
[ ... ]
|
2002-07-29 19:01:38 +00:00
|
|
|
<result>
|
|
|
|
|
<name>foobar</name>
|
|
|
|
|
<wu_name>blah</wu_name>
|
|
|
|
|
<exit_status>blah</exit_status>
|
|
|
|
|
<file_ref>...</file_ref>
|
2002-05-17 22:33:57 +00:00
|
|
|
[ ... ]
|
2002-07-29 19:01:38 +00:00
|
|
|
</result>
|
2002-08-19 18:43:10 +00:00
|
|
|
</pre>
|
|
|
|
|
The components are:
|
2002-05-17 22:33:57 +00:00
|
|
|
<ul>
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> The <b><name></b> element is the result name.
|
|
|
|
|
<li> The <b><wu_name></b> element is the workunit name.
|
|
|
|
|
<li> Each <b><file_ref></b> element is an association to an
|
|
|
|
|
output file, described by a corresponding <b><file_info></b> element.
|
2002-05-17 22:33:57 +00:00
|
|
|
</ul>
|
|
|
|
|
<p>
|
2002-08-19 18:43:10 +00:00
|
|
|
The XML document describing the sizes and checksums of the output
|
2002-07-29 19:01:38 +00:00
|
|
|
files is just a list of <b><file_info></b> elements, with the
|
2002-08-19 18:43:10 +00:00
|
|
|
<b>nbytes</b> and <b>md5_cksum</b> fields present.
|
|
|
|
|
The project back end
|
|
|
|
|
must parse this field to find the locations and checksums of output files.
|
2002-05-17 22:33:57 +00:00
|
|
|
<p>
|
2002-08-19 18:43:10 +00:00
|
|
|
Several results may be associated with a single workunit.
|
|
|
|
|
Results
|
|
|
|
|
may be generated in either of two ways (selected as part of the application):
|
2002-05-17 22:33:57 +00:00
|
|
|
<ul>
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> <b>Advance generation</b> of results.
|
2002-08-20 23:54:17 +00:00
|
|
|
One or more result records are stored in the database
|
|
|
|
|
when the workunit is produced.
|
|
|
|
|
The scheduling server dispatches each result to a single participant host.
|
|
|
|
|
When all result records have been dispatched,
|
|
|
|
|
participants hosts are "turned away".
|
2002-08-19 18:43:10 +00:00
|
|
|
<li> <b>On-demand generation</b> of results.
|
2002-08-20 23:54:17 +00:00
|
|
|
The application specifies a "result template",
|
|
|
|
|
which has place-holder tokens for the output filenames.
|
2002-08-19 18:43:10 +00:00
|
|
|
The scheduling server, in response to a host request,
|
|
|
|
|
generates a new result record and sends the result template.
|
2002-08-20 23:54:17 +00:00
|
|
|
The host generates unique output filenames,
|
|
|
|
|
and returns them along when it the computation is done.
|
2002-05-17 22:33:57 +00:00
|
|
|
</ul>
|
