Add CGetTop to the RISC-V instruction reference

Author: arichardson

app-isaquick-riscv.tex

@@ -47,6 +47,8 @@ \chapter{CHERI-RISC-V ISA Quick Reference}
 
 		\rvcheriisaquick{CGetAddr}
 
+		\rvcheriisaquick{CGetTop}
+
 		\dcnote{CGetPCC is a Special}
 
 		\dcnote{CGetPCCSetOffset is AIUPC}

chap-isaref-riscv.tex

@@ -262,6 +262,7 @@ \section{CHERI-RISC-V Instructions}
 \input{insn-riscv/cgetperm}
 \input{insn-riscv/cgetsealed}
 \input{insn-riscv/cgettag}
+\input{insn-riscv/cgettop}
 \input{insn-riscv/cgettype}
 \input{insn-riscv/cincoffset}
 \input{insn-riscv/cincoffsetimm}

def-riscv-insns.tex

@@ -25,10 +25,7 @@
 \rvcherisrcdest[name=CGetOffset]{6}{rd}{cs1}
 \rvcherisrcdest[name=CGetFlags]{7}{rd}{cs1}
 \rvcherisrcdest[name=CGetAddr]{F}{rd}{cs1}
-
-% Mark as noref and reserved until landing of
-% https://github.com/CTSRD-CHERI/sail-cheri-riscv/pull/59
-\rvcherisrcdest[name=CGetTop,noref,tablesuffix=\rvcherireservedfootnotemark]{18}{cd}{cs1}
+\rvcherisrcdest[name=CGetTop]{18}{cd}{cs1}
 
 % Mark as noref and reserved until landing of
 % https://github.com/CTSRD-CHERI/sail-cheri-riscv/pull/55

insn-riscv/cgettop.tex

@@ -0,0 +1,16 @@
+\clearpage
+\phantomsection
+\addcontentsline{toc}{subsection}{CGetTop}
+\insnriscvlabel{cgettop}
+\subsection*{CGetTop}
+
+\subsubsection*{Format}
+
+\rvcheriasm{CGetTop}
+
+\begin{center}
+\rvcheriheader
+\rvcheribitbox{CGetTop}
+\end{center}
+
+\sailRISCVisarefbody{CGetTop}

sail_latex_riscv/commands.tex

@@ -1,5 +1,6 @@
 \providecommand\saildoclabelled[2]{\phantomsection\label{#1}#2}
 \providecommand\saildocval[2]{#1 #2}
+\providecommand\saildocoutcome[2]{#1 #2}
 \providecommand\saildocfcl[2]{#1 #2}
 \providecommand\saildoctype[2]{#1 #2}
 \providecommand\saildocfn[2]{#1 #2}
@@ -5245,6 +5246,19 @@ \subsection*{Notes}
 \end{itemize}
 }{\lstinputlisting[language=sail]{sail_latex_riscv/fclCGetLenzexecute33a689e3a631b9b905b85461d3814943.tex}}}}
 
+\newcommand{\sailRISCVfclCGetTopexecute}{\saildoclabelled{sailRISCVfclCGetTopzexecute}{\saildocfcl{Integer register \emph{rd} is set equal to the \textbf{top} field (\saildocabbrev{i.e.} one past the
+last addressable byte) of capability register \emph{cs1}.
+
+\subsection*{Notes}
+
+
+\begin{itemize}
+\item Due to the compressed representation of capabilities, the actual top
+ of capabilities can be $2^{\hyperref[sailRISCVzxlen]{{xlen}}}$; \hyperref[sailRISCVzCGetTop]{\lstinline{CGetTop}} will return the
+ maximum value of $2^{\hyperref[sailRISCVzxlen]{{xlen}}}-1$ in this case.
+\end{itemize}
+}{\lstinputlisting[language=sail]{sail_latex_riscv/fclCGetTopzexecute33a689e3a631b9b905b85461d3814943.tex}}}}
+
 \newcommand{\sailRISCVfclCGetTagexecute}{\saildoclabelled{sailRISCVfclCGetTagzexecute}{\saildocfcl{The low bit of integer register \emph{rd} is set to the \textbf{tag} field of \emph{cs1}.
 All other bits of \emph{rd} are cleared.
 
@@ -14380,3 +14394,9 @@ \subsection*{Exceptions}
   \ifstrequal{#1}{x7}{\hyperref[sailRISCVregisterzx7]{#2}}{}%
   \ifstrequal{#1}{x8}{\hyperref[sailRISCVregisterzx8]{#2}}{}%
   \ifstrequal{#1}{x9}{\hyperref[sailRISCVregisterzx9]{#2}}{}}
+
+\newcommand{\sailRISCVoutcome}[1]{
+  }
+
+\newcommand{\sailRISCVrefoutcome}[2]{
+  }

sail_latex_riscv/fclCGetTopzexecute33a689e3a631b9b905b85461d3814943.tex

@@ -0,0 +1,4 @@
+let capVal = #\hyperref[sailRISCVzC]{C}#(cs1);
+let top = #\hyperref[sailRISCVzgetCapTop]{getCapTop}#(capVal);
+#\hyperref[sailRISCVzX]{X}#(rd) = #\hyperref[sailRISCVztozybits]{to\_bits}#(sizeof(xlen), if top > cap_max_addr then cap_max_addr else top);
+RETIRE_SUCCESS