globally rename Fail* to FAIL*
Change-Id: Ief2cb687cc69dd92c2e04f9314f0f1347e0a84ed
This commit is contained in:
Horst Schirmeier
@ -1,8 +1,8 @@
|
||||
=========================================================================================
|
||||
Additional libraries/packages/tools needed for Fail*:
|
||||
Additional libraries/packages/tools needed for FAIL*:
|
||||
=========================================================================================
|
||||
|
||||
Required for Fail*:
|
||||
Required for FAIL*:
|
||||
**********************************************************************
|
||||
- libmysqlclient-dev or libmariadbclient-dev
|
||||
- libprotobuf-dev
|
||||
@ -79,10 +79,10 @@ For distribution/parallelization:
|
||||
it exists.
|
||||
|
||||
=========================================================================================
|
||||
Compiling, building and modifying: Simulators and Fail*
|
||||
Compiling, building and modifying: Simulators and FAIL*
|
||||
=========================================================================================
|
||||
|
||||
Building Fail*:
|
||||
Building FAIL*:
|
||||
**********************************************************************
|
||||
|
||||
For the first time:
|
||||
@ -101,7 +101,7 @@ For the first time:
|
||||
$ ccmake .
|
||||
Select "BUILD_BOCHS" or "BUILD_GEM5". Select an experiment to enable by
|
||||
naming its "experiments/" subdirectory under "EXPERIMENTS_ACTIVATED".
|
||||
Configure Fail* features you need for this experiment by enabling
|
||||
Configure FAIL* features you need for this experiment by enabling
|
||||
"CONFIG_*" options. Press 'c', 'g' to regenerate the build system.
|
||||
(Alternatively use
|
||||
$ cmake-gui .
|
||||
@ -111,18 +111,18 @@ For the first time:
|
||||
for your need.
|
||||
|
||||
|
||||
After changes to Fail* code:
|
||||
After changes to FAIL* code:
|
||||
------------------------------------------------------------
|
||||
Compile (in ${BUILD_DIR}, optionally "add -jN" for parallel building):
|
||||
$ make
|
||||
CMake will build all Fail* libraries and link them with the simulator backend
|
||||
CMake will build all FAIL* libraries and link them with the simulator backend
|
||||
library to a binary called "fail-client". You may use the shell script
|
||||
$ ${FAIL_DIR}/scripts/rebuild-bochs.sh [-]
|
||||
to speed up repetitive tasks regarding Fail/Bochs builds. This script contains
|
||||
a concise documentation on itself.
|
||||
|
||||
|
||||
Add new Fail* sources to build chain:
|
||||
Add new FAIL* sources to build chain:
|
||||
------------------------------------------------------------
|
||||
To add new source files to the build, see CMakeLists.txt in the subdirectory of the
|
||||
corresponding component in "${FAIL_DIR}/src/core/", and probably consultate the
|
||||
@ -136,7 +136,7 @@ new subdirectory in "experiments/", activate it in the CMake configuration step
|
||||
above).
|
||||
|
||||
|
||||
Generating the Doxygen documentation for Fail*:
|
||||
Generating the Doxygen documentation for FAIL*:
|
||||
**********************************************************************
|
||||
To generate the Doxygen documentation, type:
|
||||
$ make doc
|
||||
@ -151,7 +151,7 @@ to be compiled previously:
|
||||
FailBochs: Bochs configuration features
|
||||
**********************************************************************
|
||||
|
||||
The autotools-based bochs is configured within the Fail* build run.
|
||||
The autotools-based bochs is configured within the FAIL* build run.
|
||||
The configuration flags can be set within the ccmake configuration (ccmake ${FAIL_DIR}/build)
|
||||
- Sufficient:
|
||||
--enable-cpu-level=6;--enable-ne2000;--enable-trace-cache;--enable-gdb-stub;--disable-docbook;--with-nogui
|
||||
@ -160,7 +160,7 @@ FailBochs: Bochs configuration features
|
||||
The --with-nogui flag suffices for for "headless" experiments, with the
|
||||
advantage of removing lots of library dependencies (thus reducing startup
|
||||
overhead). --with-x11 enables only the "x" (X11), --with-wx only the "wx"
|
||||
(wxWidgets) GUI. Note that "wx" does not play well together with Fail*'s
|
||||
(wxWidgets) GUI. Note that "wx" does not play well together with FAIL*'s
|
||||
"restore" feature (FailBochs will fall back to "x" if available, or die
|
||||
trying.)
|
||||
Once you know everything works as it should, you may want to add the
|
||||
@ -189,7 +189,7 @@ Debug build:
|
||||
Configure Bochs to use debugging-related compiler flags (expects to be in ${BUILD_DIR}):
|
||||
$ cd ../simulator/bochs
|
||||
$ CFLAGS="-g -O0" CXXFLAGS="-g -O0" ./configure --prefix=... ... (see above)
|
||||
You might additionally want to configure the rest of Fail* into debug mode by
|
||||
You might additionally want to configure the rest of FAIL* into debug mode by
|
||||
setting CMAKE_BUILD_TYPE to "Debug" (ccmake, see above).
|
||||
FIXME: Does this still work?
|
||||
|
||||
@ -220,7 +220,7 @@ Building gem5:
|
||||
|
||||
For the first time (incl. selecting an experiment):
|
||||
------------------------------------------------------------
|
||||
1. Change to the Fail* directory (expects to be in ${FAIL_DIR}) and
|
||||
1. Change to the FAIL* directory (expects to be in ${FAIL_DIR}) and
|
||||
create a new build directory.
|
||||
$ cd ${FAIL_DIR}; mkdir build; cd build
|
||||
3. Start the configuration by typing
|
||||
@ -233,7 +233,7 @@ For the first time (incl. selecting an experiment):
|
||||
BUILD_BOCHS and BUILD_X86.
|
||||
5. Typing
|
||||
$ make (or nice make -jN)
|
||||
will start the build process of Fail* and gem5. This automatically
|
||||
will start the build process of FAIL* and gem5. This automatically
|
||||
builds the debug variant for ARM targets. (Note that this build will
|
||||
automatically include the ${FAIL_DIR}/src/core/sal/gem5 as an
|
||||
"EXTRAS" feature, see gem5/scons build system documentation for
|
||||
@ -248,13 +248,13 @@ For the first time (incl. selecting an experiment):
|
||||
NOTE: gem5 currently does not compile with the newer clang-based daily builds
|
||||
of AspectC++ (ac++). You may need to use the ac++ 1.2 release instead.
|
||||
|
||||
After changes to Fail*/gem5 code (incl. aspect headers):
|
||||
After changes to FAIL*/gem5 code (incl. aspect headers):
|
||||
------------------------------------------------------------
|
||||
1. Clean the current build by typing
|
||||
$ make gem5-allclean
|
||||
(in your build dir ${FAIL_DIR}/build). This cleans the current
|
||||
Fail* and gem5 build directories. Note that "make clean" only cleans
|
||||
the Fail* build directory. Furthermore, all remaining CMake remnants
|
||||
FAIL* and gem5 build directories. Note that "make clean" only cleans
|
||||
the FAIL* build directory. Furthermore, all remaining CMake remnants
|
||||
should be deleted:
|
||||
$ find -name CMakeCache.txt | xargs rm
|
||||
2. Rebuild by typing
|
||||
@ -290,7 +290,7 @@ Database backend setup: MySQL / MariaDB
|
||||
Building LLVM from sources
|
||||
=========================================================================================
|
||||
If your Linux distribution does not provide a library package for LLVM 3.3 or
|
||||
newer, and you need LLVM support in Fail*, you may need to build LLVM from the
|
||||
newer, and you need LLVM support in FAIL*, you may need to build LLVM from the
|
||||
sources and install it, e.g., locally in your home.
|
||||
|
||||
1. Download the source tarball of LLVM 3.4 from http://llvm.org (or use the git
|
||||
|
||||
Reference in New Issue
Block a user