<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>torque: src/error.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">torque  <span id="projectnumber">4.1.6</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Groups</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">error.h</div> </div> </div><!--header--> <div class="contents"> <a href="error_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* $Id: error.h,v 1.4 2006/09/08 18:18:08 ciesnik Exp $ */</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * DRMAA library for Torque/PBS</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (C) 2006 Poznan Supercomputing and Networking Center</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * DSP team <dsp-devel@hedera.man.poznan.pl></span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * This library is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Lesser General Public License for more details.</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#ifndef __DRMAA__ERROR_H</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span><span class="preprocessor">#define __DRMAA__ERROR_H</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifdef HAVE_CONFIG_H</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"></span><span class="preprocessor"># include <pbs_config.h></span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <stddef.h></span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">int</span> <a class="code" href="error_8h.html#a6b10d7db8c7a68ff9b28ff0257f2026e">drmaa_get_errno_error</a>(<span class="keywordtype">char</span> *error_diagnosis, <span class="keywordtype">size_t</span> error_diag_len);</div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">int</span> drmaa_get_drmaa_error(<span class="keywordtype">char</span> *error_diagnosis, <span class="keywordtype">size_t</span> error_diag_len,</div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">int</span> error_code);</div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">int</span> <a class="code" href="error_8h.html#a9f12f964a012eb2de59ec2d4d579fadd">drmaa_get_pbs_error</a>(<span class="keywordtype">char</span> *error_diagnosis, <span class="keywordtype">size_t</span> error_diag_len);</div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">int</span> <a class="code" href="error_8h.html#ae70d3c93cb97cd7463849f0d6e3234fb">drmaa_map_pbs_error</a>(<span class="keywordtype">int</span> pbs_errcode);</div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">void</span> drmaa_log(<span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...)</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> __attribute__((format(printf, 1, 2)));</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#if DRMAA_DEBUG</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"></span><span class="preprocessor"># define DEBUG( args ) do{ drmaa_log args ; }while(0)</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span><span class="preprocessor"># define DEBUG( args ) </span><span class="comment">/* nothing */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#define STORE_ERRNO_MSG() \</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor"> do{ drmaa_get_errno_error( errmsg, errlen ); }while(0)</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#define RAISE_ERRNO( retcode ) do { \</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"> STORE_ERRNO_MSG(); \</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"> return retcode; \</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"> } while(0)</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#define SET_DRMAA_ERROR( retcode ) \</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"> do{ drmaa_get_drmaa_error( errmsg, errlen, (retcode) ); } while(0)</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#define RAISE_DRMAA( retcode ) do { \</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"> SET_DRMAA_ERROR( retcode ); \</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"> return retcode; \</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor"> } while(0)</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#define RAISE_NO_MEMORY() \</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> RAISE_DRMAA( DRMAA_ERRNO_NO_MEMORY )</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#define RAISE_PBS() \</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"> do{ return drmaa_get_pbs_error( errmsg, errlen ); } while(0)</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#define SET_PBS_ERROR( rc_var ) \</span></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"> do{ (rc_var) = drmaa_get_pbs_error( errmsg, errlen ); } while(0)</span></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#endif </span><span class="comment">/* __DRMAA__ERROR_H */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"></span></div> <div class="ttc" id="error_8h_html_a6b10d7db8c7a68ff9b28ff0257f2026e"><div class="ttname"><a href="error_8h.html#a6b10d7db8c7a68ff9b28ff0257f2026e">drmaa_get_errno_error</a></div><div class="ttdeci">int drmaa_get_errno_error(char *error_diagnosis, size_t error_diag_len)</div><div class="ttdoc">Gets last system error message and returns its code. </div><div class="ttdef"><b>Definition:</b> error.c:54</div></div> <div class="ttc" id="error_8h_html_a9f12f964a012eb2de59ec2d4d579fadd"><div class="ttname"><a href="error_8h.html#a9f12f964a012eb2de59ec2d4d579fadd">drmaa_get_pbs_error</a></div><div class="ttdeci">int drmaa_get_pbs_error(char *error_diagnosis, size_t error_diag_len)</div><div class="ttdoc">Retrieves last PBS error message. </div><div class="ttdef"><b>Definition:</b> error.c:74</div></div> <div class="ttc" id="error_8h_html_ae70d3c93cb97cd7463849f0d6e3234fb"><div class="ttname"><a href="error_8h.html#ae70d3c93cb97cd7463849f0d6e3234fb">drmaa_map_pbs_error</a></div><div class="ttdeci">int drmaa_map_pbs_error(int pbs_errcode)</div><div class="ttdoc">Maps PBS error code into DMRAA code. </div><div class="ttdef"><b>Definition:</b> error.c:218</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Nov 14 2013 18:07:37 for torque by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>