# HG changeset patch # User Windel Bouwman # Date 1378136421 -7200 # Node ID 6b3a874edd6ec59630f53c4bd6e1dda93238f6b6 # Parent e64bae57cda889b4b4294e07f04b8feb4a8f7e66 Added some docs diff -r e64bae57cda8 -r 6b3a874edd6e .hgignore --- a/.hgignore Sat Aug 31 17:58:54 2013 +0200 +++ b/.hgignore Mon Sep 02 17:40:21 2013 +0200 @@ -8,4 +8,5 @@ cos/bootdisk.img cos/lcfosinitrd.img cos/kernel/kernel.map +python/doc/_build diff -r e64bae57cda8 -r 6b3a874edd6e README.md --- a/README.md Sat Aug 31 17:58:54 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,31 +0,0 @@ - -# Project goals -* To write a microkernel OS. -* Write the kernel in C3 ('cos') -* Write a kernel in oberon like language and be able to compile this with the ide. -* Create python scripts that form the major part of the OS. -* Make IDE in python that can compile the OS. - -# Directory structure - -'os' contains the os written in oberon like language. -'ide' contains the python3 qt4 ide to build the os. -'cos' contains the os written in C and assembler. - -# Software dependencies - * python3 - * pyqt4 - -# How to start the IDE - - cd python - python ide.py - -# Run unittests - - cd python - python -m unittest - -[![Build Status](https://drone.io/bitbucket.org/windel/lcfos/status.png)](https://drone.io/bitbucket.org/windel/lcfos/latest) - - diff -r e64bae57cda8 -r 6b3a874edd6e python/doc/Makefile --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/python/doc/Makefile Mon Sep 02 17:40:21 2013 +0200 @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/lcfos.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/lcfos.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/lcfos" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/lcfos" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff -r e64bae57cda8 -r 6b3a874edd6e python/doc/compiler.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/python/doc/compiler.rst Mon Sep 02 17:40:21 2013 +0200 @@ -0,0 +1,91 @@ + + +Compiler +======== + +This chapter describes the design of the compiler. + + +Overview +-------- + +The compiler consists a frontend, mid-end and back-end. The frontend deals with +source file parsing and semantics checking. The mid-end performs optimizations. +This is optional. The back-end generates machine code. The front-end produces +intermediate code. This is a simple representation of the source. The back-end +can accept this kind of representation. This way the compiler is portable and +a front end can be constructed without having to do the rest. + +.. graphviz:: + + + digraph x { + rankdir="LR" + 1 [label="c3 source file"] + 10 [label="c3 front end" ] + 11 [label="language X front end" ] + 20 [label="mid end" ] + 30 [label="back end for X86" ] + 31 [label="back end for ARM" ] + 40 [label="object file"] + 1 -> 10 + 10 -> 20 [label="IR-code"] + 11 -> 20 [label="IR-code"] + 20 -> 30 [label="IR-code"] + 20 -> 31 [label="IR-code"] + 30 -> 40 + } + +IR-code +------- +The IR-code is implemented in the ir package. + +.. autoclass:: ir.Module + :members: + +.. autoclass:: ir.Function + :members: + +.. autoclass:: ir.Block + :members: + +.. autoclass:: ir.Statement + :members: + +.. autoclass:: ir.Expression + :members: + +.. # .. inheritance-diagram:: ir.Statement + +Front-end +--------- + +For the front-end a recursive descent parser is created for the c3 language. +This is a subset of the C language with some additional features. + +.. automodule:: c3 + :members: + :undoc-members: + +.. autoclass:: c3.Parser + :members: + +.. autoclass:: c3.Builder + :members: + +.. autoclass:: c3.CodeGenerator + :members: + +Back-end +-------- + +The back-end is more complicated. There are several steps to be taken here. + +1. Instruction selection +2. register allocation +3. Peep hole optimization? +4. real code generation + +.. automodule:: codegenarm + :members: + diff -r e64bae57cda8 -r 6b3a874edd6e python/doc/conf.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/python/doc/conf.py Mon Sep 02 17:40:21 2013 +0200 @@ -0,0 +1,244 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# lcfos documentation build configuration file, created by +# sphinx-quickstart on Sat Aug 31 18:04:20 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('..')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.graphviz', 'sphinx.ext.autodoc'] +# 'sphinx.ext.inheritance_diagram'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'lcfos' +copyright = '2013, Windel Bouwman' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'lcfosdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'lcfos.tex', 'lcfos Documentation', + 'Windel Bouwman', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'lcfos', 'lcfos Documentation', + ['Windel Bouwman'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'lcfos', 'lcfos Documentation', + 'Windel Bouwman', 'lcfos', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' diff -r e64bae57cda8 -r 6b3a874edd6e python/doc/design.rst --- a/python/doc/design.rst Sat Aug 31 17:58:54 2013 +0200 +++ b/python/doc/design.rst Mon Sep 02 17:40:21 2013 +0200 @@ -1,5 +1,11 @@ +Design +====== -= processes / threads = +OS +-- + +Processes / threads +~~~~~~~~~~~~~~~~~~~ Processes are completely seperated and fully pre-emptive. This means a process can be unscheduled at any moment. @@ -11,38 +17,40 @@ If some heavy duty task must be performed, either way spawn a new process, or yield frequently from this hard labour. -= tasks = +tasks +~~~~~ -Consider the following:: +Consider the following: + +.. code:: --- -function int insanemath(int a) -{ - while (a > 0) + function int insanemath(int a) { - a = a -1; - resume agent1; + while (a > 0) + { + a = a -1; + resume agent1; + } + return a - 1; } - return a - 1; -} -task agent1() -{ - start agent2; -} + task agent1() + { + start agent2; + } -task agent2() -{ - insanemath(55); - insanemath(44); -} + task agent2() + { + insanemath(55); + insanemath(44); + } -task main() -{ - start agent1; - join agent1; -} --- + task main() + { + start agent1; + join agent1; + } + Say to tasks are running in concurrent / parallel. @@ -64,30 +72,32 @@ Assembly code for the functions above: -.code -insanemath: -L1: -load r0, sp - 4 -cmp r0, 0 -jl L2 -dec r0 -store r0, sp - 4 -jmp L1 -L2: -ret +.. code:: + + .code + insanemath: + L1: + load r0, sp - 4 + cmp r0, 0 + jl L2 + dec r0 + store r0, sp - 4 + jmp L1 + L2: + ret -agent1: -hlt? + agent1: + hlt? -agent2: -hlt? + agent2: + hlt? -main: -jmp agent1 + main: + jmp agent1 -.data -agent1_task: -dd 0 -agent2_task: -dd 0 + .data + agent1_task: + dd 0 + agent2_task: + dd 0 diff -r e64bae57cda8 -r 6b3a874edd6e python/doc/index.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/python/doc/index.rst Mon Sep 02 17:40:21 2013 +0200 @@ -0,0 +1,26 @@ +.. lcfos documentation master file, created by + sphinx-quickstart on Sat Aug 31 18:04:20 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to lcfos's documentation! +================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + + readme_link + design + compiler + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff -r e64bae57cda8 -r 6b3a874edd6e python/doc/readme_link.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/python/doc/readme_link.rst Mon Sep 02 17:40:21 2013 +0200 @@ -0,0 +1,4 @@ + + + +.. include:: ../../readme.rst diff -r e64bae57cda8 -r 6b3a874edd6e readme.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/readme.rst Mon Sep 02 17:40:21 2013 +0200 @@ -0,0 +1,40 @@ + +About +===== + +Project goals +------------- + +* To write a microkernel OS. +* Write the kernel in C3 ('cos') +* Write a kernel in oberon like language and be able to compile this with the ide. +* Create python scripts that form the major part of the OS. +* Make IDE in python that can compile the OS. + +Directory structure +------------------- + +'os' contains the os written in oberon like language. +'ide' contains the python3 qt4 ide to build the os. +'cos' contains the os written in C and assembler. + +Software dependencies +--------------------- + * python3 + * pyqt4 + +How to start the IDE +-------------------- + + cd python + python ide.py + +Run unittests +------------- + + cd python + python -m unittest + +.. image:: https://drone.io/bitbucket.org/windel/lcfos/status.png + +