diff --git a/README.md b/README.md index 5e15a130781bb959383a881186323b4638d0656f..1c78671040097816cfb288847730d67f712b8413 100644 --- a/README.md +++ b/README.md @@ -60,9 +60,6 @@ Here are some noteworthy sections: * [Self-tests](https://lisa-linux-integrated-system-analysis.readthedocs.io/en/next/lisa_tests.html) * [Kernel tests](https://lisa-linux-integrated-system-analysis.readthedocs.io/en/next/kernel_tests.html) -We are working towards phasing out the [Github wiki](https://github.com/ARM-software/lisa/wiki) in favor of -ReadTheDocs, but in the meantime you may find some extra information there. - # External Links * Linux Integrated System Analysis (LISA) & Friends [Slides](http://events.linuxfoundation.org/sites/events/files/slides/ELC16_LISA_20160326.pdf) diff --git a/doc/index.rst b/doc/index.rst index c8e8a97903c85940f2ad1ab944a8e22dafe42ac1..e91145c43e017a104ba9476b97de68db957431aa 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -4,19 +4,16 @@ contain the root `toctree` directive. LISA API Documentation -============================================== +====================== LISA - "Linux Integrated System Analysis" is a toolkit for interactive analysis and automated regression testing of Linux kernel behaviour. - See the README on the project's `Github home page`__ for an overview. -- Check out the project's `Github Wiki`__ for some guides to installation - and setup. - Once you have LISA running, take a look at the tutorial and example notebooks included with the installation. __ https://github.com/ARM-software/lisa -__ https://github.com/ARM-software/lisa/wiki Contributions to LISA and its documentation are very welcome, and handled via Github pull requests. diff --git a/external/subtrees.conf b/external/subtrees.conf index 10e4126b64e1ea4e0219aaaead7754f4bb68f2c1..c6c7dfb3adbedd3fd7a492dc2d5a5e2f2c0ac072 100644 --- a/external/subtrees.conf +++ b/external/subtrees.conf @@ -13,11 +13,6 @@ path = external/workload-automation url = https://github.com/ARM-Software/workload-automation.git ref = master -[wiki] -path = external/wiki -url = https://github.com/ARM-Software/lisa.wiki.git -ref = master - [bart] path = external/bart # TODO: use the ARM-Software upstream once the Python 3 branch is merged diff --git a/external/wiki/Android-Tools-for-Tracing.md b/external/wiki/Android-Tools-for-Tracing.md deleted file mode 100644 index 3a20dccaaedd5c05a4082046dd12ec70a8f78e65..0000000000000000000000000000000000000000 --- a/external/wiki/Android-Tools-for-Tracing.md +++ /dev/null @@ -1,17 +0,0 @@ -## Systrace - -When performing tests on Android devices, it is possible to exploit [`systrace`](https://developer.android.com/studio/profile/systrace-commandline.html). - -In order to use `systrace` it is recommended to set up `catapult` by simply cloning the repository: - - $ git clone https://github.com/catapult-project/catapult - -and use `systrace` inside an IPython Notebook. Examples of usage of `systrace` can be found in: - -* [Android_YouTube](https://github.com/ARM-software/lisa/blob/master/ipynb/android/workloads/Android_YouTube.ipynb) -* [Android_Workloads](https://github.com/ARM-software/lisa/blob/master/ipynb/android/Android_Workloads.ipynb) - -### atrace - -`atrace` is an Android binary called by `systrace` via `adb` to capture kernel events -using `ftrace`. \ No newline at end of file diff --git a/external/wiki/Energy-Meters-Requirements.md b/external/wiki/Energy-Meters-Requirements.md deleted file mode 100644 index 2dcdbe03923eb2d5554bc46c19757ce49fe4b5cf..0000000000000000000000000000000000000000 --- a/external/wiki/Energy-Meters-Requirements.md +++ /dev/null @@ -1,279 +0,0 @@ -LISA provide integration for some types of energy probes. - -Currently supported instruments are: -* [`HWMON`](https://github.com/ARM-software/lisa/wiki/Energy-Meters-Requirements#linux-hwmon): Linux kernel hardware monitoring -* [`AEP`](https://github.com/ARM-software/lisa/wiki/Energy-Meters-Requirements#arm-energy-probe-aep): ARM Energy Probe -* [`ACME`](https://github.com/ARM-software/lisa/wiki/Energy-Meters-Requirements#iiocapture---baylibre-acme-cape): BleagleBone Black + BayLibre ACME Cape - -Instruments need to be specified either in `target.config` or inside a configuration dictionary to be passed to `TestEnv` when creating the test environment object. - -## Using Energy Meters - -In general, energy meters provide the following methods: - -* `reset()` - reset the energy meters -* `report()` - get total energy consumption since last reset -* `sample()` (optional) - get a sample from the energy meters - -Assuming you declare a target configuration dictionary called `my_conf`, the following code snippet shows how to use the `EnergyMeter` class to measure energy consumption of the target while running a workload. - -```python -my_conf = { - ... - "emeter" : { - # Energy meter configuration. You need to specify an instrument here. - "instrument" : "instrument_name", - "conf" : { - ... - } - "channel_map" : { - ... - } - }, - ... -} - -te = TestEnv(target_conf=my_conf) - -# Reset energy meter -te.emeter.reset() -# Start workload -wload.run() -# Stop energy measurement and report results in a specific output directory -nrg_data, nrg_file = te.emeter.report(te.res_dir) -``` - -The `report()` method returns a `namedtuple` called `EnergyReport` that contains the following data: - -- `channels`: a dictionary whose format is: - -```python -channels = { - "channel_1" : { - # Collected data for channel_1 - }, - ... - "channel_n" : { - # Collected data for channel_n - } -} -``` -- `report_file`: name of the file where collected energy data is stored - -*** - -## Linux HWMON - -The `hwmon` is a generic Linux kernel subsystem, providing access to hardware monitoring components like temperature or voltage/current sensors. - -#### LISA Target Configuration - -Energy sampling with `hwmon` requires the HWMON module to be enabled in `devlib` be specifying it in the target configuration. - -```python -target_conf = { - # Enable hwmon module in devlib - "modules" = ['hwmon'], - - "emeter" = { - "instrument" : "hwmon", - "conf" : { - # Prefixes of the HWMon labels - 'sites' : ['a53', 'a57'], - # Type of hardware monitor to be used - 'kinds' : ['energy'] - }, - # Mapping between sites and user-defined channel names - "channel_map" : { - 'little' : 'a53', - 'big' : 'a57' - } - }, -} -``` - -HWMON are the default energy meter in LISA. Therefore, enabling them as a `devlib` module is enough to get them as energy meters. - -*** - -## ARM Energy Probe (AEP) - -ARM Energy Probes are lightweight power measurement tools for software developers. They can monitor up to three voltage rails simultaneously. - -#### Equipment - -The required equipment is the following: - -* An ARM Energy Probe -* A shunt resistor to be connected between the voltage rail and the probe. The voltage drop - on the resistor must be at most 165 mv. Therefore depending on the maximum current required - by the load, one can properly select the value of the shunt resistor -* Install `caiman` required libraries: - -```bash -sudo apt-get install libudev-dev -``` - -* Clone, compile and install the [`caiman` tool](https://github.com/ARM-software/caiman) - -```bash -git clone https://github.com/ARM-software/caiman.git -cd caiman/caiman && cmake . && make && cd - -cp caiman/caiman /usr/bin -``` - -![ARM Energy Probe](https://developer.arm.com/-/media/developer/products/software-tools/ds-5-development-studio/images/ARM%20Energy%20Probe/ARM_Energy_Probe_4.png?h=378&w=416&hash=90D98087E80D9178CCC28026C1C8E476A6736D09&hash=90D98087E80D9178CCC28026C1C8E476A6736D09&la=en) - -#### LISA Target Configuration - -```python -target_conf = { - "emeter" : { - "instrument" : "aep", - "conf" : { - # Value of the shunt resistor in Ohm - 'resistor_values' : [0.099], - # Device entry assigned to the probe on the host - 'device_entry' : '/dev/ttyACM0', - }, - "channel_map" : { - # : - "BAT" : "channel0" - } - }, -} -``` - -*** - -## iiocapture - Baylibre ACME Cape - -The `iiocapture` instrument exploits the [BayLibre ACME](http://baylibre.com/acme/) solution for measuring power. - -#### Build the software suite - -First step is to get an *IIO version* of the ACME BeagleBone black image. The recommended way of using ACME is to use the pre-built image provided by BayLibre: - -* [ACME Image (beta)](https://github.com/baylibre-acme/ACME/releases/download/b1/acme-beaglebone-black_b1-sdcard-image.xz) - -To change the IP address and avoid a buggy route to a /8 to be added on your host: - -* Change the address of the board in /usr/bin/acme-usbgadget-udhcpd - - ```bash - # Use an address that does not clash with your existing networks - #ifconfig usb0 up 10.65.34.1 netmask 255.255.255.0 - ifconfig usb0 up 192.168.50.1 netmask 255.255.255.0 - ``` - -* Fix the DHCP server config on the ACME board to advertise a small subnet instead of a whole /8 - - ``` - #start 10.65.34.20 #default: 192.168.0.20 - #end 10.65.34.254 #default: 192.168.0.254 - - # Advertise a /24 subnet which contains both the allocated addresses and the address of the board itself - option subnet 255.255.255.0 - start 192.168.50.20 - end 192.168.50.254 - ``` - -#### Equipment -To use this instrument you need the following equipment: - -* A [BeagleBone Black](https://beagleboard.org/black) -* An [ACME Cape](http://sigrok.org/wiki/BayLibre_ACME) -* Power probes for the ACME Cape -* Install the `iio-capture` tool required libraries: - - If `libiio-*` is available from the repositories in your `apt-get`, then run `sudo apt-get install libiio-utils libiio-dev` - - Otherwise, follow the instructions on the [libiio wiki](https://wiki.analog.com/resources/tools-software/linux-software/libiio) on how to build it - -* Clone, compile and install the [`iio-capture` tool](https://github.com/BayLibre/iio-capture) - -```bash -git clone https://github.com/BayLibre/iio-capture.git -cd iio-capture && make && sudo make install && cd - -``` - -If you are using a MicroSD card, please ensure that the card is properly inserted in its slot and to keep pressed the power push-button while connecting the power (via the miniUSB cable). -Here is an image of the configuration we usually use: -[[images/ACMECapeBoardConfiguration.png]] - - -Once the board is booted, by default it has its IP address associated with the `baylibre-acme.local` hostname. -To check for the board being visible in your network, you can use this command -```bash -$ avahi-browse -a -``` -which will list all the reachable devices. - -If you do not want to use avahi, you can refer to it by the static IP of the ethernet-over-USB interface. That has the added benefit of not using the board of somebody else, since that IP is on the USB interface which can only be accessed from your local machine. - -You can now verify your installation and check that the probes are correctly detected by the `iio daemon` running on the BeagleBone with a simple command: - -```bash -$ iio_info -n baylibre-acme.local -``` - -If you have any issues, for example if `iio_info` hangs, or `iio-capture` reports "Unsupported write attribute 'in_oversampling_ratio'", try rebooting the ACME by SSH: - -```bash -$ ssh root@baylibre-acme.local reboot # (replace baylibre-acme.local if you changed the hostname) -``` - -#### LISA Target Configuration - -The target configuration for this instrument is: - -```python -target_conf = { - "emeter" : { - "instrument" : "acme", - "conf" : { - # Absolute path to the iio-capture binary on the host - 'iio-capture' : '/iio-capture', - # Default host name of the BeagleBone Black - 'ip_address' : 'baylibre-acme.local', - }, - "channel_map" : { - "Device0" : 0, # iio:device0 - ... - "DeviceN" : N, # iio:deviceN - } - }, -} -``` - -The ACME Cape 8 probe slots numbered 1 to 8. `iio:device` is the n-th discovered probe and they are discovered in ascending order. For example, if you have 2 probes attached to PROBE2 and PROBE7, then PROBE2 will be `iio:device0` and PROBE7 will be `iio:device1`. - -## Monsoon Power Monitor - -The `Monsoon` energy meter allows collecting data from Monsoon Solutions Inc's Power Monitor. - -#### Setup - -This meter depends on the monsoon.py script from AOSP. To set this up, download that script from [here](https://android.googlesource.com/platform/cts/+/master/tools/utils/monsoon.py) and run `pip install gflags pyserial`. - -The Power Monitor acts as a power supply as well as an energy meter. LISA doesn't currently automate setting this up. You'll need to manually run these commands: - -``` -monsoon.py --current -monsoon.py --voltage -monsoon.py --usbpassthrough on -``` - -#### LISA Target Configuration - -The target configuration for this instrument is: - -```python -target_conf = { - "emeter" : { - "instrument" : "monsoon", - "conf" : { - # Path to monsoon.py. If it's in your $PATH, this is not required - 'monsoon_bin' : '/monsoon.py', - }, - }, -} -``` diff --git a/external/wiki/FAQ.md b/external/wiki/FAQ.md deleted file mode 100644 index 79f6e935b980340d6d0dcdd7575daae108916cd9..0000000000000000000000000000000000000000 --- a/external/wiki/FAQ.md +++ /dev/null @@ -1,20 +0,0 @@ -## How do I get a new device up and running in LISA ? - -As it stands, there is a bit of work to get a new target device working with LISA. There are plans to make this process more user-friendly, see https://github.com/ARM-software/lisa/issues/425 - -### Platform description - -To run some post-processing, LISA will be looking for a platform description found in **\${LISA_HOME}/libs/utils/platforms/.json**. This board name is either referenced in the Notebook you are running, or in the **${LISA_HOME}/target.config** file. That configuration should have these fields: - -``` -my_conf = { - # Target platform and board - "platform" : 'android', - "board" : '', - ... -} -``` - -LISA can read the energy-model from the device itself, but the platform file is currently required. As such, you need to generate it. [This branch](https://github.com/valschneider/lisa/tree/better_nrg) has two commits to dump the platform file after reading the energy model from the device, but you should make sure the little and big clusters are labelled correctly. - -Furthermore, you will have to to manually fill-in the core info (`"board"` dictionary entry). See **${LISA_HOME}/libs/utils/platforms/pixel.json** for an example of such an entry. \ No newline at end of file diff --git a/external/wiki/Home.md b/external/wiki/Home.md deleted file mode 100644 index 493fdae6f49d36ff5568078c7cb992f981be36cf..0000000000000000000000000000000000000000 --- a/external/wiki/Home.md +++ /dev/null @@ -1,29 +0,0 @@ -## LISA - Linux Interactive System Analysis - -### What is LISA? - -The LISA is a toolkit that supports regression testing and interactive analysis of workload behaviours in Linux environment. LISA helps Linux kernel developers to measure the impact of modifications in core parts of the kernel. The focus is on the scheduler, power management and thermal frameworks. Nevertheless, LISA is generic and can be used for other purposes too. - -LISA provides an API for modelling use-cases of interest and developing regression tests for use-cases. A ready made set of test-cases to support regression testing of core kernel features is provided. In addition, LISA uses the excellent IPython Notebook framework and a set of example notebooks for live experiments on a target platform. - -### Motivations - -Main goals of LISA are: - -* Support study of existing behaviours (i.e. *"how does PELT work?"*) -* Support analysis of new code being developed (i.e. *"what is the impact on existing code?"*) -* Get insights on what's not working and possibly chase down why -* Share reproducible experiments by means of a **common language** that: - * is **flexible enough** to reproduce the same experiment on different targets - * **simplifies** generation and execution of well defined workloads - * **defines** a set of metrics to evaluate kernel behaviours - * **enables** kernel developers to easily post process data to produce statistics and plots - - -### Overall View -![LISA Overall View](https://cloud.githubusercontent.com/assets/63746/16997941/7644ea56-4eaf-11e6-81af-310c3f0e2ef6.png) - -### External Links -* Linux Integrated System Analysis (LISA) & Friends - [Slides](http://events.linuxfoundation.org/sites/events/files/slides/ELC16_LISA_20160326.pdf) and - [Video](https://www.youtube.com/watch?v=yXZzzUEngiU) \ No newline at end of file diff --git a/external/wiki/Installation.md b/external/wiki/Installation.md deleted file mode 100644 index 0a27e3cc23de521aab5a8128384a0f86841475c6..0000000000000000000000000000000000000000 --- a/external/wiki/Installation.md +++ /dev/null @@ -1,167 +0,0 @@ -This note assumes installation from scratch on a freshly installed -Ubuntu 16.04 system. If you have a different system (e.g. OSX or an -older version of Ubuntu) you can refer to the [Virtual -Machine based installation](https://github.com/ARM-software/lisa/wiki/Installation#virtual-machine-based-installation). - -## Contents - -1. [Standard Installation](https://github.com/ARM-software/lisa/wiki/Installation#standard-installation) -2. [Virtual Machine based installation](https://github.com/ARM-software/lisa/wiki/Installation#virtual-machine-based-installation) - -## Standard Installation - -### Required dependencies - - # Install common build related tools - $ sudo apt-get install build-essential autoconf automake libtool pkg-config - - # Install additional tools required for some notebooks and tests - $ sudo apt-get install trace-cmd sshpass kernelshark - - # Install optional tools required for some notebooks and tests - $ sudo apt-get install nmap net-tools tree - - # Install required libraries packages - $ sudo apt-get install libfreetype6-dev libpng12-dev - - # Install the Python package manager - $ sudo apt-get install python-pip python-dev - - # Update the Python package manager (some distribution may have an outdated version) - $ pip install --upgrade pip - - # Install (upgrade) required python packages - $ sudo pip install --upgrade matplotlib numpy nose - - # Install (upgrade) required Python libraries - $ sudo pip install --upgrade Cython trappy bart-py devlib psutil wrapt - - # Some specific notebooks may also require scipy - $ sudo pip install --upgrade scipy - -*NOTE:* TRAPpy and BART depend on `ipython` and `jupyter`. Some IPython -Notebooks examples are written using the notebooks JSON nbformat version 4, -which might not be supported by the IPython version installed by `apt-get`. -It is suggested to remove apt-get installed IPython and install it -using `pip`, which will provides the most updated version: - - # Remove (eventually) already installed versions - $ sudo apt-get remove ipython ipython-notebook - # Install most update version of the notebook - $ sudo pip install ipython jupyter - -### Installing Jupyter NBextensions - -The Jupyter notebook server installed in the previous step is just a basic version. -Although it's just enough to open and use all the notebooks provided by LISA, if you -want to take maximum advantages of the Notebooks a standard set of extensions are -provided as a dependency repository. - -To install the extensions you should follow the instructions on that official websiste: - - [[https://github.com/ipython-contrib/jupyter_contrib_nbextensions]] - -The requires steps should be: - - $ pip install jupyter_contrib_nbextensions - $ jupyter contrib nbextension install --user - -### Clone the repository - -The code of the LISA toolkit with all the supported tests and Notebooks can be -cloned from the official GitHub repository with this command: - - $ git clone https://github.com/ARM-software/lisa.git - -### Clone the submodules - -LISA depends on `bart`, `devlib` and `TRAPpy`. - - $ source init_env - $ lisa-update submodules - -## Virtual Machine based installation - -LISA provides a Vagrant recipe which allows to automate the generation of a -VirtualBox based virtual machine pre-configured to run LISA. To generate -and use such a virtual machine you need: - -- VirtualBox intalled in your machine, you can download the VM installer for - your specific system from this page: https://www.virtualbox.org/wiki/Downloads - -- Vagrant installed in your machine, you can download the installer for your - specific system from this page: https://www.vagrantup.com/downloads.html -```bash -$ wget https://releases.hashicorp.com/vagrant/1.8.1/vagrant_1.8.1_x86_64.deb -$ sudo dpkg -i ./vagrant_1.8.1_x86_64.deb -``` -Once these two components are available in your machine, to install LISA you -need to: - -- clone the LISA repository in a local folder -```bash -# Clone the master LISA repository -$ git clone https://github.com/ARM-software/lisa.git -``` -- create and start a Vagrant/VirtualBox VM -```bash -# Enter the LISA source tree -$ cd lisa -# Install LISA and its dependencies within the virtual machine -$ vagrant up -``` -This last command builds and executes the VM according to the description -provided by the Vagrant file available in the root folder of the LISA -source tree. The first time you run this command it will take some time -to download the based Ubuntu image and to install the required LISA -dependencies. The actual time depends on the speed of your internet -connection. - -### Enable USB Controller - -To be able to access devices connected through the USB, it is necessary to -enable the USB controller for the VM in `VirtualBox`. The following steps -explain how to do it: - -- Halt the vagrant VM by running - -```bash -vagrant halt -``` - -- Open the `VirtualBox` VM Manager - -- Select the `lisa_default_*` virtual machine and click **Settings** - -- Select the **USB** tab and enable the USB controller as shown in the screen-shot - -[[images/vbox_enable_usb.png]] - -- Add a **USB filter** for each of the devices that should be available in the VM as -shown in the screen-shot below - -[[images/vbox_add_usb_filter.png]] - -- Finally click **OK** to save the settings - -It is now possible to start the VM by running: - -```bash -vagrant up -``` - -### Run LISA in vagrant - -When the installation complete you will get a prompt from the LISA shell -which is running within the VM you just built. This VM shell can be -accessed from another terminal using this command -```bash -# from within the LISA root folder... -$ vagrant ssh -``` -Once you exit all the LISA shell the VM is automatically stopped by vagrant. -The next time you run the "up" command the VM will be started again and you -will get a LISA shell. - -From within the LISA shell you can start the IPython Notebooks server -by following the instructions [here](https://github.com/ARM-software/lisa/wiki/Quickstart-Tutorial). diff --git a/external/wiki/Integrating-a-new-board-in-LISA.md b/external/wiki/Integrating-a-new-board-in-LISA.md deleted file mode 100644 index 5a73e07461267ca30148794094dac4b8958f154a..0000000000000000000000000000000000000000 --- a/external/wiki/Integrating-a-new-board-in-LISA.md +++ /dev/null @@ -1,25 +0,0 @@ -Adding support for your device is a simple as writing a JSON file with the following information: - -```json -{ - "board" : { - "cores" : ["A53", "A53", "A57", "A57"], - "big_core" : "A57", - "modules" : ["bl", "cpufreq"] - } -} -``` -Where: - -- `cores`: is the list of core names of the cores available in the system -- `big_core`: is the name of the big core (must be one of the names -- `modules`: (optional) the list of `devlib` modules to be loaded by default for this board - -The two parameters are needed to understand the topology of the target device. - -The file must be placed under `/utils/platforms/`. - -NOTE: As of now, **only dual cluster devices are fully supported**. -To add a single-cluster device, remove the `big_core` entry and the `bl` module -from the json configuration. - diff --git a/external/wiki/Quickstart-Tutorial.md b/external/wiki/Quickstart-Tutorial.md deleted file mode 100644 index dc0d2c1e4a9b869087a3bd1eb3bbf5d7bdfa684a..0000000000000000000000000000000000000000 --- a/external/wiki/Quickstart-Tutorial.md +++ /dev/null @@ -1,71 +0,0 @@ -Once you've cloned LISA, source init_env to initialize the LISA Shell, which provides -a convenient set of shell commands for easy access to many LISA related -functions. - -```shell -$ source init_env -``` - -Run `lisa-help` to see an overview of the provided LISA commands. - -## Starting the IPython server to use LISA notebooks - -To start the IPython Notebook Server required to use this Notebook, on a -LISAShell run: - -```shell -[LISAShell lisa] \> lisa-ipython start - -Starting IPython Notebooks... -Starting IPython Notebook server... - IP Address : http://127.0.0.1:8888/ - Folder : /home/derkling/Code/lisa/ipynb - Logfile : /home/derkling/Code/lisa/ipynb/server.log - PYTHONPATH : - /home/derkling/Code/lisa/libs/bart - /home/derkling/Code/lisa/libs/trappy - /home/derkling/Code/lisa/libs/devlib - /home/derkling/Code/lisa/libs/wlgen - /home/derkling/Code/lisa/libs/utils - - -Notebook server task: [1] 24745 -``` - -Note that the `lisa-ipython` command allows to specify also interface and -port in case you have several network interfaces on your host: - -```lisa-ipython start [interface [port]]``` - -The URL of the main folder served by the server is printed on the screen. -By default it is - http://127.0.0.1:8888/ - -Once the server is started you can have a look at the provide tutorial notebooks -are accessible by following (in your browser) this link: - - http://127.0.0.1:8888/notebooks/tutorial/00_LisaInANutshell.ipynb - -This initial tutorial can be seen (but not executed) also on GitHub: - - https://github.com/ARM-software/lisa/blob/master/ipynb/tutorial/00_LisaInANutshell.ipynb - -## Running automated tests - -To run automated tests, you'll first need to configure the test framework to access your target. -Edit `target.config` with these details - this file contains comments describing the information -you'll need to add. For example: - -- For an SSH (Linux) target you'll usually need to edit: - - The "platform" field to "linux" - - The "board" field to the name of your device (leave blank if it isn't listed as an option) - - The "host" field to provide the IP address - - The "username" and "password" fields, or the "keyfile" field to provide login credentials. - -- For an ADB (Android) target, you'll usually need to edit: - - The "platform" to "android" - - The "board" field to the name of your device (leave blank if it isn't listed as an option) - - The "device" field to provide the Android device ID. - -Once your target is set up, you can run automated tests via the `lisa-test` command in the LISA shell. -Run `lisa-test help` to see the format of this command. diff --git a/external/wiki/Target-platform-requirements.md b/external/wiki/Target-platform-requirements.md deleted file mode 100644 index b547a54351f8b3e5725a3a9c106eb180e526c402..0000000000000000000000000000000000000000 --- a/external/wiki/Target-platform-requirements.md +++ /dev/null @@ -1,51 +0,0 @@ -## Contents - -1. [Linux Targets](https://github.com/ARM-software/lisa/wiki/Target-platform-requirements#linux-targets) -2. [Android Targets](https://github.com/ARM-software/lisa/wiki/Target-platform-requirements#android-targets) -3. [Kernel features](https://github.com/ARM-software/lisa/wiki/Target-platform-requirements#kernel-features) - -The target platform to be used for experiments with LISA must satisfy -the following requirements: - -## Linux Targets - -- allow `ssh` access, preferably as root, using either a password or an SSH key. - - Note that on Ubuntu targets, SSH root access can be enabled by setting `PermitRootLogin yes` - in the file `/etc/ssh/sshd_config`, and then restarting the SSH daemon. - -- support `sudo`, even if it's accessed as root user - -## Android Targets - -- allow `adb` access, eventually by specifying a *DEVICE ID* -- the local shell should define the `ANDROID_HOME` environment variable pointing - to an Android SDK installation. If you are not using the virtual machine based - installation you will have to install the command line tools from - [here](https://developer.android.com/studio/index.html). - -Analysis on Android devices can be done using `systrace` instead of `ftrace`. If -you plan to use `systrace` read -[this guide](https://github.com/ARM-software/lisa/wiki/Android-Tools-for-Tracing). - -## Kernel features - -Most of the tests targets a kernel with support for some new frameworks which -are currently in-development: - -- Energy-Aware Scheduler (EAS) -- SchedFreq: the CPUFreq governor -- SchedTune: the central, scheduler-driven, power-perfomance control - -Tests targeting an evaluation of these frameworks requires also a set of -tracepoint which are not available in mainline kernel. The series of patches -required to add to a recent kernel the tracepoints required by some tests are -available on this git repository and branch: - - $ git://www.linux-arm.org/linux-pb.git lisa/debug - -The patches required are the ones in this series: - - $ git log --oneline lisa/debug_base..lisa/debug - -There is also a [GitWeb Link](http://www.linux-arm.org/git?p=linux-pb.git;a=shortlog;h=refs/heads/lisa/debug) to the list of required tracepoints which are the topmost patches with a name starting by "DEBUG: ". diff --git a/external/wiki/_Sidebar.md b/external/wiki/_Sidebar.md deleted file mode 100644 index 8640b4ad65859c7963f8d82d46e68e508902c69b..0000000000000000000000000000000000000000 --- a/external/wiki/_Sidebar.md +++ /dev/null @@ -1,9 +0,0 @@ -* [Installation](https://github.com/ARM-software/lisa/wiki/Installation) - + [Standard Installation](https://github.com/ARM-software/lisa/wiki/Installation#standard-installation) - + [Virtual Machine based installation](https://github.com/ARM-software/lisa/wiki/Installation#virtual-machine-based-installation) -* [Quickstart Tutorial](https://github.com/ARM-software/lisa/wiki/Quickstart-Tutorial) -* [Target platform requirements](https://github.com/ARM-software/lisa/wiki/Target-platform-requirements) - + [Integrating a new board in LISA](https://github.com/ARM-software/lisa/wiki/Integrating-a-new-board-in-LISA) - + [Energy Meters Requirements](https://github.com/ARM-software/lisa/wiki/Energy-Meters-Requirements) -* [Android Tools for Tracing](https://github.com/ARM-software/lisa/wiki/Android-Tools-for-Tracing) -* [FAQ](https://github.com/ARM-software/lisa/wiki/FAQ) \ No newline at end of file diff --git a/external/wiki/images/ACMECapeBoardConfiguration.png b/external/wiki/images/ACMECapeBoardConfiguration.png deleted file mode 100644 index 7a41cea62068012b1e2b1492975b13da24230528..0000000000000000000000000000000000000000 Binary files a/external/wiki/images/ACMECapeBoardConfiguration.png and /dev/null differ diff --git a/external/wiki/images/vbox_add_usb_filter.png b/external/wiki/images/vbox_add_usb_filter.png deleted file mode 100644 index 696dc19b92c4052e77e70b0c3db21de42597f365..0000000000000000000000000000000000000000 Binary files a/external/wiki/images/vbox_add_usb_filter.png and /dev/null differ diff --git a/external/wiki/images/vbox_enable_usb.png b/external/wiki/images/vbox_enable_usb.png deleted file mode 100644 index 69b073f79a81e4d4c80587d5f4a3fe37b56aa333..0000000000000000000000000000000000000000 Binary files a/external/wiki/images/vbox_enable_usb.png and /dev/null differ diff --git a/wiki b/wiki deleted file mode 120000 index 4f413720ea2354cc4f4498a15fc4e948a20bafa1..0000000000000000000000000000000000000000 --- a/wiki +++ /dev/null @@ -1 +0,0 @@ -external/wiki \ No newline at end of file