blob: e183d84aad8eac1e4f4ce3d46d3f0a36b69936f8 [file] [log] [blame]
<!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.6"/>
<title>Impala: be/src/common/global-flags.cc 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">Impala
</div>
<div id="projectbrief">Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</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&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('global-flags_8cc_source.html','');});
</script>
<div id="doc-content">
<!-- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</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 class="header">
<div class="headertitle">
<div class="title">global-flags.cc</div> </div>
</div><!--header-->
<div class="contents">
<a href="global-flags_8cc.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2012 Cloudera Inc.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// This file contains global flags, ie, flags which don&#39;t belong to a particular</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// component (and would therefore need to be DEFINE&#39;d in every source file containing</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">// a main()), or flags that are referenced from multiple places and having them here</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">// calms the linker errors that would otherwise ensue.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="logging_8h.html">common/logging.h</a>&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">// This will be defaulted to the host name returned by the OS.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// This name is used in the principal generated for Kerberos authorization.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<a class="code" href="global-flags_8cc.html#a06ca06ba91695054448337d4e9c151e4">DEFINE_string</a>(hostname, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;Hostname to use for this daemon, also used as part of &quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="stringliteral">&quot;the Kerberos principal, if enabled. If not set, the system default will be&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="stringliteral">&quot; used&quot;</span>);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<a class="code" href="global-flags_8cc.html#a4a9d5657d0521a1fbcaaf23c71109760">DEFINE_int32</a>(be_port, 22000, <span class="stringliteral">&quot;port on which ImpalaInternalService is exported&quot;</span>);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">// Kerberos is enabled if and only if principal is set.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<a class="code" href="global-flags_8cc.html#a06ca06ba91695054448337d4e9c151e4">DEFINE_string</a>(principal, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;Kerberos principal. If set, both client and backend network&quot;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="stringliteral">&quot;connections will use Kerberos encryption and authentication.&quot;</span>);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<a class="code" href="global-flags_8cc.html#a06ca06ba91695054448337d4e9c151e4">DEFINE_string</a>(be_principal, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;Kerberos principal for backend network connections only,&quot;</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="stringliteral">&quot;overriding --principal if set.&quot;</span>);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<a class="code" href="global-flags_8cc.html#a06ca06ba91695054448337d4e9c151e4">DEFINE_string</a>(keytab_file, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;Absolute path to Kerberos keytab file&quot;</span>);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<a class="code" href="global-flags_8cc.html#a06ca06ba91695054448337d4e9c151e4">DEFINE_string</a>(krb5_conf, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;Absolute path to Kerberos krb5.conf if in a non-standard &quot;</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="stringliteral">&quot;location. Does not normally need to be set.&quot;</span>);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<a class="code" href="global-flags_8cc.html#a06ca06ba91695054448337d4e9c151e4">DEFINE_string</a>(krb5_debug_file, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;Turn on Kerberos debugging and output to this file&quot;</span>);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<a class="code" href="global-flags_8cc.html#a06ca06ba91695054448337d4e9c151e4">DEFINE_string</a>(mem_limit, <span class="stringliteral">&quot;80%&quot;</span>, <span class="stringliteral">&quot;Process memory limit specified as number of bytes &quot;</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="stringliteral">&quot;(&#39;&lt;int&gt;[bB]?&#39;), megabytes (&#39;&lt;float&gt;[mM]&#39;), gigabytes (&#39;&lt;float&gt;[gG]&#39;), &quot;</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="stringliteral">&quot;or percentage of the physical memory (&#39;&lt;int&gt;%&#39;). &quot;</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="stringliteral">&quot;Defaults to bytes if no unit is given&quot;</span>);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<a class="code" href="global-flags_8cc.html#a9fb87adc6f8e12c0573fd25886ddd45e">DEFINE_bool</a>(enable_process_lifetime_heap_profiling, <span class="keyword">false</span>, <span class="stringliteral">&quot;(Advanced) Enables heap &quot;</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="stringliteral">&quot;profiling for the lifetime of the process. Profile output will be stored in the &quot;</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="stringliteral">&quot;directory specified by -heap_profile_dir. Enabling this option will disable the &quot;</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="stringliteral">&quot;on-demand/remote server profile handlers.&quot;</span>);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<a class="code" href="global-flags_8cc.html#a06ca06ba91695054448337d4e9c151e4">DEFINE_string</a>(heap_profile_dir, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;Output directory to store heap profiles. If not set &quot;</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="stringliteral">&quot; profiles are stored in the current working directory.&quot;</span>);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<a class="code" href="global-flags_8cc.html#a9fb87adc6f8e12c0573fd25886ddd45e">DEFINE_bool</a>(abort_on_config_error, <span class="keyword">true</span>, <span class="stringliteral">&quot;Abort Impala startup if there are improper &quot;</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="stringliteral">&quot;configs or running on unsupported hardware.&quot;</span>);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<a class="code" href="global-flags_8cc.html#a9fb87adc6f8e12c0573fd25886ddd45e">DEFINE_bool</a>(disable_mem_pools, <span class="keyword">false</span>, <span class="stringliteral">&quot;Set to true to disable memory pooling. &quot;</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="stringliteral">&quot;This can be used to help diagnose memory corruption issues.&quot;</span>);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<a class="code" href="global-flags_8cc.html#a9fb87adc6f8e12c0573fd25886ddd45e">DEFINE_bool</a>(compact_catalog_topic, <span class="keyword">false</span>, <span class="stringliteral">&quot;If true, catalog updates sent via the &quot;</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="stringliteral">&quot;statestore are compacted before transmission. This saves network bandwidth at the&quot;</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="stringliteral">&quot; cost of a small quantity of CPU time. Enable this option in cluster with large&quot;</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="stringliteral">&quot; catalogs. It must be enabled on both the catalog service, and all Impala demons.&quot;</span>);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<a class="code" href="global-flags_8cc.html#a06ca06ba91695054448337d4e9c151e4">DEFINE_string</a>(redaction_rules_file, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;Absolute path to sensitive data redaction &quot;</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="stringliteral">&quot;rules. The rules will be applied to all log messages and query text shown in the &quot;</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="stringliteral">&quot;Web UI and audit records. Query results will not be affected. Refer to the &quot;</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="stringliteral">&quot;documentation for the rule file format.&quot;</span>);</div>
<div class="ttc" id="global-flags_8cc_html_a06ca06ba91695054448337d4e9c151e4"><div class="ttname"><a href="global-flags_8cc.html#a06ca06ba91695054448337d4e9c151e4">DEFINE_string</a></div><div class="ttdeci">DEFINE_string(hostname,&quot;&quot;,&quot;Hostname to use for this daemon, also used as part of &quot;&quot;the Kerberos principal, if enabled. If not set, the system default will be&quot;&quot; used&quot;)</div></div>
<div class="ttc" id="logging_8h_html"><div class="ttname"><a href="logging_8h.html">logging.h</a></div></div>
<div class="ttc" id="global-flags_8cc_html_a9fb87adc6f8e12c0573fd25886ddd45e"><div class="ttname"><a href="global-flags_8cc.html#a9fb87adc6f8e12c0573fd25886ddd45e">DEFINE_bool</a></div><div class="ttdeci">DEFINE_bool(enable_process_lifetime_heap_profiling, false,&quot;(Advanced) Enables heap &quot;&quot;profiling for the lifetime of the process. Profile output will be stored in the &quot;&quot;directory specified by -heap_profile_dir. Enabling this option will disable the &quot;&quot;on-demand/remote server profile handlers.&quot;)</div></div>
<div class="ttc" id="global-flags_8cc_html_a4a9d5657d0521a1fbcaaf23c71109760"><div class="ttname"><a href="global-flags_8cc.html#a4a9d5657d0521a1fbcaaf23c71109760">DEFINE_int32</a></div><div class="ttdeci">DEFINE_int32(be_port, 22000,&quot;port on which ImpalaInternalService is exported&quot;)</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_e5d120be6b5e8a44336cbfd013b25604.html">be</a></li><li class="navelem"><a class="el" href="dir_68cf7cafb51a962d5bc4848b83cab0de.html">src</a></li><li class="navelem"><a class="el" href="dir_167f1b6f9e156d639715bac594b285a1.html">common</a></li><li class="navelem"><a class="el" href="global-flags_8cc.html">global-flags.cc</a></li>
<li class="footer">Generated on Thu May 7 2015 16:10:34 for Impala by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>