Difference between revisions of "BBench-gem5"

From gem5
Jump to: navigation, search
m (Tips for Making Your Disk Image gem5 Friendly)
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This page provides everything you need to get Android, and BBench, working on gem5. BBench is a new web-page rendering benchmark; you can read about it here: [[BBench]]. We have provided pre-compiled disk images and an Android kernel, as well as step-by-step instructions on how to get Android running on gem5 using the ARM ISA.
+
Note that the ICS images are deprecated. Please see the instructions for [[Android_KitKat|running Android on gem5]] and [[WA-gem5|how to use workload automation]].
 
 
== Running BBench on Android with gem5 ==
 
'''Everything required to run BBench on gem5 is provided in the next section. You will need the kernel and the disk image (containing BBench).'''
 
# Get gem5 from the [[Repository]]
 
# Download the basic full system files from the [[Download]] page and build gem5 for the ARM ISA according to these instructions [[Compiling_M5]]
 
# Point the <code>M5_PATH</code> environment variable to this location. E.g, type <code>export M5_PATH=/path_to_gem5_system/system/</code>
 
# Download and uncompress the ARM/Android [http://www.gem5.org/dist/current/bbench/vmlinux_and_config_arm.tgz Kernel]  and place it in the /path_to_gem5_system/system/binaries directory
 
# Download and uncompress the [http://www.gem5.org/dist/current/bbench/Gingerbread_disk_image.tgz Android Disk Image] and place it in the /path_to_gem5_system/system/disks directory
 
# Run <code>/path_to_gem5_root/build/ARM/m5.fast configs/example/fs.py -b bbench --kernel=vmlinux.smp.mouse.arm</code> to run BBench on Android using ARM. Invoke from <code>/path_to_gem5_root</code>.
 
 
 
'''Note: These instructions and images are only for Android on the ARM ISA.'''
 
 
 
== Android Full-System Files ==
 
'''These files contain everything you need to get Android, and BBench, up and running on gem5.'''
 
 
 
* [http://www.gem5.org/dist/current/bbench/vmlinux_and_config_arm.tgz 2.6.35 version kernel] -- Pre-compiled Android kernel and config file.
 
 
 
* [http://www.gem5.org/dist/current/bbench/Gingerbread_disk_image.tgz Gingergread Disk Image with BBench] -- Disk image with a pre-compiled Android Gingerbread file system. This disk image contains all of the files generated during initial boot, as well as a self-terminating version of BBench and BusyBox.
 
 
 
* [http://www.gem5.org/dist/current/bbench/Gingerbread_disk_image_clean.tgz Clean Gingerbread Disk Image] -- Disk image containing only the pre-compiled Android Gingerbread file system. This disk image contains no benchmarks and has never been booted.
 
 
 
* [http://www.gem5.org/dist/current/bbench/ICS_disk_image_clean.tgz Clean ICS Disk Image] -- Disk image containing only the pre-compiled Android ICS file system. The disk image contains no benchmarks and has never been booted.
 
 
 
== Building Your Own Android File System and Kernel ==
 
'''This section gives step-by-step instructions for building a gem5 compatible Ice Cream Sandwich (ICS) disk image.'''
 
# [http://source.android.com/source/initializing.html Initialize] your build environment and [http://source.android.com/source/downloading.html download] the Android source.
 
# Get a copy of the [http://linux-arm.org/LinuxKernel/LinuxAndroidPlatform Armdroid] patches using the following command: <code>git clone git://linux-arm.org/armdroid.git</code>.
 
# Copy the arm device files into the Android device folder: <code>cp path_to_armdroid/fs/src/IceCreamSandwich/Android-ICS-device-arm.tar.bz2 path_to_android_src/device/</code>. Then, untar it.
 
# Copy the Armdroid patches to the appropriate Android source directory. These directories can be inferred from the patch file itself.
 
# Apply those patches by changing to the directories in which the patches were copied and running the command: <code>git apply *.patch</code>
 
# Change into the Android source root directory and build using: <code>make PRODUCT-armboard_v7a-eng -jn</code>.
 
# Create a blank image using the gem5img.py utility: <code>./gem5img.py init android_ics_arm.img 1024</code>
 
# Create a mount point: <code>sudo mkdir -p /mnt/ics</code>
 
# Mount the image: <code>sudo mount -o loop,offset=32256 android_ics_arm.img /mnt/ics</code>
 
# Copy the root/ and system/ folders to the mounted image:
 
## <code>cp -a path_to_android_src/out/target/product/armboard_v7a/root/* /mnt/ics</code>
 
## <code>cp -a path_to_android_src/out/target/product/armboard_v7a/system/* /mnt/ics/system</code>
 
# Unmount the image: <code>sudo umount /mnt/ics</code>
 
 
 
'''Now, to build the 2.6.35 kernel.'''
 
# Get the kernel source: <code>git clone git://linux-arm.org/linux-2.6-armdroid.git -b 2.6.35-armdroid</code>
 
# Get the 2.6.35 config file packaged with the linux kernel above.
 
# Copy it to the kernel source directory as .config.
 
# Build the kernel source: <code>make ARCH=arm CROSS_COMPILE=arm-none-linux-gnueabi- -jn vmlinux EXTRA_CFLAGS=-mno-unaligned-access </code>
 
'''Note: these instructions assume you are using the <i>arm-none-linux-gnueabi</i> compiler toolchain from [http://www.mentor.com/embedded-software/sourcery-tools/sourcery-codebench/editions/lite-edition/ Sourcery CodeBench Lite].'''
 
 
 
'''Config file for 2.6.38 kernel coming soon.'''
 
  
 
== Tips for Making Your Disk Image gem5 Friendly ==
 
== Tips for Making Your Disk Image gem5 Friendly ==
'''Speeding Up the Boot Process'''
+
====Speeding Up the Boot Process====
* When a fresh Android image is booted it generates a lot of files and does a lot of JIT compiling; this can slow down the boot process significantly. gem5 uses a copy-on-write (COW) layer between the simulator and the actual disk image, because of this COW layer none of the changes are stored to the disk image. To make these changes permanent, and avoid having to repeat them in the future, you can remove the COW during the first boot of an image. This will significantly speedup future runs. To do so make the following changes to <code>configs/commong/FSConfig.py</code>:
+
When a fresh Android image is booted it generates a lot of files and does a lot of JIT compiling; this can slow down the boot process significantly. gem5 uses a copy-on-write (COW) layer between the simulator and the actual disk image, because of this COW layer none of the changes are stored to the disk image. To make these changes permanent, and avoid having to repeat them in the future, you can remove the COW layer during the first boot of an image. This will significantly speedup future runs. To do so make the following changes to <code>configs/common/FSConfig.py</code>:
  
 
<code>
 
<code>
Line 71: Line 24:
 
</code>
 
</code>
  
Be careful when doing this. Any changes made to the disk image will be permanent when using the raw ide disk. To ensure that all the changes are written to the disk image properly you can use the <code>sync</code> and <code>halt</code> Linux commands. These are not available on Android so it is recommended that you use something like [http://busybox.net Busybox]. Once the image has finished booting and has settled, you can run <code>busybox sync</code> and <code>busybox halt -f</code> from a gem5 terminal to write all changes to the disk and halt it properly. You will likely get a panic when the simulator exits regarding an unrecognized byte however, this doesn't seem to cause any problems. Remember to re-enable the COW layer once you've finished setting up your disk image.
+
Be careful when doing this. Any changes made to the disk image will be permanent when using the raw ide disk. To ensure that all the changes are written to the disk image properly you can use the <code>sync</code> and <code>halt</code> Linux commands. These are not available on Android so it is recommended that you use something like [http://busybox.net BusyBox]. Once the image has finished booting and has settled, you can run <code>busybox sync</code> and <code>busybox halt -f</code> from a gem5 terminal to write all changes to the disk and halt it properly. You will likely get a panic when the simulator exits regarding an unrecognized byte, however, this doesn't seem to cause any problems. Remember to re-enable the COW layer once you've finished setting up your disk image.
  
'''Busybox'''
+
====BusyBox====
* [http://busybox.net Busybox] is a useful tool providing many common Linux utilities for embedded systems. To build busybox, download the source and compile statically using the following commands:
+
[http://busybox.net BusyBox] is a useful tool providing many common Linux utilities for embedded systems. To build busybox, download the source and compile statically using the following commands:
 
# <code>make CROSS_COMPILE=arm-none-linux-gnueabi- defconfig</code>
 
# <code>make CROSS_COMPILE=arm-none-linux-gnueabi- defconfig</code>
 
# <code>LDFLAGS="--static" make CROSS_COMPILE=arm-none-linux-gnueabi- -jn</code>
 
# <code>LDFLAGS="--static" make CROSS_COMPILE=arm-none-linux-gnueabi- -jn</code>
  
Place the busybox binary into the <code>/sbin/</code> directory of your Android file-system</code>. Run <code>busybox --help</code> to see a full list of the available utilities.
+
Place the busybox binary into the <code>/sbin/</code> directory of your Android file-system. Run <code>busybox --help</code> to see a full list of the available utilities.
  
'''Android Init Process'''
+
====Android Init Process====
* To have your benchmarks start automatically you will likely need to modify the <code>init.rc</code> script located in the file-system's root directory. You can see the changes made to the <code>init.rc</code> script for BBench by looking at the <code>init.rc</code> script in the images we distribute with BBench, this may be a useful template. Another useful resource for understanding the init process is located [http://www.kandroid.org/online-pdk/guide/bring_up.html here].
+
To have your benchmarks start automatically you will likely need to modify the <code>init.rc</code> script located in the file-system's root directory. You can see the changes made to the <code>init.rc</code> script for BBench by looking at the <code>init.rc</code> script in the images we distribute with BBench, this may be a useful template. Another useful resource for understanding the init process is located [http://www.kandroid.org/online-pdk/guide/bring_up.html here].
  
'''m5 Utility'''
+
====m5 Utility====
* You will likely need the <code>m5</code> utility, whose source is located in <code>util/m5/</code>, to do anything useful with your disk image. Build this (statically) and place it in the <code>/sbin/</code> directory of your Android file-system.
+
You will likely need the <code>m5</code> utility, whose source is located in <code>util/m5/</code>, to do anything useful with your disk image. Build this (statically) and place it in the <code>/sbin/</code> directory of your Android file-system.
  
 
== Publications ==
 
== Publications ==
If you use BBench in your work please cite our [http://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=6114205 IISWC 2011 paper]:
+
If you use BBench in your work please cite our [http://dx.doi.org/10.1109/IISWC.2011.6114205 IISWC 2011 paper]:
  
 
A. Gutierrez, R.G. Dreslinski, T.F. Wenisch, T. Mudge, A. Saidi, C. Emmons, and N. Paver. Full-System Analysis and Characterization of Interactive Smartphone Applications. ''IEEE International Symposium on Workload Characterization'', pages 81-90, Austin, TX, November 2011.
 
A. Gutierrez, R.G. Dreslinski, T.F. Wenisch, T. Mudge, A. Saidi, C. Emmons, and N. Paver. Full-System Analysis and Characterization of Interactive Smartphone Applications. ''IEEE International Symposium on Workload Characterization'', pages 81-90, Austin, TX, November 2011.

Latest revision as of 10:58, 20 March 2016

Note that the ICS images are deprecated. Please see the instructions for running Android on gem5 and how to use workload automation.

Tips for Making Your Disk Image gem5 Friendly

Speeding Up the Boot Process

When a fresh Android image is booted it generates a lot of files and does a lot of JIT compiling; this can slow down the boot process significantly. gem5 uses a copy-on-write (COW) layer between the simulator and the actual disk image, because of this COW layer none of the changes are stored to the disk image. To make these changes permanent, and avoid having to repeat them in the future, you can remove the COW layer during the first boot of an image. This will significantly speedup future runs. To do so make the following changes to configs/common/FSConfig.py:

   class RawIdeDisk(IdeDisk):
       image = RawDiskImage(read_only=False)
       def childImage(self, ci):
           self.image.image_file=ci

Then, inside of makeArmSystem(), change from:

   self.c0 = CowIdeDisk(driveID='master')

to

   self.c0 = RawIdeDisk(driveID='master')

Be careful when doing this. Any changes made to the disk image will be permanent when using the raw ide disk. To ensure that all the changes are written to the disk image properly you can use the sync and halt Linux commands. These are not available on Android so it is recommended that you use something like BusyBox. Once the image has finished booting and has settled, you can run busybox sync and busybox halt -f from a gem5 terminal to write all changes to the disk and halt it properly. You will likely get a panic when the simulator exits regarding an unrecognized byte, however, this doesn't seem to cause any problems. Remember to re-enable the COW layer once you've finished setting up your disk image.

BusyBox

BusyBox is a useful tool providing many common Linux utilities for embedded systems. To build busybox, download the source and compile statically using the following commands:

  1. make CROSS_COMPILE=arm-none-linux-gnueabi- defconfig
  2. LDFLAGS="--static" make CROSS_COMPILE=arm-none-linux-gnueabi- -jn

Place the busybox binary into the /sbin/ directory of your Android file-system. Run busybox --help to see a full list of the available utilities.

Android Init Process

To have your benchmarks start automatically you will likely need to modify the init.rc script located in the file-system's root directory. You can see the changes made to the init.rc script for BBench by looking at the init.rc script in the images we distribute with BBench, this may be a useful template. Another useful resource for understanding the init process is located here.

m5 Utility

You will likely need the m5 utility, whose source is located in util/m5/, to do anything useful with your disk image. Build this (statically) and place it in the /sbin/ directory of your Android file-system.

Publications

If you use BBench in your work please cite our IISWC 2011 paper:

A. Gutierrez, R.G. Dreslinski, T.F. Wenisch, T. Mudge, A. Saidi, C. Emmons, and N. Paver. Full-System Analysis and Characterization of Interactive Smartphone Applications. IEEE International Symposium on Workload Characterization, pages 81-90, Austin, TX, November 2011.