\hypertarget{orte_2mca_2rmaps_2base_2base_8h}{\section{orte/mca/rmaps/base/base.h File Reference}
\label{orte_2mca_2rmaps_2base_2base_8h}\index{orte/mca/rmaps/base/base.\+h@{orte/mca/rmaps/base/base.\+h}}
}


rmaps framework base functionality.  


{\ttfamily \#include \char`\"{}orte\+\_\+config.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}orte/types.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}opal/class/opal\+\_\+list.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}opal/mca/mca.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}orte/runtime/orte\+\_\+globals.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}orte/mca/rmaps/rmaps.\+h\char`\"{}}\\*
\subsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structorte__rmaps__base__t}{orte\+\_\+rmaps\+\_\+base\+\_\+t}
\begin{DoxyCompactList}\small\item\em Struct to hold data global to the rmaps framework. \end{DoxyCompactList}\item 
struct \hyperlink{structorte__rmaps__base__selected__module__t}{orte\+\_\+rmaps\+\_\+base\+\_\+selected\+\_\+module\+\_\+t}
\begin{DoxyCompactList}\small\item\em Select an rmaps component / module. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
B\+E\+G\+I\+N\+\_\+\+C\+\_\+\+D\+E\+C\+L\+S O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{orte_2mca_2rmaps_2base_2base_8h_a80806729ef1c137cc3d3a0f5db5b3007}{orte\+\_\+rmaps\+\_\+base\+\_\+open} (void)
\begin{DoxyCompactList}\small\item\em Open the rmaps framework. \end{DoxyCompactList}\item 
\hypertarget{orte_2mca_2rmaps_2base_2base_8h_a61b7348601b208a088596573a44be491}{{\bfseries O\+B\+J\+\_\+\+C\+L\+A\+S\+S\+\_\+\+D\+E\+C\+L\+A\+R\+A\+T\+I\+O\+N} (\hyperlink{structorte__rmaps__base__selected__module__t}{orte\+\_\+rmaps\+\_\+base\+\_\+selected\+\_\+module\+\_\+t})}\label{orte_2mca_2rmaps_2base_2base_8h_a61b7348601b208a088596573a44be491}

\item 
\hypertarget{orte_2mca_2rmaps_2base_2base_8h_a64077f78f49392be1ebb042ae482a9f6}{O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int {\bfseries orte\+\_\+rmaps\+\_\+base\+\_\+select} (void)}\label{orte_2mca_2rmaps_2base_2base_8h_a64077f78f49392be1ebb042ae482a9f6}

\item 
\hypertarget{orte_2mca_2rmaps_2base_2base_8h_a2de8f6b34afb269e36be658090897590}{O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{orte_2mca_2rmaps_2base_2base_8h_a2de8f6b34afb269e36be658090897590}{orte\+\_\+rmaps\+\_\+base\+\_\+get\+\_\+vpid\+\_\+range} (\hyperlink{orte_2include_2orte_2types_8h_addefe647f31eee13c7f756f0d959a99b}{orte\+\_\+jobid\+\_\+t} jobid, orte\+\_\+vpid\+\_\+t $\ast$start, orte\+\_\+vpid\+\_\+t $\ast$range)}\label{orte_2mca_2rmaps_2base_2base_8h_a2de8f6b34afb269e36be658090897590}

\begin{DoxyCompactList}\small\item\em Utility routines to get/set vpid mapping for the job. \end{DoxyCompactList}\item 
\hypertarget{orte_2mca_2rmaps_2base_2base_8h_af0f2f64c6b5bb7cdf23e63b3bfbf9db3}{O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int {\bfseries orte\+\_\+rmaps\+\_\+base\+\_\+set\+\_\+vpid\+\_\+range} (\hyperlink{orte_2include_2orte_2types_8h_addefe647f31eee13c7f756f0d959a99b}{orte\+\_\+jobid\+\_\+t} jobid, orte\+\_\+vpid\+\_\+t start, orte\+\_\+vpid\+\_\+t range)}\label{orte_2mca_2rmaps_2base_2base_8h_af0f2f64c6b5bb7cdf23e63b3bfbf9db3}

\item 
\hypertarget{orte_2mca_2rmaps_2base_2base_8h_a7dc45e8a4290ad2507b41550c8c364c8}{O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C char $\ast$ {\bfseries orte\+\_\+rmaps\+\_\+base\+\_\+print\+\_\+mapping} (orte\+\_\+mapping\+\_\+policy\+\_\+t mapping)}\label{orte_2mca_2rmaps_2base_2base_8h_a7dc45e8a4290ad2507b41550c8c364c8}

\item 
\hypertarget{orte_2mca_2rmaps_2base_2base_8h_a68b4c22ec5c683d8df8004776f5eb804}{O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C char $\ast$ {\bfseries orte\+\_\+rmaps\+\_\+base\+\_\+print\+\_\+ranking} (orte\+\_\+ranking\+\_\+policy\+\_\+t ranking)}\label{orte_2mca_2rmaps_2base_2base_8h_a68b4c22ec5c683d8df8004776f5eb804}

\item 
\hypertarget{orte_2mca_2rmaps_2base_2base_8h_adb06d5dfd8b38e04aae047263e847d84}{O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{orte_2mca_2rmaps_2base_2base_8h_adb06d5dfd8b38e04aae047263e847d84}{orte\+\_\+rmaps\+\_\+base\+\_\+close} (void)}\label{orte_2mca_2rmaps_2base_2base_8h_adb06d5dfd8b38e04aae047263e847d84}

\begin{DoxyCompactList}\small\item\em Close down the rmaps framework. \end{DoxyCompactList}\item 
O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{orte_2mca_2rmaps_2base_2base_8h_ad077f7bf30fb4d87845f2362412de3f4}{orte\+\_\+rmaps\+\_\+base\+\_\+filter\+\_\+nodes} (\hyperlink{structorte__app__context__t}{orte\+\_\+app\+\_\+context\+\_\+t} $\ast$app, \hyperlink{structopal__list__t}{opal\+\_\+list\+\_\+t} $\ast$nodes, bool remove)
\end{DoxyCompactItemize}
\subsection*{Variables}
\begin{DoxyCompactItemize}
\item 
\hypertarget{orte_2mca_2rmaps_2base_2base_8h_a24e6860741e399b5bae6dc4bf257aa1d}{O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C \hyperlink{structorte__rmaps__base__t}{orte\+\_\+rmaps\+\_\+base\+\_\+t} \hyperlink{orte_2mca_2rmaps_2base_2base_8h_a24e6860741e399b5bae6dc4bf257aa1d}{orte\+\_\+rmaps\+\_\+base}}\label{orte_2mca_2rmaps_2base_2base_8h_a24e6860741e399b5bae6dc4bf257aa1d}

\begin{DoxyCompactList}\small\item\em Global instance of rmaps-\/wide framework data. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
rmaps framework base functionality. 



\subsection{Function Documentation}
\hypertarget{orte_2mca_2rmaps_2base_2base_8h_ad077f7bf30fb4d87845f2362412de3f4}{\index{orte/mca/rmaps/base/base.\+h@{orte/mca/rmaps/base/base.\+h}!orte\+\_\+rmaps\+\_\+base\+\_\+filter\+\_\+nodes@{orte\+\_\+rmaps\+\_\+base\+\_\+filter\+\_\+nodes}}
\index{orte\+\_\+rmaps\+\_\+base\+\_\+filter\+\_\+nodes@{orte\+\_\+rmaps\+\_\+base\+\_\+filter\+\_\+nodes}!orte/mca/rmaps/base/base.\+h@{orte/mca/rmaps/base/base.\+h}}
\subsubsection[{orte\+\_\+rmaps\+\_\+base\+\_\+filter\+\_\+nodes}]{\setlength{\rightskip}{0pt plus 5cm}O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int orte\+\_\+rmaps\+\_\+base\+\_\+filter\+\_\+nodes (
\begin{DoxyParamCaption}
\item[{{\bf orte\+\_\+app\+\_\+context\+\_\+t} $\ast$}]{app, }
\item[{{\bf opal\+\_\+list\+\_\+t} $\ast$}]{nodes, }
\item[{bool}]{remove}
\end{DoxyParamCaption}
)}}\label{orte_2mca_2rmaps_2base_2base_8h_ad077f7bf30fb4d87845f2362412de3f4}
check that anything is here

check that anything is here

check that anything is left!

check that anything is left! 

References orte\+\_\+app\+\_\+context\+\_\+t\+::app, orte\+\_\+app\+\_\+context\+\_\+t\+::dash\+\_\+host, opal\+\_\+list\+\_\+get\+\_\+size(), and orte\+\_\+show\+\_\+help().



Referenced by orte\+\_\+rmaps\+\_\+base\+\_\+get\+\_\+target\+\_\+nodes().

\hypertarget{orte_2mca_2rmaps_2base_2base_8h_a80806729ef1c137cc3d3a0f5db5b3007}{\index{orte/mca/rmaps/base/base.\+h@{orte/mca/rmaps/base/base.\+h}!orte\+\_\+rmaps\+\_\+base\+\_\+open@{orte\+\_\+rmaps\+\_\+base\+\_\+open}}
\index{orte\+\_\+rmaps\+\_\+base\+\_\+open@{orte\+\_\+rmaps\+\_\+base\+\_\+open}!orte/mca/rmaps/base/base.\+h@{orte/mca/rmaps/base/base.\+h}}
\subsubsection[{orte\+\_\+rmaps\+\_\+base\+\_\+open}]{\setlength{\rightskip}{0pt plus 5cm}B\+E\+G\+I\+N\+\_\+\+C\+\_\+\+D\+E\+C\+L\+S O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int orte\+\_\+rmaps\+\_\+base\+\_\+open (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}\label{orte_2mca_2rmaps_2base_2base_8h_a80806729ef1c137cc3d3a0f5db5b3007}


Open the rmaps framework. 

Open the rmaps framework. default condition that allows oversubscription

force oversubscription permission 

References orte\+\_\+rmaps\+\_\+base\+\_\+t\+::available\+\_\+components, mca\+\_\+base\+\_\+param\+\_\+lookup\+\_\+int(), mca\+\_\+base\+\_\+param\+\_\+reg\+\_\+int\+\_\+name(), mca\+\_\+base\+\_\+param\+\_\+reg\+\_\+string\+\_\+name(), mca\+\_\+base\+\_\+param\+\_\+reg\+\_\+syn\+\_\+name(), O\+B\+J\+\_\+\+C\+O\+N\+S\+T\+R\+U\+C\+T, opal\+\_\+argv\+\_\+count(), opal\+\_\+argv\+\_\+free(), opal\+\_\+argv\+\_\+split(), opal\+\_\+output\+\_\+open(), orte\+\_\+show\+\_\+help(), and orte\+\_\+rmaps\+\_\+base\+\_\+t\+::rmaps\+\_\+output.

