Mercurial > archived > louis > epitech > mq > rathaxes
changeset 141:85c2fa6f6bd8
Wrap-up wip
| author | Louis Opter <kalessin@kalessin.fr> |
|---|---|
| date | Sat, 08 Feb 2014 18:28:44 -0800 |
| parents | a291b41efb69 |
| children | cbff597d307e |
| files | doc_recap_some_important_thoughts_about_the_current_compiler.patch series |
| diffstat | 2 files changed, 146 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc_recap_some_important_thoughts_about_the_current_compiler.patch Sat Feb 08 18:28:44 2014 -0800 @@ -0,0 +1,145 @@ +# HG changeset patch +# Parent 01873f017f54a0c625261b8a1f27052219a00141 +Recap important notes about the current compiler in a small document + +This should be used as a work document for the next compiler version. + +diff --git a/doc/rathaxes/technical/CMakeLists.txt b/doc/rathaxes/technical/CMakeLists.txt +--- a/doc/rathaxes/technical/CMakeLists.txt ++++ b/doc/rathaxes/technical/CMakeLists.txt +@@ -15,3 +15,5 @@ + INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/technical_documentation_en.pdf + DESTINATION share/doc/rathaxes/) + ENDFOREACH(I ${DOCS}) ++ ++ADD_LATEX_DOCUMENT(rtx_2k12_wrap_up.tex DEFAULT_PDF MANGLE_TARGET_NAMES) +diff --git a/doc/rathaxes/technical/rtx_2k12_wrap_up.tex b/doc/rathaxes/technical/rtx_2k12_wrap_up.tex +new file mode 100644 +--- /dev/null ++++ b/doc/rathaxes/technical/rtx_2k12_wrap_up.tex +@@ -0,0 +1,113 @@ ++\documentclass[american]{rtxarticle} ++ ++\title{Rathaxes 2012 wrap-up} ++ ++\author{Louis Opter} ++ ++\begin{document} ++ ++\maketitle ++ ++\begin{abstract} ++The second version of the Rathaxes compiler, \emph{Rathaxes 2012}, started in ++2010 has been sunset in 2013. This document aims to highlight the issues and ++the lessons learned while trying to recode an e1000 driver with this compiler ++version. ++ ++This document should serve as a reference for the next version of the Rathaxes ++compiler implemented in Python 3 with Pyrser. ++\end{abstract} ++ ++\section{Design issues} ++ ++\subsection{Unused features} ++ ++The following compiler features: ++ ++\begin{itemize} ++\item Advanced chunk selection (using the \texttt{with} statement); ++\item Register declarations. ++\end{itemize} ++ ++Turned out to unecessary because: ++ ++\begin{itemize} ++\item We decided to scope the first driver to a single kernel (Linux 2.6.32 and ++ then 3.2.0); ++\item Register declarations were not clearly wired to the rest of the language ++ and were simply too advanced to be used at first; ++\item Challenges appeared at other places. ++\end{itemize} ++ ++It's also interesting to note that sequences weren't used to define algorithms ++as planned but were re-fitted as ``functions'' as we started to write object ++oriented code around Rathaxes types. Some sequences are also used to logically ++regroup chunks and pointcut but those chunks could be moved to types or could ++directly be top-level declarations within their interface. ++ ++\subsection{Features we missed} ++ ++The following compiler features: ++ ++\begin{itemize} ++\item ``Object model''; ++\item Ref/Scalar; ++\item Error handling; ++\item Variadic sequences; ++\item Arrays support; ++\item Comments passthrough; ++\item Type coercion to \texttt{Builtin::symbol}. ++\end{itemize} ++ ++Are really needed. ++ ++\subsubsection{``Object model''} ++ ++The driver code started to organically organize itself into types with methods ++and attributes that loosely correspond to classes. We ran different into ++issues: ++ ++\begin{itemize} ++\item Methods call aren't working; ++\item Type dependencies aren't resolved correctly, so they aren't generated in ++ the right order; ++\item \texttt{\$\{self\}} is ambiguous, how do you know when it's a scalar or a ++ method? (this is important to define the init method); ++\item Abstract data types should probably be framed/defined in the language; ++\item Mappings aren't resolved recursively; ++\item Mappings can't use Rathaxes code in them (e.g: you can't use ++ \texttt{\$\{Rathaxes::Type.ref\}} in a mapping definition); ++\item Circular dependencies aren't supported (in e1000 the rings and the ++ hardware context are inter-dependant, you can't avoid that); ++\item Type injections in upper sub-system (i.e: inject \texttt{e1000::Context} ++ into \texttt{Ethernet::Device}), that has been implemented with regular ++ pointcut but we need another kind of pointcut to only weave the type (and ++ not the full structure field). ++\end{itemize} ++ ++\subsubsection{Error handling} ++ ++This has been deliberately left out in Rathaxes 2012 but it seems that the ++biggest difficulty is going to define and then inject the error handling code ++into the parent chunk/context appropriately. ++ ++\section{Implementation issues} ++ ++Some bugs are imparing development: ++ ++\begin{itemize} ++\item Expansion bugs: ++\begin{itemize} ++\item Obscure expansion issues solved by scoping thigns; ++\item Variable declarations leaking across different chunks; ++\item Chunk/Pointcut parameters not bound to the C variables (the parameters ++ must be named like the C variables are). ++\end{itemize} ++\item CNorm issues: it's impossible to use annotation (e.g: \texttt{\_\_init}, ++ \texttt{\_\_exit}, \texttt{\_\_iomem}, \ldots) or arbitrary typedef'd ++ types; ++\item Some sequences call aren't working for obscure reasons (e.g: ++ \texttt{DMA::unmap}). ++\end{itemize} ++ ++\end{document} +diff --git a/rathaxes/samples/e1000/e1000.blt b/rathaxes/samples/e1000/e1000.blt +--- a/rathaxes/samples/e1000/e1000.blt ++++ b/rathaxes/samples/e1000/e1000.blt +@@ -809,7 +809,7 @@ + + chunk LKM::code() + { +- static int rtx_e1000_tx_ring_alloc_resources(${e1000::TxRing.ref} self) ++ static int rtx_e1000_tx_ring_alloc_resources(${e1000:::TxRing.ref} self) + { + ${Log::info("e1000_tx_ring_alloc_resources: TBD...")}; + return 0;