Fixed up ivy annotations on the new structure supporting page_coloring.
authorKevin Klues <klueska@eecs.berkeley.edu>
Mon, 24 Aug 2009 01:57:14 +0000 (18:57 -0700)
committerZach Anderson <zra@zra-intrepid.(none)>
Mon, 24 Aug 2009 19:23:22 +0000 (12:23 -0700)
Additionally, this commit contains code that fixes up makefile dependencies
on header files and makes each source file also depend on changes made to
the Makefrag used to generate it.

Finally, a new facility for generating documentation using doxygen has
been added:
  make docs

You need to have both doxygen and graphviz (dot) installed in order to
generate the documentation properly using this command.

31 files changed:
.gitignore
GNUmakefile
doc/img/nanwan.png [new file with mode: 0644]
doc/rosdoc.cfg [new file with mode: 0644]
doc/rosdoc.main [new file with mode: 0644]
kern/arch/i386/boot/Makefrag
kern/arch/i386/page_alloc.c
kern/arch/sparc/boot/Makefrag
kern/include/colored_caches.h
kern/include/kmalloc.h
kern/include/ros/ring_buffer.h
kern/include/ros/sysevent.h
kern/ivy/Makefrag
kern/src/Makefrag
kern/src/colored_caches.c
kern/src/kmalloc.c
kern/src/manager.c
kern/src/page_alloc.c
kern/src/pmap.c
scripts/mergedep.pl
user/apps/Makefrag
user/apps/parlib/Makefrag
user/apps/roslib/Makefrag
user/parlib/Makefrag
user/parlib/src/Makefrag
user/parlib/src/i386/Makefrag [new file with mode: 0644]
user/parlib/src/sparc/Makefrag [new file with mode: 0644]
user/roslib/Makefrag
user/roslib/src/Makefrag
user/roslib/src/i386/Makefrag [new file with mode: 0644]
user/roslib/src/sparc/Makefrag [new file with mode: 0644]

index 8e29928..a745c80 100644 (file)
@@ -3,6 +3,7 @@
 bochs.out
 bochs.log
 .bochsrc
+bochsrc
 mnt
 obj
 run_bochs.sh
@@ -10,9 +11,11 @@ update*
 cscope.out
 hdd.img
 *.*~
+ivy_errordb.sql
 Makelocal
 ros-project.tmproj
 kern/boot
 kern/include/arch
 kern/src/arch
+doc/rosdoc
 
index 4488c0d..c1a7291 100644 (file)
@@ -111,6 +111,17 @@ $(OBJDIR)/.deps: $(foreach dir, $(OBJDIRS), $(wildcard $(OBJDIR)/$(dir)/*.d))
 # to be rerun
 -include $(OBJDIR)/.deps
 
+# Use doxygen to make documentation for ROS
+docs: all
+       @doxygen doc/rosdoc.cfg
+       @if [ ! -d doc/rosdoc/html/img ];          \
+        then                                      \
+               ln -s ../../img doc/rosdoc/html;       \
+        fi
+
+doxyclean:
+       rm -rf doc/rosdoc
+
 # For deleting the build
 clean:
        @rm -rf $(OBJDIR)
@@ -121,5 +132,5 @@ clean:
 always:
        @:
 
-.PHONY: all always clean
+.PHONY: all always docs clean
 
diff --git a/doc/img/nanwan.png b/doc/img/nanwan.png
new file mode 100644 (file)
index 0000000..ad47bce
Binary files /dev/null and b/doc/img/nanwan.png differ
diff --git a/doc/rosdoc.cfg b/doc/rosdoc.cfg
new file mode 100644 (file)
index 0000000..02ace14
--- /dev/null
@@ -0,0 +1,1462 @@
+# Doxyfile 1.5.7
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+#       TAG = value [value, ...]
+# For lists items can also be appended using:
+#       TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file 
+# that follow. The default is UTF-8 which is also the encoding used for all 
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the 
+# iconv built into libc) for the transcoding. See 
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING      = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
+# by quotes) that should identify the project.
+
+PROJECT_NAME           = ROS
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
+# This could be handy for archiving the generated documentation or 
+# if some version control system is used.
+
+PROJECT_NUMBER         = 0.1
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
+# base path where the generated documentation will be put. 
+# If a relative path is entered, it will be relative to the location 
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY       = doc/rosdoc/
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
+# 4096 sub-directories (in 2 levels) under the output directory of each output 
+# format and will distribute the generated files over these directories. 
+# Enabling this option can be useful when feeding doxygen a huge amount of 
+# source files, where putting all generated files in the same directory would 
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS         = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
+# documentation generated by doxygen is written. Doxygen will use this 
+# information to generate all constant output in the proper language. 
+# The default language is English, other supported languages are: 
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 
+# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, 
+# Spanish, Swedish, and Ukrainian.
+
+OUTPUT_LANGUAGE        = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
+# include brief member descriptions after the members that are listed in 
+# the file and class documentation (similar to JavaDoc). 
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC      = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
+# the brief description of a member or function before the detailed description. 
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF           = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator 
+# that is used to form the text in various listings. Each string 
+# in this list, if found as the leading text of the brief description, will be 
+# stripped from the text and the result after processing the whole list, is 
+# used as the annotated text. Otherwise, the brief description is used as-is. 
+# If left blank, the following values are used ("$name" is automatically 
+# replaced with the name of the entity): "The $name class" "The $name widget" 
+# "The $name file" "is" "provides" "specifies" "contains" 
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF       = 
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
+# Doxygen will generate a detailed section even if there is only a brief 
+# description.
+
+ALWAYS_DETAILED_SEC    = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
+# inherited members of a class in the documentation of that class as if those 
+# members were ordinary class members. Constructors, destructors and assignment 
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB  = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
+# path before files name in the file list and in the header files. If set 
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES        = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
+# can be used to strip a user-defined part of the path. Stripping is 
+# only done if one of the specified strings matches the left-hand part of 
+# the path. The tag can be used to show relative paths in the file list. 
+# If left blank the directory from which doxygen is run is used as the 
+# path to strip.
+
+STRIP_FROM_PATH        = 
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
+# the path mentioned in the documentation of a class, which tells 
+# the reader which header file to include in order to use a class. 
+# If left blank only the name of the header file containing the class 
+# definition is used. Otherwise one should specify the include paths that 
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH    = 
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
+# (but less readable) file names. This can be useful is your file systems 
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES            = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
+# will interpret the first line (until the first dot) of a JavaDoc-style 
+# comment as the brief description. If set to NO, the JavaDoc 
+# comments will behave just like regular Qt-style comments 
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF      = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
+# interpret the first line (until the first dot) of a Qt-style 
+# comment as the brief description. If set to NO, the comments 
+# will behave just like regular Qt-style comments (thus requiring 
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF           = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
+# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
+# comments) as a brief description. This used to be the default behaviour. 
+# The new default is to treat a multi-line C++ comment block as a detailed 
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
+# member inherits the documentation from any documented member that it 
+# re-implements.
+
+INHERIT_DOCS           = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
+# a new page for each member. If set to NO, the documentation of a member will 
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES  = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE               = 8
+
+# This tag can be used to specify a number of aliases that acts 
+# as commands in the documentation. An alias has the form "name=value". 
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
+# put the command \sideeffect (or @sideeffect) in the documentation, which 
+# will result in a user-defined paragraph with heading "Side Effects:". 
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES                = 
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
+# sources only. Doxygen will then generate output that is more tailored for C. 
+# For instance, some of the names that are used will be different. The list 
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C  = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
+# sources only. Doxygen will then generate output that is more tailored for 
+# Java. For instance, namespaces will be presented as packages, qualified 
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA   = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
+# sources only. Doxygen will then generate output that is more tailored for 
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN   = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
+# sources. Doxygen will then generate output that is tailored for 
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL   = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
+# to include (a tag file for) the STL sources as input, then you should 
+# set this tag to YES in order to let doxygen match functions declarations and 
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
+# func(std::string) {}). This also make the inheritance and collaboration 
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT    = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT        = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
+# Doxygen will parse them like normal C++ but will assume all classes use public 
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT            = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter 
+# and setter methods for a property. Setting this option to YES (the default) 
+# will make doxygen to replace the get and set methods by a property in the 
+# documentation. This will only work if the methods are indeed getting or 
+# setting a simple type. If this is not the case, or you want to show the 
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT   = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
+# tag is set to YES, then doxygen will reuse the documentation of the first 
+# member in the group (if any) for the other members of the group. By default 
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC   = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
+# the same type (for instance a group of public functions) to be put as a 
+# subgroup of that type (e.g. under the Public Functions section). Set it to 
+# NO to prevent subgrouping. Alternatively, this can be done per class using 
+# the \nosubgrouping command.
+
+SUBGROUPING            = YES
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
+# is documented as struct, union, or enum with the name of the typedef. So 
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
+# with name TypeT. When disabled the typedef will appear as a member of a file, 
+# namespace, or class. And the struct will be named TypeS. This can typically 
+# be useful for C code in case the coding convention dictates that all compound 
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT   = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is 
+# probably good enough. For larger projects a too small cache size can cause 
+# doxygen to be busy swapping symbols to and from disk most of the time 
+# causing a significant performance penality. 
+# If the system has enough physical memory increasing the cache will improve the 
+# performance by keeping more symbols in memory. Note that the value works on 
+# a logarithmic scale so increasing the size by one will rougly double the 
+# memory usage. The cache size is given by this formula: 
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
+# corresponding to a cache size of 2^16 = 65536 symbols
+
+SYMBOL_CACHE_SIZE      = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
+# documentation are documented, even if no documentation was available. 
+# Private class members and static file members will be hidden unless 
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL            = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
+# will be included in the documentation.
+
+EXTRACT_PRIVATE        = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file 
+# will be included in the documentation.
+
+EXTRACT_STATIC         = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
+# defined locally in source files will be included in the documentation. 
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES  = YES
+
+# This flag is only useful for Objective-C code. When set to YES local 
+# methods, which are defined in the implementation section but not in 
+# the interface are included in the documentation. 
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS  = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be 
+# extracted and appear in the documentation as a namespace called 
+# 'anonymous_namespace{file}', where file will be replaced with the base 
+# name of the file that contains the anonymous namespace. By default 
+# anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES   = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
+# undocumented members of documented classes, files or namespaces. 
+# If set to NO (the default) these members will be included in the 
+# various overviews, but no documentation section is generated. 
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS     = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
+# undocumented classes that are normally visible in the class hierarchy. 
+# If set to NO (the default) these classes will be included in the various 
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES     = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
+# friend (class|struct|union) declarations. 
+# If set to NO (the default) these declarations will be included in the 
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS  = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
+# documentation blocks found inside the body of a function. 
+# If set to NO (the default) these blocks will be appended to the 
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS      = NO
+
+# The INTERNAL_DOCS tag determines if documentation 
+# that is typed after a \internal command is included. If the tag is set 
+# to NO (the default) then the documentation will be excluded. 
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS          = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
+# file names in lower-case letters. If set to YES upper-case letters are also 
+# allowed. This is useful if you have classes or files whose names only differ 
+# in case and if your file system supports case sensitive file names. Windows 
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES       = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
+# will show members with their full class and namespace scopes in the 
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES       = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
+# will put a list of the files that are included by a file in the documentation 
+# of that file.
+
+SHOW_INCLUDE_FILES     = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
+# is inserted in the documentation for inline members.
+
+INLINE_INFO            = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
+# will sort the (detailed) documentation of file and class members 
+# alphabetically by member name. If set to NO the members will appear in 
+# declaration order.
+
+SORT_MEMBER_DOCS       = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
+# brief documentation of file, namespace and class members alphabetically 
+# by member name. If set to NO (the default) the members will appear in 
+# declaration order.
+
+SORT_BRIEF_DOCS        = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
+# hierarchy of group names into alphabetical order. If set to NO (the default) 
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES       = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
+# sorted by fully-qualified names, including namespaces. If set to 
+# NO (the default), the class list will be sorted only by class name, 
+# not including the namespace part. 
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the 
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME     = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or 
+# disable (NO) the todo list. This list is created by putting \todo 
+# commands in the documentation.
+
+GENERATE_TODOLIST      = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or 
+# disable (NO) the test list. This list is created by putting \test 
+# commands in the documentation.
+
+GENERATE_TESTLIST      = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or 
+# disable (NO) the bug list. This list is created by putting \bug 
+# commands in the documentation.
+
+GENERATE_BUGLIST       = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
+# disable (NO) the deprecated list. This list is created by putting 
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional 
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS       = 
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
+# the initial value of a variable or define consists of for it to appear in 
+# the documentation. If the initializer consists of more lines than specified 
+# here it will be hidden. Use a value of 0 to hide initializers completely. 
+# The appearance of the initializer of individual variables and defines in the 
+# documentation can be controlled using \showinitializer or \hideinitializer 
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES  = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
+# at the bottom of the documentation of classes and structs. If set to YES the 
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES        = YES
+
+# If the sources in your project are distributed over multiple directories 
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES       = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the 
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES             = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
+# Namespaces page.  This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES        = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
+# doxygen should invoke to get the current version for each file (typically from 
+# the version control system). Doxygen will invoke the program by executing (via 
+# popen()) the command <command> <input-file>, where <command> is the value of 
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
+# provided by doxygen. Whatever the program writes to standard output 
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER    = 
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 
+# doxygen. The layout file controls the global structure of the generated output files 
+# in an output format independent way. The create the layout file that represents 
+# doxygen's defaults, run doxygen with the -l option. You can optionally specify a 
+# file name after the option, if omitted DoxygenLayout.xml will be used as the name 
+# of the layout file.
+
+LAYOUT_FILE            = 
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated 
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET                  = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are 
+# generated by doxygen. Possible values are YES and NO. If left blank 
+# NO is used.
+
+WARNINGS               = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED   = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
+# potential errors in the documentation, such as not documenting some 
+# parameters in a documented function, or documenting parameters that 
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR      = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for 
+# functions that are documented, but have no documentation for their parameters 
+# or return value. If set to NO (the default) doxygen will only warn about 
+# wrong or incomplete parameter documentation, but not about the absence of 
+# documentation.
+
+WARN_NO_PARAMDOC       = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that 
+# doxygen can produce. The string should contain the $file, $line, and $text 
+# tags, which will be replaced by the file and line number from which the 
+# warning originated and the warning text. Optionally the format may contain 
+# $version, which will be replaced by the version of the file (if it could 
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT            = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning 
+# and error messages should be written. If left blank the output is written 
+# to stderr.
+
+WARN_LOGFILE           = 
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain 
+# documented source files. You may enter file names like "myfile.cpp" or 
+# directories like "/usr/src/myproject". Separate the files or directories 
+# with spaces.
+
+INPUT                  = . doc/rosdoc.main
+
+# This tag can be used to specify the character encoding of the source files 
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
+# also the default input encoding. Doxygen uses libiconv (or the iconv built 
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
+# the list of possible encodings.
+
+INPUT_ENCODING         = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the 
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
+# and *.h) to filter out the source-files in the directories. If left 
+# blank the following patterns are tested: 
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+
+FILE_PATTERNS          = *.h *.c
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
+# should be searched for input files as well. Possible values are YES and NO. 
+# If left blank NO is used.
+
+RECURSIVE              = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should 
+# excluded from the INPUT source files. This way you can easily exclude a 
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE                = 
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
+# directories that are symbolic links (a Unix filesystem feature) are excluded 
+# from the input.
+
+EXCLUDE_SYMLINKS       = NO
+
+# If the value of the INPUT tag contains directories, you can use the 
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
+# certain files from those directories. Note that the wildcards are matched 
+# against the file with absolute path, so to exclude all test directories 
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS       = */obj/* */newlib/* */gccinclude/* */.git/*
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
+# (namespaces, classes, functions, etc.) that should be excluded from the 
+# output. The symbol name can be a fully qualified name, a word, or if the 
+# wildcard * is used, a substring. Examples: ANamespace, AClass, 
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS        = 
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or 
+# directories that contain example code fragments that are included (see 
+# the \include command).
+
+EXAMPLE_PATH           = 
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
+# and *.h) to filter out the source-files in the directories. If left 
+# blank all files are included.
+
+EXAMPLE_PATTERNS       = 
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
+# searched for input files to be used with the \include or \dontinclude 
+# commands irrespective of the value of the RECURSIVE tag. 
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE      = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or 
+# directories that contain image that are included in the documentation (see 
+# the \image command).
+
+IMAGE_PATH             = 
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should 
+# invoke to filter for each input file. Doxygen will invoke the filter program 
+# by executing (via popen()) the command <filter> <input-file>, where <filter> 
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
+# input file. Doxygen will then use the output that the filter program writes 
+# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
+# ignored.
+
+INPUT_FILTER           = 
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
+# basis.  Doxygen will compare the file name with each pattern and apply the 
+# filter if there is a match.  The filters are a list of the form: 
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
+# is applied to all files.
+
+FILTER_PATTERNS        = 
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
+# INPUT_FILTER) will be used to filter the input files when producing source 
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES    = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
+# be generated. Documented entities will be cross-referenced with these sources. 
+# Note: To get rid of all source code in the generated output, make sure also 
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER         = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body 
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES         = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
+# doxygen to hide any special comment blocks from generated source code 
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS    = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES 
+# then for each documented function all documented 
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES 
+# then for each documented function all documented entities 
+# called/used by that function will be listed.
+
+REFERENCES_RELATION    = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code.  Otherwise they will link to the documentstion.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code 
+# will point to the HTML generated by the htags(1) tool instead of doxygen 
+# built-in source browser. The htags tool is part of GNU's global source 
+# tagging system (see http://www.gnu.org/software/global/global.html). You 
+# will need version 4.8.6 or higher.
+
+USE_HTAGS              = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
+# will generate a verbatim copy of the header file for each class for 
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS       = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX    = 5
+
+# In case all classes in a project start with a common prefix, all 
+# classes will be put under the same header in the alphabetical index. 
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX          = 
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
+# generate HTML output.
+
+GENERATE_HTML          = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT            = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION    = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for 
+# each generated HTML page. If it is left blank doxygen will generate a 
+# standard header.
+
+HTML_HEADER            = 
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
+# each generated HTML page. If it is left blank doxygen will generate a 
+# standard footer.
+
+HTML_FOOTER            = 
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
+# style sheet that is used by each HTML page. It can be used to 
+# fine-tune the look of the HTML output. If the tag is left blank doxygen 
+# will generate a default style sheet. Note that doxygen will try to copy 
+# the style sheet file to the HTML output directory, so don't put your own 
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET        = 
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
+# files or namespaces will be aligned in HTML using tables. If set to 
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS     = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
+# documentation will contain sections that can be hidden and shown after the 
+# page has loaded. For this to work a browser that supports 
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS  = NO
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files 
+# will be generated that can be used as input for Apple's Xcode 3 
+# integrated development environment, introduced with OSX 10.5 (Leopard). 
+# To create a documentation set, doxygen will generate a Makefile in the 
+# HTML output directory. Running make will produce the docset in that 
+# directory and running "make install" will install the docset in 
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
+# it at startup. 
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
+
+GENERATE_DOCSET        = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
+# feed. A documentation feed provides an umbrella under which multiple 
+# documentation sets from a single provider (such as a company or product suite) 
+# can be grouped.
+
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
+# should uniquely identify the documentation set bundle. This should be a 
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
+# will be generated that can be used as input for tools like the 
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP      = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
+# be used to specify the file name of the resulting .chm file. You 
+# can add a path in front of the file if the result should not be 
+# written to the html output directory.
+
+CHM_FILE               = 
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
+# be used to specify the location (absolute path including file name) of 
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION           = 
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
+# controls if a separate .chi index file is generated (YES) or that 
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI           = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING     = 
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
+# controls whether a binary table of contents is generated (YES) or a 
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC             = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members 
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND             = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
+# are set, an additional index file will be generated that can be used as input for 
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 
+# HTML documentation.
+
+GENERATE_QHP           = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
+# be used to specify the file name of the resulting .qch file. 
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE               = 
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating 
+# Qt Help Project output. For more information please see 
+# <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
+
+QHP_NAMESPACE          = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
+# Qt Help Project output. For more information please see 
+# <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
+
+QHP_VIRTUAL_FOLDER     = doc
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
+# be used to specify the location of Qt's qhelpgenerator. 
+# If non-empty doxygen will try to run qhelpgenerator on the generated 
+# .qhp file .
+
+QHG_LOCATION           = 
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
+# top of each HTML page. The value NO (the default) enables the index and 
+# the value YES disables it.
+
+DISABLE_INDEX          = NO
+
+# This tag can be used to set the number of enum values (range [1..20]) 
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE   = 4
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to FRAME, a side panel will be generated
+# containing a tree-like index structure (just like the one that 
+# is generated for HTML Help). For this to work a browser that supports 
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
+# probably better off using the HTML help feature. Other possible values 
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list;
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
+# disables this behavior completely. For backwards compatibility with previous
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
+# respectively.
+
+GENERATE_TREEVIEW      = NONE
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
+# used to set the initial width (in pixels) of the frame in which the tree 
+# is shown.
+
+TREEVIEW_WIDTH         = 250
+
+# Use this tag to change the font size of Latex formulas included 
+# as images in the HTML documentation. The default is 10. Note that 
+# when you change the font size after a successful doxygen run you need 
+# to manually remove any form_*.png images from the HTML output directory 
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE       = 10
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
+# generate Latex output.
+
+GENERATE_LATEX         = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT           = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
+# invoked. If left blank `latex' will be used as the default command name.
+
+LATEX_CMD_NAME         = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
+# generate index for LaTeX. If left blank `makeindex' will be used as the 
+# default command name.
+
+MAKEINDEX_CMD_NAME     = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
+# LaTeX documents. This may be useful for small projects and may help to 
+# save some trees in general.
+
+COMPACT_LATEX          = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used 
+# by the printer. Possible values are: a4, a4wide, letter, legal and 
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE             = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES         = 
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
+# the generated latex document. The header should contain everything until 
+# the first chapter. If it is left blank doxygen will generate a 
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER           = 
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
+# contain links (just like the HTML output) instead of page references 
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS         = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
+# plain latex in the generated Makefile. Set this option to YES to get a 
+# higher quality PDF documentation.
+
+USE_PDFLATEX           = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
+# command to the generated LaTeX files. This will instruct LaTeX to keep 
+# running if errors occur, instead of asking the user for help. 
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE        = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
+# include the index chapters (such as File Index, Compound Index, etc.) 
+# in the output.
+
+LATEX_HIDE_INDICES     = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
+# The RTF output is optimized for Word 97 and may not look very pretty with 
+# other RTF readers or editors.
+
+GENERATE_RTF           = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT             = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
+# RTF documents. This may be useful for small projects and may help to 
+# save some trees in general.
+
+COMPACT_RTF            = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
+# will contain hyperlink fields. The RTF file will 
+# contain links (just like the HTML output) instead of page references. 
+# This makes the output suitable for online browsing using WORD or other 
+# programs which support those fields. 
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS         = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's 
+# config file, i.e. a series of assignments. You only have to provide 
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE    = 
+
+# Set optional variables used in the generation of an rtf document. 
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE    = 
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
+# generate man pages
+
+GENERATE_MAN           = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT             = man
+
+# The MAN_EXTENSION tag determines the extension that is added to 
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION          = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
+# then it will generate one additional man file for each entity 
+# documented in the real man page(s). These additional files 
+# only source the real man page, but without them the man command 
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS              = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will 
+# generate an XML file that captures the structure of 
+# the code including all documentation.
+
+GENERATE_XML           = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT             = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema, 
+# which can be used by a validating XML parser to check the 
+# syntax of the XML files.
+
+XML_SCHEMA             = 
+
+# The XML_DTD tag can be used to specify an XML DTD, 
+# which can be used by a validating XML parser to check the 
+# syntax of the XML files.
+
+XML_DTD                = 
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
+# dump the program listings (including syntax highlighting 
+# and cross-referencing information) to the XML output. Note that 
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING     = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
+# generate an AutoGen Definitions (see autogen.sf.net) file 
+# that captures the structure of the code including all 
+# documentation. Note that this feature is still experimental 
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF   = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
+# generate a Perl module file that captures the structure of 
+# the code including all documentation. Note that this 
+# feature is still experimental and incomplete at the 
+# moment.
+
+GENERATE_PERLMOD       = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX          = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
+# nicely formatted so it can be parsed by a human reader.  This is useful 
+# if you want to understand what is going on.  On the other hand, if this 
+# tag is set to NO the size of the Perl module output will be much smaller 
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY         = YES
+
+# The names of the make variables in the generated doxyrules.make file 
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
+# This is useful so different doxyrules.make files included by the same 
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX = 
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor   
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
+# evaluate all C-preprocessor directives found in the sources and include 
+# files.
+
+ENABLE_PREPROCESSING   = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
+# names in the source code. If set to NO (the default) only conditional 
+# compilation will be performed. Macro expansion can be done in a controlled 
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION        = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
+# then the macro expansion is limited to the macros specified with the 
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF     = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES        = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that 
+# contain include files that are not input files but should be processed by 
+# the preprocessor.
+
+INCLUDE_PATH           = 
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
+# patterns (like *.h and *.hpp) to filter out the header-files in the 
+# directories. If left blank, the patterns specified with FILE_PATTERNS will 
+# be used.
+
+INCLUDE_FILE_PATTERNS  = 
+
+# The PREDEFINED tag can be used to specify one or more macro names that 
+# are defined before the preprocessor is started (similar to the -D option of 
+# gcc). The argument of the tag is a list of macros of the form: name 
+# or name=definition (no spaces). If the definition and the = are 
+# omitted =1 is assumed. To prevent a macro definition from being 
+# undefined via #undef or recursively expanded use the := operator 
+# instead of the = operator.
+
+PREDEFINED             = 
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
+# this tag can be used to specify a list of macro names that should be expanded. 
+# The macro definition that is found in the sources will be used. 
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED      = 
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
+# doxygen's preprocessor will remove all function-like macros that are alone 
+# on a line, have an all uppercase name, and do not end with a semicolon. Such 
+# function macros are typically used for boiler-plate code, and will confuse 
+# the parser if not removed.
+
+SKIP_FUNCTION_MACROS   = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references   
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles. 
+# Optionally an initial location of the external documentation 
+# can be added for each tagfile. The format of a tag file without 
+# this location is as follows: 
+#   TAGFILES = file1 file2 ... 
+# Adding location for the tag files is done as follows: 
+#   TAGFILES = file1=loc1 "file2 = loc2" ... 
+# where "loc1" and "loc2" can be relative or absolute paths or 
+# URLs. If a location is present for each tag, the installdox tool 
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen 
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES               = 
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE       = 
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
+# in the class index. If set to NO only the inherited external classes 
+# will be listed.
+
+ALLEXTERNALS           = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
+# in the modules index. If set to NO, only the current project's groups will 
+# be listed.
+
+EXTERNAL_GROUPS        = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script 
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH              = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool   
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
+# or super classes. Setting the tag to NO turns the diagrams off. Note that 
+# this option is superseded by the HAVE_DOT option below. This is only a 
+# fallback. It is recommended to install and use dot, since it yields more 
+# powerful graphs.
+
+CLASS_DIAGRAMS         = YES
+
+# You can define message sequence charts within doxygen comments using the \msc 
+# command. Doxygen will then run the mscgen tool (see 
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where 
+# the mscgen tool resides. If left empty the tool is assumed to be found in the 
+# default search path.
+
+MSCGEN_PATH            = 
+
+# If set to YES, the inheritance and collaboration graphs will hide 
+# inheritance and usage relations if the target is undocumented 
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS   = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
+# available from the path. This tool is part of Graphviz, a graph visualization 
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT               = YES
+
+# By default doxygen will write a font called FreeSans.ttf to the output 
+# directory and reference it in all dot files that doxygen generates. This 
+# font does not include all possible unicode characters however, so when you need 
+# these (or just want a differently looking font) you can specify the font name 
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
+# which can be done by putting it in a standard location or by setting the 
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
+# containing the font.
+
+DOT_FONTNAME           = FreeSans
+
+# By default doxygen will tell dot to use the output directory to look for the 
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a 
+# different font using DOT_FONTNAME you can set the path where dot 
+# can find it using this tag.
+
+DOT_FONTPATH           = 
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
+# will generate a graph for each documented class showing the direct and 
+# indirect inheritance relations. Setting this tag to YES will force the 
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH            = NO
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
+# will generate a graph for each documented class showing the direct and 
+# indirect implementation dependencies (inheritance, containment, and 
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH    = NO
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS           = NO
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
+# collaboration diagrams in a style similar to the OMG's Unified Modeling 
+# Language.
+
+UML_LOOK               = NO
+
+# If set to YES, the inheritance and collaboration graphs will show the 
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS     = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
+# tags are set to YES then doxygen will generate a graph for each documented 
+# file showing the direct and indirect include dependencies of the file with 
+# other documented files.
+
+INCLUDE_GRAPH          = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
+# documented header file showing the documented files that directly or 
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH      = NO
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then 
+# doxygen will generate a call dependency graph for every global function 
+# or class method. Note that enabling this option will significantly increase 
+# the time of a run. So in most cases it will be better to enable call graphs 
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH             = YES
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
+# doxygen will generate a caller dependency graph for every global function 
+# or class method. Note that enabling this option will significantly increase 
+# the time of a run. So in most cases it will be better to enable caller 
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH           = YES
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY    = NO
+
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
+# then doxygen will show the dependencies a directory has on other directories 
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH        = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT       = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be 
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH               = 
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that 
+# contain dot files that are included in the documentation (see the 
+# \dotfile command).
+
+DOTFILE_DIRS           = 
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
+# nodes that will be shown in the graph. If the number of nodes in a graph 
+# becomes larger than this value, doxygen will truncate the graph, which is 
+# visualized by representing a node as a red box. Note that doxygen if the 
+# number of direct children of the root node in a graph is already larger than 
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES    = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
+# graphs generated by dot. A depth value of 3 means that only nodes reachable 
+# from the root by following a path via at most 3 edges will be shown. Nodes 
+# that lay further from the root node will be omitted. Note that setting this 
+# option to 1 or 2 may greatly reduce the computation time needed for large 
+# code bases. Also note that the size of a graph can be further restricted by 
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH    = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
+# background. This is disabled by default, because dot on Windows does not 
+# seem to support this out of the box. Warning: Depending on the platform used, 
+# enabling this option may lead to badly anti-aliased labels on the edges of 
+# a graph (i.e. they become hard to read).
+
+DOT_TRANSPARENT        = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
+# files in one run (i.e. multiple -o and -T options on the command line). This 
+# makes dot run faster, but since only newer versions of dot (>1.8.10) 
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS      = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
+# generate a legend page explaining the meaning of the various boxes and 
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND        = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
+# remove the intermediate dot files that are used to generate 
+# the various graphs.
+
+DOT_CLEANUP            = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine   
+#---------------------------------------------------------------------------
+
+# The SEARCHENGINE tag specifies whether or not a search engine should be 
+# used. If set to NO the values of all tags below this one will be ignored.
+
+SEARCHENGINE           = NO
diff --git a/doc/rosdoc.main b/doc/rosdoc.main
new file mode 100644 (file)
index 0000000..7205a85
--- /dev/null
@@ -0,0 +1,17 @@
+/*! \mainpage The ROS Source Documentation
+    \htmlonly
+
+<p>
+Looks like I can now put whatever I want in here in HTML format, 
+so have at it.....
+</p>
+<img src="img/nanwan.png" align=left width=200></img>
+<img src="img/nanwan.png" align=right width=200></img>
+<center><font size=200>
+INCOMPLETE DOCUMENTATION:<br><br>
+ONLY ONE FILE MARKED UP SO FAR: KERN/SRC/PMAP.C<br><br>
+CLICK ON THE 'FILES' TAB IN THE UPPER LEFT AND SCROLL DOWN TO SEE IT
+</font></center>
+
+    \endhtmlonly
+ */
\ No newline at end of file
index 7a57309..5ad892b 100644 (file)
@@ -1,32 +1,32 @@
-#
-# Makefile fragment for the ROS kernel.
-# This is NOT a complete makefile;
-# you must run GNU make in the top-level directory
-# where the GNUmakefile is located.
-#
-
-KERN_BOOT_DIR := $(KERN_DIR)/boot
-OBJDIRS += $(KERN_BOOT_DIR)
-
-KERN_BOOT_CFLAGS  := $(KERN_CFLAGS) -Os
-KERN_BOOT_LDFLAGS := $(KERN_LDFLAGS) -N -e start -Ttext 0x7C00
-KERN_BOOT_OBJS    := $(OBJDIR)/$(KERN_DIR)/boot.o \
-                     $(OBJDIR)/$(KERN_DIR)/main.o
-
-$(OBJDIR)/$(KERN_DIR)/%.o: $(KERN_BOOT_DIR)/%.c
-       @echo + cc [BOOT] $<
-       @mkdir -p $(@D)
-       $(V)$(CC) $(KERN_BOOT_CFLAGS) -c -o $@ $<
-
-$(OBJDIR)/$(KERN_DIR)/%.o: $(KERN_BOOT_DIR)/%.S
-       @echo + as [BOOT] $<
-       @mkdir -p $(@D)
-       $(V)$(CC) $(KERN_BOOT_CFLAGS) -c -o $@ $<
-
-$(OBJDIR)/$(KERN_DIR)/boot: $(KERN_BOOT_OBJS)
-       @echo + ld [BOOT] $<
-       $(V)$(LD) $(KERN_BOOT_LDFLAGS) -o $@.out $^
-       $(V)$(OBJDUMP) -S $@.out >$@.asm
-       $(V)$(OBJCOPY) -S -O binary $@.out $@
-       $(V)perl $(KERN_BOOT_DIR)/sign.pl $(OBJDIR)/$(KERN_DIR)/boot
-
+#\r
+# Makefile fragment for the ROS kernel.\r
+# This is NOT a complete makefile;\r
+# you must run GNU make in the top-level directory\r
+# where the GNUmakefile is located.\r
+#\r
+\r
+KERN_BOOT_DIR := $(KERN_DIR)/boot\r
+OBJDIRS += $(KERN_BOOT_DIR)\r
+\r
+KERN_BOOT_CFLAGS  := $(KERN_CFLAGS) -Os\r
+KERN_BOOT_LDFLAGS := $(KERN_LDFLAGS) -N -e start -Ttext 0x7C00\r
+KERN_BOOT_OBJS    := $(OBJDIR)/$(KERN_BOOT_DIR)/boot.o \\r
+                     $(OBJDIR)/$(KERN_BOOT_DIR)/main.o\r
+\r
+$(OBJDIR)/$(KERN_BOOT_DIR)/%.o: $(KERN_BOOT_DIR)/%.c\r
+       @echo + cc [BOOT] $<\r
+       @mkdir -p $(@D)\r
+       $(V)$(CC) $(KERN_BOOT_CFLAGS) -c -o $@ $<\r
+\r
+$(OBJDIR)/$(KERN_BOOT_DIR)/%.o: $(KERN_BOOT_DIR)/%.S\r
+       @echo + as [BOOT] $<\r
+       @mkdir -p $(@D)\r
+       $(V)$(CC) $(KERN_BOOT_CFLAGS) -c -o $@ $<\r
+\r
+$(OBJDIR)/$(KERN_DIR)/boot: $(KERN_BOOT_OBJS)\r
+       @echo + ld [BOOT] $<\r
+       $(V)$(LD) $(KERN_BOOT_LDFLAGS) -o $@.out $^\r
+       $(V)$(OBJDUMP) -S $@.out >$@.asm\r
+       $(V)$(OBJCOPY) -S -O binary $@.out $@\r
+       $(V)perl $(KERN_BOOT_DIR)/sign.pl $(OBJDIR)/$(KERN_DIR)/boot\r
+\r
index 610de7e..3e6d66f 100644 (file)
@@ -66,4 +66,5 @@ void page_alloc_init()
        for (i = PPN(maxaddrpa); i < npages; i++) {
                pages[i].page_ref = 1;
        }
-}
\ No newline at end of file
+}
+
index cfcc922..3caa20a 100644 (file)
@@ -1,6 +1,6 @@
-#
-# Makefile fragment for the ROS kernel.
-# This is NOT a complete makefile;
-# you must run GNU make in the top-level directory
-# where the GNUmakefile is located.
-#
+#\r
+# Makefile fragment for the ROS kernel.\r
+# This is NOT a complete makefile;\r
+# you must run GNU make in the top-level directory\r
+# where the GNUmakefile is located.\r
+#\r
index 5ebf78a..d66d9e4 100644 (file)
@@ -57,4 +57,5 @@ size_t get_cache_lines_per_way(cache_t *c);
 size_t get_cache_pages_per_way(cache_t *c);
 size_t get_cache_num_page_colors(cache_t *c);
 
-#endif // ROS_KERN_COLORED_CACHES_H
\ No newline at end of file
+#endif // ROS_KERN_COLORED_CACHES_H
+
index 29a88d5..33df609 100644 (file)
 #include <arch/types.h>
 
 void  kmalloc_init();
-void* (DALLOC(size) boot_alloc)(uint32_t size, uint32_t align);
+
+void* (DALLOC(n) boot_alloc)(uint32_t n, uint32_t align);
+void* (DALLOC(_n*sz) boot_calloc)(uint32_t _n, size_t sz, uint32_t align);
+
 void* (DALLOC(size) kmalloc)(size_t size, int flags);
 void  (DFREE(addr) kfree)(void *addr);
 
-#endif //ROS_KERN_KMALLOC_H
\ No newline at end of file
+#endif //ROS_KERN_KMALLOC_H
+
index 0cd2e62..aa0d389 100644 (file)
@@ -368,4 +368,4 @@ static void __name##_assert_sring_size() __attribute__((used)) {        \
  * indent-tabs-mode: nil
  * End:
  */
\ No newline at end of file
+
index 6874fd3..a1c7dc5 100644 (file)
@@ -34,4 +34,5 @@ typedef struct sysevent_rsp {
 #define SYSEVENTRINGSIZE    PGSIZE
 DEFINE_RING_TYPES_WITH_SIZE(sysevent, sysevent_t, sysevent_rsp_t, SYSEVENTRINGSIZE);
 
-#endif //ROS_SYSEVENT_H
\ No newline at end of file
+#endif //ROS_SYSEVENT_H
+
index 925bfbc..fa62c72 100644 (file)
@@ -1,18 +1,18 @@
-KERN_IVY_DIR = $(KERN_DIR)/ivy
-OBJDIRS += $(KERN_IVY_DIR)
-
-KERN_IVY_CFLAGS   := $(KERN_CFLAGS) --nodeputy
-KERN_IVY_SRCFILES := $(KERN_IVY_DIR)/deputy.c
-KERN_IVY_OBJFILES := $(patsubst $(KERN_IVY_DIR)/%.c, \
-                                   $(OBJDIR)/$(KERN_DIR)/%.o, \
-                                   $(KERN_IVY_SRCFILES))
-
-$(OBJDIR)/$(KERN_DIR)/deputy.o: $(KERN_IVY_SRCFILES)
-       @echo + cc [KERN IVY] $<
-       @mkdir -p $(@D)
-       $(V)$(CC) $(KERN_IVY_CFLAGS) -c -o $@ $<
-
-$(OBJDIR)/$(KERN_DIR)/libivykern.a: $(KERN_IVY_OBJFILES)
-       @echo + ar [KERN IVY] $@
-       $(V)$(AR) r $@ $(KERN_IVY_OBJFILES) 2>/dev/null
-
+KERN_IVY_DIR = $(KERN_DIR)/ivy\r
+OBJDIRS += $(KERN_IVY_DIR)\r
+\r
+KERN_IVY_CFLAGS   := $(KERN_CFLAGS) --nodeputy\r
+KERN_IVY_SRCFILES := $(KERN_IVY_DIR)/deputy.c\r
+KERN_IVY_OBJFILES := $(patsubst $(KERN_IVY_DIR)/%.c, \\r
+                                   $(OBJDIR)/$(KERN_IVY_DIR)/%.o, \\r
+                                   $(KERN_IVY_SRCFILES))\r
+\r
+$(OBJDIR)/$(KERN_IVY_DIR)/%.o: $(KERN_IVY_DIR)/%.c \r
+       @echo + cc [KERN IVY] $<\r
+       @mkdir -p $(@D)\r
+       $(V)$(CC) $(KERN_IVY_CFLAGS) -c -o $@ $<\r
+\r
+$(OBJDIR)/$(KERN_DIR)/libivykern.a: $(KERN_IVY_OBJFILES)\r
+       @echo + ar [KERN IVY] $@\r
+       $(V)$(AR) r $@ $(KERN_IVY_OBJFILES) 2>/dev/null\r
+\r
index 5ed6112..cf22d26 100644 (file)
@@ -52,7 +52,7 @@ KERN_APPFILES := \
 #                 $(USER_APPS_PARLIB_DIR)/open_read
 
 KERN_LDFLAGS   := $(KERN_LDFLAGS) -L$(OBJDIR)/$(KERN_DIR) \
-                  -T $(ARCH_DIR)/$(TARGET_ARCH)/kernel.ld
+                  -T $(KERN_ARCH_SRC_DIR)/kernel.ld
 
 KERN_OBJFILES  := $(patsubst $(KERN_DIR)/%.c, \
                              $(OBJDIR)/$(KERN_DIR)/%.o, \
index cb8c082..107271e 100644 (file)
@@ -107,4 +107,5 @@ inline size_t get_cache_pages_per_way(cache_t *c) {
 }
 inline size_t get_cache_num_page_colors(cache_t *c) {
        return get_cache_pages_per_way(c);
-}
\ No newline at end of file
+}
+
index acd811b..ba321f1 100644 (file)
@@ -13,7 +13,7 @@
 
 #define kmallocdebug(args...)  printk(args)
 
-physaddr_t boot_freemem;           // Pointer to next byte of free physical mem
+char*BND(end, maxaddrpa_ptr + IVY_KERNBASE) boot_freemem;
 static page_list_t pages_list; //List of physical pages used by kmalloc
 
 /*
@@ -25,9 +25,9 @@ static page_list_t pages_list;        //List of physical pages used by kmalloc
  * This function may ONLY be used during initialization,
  * before the page_free_list has been set up.
  */
-void* boot_alloc(uint32_t size, uint32_t align)
+void* boot_alloc(uint32_t n, uint32_t align)
 {
-       extern char (COUNT(1) end)[]; //Read in from the linker script
+       extern char (SNT end)[];
        void *v;
 
        // Initialize boot_freemem if this is the first time.
@@ -35,23 +35,54 @@ void* boot_alloc(uint32_t size, uint32_t align)
        // which points to the end of the kernel's bss segment -
        // i.e., the first virtual address that the linker
        // did _not_ assign to any kernel code or global variables.
-       if (boot_freemem == 0)
-               boot_freemem = (physaddr_t) end;
+       if (boot_freemem == 0) {
+               boot_freemem = TC(end);
+       }
 
        //      Step 1: round boot_freemem up to be aligned properly
-       boot_freemem = ROUNDUP(boot_freemem, align);
+       boot_freemem = PTRROUNDUP(boot_freemem, align);
 
        //      Step 2: save current value of boot_freemem as allocated chunk
-       v = (void *COUNT(size)) TC(boot_freemem);
+       v = boot_freemem;
        //  Step 2.5: check if we can alloc
-       if (PADDR(boot_freemem + size) > maxaddrpa)
+       if (PADDR(boot_freemem + n) > maxaddrpa)
                panic("Out of memory in boot alloc, you fool!\n");
        //      Step 3: increase boot_freemem to record allocation
-       boot_freemem += size;   
+       boot_freemem += n;      
        //      Step 4: return allocated chunk
        return v;
 }
 
+void* boot_calloc(uint32_t _n, size_t sz, uint32_t align)
+{
+       extern char (SNT end)[];
+       uint32_t n = _n *sz;
+       void *v;
+
+       // Initialize boot_freemem if this is the first time.
+       // 'end' is a magic symbol automatically generated by the linker,
+       // which points to the end of the kernel's bss segment -
+       // i.e., the first virtual address that the linker
+       // did _not_ assign to any kernel code or global variables.
+       if (boot_freemem == 0)
+               boot_freemem = TC(end);
+
+       //      Step 1: round boot_freemem up to be aligned properly
+       boot_freemem = PTRROUNDUP(boot_freemem, align);
+
+       //      Step 2: save current value of boot_freemem as allocated chunk
+       v = boot_freemem;
+       //  Step 2.5: check if we can alloc
+       if (PADDR(boot_freemem + n) > maxaddrpa)
+               panic("Out of memory in boot alloc, you fool!\n");
+       //      Step 3: increase boot_freemem to record allocation
+       boot_freemem += n;
+       //  Step 4: zero allocated chunk
+       memset(v,0,n);
+       //      Step 5: return allocated chunk
+       return v;
+}
+
 void kmalloc_init() 
 {
        LIST_INIT(&pages_list);
@@ -105,4 +136,5 @@ void kfree(void *addr)
                page_free(p);
                kmallocdebug("freeing page: %d\n", page2ppn(p));
        }
-}
\ No newline at end of file
+}
+
index 43aee00..7f88665 100644 (file)
@@ -27,8 +27,6 @@ void manager(void)
        static uint8_t progress = 0;
        env_t *envs[256];
 
-       test_page_coloring();
-
        switch (progress++) {
                case 0:
                        envs[0] = kfs_proc_create(kfs_lookup_path("roslib_hello"));
index 80dd5cb..93cd9c8 100644 (file)
@@ -10,8 +10,9 @@
 #include <pmap.h>
 #include <string.h>
 
-/*
- * Clear a Page structure.
+/**
+ * @brief Clear a Page structure.
+ *
  * The result has null links and 0 refcount.
  * Note that the corresponding physical page is NOT initialized!
  */
@@ -20,17 +21,17 @@ static void page_clear(page_t *SAFE page)
        memset(page, 0, sizeof(page_t));
 }
 
-/*
- * Allocates a physical page.
+/**
+ * @brief Allocates a physical page from a pool of unused physical memory
+ *
  * Does NOT set the contents of the physical page to zero -
  * the caller must do that if necessary.
  *
- * *page       -- is set to point to the Page struct 
- *                of the newly allocated page
+ * @param[out] page  set to point to the Page struct
+ *                   of the newly allocated page
  *
- * RETURNS 
- *   ESUCCESS  -- on success
- *   -ENOMEM   -- otherwise 
+ * @return ESUCCESS on success
+ * @return -ENOMEM  otherwise
  */
 error_t page_alloc(page_t** page) 
 {
@@ -45,7 +46,7 @@ error_t page_alloc(page_t** page)
        return -ENOMEM;
 }
 
-/* 
+/*
  * This macro defines multiple functions of the form:
  * error_t _cache##_page_alloc(page_t** page, size_t color)
  *
index c292eb0..4dc34b3 100644 (file)
@@ -1,5 +1,16 @@
 /* See COPYRIGHT for copyright information. */
 
+/** @file 
+ * This file is responsible for managing physical pages as they 
+ * are mapped into the page tables of a particular virtual address
+ * space.  The functions defined in this file operate on these
+ * page tables to insert and remove physical pages from them at 
+ * particular virtual addresses.
+ *
+ * @author Kevin Klues <klueska@cs.berkeley.edu>
+ * @author Barret Rhoden <brho@cs.berkeley.edu>
+ */
+
 #include <arch/arch.h>
 #include <arch/mmu.h>
 
 #include <process.h>
 #include <stdio.h>
 
+/**
+ * @brief Global variable used to store erroneous virtual addresses as the
+ *        result of a failed user_mem_check().
+ */
 static void *DANGEROUS user_mem_check_addr;
 
-// --------------------------------------------------------------
-// Tracking of physical pages.
-// The 'pages' array has one 'page_t' entry per physical page.
-// Pages are reference counted, and free pages are kept on a linked list.
-// --------------------------------------------------------------
-  
-// Initialize page structure and memory free list.
+/**
+ * @brief Initialize the array of physical pages and memory free list.
+ *
+ * The 'pages' array has one 'page_t' entry per physical page.
+ * Pages are reference counted, and free pages are kept on a linked list.
+ */
 void page_init(void)
 {
-       // First, make 'pages' point to an array of size 'npages' of
-       // type 'page_t'.
-       // The kernel uses this structure to keep track of physical pages;
-       // 'npages' equals the number of physical pages in memory.
-       // round up to the nearest page
+       /*
+     * First, make 'pages' point to an array of size 'npages' of
+        * type 'page_t'.
+        * The kernel uses this structure to keep track of physical pages;
+        * 'npages' equals the number of physical pages in memory.
+        * round up to the nearest page
+        */
        size_t page_array_size = ROUNDUP(npages*sizeof(page_t), PGSIZE);
        pages = (page_t*)boot_alloc(page_array_size, PGSIZE);
-       memset(pages, 0, page_array_size);
+       memset(pages, 0, npages*sizeof(page_t));
 
-       // Now initilaize everything so pages can start to be alloced and freed
-       // from the memory free list
+       /*
+     * Then initilaize everything so pages can start to be alloced and freed
+        * from the memory free list
+        */
        page_alloc_init();
 }
 
-//
-// Map the physical page 'pp' at virtual address 'va'.
-// The permissions (the low 12 bits) of the page table
-//  entry should be set to 'perm|PTE_P'.
-//
-// Details
-//   - If there is already a page mapped at 'va', it is page_remove()d.
-//   - If necessary, on demand, allocates a page table and inserts it into
-//     'pgdir'.
-//   - page_incref() should be called if the insertion succeeds.
-//   - The TLB must be invalidated if a page was formerly present at 'va'.
-//     (this is handled in page_remove)
-//
-// RETURNS: 
-//   0 on success
-//   -ENOMEM, if page table couldn't be allocated
-//
-// Hint: The TA solution is implemented using pgdir_walk, page_remove,
-// and page2pa.
-//
-// No support for jumbos here.  will need to be careful of trying to insert
-// regular pages into something that was already jumbo, and the overloading
-// of the PTE_PS and PTE_PAT flags...
-int
-page_insert(pde_t *pgdir, page_t *pp, void *va, int perm) 
+/** 
+ * @brief Map the physical page 'pp' into the virtual address 'va' in page
+ *        directory 'pgdir'
+ *
+ * Map the physical page 'pp' at virtual address 'va'.
+ * The permissions (the low 12 bits) of the page table
+ * entry should be set to 'perm|PTE_P'.
+ * 
+ * Details:
+ *   - If there is already a page mapped at 'va', it is page_remove()d.
+ *   - If necessary, on demand, allocates a page table and inserts it into 
+ *     'pgdir'.
+ *   - page_incref() should be called if the insertion succeeds. 
+ *   - The TLB must be invalidated if a page was formerly present at 'va'.
+ *     (this is handled in page_remove)
+ *
+ * No support for jumbos here.  We will need to be careful when trying to
+ * insert regular pages into something that was already jumbo.  We will
+ * also need to be careful with our overloading of the PTE_PS and 
+ * PTE_PAT flags...
+ *
+ * @param[in] pgdir the page directory to insert the page into
+ * @param[in] pp    a pointr to the page struct representing the
+ *                  physical page that should be inserted.
+ * @param[in] va    the virtual address where the page should be
+ *                  inserted.
+ * @param[in] perm  the permition bits with which to set up the 
+ *                  virtual mapping.
+ *
+ * @return ESUCCESS  on success
+ * @return -ENOMEM   if a page table could not be allocated
+ *                   into which the page should be inserted
+ *
+ */
+int page_insert(pde_t *pgdir, page_t *pp, void *va, int perm) 
 {
        pte_t* pte = pgdir_walk(pgdir, va, 1);
        if (!pte)
@@ -79,24 +107,34 @@ page_insert(pde_t *pgdir, page_t *pp, void *va, int perm)
        return 0;
 }
 
-//
-// Map the physical page 'pp' at the first virtual address that is free 
-// in the range 'vab' to 'vae'.
-// The permissions (the low 12 bits) of the page table entry get set to 
-// 'perm|PTE_P'.
-//
-// Details
-//   - If there is no free entry in the range 'vab' to 'vae' this 
-//     function returns -ENOMEM.
-//   - If necessary, on demand, this function will allocate a page table 
-//     and inserts it into 'pgdir'.
-//   - page_incref() should be called if the insertion succeeds.
-//
-// RETURNS: 
-//   NULL, if no free va in the range (vab, vae) could be found
-//   va,   the virtual address where pp has been mapped in the 
-//         range (vab, vae)
-//
+/**
+ * @brief Map the physical page 'pp' at the first virtual address that is free 
+ * in the range 'vab' to 'vae' in page directory 'pgdir'.
+ *
+ * The permissions (the low 12 bits) of the page table entry get set to 
+ * 'perm|PTE_P'.
+ *
+ * Details:
+ *   - If there is no free entry in the range 'vab' to 'vae' this 
+ *     function returns NULL.
+ *   - If necessary, on demand, this function will allocate a page table 
+ *     and inserts it into 'pgdir'.
+ *   - page_incref() will be called if the insertion succeeds.
+ * 
+ * @param[in] pgdir the page directory to insert the page into
+ * @param[in] pp    a pointr to the page struct representing the
+ *                  physical page that should be inserted.
+ * @param[in] vab   the first virtual address in the range in which the 
+ *                  page can be inserted.
+ * @param[in] vae   the last virtual address in the range in which the 
+ *                  page can be inserted.
+ * @param[in] perm  the permition bits with which to set up the 
+ *                  virtual mapping.
+ *
+ * @return VA   the virtual address where pp has been mapped in the 
+ *              range (vab, vae)
+ * @return NULL no free va in the range (vab, vae) could be found
+ */
 void* page_insert_in_range(pde_t *pgdir, page_t *pp, 
                            void *vab, void *vae, int perm) 
 {
@@ -113,17 +151,23 @@ void* page_insert_in_range(pde_t *pgdir, page_t *pp,
        return TC(new_va); // trusted because mapping a page is like allocation
 }
 
-//
-// Return the page mapped at virtual address 'va'.
-// If pte_store is not zero, then we store in it the address
-// of the pte for this page.  This is used by page_remove
-// but should not be used by other callers.
-//
-// Return 0 if there is no page mapped at va.
-//
-// Hint: the TA solution uses pgdir_walk and pa2page.
-//
-// For jumbos, right now this returns the first Page* in the 4MB
+/**
+ * @brief Return the page mapped at virtual address 'va' in 
+ * page directory 'pgdir'.
+ *
+ * If pte_store is not NULL, then we store in it the address
+ * of the pte for this page.  This is used by page_remove
+ * but should not be used by other callers.
+ *
+ * For jumbos, right now this returns the first Page* in the 4MB range
+ *
+ * @param[in]  pgdir     the page directory from which we should do the lookup
+ * @param[in]  va        the virtual address of the page we are looking up
+ * @param[out] pte_store the address of the page table entry for the returned page
+ *
+ * @return PAGE the page mapped at virtual address 'va'
+ * @return NULL No mapping exists at virtual address 'va'   
+ */
 page_t *page_lookup(pde_t *pgdir, void *va, pte_t **pte_store)
 {
        pte_t* pte = pgdir_walk(pgdir, va, 0);
@@ -134,24 +178,27 @@ page_t *page_lookup(pde_t *pgdir, void *va, pte_t **pte_store)
        return pa2page(PTE_ADDR(*pte));
 }
 
-//
-// Unmaps the physical page at virtual address 'va'.
-// If there is no physical page at that address, silently does nothing.
-//
-// Details:
-//   - The ref count on the physical page should decrement.
-//   - The physical page should be freed if the refcount reaches 0.
-//   - The pg table entry corresponding to 'va' should be set to 0.
-//     (if such a PTE exists)
-//   - The TLB must be invalidated if you remove an entry from
-//     the pg dir/pg table.
-//
-// Hint: The TA solution is implemented using page_lookup,
-//     tlb_invalidate, and page_decref.
-//
-// This may be wonky wrt Jumbo pages and decref.  
-void
-page_remove(pde_t *pgdir, void *va)
+/**
+ * @brief Unmaps the physical page at virtual address 'va' in page directory
+ * 'pgdir'.
+ *
+ * If there is no physical page at that address, this function silently 
+ * does nothing.
+ *
+ * Details:
+ *   - The ref count on the physical page is decrement when the page is removed
+ *   - The physical page is freed if the refcount reaches 0.
+ *   - The pg table entry corresponding to 'va' is set to 0.
+ *     (if such a PTE exists)
+ *   - The TLB is invalidated if an entry is removes from the pg dir/pg table.
+ *
+ * This may be wonky wrt Jumbo pages and decref.  
+ *
+ * @param pgdir the page directory from with the page sholuld be removed
+ * @param va    the virtual address at which the page we are trying to 
+ *              remove is mapped
+ */
+void page_remove(pde_t *pgdir, void *va)
 {
        pte_t* pte;
        page_t *page;
@@ -163,48 +210,49 @@ page_remove(pde_t *pgdir, void *va)
        page_decref(page);
 }
 
-//
-// Invalidate a TLB entry, but only if the page tables being
-// edited are the ones currently in use by the processor.
-//
-// Need to sort this for cross core lovin'  TODO
-void
-tlb_invalidate(pde_t *pgdir, void *va)
+/**
+ * @brief Invalidate a TLB entry, but only if the page tables being
+ * edited are the ones currently in use by the processor.
+ *
+ * TODO: Need to sort this for cross core lovin'
+ *
+ * @param pgdir the page directory assocaited with the tlb entry 
+ *              we are trying to invalidate
+ * @param va    the virtual address associated with the tlb entry
+ *              we are trying to invalidate
+ */
+void tlb_invalidate(pde_t *pgdir, void *va)
 {
        // Flush the entry only if we're modifying the current address space.
        // For now, there is only one address space, so always invalidate.
        invlpg(va);
 }
 
-//
-// Check that an environment is allowed to access the range of memory
-// [va, va+len) with permissions 'perm | PTE_P'.
-// Normally 'perm' will contain PTE_U at least, but this is not required.
-// 'va' and 'len' need not be page-aligned; you must test every page that
-// contains any of that range.  You will test either 'len/PGSIZE',
-// 'len/PGSIZE + 1', or 'len/PGSIZE + 2' pages.
-//
-// A user program can access a virtual address if (1) the address is below
-// ULIM, and (2) the page table gives it permission.  These are exactly
-// the tests you should implement here.
-//
-// If there is an error, set the 'user_mem_check_addr' variable to the first
-// erroneous virtual address.
-//
-// Returns 0 if the user program can access this range of addresses,
-// and -EFAULT otherwise.
-//
-// Hint: The TA solution uses pgdir_walk.
-//
-
-// zra: I've modified the interface to these two functions so that Ivy can
-// check that user pointers aren't dereferenced. User pointers get the
-// DANGEROUS qualifier. After validation, these functions return a
-// COUNT(len) pointer. user_mem_check now returns NULL on error instead of
-// -EFAULT.
-
-void *
-user_mem_check(env_t *env, const void *DANGEROUS va, size_t len, int perm)
+/**
+ * @brief Check that an environment is allowed to access the range of memory
+ * [va, va+len) with permissions 'perm | PTE_P'.
+ *
+ * Normally 'perm' will contain PTE_U at least, but this is not required.
+ * 'va' and 'len' need not be page-aligned;
+ *
+ * A user program can access a virtual address if:
+ *     -# the address is below ULIM
+ *     -# the page table gives it permission.  
+ *
+ * If there is an error, 'user_mem_check_addr' is set to the first
+ * erroneous virtual address.
+ *
+ * @param env  the environment associated with the user program trying to access
+ *             the virtual address range
+ * @param va   the first virtual address in the range
+ * @param len  the length of the virtual address range
+ * @param perm the permissions the user is trying to access the virtual address 
+ *             range with
+ *
+ * @return VA a pointer of type COUNT(len) to the address range
+ * @return NULL trying to access this range of virtual addresses is not allowed
+ */
+void* user_mem_check(env_t *env, const void *DANGEROUS va, size_t len, int perm)
 {
        // TODO - will need to sort this out wrt page faulting / PTE_P
        // also could be issues with sleeping and waking up to find pages
@@ -241,8 +289,23 @@ user_mem_check(env_t *env, const void *DANGEROUS va, size_t len, int perm)
        return (void *COUNT(len))TC(va);
 }
 
-size_t
-user_mem_strlcpy(env_t *env, char *dst, const char *DANGEROUS va,
+/**
+ * @brief Use the kernel to copy a string from a buffer stored in userspace
+ *        to a buffer stored elsewhere in the address space (potentially in 
+ *        memory only accessible by the kernel)
+ *
+ * @param env  the environment associated with the user program from which
+ *             the string is being copied
+ * @param dst  the destination of the buffer into which the string 
+ *             is being copied
+ * @param va   the start address of the buffer where the string resides
+ * @param len  the length of the buffer 
+ * @param perm the permissions with which the user is trying to access 
+ *             elements of the original buffer 
+ *
+ * @return LEN the length of the new buffer copied into 'dst'
+ */
+size_t user_mem_strlcpy(env_t *env, char *dst, const char *DANGEROUS va,
                  size_t len, int perm)
 {
        const char *DANGEROUS src = va;
@@ -264,12 +327,25 @@ user_mem_strlcpy(env_t *env, char *dst, const char *DANGEROUS va,
        return dst - dst_in;
 }
 
-//
-// Checks that environment 'env' is allowed to access the range
-// of memory [va, va+len) with permissions 'perm | PTE_U'.
-// If it can, then the function simply returns.
-// If it cannot, 'env' is destroyed.
-//
+/**
+ * @brief Checks that environment 'env' is allowed to access the range
+ * of memory [va, va+len) with permissions 'perm | PTE_U'. Destroy 
+ * environment 'env' if the assertion fails.
+ *
+ * This function is identical to user_mem_assert() except that it has a side
+ * affect of destroying the environment 'env' if the memory check fails.
+ *
+ * @param env  the environment associated with the user program trying to access
+ *             the virtual address range
+ * @param va   the first virtual address in the range
+ * @param len  the length of the virtual address range
+ * @param perm the permissions the user is trying to access the virtual address 
+ *             range with
+ *
+ * @return VA a pointer of type COUNT(len) to the address range
+ * @return NULL trying to access this range of virtual addresses is not allowed
+ *              environment 'env' is destroyed
+ */
 void *
 user_mem_assert(env_t *env, const void *DANGEROUS va, size_t len, int perm)
 {
@@ -283,10 +359,20 @@ user_mem_assert(env_t *env, const void *DANGEROUS va, size_t len, int perm)
     return res;
 }
 
-// copies data from a user buffer to a kernel buffer.
-// EFAULT if page not present, user lacks perms, or invalid addr.
-error_t
-memcpy_from_user(env_t* env, void* COUNT(len) dest,
+/**
+ * @brief Copies data from a user buffer to a kernel buffer.
+ * 
+ * @param env  the environment associated with the user program
+ *             from which the buffer is being copied
+ * @param dest the destination address of the kernel buffer
+ * @param va   the address of the userspace buffer from which we are copying
+ * @param len  the length of the userspace buffer
+ *
+ * @return ESUCCESS on success
+ * @return -EFAULT  the page assocaited with 'va' is not present, the user 
+ *                  lacks the proper permissions, or there was an invalid 'va'
+ */
+error_t memcpy_from_user(env_t* env, void* COUNT(len) dest,
                  const void *DANGEROUS va, size_t len)
 {
        const void *DANGEROUS start, *DANGEROUS end;
@@ -327,3 +413,4 @@ memcpy_from_user(env_t* env, void* COUNT(len) dest,
 
        return ESUCCESS;
 }
+
index 45b6b2b..600b87d 100644 (file)
 # so it is compatible with GCC3's -MP option.
 #
 
+sub makedirname($) 
+{
+       my $file = shift; 
+       $file =~ s!/?[^/]*/*$!!; 
+       $file =~ s!^[^/]*/!!; 
+       return $file; 
+}
+
 sub readdeps {
        my $filename = shift;
+       my $use_filename = shift;
 
        open(DEPFILE, $filename) or return 0;
        while (<DEPFILE>) {
                if (/([^:]*):([^\\:]*)([\\]?)$/) {
-                       my $target = $filename;
+                       my $target = $1;
                        my $deplines = $2;
                        my $slash = $3;
-                       $target =~ s/\.d$/\.o/;
+                       if($use_filename) {
+                               $target = $filename;
+                               $target =~ s/\.d$/\.o/;
+                       }
                        while ($slash ne '') {
                                $_ = <DEPFILE>;
                                defined($_) or die
@@ -44,7 +56,7 @@ sub readdeps {
                                $slash = $2;
                        }
                        #print "DEPENDENCY [[$target]]: [[$deplines]]\n";
-                       $dephash{$target} = $deplines;
+                       $dephash{$target} = " ".makedirname($filename)."/Makefrag".$deplines;
                } elsif (/^[#]?[ \t]*$/) {
                        # ignore blank lines and comments
                } else {
@@ -65,11 +77,11 @@ if ($#ARGV < 0) {
 
 # Read the main dependency file
 $maindeps = $ARGV[0];
-readdeps($maindeps);
+readdeps($maindeps, 0);
 
 # Read and merge in the new dependency files
 foreach $i (1 .. $#ARGV) {
-       readdeps($ARGV[$i]) or die "Can't open $ARGV[$i]";
+       readdeps($ARGV[$i], 1) or die "Can't open $ARGV[$i]";
 }
 
 # Update the main dependency file
index a064700..a3aa56a 100644 (file)
@@ -1,7 +1,7 @@
-USER_APPS_DIR = $(USER_DIR)/apps
-
-include $(USER_APPS_DIR)/roslib/Makefrag
-include $(USER_APPS_DIR)/parlib/Makefrag
-
-.PRECIOUS: $(OBJDIR)/$(USER_APPS_DIR)/roslib/%.o \
-           $(OBJDIR)/$(USER_APPS_DIR)/parlib/%.o
+USER_APPS_DIR = $(USER_DIR)/apps\r
+\r
+include $(USER_APPS_DIR)/roslib/Makefrag\r
+include $(USER_APPS_DIR)/parlib/Makefrag\r
+\r
+.PRECIOUS: $(OBJDIR)/$(USER_APPS_DIR)/roslib/%.o \\r
+           $(OBJDIR)/$(USER_APPS_DIR)/parlib/%.o\r
index d456971..de949d9 100644 (file)
@@ -13,7 +13,7 @@ USER_APPS_PARLIB_LDDIRS    := -L$(OBJDIR)/$(USER_PARLIB_DIR) \
 
 USER_APPS_PARLIB_LDLIBS    := --start-group -lc -lm -lg -lparlib -livyparlib --end-group
 
-USER_APPS_PARLIB_LDOBJS    := $(OBJDIR)/$(USER_PARLIB_DIR)/$(TARGET_ARCH)/entry.o \
+USER_APPS_PARLIB_LDOBJS    := $(OBJDIR)/$(USER_PARLIB_ARCH_SRC_DIR)/entry.o \
                               $(OBJDIR)/$(USER_APPS_PARLIB_DIR)/readline.o \
                               $(OBJDIR)/$(USER_APPS_PARLIB_DIR)/file_io.o \
                               $(OBJDIR)/$(USER_APPS_PARLIB_DIR)/file_error.o \
index c2a63ae..fd28d38 100644 (file)
@@ -7,7 +7,7 @@ USER_APPS_ROSLIB_LDFLAGS   := $(USER_LDFLAGS) -static \
                               -T $(USER_APPS_ROSLIB_DIR)/apps_$(TARGET_ARCH).ld
 USER_APPS_ROSLIB_LDDIRS    := -L$(OBJDIR)/$(USER_ROSLIB_DIR)
 USER_APPS_ROSLIB_LDLIBS    := --start-group -livyroslib -lroslib --end-group
-USER_APPS_ROSLIB_LDOBJS    := $(OBJDIR)/$(USER_ROSLIB_DIR)/$(TARGET_ARCH)/entry.o 
+USER_APPS_ROSLIB_LDOBJS    := $(OBJDIR)/$(USER_ROSLIB_ARCH_SRC_DIR)/entry.o 
 USER_APPS_ROSLIB_LDDEPENDS := $(USER_APPS_ROSLIB_LDOBJS) \
                               $(OBJDIR)/$(USER_ROSLIB_DIR)/libivyroslib.a \
                               $(OBJDIR)/$(USER_ROSLIB_DIR)/libroslib.a \
index 88d6103..7258923 100644 (file)
@@ -1,10 +1,11 @@
-USER_PARLIB_DIR := $(USER_DIR)/parlib
-USER_PARLIB_INCLUDE_DIR  := $(USER_PARLIB_DIR)/inc
-
-# This is defined here for use by the parlib library
-USER_PARLIB_NEWLIB_DIR := $(USER_PARLIB_DIR)/newlib
-
-include $(USER_PARLIB_DIR)/src/Makefrag
-include $(USER_PARLIB_DIR)/ivy/Makefrag
-
-.PRECIOUS: $(OBJDIR)/$(USER_PARLIB_DIR)/%.o 
+USER_PARLIB_DIR := $(USER_DIR)/parlib\r
+USER_PARLIB_INCLUDE_DIR  := $(USER_PARLIB_DIR)/inc\r
+\r
+# This is defined here for use by the parlib library\r
+USER_PARLIB_NEWLIB_DIR := $(USER_PARLIB_DIR)/newlib\r
+\r
+include $(USER_PARLIB_DIR)/src/$(TARGET_ARCH)/Makefrag\r
+include $(USER_PARLIB_DIR)/src/Makefrag\r
+include $(USER_PARLIB_DIR)/ivy/Makefrag\r
+\r
+.PRECIOUS: $(OBJDIR)/$(USER_PARLIB_DIR)/%.o \r
index f748b38..4e8864c 100644 (file)
@@ -1,6 +1,7 @@
 USER_PARLIB_SRC_DIR = $(USER_PARLIB_DIR)/src
 OBJDIRS += $(USER_PARLIB_SRC_DIR)
-PATCHFILE = $(USER_PARLIB_DIR)/inc/libc_patch.i
+
+PATCHFILE = $(OBJDIR)/$(USER_PARLIB_DIR)/libc_patch.i
 
 USER_PARLIB_SRC_CFLAGS   := $(USER_CFLAGS) --nopatch --patch=$(PATCHFILE)\
                             -I$(USER_PARLIB_DIR)/inc \
@@ -11,28 +12,29 @@ USER_PARLIB_SRC_SRCFILES := $(USER_PARLIB_SRC_DIR)/debug.c \
                             $(USER_PARLIB_SRC_DIR)/syscall.c \
                             $(USER_PARLIB_SRC_DIR)/parlibmain.c \
                             $(USER_PARLIB_SRC_DIR)/channel.c \
-                            $(USER_PARLIB_SRC_DIR)/$(TARGET_ARCH)/syscall.c \
-                            $(USER_PARLIB_SRC_DIR)/$(TARGET_ARCH)/entry.S \
-                            $(USER_PARLIB_SRC_DIR)/$(TARGET_ARCH)/newlib_backend.c
+                            $(USER_PARLIB_ARCH_SRCFILES)
 
 USER_PARLIB_SRC_OBJFILES := $(patsubst $(USER_PARLIB_SRC_DIR)/%.c, \
-                            $(OBJDIR)/$(USER_PARLIB_DIR)/%.o, \
+                            $(OBJDIR)/$(USER_PARLIB_SRC_DIR)/%.o, \
                             $(USER_PARLIB_SRC_SRCFILES))
 USER_PARLIB_SRC_OBJFILES := $(patsubst $(USER_PARLIB_SRC_DIR)/%.S, \
-                            $(OBJDIR)/$(USER_PARLIB_DIR)/%.o, \
+                            $(OBJDIR)/$(USER_PARLIB_SRC_DIR)/%.o, \
                             $(USER_PARLIB_SRC_OBJFILES))
 
-ANNOTS = /usr/local/lib/ivy/include/deputy/annots.h
+ANNOTS := $(shell dirname $(shell which ivycc))
+ANNOTS := $(ANNOTS)/../lib/ivy/include/deputy/annots.h
+
 $(PATCHFILE): $(USER_PARLIB_DIR)/inc/libc_patch.h
-       @echo + cpp [PARLIB] $<
+       @echo + cpp [PARLIB] $^
+       @mkdir -p $(@D)
        $(V)gcc -E -include $(ANNOTS) -o $@ $^
 
-$(OBJDIR)/$(USER_PARLIB_DIR)/%.o: $(USER_PARLIB_SRC_DIR)/%.c $(PATCHFILE)
+$(OBJDIR)/$(USER_PARLIB_SRC_DIR)/%.o: $(USER_PARLIB_SRC_DIR)/%.c $(PATCHFILE)
        @echo + cc [PARLIB] $<
        @mkdir -p $(@D)
        $(V)$(CC) $(USER_PARLIB_SRC_CFLAGS) -c -o $@ $<
 
-$(OBJDIR)/$(USER_PARLIB_DIR)/%.o: $(USER_PARLIB_SRC_DIR)/%.S
+$(OBJDIR)/$(USER_PARLIB_SRC_DIR)/%.o: $(USER_PARLIB_SRC_DIR)/%.S
        @echo + as [PARLIB] $<
        @mkdir -p $(@D)
        $(V)$(CC) $(USER_PARLIB_SRC_CFLAGS) -c -o $@ $<
diff --git a/user/parlib/src/i386/Makefrag b/user/parlib/src/i386/Makefrag
new file mode 100644 (file)
index 0000000..93f663a
--- /dev/null
@@ -0,0 +1,15 @@
+# Makefile fragment for ROS kernel.
+# This is NOT a complete makefile;
+# you must run GNU make in the top-level directory
+# where the GNUmakefile is located.
+#
+
+USER_PARLIB_ARCH_SRC_DIR = $(USER_PARLIB_DIR)/src/$(TARGET_ARCH)
+OBJDIRS += $(USER_PARLIB_ARCH_SRC_DIR)
+
+# We also snatch the use of a couple handy source files
+# from the lib directory, to avoid gratuitous code duplication.
+USER_PARLIB_ARCH_SRCFILES := $(USER_PARLIB_ARCH_SRC_DIR)/syscall.c \
+                             $(USER_PARLIB_ARCH_SRC_DIR)/entry.S \
+                             $(USER_PARLIB_ARCH_SRC_DIR)/newlib_backend.c
+
diff --git a/user/parlib/src/sparc/Makefrag b/user/parlib/src/sparc/Makefrag
new file mode 100644 (file)
index 0000000..93f663a
--- /dev/null
@@ -0,0 +1,15 @@
+# Makefile fragment for ROS kernel.
+# This is NOT a complete makefile;
+# you must run GNU make in the top-level directory
+# where the GNUmakefile is located.
+#
+
+USER_PARLIB_ARCH_SRC_DIR = $(USER_PARLIB_DIR)/src/$(TARGET_ARCH)
+OBJDIRS += $(USER_PARLIB_ARCH_SRC_DIR)
+
+# We also snatch the use of a couple handy source files
+# from the lib directory, to avoid gratuitous code duplication.
+USER_PARLIB_ARCH_SRCFILES := $(USER_PARLIB_ARCH_SRC_DIR)/syscall.c \
+                             $(USER_PARLIB_ARCH_SRC_DIR)/entry.S \
+                             $(USER_PARLIB_ARCH_SRC_DIR)/newlib_backend.c
+
index c8aae22..fff3b07 100644 (file)
@@ -1,7 +1,8 @@
-USER_ROSLIB_DIR := $(USER_DIR)/roslib
-USER_ROSLIB_INCLUDE_DIR  := $(USER_ROSLIB_DIR)/inc
-
-include $(USER_ROSLIB_DIR)/src/Makefrag
-include $(USER_ROSLIB_DIR)/ivy/Makefrag
-
-.PRECIOUS: $(OBJDIR)/$(USER_ROSLIB_DIR)/%.o
+USER_ROSLIB_DIR := $(USER_DIR)/roslib\r
+USER_ROSLIB_INCLUDE_DIR  := $(USER_ROSLIB_DIR)/inc\r
+\r
+include $(USER_ROSLIB_DIR)/src/$(TARGET_ARCH)/Makefrag\r
+include $(USER_ROSLIB_DIR)/src/Makefrag\r
+include $(USER_ROSLIB_DIR)/ivy/Makefrag\r
+\r
+.PRECIOUS: $(OBJDIR)/$(USER_ROSLIB_DIR)/%.o\r
index 64227b3..a32d7ab 100644 (file)
@@ -14,25 +14,24 @@ USER_ROSLIB_SRC_SRCFILES := $(USER_ROSLIB_SRC_DIR)/console.c \
                             $(USER_ROSLIB_SRC_DIR)/readline.c \
                             $(USER_ROSLIB_SRC_DIR)/string.c \
                             $(USER_ROSLIB_SRC_DIR)/syscall.c \
-                            $(USER_ROSLIB_SRC_DIR)/$(TARGET_ARCH)/syscall.c \
-                            $(USER_ROSLIB_SRC_DIR)/$(TARGET_ARCH)/entry.S \
                             $(USER_ROSLIB_SRC_DIR)/asynccall.c \
                             $(USER_ROSLIB_SRC_DIR)/atomic.c \
-                            $(USER_ROSLIB_SRC_DIR)/timer.c 
+                            $(USER_ROSLIB_SRC_DIR)/timer.c \
+                            $(USER_ROSLIB_ARCH_SRCFILES)
 
 USER_ROSLIB_SRC_OBJFILES := $(patsubst $(USER_ROSLIB_SRC_DIR)/%.c, \
-                            $(OBJDIR)/$(USER_ROSLIB_DIR)/%.o,  \
+                            $(OBJDIR)/$(USER_ROSLIB_SRC_DIR)/%.o,  \
                             $(USER_ROSLIB_SRC_SRCFILES))
 USER_ROSLIB_SRC_OBJFILES := $(patsubst $(USER_ROSLIB_SRC_DIR)/%.S, \
-                            $(OBJDIR)/$(USER_ROSLIB_DIR)/%.o,  \
+                            $(OBJDIR)/$(USER_ROSLIB_SRC_DIR)/%.o,  \
                             $(USER_ROSLIB_SRC_OBJFILES))
 
-$(OBJDIR)/$(USER_ROSLIB_DIR)/%.o: $(USER_ROSLIB_SRC_DIR)/%.c
+$(OBJDIR)/$(USER_ROSLIB_SRC_DIR)/%.o: $(USER_ROSLIB_SRC_DIR)/%.c
        @echo + cc [ROSLIB] $<
        @mkdir -p $(@D)
        $(V)$(CC) $(USER_ROSLIB_SRC_CFLAGS) -c -o $@ $<
 
-$(OBJDIR)/$(USER_ROSLIB_DIR)/%.o: $(USER_ROSLIB_SRC_DIR)/%.S
+$(OBJDIR)/$(USER_ROSLIB_SRC_DIR)/%.o: $(USER_ROSLIB_SRC_DIR)/%.S
        @echo + as [ROSLIB] $<
        @mkdir -p $(@D)
        $(V)$(CC) $(USER_ROSLIB_SRC_CFLAGS) -c -o $@ $<
diff --git a/user/roslib/src/i386/Makefrag b/user/roslib/src/i386/Makefrag
new file mode 100644 (file)
index 0000000..e7baf20
--- /dev/null
@@ -0,0 +1,14 @@
+# Makefile fragment for ROS kernel.
+# This is NOT a complete makefile;
+# you must run GNU make in the top-level directory
+# where the GNUmakefile is located.
+#
+
+USER_ROSLIB_ARCH_SRC_DIR = $(USER_ROSLIB_DIR)/src/$(TARGET_ARCH)
+OBJDIRS += $(USER_ROSLIB_ARCH_SRC_DIR)
+
+# We also snatch the use of a couple handy source files
+# from the lib directory, to avoid gratuitous code duplication.
+USER_ROSLIB_ARCH_SRCFILES := $(USER_ROSLIB_ARCH_SRC_DIR)/syscall.c \
+                             $(USER_ROSLIB_ARCH_SRC_DIR)/entry.S
+
diff --git a/user/roslib/src/sparc/Makefrag b/user/roslib/src/sparc/Makefrag
new file mode 100644 (file)
index 0000000..e7baf20
--- /dev/null
@@ -0,0 +1,14 @@
+# Makefile fragment for ROS kernel.
+# This is NOT a complete makefile;
+# you must run GNU make in the top-level directory
+# where the GNUmakefile is located.
+#
+
+USER_ROSLIB_ARCH_SRC_DIR = $(USER_ROSLIB_DIR)/src/$(TARGET_ARCH)
+OBJDIRS += $(USER_ROSLIB_ARCH_SRC_DIR)
+
+# We also snatch the use of a couple handy source files
+# from the lib directory, to avoid gratuitous code duplication.
+USER_ROSLIB_ARCH_SRCFILES := $(USER_ROSLIB_ARCH_SRC_DIR)/syscall.c \
+                             $(USER_ROSLIB_ARCH_SRC_DIR)/entry.S
+