├── config
    ├── example.cfg
    └── logging.cfg
├── config.h.in
├── scripts
    ├── extract-winner.sh
    └── extract-times.sh
├── global.h
├── CMakeLists.txt
├── Solver.h
├── SolverManager.h
├── README
├── Solver.cpp
├── main.cpp
├── SolverManager.cpp
└── LICENSE


/config/example.cfg:
--------------------------------------------------------------------------------
 1 | #Example configuration file
 2 | 
 3 | solver = z3
 4 | z3.opts = -smt2
 5 | z3.input-on-stdin = false
 6 | 
 7 | solver = mathsat
 8 | mathsat.opts = -printer.bv_number_format=2
 9 | mathsat.input-on-stdin = true
10 | 
11 | solver = sonolar
12 | sonolar.opts = --input-format=smtlib2
13 | sonolar.input-on-stdin = false
14 | 
15 | verbose = off
16 | timeout = 50.0
17 | 


--------------------------------------------------------------------------------
/config/logging.cfg:
--------------------------------------------------------------------------------
 1 | #Example configuration file
 2 | solver = z3
 3 | z3.opts = -smt2
 4 | 
 5 | #SMTCOMP2012 options for QF_AUFBV
 6 | solver = mathsat
 7 | mathsat.opts = -printer.bv_number_format=2 -theory.la.enabled=false -theory.bv.delay_propagated_eqs=true -theory.arr.max_wr_lemmas=0 -theory.arr.enable_nonlinear=true -theory.arr.enable_witness=false -preprocessor.toplevel_propagation=true -preprocessor.simplification=7 -theory.arr.permanent_lemma_inst=true -dpll.branching_random_frequency=0 -theory.bv.eager=false 
 8 | mathsat.input-on-stdin = true
 9 | 
10 | solver = sonolar
11 | sonolar.opts = --input-format=smtlib2
12 | 
13 | solver = cvc3
14 | cvc3.opts = -lang smt2
15 | 
16 | solver = stpwrap2
17 | 
18 | solver = stp2wrap2
19 | 
20 | verbose = off
21 | 
22 | logging-path = /path/to/log/file.log
23 | 


--------------------------------------------------------------------------------
/config.h.in:
--------------------------------------------------------------------------------
 1 | /*
 2 |     Copyright (c) Dan Liew 2012
 3 | 
 4 |     This file is part of NSolv.
 5 | 
 6 |     NSolv is free software: you can redistribute it and/or modify
 7 |     it under the terms of the GNU General Public License as published by
 8 |     the Free Software Foundation, either version 3 of the License, or
 9 |     (at your option) any later version.
10 | 
11 |     NSolv is distributed in the hope that it will be useful,
12 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
13 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 |     GNU General Public License for more details.
15 | 
16 |     You should have received a copy of the GNU General Public License
17 |     along with NSolv.  If not, see <http://www.gnu.org/licenses/>
18 |  */
19 | const char NSOLV_VERSION[] = "@nsolv_VERSION_STRING@";
20 | 


--------------------------------------------------------------------------------
/scripts/extract-winner.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | if [ $# -ne 1 ]; then
 4 | 	echo "$0 : <input file>"
 5 | 	echo "<input file> - A logging file produced by NSolv"
 6 | 	echo ""
 7 | 	echo "This utility will report the number of times each solver completed first"
 8 | 	exit
 9 | fi
10 | 
11 | INPUT="$1"
12 | 
13 | if [ ! -r "${INPUT}" ]; then
14 | 	echo "Can't open input file ${INPUT}"
15 | 	exit
16 | fi
17 | 
18 | #Get solver names from file
19 | SOLVERS=$(grep -E --max-count=1 '^# [0-9]+ solvers:' "${INPUT}" | sed 's/# [0-9]\+ solvers: //; s/,/ /g')
20 | 
21 | if [ -z "${SOLVERS}" ]; then
22 | 	echo "No solvers found!"
23 | 	exit
24 | fi
25 | 
26 | echo -e "#[Solver name]\t[ number of times came first]"
27 | #Loop over solvers extracting info
28 | for solver in ${SOLVERS}
29 | do
30 | 
31 | cat "${INPUT}" | awk 'BEGIN { counter=0; OFS="\t";}
32 | 		     /#First solver to finish/ { if($5 == "'${solver}'") counter++;}
33 | 	              END { print "'${solver}'",counter;}'
34 | 
35 | done
36 | 


--------------------------------------------------------------------------------
/global.h:
--------------------------------------------------------------------------------
 1 | /*
 2 |     Copyright (c) Dan Liew 2012
 3 | 
 4 |     This file is part of NSolv.
 5 | 
 6 |     NSolv is free software: you can redistribute it and/or modify
 7 |     it under the terms of the GNU General Public License as published by
 8 |     the Free Software Foundation, either version 3 of the License, or
 9 |     (at your option) any later version.
10 | 
11 |     NSolv is distributed in the hope that it will be useful,
12 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
13 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 |     GNU General Public License for more details.
15 | 
16 |     You should have received a copy of the GNU General Public License
17 |     along with NSolv.  If not, see <http://www.gnu.org/licenses/>
18 |  */
19 | #ifndef GLOBAL_H_
20 | #define GLOBAL_H_
21 | 
22 | #include <string>
23 | 
24 | //True if the user wants verbose output
25 | extern bool verbose;
26 | 
27 | //Path to logging file
28 | extern std::string loggingPath;
29 | 
30 | #endif /* GLOBAL_H_ */
31 | 


--------------------------------------------------------------------------------
/scripts/extract-times.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | if [ $# -ne 2 ]; then
 4 | 	echo "$0 : <input file> <output directory>"
 5 | 	echo "<input file> - A logging file produced by NSolv"
 6 | 	echo "<output directory> - The directory to place the files"
 7 | 	echo ""
 8 | 	echo "This utility will report the run times for each solver which placed in a seperate file for each solver"
 9 | 	exit
10 | fi
11 | 
12 | INPUT="$1"
13 | OUTPUT_DIR="$2"
14 | 
15 | if [ ! -r "${INPUT}" ]; then
16 | 	echo "Can't open input file ${INPUT}"
17 | 	exit
18 | fi
19 | 
20 | if [ ! -d "${OUTPUT_DIR}" ]; then
21 | 	echo "The directory ${OUTPUT_DIR} is not accessible"
22 | 	exit
23 | fi
24 | 
25 | #Strip trailing slash for OUTPUT_DIR
26 | OUTPUT_DIR=$( echo "$OUTPUT_DIR" | sed 's#/\+$##')
27 | 
28 | #Get solver names from file
29 | SOLVERS=$(grep -E --max-count=1 '^# [0-9]+ solvers:' "${INPUT}" | sed 's/# [0-9]\+ solvers: //; s/,/ /g')
30 | 
31 | 
32 | if [ -z "${SOLVERS}" ]; then
33 | 	echo "No solvers found!"
34 | 	exit
35 | fi
36 | 
37 | MERGE_FILE="${OUTPUT_DIR}/all-runtimes.txt"
38 | MERGE_TEMP_FILE="${OUTPUT_DIR}/merge-runtimes-temp.txt"
39 | MERGE_CMD_LINE=""
40 | #Loop over solvers extracting info
41 | for solver in ${SOLVERS}
42 | do
43 | 
44 | OUTPUT_FILE="${OUTPUT_DIR}/${solver}-runtimes.txt"
45 | echo "Creating ${OUTPUT_FILE}"
46 | 
47 | echo -e "#[Run time]\t[ satisfiability]" > "${OUTPUT_FILE}"
48 | cat "${INPUT}" | awk 'BEGIN { OFS="\t";}
49 | 		     /^'${solver}'/ { print $2,$3;} ' >> "${OUTPUT_FILE}"
50 | 
51 | #Output part of header for merge file
52 | echo -en "[Solver ${solver}]\t\t" >> "${MERGE_TEMP_FILE}"
53 | 
54 | #Add solver to the merge command line
55 | MERGE_CMD_LINE="${MERGE_CMD_LINE} ${OUTPUT_FILE}"
56 | 
57 | done
58 | 
59 | #Output new line for merge file
60 | echo "" >> "${MERGE_TEMP_FILE}"
61 | 
62 | echo "Creating ${MERGE_FILE}"
63 | #Create merged file
64 | cat "${MERGE_TEMP_FILE}" <(paste ${MERGE_CMD_LINE}) > "${MERGE_FILE}"
65 | 
66 | #Remove the temp file
67 | rm "${MERGE_TEMP_FILE}"
68 | 


--------------------------------------------------------------------------------
/CMakeLists.txt:
--------------------------------------------------------------------------------
 1 | #   Copyright (c) Dan Liew 2012
 2 | # 
 3 | #    This file is part of NSolv.
 4 | #
 5 | #    NSolv is free software: you can redistribute it and/or modify
 6 | #    it under the terms of the GNU General Public License as published by
 7 | #    the Free Software Foundation, either version 3 of the License, or
 8 | #    (at your option) any later version.
 9 | #
10 | #    NSolv is distributed in the hope that it will be useful,
11 | #    but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 | #    GNU General Public License for more details.
14 | #
15 | #    You should have received a copy of the GNU General Public License
16 | #    along with NSolv.  If not, see <http://www.gnu.org/licenses/>
17 | 
18 | cmake_minimum_required(VERSION 2.8)
19 | project(nsolv)
20 | 
21 | #The Version numbering
22 | set (nsolv_VERSION_MAJOR 1)
23 | set (nsolv_VERSION_MINOR 0)
24 | set (nsolv_VERSION_STRING ${nsolv_VERSION_MAJOR}.${nsolv_VERSION_MINOR})
25 | 
26 | set(EXEC_NAME ${CMAKE_PROJECT_NAME})
27 | 
28 | # Set the possible values of build type for cmake-gui
29 | set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
30 | 
31 | #Look for Boost
32 | find_package(Boost 1.42 REQUIRED COMPONENTS program_options filesystem system)
33 | include_directories(${Boost_INCLUDE_DIR})
34 | 
35 | #Look for the Realtime library
36 | find_library(REALTIME_LIBRARY rt)
37 | 
38 | if(NOT REALTIME_LIBRARY)
39 | 	message(FATAL_ERROR "The Realtime library could not be found.")
40 | endif()
41 | 
42 | #Look for pthreads
43 | find_package(Threads REQUIRED)
44 | 
45 | #List source files
46 | SET(NSOLV_SRC main.cpp SolverManager.cpp Solver.cpp)
47 | 
48 | #Configure the configuration file.
49 | configure_file(config.h.in ${CMAKE_CURRENT_BINARY_DIR}/config.h @ONLY)
50 | INCLUDE_DIRECTORIES(${CMAKE_CURRENT_BINARY_DIR})
51 | 
52 | add_executable(${EXEC_NAME} ${NSOLV_SRC})
53 | target_link_libraries(${EXEC_NAME} ${Boost_LIBRARIES} ${REALTIME_LIBRARY} ${CMAKE_THREAD_LIBS_INIT})
54 | 
55 | install(TARGETS ${EXEC_NAME}
56 | 		RUNTIME DESTINATION bin
57 | 		)
58 | 


--------------------------------------------------------------------------------
/Solver.h:
--------------------------------------------------------------------------------
 1 | /*
 2 |     Copyright (c) Dan Liew 2012
 3 | 
 4 |     This file is part of NSolv.
 5 | 
 6 |     NSolv is free software: you can redistribute it and/or modify
 7 |     it under the terms of the GNU General Public License as published by
 8 |     the Free Software Foundation, either version 3 of the License, or
 9 |     (at your option) any later version.
10 | 
11 |     NSolv is distributed in the hope that it will be useful,
12 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
13 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 |     GNU General Public License for more details.
15 | 
16 |     You should have received a copy of the GNU General Public License
17 |     along with NSolv.  If not, see <http://www.gnu.org/licenses/>
18 |  */
19 | #ifndef SOLVER_H_
20 | #define SOLVER_H_
21 | 
22 | #include <string>
23 | #include <vector>
24 | #include <unistd.h>
25 | 
26 | class Solver
27 | {
28 | 	public:
29 | 
30 | 		enum Result
31 | 		{
32 | 			SAT,
33 | 			UNSAT,
34 | 			UNKNOWN,
35 | 			ERROR
36 | 		};
37 | 
38 | 		//_name is executable path
39 | 		//_cmdOptions is a string with space seperated options (empty for no cmd line options)
40 | 		Solver(const std::string& _name, const std::string& _cmdOptions, const std::string& _inputFile,
41 | 				bool _inputOnStdin);
42 | 
43 | 		//Triggering destructor will kill solver
44 | 		~Solver();
45 | 
46 | 		//can only be called once. Should be called just after fork() in parent.
47 | 		bool setPID(pid_t p);
48 | 
49 | 
50 | 		//call from parent when it is known that child finished
51 | 		Result getResult();
52 | 
53 | 		//Dump the output from the solver to stdout.
54 | 		void dumpResult();
55 | 
56 | 		//Only to be called within child. Will replace current process with solver program.
57 | 		void exec();
58 | 
59 | 		int getReadFileDescriptor();
60 | 
61 | 		const std::string& toString();
62 | 
63 | 		static const char* resultToString(Solver::Result r);
64 | 
65 | 		void kill();
66 | 
67 | 	private:
68 | 		std::string name;
69 | 		std::vector< std::string > cmdOptions;
70 | 		std::string inputFile;//Only used if inputOnStdout is true
71 | 
72 | 		//fd[0] is for parent to read from, fd[1] is for child to write to
73 | 		int fd[2]; //for use with half-duplex pipe
74 | 
75 | 		pid_t pid;
76 | 		const char** argv;
77 | 
78 | 		//Raw byte buffer used to read the first bits of data coming from the child
79 | 		unsigned char buffer[7];
80 | 
81 | 		bool inputOnStdin;
82 | 
83 | 		bool resultAlreadyRead;
84 | 
85 | 		int numberOfBytesReadFromPipe;
86 | 
87 | 
88 | 
89 | 		void setupArguments(const std::string& _cmdOptions, const std::string& inputFile);
90 | 
91 | 		bool bufferMatch(const char cstring[]);
92 | };
93 | 
94 | 
95 | #endif /* SOLVER_H_ */
96 | 


--------------------------------------------------------------------------------
/SolverManager.h:
--------------------------------------------------------------------------------
  1 | /*
  2 |     Copyright (c) Dan Liew 2012
  3 | 
  4 |     This file is part of NSolv.
  5 | 
  6 |     NSolv is free software: you can redistribute it and/or modify
  7 |     it under the terms of the GNU General Public License as published by
  8 |     the Free Software Foundation, either version 3 of the License, or
  9 |     (at your option) any later version.
 10 | 
 11 |     NSolv is distributed in the hope that it will be useful,
 12 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
 13 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 14 |     GNU General Public License for more details.
 15 | 
 16 |     You should have received a copy of the GNU General Public License
 17 |     along with NSolv.  If not, see <http://www.gnu.org/licenses/>
 18 |  */
 19 | #ifndef SOLVERMANAGER_H_
 20 | #define SOLVERMANAGER_H_
 21 | 
 22 | #include <fstream>
 23 | #include <string>
 24 | #include <vector>
 25 | #include <map>
 26 | #include "Solver.h"
 27 | #include <unistd.h>
 28 | #include <time.h>
 29 | #include <queue>
 30 | #include <sys/select.h>
 31 | #include <semaphore.h>
 32 | 
 33 | class SolverManager
 34 | {
 35 | 	public:
 36 | 		SolverManager(const std::string& _inputFile, double _timeOut, bool _loggingMode);
 37 | 		~SolverManager();
 38 | 		void addSolver(const std::string& name, const std::string& cmdLineArgs, bool inputOnStdin);
 39 | 		void addSolver(const std::string& name, bool inputOnStdin);
 40 | 		bool invokeSolvers();
 41 | 
 42 | 		size_t getNumberOfSolvers();
 43 | 
 44 | 	private:
 45 | 		std::vector<Solver*> solvers;
 46 | 		std::map<pid_t,Solver*> pidToSolverMap;
 47 | 		std::string inputFile;
 48 | 		const std::string empty;
 49 | 
 50 | 		timespec timeout;
 51 | 		timespec startTime;
 52 | 		timespec originalTimeout;
 53 | 
 54 | 		std::map<int,Solver*> fdToSolverMap;
 55 | 
 56 | 		fd_set lookingToRead;
 57 | 		int largestFileDescriptor;
 58 | 
 59 | 		bool loggingMode;
 60 | 		std::ofstream loggingFile;
 61 | 
 62 | 		sem_t* solverSynchronisingSemaphore;
 63 | 		std::string solverSyncName;
 64 | 
 65 | 		bool timeoutEnabled();
 66 | 
 67 | 
 68 | 		/*Adjust timeout so that is OriginalTimeout - (currentTime - startTime)
 69 | 		 * This is needed because if a solver finishes and it has a useless answer we should
 70 | 		 * wait for the next available solver but only for the remaining time left from what the
 71 | 		 * user originally asked for.
 72 | 		 */
 73 | 		void adjustRemainingTime();
 74 | 
 75 | 		//Configures "lookingToRead" to be set up for the solvers in "fdToSolverMap"
 76 | 		void setupFileDescriptorSet();
 77 | 
 78 | 		Solver* getSolverFromFileDescriptorSet();
 79 | 
 80 | 		void removeSolverFromFileDescriptorSet(Solver* s);
 81 | 
 82 | 		void listSolversToLog();
 83 | 
 84 | 		void printSolverHeaderToLog();
 85 | 
 86 | 		void printSolverAnswerToLog(Solver::Result result, const std::string& name);
 87 | 
 88 | 		void printUnfinishedSolversToLog();
 89 | 
 90 | };
 91 | 
 92 | //helper function a -b
 93 | struct timespec subtract(struct timespec a, struct timespec b);
 94 | double toDouble(struct timespec t);
 95 | 
 96 | bool operator==(struct timespec a, struct timespec b);
 97 | bool operator>(struct timespec a, struct timespec b);
 98 | bool operator>=(struct timespec a, struct timespec b);
 99 | 
100 | #endif /* SOLVERMANAGER_H_ */
101 | 


--------------------------------------------------------------------------------
/README:
--------------------------------------------------------------------------------
 1 | NSolv By Dan Liew.
 2 | 
 3 | ABOUT
 4 | 
 5 | NSolv is a simple tool for POSIX compliant operating systems that allows several
 6 | SMTLIBv2 [1] solvers to be invoked in parallel (each solver is in its own
 7 | process). The tool can operate in one of two modes
 8 | 
 9 | * Performance Mode
10 | The first solver to respond (sat|unsat) is considered to be the first
11 | solver to return useful output and the other solvers are killed. After this the
12 | output of this "first solver" is outputted to standard output.
13 | 
14 | * Logging Mode
15 | The first solver to respond (sat|unsat) is considered to be the first
16 | solver to return useful output. The other solvers are allowed to finish unless
17 | they timeout. The results and runtime of all solvers are recorded to a log file.
18 | 
19 | NSolv is so named because it allows you to launch "N Solv(ers)".
20 | 
21 | Its original purpose was to act as front-end to several SMTLIBv2 solvers for a
22 | modified version ([2]) of KLEE [3]. These changes made to KLEE will most likely
23 | never be merged as work is currently being done to integrate SMT-LIBv2 solvers
24 | via a library rather than executing an external application as is needed for 
25 | NSolv.
26 | 
27 | BUILDING
28 | NSolv uses CMake as its build system. Here are a few commands you can run to get
29 | started. Nsolv has very few depencies but make sure have the following
30 | installed.
31 | 
32 | * Boost libraries and development header files
33 | * librt (Real time library)
34 | * PThreads library
35 | * Standard development tools (C++ Compiler, development header files, etc...)
36 | 
37 | 1. This stage is optional but it is advised you do an out of source build. Pick
38 | any directory you like to build NSolv in.
39 | 
40 | $ mkdir /path/to/nsolv/build/directory
41 | 
42 | 2. Now we'll launch your favourite CMake front-end.
43 | $ cd /path/to/nsolv/build/directory
44 | $ cmake-gui /path/to/nsolv/source-code/directory
45 | 
46 | Now press configure. CMake should hopefully find all the dependencies. It will
47 | report an error if there is a problem.
48 | 
49 | At this point you set the build type by setting CMAKE_BUILD_TYPE. You probably
50 | either want "Release" or "Debug". If you set this variable press configure
51 | again.
52 | 
53 | Alternatively you could use ccmake or if you're brave just plain cmake.
54 | 
55 | 3. Now generate your build system. Usually you just want to generate plain UNIX
56 | makefiles. You can do this by pressing the "Generate" button in cmake-gui
57 | 
58 | 4. You can now start the build process by running the following command in the
59 | NSolv build directory.
60 | 
61 | $ make
62 | 
63 | 5. If you wish to install (prefix is CMAKE_INSTALL_PREFIX)  run
64 | 
65 | $ make install
66 | 
67 | 6. CMake doesn't provide an "uninstall" makefile target. When you run install
68 | the list of installed files are put in a file called "install_manifest.txt" in
69 | the root of your binary build folder.
70 | 
71 | To uninstall run
72 | 
73 | $ xargs rm < install_manifest.txt
74 | 
75 | USAGE
76 | 
77 | See the help message
78 | $ nsolv --help
79 | 
80 | NSolv supports using a configuration file which is the recommended way to use
81 | it. An example configuration file can be found in "config/example.cfg".
82 | 
83 | REFERENCES
84 | [1] http://www.smt-lib.org
85 | [2] https://github.com/delcypher/klee/tree/smtlib
86 | [3] http://klee.llvm.org/
87 | 
88 | :set textwidth=80
89 | 


--------------------------------------------------------------------------------
/Solver.cpp:
--------------------------------------------------------------------------------
  1 | /*
  2 |     Copyright (c) Dan Liew 2012
  3 | 
  4 |     This file is part of NSolv.
  5 | 
  6 |     NSolv is free software: you can redistribute it and/or modify
  7 |     it under the terms of the GNU General Public License as published by
  8 |     the Free Software Foundation, either version 3 of the License, or
  9 |     (at your option) any later version.
 10 | 
 11 |     NSolv is distributed in the hope that it will be useful,
 12 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
 13 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 14 |     GNU General Public License for more details.
 15 | 
 16 |     You should have received a copy of the GNU General Public License
 17 |     along with NSolv.  If not, see <http://www.gnu.org/licenses/>
 18 |  */
 19 | #include "Solver.h"
 20 | #include "global.h"
 21 | #include <signal.h>
 22 | #include <errno.h>
 23 | #include <unistd.h>
 24 | #include <iostream>
 25 | #include <cstdlib>
 26 | #include <cstdio>
 27 | #include <cstring>
 28 | #include <fcntl.h>
 29 | 
 30 | using namespace std;
 31 | Solver::Solver(const std::string& _name, const std::string& _cmdOptions, const std::string& _inputFile, bool _inputOnStdin) :
 32 | name(_name), cmdOptions(), inputFile(_inputFile) , argv(NULL), pid(0), inputOnStdin(_inputOnStdin), resultAlreadyRead(false),
 33 | numberOfBytesReadFromPipe(0)
 34 | {
 35 | 	setupArguments(_cmdOptions,_inputFile);
 36 | 
 37 | 	//Setup half duplex pipe.
 38 | 	int result= pipe(this->fd);
 39 | 	if(result == -1)
 40 | 	{
 41 | 		perror("Problem setting up pipe:");
 42 | 		exit(1);
 43 | 	}
 44 | 
 45 | 	//Solver::exec() should be called in child after fork() so we'll close fd appropriately there.
 46 | 	//Solver::setPID() should be called in parent after fork so we'll close fd appropriately there.
 47 | }
 48 | 
 49 | Solver::~Solver()
 50 | {
 51 | 	//It is presumed this is called only in the parent.
 52 | 
 53 | 	kill();
 54 | 	delete [] argv;
 55 | 	argv=NULL;
 56 | 
 57 | 	//Try closing the read end of the pipe. It may have already been closed in dumpResult()
 58 | 	close(fd[0]);
 59 | }
 60 | 
 61 | bool Solver::setPID(pid_t p)
 62 | {
 63 | 	if(pid == 0)
 64 | 	{
 65 | 		pid =p;
 66 | 
 67 | 		/* We're in parent and the child has already forked from us (hopefully).
 68 | 		 * So we should now close the writing end of the file descriptor.
 69 | 		 */
 70 | 		int result=close(fd[1]);
 71 | 		if(result == -1)
 72 | 		{
 73 | 			perror("Error closing file descriptor in parent.");
 74 | 			exit(1);
 75 | 		}
 76 | 
 77 | 
 78 | 		return true;
 79 | 	}
 80 | 	else
 81 | 		return false;
 82 | }
 83 | 
 84 | Solver::Result Solver::getResult()
 85 | {
 86 | 	//Read the result from the child if we haven't already tried
 87 | 	if(!resultAlreadyRead)
 88 | 	{
 89 | 			int result=::read(fd[0],buffer,sizeof(buffer));
 90 | 			if(result == -1)
 91 | 			{
 92 | 				perror("read:");
 93 | 				exit(1);
 94 | 			}
 95 | 
 96 | 		resultAlreadyRead=true;
 97 | 
 98 | 		/* Ideally we would like to read sizeof(buffer) bytes, but the read()
 99 | 		 * system call does NOT guarantee this! So we must record how many bytes it gave us.
100 | 		 * This might not actually be enough to check for (sat|unsat|unknown) but let's hope it is!
101 | 		 */
102 | 		numberOfBytesReadFromPipe=result;
103 | 	}
104 | 
105 | 	//check for the valid responses from a SMTLIBv2 solver
106 | 	if(bufferMatch("sat"))
107 | 	{
108 | 		return Solver::SAT;
109 | 	}
110 | 	else if(bufferMatch("unsat"))
111 | 	{
112 | 		return Solver::UNSAT;
113 | 	}
114 | 	else if(bufferMatch("unknown"))
115 | 	{
116 | 		return Solver::UNKNOWN;
117 | 	}
118 | 	else
119 | 		return Solver::ERROR;
120 | }
121 | 
122 | void Solver::dumpResult()
123 | {
124 | 	if(resultAlreadyRead==false)
125 | 	{
126 | 		cerr << "Solver::dumpResult() . You need to call getResult() first!" << endl;
127 | 		return;
128 | 	}
129 | 
130 | 	int result=0;
131 | 
132 | 	//dump the buffer to stdout
133 | 	result=write(fileno(stdout),buffer,numberOfBytesReadFromPipe);
134 | 	if(result== -1)
135 | 	{
136 | 		cerr << "Solver::dumpResult() : Failed to write buffer to stdout." << endl;
137 | 		perror("Write:");
138 | 		return;
139 | 	}
140 | 	fflush(stdout);
141 | 
142 | 	//print out what remains inside the pipe.
143 | 	FILE* f = fdopen(fd[0],"r");
144 | 
145 | 	if(f == NULL)
146 | 	{
147 | 		cerr << "Solver::dumpResult() : Failed to open pipe to print remainder." << endl;
148 | 		return;
149 | 	}
150 | 
151 | 	//Write what remains in the pipe to stdout.
152 | 	//Not very efficient but not sure how to do this a better way
153 | 	int c=fgetc(f);
154 | 	while(c != EOF)
155 | 	{
156 | 		putchar(c);
157 | 		c=fgetc(f);
158 | 	}
159 | 	fflush(stdout);
160 | 	result=fclose(f);
161 | 	if(result !=0)
162 | 	{
163 | 		cerr << "Solver::dumpResult() : Failed to close FILE* to pipe." << endl;
164 | 	}
165 | 
166 | }
167 | 
168 | void Solver::exec()
169 | {
170 | 	//We should be in child after fork. We close the reading end of the pipe.
171 | 	int result=close(fd[0]);
172 | 	if(result == -1)
173 | 		perror("Problem closing file descriptor in child.");
174 | 
175 | 	//We want stdout of the child to be sent to the parent via the pipe.
176 | 	result=dup2(fd[1],fileno(stdout));
177 | 	if(result == -1)
178 | 	{
179 | 		perror("Problem redirecting stdout of child to pipe!");
180 | 		exit(1);
181 | 	}
182 | 
183 | 	if(inputOnStdin)
184 | 	{
185 | 		//The user wants us to send the SMTLIBv2 file on stdinput to the solver
186 | 
187 | 		//get file descriptor.
188 | 		int smtlibFd=0;
189 | 		smtlibFd = ::open(inputFile.c_str(), O_RDONLY);
190 | 
191 | 		if(smtlibFd == -1)
192 | 		{
193 | 			perror("Problem opening input SMTLIBv2 file:");
194 | 			exit(1);
195 | 		}
196 | 
197 | 		//We want the stdinput for the solver to come from the input SMTLIBv2 file
198 | 		result=dup2(smtlibFd,fileno(stdin));
199 | 		if(result == -1)
200 | 		{
201 | 			perror("Problem redirecting input SMTLIBv2 file to stdinput:");
202 | 			exit(1);
203 | 		}
204 | 
205 | 	}
206 | 
207 | 	//Now execute the solver
208 | 	result = execvp(name.c_str(), (char * const*) argv);
209 | 	if(result == -1)
210 | 	{
211 | 		cerr << "Failed to execute solver:" << name << "!" << endl;
212 | 		perror("execvp:");
213 | 		exit(1);
214 | 	}
215 | }
216 | 
217 | const std::string& Solver::toString()
218 | {
219 | 	return name;
220 | }
221 | 
222 | void Solver::kill()
223 | {
224 | 	if(verbose) cerr << "Trying to kill solver " << name << " with pid:" << pid << endl;
225 | 	int result = ::kill(pid, SIGTERM);
226 | 
227 | 	//Note ESRCH is when pid didn't exists, we don't care about that case.
228 | 	if(result == -1 && errno != ESRCH)
229 | 		cerr << "Killing process with PID:" << pid << " failed!" << endl;
230 | }
231 | 
232 | void Solver::setupArguments(const std::string& cmdOptionsStr, const std::string& inputFile)
233 | {
234 | 
235 | 	string temp("");//Temporary token holder
236 | 
237 | 	//push the argv[0] argument which is the program name.
238 | 	cmdOptions.push_back(name);
239 | 
240 | 	string::const_iterator lastElement = cmdOptionsStr.end() -1;
241 | 	for(string::const_iterator c = cmdOptionsStr.begin(); c != cmdOptionsStr.end() ; ++c)
242 | 	{
243 | 		//ignore whitespace leading up to a token
244 | 		if(*c == ' ' && temp.length() ==0)
245 | 			continue;
246 | 
247 | 		temp+=*c;
248 | 
249 | 		//Hit end of token
250 | 		if( (c == lastElement || *(c +1) == ' ' ) && temp.length() > 0)
251 | 		{
252 | 			cmdOptions.push_back(temp);
253 | 			temp=""; //blank the temporary token holder
254 | 			continue;;
255 | 		}
256 | 
257 | 
258 | 	}
259 | 
260 | 	//That last argument is the input file if that is what's requested for.
261 | 	if(!inputOnStdin)
262 | 	{
263 | 		cmdOptions.push_back(inputFile);
264 | 	}
265 | 
266 | 
267 | 	int index=0;
268 | 
269 | 	if(verbose)
270 | 	{
271 | 		cerr << "Solver::setupArguments() : Found " << cmdOptions.size() << " argument(s) for solver " <<
272 | 				name << endl;
273 | 
274 | 		for(vector<string>::const_iterator i =cmdOptions.begin(); i != cmdOptions.end(); ++i, ++index)
275 | 			cerr << "[" << index << "] = \"" << *i << "\"" << endl;
276 | 	}
277 | 
278 | 	if(verbose && inputOnStdin)
279 | 		cerr << "Solver::setupArguments() : Input file (" << inputFile << ") will passed to solver " << name <<
280 | 		        " on standard input." << endl;
281 | 
282 | 	/* We now need to setup a (char*) NULL terminated C
283 | 	 * array for execvp().
284 | 	 */
285 | 	try {argv = new const char* [cmdOptions.size() +1]; }
286 | 	catch(std::bad_alloc& e)
287 | 	{
288 | 		cerr << "Failed to allocate space for options array!" << endl;
289 | 		exit(1);
290 | 	}
291 | 	index=0;
292 | 	for(vector<string>::const_iterator i =cmdOptions.begin(); i != cmdOptions.end(); ++i, ++index)
293 | 		argv[index] = i->c_str();
294 | 
295 | 	//Terminate with a NULL as execvp() expects
296 | 	argv[cmdOptions.size()] = (char*) NULL ;
297 | }
298 | 
299 | int Solver::getReadFileDescriptor()
300 | {
301 | 	return fd[0];
302 | }
303 | 
304 | const char* Solver::resultToString(Solver::Result r)
305 | {
306 | 	switch(r)
307 | 	{
308 | 		case SAT: return "sat";
309 | 		case UNSAT: return "unsat";
310 | 		case UNKNOWN: return "unknown";
311 | 		case ERROR:
312 | 		default:
313 | 			return "error";
314 | 	}
315 | }
316 | 
317 | bool Solver::bufferMatch(const char cstring[])
318 | {
319 | 	unsigned int strLength=strlen(cstring);
320 | 
321 | 	if(strLength==0) return false; //can't deal with empty strings.
322 | 
323 | 	for(unsigned int index=0; index < sizeof(buffer) && index < strLength; index++)
324 | 	{
325 | 		if(cstring[index] != buffer[index])
326 | 			return false;
327 | 
328 | 		if(strLength == (index + 1))
329 | 			return true;// There was a match
330 | 	}
331 | 
332 | 	return false;
333 | }
334 | 


--------------------------------------------------------------------------------
/main.cpp:
--------------------------------------------------------------------------------
  1 | /*
  2 |     Copyright (c) Dan Liew 2012
  3 | 
  4 |     This file is part of NSolv.
  5 | 
  6 |     NSolv is free software: you can redistribute it and/or modify
  7 |     it under the terms of the GNU General Public License as published by
  8 |     the Free Software Foundation, either version 3 of the License, or
  9 |     (at your option) any later version.
 10 | 
 11 |     NSolv is distributed in the hope that it will be useful,
 12 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
 13 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 14 |     GNU General Public License for more details.
 15 | 
 16 |     You should have received a copy of the GNU General Public License
 17 |     along with NSolv.  If not, see <http://www.gnu.org/licenses/>
 18 |  */
 19 | 
 20 | #include <boost/program_options.hpp>
 21 | #include <boost/filesystem.hpp>
 22 | namespace po = boost::program_options;
 23 | 
 24 | #include <iostream>
 25 | #include <vector>
 26 | #include <string>
 27 | #include <fstream>
 28 | #include "SolverManager.h"
 29 | #include <signal.h>
 30 | #include <config.h>
 31 | using namespace std;
 32 | 
 33 | //Global store for variables
 34 | po::variables_map vm;
 35 | bool verbose;
 36 | string loggingPath;
 37 | pid_t nsolvProcess;
 38 | 
 39 | const char NSOLV[] = "nsolv";
 40 | 
 41 | //This is the default path for the configuration file
 42 | const char DEFAULT_CONFIG_PATH[] = "./nsolv.cfg";
 43 | 
 44 | SolverManager* sm=NULL;
 45 | struct sigaction act;
 46 | 
 47 | //Parses command line options and config file.
 48 | void parseOptions(int argc, char* argv[]);
 49 | 
 50 | //Prints help message
 51 | void printHelp(po::options_description& o);
 52 | 
 53 | //Signal handler that attempts to cleanly exit.
 54 | void handleExit(int signum);
 55 | 
 56 | int main(int ac, char* av[])
 57 | {
 58 | 	nsolvProcess=getpid();
 59 | 
 60 | 	/* We want to prevent SIGINT, SIGTERM & SIGQUIT
 61 | 	 * from interrupting the instantiation ( parseOptions() )
 62 | 	 * process so we temporarily block them.
 63 | 	 */
 64 | 	int result=0;
 65 | 
 66 | 	memset(&act,0,sizeof(act));
 67 | 	act.sa_handler = SIG_IGN;
 68 | 
 69 | 	result=sigaction(SIGTERM,&act,NULL);
 70 | 	if(result == -1) cerr << "Couldn't block SIGTERM" << endl;
 71 | 	result=sigaction(SIGQUIT,&act,NULL);
 72 | 	if(result == -1) cerr << "Couldn't block SIGQUIT" << endl;
 73 | 	result=sigaction(SIGINT,&act,NULL);
 74 | 	if(result == -1) cerr << "Couldn't block SIGINT" << endl;
 75 | 
 76 | 	parseOptions(ac,av);
 77 | 
 78 | 	/* Now that the SolverManager is instantiated it is safe
 79 | 	 * to allow the user to force an early exit.
 80 | 	 */
 81 | 	act.sa_handler = handleExit;
 82 | 	result=sigaction(SIGTERM,&act,NULL);
 83 | 	if(result == -1) cerr << "Couldn't setup handler for SIGTERM" << endl;
 84 | 	result=sigaction(SIGQUIT,&act,NULL);
 85 | 	if(result == -1) cerr << "Couldn't setup handler for SIGQUIT" << endl;
 86 | 	result=sigaction(SIGINT,&act,NULL);
 87 | 	if(result == -1) cerr << "Couldn't setup handler for SIGQUIT" << endl;
 88 | 
 89 | 
 90 | 	sm->invokeSolvers();
 91 | 
 92 | 	delete sm;
 93 |     return 0;
 94 | }
 95 | 
 96 | void parseOptions(int argc, char* argv[])
 97 | {
 98 | 	vector< string> solverList;
 99 | 
100 | 	try
101 | 	{
102 | 		/* Declare the different group of program
103 | 		 * options available
104 | 		 */
105 | 		po::options_description generalOpts("General options");
106 | 		generalOpts.add_options()
107 | 				("help,h", "produce help message")
108 | 				("config,c", po::value<std::string>()->default_value(DEFAULT_CONFIG_PATH), "Path to configuration file.")
109 | 
110 | 				;
111 | 
112 | 
113 | 		po::options_description solverOpts("Solver options");
114 | 		solverOpts.add_options()
115 | 				("solver,s", po::value< std::vector<string> >(&solverList)->composing(),
116 | 						"Specify a solver to use. This option can be set multiple times so that each "
117 | 						"solver is invoked in a different process.")
118 | 				("timeout,t", po::value<double>()->default_value(0.0), "Set timeout in seconds.")
119 | 				("verbose", po::value<bool>(&verbose)->default_value(false), "Print running information to standard error.")
120 | 				("logging-path", po::value<string>(&loggingPath)->default_value(""), "Enable logging mode (off by default) and set the path to the log file.")
121 | 				;
122 | 
123 | 
124 | 		//This is used as a positional argument
125 | 		po::options_description input("Input");
126 | 		input.add_options()("input", po::value<std::string>()->required(),"Specifies SMTLIBv2 input file.");
127 | 		po::positional_options_description p;
128 | 		p.add("input",1);
129 | 
130 | 		//Create options group to show for help messages
131 | 		po::options_description hm("Options");
132 | 		hm.add(generalOpts).add(solverOpts);
133 | 
134 | 		//Options group for parsing
135 | 		po::options_description cl("");
136 | 		cl.add(generalOpts).add(solverOpts).add(input);
137 | 
138 | 		//invoke commandline parser
139 | 		po::store(po::command_line_parser(argc, argv).
140 | 				  options(cl).positional(p).run(), vm);
141 | 
142 | 		/*check for help option first because the input might not be set
143 | 		* which will cause notify() to throw an exception
144 | 		*/
145 | 		if(vm.count("help"))
146 | 			printHelp(hm);
147 | 
148 | 		po::notify(vm);//trigger exceptions if there are any
149 | 
150 | 		//check input file exists
151 | 		boost::filesystem::path inputFile(vm["input"].as<string>());
152 | 		if(! boost::filesystem::is_regular_file(inputFile))
153 | 		{
154 | 			cerr << "Error: Input SMTLIBv2 file (" << vm["input"].as<string>() <<
155 | 					") does not exist or is not a regular file." << endl;
156 | 			exit(1);
157 | 		}
158 | 
159 | 
160 | 		//if the configuration file exists then load it
161 | 		boost::filesystem::path configFile(vm["config"].as<string>());
162 | 		bool configFileExists=boost::filesystem::is_regular_file(configFile) ||
163 | 					boost::filesystem::is_symlink(configFile);
164 | 
165 | 
166 | 		//If user manually specified a config file check it exists
167 | 		if(!vm["config"].defaulted() > 0 && ! configFileExists )
168 | 		{
169 | 			cerr << "Error: Configuration file " << configFile.string() << " does not exist!" << endl;
170 | 			exit(1);
171 | 		}
172 | 
173 | 		po::options_description indivSolvOpt("");
174 | 		if(configFileExists)
175 | 		{
176 | 			//parse configuration file for options too
177 | 			if(verbose) cerr << "Parsing configuration file:" << configFile.string() << endl;
178 | 
179 | 			ifstream cf;
180 | 			cf.open(configFile.string().c_str());
181 | 
182 | 			if(!cf.good())
183 | 			{
184 | 				cerr << "Couldn't open configuration file " << configFile.string() << endl;
185 | 			}
186 | 
187 | 
188 | 			//Do first pass for solver options
189 | 			po::store(po::parse_config_file(cf,solverOpts,true), vm);
190 | 			po::notify(vm);
191 | 
192 | 			cf.close();
193 | 			cf.open(configFile.string().c_str());
194 | 
195 | 			//cf.seekg(0,ios_base::beg);//Move to the beginning of the file.
196 | 
197 | 			/*loop over solvers and create
198 | 			 * <solvername>.opts options
199 | 			 * <solvername>.input-on-stdin options
200 | 			 */
201 | 			for(vector<string>::const_iterator s= solverList.begin(); s != solverList.end(); ++s)
202 | 			{
203 | 				string optionName(*s);
204 | 
205 | 				//Do <solvername>.opts
206 | 				optionName+=".opts";
207 | 				indivSolvOpt.add_options() (optionName.c_str(),po::value<string>(),"");
208 | 				if(verbose) cerr << "Looking for \"" << optionName << "\" in " << configFile << endl;
209 | 
210 | 				//Do <solvername>.input-on-stdout
211 | 				optionName=*s;
212 | 				optionName+=".input-on-stdin";
213 | 				indivSolvOpt.add_options() (optionName.c_str(),po::value<bool>()->default_value(false),"");
214 | 				if(verbose) cerr << "Looking for \"" << optionName << "\" in " << configFile << endl;
215 | 
216 | 			}
217 | 
218 | 			//Do second pass for per solver options
219 | 			po::store(po::parse_config_file(cf,indivSolvOpt,true), vm);
220 | 			po::notify(vm);
221 | 
222 | 			cf.close();
223 | 		}
224 | 
225 | 		/* See if we are using logging mode
226 | 		 *
227 | 		 */
228 | 		bool lMode=false;
229 | 		if(vm["logging-path"].as<string>().length() != 0)
230 | 		{
231 | 			lMode=true;
232 | 		}
233 | 
234 | 
235 | 		try {sm = new SolverManager(vm["input"].as<string>(),vm["timeout"].as<double>(),lMode);}
236 | 		catch(std::bad_alloc& e)
237 | 		{
238 | 			cerr << "Failed to allocate memory of SolverManager:" << e.what() << endl;
239 | 			exit(1);
240 | 		}
241 | 
242 | 		//Now finally create solvers
243 | 		for(vector<string>::const_iterator s= solverList.begin(); s != solverList.end(); ++s)
244 | 		{
245 | 			string solvOpt(*s);
246 | 			solvOpt+=".opts";
247 | 
248 | 			string stdinOpt(*s);
249 | 			stdinOpt+=".input-on-stdin";
250 | 
251 | 			bool inputOnStdin = false;
252 | 			if(configFileExists && vm.count(stdinOpt.c_str()) && vm[stdinOpt.c_str()].as<bool>() )
253 | 				inputOnStdin=true;
254 | 
255 | 			if(configFileExists && vm.count(solvOpt.c_str()))
256 | 			{
257 | 				sm->addSolver(*s, vm[solvOpt.c_str()].as<string>(), inputOnStdin);
258 | 			}
259 | 			else
260 | 				sm->addSolver(*s,inputOnStdin);
261 | 
262 | 		}
263 | 
264 | 
265 | 	}
266 | 	catch(po::required_option& r)
267 | 	{
268 | 		cerr << "Error: ";
269 | 		if (r.get_option_name() == "--input")
270 | 		{
271 | 			cerr << "Input SMTLIBv2 file must be specified. For help use --help" << endl;
272 | 		}
273 | 		else
274 | 		{
275 | 			cerr << r.what() << endl;
276 | 		}
277 | 
278 | 		exit(1);
279 | 	}
280 | 	catch(exception& e)
281 | 	{
282 | 		cerr << "Error:" << e.what() << endl;
283 | 		exit(1);
284 | 	}
285 | 
286 | 
287 | }
288 | 
289 | void printHelp(po::options_description& o)
290 | {
291 | 	cout << NSOLV << " [options] <input>" << endl <<
292 | 			"<input> is a valid (.smt2) SMTLIBv2 file." << endl << endl <<
293 | 
294 | 			"NSolv allows several SMTLIBv2 solvers to be invoked simultaneously (each as a separate process)." << endl <<
295 | 			"Multiple calls to --solver will create each solver. It also possible (and recommended) to specify this " << endl <<
296 | 			"in a configuration file. Command line parameters for each solver may also be specified in " << endl <<
297 | 			"the configuration file but NOT on the command line of NSolv. It also possible to specify how <input> " << endl <<
298 | 			"is given to each solver (either as the last command line parameter or on standard input) in the configuration " << endl <<
299 | 			"file." << endl << endl <<
300 | 
301 | 			"Nsolv works in two modes; performance mode and logging mode. The default is performance mode. In this " << endl <<
302 | 			"mode the answer from the first solver to return (sat|unsat) is used and all other solvers are killed." << endl <<
303 | 			"In logging mode the answer from the first solver to return (sat|unsat) is used but are solvers are allowed to " << endl <<
304 | 			"finish (unless they timeout). The times and answers from the solvers are saved to a log file " << endl <<
305 | 			"(see --logging-path). If the log file already exists the times and answers are appended." << endl << endl <<
306 | 
307 | 			"CONFIGURATION FILE FORMAT" << endl <<
308 | 			"Here is an example..." << endl << endl <<
309 | 			"-------------------------------------------------------------------------------" << endl <<
310 | 			"#This is a comment" << endl <<
311 | 			"solver = z3" << endl <<
312 | 			"#Set command line options to be passed to z3 solver" << endl <<
313 | 			"z3.opts = -smt2 -v:0" << endl << endl <<
314 | 
315 | 			"solver = mathsat" << endl <<
316 | 			"#Set command line options to be passed to mathsat solver" << endl <<
317 | 			"mathsat.opts = -input=smt2 -verbosity=0" << endl <<
318 | 			"#Set the input file to be passed to mathsat on standard input" << endl <<
319 | 			"mathsat.input-on-stdin = on" << endl << endl <<
320 | 
321 | 			"#Set the timeout in seconds" << endl <<
322 | 			"timeout = 60.0" << endl << endl <<
323 | 			"#Switch off NSolv's verbose output" << endl <<
324 | 			"verbose = off" << endl <<
325 | 			"-------------------------------------------------------------------------------" << endl << endl <<
326 | 
327 | 			"Each solver must be declared on a separate line as shown above. Options can specified for " << endl <<
328 | 			"each solver by adding a line starting with \"<solver-name>.opts =\". These options are space separated." << endl <<
329 | 			"Quotes (\") are interpreted literally so it is not possible to have a single argument with a space in." << endl <<
330 | 			"Whether or not the <input> is given to a particular solver on standard input can be controlled by adding the line " << endl <<
331 | 			"starting with \"<solver-name>.input-on-stdin =\". The default behaviour is to pass <input> as the last command " << endl <<
332 | 			"line parameter to the solver." << endl << endl <<
333 | 			"The --solver <name> option and \"solver = <name>\" option in the configuration file use <name> as the " << endl <<
334 | 			"solver name but also as the executable name. Therefore <name> should be in your PATH." << endl << endl <<
335 | 
336 | 			"The default path for the configuration file is \"" << DEFAULT_CONFIG_PATH << "\". If this default file does not " << endl <<
337 | 			"exist NSolv will not complain, however if \"--config <file>\" is used <file> must exist." << endl << endl;
338 | 
339 | 
340 | 	cout << o << endl;
341 | 	cout << "NSolv version " << NSOLV_VERSION << " built on "  __DATE__  << endl;
342 | 	exit(0);
343 | }
344 | 
345 | void handleExit(int signum)
346 | {
347 | 	int result=0;
348 | 	if(verbose) cerr << "(" << getpid() << ") Received signal " << signum << ". Trying to cleanly exit..." << endl;
349 | 
350 | 	/* Need to handle a special edge case. This signal handler can get called in the child
351 | 	 * if it hasn't started its solver yet. If this happens and we delete the solverManager, then we'll
352 | 	 * trigger a delete of all other solvers which isn't desired. Only the parent process should
353 | 	 * be allowed to delete the solverManager
354 | 	 */
355 | 	if(getpid() == nsolvProcess)
356 | 	{
357 | 		/*Assume the Solver Manager has already been created and not already deleted.
358 | 		 * There is a possible race condition here if sm was already deleted. FIXME
359 | 		 */
360 | 		delete sm;
361 | 	}
362 | 
363 | 	//Remove signal handler for signals.
364 | 	act.sa_handler = SIG_DFL;
365 | 	result=sigaction(SIGTERM,&act,NULL);
366 | 	if(result == -1) cerr << "Couldn't set SIGTERM handler to default" << endl;
367 | 	result=sigaction(SIGQUIT,&act,NULL);
368 | 	if(result == -1) cerr << "Couldn't set SIGQUIT handler to default" << endl;
369 | 	result=sigaction(SIGINT,&act,NULL);
370 | 	if(result == -1) cerr << "Couldn't set SIGINT handler to default" << endl;
371 | 
372 | 	//Now send the received signal to ourself.
373 | 	kill(getpid(),signum);
374 | }
375 | 


--------------------------------------------------------------------------------
/SolverManager.cpp:
--------------------------------------------------------------------------------
  1 | /*
  2 |     Copyright (c) Dan Liew 2012
  3 | 
  4 |     This file is part of NSolv.
  5 | 
  6 |     NSolv is free software: you can redistribute it and/or modify
  7 |     it under the terms of the GNU General Public License as published by
  8 |     the Free Software Foundation, either version 3 of the License, or
  9 |     (at your option) any later version.
 10 | 
 11 |     NSolv is distributed in the hope that it will be useful,
 12 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
 13 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 14 |     GNU General Public License for more details.
 15 | 
 16 |     You should have received a copy of the GNU General Public License
 17 |     along with NSolv.  If not, see <http://www.gnu.org/licenses/>
 18 |  */
 19 | #include "global.h"
 20 | #include "SolverManager.h"
 21 | #include <iostream>
 22 | #include <cmath>
 23 | #include <signal.h>
 24 | #include <cstdlib>
 25 | #include <cstring>
 26 | #include <errno.h>
 27 | #include <cstdio>
 28 | #include <sys/wait.h>
 29 | #include <fcntl.h>
 30 | #include <sys/stat.h>
 31 | #include <sstream>
 32 | using namespace std;
 33 | 
 34 | 
 35 | SolverManager::SolverManager(const std::string& _inputFile, double _timeout, bool _loggingMode ) :
 36 | solvers(), pidToSolverMap(), inputFile(_inputFile), empty(""), fdToSolverMap(), largestFileDescriptor(0),
 37 | loggingMode(_loggingMode)
 38 | {
 39 | 	//set timeout
 40 | 	double intPart;
 41 | 	modf(_timeout,&intPart);
 42 | 
 43 | 	originalTimeout.tv_sec = timeout.tv_sec = static_cast<time_t>(intPart);
 44 | 	originalTimeout.tv_nsec = timeout.tv_nsec = 0;
 45 | 
 46 | 	if(verbose && _timeout != 0)
 47 | 		cerr << "SolverManager: Using timeout of " << timeout.tv_sec << " second(s)." << endl;
 48 | 
 49 | 	if(loggingMode)
 50 | 	{
 51 | 		if(verbose) cerr << "SolverManager: Using logging mode. Log file is " << loggingPath << endl;
 52 | 
 53 | 		//Open the file for output and append to previous logging data
 54 | 		loggingFile.open(loggingPath.c_str(), ios_base::out | ios_base::app);
 55 | 
 56 | 		//set precision for use with times
 57 | 		loggingFile.setf(ios::fixed,ios::floatfield);
 58 | 		loggingFile.precision(9); //show nanosecond precision.
 59 | 
 60 | 		if(! loggingFile.is_open())
 61 | 		{
 62 | 			cerr << "Error : Could not open log file." << endl;
 63 | 			exit(1);
 64 | 		}
 65 | 		else
 66 | 			loggingFile << "#Start" << endl;
 67 | 
 68 | 	}
 69 | 
 70 | 	if(verbose && !loggingMode)
 71 | 		cerr << "SolverManager: Using performance mode" << endl;
 72 | 
 73 | 	//Setup up semaphore
 74 | 	solverSynchronisingSemaphore=NULL;
 75 | 	stringstream s;
 76 | 	s << "/nsolv-sem-" << time(NULL); //pick a unique name for the semaphore
 77 | 	solverSyncName=s.str();
 78 | 	solverSynchronisingSemaphore=sem_open(solverSyncName.c_str(),
 79 | 			O_CREAT | //Create a new semaphore if it doesn't already exist
 80 | 			O_EXCL | //Only allow exclusive access (i.e. with O_CREAT means that we can only create a new semaphore)
 81 | 			O_CLOEXEC, //Close semaphore on exec() call
 82 | 			S_IRWXU,
 83 | 			0U);
 84 | 
 85 | 	if(solverSynchronisingSemaphore==SEM_FAILED)
 86 | 	{
 87 | 		cerr << "SolverManager: Failed to create semaphore for synchronisation" << endl;
 88 | 		perror(NULL);
 89 | 	}
 90 | 	else
 91 | 		if(verbose) cerr << "SolverManger: Created named semaphore \"" << solverSyncName << "\"" << endl;
 92 | 
 93 | 
 94 | }
 95 | 
 96 | SolverManager::~SolverManager()
 97 | {
 98 | 	//clean up the semaphore
 99 | 
100 | 	if(sem_close(solverSynchronisingSemaphore)!=0)
101 | 	{
102 | 		cerr << "SolverManager: Failed to close semaphore" << endl;
103 | 		perror(NULL);
104 | 	}
105 | 	else
106 | 		if(verbose) cerr << "SolverManger: Closing semaphore \"" << solverSyncName << "\"" << endl;
107 | 
108 | 	//We assume that we are the parent process and so only the parent performs the unlink
109 | 	if(sem_unlink(solverSyncName.c_str())!=0)
110 | 	{
111 | 		cerr << "SolverManager: Failed to unlink semaphore" << endl;
112 | 		perror(NULL);
113 | 	}
114 | 	else
115 | 		if(verbose) cerr << "SolverManger: Unlinking semaphore \"" << solverSyncName << "\"" << endl;
116 | 
117 | 
118 | 	string solverName("");
119 | 	//Try to delete all the solvers
120 | 	for(map<pid_t,Solver*>::iterator i = pidToSolverMap.begin(); i != pidToSolverMap.end(); ++i)
121 | 	{
122 | 		solverName=i->second->toString();
123 | 
124 | 		//Delete the solver. This should kill the solver even if it's still running for some reason
125 | 		delete i->second;
126 | 		i->second=NULL;
127 | 
128 | 		//Try to reap the child. We don't want any zombies lying around!!
129 | 		if(i->first != 0)
130 | 		{
131 | 			if(verbose) cerr << "Reaping child PID:" << i->first << " (" << solverName << ")" << endl;
132 | 			waitpid(i->first,NULL,0);
133 | 		}
134 | 	}
135 | 
136 | 	//close log
137 | 	if(loggingMode) { loggingFile << endl; loggingFile.close();}
138 | }
139 | 
140 | void SolverManager::addSolver(const std::string& name,
141 | 		const std::string& cmdLineArgs, bool inputOnStdin)
142 | {
143 | 	Solver* s=NULL;
144 | 	try
145 | 	{
146 | 		s=new Solver(name,cmdLineArgs,inputFile, inputOnStdin);
147 | 		solvers.push_back(s);
148 | 
149 | 		if(! fdToSolverMap.insert( make_pair(s->getReadFileDescriptor(),s)).second)
150 | 			cerr << "Warning: Failed to record file descriptor -> solver mapping" << endl;
151 | 
152 | 		if(verbose)
153 | 			cerr << "SolverManager: Added solver \"" << name << "\"" << endl;
154 | 	}
155 | 	catch(exception& e)
156 | 	{
157 | 		cerr << "Failed to allocate memory for solver " << name << " : " << e.what() << endl;
158 | 		exit(1);
159 | 	}
160 | }
161 | 
162 | void SolverManager::addSolver(const std::string& name, bool inputOnStdin)
163 | {
164 | 	addSolver(name,empty, inputOnStdin);
165 | }
166 | 
167 | bool SolverManager::invokeSolvers()
168 | {
169 | 	if(getNumberOfSolvers() == 0)
170 | 	{
171 | 		cerr << "SolverManager::invokeSolvers : There are no solvers to invoke." << endl;
172 | 		return false;
173 | 	}
174 | 
175 | 	if(loggingMode) {listSolversToLog(); printSolverHeaderToLog();}
176 | 
177 | 	/* Loop over the solvers. For each solver fork the current process and
178 | 	 * execute the solver's code
179 | 	 */
180 | 	for(vector<Solver*>::iterator s = solvers.begin(); s!= solvers.end(); ++s)
181 | 	{
182 | 		fflush(stdout);
183 | 		fflush(stderr);
184 | 		pid_t pid = fork();
185 | 
186 | 		if(pid < 0)
187 | 		{
188 | 			cerr << "SolverManager::invokeSolvers() : Failed to fork!" << endl;
189 | 			return false;
190 | 		}
191 | 		if(pid == 0)
192 | 		{
193 | 			//In child
194 | 
195 | 			if(verbose) cerr << "SolverManager: Solver \"" << (*s)->toString() << "\" blocking..." << endl;
196 | 
197 | 			/* We will now block (assuming our semaphores is initialised to zero)
198 | 			 * until the NSolv parent process lets us go.
199 | 			 */
200 | 			if(sem_wait(solverSynchronisingSemaphore) !=0)
201 | 			{
202 | 				perror("Waiting for semaphore failed:");
203 | 			}
204 | 			if(verbose) cerr << "SolverManager: Solver \"" << (*s)->toString() << "\" unblocked..." << endl;
205 | 
206 | 			//Child code
207 | 			(*s)->exec();
208 | 		}
209 | 		else
210 | 		{
211 | 			//parent code
212 | 
213 | 			//Add the pid and solver to the map
214 | 			if(! pidToSolverMap.insert(std::make_pair(pid,*s)).second )
215 | 			{
216 | 				cerr << "SolverManager::invokeSolvers() : Failed toSolverManager::invokeSolvers() associate solver " << (*s)->toString() <<
217 | 						"with PID:" << pid << endl;
218 | 				return false;
219 | 			}
220 | 
221 | 			(*s)->setPID(pid);
222 | 		}
223 | 	}
224 | 
225 | 	/* (Parent). All the solvers have now been created. They should all be blocked on our semaphore.
226 | 	 * We'll now release the semaphores in the hope that all the solvers will get a fair (depends on
227 | 	 * your OS's scheduler) start.
228 | 	 */
229 | 	for(int numberOfSolvers=0; numberOfSolvers < solvers.size(); numberOfSolvers++)
230 | 		sem_post(solverSynchronisingSemaphore);
231 | 
232 | 	//record the start time
233 | 	if(clock_gettime(CLOCK_MONOTONIC,&startTime) == -1)
234 | 		cerr << "WARNING: Failed to record start time!" << endl;
235 | 
236 | 
237 | 
238 | 	Solver* solverOfInterest=NULL;
239 | 	int numberOfReadySolvers=0;
240 | 	int numberOfUsableSolvers=solvers.size();
241 | 	int status=0;
242 | 
243 | 	Solver* winningSolver=NULL;
244 | 	Solver::Result solverResult=Solver::ERROR;
245 | 
246 | 	while(numberOfUsableSolvers!=0)
247 | 	{
248 | 		setupFileDescriptorSet();
249 | 
250 | 		//Now wait for a solver to return.
251 | 		if(timeoutEnabled())
252 | 		{
253 | 			numberOfReadySolvers = pselect(largestFileDescriptor +1,&lookingToRead,NULL,NULL,&timeout,NULL);
254 | 		}
255 | 		else
256 | 		{
257 | 			numberOfReadySolvers = pselect(largestFileDescriptor +1,&lookingToRead,NULL,NULL,NULL,NULL);
258 | 		}
259 | 
260 | 		if(numberOfReadySolvers==0)
261 | 		{
262 | 			//Timeout expired!
263 | 			cerr << "Timeout expired!" << endl;
264 | 			if(loggingMode) printUnfinishedSolversToLog();
265 | 			return false;
266 | 		}
267 | 
268 | 		if(numberOfReadySolvers == -1)
269 | 		{
270 | 			switch(errno)
271 | 			{
272 | 				case EBADF:
273 | 					cerr << "Bad file descriptor in set given to pselect()" << endl;
274 | 					return false;
275 | 				case EINTR:
276 | 					//Unexpected signal
277 | 					cerr << "Received unexpected signal while waiting in pselect()" << endl;
278 | 					return false;
279 | 
280 | 				case EINVAL:
281 | 					//Invalid parameters
282 | 					cerr << "Invalid parameters given to pselect()" << endl;
283 | 					return false;
284 | 
285 | 				default:
286 | 					cerr << "Something went wrong waiting for solver via pselect()" << endl;
287 | 					return false;
288 | 			}
289 | 		}
290 | 
291 | 		solverOfInterest = getSolverFromFileDescriptorSet();
292 | 		if(solverOfInterest==NULL)
293 | 		{
294 | 			cerr << "Error: Couldn't find solver from its file descriptor." << endl;
295 | 			return false;
296 | 		}
297 | 
298 | 
299 | 		if(verbose) cerr << "Solver:" << solverOfInterest->toString() << " returned. Checking result..." << endl;
300 | 
301 | 		//remove that solver from the file descriptor map.
302 | 		removeSolverFromFileDescriptorSet(solverOfInterest);
303 | 
304 | 		solverResult=solverOfInterest->getResult();
305 | 		switch(solverResult)
306 | 		{
307 | 			case Solver::SAT:
308 | 
309 | 				if(verbose) cerr << "Result: sat" << endl;
310 | 
311 | 				if(winningSolver==NULL)
312 | 				{
313 | 
314 | 					winningSolver=solverOfInterest;//Record the solver that won so we can print its output later.
315 | 
316 | 					if(loggingMode)
317 | 						loggingFile << "#First solver to finish " << solverOfInterest->toString() << endl;
318 | 				}
319 | 
320 | 				if(!loggingMode)
321 | 				{
322 | 					//We don't want to let any other solvers run
323 | 					numberOfUsableSolvers=0;
324 | 					continue;
325 | 				}
326 | 				else
327 | 				{
328 | 					//Log output
329 | 					printSolverAnswerToLog(solverResult,solverOfInterest->toString());
330 | 
331 | 					//Try the other solvers.
332 | 					adjustRemainingTime();
333 | 					numberOfUsableSolvers--;
334 | 					continue;
335 | 				}
336 | 
337 | 			case Solver::UNSAT:
338 | 
339 | 				if(verbose) cerr << "Result: unsat" << endl;
340 | 
341 | 				if(winningSolver==NULL)
342 | 				{
343 | 						winningSolver=solverOfInterest;//Record the winning solver so we can output its output later.
344 | 
345 | 						if(loggingMode)
346 | 							loggingFile << "#First solver to finish " << solverOfInterest->toString() << endl;
347 | 				}
348 | 
349 | 
350 | 				if(!loggingMode)
351 | 				{
352 | 					//We don't want to let any other solvers run
353 | 					numberOfUsableSolvers=0;
354 | 					continue;
355 | 				}
356 | 				else
357 | 				{
358 | 					//Log output
359 | 					printSolverAnswerToLog(solverResult,solverOfInterest->toString());
360 | 
361 | 					//Try the other solvers.
362 | 					adjustRemainingTime();
363 | 					numberOfUsableSolvers--;
364 | 					continue;
365 | 				}
366 | 
367 | 
368 | 			case Solver::UNKNOWN:
369 | 				if(verbose) cerr << "Result: unknown" << endl << "Trying another solver..." << endl;
370 | 
371 | 				if(loggingMode) printSolverAnswerToLog(solverResult,solverOfInterest->toString());
372 | 				//Try another solver
373 | 				adjustRemainingTime();
374 | 				numberOfUsableSolvers--;
375 | 				continue;
376 | 
377 | 			case Solver::ERROR:
378 | 				cerr << "Result: Solver (" << solverOfInterest->toString() <<
379 | 						") failed." << endl << "Trying another solver..." << endl;
380 | 
381 | 				if(loggingMode) printSolverAnswerToLog(solverResult,solverOfInterest->toString());
382 | 
383 | 				//Try another solver
384 | 				adjustRemainingTime();
385 | 				numberOfUsableSolvers--;
386 | 				continue;
387 | 
388 | 			default:
389 | 				return false;
390 | 		}
391 | 
392 | 	}
393 | 
394 | 	if(winningSolver==NULL)
395 | 	{
396 | 		cerr << "SolverManager::invokeSolvers() : Ran out of usable solvers!" << endl;
397 | 		return false;
398 | 	}
399 | 	else
400 | 	{
401 | 		/* kill all other solvers if possible.
402 | 		 * For some reason if we don't do this calling dumpResult() on the winning solver
403 | 		 * blocks. I don't know why, it shouldn't happen because the file descriptor of each solver
404 | 		 * should be separate from each other.
405 | 		 */
406 | 
407 | 		for(vector<Solver*>::iterator i=solvers.begin(); i!= solvers.end(); ++i)
408 | 		{
409 | 			if(*i != winningSolver)
410 | 				(*i)->kill();
411 | 		}
412 | 
413 | 		//print the output of the winning solver
414 | 		winningSolver->dumpResult();
415 | 		return true;
416 | 	}
417 | 
418 | }
419 | 
420 | size_t SolverManager::getNumberOfSolvers()
421 | {
422 | 	return solvers.size();
423 | }
424 | 
425 | bool SolverManager::timeoutEnabled() {
426 | 	return (originalTimeout.tv_sec != 0);
427 | }
428 | 
429 | 
430 | void SolverManager::adjustRemainingTime()
431 | {
432 | 	timespec current;
433 | 	if(clock_gettime(CLOCK_MONOTONIC,&current) == -1)
434 | 	{
435 | 		cerr << "Failed to determine current time." << endl;
436 | 		return;
437 | 	}
438 | 
439 | 	//calculate elapsed time since start
440 | 	timespec elapsedTime= subtract(current,startTime);
441 | 
442 | 	if(elapsedTime >= originalTimeout)
443 | 		timeout.tv_sec= timeout.tv_nsec =0;
444 | 	else
445 | 		timeout= subtract(originalTimeout,elapsedTime);
446 | 
447 | 	if(verbose && timeoutEnabled()) cerr << "Remaining time:" << toDouble(timeout) << " second(s)." << endl;
448 | }
449 | 
450 | void SolverManager::setupFileDescriptorSet()
451 | {
452 | 	//set no file descriptors
453 | 	FD_ZERO(&lookingToRead);
454 | 	largestFileDescriptor=0;
455 | 
456 | 	//Add the file descriptors currently in the map.
457 | 	for(map<int,Solver*>::const_iterator i= fdToSolverMap.begin(); i!= fdToSolverMap.end(); ++i)
458 | 	{
459 | 		//Try to record the largest file descriptor
460 | 		if(i->first > largestFileDescriptor) largestFileDescriptor=i->first;
461 | 
462 | 		FD_SET(i->first,&lookingToRead);
463 | 	}
464 | }
465 | 
466 | Solver* SolverManager::getSolverFromFileDescriptorSet()
467 | {
468 | 	//Loop through known solvers using the first found solver
469 | 	for(vector<Solver*>::const_iterator i=solvers.begin(); i!= solvers.end(); ++i)
470 | 	{
471 | 		if(FD_ISSET((*i)->getReadFileDescriptor(),&lookingToRead))
472 | 			return *i;
473 | 	}
474 | 
475 | 	//We didn't find anything.
476 | 	return NULL;
477 | }
478 | 
479 | void SolverManager::removeSolverFromFileDescriptorSet(Solver* s)
480 | {
481 | 	for(map<int,Solver*>::iterator i= fdToSolverMap.begin(); i!= fdToSolverMap.end(); ++i)
482 | 	{
483 | 		if(i->second == s)
484 | 		{
485 | 			//remove this solver
486 | 			fdToSolverMap.erase(i);
487 | 			return;
488 | 		}
489 | 	}
490 | }
491 | 
492 | void SolverManager::listSolversToLog()
493 | {
494 | 	if(!loggingFile.good())
495 | 		return;
496 | 
497 | 	loggingFile << "# " << solvers.size() << " solvers: ";
498 | 
499 | 	for(vector<Solver*>::const_iterator i=solvers.begin(); i!= solvers.end(); ++i)
500 | 	{
501 | 		loggingFile << (*i)->toString() << "," ;
502 | 	}
503 | 
504 | 	loggingFile << endl;
505 | }
506 | 
507 | void SolverManager::printSolverHeaderToLog()
508 | {
509 | 	if(!loggingFile.good())
510 | 		return;
511 | 
512 | 	loggingFile << "# [Solver name ] [ time (seconds)] [answer]" << endl;
513 | }
514 | 
515 | void SolverManager::printSolverAnswerToLog(Solver::Result result,
516 | 		const std::string& name)
517 | {
518 | 	if(!loggingFile.good())
519 | 		return;
520 | 
521 | 	timespec current;
522 | 	if(clock_gettime(CLOCK_MONOTONIC,&current) == -1)
523 | 	{
524 | 		cerr << "Failed to determine current time." << endl;
525 | 		return;
526 | 	}
527 | 
528 | 	//calculate elapsed time since start
529 | 	timespec elapsedTime = subtract(current,startTime);
530 | 
531 | 	loggingFile << name << " " << toDouble(elapsedTime) << " " << Solver::resultToString(result) << endl;
532 | 
533 | 
534 | }
535 | 
536 | void SolverManager::printUnfinishedSolversToLog()
537 | {
538 | 	if(!loggingFile.good())
539 | 		return;
540 | 
541 | 	timespec current;
542 | 	if(clock_gettime(CLOCK_MONOTONIC,&current) == -1)
543 | 	{
544 | 		cerr << "Failed to determine current time." << endl;
545 | 		return;
546 | 	}
547 | 
548 | 	//calculate elapsed time since start
549 | 	timespec elapsedTime = subtract(current,startTime);
550 | 
551 | 	for(map<int,Solver*>::const_iterator i= fdToSolverMap.begin() ; i!= fdToSolverMap.end(); ++i)
552 | 	{
553 | 		loggingFile << i->second->toString() << " " << toDouble(elapsedTime) << " timeout" << endl;
554 | 	}
555 | }
556 | 
557 | struct timespec subtract(struct timespec a, struct timespec b)
558 | {
559 | 	/* Based on by Alex Measday's ts_util function from his General purpose library.
560 | 	 * http://www.geonius.com/software/libgpl/ts_util.html
561 | 	 */
562 | 	struct timespec result;
563 | 
564 | 	/* Handle the case where we would calculate a negative time.
565 | 	 * We just return 0.
566 | 	 */
567 | 	if( (a.tv_sec < b.tv_sec) ||
568 | 		((a.tv_sec == b.tv_sec) && (a.tv_nsec < b.tv_nsec) )
569 | 	  )
570 | 	{
571 | 		result.tv_sec = result.tv_sec =0;
572 | 		return result;
573 | 	}
574 | 
575 | 	//the result will be positive.
576 | 	result.tv_sec = a.tv_sec - b.tv_sec;
577 | 
578 | 	//check if we need to borrow from the seconds.
579 | 	if( a.tv_nsec < b.tv_nsec)
580 | 	{
581 | 		result.tv_sec -=1; //borrow a second
582 | 		result.tv_nsec = 1000000000L + a.tv_nsec - b.tv_nsec;
583 | 	}
584 | 	else
585 | 		result.tv_nsec = a.tv_nsec - b.tv_nsec;
586 | 
587 | 	return result;
588 | }
589 | 
590 | double toDouble(struct timespec t)
591 | {
592 | 	double value = t.tv_sec;
593 | 	value += (static_cast<double>(t.tv_nsec))/1E9;
594 | 	return value;
595 | }
596 | 
597 | bool operator==(struct timespec a, struct timespec b)
598 | {
599 | 	if(a.tv_sec == b.tv_sec && a.tv_nsec == b.tv_nsec)
600 | 		return true;
601 | 	else
602 | 		return false;
603 | }
604 | 
605 | bool operator>(struct timespec a, struct timespec b)
606 | {
607 | 	if(a.tv_sec > b.tv_sec)
608 | 		return true;
609 | 
610 | 	if( (a.tv_sec == b.tv_sec) && (a.tv_nsec > b.tv_nsec) )
611 | 		return true;
612 | 
613 | 	return false;
614 | }
615 | 
616 | bool operator>=(struct timespec a, struct timespec b) { return ( a==b || a>b);}
617 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------