<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.2.2 C++ API: gc_job_manager.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('gc__job__manager_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>gc_job_manager.h</h1> </div>
</div>
<div class="contents">
<a href="gc__job__manager_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2007,2008 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
<a name="l00018"></a>00018 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00019"></a>00019 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef INCLUDED_GC_JOB_MANAGER_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GC_JOB_MANAGER_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <boost/utility.hpp></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <vector></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <stdexcept></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <libspe2.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="gc__job__desc_8h.html">gc_job_desc.h</a>"</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classgc__job__manager.html" title="Abstract class that manages SPE jobs.There is typically a single instance derived from this class...">gc_job_manager</a>;
<a name="l00034"></a>00034 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<gc_job_manager></a> <a class="code" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a>;
<a name="l00035"></a>00035 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<spe_program_handle_t></a> <a class="code" href="classboost_1_1shared__ptr.html">spe_program_handle_sptr</a>;
<a name="l00036"></a>00036 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gc_job_desc></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gc_job_desc_sptr</a>;
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/*!</span>
<a name="l00039"></a>00039 <span class="comment"> * \brief Return a boost::shared_ptr to an spe_program_handle_t</span>
<a name="l00040"></a>00040 <span class="comment"> *</span>
<a name="l00041"></a>00041 <span class="comment"> * \param filename is the name of the SPE ELF executable to open.</span>
<a name="l00042"></a>00042 <span class="comment"> *</span>
<a name="l00043"></a>00043 <span class="comment"> * Calls spe_image_open to open the file. If successful returns a</span>
<a name="l00044"></a>00044 <span class="comment"> * boost::shared_ptr that will call spe_image_close when it's time to</span>
<a name="l00045"></a>00045 <span class="comment"> * free the object.</span>
<a name="l00046"></a>00046 <span class="comment"> *</span>
<a name="l00047"></a>00047 <span class="comment"> * Returns the equivalent of the NULL pointer if the file cannot be</span>
<a name="l00048"></a>00048 <span class="comment"> * opened, or if it's not an SPE ELF object file.</span>
<a name="l00049"></a>00049 <span class="comment"> *</span>
<a name="l00050"></a>00050 <span class="comment"> * \sa gc_program_handle_from_address</span>
<a name="l00051"></a>00051 <span class="comment"> */</span>
<a name="l00052"></a>00052 <a class="code" href="classboost_1_1shared__ptr.html">spe_program_handle_sptr</a>
<a name="l00053"></a>00053 <a class="code" href="gc__job__manager_8h.html#a1dd4518136ea1dc7bf0dde42ad7a4803" title="Return a boost::shared_ptr to an spe_program_handle_t.">gc_program_handle_from_filename</a>(<span class="keyword">const</span> std::string &filename);
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment">/*!</span>
<a name="l00056"></a>00056 <span class="comment"> * \brief Return a boost::shared_ptr to an spe_program_handle_t</span>
<a name="l00057"></a>00057 <span class="comment"> *</span>
<a name="l00058"></a>00058 <span class="comment"> * \param handle is a non-zero pointer to an embedded SPE image.</span>
<a name="l00059"></a>00059 <span class="comment"> *</span>
<a name="l00060"></a>00060 <span class="comment"> * If successful returns a boost::shared_ptr that does nothing when</span>
<a name="l00061"></a>00061 <span class="comment"> * it's time to free the object.</span>
<a name="l00062"></a>00062 <span class="comment"> *</span>
<a name="l00063"></a>00063 <span class="comment"> * \sa gc_program_handle_from_filename</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a>00065 <a class="code" href="classboost_1_1shared__ptr.html">spe_program_handle_sptr</a>
<a name="l00066"></a>00066 <a class="code" href="gc__job__manager_8h.html#a97e12792ec99a2ae9efccb37e309091a" title="Return a boost::shared_ptr to an spe_program_handle_t.">gc_program_handle_from_address</a>(spe_program_handle_t *handle);
<a name="l00067"></a>00067 <span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment">/*!</span>
<a name="l00069"></a>00069 <span class="comment"> * \brief map gc_job_status_t into a string</span>
<a name="l00070"></a>00070 <span class="comment"> */</span>
<a name="l00071"></a>00071 <span class="keyword">const</span> std::string
<a name="l00072"></a>00072 <a class="code" href="gc__job__manager_8h.html#ad0c489d72a6e526f278f3e2962597ebd" title="map gc_job_status_t into a string">gc_job_status_string</a>(<a class="code" href="gc__job__desc_8h.html#a8e110a97291b439c37ed61b0931bb0dd" title="final job status">gc_job_status_t</a> status);
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="comment">/*</span>
<a name="l00075"></a>00075 <span class="comment"> * \brief Options that configure the job_manager.</span>
<a name="l00076"></a>00076 <span class="comment"> * The default values are reasonable.</span>
<a name="l00077"></a>00077 <span class="comment"> */</span>
<a name="l00078"></a><a class="code" href="structgc__jm__options.html">00078</a> <span class="keyword">struct </span><a class="code" href="structgc__jm__options.html">gc_jm_options</a> {
<a name="l00079"></a><a class="code" href="structgc__jm__options.html#aa304dd1cfcbba8493b0d7c6cee8c9de6">00079</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structgc__jm__options.html#aa304dd1cfcbba8493b0d7c6cee8c9de6">max_jobs</a>; <span class="comment">// max # of job descriptors in system</span>
<a name="l00080"></a><a class="code" href="structgc__jm__options.html#aab18f2ee3ca408c9e3af58ccffdf79ba">00080</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structgc__jm__options.html#aab18f2ee3ca408c9e3af58ccffdf79ba">max_client_threads</a>; <span class="comment">// max # of client threads of job manager</span>
<a name="l00081"></a><a class="code" href="structgc__jm__options.html#a6ea0fa1f46b8c10503bd616eb0ac23be">00081</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structgc__jm__options.html#a6ea0fa1f46b8c10503bd616eb0ac23be">nspes</a>; <span class="comment">// how many SPEs shall we use? 0 -> all of them</span>
<a name="l00082"></a><a class="code" href="structgc__jm__options.html#abf0f499ade951e9f7094d4033be96de6">00082</a> <span class="keywordtype">bool</span> <a class="code" href="structgc__jm__options.html#abf0f499ade951e9f7094d4033be96de6">gang_schedule</a>; <span class="comment">// shall we gang schedule?</span>
<a name="l00083"></a><a class="code" href="structgc__jm__options.html#a7574fce9ef2361ba144f2b2251bb3bb3">00083</a> <span class="keywordtype">bool</span> <a class="code" href="structgc__jm__options.html#a7574fce9ef2361ba144f2b2251bb3bb3">use_affinity</a>; <span class="comment">// shall we try for affinity (FIXME not implmented)</span>
<a name="l00084"></a><a class="code" href="structgc__jm__options.html#af7f78ed4f69a1a794501f982ce2f6fc9">00084</a> <span class="keywordtype">bool</span> <a class="code" href="structgc__jm__options.html#af7f78ed4f69a1a794501f982ce2f6fc9">enable_logging</a>; <span class="comment">// shall we log SPE events?</span>
<a name="l00085"></a><a class="code" href="structgc__jm__options.html#ad6ef161a82728e12c4ff665d3ac6d827">00085</a> uint32_t <a class="code" href="structgc__jm__options.html#ad6ef161a82728e12c4ff665d3ac6d827">log2_nlog_entries</a>; <span class="comment">// log2 of number of log entries (default is 12 == 4k)</span>
<a name="l00086"></a><a class="code" href="structgc__jm__options.html#a90d8b6ffdbb82653444968a36f89c569">00086</a> <a class="code" href="classboost_1_1shared__ptr.html">spe_program_handle_sptr</a> <a class="code" href="structgc__jm__options.html#a90d8b6ffdbb82653444968a36f89c569">program_handle</a>; <span class="comment">// program to load into SPEs</span>
<a name="l00087"></a>00087
<a name="l00088"></a><a class="code" href="structgc__jm__options.html#a4e83a1fd1c75eda65d278262e2743221">00088</a> <a class="code" href="structgc__jm__options.html#a4e83a1fd1c75eda65d278262e2743221">gc_jm_options</a>() :
<a name="l00089"></a>00089 <a class="code" href="structgc__jm__options.html#aa304dd1cfcbba8493b0d7c6cee8c9de6">max_jobs</a>(0), <a class="code" href="structgc__jm__options.html#aab18f2ee3ca408c9e3af58ccffdf79ba">max_client_threads</a>(0), <a class="code" href="structgc__jm__options.html#a6ea0fa1f46b8c10503bd616eb0ac23be">nspes</a>(0),
<a name="l00090"></a>00090 <a class="code" href="structgc__jm__options.html#abf0f499ade951e9f7094d4033be96de6">gang_schedule</a>(<a class="code" href="gc__types_8h.html#a65e9886d74aaee76545e83dd09011727">false</a>), <a class="code" href="structgc__jm__options.html#a7574fce9ef2361ba144f2b2251bb3bb3">use_affinity</a>(<a class="code" href="gc__types_8h.html#a65e9886d74aaee76545e83dd09011727">false</a>),
<a name="l00091"></a>00091 <a class="code" href="structgc__jm__options.html#af7f78ed4f69a1a794501f982ce2f6fc9">enable_logging</a>(<a class="code" href="gc__types_8h.html#a65e9886d74aaee76545e83dd09011727">false</a>), <a class="code" href="structgc__jm__options.html#ad6ef161a82728e12c4ff665d3ac6d827">log2_nlog_entries</a>(12)
<a name="l00092"></a>00092 {
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094
<a name="l00095"></a><a class="code" href="structgc__jm__options.html#ac2fd3300f096fc05aebd7f174c441dae">00095</a> <a class="code" href="structgc__jm__options.html#a4e83a1fd1c75eda65d278262e2743221">gc_jm_options</a>(<a class="code" href="classboost_1_1shared__ptr.html">spe_program_handle_sptr</a> program_handle_,
<a name="l00096"></a>00096 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nspes_ = 0) :
<a name="l00097"></a>00097 <a class="code" href="structgc__jm__options.html#aa304dd1cfcbba8493b0d7c6cee8c9de6">max_jobs</a>(0), <a class="code" href="structgc__jm__options.html#aab18f2ee3ca408c9e3af58ccffdf79ba">max_client_threads</a>(0), <a class="code" href="structgc__jm__options.html#a6ea0fa1f46b8c10503bd616eb0ac23be">nspes</a>(nspes_),
<a name="l00098"></a>00098 <a class="code" href="structgc__jm__options.html#abf0f499ade951e9f7094d4033be96de6">gang_schedule</a>(<a class="code" href="gc__types_8h.html#a65e9886d74aaee76545e83dd09011727">false</a>), <a class="code" href="structgc__jm__options.html#a7574fce9ef2361ba144f2b2251bb3bb3">use_affinity</a>(<a class="code" href="gc__types_8h.html#a65e9886d74aaee76545e83dd09011727">false</a>),
<a name="l00099"></a>00099 <a class="code" href="structgc__jm__options.html#af7f78ed4f69a1a794501f982ce2f6fc9">enable_logging</a>(<a class="code" href="gc__types_8h.html#a65e9886d74aaee76545e83dd09011727">false</a>), <a class="code" href="structgc__jm__options.html#ad6ef161a82728e12c4ff665d3ac6d827">log2_nlog_entries</a>(12),
<a name="l00100"></a>00100 <a class="code" href="structgc__jm__options.html#a90d8b6ffdbb82653444968a36f89c569">program_handle</a>(program_handle_)
<a name="l00101"></a>00101 {
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104
<a name="l00105"></a><a class="code" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038c">00105</a> <span class="keyword">enum</span> <a class="code" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038c">gc_wait_mode</a> {
<a name="l00106"></a><a class="code" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038ca03e0a1c46214d9006a4078ab88f523be">00106</a> <a class="code" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038ca03e0a1c46214d9006a4078ab88f523be">GC_WAIT_ANY</a>,
<a name="l00107"></a><a class="code" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038ca1281576bc1c87da9044b2bbbba101963">00107</a> <a class="code" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038ca1281576bc1c87da9044b2bbbba101963">GC_WAIT_ALL</a>,
<a name="l00108"></a>00108 };
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="comment">/*</span>
<a name="l00111"></a>00111 <span class="comment"> * exception classes</span>
<a name="l00112"></a>00112 <span class="comment"> */</span>
<a name="l00113"></a><a class="code" href="classgc__exception.html">00113</a> <span class="keyword">class </span><a class="code" href="classgc__exception.html">gc_exception</a> : <span class="keyword">public</span> std::runtime_error
<a name="l00114"></a>00114 {
<a name="l00115"></a>00115 <span class="keyword">public</span>:
<a name="l00116"></a>00116 <a class="code" href="classgc__exception.html#aed7fb629a044d16d412de649bc2bc09f">gc_exception</a>(<span class="keyword">const</span> std::string &msg);
<a name="l00117"></a>00117 };
<a name="l00118"></a>00118
<a name="l00119"></a><a class="code" href="classgc__unknown__proc.html">00119</a> <span class="keyword">class </span><a class="code" href="classgc__unknown__proc.html">gc_unknown_proc</a> : <span class="keyword">public</span> <a class="code" href="classgc__exception.html">gc_exception</a>
<a name="l00120"></a>00120 {
<a name="l00121"></a>00121 <span class="keyword">public</span>:
<a name="l00122"></a>00122 <a class="code" href="classgc__unknown__proc.html#a4580f910b7bc0418d070283f78d85402">gc_unknown_proc</a>(<span class="keyword">const</span> std::string &msg);
<a name="l00123"></a>00123 };
<a name="l00124"></a>00124
<a name="l00125"></a><a class="code" href="classgc__bad__alloc.html">00125</a> <span class="keyword">class </span><a class="code" href="classgc__bad__alloc.html">gc_bad_alloc</a> : <span class="keyword">public</span> <a class="code" href="classgc__exception.html">gc_exception</a>
<a name="l00126"></a>00126 {
<a name="l00127"></a>00127 <span class="keyword">public</span>:
<a name="l00128"></a>00128 <a class="code" href="classgc__bad__alloc.html#aa2a9201861429f9d52069af83a76e8a1">gc_bad_alloc</a>(<span class="keyword">const</span> std::string &msg);
<a name="l00129"></a>00129 };
<a name="l00130"></a>00130
<a name="l00131"></a><a class="code" href="classgc__bad__align.html">00131</a> <span class="keyword">class </span><a class="code" href="classgc__bad__align.html">gc_bad_align</a> : <span class="keyword">public</span> <a class="code" href="classgc__exception.html">gc_exception</a>
<a name="l00132"></a>00132 {
<a name="l00133"></a>00133 <span class="keyword">public</span>:
<a name="l00134"></a>00134 <a class="code" href="classgc__bad__align.html#a1bc4cd94a0111f934c67e3a2f65841a6">gc_bad_align</a>(<span class="keyword">const</span> std::string &msg);
<a name="l00135"></a>00135 };
<a name="l00136"></a>00136
<a name="l00137"></a><a class="code" href="classgc__bad__submit.html">00137</a> <span class="keyword">class </span><a class="code" href="classgc__bad__submit.html">gc_bad_submit</a> : <span class="keyword">public</span> <a class="code" href="classgc__exception.html">gc_exception</a>
<a name="l00138"></a>00138 {
<a name="l00139"></a>00139 <span class="keyword">public</span>:
<a name="l00140"></a>00140 <a class="code" href="classgc__bad__submit.html#a87b6cd928df343b3f474323c2a04a86e">gc_bad_submit</a>(<span class="keyword">const</span> std::string &name, <a class="code" href="gc__job__desc_8h.html#a8e110a97291b439c37ed61b0931bb0dd" title="final job status">gc_job_status_t</a> status);
<a name="l00141"></a>00141 };
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="comment">/*</span>
<a name="l00144"></a>00144 <span class="comment"> * \brief Create an instance of the job manager</span>
<a name="l00145"></a>00145 <span class="comment"> */</span>
<a name="l00146"></a>00146 <a class="code" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a>
<a name="l00147"></a>00147 <a class="code" href="gc__job__manager_8h.html#ababcb62055f6ee7f1de4595669e52d2a">gc_make_job_manager</a>(<span class="keyword">const</span> <a class="code" href="structgc__jm__options.html">gc_jm_options</a> *options = 0);
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="comment"></span>
<a name="l00150"></a>00150 <span class="comment">/*!</span>
<a name="l00151"></a>00151 <span class="comment"> * \brief Abstract class that manages SPE jobs.</span>
<a name="l00152"></a>00152 <span class="comment"> * \ingroup gcell</span>
<a name="l00153"></a>00153 <span class="comment"> *</span>
<a name="l00154"></a>00154 <span class="comment"> * There is typically a single instance derived from this class.</span>
<a name="l00155"></a>00155 <span class="comment"> * It is safe to call its methods from any thread.</span>
<a name="l00156"></a>00156 <span class="comment"> */</span>
<a name="l00157"></a><a class="code" href="classgc__job__manager.html">00157</a> <span class="keyword">class </span><a class="code" href="classgc__job__manager.html" title="Abstract class that manages SPE jobs.There is typically a single instance derived from this class...">gc_job_manager</a> : boost::noncopyable
<a name="l00158"></a>00158 {
<a name="l00159"></a>00159 <span class="keyword">public</span>:
<a name="l00160"></a>00160 <a class="code" href="classgc__job__manager.html#a55d6e5f2dd1035a1d0d915c3d890916f">gc_job_manager</a>(<span class="keyword">const</span> <a class="code" href="structgc__jm__options.html">gc_jm_options</a> *options = 0);
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="keyword">virtual</span> <a class="code" href="classgc__job__manager.html#a40094f709ede2264ec1df985e996a411">~gc_job_manager</a>();
<a name="l00163"></a>00163 <span class="comment"></span>
<a name="l00164"></a>00164 <span class="comment"> /*!</span>
<a name="l00165"></a>00165 <span class="comment"> * Stop accepting new jobs. Wait for existing jobs to complete.</span>
<a name="l00166"></a>00166 <span class="comment"> * Return all managed SPE's to the system.</span>
<a name="l00167"></a>00167 <span class="comment"> */</span>
<a name="l00168"></a>00168 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classgc__job__manager.html#a12ba6187460071d427305809cae8a5ba">shutdown</a>() = 0;
<a name="l00169"></a>00169 <span class="comment"></span>
<a name="l00170"></a>00170 <span class="comment"> /*!</span>
<a name="l00171"></a>00171 <span class="comment"> * \brief Return number of SPE's currently allocated to job manager.</span>
<a name="l00172"></a>00172 <span class="comment"> */</span>
<a name="l00173"></a>00173 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classgc__job__manager.html#a50d8e2f20b58d1c6743d86277664cad2" title="Return number of SPE&#39;s currently allocated to job manager.">nspes</a>() <span class="keyword">const</span> = 0;
<a name="l00174"></a>00174 <span class="comment"></span>
<a name="l00175"></a>00175 <span class="comment"> /*!</span>
<a name="l00176"></a>00176 <span class="comment"> * \brief Return a pointer to a properly aligned job descriptor,</span>
<a name="l00177"></a>00177 <span class="comment"> * or throws gc_bad_alloc if there are none available.</span>
<a name="l00178"></a>00178 <span class="comment"> */</span>
<a name="l00179"></a>00179 <span class="keyword">virtual</span> <a class="code" href="structgc__job__desc.html" title="&quot;job description&quot; that is DMA&#39;d to/from the SPE.">gc_job_desc</a> *<a class="code" href="classgc__job__manager.html#a22f39fc07b55782205b914555b8cb10a" title="Return a pointer to a properly aligned job descriptor, or throws gc_bad_alloc if there are none avail...">alloc_job_desc</a>() = 0;
<a name="l00180"></a>00180
<a name="l00181"></a>00181 <span class="comment">/*</span>
<a name="l00182"></a>00182 <span class="comment"> *! Free a job descriptor previously allocated with alloc_job_desc()</span>
<a name="l00183"></a>00183 <span class="comment"> *</span>
<a name="l00184"></a>00184 <span class="comment"> * \param[in] jd pointer to job descriptor to free.</span>
<a name="l00185"></a>00185 <span class="comment"> */</span>
<a name="l00186"></a>00186 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgc__job__manager.html#a0aeeb7c3b20089adcd521179a33e326d">free_job_desc</a>(<a class="code" href="structgc__job__desc.html" title="&quot;job description&quot; that is DMA&#39;d to/from the SPE.">gc_job_desc</a> *jd) = 0;
<a name="l00187"></a>00187 <span class="comment"></span>
<a name="l00188"></a>00188 <span class="comment"> /*!</span>
<a name="l00189"></a>00189 <span class="comment"> * \brief Submit a job for asynchronous processing on an SPE.</span>
<a name="l00190"></a>00190 <span class="comment"> *</span>
<a name="l00191"></a>00191 <span class="comment"> * \param[in] jd pointer to job description</span>
<a name="l00192"></a>00192 <span class="comment"> *</span>
<a name="l00193"></a>00193 <span class="comment"> * The caller must not read or write the job description</span>
<a name="l00194"></a>00194 <span class="comment"> * or any of the memory associated with any indirect arguments</span>
<a name="l00195"></a>00195 <span class="comment"> * until after calling wait_job.</span>
<a name="l00196"></a>00196 <span class="comment"> *</span>
<a name="l00197"></a>00197 <span class="comment"> * \returns true iff the job was successfully enqueued.</span>
<a name="l00198"></a>00198 <span class="comment"> * If submit_job returns false, check jd->status for additional info.</span>
<a name="l00199"></a>00199 <span class="comment"> */</span>
<a name="l00200"></a>00200 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classgc__job__manager.html#a050c7cc1ed51f2ff5a6e41541c55cf29" title="Submit a job for asynchronous processing on an SPE.">submit_job</a>(<a class="code" href="structgc__job__desc.html" title="&quot;job description&quot; that is DMA&#39;d to/from the SPE.">gc_job_desc</a> *jd) = 0;
<a name="l00201"></a>00201 <span class="comment"></span>
<a name="l00202"></a>00202 <span class="comment"> /*!</span>
<a name="l00203"></a>00203 <span class="comment"> * \brief Wait for job to complete.</span>
<a name="l00204"></a>00204 <span class="comment"> *</span>
<a name="l00205"></a>00205 <span class="comment"> * A thread may only wait for jobs which it submitted.</span>
<a name="l00206"></a>00206 <span class="comment"> *</span>
<a name="l00207"></a>00207 <span class="comment"> * \returns true if sucessful, else false.</span>
<a name="l00208"></a>00208 <span class="comment"> */</span>
<a name="l00209"></a>00209 <span class="keyword">virtual</span> <span class="keywordtype">bool</span>
<a name="l00210"></a>00210 <a class="code" href="classgc__job__manager.html#ad323d06be028cd5f4848cbd7451b2114" title="Wait for job to complete.">wait_job</a>(<a class="code" href="structgc__job__desc.html" title="&quot;job description&quot; that is DMA&#39;d to/from the SPE.">gc_job_desc</a> *jd) = 0;
<a name="l00211"></a>00211 <span class="comment"></span>
<a name="l00212"></a>00212 <span class="comment"> /*!</span>
<a name="l00213"></a>00213 <span class="comment"> * \brief wait for 1 or more jobs to complete.</span>
<a name="l00214"></a>00214 <span class="comment"> *</span>
<a name="l00215"></a>00215 <span class="comment"> * \param[in] njobs is the length of arrays \p jd and \p done.</span>
<a name="l00216"></a>00216 <span class="comment"> * \param[in] jd are the jobs that are to be waited for.</span>
<a name="l00217"></a>00217 <span class="comment"> * \param[out] done indicates whether the corresponding job is complete.</span>
<a name="l00218"></a>00218 <span class="comment"> * \param[in] mode indicates whether to wait for ALL or ANY of the jobs</span>
<a name="l00219"></a>00219 <span class="comment"> * in \p jd to complete.</span>
<a name="l00220"></a>00220 <span class="comment"> *</span>
<a name="l00221"></a>00221 <span class="comment"> * A thread may only wait for jobs which it submitted.</span>
<a name="l00222"></a>00222 <span class="comment"> *</span>
<a name="l00223"></a>00223 <span class="comment"> * \returns number of jobs completed, or -1 if error.</span>
<a name="l00224"></a>00224 <span class="comment"> * The caller must examine the status field of each job to confirm</span>
<a name="l00225"></a>00225 <span class="comment"> * successful completion of the job.</span>
<a name="l00226"></a>00226 <span class="comment"> */</span>
<a name="l00227"></a>00227 <span class="keyword">virtual</span> <span class="keywordtype">int</span>
<a name="l00228"></a>00228 <a class="code" href="classgc__job__manager.html#a3f202d807a08d7756112388ce9fd03ff" title="wait for 1 or more jobs to complete.">wait_jobs</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> njobs,
<a name="l00229"></a>00229 <a class="code" href="structgc__job__desc.html" title="&quot;job description&quot; that is DMA&#39;d to/from the SPE.">gc_job_desc</a> *jd[], <span class="keywordtype">bool</span> done[], <a class="code" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038c">gc_wait_mode</a> mode) = 0;
<a name="l00230"></a>00230 <span class="comment"></span>
<a name="l00231"></a>00231 <span class="comment"> /*!</span>
<a name="l00232"></a>00232 <span class="comment"> * Return the maximum number of bytes of EA arguments that may be</span>
<a name="l00233"></a>00233 <span class="comment"> * copied to or from the SPE in a single job. The limit applies</span>
<a name="l00234"></a>00234 <span class="comment"> * independently to the "get" and "put" args. </span>
<a name="l00235"></a>00235 <span class="comment"> * \sa gc_job_desc_t, gc_job_ea_args_t</span>
<a name="l00236"></a>00236 <span class="comment"> */</span>
<a name="l00237"></a>00237 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classgc__job__manager.html#acd5c7de0370f3186ae467f8db24ca94d">ea_args_maxsize</a>() = 0;
<a name="l00238"></a>00238 <span class="comment"></span>
<a name="l00239"></a>00239 <span class="comment"> /*!</span>
<a name="l00240"></a>00240 <span class="comment"> * Return gc_proc_id_t associated with spu procedure \p proc_name if one</span>
<a name="l00241"></a>00241 <span class="comment"> * exists, otherwise throws gc_unknown_proc.</span>
<a name="l00242"></a>00242 <span class="comment"> */</span>
<a name="l00243"></a>00243 <span class="keyword">virtual</span> <a class="code" href="gc__job__desc_8h.html#a26e60e5aaade61f7c333ee636940a658" title="opaque ID that specifies which code to invoke on the SPE">gc_proc_id_t</a> <a class="code" href="classgc__job__manager.html#aebe49e58ce5ffc139b133bd5c1d1675b">lookup_proc</a>(<span class="keyword">const</span> std::string &proc_name) = 0;
<a name="l00244"></a>00244 <span class="comment"></span>
<a name="l00245"></a>00245 <span class="comment"> /*!</span>
<a name="l00246"></a>00246 <span class="comment"> * Return a vector of all known spu procedure names.</span>
<a name="l00247"></a>00247 <span class="comment"> */</span>
<a name="l00248"></a>00248 <span class="keyword">virtual</span> <a class="code" href="classstd_1_1vector.html" title="vector documentation stub">std::vector<std::string></a> <a class="code" href="classgc__job__manager.html#a62257a6f86bf862494054a1a57cb128c">proc_names</a>() = 0;
<a name="l00249"></a>00249
<a name="l00250"></a>00250 <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_debug(<span class="keywordtype">int</span> debug);
<a name="l00251"></a>00251 <span class="keyword">virtual</span> <span class="keywordtype">int</span> debug();
<a name="l00252"></a>00252
<a name="l00253"></a>00253 <span class="comment">/* ----- static methods ----- */</span>
<a name="l00254"></a>00254 <span class="comment"></span>
<a name="l00255"></a>00255 <span class="comment"> /*!</span>
<a name="l00256"></a>00256 <span class="comment"> * \brief Set the singleton gc_job_manager instance.</span>
<a name="l00257"></a>00257 <span class="comment"> * \param mgr is the job manager instance.</span>
<a name="l00258"></a>00258 <span class="comment"> *</span>
<a name="l00259"></a>00259 <span class="comment"> * The singleton is weakly held, thus the caller must maintain</span>
<a name="l00260"></a>00260 <span class="comment"> * a reference to the mgr for the duration. (If we held the</span>
<a name="l00261"></a>00261 <span class="comment"> * manager strongly, the destructor would never be called, and the</span>
<a name="l00262"></a>00262 <span class="comment"> * resources (SPEs) would not be returned.) Bottom line: the</span>
<a name="l00263"></a>00263 <span class="comment"> * caller is responsible for life-time management.</span>
<a name="l00264"></a>00264 <span class="comment"> */</span>
<a name="l00265"></a>00265 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classgc__job__manager.html#a4df28764e574674ae33ab149982fa0da" title="Set the singleton gc_job_manager instance.">set_singleton</a>(<a class="code" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> mgr);
<a name="l00266"></a>00266 <span class="comment"></span>
<a name="l00267"></a>00267 <span class="comment"> /*!</span>
<a name="l00268"></a>00268 <span class="comment"> * \brief Retrieve the singleton gc_job_manager instance.</span>
<a name="l00269"></a>00269 <span class="comment"> *</span>
<a name="l00270"></a>00270 <span class="comment"> * Returns the singleton gc_job_manager instance or raises</span>
<a name="l00271"></a>00271 <span class="comment"> * boost::bad_weak_ptr if the singleton is empty.</span>
<a name="l00272"></a>00272 <span class="comment"> */</span>
<a name="l00273"></a>00273 <span class="keyword">static</span> <a class="code" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> <a class="code" href="classgc__job__manager.html#a02b46ba7fd4fbd19fa18a3e2dd500a62" title="Retrieve the singleton gc_job_manager instance.">singleton</a>();
<a name="l00274"></a>00274 <span class="comment"></span>
<a name="l00275"></a>00275 <span class="comment"> /*!</span>
<a name="l00276"></a>00276 <span class="comment"> * \brief return a boost::shared_ptr to a job descriptor.</span>
<a name="l00277"></a>00277 <span class="comment"> */</span>
<a name="l00278"></a>00278 <span class="keyword">static</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gc_job_desc_sptr</a> make_jd_sptr(<a class="code" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> mgr, <a class="code" href="structgc__job__desc.html" title="&quot;job description&quot; that is DMA&#39;d to/from the SPE.">gc_job_desc</a> *jd);
<a name="l00279"></a>00279 <span class="comment"></span>
<a name="l00280"></a>00280 <span class="comment"> /*!</span>
<a name="l00281"></a>00281 <span class="comment"> * \brief allocate a job descriptor and return a boost::shared_ptr to it.</span>
<a name="l00282"></a>00282 <span class="comment"> */</span>
<a name="l00283"></a>00283 <span class="keyword">static</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gc_job_desc_sptr</a> <a class="code" href="classgc__job__manager.html#a22f39fc07b55782205b914555b8cb10a" title="Return a pointer to a properly aligned job descriptor, or throws gc_bad_alloc if there are none avail...">alloc_job_desc</a>(<a class="code" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> mgr);
<a name="l00284"></a>00284 };
<a name="l00285"></a>00285
<a name="l00286"></a>00286
<a name="l00287"></a>00287 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GC_JOB_MANAGER_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="gc__job__manager_8h.html">gc_job_manager.h</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
3452
