#LyX 1.2 created this file. For more info see http://www.lyx.org/
\lyxformat 220
\textclass article
+\begin_preamble
+\usepackage[colorlinks=true,linkcolor=blue]{hyperref}
+\end_preamble
\language english
\inputencoding default
\fontscheme pslatex
\layout Section
-
+\pagebreak_top
Introduction
\layout Subsection
This documentation is maintained using a freeware word processor (LyX).
\newline
This program is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the Free
- Software Foundation; either version 2, or (at your option) any later version.
+ under the terms of the GNU General Public License
+\begin_inset LatexCommand \index{GNU General Public License}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{GPL}
+
+\end_inset
+
+ as published by the Free Software Foundation; either version 2, or (at
+ your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.
If you can think of some more, please send them to the list.
\newline
-\newline
+\layout Section
-\emph on
-<pending: And then of course a proper index-table
-\begin_inset LatexCommand \index{index}
+Installation
+\begin_inset LatexCommand \index{Installation}
\end_inset
->
-\layout Section
-Installation
\layout Subsection
-Install and search paths
+Configure Options
+\begin_inset LatexCommand \index{Configure Options}
+
+\end_inset
+
+
\layout Standard
-Linux (and other gcc-builds like Solaris, Cygwin, Mingw32 and OSX) by default
- install in /usr/local.
- You can override this when configuring with ---prefix-path.
- Subdirs used will be bin, share/sdcc/include, share/sdcc/lib and share/sdcc/doc.
-\newline
-Windows MSVC and Borland builds will install in one single tree (e.g.
- /sdcc) with subdirs bin, lib, include and doc.
-\newline
+The install paths, search paths and other options are defined when running
+ 'configure'.
+ The defaults can be overriden by:
+\layout List
+\labelwidthstring 00.00.0000
+
+---prefix see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+---exec_prefix see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+---bindir see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+---datadir see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+docdir environment variable, see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+include_dir_suffix environment variable, see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+lib_dir_suffix environment variable, see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+sdccconf_h_dir_separator environment variable, either / or
+\backslash
+
+\backslash
+ makes sense here.
+ This character will only be used in sdccconf.h; don't forget it's a C-header,
+ therefore a double-backslash is needed there.
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-mcs51-port Excludes the Intel mcs51 port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-gbz80-port Excludes the Gameboy gbz80 port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-z80-port Excludes the z80 port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-avr-port Excludes the AVR port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-ds390-port Excludes the DS390 port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-pic-port Excludes the PIC port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-xa51-port Excludes the XA51 port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-ucsim Disables configuring and building of ucsim
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-device-lib-build Disables automatically building device libraries
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-packihx Disables building packihx
+\layout List
+\labelwidthstring 00.00.0000
+---enable-libgc Use the Bohem memory allocator.
+ Lower runtime footprint.
+\layout Standard
+
+Furthermore the environment variables CC, CFLAGS, ...
+ the tools and their arguments can be influenced.
+ Please see `configure ---help` and the man/info pages of `configure` for
+ details.
\newline
-The paths searched when running the compiler are as follows (the first catch
- wins):
-\layout Enumerate
-Binary files (preprocessor, assembler and linker):
\newline
-- the path of argv[0] (if available)
+The names of the standard libraries STD_LIB, STD_INT_LIB, STD_LONG_LIB,
+ STD_FP_LIB, STD_DS390_LIB, STD_XA51_LIB and the environment variables SDCC_DIR_
+NAME, SDCC_INCLUDE_NAME, SDCC_LIB_NAME are defined by `configure` too.
+ At the moment it's not possible to change the default settings (it was
+ simply never required.
\newline
-- getenv(
-\begin_inset Quotes sld
-\end_inset
-SDCC_BIN_PATH
-\begin_inset Quotes srd
-\end_inset
+\newline
+These configure options are compiled into the binaries, and can only be
+ changed by rerunning 'configure' and recompiling SDCC.
+ The configure options are written in
+\emph on
+italics
+\emph default
+ to distinguish them from run time environment variables (see section search
+ paths).
+\newline
-)
\newline
-- getenv(
+The settings for
\begin_inset Quotes sld
\end_inset
-SDCCHOME
+Win32 builds
\begin_inset Quotes srd
\end_inset
-)/bin
-\newline
-- $PATH
+ are used by the SDCC team to build the official Win32 binaries.
+ The SDCC team uses Mingw32 to build the official Windows binaries, because
+ it's
\layout Enumerate
-Include files:
-\newline
-- -I dir
+open source,
+\layout Enumerate
+
+a gcc compiler and last but not least
+\layout Enumerate
+
+the binaries can be built by cross compiling on Sourceforge's compile farm.
+\layout Standard
+
+See the examples, how to pass the Win32 settings to 'configure'.
+ The other Win32 builds using Borland, VC or whatever don't use 'configure',
+ but a header file sdcc_vc_in.h is the same as sdccconf.h built by 'configure'
+ for Win32.
\newline
-- getenv(
-\begin_inset Quotes sld
-\end_inset
-SDCC_INCLUDE_PATH
-\begin_inset Quotes srd
-\end_inset
+\newline
+These defaults are:
+\newline
-)
\newline
-- getenv(
-\begin_inset Quotes sld
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="8" columns="3">
+<features>
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" rightline="true" width="0in">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Variable
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-SDCCHOME
-\begin_inset Quotes srd
+\layout Standard
+
+default
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-)/include
-\newline
-- /usr/local/share/sdcc/include (gcc builds)
-\newline
-- path(arv[0])/../include and then /sdcc/include (as a last resort for windoze
- msvc and borland builds)
-\layout Enumerate
+\layout Standard
-Library files (the
-\shape italic
-model
-\shape default
- is auto-appended by the compiler, e.g.
- small, large, z80, ds390 etc.):
-\newline
-- -L dir
-\newline
-- getenv(
-\begin_inset Quotes sld
+Win32 builds
\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-SDCC_LIB_PATH
-\begin_inset Quotes srd
+\layout Standard
+
+
+\emph on
+PREFIX
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-)/
-\shape italic
-model
-\shape default
+\layout Standard
-\newline
-- getenv(
-\begin_inset Quotes sld
+/usr/local
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-SDCCHOME
-\begin_inset Quotes srd
+\layout Standard
+
+
+\backslash
+sdcc
\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-)/lib/
-\shape italic
-model
-\shape default
+\layout Standard
-\newline
-- /usr/local/share/sdcc/lib/
-\shape italic
-model
-\shape default
- (gcc builds)
-\newline
-- path(argv[0])/../lib/
-\shape italic
-model
-\shape default
- and then /sdcc/lib/
-\shape italic
-model
-\shape default
- (as a last resort for windoze msvc and borland builds)
-\layout Enumerate
-Documentation (although never really searched for, you have to do that yourself
- :):
-\newline
-- getenv(
-\begin_inset Quotes sld
+\emph on
+EXEC_PREFIX
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-SDCCHOME
-\begin_inset Quotes srd
+\layout Standard
+
+
+\emph on
+$PREFIX
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-)/doc
-\newline
-- /usr/local/share/sdcc/doc (gcc builds)
-\newline
-- /sdcc/doc (windoze msvc and borland builds)
\layout Standard
-So, for windoze it is highly recommended to set the environment variable
- SDCCHOME to prevent needless usage of -I and -L options.
- For gcc-builds SDCCHOME should only be set when sdcc is installed in non-standa
-rd paths.
-\layout Subsection
-Linux and other gcc-based systems (cygwin, mingw32, osx)
-\layout Enumerate
+\emph on
+$PREFIX
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+\layout Standard
-\series medium
-Download the source package
-\series default
- either from the SDCC CVS repository or from the
-\begin_inset LatexCommand \url[nightly snapshots]{http://sdcc.sourceforge.net/snap.php}
+\emph on
+BINDIR
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+\layout Standard
-\series medium
-, it will be named something like sdcc
-\series default
-.src
-\series medium
-.tgz.
-\layout Enumerate
+\emph on
+$EXECPREFIX
+\emph default
+/bin
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-\series medium
-Bring up a command line terminal, such as xterm.
-\layout Enumerate
+\layout Standard
-\series medium
-Unpack the file using a command like:
-\family sans
-\series bold
-"tar -xzf sdcc.src.tgz
-\family default
-\series default
-"
-\series medium
-, this will create a sub-directory called sdcc with all of the sources.
-\layout Enumerate
+\emph on
+$EXECPREFIX
+\emph default
-Change directory into the main SDCC directory, for example type:
+\backslash
+bin
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+DATADIR
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$PREFIX
+\emph default
+/share
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$PREFIX
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+DOCDIR
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$DATADIR
+\emph default
+/sdcc/doc
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$DATADIR
+\emph default
+
+\backslash
+doc
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+INCLUDE_DIR_SUFFIX
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+sdcc/include
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+include
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+LIB_DIR_SUFFIX
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+sdcc/lib
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+lib
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\newline
+
+\newline
+
+\newline
+'configure' also computes relative paths.
+ This is needed for full relocatability of a binary package and to complete
+ search paths (see section search paths below):
+\newline
+
+\newline
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="4" columns="3">
+<features>
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" rightline="true" width="0in">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Variable (computed)
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+default
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Win32 builds
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+BIN2DATA_DIR
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+../share
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+..
+\backslash
+
+\end_inset
+</cell>
+</row>
+<row bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+PREFIX2BIN_DIR
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+bin
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+bin
+\end_inset
+</cell>
+</row>
+<row bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+PREFIX2DATA_DIR
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+share/sdcc
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\newline
+
+\newline
+Examples:
+\layout LyX-Code
+
+./configure
+\layout LyX-Code
+
+./configure ---prefix=
+\begin_inset Quotes srd
+\end_inset
+
+/usr/bin
+\begin_inset Quotes srd
+\end_inset
+
+ ---datadir=
+\begin_inset Quotes srd
+\end_inset
+
+/usr/share
+\begin_inset Quotes srd
+\end_inset
+
+
+\layout LyX-Code
+
+./configure ---disable-avr-port ---disable-xa51-port
+\layout Standard
+
+To crosscompile on linux for Mingw32 (see also 'sdcc/support/scripts/sdcc_mingw3
+2'):
+\layout LyX-Code
+
+./configure
+\backslash
+
+\layout LyX-Code
+
+ CC=
+\begin_inset Quotes srd
+\end_inset
+
+i586-mingw32msvc-gcc
+\begin_inset Quotes srd
+\end_inset
+
+ CXX=
+\begin_inset Quotes srd
+\end_inset
+
+i586-mingw32msvc-g++
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ RANLIB=
+\begin_inset Quotes srd
+\end_inset
+
+i586-mingw32msvc-ranlib
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ STRIP=
+\begin_inset Quotes srd
+\end_inset
+
+i586-mingw32msvc-strip
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ ---prefix=
+\begin_inset Quotes srd
+\end_inset
+
+/sdcc
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ ---datadir=
+\begin_inset Quotes srd
+\end_inset
+
+/sdcc
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ docdir=
+\begin_inset Quotes srd
+\end_inset
+
+/sdcc/doc
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ include_dir_suffix=
+\begin_inset Quotes srd
+\end_inset
+
+include
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ lib_dir_suffix=
+\begin_inset Quotes srd
+\end_inset
+
+lib
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ sdccconf_h_dir_separator=
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\backslash
+
+\backslash
+
+\backslash
+
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ ---disable-device-lib-build
+\backslash
+
+\layout LyX-Code
+
+ ---disable-ucsim
+\backslash
+
+\layout LyX-Code
+
+ ---host=i586-mingw32msvc ---build=unknown-unknown-linux-gnu
+\layout Standard
+
+To
+\begin_inset Quotes sld
+\end_inset
+
+cross
+\begin_inset Quotes srd
+\end_inset
+
+compile on Cygwin for Mingw32(see also sdcc/support/scripts/sdcc_cygwin_mingw32)
+:
+\layout LyX-Code
+
+./configure -C
+\backslash
+
+\layout LyX-Code
+
+ CFLAGS=
+\begin_inset Quotes srd
+\end_inset
+
+-mno-cygwin -O2
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ LDFLAGS=
+\begin_inset Quotes srd
+\end_inset
+
+-mno-cygwin
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ ---prefix=
+\begin_inset Quotes srd
+\end_inset
+
+/sdcc
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ ---datadir=
+\begin_inset Quotes srd
+\end_inset
+
+/sdcc
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ docdir=
+\begin_inset Quotes srd
+\end_inset
+
+/sdcc/doc
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ include_dir_suffix=
+\begin_inset Quotes srd
+\end_inset
+
+include
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ lib_dir_suffix=
+\begin_inset Quotes srd
+\end_inset
+
+lib
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ sdccconf_h_dir_separator=
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\backslash
+
+\backslash
+
+\backslash
+
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ ---disable-ucsim
+\layout Standard
+
+'configure' is quite slow on Cygwin (at least on windows before Win2000/XP).
+ The option '--C' turns on caching, which gives a little bit extra speed.
+ However if options are changed, it can be necessary to delete the config.cache
+ file.
+\layout Subsection
+
+Install paths
+\begin_inset LatexCommand \index{Install paths}
+
+\end_inset
+
+
+\layout Standard
+
+1.
+ Binary files (preprocessor, assembler and linker)
+\layout Standard
+
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="2" columns="3">
+<features>
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" rightline="true" width="0in">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Path
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+default
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Win32 builds
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$EXEC_PREFIX
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+/usr/local/bin
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\backslash
+sdcc
+\backslash
+bin
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\newline
+
+\newline
+2.
+ Include files
+\layout Standard
+
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="2" columns="3">
+<features>
+<column alignment="block" valignment="top" leftline="true" width="1.6in">
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="center" valignment="top" leftline="true" rightline="true" width="0in">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Path
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+default
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Win32 builds
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$DATADIR/
+\newline
+$INCLUDE_DIR_SUFFIX
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+/usr/local/share/sdcc/include
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\backslash
+sdcc
+\backslash
+include
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\newline
+
+\newline
+3.
+ Library files (the
+\shape italic
+model
+\shape default
+ is auto-appended by the compiler, e.g.
+ small, large, z80, ds390 etc.)
+\layout Standard
+
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="2" columns="3">
+<features>
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" rightline="true" width="0in">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Path
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+default
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Win32 builds
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$DATADIR/$LIB_DIR_SUFFIX
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+/usr/local/share/sdcc/lib
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\backslash
+sdcc
+\backslash
+lib
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\newline
+
+\newline
+4.
+ Documentation
+\layout Standard
+
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="2" columns="3">
+<features>
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" rightline="true" width="0in">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Path
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+default
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Win32 builds
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$DOCDIR
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+/usr/local/share/sdcc/doc
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\backslash
+sdcc
+\backslash
+doc
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\newline
+
+\newline
+The install paths can still be changed during `make install` with e.g.:
+\layout LyX-Code
+
+make install prefix=$(HOME)/local/sdcc
+\layout Standard
+
+Of course this doesn't change the search paths compiled into the binaries.
+\layout Subsection
+
+Search Paths
+\begin_inset LatexCommand \index{Search Paths}
+
+\end_inset
+
+
+\layout Standard
+
+Some search paths or parts of them are determined by configure variables
+ (in
+\emph on
+italics
+\emph default
+, see section above).
+ Further search paths are determined by environment variables during runtime.
+
+\newline
+The paths searched when running the compiler are as follows (the first catch
+ wins):
+\newline
+
+\newline
+1.
+ Binary files (preprocessor, assembler and linker)
+\newline
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="4" columns="3">
+<features>
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" rightline="true" width="0in">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Search path
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+default
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Win32 builds
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_HOME/
+\emph on
+$PPREFIX2BIN_DIR
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_HOME/bin
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_HOME
+\backslash
+bin
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Path of argv[0] (if available)
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Path of argv[0]
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Path of argv[0]
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$PATH
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$PATH
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$PATH
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\newline
+
+\newline
+2.
+ Include files
+\newline
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="6" columns="3">
+<features>
+<column alignment="block" valignment="top" leftline="true" width="1.5in">
+<column alignment="block" valignment="top" leftline="true" width="1.5in">
+<column alignment="left" valignment="top" leftline="true" rightline="true" width="0in">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Search path
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+default
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Win32 builds
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+---I dir
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+---I dir
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+---I dir
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_INCLUDE
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_INCLUDE
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_INCLUDE
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_HOME/
+\newline
+
+\emph on
+$PREFIX2DATA_DIR/
+\newline
+$INCLUDE_DIR_SUFFIX
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_ HOME/
+\newline
+share/sdcc/
+\newline
+include
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_HOME
+\backslash
+include
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+path(argv[0])/
+\newline
+
+\emph on
+$BIN2DATADIR/
+\emph default
+
+\newline
+
+\emph on
+$INCLUDE_DIR_SUFFIX
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+path(argv[0])/
+\newline
+../sdcc/include
+\newline
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+path(argv[0])
+\backslash
+..
+\backslash
+include
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$DATADIR/
+\emph default
+
+\newline
+
+\emph on
+$INCLUDE_DIR_SUFFIX
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+/usr/local/share/sdcc/
+\newline
+include
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+(not on Win32)
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\newline
+
+\newline
+ The option ---nostdinc disables the last two search paths.
+\newline
+
+\newline
+3.
+ Library files
+\newline
+With the exception of
+\begin_inset Quotes sld
+\end_inset
+
+---L dir
+\begin_inset Quotes srd
+\end_inset
+
+ the
+\shape italic
+model
+\shape default
+ is auto-appended by the compiler (e.g.
+ small, large, z80, ds390 etc.).
+
+\newline
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="6" columns="3">
+<features>
+<column alignment="block" valignment="top" leftline="true" width="1.7in">
+<column alignment="left" valignment="top" leftline="true" width="1.2in">
+<column alignment="block" valignment="top" leftline="true" rightline="true" width="1.2in">
+<row topline="true" bottomline="true">
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Search path
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+default
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Win32 builds
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+---L dir
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+---L dir
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+---L dir
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_LIB/
+\newline
+
+\emph on
+<model>
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_LIB/
+\newline
+
+\emph on
+<model>
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_LIB
+\backslash
+
+\newline
+
+\emph on
+<model>
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_HOME/
+\newline
+
+\emph on
+$PREFIX2DATA_DIR/
+\newline
+$LIB_DIR_SUFFIX/<model>
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_HOME/
+\newline
+share/sdcc/
+\newline
+lib/
+\emph on
+<model>
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+$SDCC_HOME
+\backslash
+lib
+\backslash
+
+\emph on
+
+\newline
+<model>
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+path(argv[0])/
+\newline
+
+\emph on
+$BIN2DATADIR/
+\emph default
+
+\newline
+
+\emph on
+$LIB_DIR_SUFFIX/<model>
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+path(argv[0])/
+\newline
+../sdcc/lib/
+\emph on
+<model>
+\newline
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+path(argv[0])
+\backslash
+
+\newline
+..
+\backslash
+lib
+\backslash
+
+\emph on
+<model>
+\newline
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$DATADIR/
+\newline
+$LIB_DIR_SUFFIX/<model>
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+/usr/local/share/sdcc/
+\newline
+lib/
+\emph on
+<model>
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+(not on Win32)
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\layout Comment
+
+Don't delete any of the stray spaces in the table above without checking
+ the HTML output (last line)!
+\layout Standard
+
+\SpecialChar ~
+
+\newline
+The option ---nostdlib disables the last two search paths.
+\layout Subsection
+
+Building SDCC
+\begin_inset LatexCommand \index{Building SDCC}
+
+\end_inset
+
+
+\layout Subsubsection
+
+Building SDCC on Linux
+\layout Enumerate
+
+
+\series medium
+Download the source package
+\series default
+ either from the SDCC CVS repository or from the
+\begin_inset LatexCommand \url[nightly snapshots]{http://sdcc.sourceforge.net/snap.php}
+
+\end_inset
+
+
+\series medium
+, it will be named something like sdcc
+\series default
+.src
+\series medium
+.t
+\series default
+ar.
+\series medium
+gz.
+\layout Enumerate
+
+
+\series medium
+Bring up a command line terminal, such as xterm.
+\layout Enumerate
+
+
+\series medium
+Unpack the file using a command like:
+\family sans
+\series bold
+"tar -xzf sdcc.src.tar.gz
+\family default
+\series default
+"
+\series medium
+, this will create a sub-directory called sdcc with all of the sources.
+\layout Enumerate
+
+Change directory into the main SDCC directory, for example type:
\family sans
\series bold
"cd sdcc
\layout Enumerate
-\series medium
-Type
-\family sans
-\series bold
-"./configure
-\family default
-\series default
-".
- This configures the package for compilation on your system.
-\layout Enumerate
+\series medium
+Type
+\family sans
+\series bold
+"./configure
+\family default
+\series default
+".
+ This configures the package for compilation on your system.
+\layout Enumerate
+
+
+\series medium
+Type
+\family sans
+\series bold
+"make
+\family default
+\series default
+"
+\series medium
+.
+
+\series default
+ All of the source packages will compile, this can take a while.
+\layout Enumerate
+
+
+\series medium
+Type
+\family sans
+\series bold
+"make install"
+\family default
+\series default
+ as root
+\series medium
+.
+
+\series default
+ This copies the binary executables, the include files, the libraries and
+ the documentation to the install directories.
+\layout Subsubsection
+
+Building SDCC on OSX 2.x
+\layout Standard
+
+Follow the instruction for Linux.
+\newline
+
+\newline
+On OSX 2.x it was reported, that the default gcc (version 3.1 20020420 (prerelease
+)) fails to compile SDCC.
+ Fortunately there's also gcc 2.9.x installed, which works fine.
+ This compiler can be selected by running 'configure' with:
+\layout LyX-Code
+
+./configure CC=gcc2 CXX=g++2
+\layout Subsubsection
+
+Crosscompiling SDCC on Linux for Windows
+\layout Standard
+
+With the Mingw32 gcc crosscompiler it's easy to compile SDCC for Win32.
+ See section 'Configure Options'.
+\layout Subsubsection
+
+Building SDCC on Windows
+\layout Standard
+
+With the exception of Cygwin the SDCC binaries uCsim and sdcdb can't be
+ built on Windows.
+ They use Unix-sockets, which are not available on Win32.
+\layout Subsubsection
+
+Windows Install Using a Binary Package
+\layout Enumerate
+
+Download the binary package and unpack it using your favorite unpacking
+ tool (gunzip, WinZip, etc).
+ This should unpack to a group of sub-directories.
+ An example directory structure after unpacking the mingw32 package is:
+ c:
+\backslash
+sdcc
+\backslash
+bin for the executables, c:
+\backslash
+sdcc
+\backslash
+include and c:
+\backslash
+sdcc
+\backslash
+lib for the include and libraries.
+\layout Enumerate
+
+Adjust your environment variable PATH to include the location of the bin
+ directory or start sdcc using the full path.
+\layout Subsubsection
+
+Building SDCC using Cygwin and Mingw32
+\layout Standard
+
+For building and installing a Cygwin executable follow the instructions
+ for Linux.
+\newline
+
+\newline
+On Cygwin a
+\begin_inset Quotes sld
+\end_inset
+
+native
+\begin_inset Quotes srd
+\end_inset
+
+ Win32-binary can be built, which will not need the Cygwin-DLL.
+ For the necessary 'configure' options see section 'configure options' or
+ the script 'sdcc/support/scripts/sdcc_cygwinmingw32'.
+\newline
+
+\newline
+In order to install Cygwin on Windows download setup.exe from
+\begin_inset LatexCommand \url[www.cygwin.com]{http://www.cygwin.com/}
+
+\end_inset
+
+.
+ Run it, set the
+\begin_inset Quotes sld
+\end_inset
+
+default text file type
+\begin_inset Quotes srd
+\end_inset
+
+ to
+\begin_inset Quotes sld
+\end_inset
+
+unix
+\begin_inset Quotes srd
+\end_inset
+
+ and download/install at least the following packages.
+ Some packages are selected by default, others will be automatically selected
+ because of dependencies with the manually selected packages.
+ Never deselect these packages!
+\layout Itemize
+
+flex
+\layout Itemize
+
+bison
+\layout Itemize
+
+gcc ; version 3.x is fine, no need to use the old 2.9x
+\layout Itemize
+
+binutils ; selected with gcc
+\layout Itemize
+
+make
+\layout Itemize
+
+rxvt ; a nice console, which makes life much easier under windoze (see below)
+\layout Itemize
+
+man ; not really needed for building SDCC, but you'll miss it sooner or
+ later
+\layout Itemize
+
+less ; not really needed for building SDCC, but you'll miss it sooner or
+ later
+\layout Itemize
+
+cvs ; only if you use CVS access
+\layout Standard
+
+If you want to develop something you'll need:
+\layout Itemize
+
+python ; for the regression tests
+\layout Itemize
+
+gdb ; the gnu debugger, together with the nice GUI
+\begin_inset Quotes sld
+\end_inset
+
+insight
+\begin_inset Quotes srd
+\end_inset
+
+
+\layout Itemize
+
+openssh ; to access the CF or commit changes
+\layout Itemize
+autoconf and autoconf-devel ; if you want to fight with 'configure', don't
+ use autoconf-stable!
+\layout Standard
-\series medium
-Type
-\family sans
-\series bold
-"make
-\family default
-\series default
-"
-\series medium
-.
+rxvt is a nice console with history.
+ Replace in your cygwin.bat the line
+\layout LyX-Code
-\series default
- All of the source packages will compile, this can take a while.
-\layout Enumerate
+bash --login -i
+\layout Standard
+with (one line):
+\layout LyX-Code
-\series medium
-Type
-\family sans
-\series bold
-"make install"
-\family default
-\series default
- as root
-\series medium
-.
+rxvt -sl 1000 -fn "Lucida Console-12" -sr -cr red
+\layout LyX-Code
-\series default
- This copies the binary executables, the include files, the libraries and
- the documentation to the install directories.
-\layout Subsection
+ -bg black -fg white -geometry 100x65 -e bash --login
+\layout Standard
-Windows
-\layout Subsubsection
+Text selected with the mouse is automatically copied to the clipboard, pasting
+ works with shift-insert.
+\newline
-Windows Install Using a Binary Package
-\layout Enumerate
+\newline
+The other good tip is to make sure you have no //c/-style paths anywhere,
+ use /cygdrive/c/ instead.
+ Using // invokes a network lookup which is very slow.
+ If you think
+\begin_inset Quotes sld
+\end_inset
-Download the binary package and unpack it using your favorite unpacking
- tool (gunzip, WinZip, etc).
- This should unpack to a group of sub-directories.
- An example directory structure after unpacking the mingw32 package is:
- c:
-\backslash
-usr
-\backslash
-local
-\backslash
-bin for the executables, c:
-\backslash
-usr
-\backslash
-local
-\backslash
-share
-\backslash
-sdcc
-\backslash
-include and c:
-\backslash
-usr
-\backslash
-local
-\backslash
-share
-\backslash
-sdcc
-\backslash
-lib for the include and libraries.
-\layout Enumerate
+cygdrive
+\begin_inset Quotes srd
+\end_inset
-Adjust your environment variable PATH to include the location of the bin
- directory or start sdcc using the full path.
-\layout Subsubsection
+ is too long, you can change it with e.g.
+\layout LyX-Code
-Windows Install Using Cygwin and Mingw32
+mount -s -u -c /mnt
\layout Standard
-Follow the instruction in
-\series bold
-Linux and other gcc-based systems
-\series default
-.
+SDCC sources use the unix line ending LF.
+ Life is much easier, if you store the source tree on a drive, which is
+ mount in binary mode.
+ And use an editor which can handle LF-only line endings.
+ Make sure not to commit files with windows line endings.
\layout Subsubsection
Windows Install Using Microsoft Visual C++ 6.0/NET
\newline
\newline
-Download the file UnxUtils.zip.
+Download the file UnxUtils
+\begin_inset LatexCommand \index{UnxUtils}
+
+\end_inset
+
+.zip.
Now you have to install the utilities and setup Visual C++ so it can locate
the required programs.
Here there are two alternatives (choose one!):
from the sdcc directory.
\layout Subsection
+Building the Documentation
+\layout Standard
+
+...
+ coming soon
+\layout Subsection
+
Testing out the SDCC Compiler
\layout Standard
\family sans
\series bold
"sdcc ---version"
+\begin_inset LatexCommand \index{version}
+
+\end_inset
+
+
\family default
\series default
at the prompt, and the program should run and tell you the version.
\layout Subsection
Install Trouble-shooting
+\begin_inset LatexCommand \index{Install Trouble-shooting}
+
+\end_inset
+
+
\layout Subsubsection
SDCC does not build correctly.
A thing to try is starting from scratch by unpacking the .tgz source package
again in an empty directory.
- Confure it like:
+ Configure it like:
\newline
\newline
\layout Subsubsection
s51 - The Simulator
+\begin_inset LatexCommand \index{s51 - The Simulator}
+
+\end_inset
+
+
\layout Standard
S51 is a freeware, opensource simulator developed by Daniel Drotos (
\newline
\newline
-sourcefile.asm - Assembler source file created by the compiler
+sourcefile.asm
+\begin_inset LatexCommand \index{.asm}
+
+\end_inset
+
+ - Assembler source file created by the compiler
+\newline
+sourcefile.lst
+\begin_inset LatexCommand \index{.lst}
+
+\end_inset
+
+ - Assembler listing file created by the Assembler
+\newline
+sourcefile.rst
+\begin_inset LatexCommand \index{.rst}
+
+\end_inset
+
+ - Assembler listing file updated with linkedit information, created by
+ linkage editor
+\newline
+sourcefile.sym
+\begin_inset LatexCommand \index{.sym}
+
+\end_inset
+
+ - symbol listing for the sourcefile, created by the assembler
\newline
-sourcefile.lst - Assembler listing file created by the Assembler
+sourcefile.rel
+\begin_inset LatexCommand \index{.rel}
+
+\end_inset
+
+ - Object file created by the assembler, input to Linkage editor
\newline
-sourcefile.rst - Assembler listing file updated with linkedit information,
- created by linkage editor
+sourcefile.map
+\begin_inset LatexCommand \index{.map}
+
+\end_inset
+
+ - The memory map for the load module, created by the Linker
\newline
-sourcefile.sym - symbol listing for the sourcefile, created by the assembler
+sourcefile.mem
+\begin_inset LatexCommand \index{.mem}
+
+\end_inset
+
+ - A file with a summary of the memory ussage
\newline
-sourcefile.rel - Object file created by the assembler, input to Linkage editor
+sourcefile.ihx
+\begin_inset LatexCommand \index{.ihx}
+
+\end_inset
+
+ - The load module in Intel hex format (you can select the Motorola S19
+ format with ---out-fmt-s19)
\newline
-sourcefile.map - The memory map for the load module, created by the Linker
+sourcefile.adb
+\begin_inset LatexCommand \index{.adb}
+
+\end_inset
+
+ - An intermediate file containing debug information needed to create the
+ .cdb file (with ---debug)
\newline
-sourcefile.ihx - The load module in Intel hex format (you can select the
- Motorola S19 format with ---out-fmt-s19)
+sourcefile.cdb
+\begin_inset LatexCommand \index{.cdb}
+
+\end_inset
+
+ - An optional file (with ---debug) containing debug information
\newline
-sourcefile.cdb - An optional file (with ---debug) containing debug information
+sourcefile.
+ - (no extension)
+\begin_inset LatexCommand \index{. (no extension)}
+
+\end_inset
+
+ An optional AOMF51 file containing debug information (with ---debug)
\newline
-sourcefile.dump* - Dump file to debug the compiler it self (with ---dumpall)
- (see section
+sourcefile.dump*
+\begin_inset LatexCommand \index{.dump*}
+
+\end_inset
+
+ - Dump file to debug the compiler it self (with ---dumpall) (see section
+
\begin_inset Quotes sld
\end_inset
\layout Subsubsection
Projects with Additional Libraries
+\begin_inset LatexCommand \index{Libraries}
+
+\end_inset
+
+
\layout Standard
Some reusable routines may be compiled into a library, see the documentation
for how to create a
\emph on
.lib
+\begin_inset LatexCommand \index{.lib}
+
+\end_inset
+
+
\emph default
library file.
Libraries created in this manner can be included in the command line.
\layout Subsection
Command Line Options
+\begin_inset LatexCommand \index{Command Line Options}
+
+\end_inset
+
+
\layout Subsubsection
Processor Selection Options
+\begin_inset LatexCommand \index{Processor Selection Options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
-mmcs51
+\begin_inset LatexCommand \index{-mmcs51}
+
+\end_inset
+
+
\series default
Generate code for the MCS51 (8051) family of processors.
This is the default processor target.
\series bold
-mds390
+\begin_inset LatexCommand \index{-mds390}
+
+\end_inset
+
+
\series default
Generate code for the DS80C390 processor.
\layout List
\series bold
-mz80
+\begin_inset LatexCommand \index{-mz80}
+
+\end_inset
+
+
\series default
Generate code for the Z80 family of processors.
\layout List
\series bold
-mgbz80
+\begin_inset LatexCommand \index{-mgbz80}
+
+\end_inset
+
+
\series default
Generate code for the GameBoy Z80 processor.
\layout List
\series bold
-mavr
+\begin_inset LatexCommand \index{-mavr}
+
+\end_inset
+
+
\series default
Generate code for the Atmel AVR processor (In development, not complete).
\layout List
\series bold
-mpic14
+\begin_inset LatexCommand \index{-mpic14}
+
+\end_inset
+
+
\series default
Generate code for the PIC 14-bit processors (In development, not complete).
\layout List
\series bold
-mxa51
+\begin_inset LatexCommand \index{-mxa51}
+
+\end_inset
+
+
\series default
Generate code for the Philips XA51 processor (In development, not complete).
\layout Subsubsection
Preprocessor Options
+\begin_inset LatexCommand \index{Options Preprocessor}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Preprocessor Options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
-I<path>
+\begin_inset LatexCommand \index{-I<path>}
+
+\end_inset
+
+
\series default
The additional location where the pre processor will look for <..h> or
\begin_inset Quotes eld
\series bold
-D<macro[=value]>
+\begin_inset LatexCommand \index{-D<macro[=value]>}
+
+\end_inset
+
+
\series default
Command line definition of macros.
Passed to the pre processor.
\series bold
-M
+\begin_inset LatexCommand \index{-M}
+
+\end_inset
+
+
\series default
Tell the preprocessor to output a rule suitable for make describing the
dependencies of each object file.
\series bold
-C
+\begin_inset LatexCommand \index{-C}
+
+\end_inset
+
+
\series default
Tell the preprocessor not to discard comments.
Used with the `-E' option.
\series bold
-MM
+\begin_inset LatexCommand \index{-MM}
+
+\end_inset
+
+
\size large
\bar under
\series bold
-Aquestion(answer)
+\begin_inset LatexCommand \index{-Aquestion(answer)}
+
+\end_inset
+
+
\series default
Assert the answer answer for question, in case it is tested with a preprocessor
conditional such as `#if #question(answer)'.
\series bold
-Umacro
+\begin_inset LatexCommand \index{-Umacro}
+
+\end_inset
+
+
\series default
Undefine macro macro.
`-U' options are evaluated after all `-D' options, but before any `-include'
\series bold
-dM
+\begin_inset LatexCommand \index{-dM}
+
+\end_inset
+
+
\series default
Tell the preprocessor to output only a list of the macro definitions that
are in effect at the end of preprocessing.
\series bold
-dD
+\begin_inset LatexCommand \index{-dD}
+
+\end_inset
+
+
\series default
Tell the preprocessor to pass all macro definitions into the output, in
their proper sequence in the rest of the output.
\series bold
-dN
+\begin_inset LatexCommand \index{-dN}
+
+\end_inset
+
+
\size large
\bar under
\layout Subsubsection
Linker Options
+\begin_inset LatexCommand \index{Options Linker}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Linker Options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
-L\SpecialChar ~
---lib-path
+\begin_inset LatexCommand \index{-L ---lib-path}
+
+\end_inset
+
+
\bar under
\series default
\series bold
---xram-loc
\series default
+
+\begin_inset LatexCommand \index{---xram-loc}
+
+\end_inset
+
<Value> The start location of the external ram, default value is 0.
The value entered can be in Hexadecimal or Decimal format, e.g.: ---xram-loc
0x8000 or ---xram-loc 32768.
\series bold
---code-loc
\series default
+
+\begin_inset LatexCommand \index{---code-loc}
+
+\end_inset
+
<Value> The start location of the code segment, default value 0.
Note when this option is used the interrupt vector table is also relocated
to the given address.
\series bold
---stack-loc
\series default
+
+\begin_inset LatexCommand \index{---stack-loc}
+
+\end_inset
+
<Value> By default the stack is placed after the data segment.
Using this option the stack can be placed anywhere in the internal memory
space of the 8051.
\series bold
---data-loc
\series default
+
+\begin_inset LatexCommand \index{---data-loc}
+
+\end_inset
+
<Value> The start location of the internal ram data segment.
The value entered can be in Hexadecimal or Decimal format, eg.
---data-loc 0x20 or ---data-loc 32.
\series bold
---idata-loc
\series default
+
+\begin_inset LatexCommand \index{---idata-loc}
+
+\end_inset
+
<Value> The start location of the indirectly addressable internal ram, default
value is 0x80.
The value entered can be in Hexadecimal or Decimal format, eg.
\series bold
---out-fmt-ihx
+\begin_inset LatexCommand \index{---out-fmt-ihx}
+
+\end_inset
+
+
\bar under
\series default
\series bold
---out-fmt-s19
+\begin_inset LatexCommand \index{---out-fmt-s19}
+
+\end_inset
+
+
\bar under
\series default
\layout Subsubsection
MCS51 Options
+\begin_inset LatexCommand \index{Options MCS51}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{MCS51 Options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
---model-large
+\begin_inset LatexCommand \index{---model-large}
+
+\end_inset
+
+
\series default
Generate code for Large model programs see section Memory Models for more
details.
\series bold
---model-small
+\begin_inset LatexCommand \index{---model-small}
+
+\end_inset
+
+
\series default
\size large
\emph on
\layout Subsubsection
DS390 Options
+\begin_inset LatexCommand \index{Options DS390}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{DS390 Options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
---model-flat24
\series default
+
+\begin_inset LatexCommand \index{---model-flat24}
+
+\end_inset
+
+
\size large
\emph on
\series bold
---stack-10bit
\series default
+
+\begin_inset LatexCommand \index{--stack-10bit}
+
+\end_inset
+
Generate code for the 10 bit stack mode of the Dallas DS80C390 part.
This is the one and only that the ds390 code generator supports right now
and is default when using
\layout Subsubsection
Optimization Options
+\begin_inset LatexCommand \index{Options Optimization}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Optimization Options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
---nogcse
+\begin_inset LatexCommand \index{---nogcse}
+
+\end_inset
+
+
\series default
Will not do global subexpression elimination, this option may be used when
the compiler creates undesirably large stack/data spaces to store compiler
\series bold
---noinvariant
+\begin_inset LatexCommand \index{---noinvariant}
+
+\end_inset
+
+
\series default
Will not do loop invariant optimizations, this may be turned off for reasons
explained for the previous option.
\series bold
---noinduction
+\begin_inset LatexCommand \index{---noinduction}
+
+\end_inset
+
+
\series default
Will not do loop induction optimizations, see section strength reduction
for more details.It is recommended that this option is NOT used, #pragma\SpecialChar ~
\series bold
---nojtbound
+\begin_inset LatexCommand \index{---nojtbound}
+
+\end_inset
+
+
\size large
\bar under
\series bold
---noloopreverse
+\begin_inset LatexCommand \index{---noloopreverse}
+
+\end_inset
+
+
\series default
\size large
\layout List
\labelwidthstring 00.00.0000
+---
+\series bold
+nolabelopt
+\series default
+
+\begin_inset LatexCommand \index{---nolabelopt }
+
+\end_inset
+
+Will not optimize labels (makes the dumpfiles more readable).
+\layout List
+\labelwidthstring 00.00.0000
+
\series bold
---no-xinit-opt
+\begin_inset LatexCommand \index{---no-xinit-opt}
+
+\end_inset
+
+
\series default
- This will disable the memcpy of initialized data in far space from code
- space
+ Will not memcpy initialized data in far space from code space.
+ This saves a few bytes in code space if you don't have initialized data.
\layout Subsubsection
Other Options
+\begin_inset LatexCommand \index{Options other}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Other Options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
-c\SpecialChar ~
---compile-only
+\begin_inset LatexCommand \index{---compile-only}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{-c ---compile-only}
+
+\end_inset
+
+
\series default
will compile and assemble the source, but will not call the linkage editor.
\layout List
\labelwidthstring 00.00.0000
+\series bold
+--c1mode
+\begin_inset LatexCommand \index{--c1mode}
+
+\end_inset
+
+
+\series default
+ reads the preprocessed source from standard input and compiles it.
+ The file name for the assembler output must be specified using the -o option.
+\layout List
+\labelwidthstring 00.00.0000
+
+
\series bold
-E
+\begin_inset LatexCommand \index{-E}
+
+\end_inset
+
+
\series default
Run only the C preprocessor.
Preprocess all the C source files specified and output the results to standard
\series bold
-o\SpecialChar ~
-<path/file>
+<path/file>
+\begin_inset LatexCommand \index{-o <path/file>}
+
+\end_inset
+
+
\series default
The output path resp.
file where everything will be placed.
\series bold
---stack-auto
+\begin_inset LatexCommand \index{---stack-auto}
+
+\end_inset
+
+
\series default
\size large
\emph on
\series bold
---xstack
+\begin_inset LatexCommand \index{---xstack}
+
+\end_inset
+
+
\series default
Uses a pseudo stack in the first 256 bytes in the external ram for allocating
variables and passing parameters.
\series bold
----callee-saves function1[,function2][,function3]....
+---callee-saves
+\begin_inset LatexCommand \index{---callee-saves}
+
+\end_inset
+
+ function1[,function2][,function3]....
\series default
The compiler by default uses a caller saves convention for register saving
If the project consists of multiple source files then all the source file
should be compiled with the same ---callee-saves option string.
Also see #pragma\SpecialChar ~
-CALLEE-SAVES.
+CALLEE-SAVES
+\begin_inset LatexCommand \index{\#pragma CALLEE-SAVES}
+
+\end_inset
+
+.
\layout List
\labelwidthstring 00.00.0000
\series bold
---debug
+\begin_inset LatexCommand \index{---debug}
+
+\end_inset
+
+
\bar under
\series default
\series bold
---peep-file
\series default
+
+\begin_inset LatexCommand \index{---peep-file}
+
+\end_inset
+
<filename> This option can be used to use additional rules to be used by
the peep hole optimizer.
See section Peep Hole optimizations for details on how to write these rules.
\series bold
-S
+\begin_inset LatexCommand \index{-S}
+
+\end_inset
+
+
\size large
\bar under
\series bold
-Wa_asmOption[,asmOption]
\series default
+
+\begin_inset LatexCommand \index{-Wa\_asmOption[,asmOption]}
+
+\end_inset
+
...
Pass the asmOption to the assembler.
\layout List
\series bold
-Wl_linkOption[,linkOption]
\series default
+
+\begin_inset LatexCommand \index{-Wl\_linkOption[,linkOption]}
+
+\end_inset
+
...
Pass the linkOption to the linker.
\layout List
\series bold
---int-long-reent
+\begin_inset LatexCommand \index{---int-long-reent}
+
+\end_inset
+
+
\series default
-\size large
-
-\size default
Integer (16 bit) and long (32 bit) libraries have been compiled as reentrant.
Note by default these libraries are compiled as non-reentrant.
See section Installation for more details.
\series bold
---cyclomatic
+\begin_inset LatexCommand \index{---cyclomatic}
+
+\end_inset
+
+
\bar under
\series default
graph of the function, and most importantly the
\emph on
cyclomatic complexity
+\begin_inset LatexCommand \index{cyclomatic complexity}
+
+\end_inset
+
+
\emph default
see section on Cyclomatic Complexity for more details.
\layout List
\series bold
---float-reent
+\begin_inset LatexCommand \index{---float-reent}
+
+\end_inset
+
+
\bar under
\series default
\bar default
- Floating point library is compiled as reentrant.See section Installation
- for more details.
+ Floating point library is compiled as reentrant
+\begin_inset LatexCommand \index{ reentrant}
+
+\end_inset
+
+.See section Installation for more details.
\layout List
\labelwidthstring 00.00.0000
\series bold
---nooverlay
+\begin_inset LatexCommand \index{---nooverlay}
+
+\end_inset
+
+
\series default
The compiler will not overlay parameters and local variables of any function,
see section Parameters and local variables for more details.
\series bold
---main-return
+\begin_inset LatexCommand \index{---main-return}
+
+\end_inset
+
+
\series default
This option can be used when the code generated is called by a monitor
program.
- The compiler will generate a 'ret' upon return from the 'main' function.
+ The compiler will generate a 'ret' upon return from the 'main'
+\begin_inset LatexCommand \index{main return}
+
+\end_inset
+
+ function.
The default option is to lock up i.e.
generate a 'ljmp '.
\layout List
\series bold
---no-peep
+\begin_inset LatexCommand \index{---no-peep}
+
+\end_inset
+
+
\series default
Disable peep-hole optimization.
\layout List
\series bold
---peep-asm
+\begin_inset LatexCommand \index{---peep-asm}
+
+\end_inset
+
+
\series default
Pass the inline assembler code through the peep hole optimizer.
This can cause unexpected changes to inline assembler code, please go through
- the peephole optimizer rules defined in the source file tree '<target>/peeph.def
-' before using this option.
+ the peephole optimizer
+\begin_inset LatexCommand \index{Peephole optimizer}
+
+\end_inset
+
+ rules defined in the source file tree '<target>/peeph.def' before using
+ this option.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+---iram-size
+\series default
+<Value>
+\begin_inset LatexCommand \index{---iram-size<Value>}
+
+\end_inset
+
+ Causes the linker to check if the internal ram usage is within limits of
+ the given value.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+---xram-size
+\series default
+<Value>
+\begin_inset LatexCommand \index{---xram-size<Value>}
+
+\end_inset
+
+ Causes the linker to check if the external ram usage is within limits of
+ the given value.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+---code-size
+\series default
+<Value>
+\begin_inset LatexCommand \index{---code-size<Value>}
+
+\end_inset
+
+ Causes the linker to check if the code usage is within limits of the given
+ value.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+---nostdincl
+\begin_inset LatexCommand \index{---nostdincl}
+
+\end_inset
+
+
+\series default
+ This will prevent the compiler from passing on the default include path
+ to the preprocessor.
\layout List
\labelwidthstring 00.00.0000
-\series bold
----iram-size
+\series bold
+---nostdlib
+\begin_inset LatexCommand \index{---nostdlib}
+
+\end_inset
+
+
\series default
-<Value> Causes the linker to check if the internal ram usage is within limits
- of the given value.
+ This will prevent the compiler from passing on the default library path
+ to the linker.
\layout List
\labelwidthstring 00.00.0000
\series bold
----xram-size
+---verbose
+\begin_inset LatexCommand \index{---verbose}
+
+\end_inset
+
+
\series default
-<Value> Causes the linker to check if the external ram usage is within limits
- of the given value.
+ Shows the various actions the compiler is performing.
\layout List
\labelwidthstring 00.00.0000
\series bold
----code-size
+-V
+\begin_inset LatexCommand \index{-V}
+
+\end_inset
+
+
\series default
-<Value> Causes the linker to check if the code usage is within limits of
- the given value.
+ Shows the actual commands the compiler is executing.
\layout List
\labelwidthstring 00.00.0000
\series bold
----nostdincl
+---no-c-code-in-asm
+\begin_inset LatexCommand \index{---no-c-code-in-asm}
+
+\end_inset
+
+
\series default
- This will prevent the compiler from passing on the default include path
- to the preprocessor.
+ Hides your ugly and inefficient c-code from the asm file, so you can always
+ blame the compiler :).
\layout List
\labelwidthstring 00.00.0000
\series bold
----nostdlib
+---i-code-in-asm
+\begin_inset LatexCommand \index{---i-code-in-asm}
+
+\end_inset
+
+
\series default
- This will prevent the compiler from passing on the default library path
- to the linker.
+ Include i-codes in the asm file.
+ Sounds like noise but is most helpfull for debugging the compiler itself.
\layout List
\labelwidthstring 00.00.0000
\series bold
----verbose
+---less-pedantic
+\begin_inset LatexCommand \index{---less-pedantic}
+
+\end_inset
+
+
\series default
- Shows the various actions the compiler is performing.
+ Disable some of the more pedantic warnings (jwk burps: please be more specific
+ here, please!)
\layout List
\labelwidthstring 00.00.0000
\series bold
--V
+---print-search-dirs
+\begin_inset LatexCommand \index{---print-search-dirs}
+
+\end_inset
+
+
\series default
- Shows the actual commands the compiler is executing.
+ Display the directories in the compiler's search path
\layout Subsubsection
Intermediate Dump Options
+\begin_inset LatexCommand \index{Options Intermediate Dump}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Intermediate Dump Options}
+
+\end_inset
+
+
\layout Standard
The following options are provided for the purpose of retargetting and debugging
the compiler.
- These provided a means to dump the intermediate code (iCode) generated
- by the compiler in human readable form at various stages of the compilation
- process.
+ These provided a means to dump the intermediate code (iCode
+\begin_inset LatexCommand \index{iCode}
+
+\end_inset
+
+) generated by the compiler in human readable form at various stages of
+ the compilation process.
\layout List
\labelwidthstring 00.00.0000
\series bold
---dumpraw
+\begin_inset LatexCommand \index{---dumpraw}
+
+\end_inset
+
+
\series default
This option will cause the compiler to dump the intermediate code into
a file of named
\emph default
just after the intermediate code has been generated for a function, i.e.
before any optimizations are done.
- The basic blocks at this stage ordered in the depth first number, so they
- may not be in sequence of execution.
+ The basic blocks
+\begin_inset LatexCommand \index{basic blocks}
+
+\end_inset
+
+ at this stage ordered in the depth first number, so they may not be in
+ sequence of execution.
\layout List
\labelwidthstring 00.00.0000
\series bold
---dumpgcse
+\begin_inset LatexCommand \index{---dumpgcse}
+
+\end_inset
+
+
\series default
- Will create a dump of iCode's, after global subexpression elimination,
- into a file named
+ Will create a dump of iCode's, after global subexpression elimination
+\begin_inset LatexCommand \index{global subexpression elimination}
+
+\end_inset
+
+, into a file named
\emph on
<source filename>.dumpgcse.
\layout List
\series bold
---dumpdeadcode
+\begin_inset LatexCommand \index{---dumpdeadcode}
+
+\end_inset
+
+
\series default
- Will create a dump of iCode's, after deadcode elimination, into a file
- named
+ Will create a dump of iCode's, after deadcode elimination
+\begin_inset LatexCommand \index{deadcode elimination}
+
+\end_inset
+
+, into a file named
\emph on
<source filename>.dumpdeadcode.
\layout List
\series bold
---dumploop
+\begin_inset LatexCommand \index{---dumploop}
+
+\end_inset
+
+
\series default
\size large
\size default
-Will create a dump of iCode's, after loop optimizations, into a file named
-
+Will create a dump of iCode's, after loop optimizations
+\begin_inset LatexCommand \index{loop optimizations}
+
+\end_inset
+
+, into a file named
\emph on
<source filename>.dumploop.
\layout List
\series bold
---dumprange
+\begin_inset LatexCommand \index{---dumprange}
+
+\end_inset
+
+
\series default
\size large
\size default
-Will create a dump of iCode's, after live range analysis, into a file named
-
+Will create a dump of iCode's, after live range analysis
+\begin_inset LatexCommand \index{live range analysis}
+
+\end_inset
+
+, into a file named
\emph on
<source filename>.dumprange.
\layout List
\series bold
---dumlrange
+\begin_inset LatexCommand \index{---dumlrange}
+
+\end_inset
+
+
\series default
- Will dump the life ranges for all symbols.
+ Will dump the life ranges
+\begin_inset LatexCommand \index{life ranges}
+
+\end_inset
+
+ for all symbols.
\layout List
\labelwidthstring 00.00.0000
\series bold
---dumpregassign
+\begin_inset LatexCommand \index{---dumpregassign}
+
+\end_inset
+
+
\bar under
\series default
\bar default
-Will create a dump of iCode's, after register assignment, into a file named
-
+Will create a dump of iCode's, after register assignment
+\begin_inset LatexCommand \index{register assignment}
+
+\end_inset
+
+, into a file named
\emph on
<source filename>.dumprassgn.
\layout List
\series bold
---dumplrange
+\begin_inset LatexCommand \index{---dumplrange}
+
+\end_inset
+
+
\series default
Will create a dump of the live ranges of iTemp's
\layout List
\series bold
---dumpall
+\begin_inset LatexCommand \index{---dumpall}
+
+\end_inset
+
+
\size large
\bar under
\layout Subsection
Environment variables
+\begin_inset LatexCommand \index{Environment variables}
+
+\end_inset
+
+
\layout Standard
SDCC recognizes the following environment variables:
\series bold
SDCC_LEAVE_SIGNALS
+\begin_inset LatexCommand \index{SDCC\_LEAVE\_SIGNALS}
+
+\end_inset
+
+
\series default
- SDCC installs a signal handler to be able to delete temporary files after
- an user break (^C) or an exception.
+ SDCC installs a signal handler
+\begin_inset LatexCommand \index{ signal handler}
+
+\end_inset
+
+ to be able to delete temporary files after an user break (^C) or an exception.
If this environment variable is set, SDCC won't install the signal handler
in order to be able to debug SDCC.
\layout List
\series bold
-TMP,\SpecialChar ~
-TEMP,\SpecialChar ~
+TMP
+\begin_inset LatexCommand \index{TMP}
+
+\end_inset
+
+,\SpecialChar ~
+TEMP
+\begin_inset LatexCommand \index{TEMP}
+
+\end_inset
+
+,\SpecialChar ~
TMPDIR
+\begin_inset LatexCommand \index{TMPDIR}
+
+\end_inset
+
+
\series default
Path, where temporary files will be created.
The order of the variables is the search order.
\series bold
-(coming\SpecialChar ~
-soon:\SpecialChar ~
-SDCC_BIN_PATH)
-\series default
- Path, see
-\begin_inset Quotes sld
-\end_inset
+SDCC_HOME
+\begin_inset LatexCommand \index{SDCC\_HOME}
-2.1 Install and search paths
-\begin_inset Quotes srd
\end_inset
-.
-\layout List
-\labelwidthstring 00.00.0000
-
-\series bold
-(coming\SpecialChar ~
-soon:\SpecialChar ~
-SDCC_INCLUDE_PATH)
\series default
Path, see
\begin_inset Quotes sld
\end_inset
-2.1 Install and search paths
+2.3 Install and search paths
\begin_inset Quotes srd
\end_inset
\series bold
-(coming\SpecialChar ~
-soon:\SpecialChar ~
-SDCC_LIB_PATH)
+SDCC_INCLUDE
+\begin_inset LatexCommand \index{SDCC\_INCLUDE}
+
+\end_inset
+
+
\series default
Path, see
\begin_inset Quotes sld
\end_inset
-2.1 Install and search paths
+2.3 Install and search paths
\begin_inset Quotes srd
\end_inset
\series bold
-SDCCDIR\SpecialChar ~
-(soon\SpecialChar ~
-replaced\SpecialChar ~
-by:\SpecialChar ~
-SDCCPATH)
+SDCC_LIB
+\begin_inset LatexCommand \index{SDCC\_LIB}
+
+\end_inset
+
+
\series default
Path, see
\begin_inset Quotes sld
\end_inset
-2.1 Install and search paths
+2.3 Install and search paths
\begin_inset Quotes srd
\end_inset
They can change or disappear very quickly, and will never be documentated.
\layout Subsection
-MCS51/DS390 Storage Class Language Extensions
+MCS51/DS390 Storage Class
+\begin_inset LatexCommand \index{Storage Class}
+
+\end_inset
+
+ Language Extensions
\layout Standard
In addition to the ANSI storage classes SDCC allows the following MCS51
\layout Subsubsection
xdata
+\begin_inset LatexCommand \index{xdata}
+
+\end_inset
+
+
\layout Standard
Variables declared with this storage class will be placed in the extern
\layout Subsubsection
data
+\begin_inset LatexCommand \index{data}
+
+\end_inset
+
+
\layout Standard
This is the
\layout Subsubsection
idata
+\begin_inset LatexCommand \index{idata}
+
+\end_inset
+
+
\layout Standard
Variables declared with this storage class will be allocated into the indirectly
\layout Subsubsection
bit
+\begin_inset LatexCommand \index{bit}
+
+\end_inset
+
+
\layout Standard
This is a data-type and a storage class specifier.
bit iFlag;
\layout Subsubsection
-sfr / sbit
+sfr
+\begin_inset LatexCommand \index{sfr}
+
+\end_inset
+
+ / sbit
+\begin_inset LatexCommand \index{sbit}
+
+\end_inset
+
+
\layout Standard
Like the bit keyword,
\family typewriter
sfr at 0x80 P0; /* special function register P0 at location 0x80 */
\newline
-sbit at 0xd7 CY; /* CY (Carry Flag) */
+sbit at 0xd7 CY; /* CY (Carry Flag
+\begin_inset LatexCommand \index{Carry flag}
+
+\end_inset
+
+) */
\layout Subsection
Pointers
+\begin_inset LatexCommand \index{Pointers}
+
+\end_inset
+
+
\layout Standard
SDCC allows (via language extensions) pointers to explicitly point to any
- of the memory spaces of the 8051.
+ of the memory spaces
+\begin_inset LatexCommand \index{memory spaces}
+
+\end_inset
+
+ of the 8051.
In addition to the explicit pointers, the compiler uses (by default) generic
pointers which can be used to point to any of the memory spaces.
\newline
code.
\layout Subsection
-Parameters & Local Variables
+Parameters
+\begin_inset LatexCommand \index{Parameters}
+
+\end_inset
+
+ & Local Variables
+\begin_inset LatexCommand \index{Local Variables}
+
+\end_inset
+
+
\layout Standard
Automatic (local) variables and parameters to functions can either be placed
This in fact makes them
\emph on
static
+\begin_inset LatexCommand \index{static}
+
+\end_inset
+
+
\emph default
- so by default functions are non-reentrant.
+ so by default functions are non-reentrant
+\begin_inset LatexCommand \index{non-reentrant}
+
+\end_inset
+
+.
\newline
\newline
-They can be placed on the stack either by using the
+They can be placed on the stack
+\begin_inset LatexCommand \index{stack}
+
+\end_inset
+
+ either by using the
\emph on
---stack-auto
+\begin_inset LatexCommand \index{--stack-auto}
+
+\end_inset
+
+
\emph default
option or by using the
\emph on
reentrant
+\begin_inset LatexCommand \index{reentrant}
+
+\end_inset
+
+
\emph default
keyword in the function declaration, e.g.:
\newline
\newline
\newline
-Local variables can be assigned storage classes and absolute addresses,
- e.g.:
+Local variables can be assigned storage classes and absolute
+\begin_inset LatexCommand \index{absolute}
+
+\end_inset
+
+ addresses, e.g.:
\newline
\newline
\layout Subsection
Overlaying
+\begin_inset LatexCommand \index{Overlaying}
+
+\end_inset
+
+
\layout Standard
For non-reentrant functions SDCC will try to reduce internal ram space usage
e segment if the function has
\emph on
no other function calls and the function is non-reentrant and the memory
- model is small.
+ model
+\begin_inset LatexCommand \index{memory model}
+
+\end_inset
+
+ is small.
\emph default
If an explicit storage class is specified for a local variable, it will
g the data items.
Functions that are called from an interrupt service routine should be preceded
by a #pragma\SpecialChar ~
-NOOVERLAY if they are not reentrant.
+NOOVERLAY
+\begin_inset LatexCommand \index{\#pragma NOOVERLAY}
+
+\end_inset
+
+ if they are not reentrant.
\layout Standard
-Also note that the compiler does not do any processing of inline assembler
- code, so the compiler might incorrectly assign local variables and parameters
- of a function into the overlay segment if the inline assembler code calls
- other c-functions that might use the overlay.
+Also note that the compiler does not do any processing of inline
+\begin_inset LatexCommand \index{inline}
+
+\end_inset
+
+ assembler code, so the compiler might incorrectly assign local variables
+ and parameters of a function into the overlay segment if the inline assembler
+ code calls other c-functions that might use the overlay.
In that case the #pragma\SpecialChar ~
NOOVERLAY should be used.
\layout Standard
Parameters and Local variables of functions that contain 16 or 32 bit multiplica
-tion or division will NOT be overlayed since these are implemented using
- external functions, e.g.:
+tion
+\begin_inset LatexCommand \index{multiplication}
+
+\end_inset
+
+ or division
+\begin_inset LatexCommand \index{division}
+
+\end_inset
+
+ will NOT be overlayed since these are implemented using external functions,
+ e.g.:
\newline
\newline
\family typewriter
#pragma SAVE
\newline
-#pragma NOOVERLAY
+#pragma NOOVERLAY
+\begin_inset LatexCommand \index{\#pragma NOOVERLAY}
+
+\end_inset
+
+
\newline
void set_error(unsigned char errcd)
\newline
\newline
\newline
-void some_isr () interrupt 2 using 1
+void some_isr () interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+ 2 using
+\begin_inset LatexCommand \index{using}
+
+\end_inset
+
+ 1
\newline
{
\newline
the function are NOT overlayed.
\layout Subsection
-Interrupt Service Routines
+Interrupt Service Routines
+\begin_inset LatexCommand \index{Interrupt Service Routines}
+
+\end_inset
+
+
\layout Standard
SDCC allows interrupt service routines to be coded in C, with some extended
The number following the
\emph on
interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+
\emph default
keyword is the interrupt number this routine will service.
The compiler will insert a call to this routine in the interrupt vector
(8051 specific) when generating code for this function.
Note that when some function is called from an interrupt service routine
it should be preceded by a #pragma\SpecialChar ~
-NOOVERLAY if it is not reentrant.
+NOOVERLAY
+\begin_inset LatexCommand \index{\#pragma NOOVERLAY}
+
+\end_inset
+
+ if it is not reentrant.
A special note here, int (16 bit) and long (32 bit) integer division, multiplic
ation & modulus operations are implemented using external support routines
developed in ANSI-C, if an interrupt service routine needs to do any of
section) will have to be recompiled using the
\emph on
---stack-auto
+\begin_inset LatexCommand \index{---stack-auto}
+
+\end_inset
+
+
\emph default
option and the source file will need to be compiled using the
\emph on
---int-long-ren
\emph default
-t compiler option.
+t
+\begin_inset LatexCommand \index{---int-long-rent}
+
+\end_inset
+
+ compiler option.
\layout Standard
If you have multiple source files in your project, interrupt service routines
Interrupt Numbers and the corresponding address & descriptions for the Standard
8051 are listed below.
- SDCC will automatically adjust the interrupt vector table to the maximum
- interrupt number specified.
+ SDCC will automatically adjust the interrupt vector table
+\begin_inset LatexCommand \index{ interrupt vector table}
+
+\end_inset
+
+ to the maximum interrupt number specified.
\newline
\layout Standard
\begin_inset Tabular
<lyxtabular version="3" rows="6" columns="3">
<features>
-<column alignment="center" valignment="top" leftline="true" width="0pt">
-<column alignment="center" valignment="top" leftline="true" width="0pt">
-<column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
+<column alignment="center" valignment="top" leftline="true" width="0in">
+<column alignment="center" valignment="top" leftline="true" width="0in">
+<column alignment="center" valignment="top" leftline="true" rightline="true" width="0in">
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
If the interrupt service routine is defined without
\emph on
using
+\begin_inset LatexCommand \index{using}
+
+\end_inset
+
+
\emph default
a register bank or with register bank 0 (using 0), the compiler will save
the registers used by itself on the stack upon entry and restore them at
\layout Subsection
Naked Functions
+\begin_inset LatexCommand \index{Naked Functions}
+
+\end_inset
+
+
\layout Standard
A special keyword may be associated with a function declaring it as
\emph on
-_naked.
+_naked
+\begin_inset LatexCommand \index{\_naked}
+
+\end_inset
+
+.
\emph default
The
_naked
\emph default
function modifier attribute prevents the compiler from generating prologue
- and epilogue code for that function.
+\begin_inset LatexCommand \index{function prologue}
+
+\end_inset
+
+ and epilogue
+\begin_inset LatexCommand \index{function epilogue}
+
+\end_inset
+
+ code for that function.
This means that the user is entirely responsible for such things as saving
any registers that may need to be preserved, selecting the proper register
bank, generating the
\family typewriter
data unsigned char counter;
\newline
-void simpleInterrupt(void) interrupt 1
+void simpleInterrupt(void) interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+ 1
\newline
{
\newline
\layout Subsection
Functions using private banks
+\begin_inset LatexCommand \index{banks}
+
+\end_inset
+
+
\layout Standard
The
\emph on
using
+\begin_inset LatexCommand \index{using}
+
+\end_inset
+
+
\emph default
attribute (which tells the compiler to use a register bank other than the
default bank zero) should only be applied to
\emph on
interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+
\emph default
functions (see note 1 below).
This will in most circumstances make the generated ISR code more efficient
\emph default
function using a non-zero bank will assume that it can trash that register
bank, and will not save it.
- Since high-priority interrupts can interrupt low-priority ones on the 8051
- and friends, this means that if a high-priority ISR
+ Since high-priority interrupts
+\begin_inset LatexCommand \index{interrupt priority}
+
+\end_inset
+
+ can interrupt low-priority ones on the 8051 and friends, this means that
+ if a high-priority ISR
\emph on
using
\emph default
\layout Subsection
Absolute Addressing
+\begin_inset LatexCommand \index{Absolute Addressing}
+
+\end_inset
+
+
\layout Standard
Data items can be assigned an absolute address with the
\emph on
-at <address>
+at
+\begin_inset LatexCommand \index{at}
+
+\end_inset
+
+ <address>
\emph default
keyword, in addition to a storage class, e.g.:
\newline
\newline
\family typewriter
-xdata at 0x8000 unsigned char PORTA_8255 ;
+xdata
+\begin_inset LatexCommand \index{xdata}
+
+\end_inset
+
+ at
+\begin_inset LatexCommand \index{at}
+
+\end_inset
+
+ 0x8000 unsigned char PORTA_8255 ;
\newline
\family default
in this way (they are implemented with an equate in the assembler).
Thus it is left to the programmer to make sure there are no overlaps with
other variables that are declared without the absolute address.
- The assembler listing file (.lst) and the linker output files (.rst) and
- (.map) are a good places to look for such overlaps.
+ The assembler listing file (.lst
+\begin_inset LatexCommand \index{.lst}
+
+\end_inset
+
+) and the linker output files (.rst
+\begin_inset LatexCommand \index{.rst}
+
+\end_inset
+
+) and (.map
+\begin_inset LatexCommand \index{.map}
+
+\end_inset
+
+) are a good places to look for such overlaps.
\newline
\newline
\newline
\family typewriter
-bit at 0x02 bvar;
+bit
+\begin_inset LatexCommand \index{bit}
+
+\end_inset
+
+ at
+\begin_inset LatexCommand \index{at}
+
+\end_inset
+
+ 0x02 bvar;
\newline
\newline
\layout Subsection
Startup Code
+\begin_inset LatexCommand \index{Startup Code}
+
+\end_inset
+
+
\layout Standard
The compiler inserts a call to the C routine
\emph on
-_sdcc__external__startup()
+_sdcc_external_startup()
+\begin_inset LatexCommand \index{\_sdcc\_external\_startup()}
+
+\end_inset
+
+
\series bold
\emph default
before the function main is invoked.
You could add a
\emph on
-_sdcc__external__startup()
+_sdcc_external_startup()
\emph default
routine to your program to override the default if you need to setup hardware
or perform some other critical operation prior to static & global variable
\layout Subsection
Inline Assembler Code
+\begin_inset LatexCommand \index{Inline Assembler Code}
+
+\end_inset
+
+
\layout Standard
SDCC allows the use of in-line assembler with a few restriction as regards
When the
\emph on
---peep-asm
+\begin_inset LatexCommand \index{--peep-asm}
+
+\end_inset
+
+
\emph default
command line option is used, the inline assembler code will be passed through
- the peephole optimizer.
+ the peephole optimizer
+\begin_inset LatexCommand \index{Peephole optimizer}
+
+\end_inset
+
+.
This might cause some unexpected changes in the inline assembler code.
Please go throught the peephole optimizer rules defined in file
\emph on
\newline
\family typewriter
-_asm
+_asm
+\begin_inset LatexCommand \index{\_asm}
+
+\end_inset
+
+
\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
b,00001$
\newline
-_endasm ;
+_endasm
+\begin_inset LatexCommand \index{\_endasm}
+
+\end_inset
+
+ ;
\family default
\size small
\newline
Inline assembler code cannot reference any C-Labels, however it can reference
- labels defined by the inline assembler, e.g.:
+ labels
+\begin_inset LatexCommand \index{Labels}
+
+\end_inset
+
+ defined by the inline assembler, e.g.:
\newline
\newline
labels defines in inline assembly CANNOT be accessed by C statements.
\layout Subsection
-int (16 bit) and long (32 bit) Support
+int (16 bit)
+\begin_inset LatexCommand \index{int (16 bit)}
+
+\end_inset
+
+ and long (32 bit)
+\begin_inset LatexCommand \index{long (32 bit)}
+
+\end_inset
+
+ Support
\layout Standard
For signed & unsigned int (16 bit) and long (32 bit) variables, division,
\emph on
non-reentrant
\emph default
-, interrupt service routines should not do any of the above operations.
+
+\begin_inset LatexCommand \index{reentrant}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{non-reentrant}
+
+\end_inset
+
+, interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+ service routines should not do any of the above operations.
If this is unavoidable then the above routines will need to be compiled
with the
\emph on
---stack-auto
+\begin_inset LatexCommand \index{---stack-auto}
+
+\end_inset
+
+
\emph default
option, after which the source program will have to be compiled with
\emph on
---int-long-rent
+\begin_inset LatexCommand \index{---int-long-rent}
+
+\end_inset
+
+
\emph default
option.
\layout Subsection
Floating Point Support
+\begin_inset LatexCommand \index{Floating Point Support}
+
+\end_inset
+
+
\layout Standard
SDCC supports IEEE (single precision 4bytes) floating point numbers.The floating
\layout Subsection
MCS51 Memory Models
+\begin_inset LatexCommand \index{Memory Models}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{MCS51 Memory Models}
+
+\end_inset
+
+
\layout Standard
SDCC allows two memory models for MCS51 code, small and large.
in the internal ram.
\layout Standard
-Judicious usage of the processor specific storage classes and the 'reentrant'
- function type will yield much more efficient code, than using the large
- model.
+Judicious usage of the processor specific storage classes
+\begin_inset LatexCommand \index{storage classes}
+
+\end_inset
+
+ and the 'reentrant' function type will yield much more efficient code,
+ than using the large model.
Several optimizations are disabled when the program is compiled using the
large model, it is therefore strongly recommdended that the small model
be used unless absolutely required.
\layout Subsection
DS390 Memory Models
+\begin_inset LatexCommand \index{Memory Models}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{DS390 Memory Models}
+
+\end_inset
+
+
\layout Standard
-The only model supported is Flat 24.
+The only model supported is Flat 24
+\begin_inset LatexCommand \index{Flat 24}
+
+\end_inset
+
+.
This generates code for the 24 bit contiguous addressing mode of the Dallas
DS80C390 part.
In this mode, up to four meg of external RAM or code space can be directly
\emph on
tinibios
\emph default
+
+\begin_inset LatexCommand \index{tinibios}
+
+\end_inset
+
, the boot loader or similar code must ensure that the processor is in 24
bit contiguous addressing mode before calling the SDCC startup code.
\newline
\layout Subsection
Defines Created by the Compiler
+\begin_inset LatexCommand \index{Defines Created by the Compiler}
+
+\end_inset
+
+
\layout Standard
-The compiler creates the following #defines.
+The compiler creates the following #defines
+\begin_inset LatexCommand \index{\#defines}
+
+\end_inset
+
+.
\layout Itemize
-SDCC - this Symbol is always defined.
+SDCC
+\begin_inset LatexCommand \index{SDCC}
+
+\end_inset
+
+ - this Symbol is always defined.
\layout Itemize
-SDCC_mcs51 or SDCC_ds390 or SDCC_z80, etc - depending on the model used
- (e.g.: -mds390)
+SDCC_mcs51
+\begin_inset LatexCommand \index{SDCC\_mcs51}
+
+\end_inset
+
+ or SDCC_ds390
+\begin_inset LatexCommand \index{SDCC\_ds390}
+
+\end_inset
+
+ or SDCC_z80
+\begin_inset LatexCommand \index{SDCC\_z80}
+
+\end_inset
+
+, etc - depending on the model used (e.g.: -mds390)
\layout Itemize
-__mcs51 or __ds390 or __z80, etc - depending on the model used (e.g.
+__mcs51
+\begin_inset LatexCommand \index{\_\_mcs51}
+
+\end_inset
+
+ or __ds390
+\begin_inset LatexCommand \index{\_\_ds390}
+
+\end_inset
+
+ or __z80
+\begin_inset LatexCommand \index{\_\_z80}
+
+\end_inset
+
+, etc - depending on the model used (e.g.
-mz80)
\layout Itemize
-SDCC_STACK_AUTO - this symbol is defined when
+SDCC_STACK_AUTO
+\begin_inset LatexCommand \index{SDCC\_STACK\_AUTO}
+
+\end_inset
+
+ - this symbol is defined when
\emph on
---stack-auto
\emph default
option is used.
\layout Itemize
-SDCC_MODEL_SMALL - when
+SDCC_MODEL_SMALL
+\begin_inset LatexCommand \index{SDCC\_MODEL\_SMALL}
+
+\end_inset
+
+ - when
\emph on
---model-small
\emph default
is used.
\layout Itemize
-SDCC_MODEL_LARGE - when
+SDCC_MODEL_LARGE
+\begin_inset LatexCommand \index{SDCC\_MODEL\_LARGE}
+
+\end_inset
+
+ - when
\emph on
---model-large
\emph default
is used.
\layout Itemize
-SDCC_USE_XSTACK - when
+SDCC_USE_XSTACK
+\begin_inset LatexCommand \index{SDCC\_USE\_XSTACK}
+
+\end_inset
+
+ - when
\emph on
---xstack
\emph default
option is used.
\layout Itemize
-SDCC_STACK_TENBIT - when
+SDCC_STACK_TENBIT
+\begin_inset LatexCommand \index{SDCC\_STACK\_TENBIT}
+
+\end_inset
+
+ - when
\emph on
-mds390
\emph default
is used
\layout Itemize
-SDCC_MODEL_FLAT24 - when
+SDCC_MODEL_FLAT24
+\begin_inset LatexCommand \index{SDCC\_MODEL\_FLAT24}
+
+\end_inset
+
+ - when
\emph on
-mds390
\emph default
\layout Subsection
Optimizations
+\begin_inset LatexCommand \index{Optimizations}
+
+\end_inset
+
+
\layout Standard
SDCC performs a host of standard optimizations in addition to some MCU specific
\layout Subsubsection
Sub-expression Elimination
+\begin_inset LatexCommand \index{Sub-expression Elimination}
+
+\end_inset
+
+
\layout Standard
The compiler does local and global common subexpression elimination, e.g.:
\layout Subsubsection
Dead-Code Elimination
+\begin_inset LatexCommand \index{Dead-Code Elimination}
+
+\end_inset
+
+
\layout Standard
\layout Subsubsection
Copy-Propagation
+\begin_inset LatexCommand \index{Copy-Propagation}
+
+\end_inset
+
+
\layout Standard
\layout Subsubsection
Loop Optimizations
+\begin_inset LatexCommand \index{Loop Optimizations}
+
+\end_inset
+
+
\layout Standard
Two types of loop optimizations are done by SDCC loop invariant lifting
In addition to the strength reduction the optimizer marks the induction
variables and the register allocator tries to keep the induction variables
in registers for the duration of the loop.
- Because of this preference of the register allocator, loop induction optimizati
-on causes an increase in register pressure, which may cause unwanted spilling
- of other temporary variables into the stack / data space.
+ Because of this preference of the register allocator
+\begin_inset LatexCommand \index{Register allocator}
+
+\end_inset
+
+, loop induction optimization causes an increase in register pressure, which
+ may cause unwanted spilling of other temporary variables into the stack
+\begin_inset LatexCommand \index{stack}
+
+\end_inset
+
+ / data space.
The compiler will generate a warning message when it is forced to allocate
extra space either on the stack or data space.
If this extra space allocation is undesirable then induction optimization
can be eliminated either for the entire source file (with ---noinduction
option) or for a given function only using #pragma\SpecialChar ~
-NOINDUCTION.
+NOINDUCTION
+\begin_inset LatexCommand \index{\#pragma NOINDUCTION}
+
+\end_inset
+
+.
\newline
\newline
address computations are also moved out of the loop.
\newline
-\newline
-Strength Reduction, this optimization substitutes an expression by a cheaper
- expression:
+\newline
+Strength Reduction
+\begin_inset LatexCommand \index{Strength Reduction}
+
+\end_inset
+
+, this optimization substitutes an expression by a cheaper expression:
\newline
\newline
\newline
\newline
-The more expensive multiplication is changed to a less expensive addition.
+The more expensive multiplication
+\begin_inset LatexCommand \index{multiplication}
+
+\end_inset
+
+ is changed to a less expensive addition.
\layout Subsubsection
Loop Reversing
+\begin_inset LatexCommand \index{Loop Reversing}
+
+\end_inset
+
+
\layout Standard
This optimization is done to reduce the overhead of checking loop boundaries
\newline
\newline
-Note the subexpressions given above are generally introduced by macro expansions
- or as a result of copy/constant propagation.
+Note the subexpressions
+\begin_inset LatexCommand \index{subexpressions}
+
+\end_inset
+
+ given above are generally introduced by macro expansions or as a result
+ of copy/constant propagation.
\layout Subsubsection
'switch' Statements
+\begin_inset LatexCommand \index{switch Statements}
+
+\end_inset
+
+
\layout Standard
-SDCC changes switch statements to jump tables when the following conditions
- are true.
+SDCC changes switch statements to jump tables
+\begin_inset LatexCommand \index{jump tables}
+
+\end_inset
+
+ when the following conditions are true.
\layout Itemize
the unmodified switch statement will not be.
\layout Subsubsection
-Bit-shifting Operations.
+Bit-shifting Operations
+\begin_inset LatexCommand \index{Bit-shifting Operations}
+
+\end_inset
+
+.
\layout Standard
Bit shifting is one of the most frequently used operation in embedded programmin
\layout Subsubsection
Bit-rotation
+\begin_inset LatexCommand \index{Bit-rotation}
+
+\end_inset
+
+
\layout Standard
A special case of the bit-shift operation is bit rotation, SDCC recognizes
\layout Subsubsection
Highest Order Bit
+\begin_inset LatexCommand \index{Highest Order Bit}
+
+\end_inset
+
+
\layout Standard
It is frequently required to obtain the highest order bit of an integral
will still be recognized.
\layout Subsubsection
-Peep-hole Optimizer
+Peephole Optimizer
+\begin_inset LatexCommand \index{Peephole optimizer}
+
+\end_inset
+
+
\layout Standard
The compiler uses a rule based, pattern matching and re-writing mechanism
A default set of rules are compiled into the compiler, additional rules
may be added with the
\emph on
----peep-file <filename>
+---peep-file
+\begin_inset LatexCommand \index{---peep-file}
+
+\end_inset
+
+ <filename>
\emph default
option.
The rule language is best illustrated with examples.
\layout Subsection
Pragmas
+\begin_inset LatexCommand \index{Pragmas}
+
+\end_inset
+
+
\layout Standard
SDCC supports the following #pragma directives.
- This directives are applicable only at a function level.
\layout Itemize
-SAVE - this will save all the current options.
+SAVE
+\begin_inset LatexCommand \index{\#pragma SAVE}
+
+\end_inset
+
+ - this will save all current options to the SAVE/RESTORE stack.
+ See RESTORE.
+\layout Itemize
+
+RESTORE
+\begin_inset LatexCommand \index{\#pragma RESTORE}
+
+\end_inset
+
+ - will restore saved options from the last save.
+ SAVEs & RESTOREs can be nested.
+ SDCC uses a SAVE/RESTORE stack: SAVE pushes current options to the stack,
+ RESTORE pulls current options from the stack.
+ See SAVE.
\layout Itemize
-RESTORE - will restore the saved options from the last save.
- Note that SAVES & RESTOREs cannot be nested.
- SDCC uses the same buffer to save the options each time a SAVE is called.
+NOGCSE
+\begin_inset LatexCommand \index{\#pragma NOGCSE}
+
+\end_inset
+
+ - will stop global subexpression elimination.
\layout Itemize
-NOGCSE - will stop global subexpression elimination.
+NOINDUCTION
+\begin_inset LatexCommand \index{\#pragma NOINDUCTION}
+
+\end_inset
+
+ - will stop loop induction optimizations.
\layout Itemize
-NOINDUCTION - will stop loop induction optimizations.
+NOJTBOUND
+\begin_inset LatexCommand \index{\#pragma NOJTBOUND}
+
+\end_inset
+
+ - will not generate code for boundary value checking, when switch statements
+ are turned into jump-tables.
\layout Itemize
-NOJTBOUND - will not generate code for boundary value checking, when switch
- statements are turned into jump-tables.
+NOOVERLAY
+\begin_inset LatexCommand \index{\#pragma NOOVERLAY}
+
+\end_inset
+
+ - the compiler will not overlay the parameters and local variables of a
+ function.
\layout Itemize
-NOOVERLAY - the compiler will not overlay the parameters and local variables
- of a function.
+LESS_PEDANTIC
+\begin_inset LatexCommand \index{\#pragma LESS\_PEDANTIC}
+
+\end_inset
+
+ - the compiler will not warn you anymore for obvious mistakes, you'r on
+ your own now ;-(
\layout Itemize
-NOLOOPREVERSE - Will not do loop reversal optimization
+NOLOOPREVERSE
+\begin_inset LatexCommand \index{\#pragma NOLOOPREVERSE}
+
+\end_inset
+
+ - Will not do loop reversal optimization
\layout Itemize
-EXCLUDE NONE | {acc[,b[,dpl[,dph]]] - The exclude pragma disables generation
- of pair of push/pop instruction in ISR function (using interrupt keyword).
+EXCLUDE
+\begin_inset LatexCommand \index{\#pragma EXCLUDE}
+
+\end_inset
+
+ NONE | {acc[,b[,dpl[,dph]]] - The exclude pragma disables generation of
+ pair of push/pop instruction in ISR function (using interrupt keyword).
The directive should be placed immediately before the ISR function definition
and it affects ALL ISR functions following it.
To enable the normal register saving for ISR functions use #pragma\SpecialChar ~
none.
\layout Itemize
-NOIV - Do not generate interrupt vector table entries for all ISR functions
+NOIV
+\begin_inset LatexCommand \index{\#pragma NOIV}
+
+\end_inset
+
+ - Do not generate interrupt vector table entries for all ISR functions
defined after the pragma.
This is useful in cases where the interrupt vector table must be defined
manually, or when there is a secondary, manually defined interrupt vector
for the autovector feature of the Cypress EZ-USB FX2).
\layout Itemize
-CALLEE-SAVES function1[,function2[,function3...]] - The compiler by default
- uses a caller saves convention for register saving across function calls,
- however this can cause unneccessary register pushing & popping when calling
- small functions from larger functions.
- This option can be used to switch the register saving convention for the
- function names specified.
+CALLEE-SAVES
+\begin_inset LatexCommand \index{\#pragma CALLEE-SAVES}
+
+\end_inset
+
+ function1[,function2[,function3...]] - The compiler by default uses a caller
+ saves convention for register saving across function calls, however this
+ can cause unneccessary register pushing & popping when calling small functions
+ from larger functions.
+ This option can be used to switch off the register saving convention for
+ the function names specified.
The compiler will not save registers when calling these functions, extra
- code will be generated at the entry & exit for these functions to save
- & restore the registers used by these functions, this can SUBSTANTIALLY
+ code need to be manually inserted at the entry & exit for these functions
+ to save & restore the registers used by these functions, this can SUBSTANTIALLY
reduce code & improve run time performance of the generated code.
- In future the compiler (with interprocedural analysis) will be able to
- determine the appropriate scheme to use for each function call.
+ In the future the compiler (with interprocedural analysis) may be able
+ to determine the appropriate scheme to use for each function call.
If ---callee-saves command line option is used, the function names specified
in #pragma\SpecialChar ~
-CALLEE-SAVES is appended to the list of functions specified inthe
- command line.
+CALLEE-SAVES is appended to the list of functions specified in
+ the command line.
\layout Standard
The pragma's are intended to be used to turn-off certain optimizations which
\newline
\family typewriter
-#pragma SAVE /* save the current settings */
+#pragma SAVE
+\begin_inset LatexCommand \index{\#pragma SAVE}
+
+\end_inset
+
+ /* save the current settings */
\newline
-#pragma NOGCSE /* turnoff global subexpression elimination */
+#pragma NOGCSE
+\begin_inset LatexCommand \index{\#pragma NOGCSE}
+
+\end_inset
+
+ /* turnoff global subexpression elimination */
\newline
-#pragma NOINDUCTION /* turn off induction optimizations */
+#pragma NOINDUCTION
+\begin_inset LatexCommand \index{\#pragma NOINDUCTION}
+
+\end_inset
+
+ /* turn off induction optimizations */
\newline
int foo ()
\newline
\newline
}
\newline
-#pragma RESTORE /* turn the optimizations back on */
+#pragma RESTORE
+\begin_inset LatexCommand \index{\#pragma RESTORE}
+
+\end_inset
+
+ /* turn the optimizations back on */
\family default
\newline
\layout Subsection
Interfacing with Assembly Routines
+\begin_inset LatexCommand \index{Assembly Routines}
+
+\end_inset
+
+
\layout Subsubsection
Global Registers used for Parameter Passing
+\begin_inset LatexCommand \index{Parameter Passing}
+
+\end_inset
+
+
\layout Standard
The compiler always uses the global registers
\emph on
-DPL,DPH,B
+DPL
+\begin_inset LatexCommand \index{DPL}
+
+\end_inset
+
+,DPH
+\begin_inset LatexCommand \index{DPH}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{DPTR}
+
+\end_inset
+
+,B
+\begin_inset LatexCommand \index{B}
+
+\end_inset
+
+
\emph default
and
\emph on
ACC
+\begin_inset LatexCommand \index{ACC}
+
+\end_inset
+
+
\emph default
to pass the first parameter to a routine.
The second parameter onwards is either allocated on the stack (for reentrant
\layout Subsubsection
Assembler Routine(non-reentrant)
+\begin_inset LatexCommand \index{Assembler Routine(non-reentrant)}
+
+\end_inset
+
+
\layout Standard
In the following example the function cfunc calls an assembler routine asm_func,
\layout Subsubsection
Assembler Routine(reentrant)
+\begin_inset LatexCommand \index{Assembler Routine(reentrant)}
+
+\end_inset
+
+
\layout Standard
In this case the second parameter onwards will be passed on the stack, the
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-mov _bp,sp
+mov _bp,sp
\newline
\SpecialChar ~
\SpecialChar ~
\layout Subsection
External Stack
+\begin_inset LatexCommand \index{External Stack}
+
+\end_inset
+
+
\layout Standard
The external stack is located at the start of the external ram segment,
\layout Subsection
ANSI-Compliance
+\begin_inset LatexCommand \index{ANSI-Compliance}
+
+\end_inset
+
+
\layout Standard
Deviations from the compliancy.
\layout Subsection
Cyclomatic Complexity
+\begin_inset LatexCommand \index{Cyclomatic Complexity}
+
+\end_inset
+
+
\layout Standard
Cyclomatic complexity of a function is defined as the number of independent
compiler will be smart enough to detect such optimization oppurtunities).
\layout Subsection
-Notes on MCS51 memory layout
+Notes on MCS51 memory
+\begin_inset LatexCommand \index{MCS51 memory}
+
+\end_inset
+
+ layout
\layout Standard
The 8051 family of micro controller have a minimum of 128 bytes of internal
\newline
\newline
-Normally the SDCC compiler will only utilise the first bank of registers,
- but it is possible to specify that other banks of registers should be used
- in interrupt routines.
+Normally the SDCC compiler will only utilise the first bank
+\begin_inset LatexCommand \index{bank}
+
+\end_inset
+
+ of registers, but it is possible to specify that other banks of registers
+ should be used in interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+ routines.
By default, the compiler will place the stack after the last bank of used
registers, i.e.
if the first 2 banks of registers are used, it will position the base of
the internal stack at address 16 (0X10).
- This implies that as the stack grows, it will use up the remaining register
- banks, and the 16 bytes used by the 128 bit variables, and 60 bytes for
- general purpose use.
+ This implies that as the stack
+\begin_inset LatexCommand \index{stack}
+
+\end_inset
+
+ grows, it will use up the remaining register banks, and the 16 bytes used
+ by the 128 bit variables, and 60 bytes for general purpose use.
\layout Standard
By default, the compiler uses the 60 general purpose bytes to hold "near
\layout Standard
The amount of stack being used is affected by the use of the "internal stack"
- to save registers before a subroutine call is made (---stack-auto will
- declare parameters and local variables on the stack) and the number of
- nested subroutines.
+ to save registers before a subroutine call is made (---stack-auto
+\begin_inset LatexCommand \index{---stack-auto}
+
+\end_inset
+
+ will declare parameters and local variables on the stack) and the number
+ of nested subroutines.
\layout Standard
If you detect that the stack is over writing you data, then the following
\layout Standard
----stack-loc will allow you specify the start of the stack, i.e.
+---stack-loc
+\begin_inset LatexCommand \index{---stack-loc}
+
+\end_inset
+
+ will allow you specify the start of the stack, i.e.
you could start it after any data in the general purpose area.
However this may waste the memory not used by the register banks and if
the size of the "near data" increases, it may creep into the bottom of
the stack.
\layout Standard
----stack-after-data, similar to the ---stack-loc, but it automatically places
- the stack after the end of the "near data".
+---stack-after-data
+\begin_inset LatexCommand \index{---stack-after-data}
+
+\end_inset
+
+, similar to the ---stack-loc, but it automatically places the stack after
+ the end of the "near data".
Again this could waste any spare register space.
\layout Standard
----data-loc allows you to specify the start address of the near data.
+---data-loc
+\begin_inset LatexCommand \index{---data-loc}
+
+\end_inset
+
+ allows you to specify the start address of the near data.
This could be used to move the "near data" further away from the stack
giving it more room to grow.
This will only work if no bit variables are being used and the stack can
As mentioned in the optimization section the peep-hole optimizer is rule
based system, which can reprogrammed for other MCUs.
\layout Section
+\pagebreak_top
+SDCDB
+\begin_inset LatexCommand \index{SDCDB}
+
+\end_inset
+
+ - Source Level Debugger
+\begin_inset LatexCommand \index{Debugger}
+
+\end_inset
+
-SDCDB - Source Level Debugger
\layout Standard
SDCC is distributed with a source level debugger.
\SpecialChar \-
debug option must be specified for all files for which debug information
is to be generated.
- The complier generates a .cdb file for each of these files.
- The linker updates the .cdb file with the address information.
+ The complier generates a .adb file for each of these files.
+ The linker creates the .cdb file from the .adb files and the address information.
This .cdb is used by the debugger.
\layout Subsection
When the ---debug option is specified the compiler generates extra symbol
information some of which are put into the the assembler source and some
- are put into the .cdb file, the linker updates the .cdb file with the address
- information for the symbols.
+ are put into the .adb file.
+ Then the linker creates the .cdb file from the individual .adb files with
+ the address information for the symbols.
The debugger reads the symbolic information generated by the compiler &
the address information generated by the linker.
It uses the SIMULATOR (Daniel's S51) to execute the program, the program
My name is Bobby Brown"
\layout Subsection
-Interfacing with XEmacs.
+Interfacing with XEmacs
+\begin_inset LatexCommand \index{XEmacs}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Emacs}
+
+\end_inset
+
+.
\layout Standard
Two files (in emacs lisp) are provided for the interfacing with XEmacs,
\newline
\layout Section
-
+\pagebreak_top
Other Processors
\layout Subsection
\layout Section
Support
+\begin_inset LatexCommand \index{Support}
+
+\end_inset
+
+
\layout Standard
SDCC has grown to be a large project.
\layout Subsection
Reporting Bugs
+\begin_inset LatexCommand \index{Bugs}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Reporting Bugs}
+
+\end_inset
+
+
\layout Standard
Send an email to the mailing list at 'user-sdcc@sdcc.sourceforge.net' or 'devel-sd
Compiling your program with the ---dumpall option can sometimes be useful
in locating optimization problems.
\layout Section
+\pagebreak_top
+Compiler internals
+\layout Subsection
The anatomy of the compiler
\layout Standard
\layout Paragraph*
-Parsing
+Parsing
+\begin_inset LatexCommand \index{Parsing}
+
+\end_inset
+
+
\layout Standard
-Parsing the input source file and creating an AST (Annotated Syntax Tree).
+Parsing the input source file and creating an AST (Annotated Syntax Tree
+\begin_inset LatexCommand \index{Annotated Syntax Tree}
+
+\end_inset
+
+).
This phase also involves propagating types (annotating each node of the
parse tree with type information) and semantic analysis.
There are some MCU specific parsing rules.
\layout Paragraph*
Generating iCode
+\begin_inset LatexCommand \index{iCode}
+
+\end_inset
+
+
\layout Standard
Intermediate code generation.
C source functions.
\layout Paragraph*
-Optimizations.
+Optimizations
+\begin_inset LatexCommand \index{Optimizations}
+
+\end_inset
+
+.
\layout Standard
Bulk of the target independent optimizations is performed in this phase.
\layout Paragraph*
Live range analysis
+\begin_inset LatexCommand \index{Live range analysis}
+
+\end_inset
+
+
\layout Standard
During intermediate code generation phase, the compiler assumes the target
\layout Paragraph*
Register Allocation
+\begin_inset LatexCommand \index{Register Allocation}
+
+\end_inset
+
+
\layout Standard
The register allocation determines the type and number of registers needed
\layout Paragraph*
ICode Example
+\begin_inset LatexCommand \index{ICode Example}
+
+\end_inset
+
+
\layout Standard
This section shows some details of iCode.
\SpecialChar ~
\SpecialChar ~
ret
-\size default
+\newline
+
+\layout Subsection
+
+A few words about basic block successors, predecessors and dominators
+\layout Standard
+
+Successors are basic blocks that might execute after this basic block.
+\newline
+Predecessors are basic blocks that might execute before reaching this basic
+ block.
+\newline
+Dominators are basic blocks that WILL execute before reaching this basic
+ block.
+\newline
+
+\layout Standard
+
+[basic block 1]
+\layout Standard
+
+if (something)
+\layout Standard
+[basic block 2]
+\layout Standard
+
+else
+\layout Standard
+
+[basic block 3]
+\layout Standard
+
+[basic block 4]
\newline
+\layout Standard
+
+a) succList of [BB2] = [BB4], of [BB3] = [BB4], of [BB1] = [BB2,BB3]
+\layout Standard
+
+b) predList of [BB2] = [BB1], of [BB3] = [BB1], of [BB4] = [BB2,BB3]
+\layout Standard
+
+c) domVect of [BB4] = BB1 ...
+ here we are not sure if BB2 or BB3 was executed but we are SURE that BB1
+ was executed.
\layout Section
Acknowledgments
All product names mentioned herein may be trademarks of their respective
companies.
+\layout Section
+
+Alphabetical index
+\layout Standard
+
+To avoid confusion, the installation and building options for sdcc itself
+ (chapter 2) are not part of the index.
\layout Standard
projects / fw / sdcc / blobdiff