From acd689de164bc457abaeae0e124504dd7c982460 Mon Sep 17 00:00:00 2001 From: EunYoung Jeong Date: Wed, 2 Apr 2014 22:28:29 +0900 Subject: [PATCH] README and LICENSE --- LICENSE | 44 +++++++++++++++++++++++--------------------- README | 18 ++++++++++++++++-- README.md | 2 ++ 3 files changed, 41 insertions(+), 23 deletions(-) diff --git a/LICENSE b/LICENSE index 25d0967..78f9e53 100644 --- a/LICENSE +++ b/LICENSE @@ -1,27 +1,29 @@ -Copyright (c) 2014, eunyoung14 +mTCP source code is distributed under the Modified BSD Licence. + +Copyright (C) 2014 EunYoung Jeong, Shinae Woo, Muhammad Jamshed, Haewon Jeong, + Sunghwan Ihm, Dongsu Han, KyoungSoo Park + All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of the nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. -* Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -* Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -* Neither the name of the {organization} nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/README b/README index 5093a7a..b49943e 100644 --- a/README +++ b/README @@ -119,17 +119,31 @@ Event-driven PacketShader I/O engine (extended io_engine-0.2) FREQUENTLY ASKED QUESTIONS ======================================================================== -1. My application keeps printing "No route to 0.0.0.0" +1. How can I quit the application? + - Use ^C to gracefully shutdown the application. Two consecutive + ^C (separated by 1 sec) will force quit. + +2. My application keeps printing "No route to 0.0.0.0" - Try to turn off your network-manager for xge*. The network manager can override the IP configuration set by install.py in PSIO driver. -2. Can I statically set the routing or arp table? +3. Can I statically set the routing or arp table? - Yes, mTCP allows static route and arp configuration. Go to the config directory and see sample_route.conf or sample_arp.conf. Copy and adapt it to your condition and link (ln -s) the config directory to the application directory. mTCP will find config/route.conf and config/arp.conf for static configuration. +======================================================================== + CAUTION +======================================================================== + +1. Do not remove ps_ixgbe driver while running mTCP applications. The + application will go panic. + +2. Use the ps_ixgbe driver contained in this package, not the one from + some other place (e.g., from io_engine github). + ======================================================================== Contact: mtcp at list.ndsl.kaist.edu diff --git a/README.md b/README.md index f9b17ac..4639b41 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,5 @@ mtcp ==== mTCP: A Highly Scalable User-level TCP Stack for Multicore Systems + +Refer to the README for the instructions installing and using mTCP.