Merge branch 'master' of github.com:hioa-cs/IncludeOS

Author: alfreb

.editorconfig

@@ -21,3 +21,6 @@ indent_size = 4
 
 [boot]
 indent_size = 4
+
+[*.asm]
+indent_size = 4

.gitignore

@@ -39,9 +39,13 @@ src/compile_commands.json
 /examples/demo_service/IncludeOS_Demo_Service
 /seed/My_Service
 
-build
+build/
+build_i686/
+build_x86_64/
 
 # cmake related
 CMakeFiles*
 CMakeCache*
 cmake_install.cmake
+
+dummy.disk

CMakeLists.txt

@@ -2,20 +2,33 @@ cmake_minimum_required(VERSION 2.8.9)
 
 set(INCLUDEOS_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/)
 
-set(CMAKE_TOOLCHAIN_FILE ${INCLUDEOS_ROOT}/cmake/i686-elf-toolchain.cmake)
+# Target CPU Architecture
+if(DEFINED ENV{ARCH})
+  set(ARCH "$ENV{ARCH}" CACHE STRING "Architecture")
+else()
+  set(ARCH "x86_64" CACHE STRING "Architecture (default)")
+endif()
+
+message(STATUS "Target CPU ${ARCH}")
+
+set(TRIPLE "${ARCH}-pc-linux-elf")
+set(CMAKE_CXX_COMPILER_TARGET ${TRIPLE})
+set(CMAKE_C_COMPILER_TARGET ${TRIPLE})
+
+message(STATUS "Target triple ${TRIPLE}")
+
+option(WITH_SOLO5 "Install with solo5 support" ON)
+
+set(CMAKE_TOOLCHAIN_FILE ${INCLUDEOS_ROOT}/cmake/${ARCH}-elf-toolchain.cmake)
 
-project (includeos)
+project (includeos C CXX)
 
 set(LIB ${CMAKE_INSTALL_PREFIX}/includeos/lib)
 set(BIN ${CMAKE_INSTALL_PREFIX}/includeos/bin)
 set(SCRIPTS ${CMAKE_INSTALL_PREFIX}/includeos/scripts)
 
-# test compiler
-if(CMAKE_COMPILER_IS_GNUCC)
-	# currently gcc is not supported due to problems cross-compiling a unikernel
-	# (i.e., building a 32bit unikernel (only supported for now) on a 64bit system)
-#	message(FATAL_ERROR "Building IncludeOS with gcc is not currently supported. Please clean-up build directory and configure for clang through CC and CXX environmental variables.")
-endif(CMAKE_COMPILER_IS_GNUCC)
+# C++ version
+set(CMAKE_CXX_STANDARD 14)
 
 # create OS version string from git describe (used in CXX flags)
 execute_process(COMMAND git describe --dirty
@@ -34,8 +47,10 @@ else()
   set(DEFAULT_VM "vm.cpu_feat.json") # vmrunner
 endif(cpu_feat_vanilla)
 
+option(single_threaded "Compile without SMP support" ON)
+
 # create random hex string as stack protector canary
-string(RANDOM LENGTH 8 ALPHABET 0123456789ABCDEF STACK_PROTECTOR_VALUE)
+string(RANDOM LENGTH 16 ALPHABET 0123456789ABCDEF STACK_PROTECTOR_VALUE)
 
 set(CAPABS "${CAPABS} -fstack-protector-strong -D_STACK_GUARD_VALUE_=0x${STACK_PROTECTOR_VALUE}")
 
@@ -45,7 +60,7 @@ set(CAPABS "${CAPABS} -fstack-protector-strong -D_STACK_GUARD_VALUE_=0x${STACK_P
 # * _GNU_SOURCE enables POSIX-extensions in newlib, such as strnlen. ("everything newlib has", ref. cdefs.h)
 set(CAPABS "${CAPABS} -DNO_DEBUG=1 -DOS_TERMINATE_ON_CONTRACT_VIOLATION -D_GNU_SOURCE")
 
-set(WARNS "-Wall -Wextra") #-pedantic
+set(WARNS "-Wall -Wextra")
 
 # configure options
 option(debug "Build with debugging symbols (OBS: Dramatically increases binary size)" OFF)
@@ -63,6 +78,9 @@ endfunction()
 init_submodule(mod/GSL)
 init_submodule(mod/http-parser)
 init_submodule(mod/uzlib)
+init_submodule(mod/rapidjson)
+
+install(DIRECTORY mod/rapidjson/include/rapidjson DESTINATION includeos/include)
 
 # set optimization level
 set(OPTIMIZE "-O2")
@@ -92,14 +110,29 @@ endif(silent)
 # Append optimization level
 set(CAPABS "${CAPABS} ${OPTIMIZE}")
 
+# object format needs to be set BEFORE enabling ASM
+# see: https://cmake.org/Bug/bug_relationship_graph.php?bug_id=13166
+if ("${ARCH}" STREQUAL "i686")
+  set(CMAKE_ASM_NASM_OBJECT_FORMAT "elf")
+  set(OBJCOPY_TARGET "elf32-i386")
+  set(CAPABS "${CAPABS} -m32")
+else()
+  set(CMAKE_ASM_NASM_OBJECT_FORMAT "elf64")
+  set(OBJCOPY_TARGET "elf64-x86-64")
+  set(CAPABS "${CAPABS} -m64")
+endif()
+
+enable_language(ASM_NASM)
+
+# initialize C and C++ compiler flags
 if (CMAKE_COMPILER_IS_GNUCC)
   # gcc/g++ settings
-  set(CMAKE_CXX_FLAGS "-m32 -MMD ${CAPABS} ${WARNS} -Wno-frame-address -nostdlib -c -std=c++14 -D_LIBCPP_HAS_NO_THREADS=1 -DOS_VERSION=\\\"${OS_VERSION}\\\"")
-  set(CMAKE_C_FLAGS "-m32 -MMD ${CAPABS} ${WARNS} -nostdlib -c -DOS_VERSION=\"\"${OS_VERSION}\"\"")
+  set(CMAKE_CXX_FLAGS " -MMD ${CAPABS} ${WARNS} -Wno-frame-address -nostdlib -fno-omit-frame-pointer -c -D_LIBCPP_HAS_NO_THREADS=1 -DOS_VERSION=\\\"${OS_VERSION}\\\"")
+  set(CMAKE_C_FLAGS " -MMD ${CAPABS} ${WARNS} -nostdlib -fno-omit-frame-pointer -c -DOS_VERSION=\"\"${OS_VERSION}\"\"")
 else()
   # these kinda work with llvm
-  set(CMAKE_CXX_FLAGS "-target i686 -MMD ${CAPABS} ${WARNS} -nostdlib -nostdlibinc -c -m32 -std=c++14 -D_LIBCPP_HAS_NO_THREADS=1 -DOS_VERSION=\\\"${OS_VERSION}\\\"")
-  set(CMAKE_C_FLAGS "-target i686 -MMD ${CAPABS} ${WARNS} -nostdlib -nostdlibinc -c -m32 -DOS_VERSION=\"\"${OS_VERSION}\"\"")
+  set(CMAKE_CXX_FLAGS "-MMD ${CAPABS} ${WARNS} -nostdlib -nostdlibinc -fno-omit-frame-pointer -c  -D_LIBCPP_HAS_NO_THREADS=1 -DOS_VERSION=\\\"${OS_VERSION}\\\"")
+  set(CMAKE_C_FLAGS "-MMD ${CAPABS} ${WARNS} -nostdlib -nostdlibinc -fno-omit-frame-pointer -c -DOS_VERSION=\"\"${OS_VERSION}\"\"")
 endif()
 
 # either download or cross-compile needed libraries
@@ -125,6 +158,7 @@ if(vmbuild)
   # Install vmbuilder as an external project
   ExternalProject_Add(vmbuild
     PREFIX vmbuild # Build where
+    BUILD_ALWAYS 1
     SOURCE_DIR ${INCLUDEOS_ROOT}/vmbuild # Where is project located
     BINARY_DIR ${INCLUDEOS_ROOT}/vmbuild/build
     INSTALL_DIR ${BIN} # Where to install
@@ -135,6 +169,7 @@ endif(vmbuild)
 option(diskbuilder "Build and install memdisk helper tool" ON)
 if(diskbuilder)
   ExternalProject_Add(diskbuilder
+    BUILD_ALWAYS 1
     SOURCE_DIR ${INCLUDEOS_ROOT}/diskimagebuild
     BINARY_DIR ${INCLUDEOS_ROOT}/diskimagebuild/build
     INSTALL_DIR ${BIN}
@@ -164,32 +199,36 @@ endif(tests)
 
 option(libmana "Build and install mana web application framework library" ON)
 if(libmana)
-  set(rapidjson ON) # Dependent on rapidjson
   add_subdirectory(lib/mana)
 endif(libmana)
 
-option(rapidjson "Download and install rapidjson submodule" ON)
-if(rapidjson)
-  init_submodule(mod/rapidjson)
-  install(DIRECTORY mod/rapidjson/include/rapidjson DESTINATION includeos/include)
-endif(rapidjson)
+option(libuplink "Build and install uplink" ON)
+if(libuplink)
+  set(libliveupdate ON) # dependent
+  add_subdirectory(lib/uplink)
+endif(libuplink)
 
+option(libliveupdate "Build and install LiveUpdate" ON)
+if(libliveupdate)
+  add_subdirectory(lib/LiveUpdate)
+endif(libliveupdate)
 
 #
 # Installation
 #
 
 # Install cmake files
-install(FILES etc/service.cmake DESTINATION includeos)
-install(FILES etc/library.cmake DESTINATION includeos)
+install(FILES cmake/pre.service.cmake DESTINATION includeos)
+install(FILES cmake/post.service.cmake DESTINATION includeos)
+install(FILES cmake/library.cmake DESTINATION includeos)
 install(FILES cmake/${DEFAULT_SETTINGS_CMAKE} DESTINATION includeos RENAME settings.cmake) # cpu_feat_vanilla opt
 
 # Install vmrunner
 install(DIRECTORY vmrunner DESTINATION includeos)
 install(FILES vmrunner/${DEFAULT_VM} DESTINATION includeos/vmrunner/ RENAME vm.default.json) # cpu_feat_vanilla opt
 
 # Install toolchain
-install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/cmake/i686-elf-toolchain.cmake DESTINATION includeos)
+install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/cmake/${ARCH}-elf-toolchain.cmake DESTINATION includeos)
 
 # Install seed
 install(DIRECTORY seed/ DESTINATION includeos/seed)
@@ -204,6 +243,7 @@ install(PROGRAMS
   ${CMAKE_CURRENT_SOURCE_DIR}/etc/scripts/grubify.sh
   ${CMAKE_CURRENT_SOURCE_DIR}/etc/scripts/qemu-ifup
   ${CMAKE_CURRENT_SOURCE_DIR}/etc/scripts/qemu_cmd.sh
+  ${CMAKE_CURRENT_SOURCE_DIR}/etc/scripts/ukvm-ifup.sh
   ${CMAKE_CURRENT_SOURCE_DIR}/etc/scripts/run.sh
   DESTINATION includeos/scripts)
 

README.md

@@ -1,10 +1,6 @@
 ![IncludeOS Logo](./doc/logo.png)
 ================================================
 
-**Update**: Check out [Acorn](examples/acorn/), the innovative web server appliance we [demoed at CppCon](https://www.youtube.com/watch?v=t4etEwG2_LY). Built using [Mana](lib/mana/), the new C++ Web Application Framework for IncludeOS.
-
-A *live demo* of Acorn can be found at [acorn2.unofficial.includeos.io](http://acorn2.unofficial.includeos.io) (sporadically unavailable)
-
 **IncludeOS** is an includable, minimal [unikernel](https://en.wikipedia.org/wiki/Unikernel) operating system for C++ services running in the cloud. Starting a program with `#include <os>` will literally include a tiny operating system into your service during link-time.
 
 The build system will:
@@ -24,8 +20,8 @@ IncludeOS is free software, with "no warranties or restrictions of any kind".
 
 |        | Build from bundle | Integration tests |
 |--------|-------------------|-------------------|
-| Master | [![Build Status](https://jenkins.includeos.org/buildStatus/icon?job=shield_master_bundle)](https://jenkins.includeos.org/job/shield_master_bundle/) |  Coming soon |
-| Dev    | [![Build Status](https://jenkins.includeos.org/buildStatus/icon?job=shield_dev_bundle)](https://jenkins.includeos.org/job/shield_dev_bundle/)      | [![Jenkins tests](https://img.shields.io/jenkins/t/https/jenkins.includeos.org/shield_dev_integration_tests.svg)](https://jenkins.includeos.org/job/shield_dev_integration_tests/) |
+| Master | [![Build Status](https://img.shields.io/jenkins/s/https/jenkins.includeos.org/shield_master_bundle.svg)](https://jenkins.includeos.org/job/shield_master_bundle/) |  Coming soon |
+| Dev    | [![Build Status](https://img.shields.io/jenkins/s/https/jenkins.includeos.org/shield_dev_bundle.svg)](https://jenkins.includeos.org/job/shield_dev_bundle/)      | [![Jenkins tests](https://img.shields.io/jenkins/t/https/jenkins.includeos.org/shield_dev_integration_tests.svg)](https://jenkins.includeos.org/job/shield_dev_integration_tests/) |
 
 ### Key features
 
@@ -48,22 +44,22 @@ A longer list of features and limitations is on the [wiki feature list](https://
 
 By default the project is installed to /usr/local/includeos.
 
-However, it is recommended to choose a custom location as well as select the compiler we want clang to find.
+However, it is recommended to choose a custom location as well as select the compiler we want clang to find. In this document we assume you install IncludeOS in your home directory, in the folder ~/includeos.
 
-To do this we can edit ~/.bashrc (in the home folder), adding these lines at the end of the file:
+To do this we can edit ~/.bash_profile (mac os) or ~/.bashrc (linux), adding these lines at the end of the file:
 
 ```
-    export CC=/usr/bin/clang-3.8
-    export CXX=/usr/bin/clang++-3.8
-    export INCLUDEOS_PREFIX=<HOME FOLDER>/includeos
+    export INCLUDEOS_PREFIX=~/includeos/
     export PATH=$PATH:$INCLUDEOS_PREFIX/bin
 ```
 
 This will also crucially make the boot program visible globally, so that you can simply run ```boot <myservice>``` inside any service folder.
 
 ### Install libraries
 
-**NOTE:** The script will install packages and create a network bridge.
+If you want to install IncludeOS on Mac OS you'll need a working installation of [brew] so the install script can install its dependencies.
+
+**NOTE:** The script will install packages.
 
 ```
     $ git clone https://github.com/hioa-cs/IncludeOS
@@ -85,19 +81,20 @@ Configuration of your IncludeOS installation can be done inside `build/` with `c
 
 ### Testing the installation
 
-A successful setup enables you to build and run a virtual machine. Running:
+A successful setup enables you to build and run a virtual machine. There are a few demonstration services in the source folder. If you look in the `examples/` folder you see these. If you enter `demo_service` and type `boot --create-bridge .` this script will build the service and boot it using [qemu].
 
 ```
-    $ ./test.sh
+    $ cd examples/demo_service
+    $ boot --create-bridge .
 ```
 
-will build and run [this example service](./examples/demo_service/service.cpp).
+will build and run [this example service](./examples/demo_service/service.cpp). You can visit the service on [http://10.0.0.42/](http://10.0.0.42/).
 
 More information is [available on the wiki](https://github.com/hioa-cs/IncludeOS/wiki/Testing-the-example-service).
 
 ### Writing your first service
 
-1. Copy the [./seed/service](./seed/service) directory to a convenient location like `~/your_service`. Then, just start implementing the `Service::start` function in the `Service` class, located in [your_service/service.cpp](./seed/service/service.cpp) (Very simple example provided). This function will be called once the OS is up and running.
+1. Copy the [./seed/service](./seed/service) directory to a convenient location like `~/your_service`. Then, just start implementing the `Service::start` function in the `Service` class, located in [your_service/service.cpp](./seed/service/service.cpp) (very simple example provided). This function will be called once the OS is up and running.
 2. Update the [CMakeLists.txt](./seed/service/CMakeLists.txt) to specify the name of your project, enable any needed drivers or plugins, etc.
 
 **Example:**
@@ -130,3 +127,7 @@ We want to adhere as much as possible to the [ISO C++ Core Guidelines](https://g
 We're trying to grow a Wiki, and some questions might already be answered here in the [FAQ](https://github.com/hioa-cs/IncludeOS/wiki/FAQ).
 
 See the [Wiki front page](https://github.com/hioa-cs/IncludeOS/wiki) for a complete introduction, system overview, and more detailed guides.
+
+
+[brew]: https://brew.sh/
+[qemu]: https://www.qemu.org/

api/arch.hpp

@@ -0,0 +1,57 @@
+// -*-C++-*-
+// This file is a part of the IncludeOS unikernel - www.includeos.org
+//
+// Copyright 2017 Oslo and Akershus University College of Applied Sciences
+// and Alfred Bratterud
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#pragma once
+#ifndef INCLUDEOS_ARCH_HEADER
+#define INCLUDEOS_ARCH_HEADER
+
+#include <cstddef>
+#include <cstdint>
+#include <cassert>
+
+extern void __arch_init();
+extern void __arch_poweroff();
+extern void __arch_reboot();
+extern void __arch_enable_legacy_irq(uint8_t);
+extern void __arch_disable_legacy_irq(uint8_t);
+
+extern void __arch_install_irq(uint8_t, void(*)());
+extern void __arch_subscribe_irq(uint8_t);
+extern void __arch_unsubscribe_irq(uint8_t);
+extern void __arch_preempt_forever(void(*)());
+
+inline void __arch_hw_barrier() noexcept;
+inline void __sw_barrier() noexcept;
+inline uint64_t __arch_cpu_cycles() noexcept;
+
+
+inline void __sw_barrier() noexcept
+{
+  asm volatile("" ::: "memory");
+}
+
+// Include arch specific inline implementations
+#if defined(ARCH_x86_64)
+#include "arch/x86_64.hpp"
+#elif defined(ARCH_i686)
+#include "arch/i686.hpp"
+#else
+#error "Unsupported arch specified"
+#endif
+
+#endif

api/arch api/arch/i686.hppapi/arch renamed to api/arch/i686.hpp

@@ -1,7 +1,7 @@
 // -*-C++-*-
 // This file is a part of the IncludeOS unikernel - www.includeos.org
 //
-// Copyright 2015 Oslo and Akershus University College of Applied Sciences
+// Copyright 2017 Oslo and Akershus University College of Applied Sciences
 // and Alfred Bratterud
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,30 +16,16 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#pragma once
-#ifndef INCLUDEOS_ARCH_HEADER
-#define INCLUDEOS_ARCH_HEADER
+#ifndef i686_ARCH_HPP
+#define i686_ARCH_HPP
 
-#include <cstddef>
-#include <cstdint>
+#include <arch/x86.hpp>
 
-extern void __arch_init();
-extern void __arch_poweroff();
-extern void __arch_reboot();
-extern void __arch_enable_legacy_irq(uint8_t);
-extern void __arch_disable_legacy_irq(uint8_t);
-
-#ifdef ARCH_X86
 inline uint64_t __arch_cpu_cycles() noexcept {
   uint64_t ret;
   asm("rdtsc" : "=A" (ret));
   return ret;
 }
-#else
-inline uint64_t __arch_cpu_cycles() noexcept {
-  return 0;
-}
-#endif
 
-#endif
 
+#endif