├── .gitignore ├── .gitattributes ├── CHANGELOG.md ├── .editorconfig ├── post-example-build.cmake ├── include ├── threadpoolthreadapiimpl.h ├── threadpoolworker.h └── threadpool.h ├── tests ├── test.h ├── test_new_invalid_options.c ├── test_stress.c ├── test_invoke_over_max_threads.c ├── test_invoke_under_max_threads.c └── test.c ├── .github ├── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md ├── CONTRIBUTING.md └── workflows │ └── ci.yml ├── examples └── example.c ├── src ├── threadpoolthreadapiimpl.c ├── threadpoolworker.c └── threadpool.c ├── README.md ├── CMakeLists.txt ├── uncrustify.cfg └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | temp/ 3 | **/*.log 4 | /core 5 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text eol=lf 2 | *.ico binary 3 | *.woff binary 4 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## CHANGELOG 2 | 3 | ### v0.1.1 (20230-4-19) 4 | 5 | * Extract thread lock to a standalone library and use it in threadpool 6 | 7 | ### v0.1.0 (2023-04-18) 8 | 9 | * Initial release 10 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | end_of_line = lf 7 | insert_final_newline = true 8 | trim_trailing_whitespace = true 9 | indent_style = space 10 | indent_size = 2 11 | 12 | -------------------------------------------------------------------------------- /post-example-build.cmake: -------------------------------------------------------------------------------- 1 | 2 | include("./cmake-modules/src/utils.cmake") 3 | 4 | utils_embed_example_source_in_readme( 5 | EXAMPLE_FILE "../examples/example.c" 6 | DOCUMENT_FILE "../README.md" 7 | SOURCE_TYPE "c" 8 | ) 9 | 10 | -------------------------------------------------------------------------------- /include/threadpoolthreadapiimpl.h: -------------------------------------------------------------------------------- 1 | #ifndef THREADPOOLTHREADAPIIMPL_H 2 | #define THREADPOOLTHREADAPIIMPL_H 3 | 4 | #include "threadpool.h" 5 | 6 | struct ThreadPoolThreadAPI *threadpoolthreadapiimpl_new(void); 7 | void threadpoolthreadapiimpl_release(struct ThreadPoolThreadAPI *); 8 | 9 | #endif 10 | 11 | -------------------------------------------------------------------------------- /tests/test.h: -------------------------------------------------------------------------------- 1 | #ifndef __TEST_H__ 2 | #define __TEST_H__ 3 | 4 | #include 5 | #include 6 | 7 | void test_run(void (*fn)()); 8 | void test_fail(); 9 | void assert_true(bool); 10 | void assert_true_with_description(bool, const char *); 11 | 12 | void assert_size_equal(size_t, size_t); 13 | void assert_num_equal(int, int); 14 | void assert_string_equal(char *, char *); 15 | 16 | #endif 17 | 18 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: sagiegurari 7 | 8 | --- 9 | 10 | ### Feature Description 11 | 12 | 13 | ### Describe The Solution You'd Like 14 | 15 | 16 | ### Code Sample 17 | 18 | ```c 19 | // paste code here 20 | ``` 21 | -------------------------------------------------------------------------------- /tests/test_new_invalid_options.c: -------------------------------------------------------------------------------- 1 | #include "test.h" 2 | #include "threadpool.h" 3 | 4 | 5 | static void test_impl() 6 | { 7 | struct ThreadPoolOptions options = threadpool_new_default_options(); 8 | 9 | options.max_size = 0; 10 | struct ThreadPool *pool = threadpool_new_with_options(options, NULL); 11 | assert_true_with_description(pool == NULL, "pool created with invalid options"); 12 | } 13 | 14 | 15 | int main() 16 | { 17 | test_run(test_impl); 18 | } 19 | 20 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: sagiegurari 7 | 8 | --- 9 | 10 | ### Describe The Bug 11 | 12 | 13 | ### To Reproduce 14 | 15 | 16 | ### Error Stack 17 | 18 | ```console 19 | The error stack trace 20 | ``` 21 | 22 | ### Code Sample 23 | 24 | ```c 25 | // paste code here 26 | ``` 27 | -------------------------------------------------------------------------------- /include/threadpoolworker.h: -------------------------------------------------------------------------------- 1 | #ifndef THREADPOOLWORKER_H 2 | #define THREADPOOLWORKER_H 3 | 4 | #include "threadlock.h" 5 | #include "threadpool.h" 6 | #include 7 | #include 8 | 9 | struct ThreadPoolWorker; 10 | 11 | struct ThreadPoolWorker *threadpoolworker_new(struct ThreadPoolThreadAPI *, struct ThreadLock *, bool *should_stop, int wait_timeout_in_milliseconds); 12 | void threadpoolworker_release(struct ThreadPoolWorker *); 13 | bool threadpoolworker_is_running(struct ThreadPoolWorker *); 14 | bool threadpoolworker_assign(struct ThreadPoolWorker *, void (*fn)(void *), void *args); 15 | 16 | #endif 17 | 18 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | ## Issues 4 | 5 | Found a bug? Got a question? Want some enhancement?
6 | First place to go is the repository issues section, and I'll try to help as much as possible. 7 | 8 | ## Pull Requests 9 | 10 | Fixed a bug or just want to provided additional functionality?
11 | Simply fork this repository, implement your changes and create a pull request.
12 | Few guidelines regarding pull requests: 13 | 14 | * This repository is integrated with github actions for continuous integration.
15 | 16 | Your pull request build must pass (the build will run automatically).
17 | You can run the following command locally to ensure the build will pass: 18 | 19 | ```sh 20 | mkdir ./target 21 | cd ./target 22 | cmake .. 23 | make 24 | ctest -C Release --output-on-failure 25 | ``` 26 | 27 | * There are many automatic unit tests as part of the library which provide full coverage of the functionality.
Any fix/enhancement must come with a set of tests to ensure it's working well. 28 | -------------------------------------------------------------------------------- /examples/example.c: -------------------------------------------------------------------------------- 1 | #include "threadpool.h" 2 | #include 3 | #include 4 | 5 | static void do_in_background(void *); 6 | 7 | 8 | int main() 9 | { 10 | printf("Library Examples:\n"); 11 | 12 | struct ThreadPool *pool = threadpool_new(); 13 | 14 | int loops = 100; 15 | int parallel = 100; 16 | for (int loop = 0; loop < loops; loop++) 17 | { 18 | for (int index = 0; index < parallel; index++) 19 | { 20 | char *args = (char *)malloc(sizeof(char) * 100); 21 | sprintf(args, "loop: %d sub loop: %d", loop, index); 22 | 23 | // invoke function in the background 24 | threadpool_invoke(pool, do_in_background, args); 25 | } 26 | 27 | // block until all threads finished processing all requests 28 | threadpool_block(pool); 29 | } 30 | 31 | // Once done, release the pool. 32 | // This will block until all threads are done. 33 | threadpool_release(pool); 34 | 35 | return(0); 36 | } 37 | 38 | 39 | static void do_in_background(void *args) 40 | { 41 | printf("In thread, args: %s\n", (char *)args); 42 | } 43 | 44 | -------------------------------------------------------------------------------- /tests/test_stress.c: -------------------------------------------------------------------------------- 1 | #include "test.h" 2 | #include "threadlock.h" 3 | #include "threadpool.h" 4 | 5 | static int _global_invoked = 0; 6 | static struct ThreadLock *_global_lock = NULL; 7 | 8 | 9 | static void _run(void *args) 10 | { 11 | assert_true_with_description(args != NULL, "args are null"); 12 | assert_string_equal("test", (char *)args); 13 | threadlock_lock(_global_lock); 14 | _global_invoked++; 15 | threadlock_unlock(_global_lock); 16 | } 17 | 18 | 19 | static void test_impl() 20 | { 21 | _global_lock = threadlock_new(); 22 | struct ThreadPool *pool = threadpool_new(); 23 | 24 | assert_true_with_description(pool != NULL, "pool is null"); 25 | 26 | int loops = 100; 27 | int parallel = 100; 28 | for (int loop = 0; loop < loops; loop++) 29 | { 30 | for (int index = 0; index < parallel; index++) 31 | { 32 | assert_true_with_description(threadpool_invoke(pool, _run, "test"), "Failed to submit job to thread"); 33 | } 34 | threadpool_block(pool); 35 | } 36 | assert_num_equal(_global_invoked, loops * parallel); 37 | 38 | threadpool_release(pool); 39 | threadlock_release(_global_lock); 40 | } 41 | 42 | 43 | int main() 44 | { 45 | test_run(test_impl); 46 | } 47 | 48 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: [push, pull_request] 3 | env: 4 | BUILD_TYPE: Release 5 | jobs: 6 | ci: 7 | name: CI 8 | runs-on: ${{ matrix.os }} 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | os: [ubuntu-latest, macOS-latest] 13 | steps: 14 | - name: Checkout 15 | uses: actions/checkout@v2 16 | - name: Setup Env 17 | run: cmake -E make_directory target 18 | - name: Configure 19 | shell: bash 20 | working-directory: target 21 | run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE 22 | - name: Build 23 | shell: bash 24 | working-directory: target 25 | run: cmake --build . --config $BUILD_TYPE 26 | - name: Test 27 | shell: bash 28 | working-directory: target 29 | run: ctest -C $BUILD_TYPE --output-on-failure 30 | - name: Memory Leak Test 31 | if: matrix.os == 'ubuntu-latest' 32 | shell: bash 33 | working-directory: target 34 | run: | 35 | sudo apt update 36 | sudo apt install -y valgrind --fix-missing 37 | for testfile in ./bin/test_*; do echo "Testing ${testfile}" && valgrind --leak-check=full --show-leak-kinds=definite,indirect,possible --error-exitcode=1 "${testfile}"; done 38 | 39 | -------------------------------------------------------------------------------- /tests/test_invoke_over_max_threads.c: -------------------------------------------------------------------------------- 1 | #include "test.h" 2 | #include "threadlock.h" 3 | #include "threadpool.h" 4 | 5 | static int _global_invoked = 0; 6 | static struct ThreadLock *_global_lock = NULL; 7 | 8 | 9 | static void _run(void *args) 10 | { 11 | assert_true_with_description(args != NULL, "args are null"); 12 | assert_string_equal("test", (char *)args); 13 | threadlock_lock(_global_lock); 14 | _global_invoked++; 15 | threadlock_unlock(_global_lock); 16 | } 17 | 18 | 19 | static void test_impl() 20 | { 21 | _global_lock = threadlock_new(); 22 | struct ThreadPoolOptions options = threadpool_new_default_options(); 23 | options.max_size = 2; 24 | struct ThreadPool *pool = threadpool_new_with_options(options, NULL); 25 | 26 | assert_true_with_description(pool != NULL, "pool is null"); 27 | 28 | int parallel = 10; 29 | for (int index = 0; index < parallel; index++) 30 | { 31 | assert_true_with_description(threadpool_invoke(pool, _run, "test"), "Failed to submit job to thread"); 32 | } 33 | threadpool_block(pool); 34 | assert_num_equal(_global_invoked, parallel); 35 | 36 | threadpool_release(pool); 37 | threadlock_release(_global_lock); 38 | } 39 | 40 | 41 | int main() 42 | { 43 | test_run(test_impl); 44 | } 45 | 46 | -------------------------------------------------------------------------------- /tests/test_invoke_under_max_threads.c: -------------------------------------------------------------------------------- 1 | #include "test.h" 2 | #include "threadlock.h" 3 | #include "threadpool.h" 4 | 5 | static int _global_invoked = 0; 6 | static struct ThreadLock *_global_lock = NULL; 7 | 8 | 9 | static void _run(void *args) 10 | { 11 | assert_true_with_description(args != NULL, "args are null"); 12 | assert_string_equal("test", (char *)args); 13 | threadlock_lock(_global_lock); 14 | _global_invoked++; 15 | threadlock_unlock(_global_lock); 16 | } 17 | 18 | 19 | static void test_impl() 20 | { 21 | _global_lock = threadlock_new(); 22 | struct ThreadPoolOptions options = threadpool_new_default_options(); 23 | options.max_size = 10; 24 | struct ThreadPool *pool = threadpool_new_with_options(options, NULL); 25 | 26 | assert_true_with_description(pool != NULL, "pool is null"); 27 | 28 | int parallel = 2; 29 | for (int index = 0; index < parallel; index++) 30 | { 31 | assert_true_with_description(threadpool_invoke(pool, _run, "test"), "Failed to submit job to thread"); 32 | } 33 | threadpool_block(pool); 34 | assert_num_equal(_global_invoked, parallel); 35 | 36 | threadpool_release(pool); 37 | threadlock_release(_global_lock); 38 | } 39 | 40 | 41 | int main() 42 | { 43 | test_run(test_impl); 44 | } 45 | 46 | -------------------------------------------------------------------------------- /tests/test.c: -------------------------------------------------------------------------------- 1 | #include "test.h" 2 | #include 3 | #include 4 | #include 5 | 6 | 7 | void test_run(void (*fn)(void)) 8 | { 9 | printf("Test ... "); 10 | fn(); 11 | printf("Done\n"); 12 | } 13 | 14 | 15 | void test_fail() 16 | { 17 | printf(" Error\n"); 18 | exit(1); 19 | } 20 | 21 | 22 | void assert_true(bool value) 23 | { 24 | assert_true_with_description(value, NULL); 25 | } 26 | 27 | 28 | void assert_true_with_description(bool value, const char *message) 29 | { 30 | if (!value) 31 | { 32 | if (message != NULL) 33 | { 34 | printf("\n%s\n", message); 35 | } 36 | test_fail(); 37 | } 38 | } 39 | 40 | 41 | void assert_size_equal(size_t value1, size_t value2) 42 | { 43 | if (value1 != value2) 44 | { 45 | #ifdef linux 46 | printf("Assert Failed, value: %zu not equals to value: %zu", value1, value2); 47 | #endif 48 | test_fail(); 49 | } 50 | } 51 | 52 | 53 | void assert_num_equal(int value1, int value2) 54 | { 55 | if (value1 != value2) 56 | { 57 | #ifdef linux 58 | printf("Assert Failed, value: %d not equals to value: %d", value1, value2); 59 | #endif 60 | test_fail(); 61 | } 62 | } 63 | 64 | 65 | void assert_string_equal(char *value1, char *value2) 66 | { 67 | if (strcmp(value1, value2) != 0) 68 | { 69 | printf("Assert Failed, value: %s not equals to value: %s", value1, value2); 70 | test_fail(); 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /src/threadpoolthreadapiimpl.c: -------------------------------------------------------------------------------- 1 | #include "threadpoolthreadapiimpl.h" 2 | #include 3 | #include 4 | 5 | static void *_threadpoolthreadapiimpl_start(struct ThreadPoolThreadAPI *, void *(*fn)(void *), void *); 6 | static bool _threadpoolthreadapiimpl_stop(struct ThreadPoolThreadAPI *, void *); 7 | 8 | struct ThreadPoolAPIThread 9 | { 10 | pthread_t thread; 11 | }; 12 | 13 | struct ThreadPoolThreadAPI *threadpoolthreadapiimpl_new(void) 14 | { 15 | struct ThreadPoolThreadAPI *thread_api = malloc(sizeof(struct ThreadPoolThreadAPI)); 16 | 17 | thread_api->start = _threadpoolthreadapiimpl_start; 18 | thread_api->stop = _threadpoolthreadapiimpl_stop; 19 | thread_api->context = NULL; 20 | 21 | return(thread_api); 22 | } 23 | 24 | 25 | void threadpoolthreadapiimpl_release(struct ThreadPoolThreadAPI *thread_api) 26 | { 27 | if (thread_api == NULL) 28 | { 29 | return; 30 | } 31 | 32 | free(thread_api->context); 33 | free(thread_api); 34 | } 35 | 36 | 37 | static void *_threadpoolthreadapiimpl_start(struct ThreadPoolThreadAPI *thread_api, void *(*fn)(void *), void *args) 38 | { 39 | if (thread_api == NULL) 40 | { 41 | return(NULL); 42 | } 43 | 44 | struct ThreadPoolAPIThread *thread = malloc(sizeof(struct ThreadPoolAPIThread)); 45 | 46 | bool created = !pthread_create(&thread->thread, NULL, fn, args); 47 | if (!created) 48 | { 49 | free(thread); 50 | return(NULL); 51 | } 52 | 53 | return(thread); 54 | } 55 | 56 | 57 | static bool _threadpoolthreadapiimpl_stop(struct ThreadPoolThreadAPI *thread_api, void *thread_ptr) 58 | { 59 | if (thread_api == NULL || thread_ptr == NULL) 60 | { 61 | return(false); 62 | } 63 | 64 | struct ThreadPoolAPIThread *thread = (struct ThreadPoolAPIThread *)thread_ptr; 65 | 66 | pthread_join(thread->thread, NULL); 67 | 68 | free(thread); 69 | 70 | return(true); 71 | } 72 | 73 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Thread Pool 2 | 3 | [![CI](https://github.com/sagiegurari/c_thread_pool/workflows/CI/badge.svg?branch=master)](https://github.com/sagiegurari/c_thread_pool/actions) 4 | [![Release](https://img.shields.io/github/v/release/sagiegurari/c_thread_pool)](https://github.com/sagiegurari/c_thread_pool/releases) 5 | [![license](https://img.shields.io/github/license/sagiegurari/c_thread_pool)](https://github.com/sagiegurari/c_thread_pool/blob/master/LICENSE) 6 | 7 | > Thread Pool for C. 8 | 9 | * [Overview](#overview) 10 | * [Usage](#usage) 11 | * [Contributing](.github/CONTRIBUTING.md) 12 | * [Release History](CHANGELOG.md) 13 | * [License](#license) 14 | 15 | 16 | ## Overview 17 | This library provides a simple thread pool and enables running functions in the background. 18 | 19 | 20 | ## Usage 21 | 22 | 23 | ```c 24 | #include "threadpool.h" 25 | #include 26 | #include 27 | 28 | static void do_in_background(void *); 29 | 30 | 31 | int main() 32 | { 33 | printf("Library Examples:\n"); 34 | 35 | struct ThreadPool *pool = threadpool_new(); 36 | 37 | int loops = 100; 38 | int parallel = 100; 39 | for (int loop = 0; loop < loops; loop++) 40 | { 41 | for (int index = 0; index < parallel; index++) 42 | { 43 | char *args = (char *)malloc(sizeof(char) * 100); 44 | sprintf(args, "loop: %d sub loop: %d", loop, index); 45 | 46 | // invoke function in the background 47 | threadpool_invoke(pool, do_in_background, args); 48 | } 49 | 50 | // block until all threads finished processing all requests 51 | threadpool_block(pool); 52 | } 53 | 54 | // Once done, release the pool. 55 | // This will block until all threads are done. 56 | threadpool_release(pool); 57 | 58 | return(0); 59 | } 60 | 61 | 62 | static void do_in_background(void *args) 63 | { 64 | printf("In thread, args: %s\n", (char *)args); 65 | } 66 | ``` 67 | 68 | 69 | ## Contributing 70 | See [contributing guide](.github/CONTRIBUTING.md) 71 | 72 | 73 | ## Release History 74 | 75 | See [Changelog](CHANGELOG.md) 76 | 77 | 78 | ## License 79 | Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license. 80 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | 2 | cmake_minimum_required(VERSION 3.7) 3 | 4 | project(threadpool C) 5 | 6 | # include shared utilities 7 | if(NOT EXISTS "target/cmake-modules/src/utils.cmake") 8 | execute_process(COMMAND git clone https://github.com/sagiegurari/cmake-modules.git) 9 | endif() 10 | include("target/cmake-modules/src/utils.cmake") 11 | 12 | set(CMAKE_EXPORT_COMPILE_COMMANDS ON) 13 | 14 | set(CMAKE_BUILD_TYPE Release) 15 | set(CMAKE_C_FLAGS -pthread) 16 | if(NOT WIN32) 17 | set(X_CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror -Wall -Wextra -Wcast-align -Wunused -Wshadow -Wpedantic") 18 | endif() 19 | 20 | set(X_CMAKE_PROJECT_ROOT_DIR ${CMAKE_BINARY_DIR}/..) 21 | 22 | set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) 23 | set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) 24 | set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) 25 | 26 | macro(add_external_lib) 27 | utils_add_external_github_lib( 28 | REPO_USERNAME sagiegurari 29 | REPO_NAME c_${ARGV0} 30 | TAG_NAME ${ARGV1} 31 | LIBRARY_NAME ${ARGV0} 32 | LIBRARY_PARENT_DIRECTORY target 33 | ) 34 | endmacro(add_external_lib) 35 | add_external_lib("thread_lock") 36 | 37 | include_directories(include "${THREAD_LOCK_INCLUDE}") 38 | 39 | # define all sources 40 | file(GLOB SOURCES "src/*.c") 41 | file(GLOB HEADER_SOURCES "include/*.h") 42 | file(GLOB TEST_SOURCES "tests/*") 43 | file(GLOB COMMON_TEST_SOURCES "tests/test.*") 44 | file(GLOB EXAMPLE_SOURCES "examples/*.c") 45 | 46 | # lint code 47 | utils_cppcheck(INCLUDE_DIRECTORY "./include/" SOURCES "./src/*.c" WORKING_DIRECTORY "${X_CMAKE_PROJECT_ROOT_DIR}") 48 | 49 | # format code 50 | utils_uncrustify( 51 | CONFIG_FILE "${X_CMAKE_PROJECT_ROOT_DIR}/uncrustify.cfg" 52 | SOURCES ${SOURCES} ${HEADER_SOURCES} ${TEST_SOURCES} ${EXAMPLE_SOURCES} 53 | ) 54 | 55 | # create static library 56 | add_library(${CMAKE_PROJECT_NAME} STATIC ${SOURCES} ${THREAD_LOCK_SOURCES}) 57 | if(NOT WIN32) 58 | set_target_properties(${CMAKE_PROJECT_NAME} PROPERTIES COMPILE_FLAGS "${X_CMAKE_C_FLAGS} -Wconversion") 59 | endif() 60 | 61 | # example 62 | add_executable(example examples/example.c) 63 | target_link_libraries(example ${CMAKE_PROJECT_NAME}) 64 | set_target_properties(example PROPERTIES COMPILE_FLAGS "${X_CMAKE_C_FLAGS}") 65 | 66 | # tests 67 | include(CTest) 68 | 69 | utils_setup_test_lib( 70 | SOURCES "${COMMON_TEST_SOURCES}" 71 | COMPILATION_FLAGS "${X_CMAKE_C_FLAGS}" 72 | ) 73 | utils_setup_c_all_tests( 74 | COMPILATION_FLAGS "${X_CMAKE_C_FLAGS}" 75 | BINARY_DIRECTORY "${CMAKE_BINARY_DIR}/bin" 76 | LIBRARIES "Test" 77 | ) 78 | 79 | if("$ENV{X_CMAKE_DOC_STEPS}" STREQUAL "true") 80 | # post build steps 81 | add_custom_command( 82 | TARGET example 83 | POST_BUILD 84 | COMMENT "Post Build Steps" 85 | COMMAND ${CMAKE_COMMAND} -P "../post-example-build.cmake" 86 | ) 87 | endif() 88 | 89 | -------------------------------------------------------------------------------- /include/threadpool.h: -------------------------------------------------------------------------------- 1 | #ifndef THREADPOOL_H 2 | #define THREADPOOL_H 3 | 4 | #include 5 | #include 6 | 7 | /** 8 | * This is the top level header that exposes this library API. 9 | * Other headers should be considered internal and should not be included directly. 10 | */ 11 | 12 | #define THREADPOOL_DEFAULT_MAX_SIZE 20 13 | #define THREADPOOL_DEFAULT_WAIT_TIMEOUT_MILLISECONDS 5000 // 5 seconds 14 | 15 | struct ThreadPool; 16 | 17 | /** 18 | * Custom threading API used by the ThreadPool and provided 19 | * by the caller. 20 | * The API will only require to handle a single thread at a time. 21 | */ 22 | struct ThreadPoolThreadAPI 23 | { 24 | /** 25 | * Creates and starts a new thread. 26 | * A basic implementation can be to simply wrap the pthread_create call and 27 | * return the thread. 28 | */ 29 | void * (*start)(struct ThreadPoolThreadAPI *, void *(*fn)(void *), void *args); 30 | 31 | /** 32 | * Stops the currently running thread (if exists). 33 | * A basic implementation can be to simply wrap the pthread_join call. 34 | */ 35 | bool (*stop)(struct ThreadPoolThreadAPI *, void *); 36 | 37 | /** 38 | * Any custom context used by the caller (not used by ThreadPool). 39 | */ 40 | void *context; 41 | }; 42 | 43 | struct ThreadPoolOptions 44 | { 45 | size_t max_size; 46 | bool wait_for_available_thread; 47 | struct ThreadPoolThreadAPI thread_api; 48 | // internal wait/signal timeout, <= 0 for unlimited 49 | int wait_timeout_in_milliseconds; 50 | }; 51 | 52 | /** 53 | * Returns default options struct that can be modified and used to later 54 | * create a new thread pool. 55 | */ 56 | struct ThreadPoolOptions threadpool_new_default_options(void); 57 | 58 | /** 59 | * Creates a new thread pool with default options. 60 | */ 61 | struct ThreadPool *threadpool_new(void); 62 | 63 | /** 64 | * Creates a new thread pool with provided options. 65 | * The optional thread api can be provided to gain more control over thread creation. 66 | */ 67 | struct ThreadPool *threadpool_new_with_options(struct ThreadPoolOptions, struct ThreadPoolThreadAPI *); 68 | 69 | /** 70 | * Finishes the currently running work and releases all the 71 | * thread pool. All functions in the backlog are dropped and the 72 | * thread pool is no longer usable. 73 | */ 74 | void threadpool_release(struct ThreadPool *); 75 | 76 | /** 77 | * Invokes the function via thread from the pool. 78 | * If no thread is available, a new thread will be created or (if max reached), the 79 | * function will wait for a free thread (in case wait_for_available_thread is true). 80 | */ 81 | bool threadpool_invoke(struct ThreadPool *, void (*fn)(void *), void *); 82 | 83 | /** 84 | * Blocks until all threads finish their work (including any waiting work). 85 | */ 86 | void threadpool_block(struct ThreadPool *); 87 | 88 | #endif 89 | 90 | -------------------------------------------------------------------------------- /src/threadpoolworker.c: -------------------------------------------------------------------------------- 1 | #include "threadlock.h" 2 | #include "threadpoolworker.h" 3 | #include 4 | 5 | struct ThreadPoolWorker 6 | { 7 | void *thread; 8 | void (*fn)(void *); 9 | void *args; 10 | struct ThreadLock *worker_lock; 11 | struct ThreadLock *notify_lock; 12 | struct ThreadPoolThreadAPI *thread_api; 13 | bool *should_stop; 14 | }; 15 | 16 | static void *_threadpoolworker_run(void *); 17 | 18 | struct ThreadPoolWorker *threadpoolworker_new(struct ThreadPoolThreadAPI *thread_api, struct ThreadLock *notify_lock, bool *should_stop, int wait_timeout_in_milliseconds) 19 | { 20 | if (thread_api == NULL || notify_lock == NULL || *should_stop) 21 | { 22 | return(NULL); 23 | } 24 | 25 | struct ThreadLockOptions lock_options = threadlock_new_default_options(); 26 | lock_options.wait_timeout_in_milliseconds = wait_timeout_in_milliseconds; 27 | struct ThreadLock *worker_lock = threadlock_new_with_options(lock_options); 28 | if (worker_lock == NULL) 29 | { 30 | return(NULL); 31 | } 32 | 33 | struct ThreadPoolWorker *worker = malloc(sizeof(struct ThreadPoolWorker)); 34 | worker->worker_lock = worker_lock; 35 | worker->notify_lock = notify_lock; 36 | worker->thread_api = thread_api; 37 | worker->should_stop = should_stop; 38 | worker->fn = NULL; 39 | worker->args = NULL; 40 | 41 | worker->thread = thread_api->start(thread_api, _threadpoolworker_run, worker); 42 | if (worker->thread == NULL) 43 | { 44 | threadlock_release(worker->worker_lock); 45 | free(worker); 46 | return(NULL); 47 | } 48 | 49 | return(worker); 50 | } 51 | 52 | 53 | void threadpoolworker_release(struct ThreadPoolWorker *worker) 54 | { 55 | if (worker == NULL) 56 | { 57 | return; 58 | } 59 | 60 | threadlock_lock(worker->worker_lock); 61 | worker->fn = NULL; 62 | worker->args = NULL; 63 | threadlock_signal(worker->worker_lock, false); 64 | threadlock_unlock(worker->worker_lock); 65 | worker->thread_api->stop(worker->thread_api, worker->thread); 66 | 67 | threadlock_release(worker->worker_lock); 68 | free(worker); 69 | } 70 | 71 | 72 | bool threadpoolworker_is_running(struct ThreadPoolWorker *worker) 73 | { 74 | if (worker == NULL) 75 | { 76 | return(false); 77 | } 78 | 79 | return(worker->fn != NULL); 80 | } 81 | 82 | 83 | bool threadpoolworker_assign(struct ThreadPoolWorker *worker, void (*fn)(void *), void *args) 84 | { 85 | if (worker == NULL || fn == NULL || threadpoolworker_is_running(worker)) 86 | { 87 | return(false); 88 | } 89 | 90 | threadlock_lock(worker->worker_lock); 91 | worker->args = args; 92 | worker->fn = fn; 93 | threadlock_signal(worker->worker_lock, false); 94 | threadlock_unlock(worker->worker_lock); 95 | 96 | return(true); 97 | } 98 | 99 | 100 | static void *_threadpoolworker_run(void *worker_ptr) 101 | { 102 | if (worker_ptr == NULL) 103 | { 104 | return(NULL); 105 | } 106 | 107 | struct ThreadPoolWorker *worker = (struct ThreadPoolWorker *)worker_ptr; 108 | do 109 | { 110 | threadlock_lock(worker->worker_lock); 111 | void (*fn)(void *) = worker->fn; 112 | void *args = worker->args; 113 | if (fn != NULL) 114 | { 115 | fn(args); 116 | 117 | worker->args = NULL; 118 | worker->fn = NULL; 119 | 120 | threadlock_unlock(worker->worker_lock); 121 | threadlock_signal(worker->notify_lock, true); 122 | } 123 | else if (!*worker->should_stop) 124 | { 125 | threadlock_signal(worker->notify_lock, true); 126 | threadlock_wait(worker->worker_lock, false); 127 | threadlock_unlock(worker->worker_lock); 128 | } 129 | 130 | if (*worker->should_stop && worker->fn == NULL) 131 | { 132 | break; 133 | } 134 | } while (true); 135 | 136 | return(NULL); 137 | } /* _threadpool_worker_loop */ 138 | -------------------------------------------------------------------------------- /uncrustify.cfg: -------------------------------------------------------------------------------- 1 | output_tab_size = 2 2 | tok_split_gte = true 3 | indent_columns = 2 4 | indent_with_tabs = 0 5 | indent_class = true 6 | indent_member = 2 7 | indent_bool_paren = true 8 | indent_first_bool_expr = true 9 | sp_arith = force 10 | sp_assign = force 11 | sp_assign_default = force 12 | sp_bool = force 13 | sp_compare = force 14 | sp_inside_paren = remove 15 | sp_paren_paren = remove 16 | sp_before_ptr_star = force 17 | sp_between_ptr_star = remove 18 | sp_after_ptr_star = remove 19 | sp_before_byref = force 20 | sp_after_byref = remove 21 | sp_before_angle = remove 22 | sp_inside_angle = remove 23 | sp_after_angle = force 24 | sp_angle_paren = remove 25 | sp_angle_paren_empty = remove 26 | sp_angle_word = force 27 | sp_before_sparen = force 28 | sp_inside_sparen = remove 29 | sp_after_sparen = force 30 | sp_before_semi_for = remove 31 | sp_before_semi_for_empty = force 32 | sp_before_squares = remove 33 | sp_inside_square = remove 34 | sp_after_comma = force 35 | sp_before_ellipsis = remove 36 | sp_after_cast = remove 37 | sp_sizeof_paren = remove 38 | sp_inside_braces_enum = force 39 | sp_inside_braces_struct = force 40 | sp_inside_braces = force 41 | sp_func_proto_paren = remove 42 | sp_func_def_paren = remove 43 | sp_inside_fparen = remove 44 | sp_after_tparen_close = remove 45 | sp_func_call_paren = remove 46 | sp_return_paren = remove 47 | sp_attribute_paren = remove 48 | sp_defined_paren = force 49 | sp_brace_typedef = force 50 | sp_before_dc = remove 51 | sp_after_dc = remove 52 | sp_enum_assign = force 53 | align_func_params = true 54 | align_var_def_span = 2 55 | align_var_def_star_style = 1 56 | align_var_def_amp_style = 1 57 | align_var_def_colon = true 58 | align_var_def_inline = true 59 | align_assign_span = 1 60 | align_enum_equ_span = 4 61 | align_var_class_span = 2 62 | align_var_struct_span = 3 63 | align_struct_init_span = 3 64 | align_typedef_gap = 3 65 | align_typedef_span = 5 66 | align_typedef_star_style = 1 67 | align_right_cmt_span = 3 68 | align_nl_cont = true 69 | align_pp_define_gap = 4 70 | align_pp_define_span = 3 71 | align_asm_colon = true 72 | align_enum_equ_thresh = 8 73 | nl_assign_leave_one_liners = true 74 | nl_class_leave_one_liners = true 75 | nl_enum_leave_one_liners = true 76 | nl_getset_leave_one_liners = true 77 | nl_assign_brace = add 78 | nl_func_var_def_blk = 1 79 | nl_fcall_brace = add 80 | nl_enum_brace = force 81 | nl_struct_brace = add 82 | nl_union_brace = add 83 | nl_if_brace = add 84 | nl_brace_else = add 85 | nl_elseif_brace = add 86 | nl_else_brace = add 87 | nl_finally_brace = add 88 | nl_try_brace = add 89 | nl_for_brace = add 90 | nl_catch_brace = add 91 | nl_while_brace = add 92 | nl_do_brace = add 93 | nl_brace_while = remove 94 | nl_switch_brace = add 95 | nl_before_case = true 96 | nl_after_case = true 97 | nl_case_colon_brace = force 98 | nl_namespace_brace = force 99 | nl_constr_init_args = force 100 | nl_func_type_name = remove 101 | nl_func_paren = remove 102 | nl_func_def_paren = remove 103 | nl_func_decl_start = remove 104 | nl_func_def_start = remove 105 | nl_func_decl_start_single = remove 106 | nl_func_def_start_single = remove 107 | nl_func_decl_args = remove 108 | nl_func_decl_end = remove 109 | nl_func_def_end = remove 110 | nl_func_decl_end_single = remove 111 | nl_func_def_end_single = remove 112 | nl_fdef_brace = force 113 | nl_return_expr = remove 114 | nl_after_semicolon = true 115 | nl_after_brace_open = true 116 | nl_after_vbrace_open = true 117 | nl_after_brace_close = true 118 | nl_squeeze_ifdef = true 119 | nl_constr_colon = force 120 | pos_constr_comma = lead_force 121 | pos_constr_colon = lead_break 122 | pos_bool = lead 123 | pos_enum_comma = trail_force 124 | nl_max = 3 125 | nl_after_func_proto = 1 126 | nl_after_func_proto_group = 2 127 | nl_before_func_body_def = 3 128 | nl_after_access_spec = 1 129 | eat_blanks_after_open_brace = true 130 | eat_blanks_before_close_brace = true 131 | nl_after_return = true 132 | mod_full_brace_do = add 133 | mod_full_brace_for = add 134 | mod_full_brace_if = add 135 | mod_full_brace_while = add 136 | mod_paren_on_return = add 137 | mod_remove_extra_semicolon = true 138 | mod_add_long_function_closebrace_comment = 40 139 | mod_add_long_namespace_closebrace_comment = 5 140 | mod_add_long_switch_closebrace_comment = 40 141 | mod_remove_empty_return = true 142 | cmt_star_cont = true 143 | pp_indent = remove 144 | pp_space = remove 145 | mod_sort_include = true 146 | -------------------------------------------------------------------------------- /src/threadpool.c: -------------------------------------------------------------------------------- 1 | #include "threadlock.h" 2 | #include "threadpool.h" 3 | #include "threadpoolthreadapiimpl.h" 4 | #include "threadpoolworker.h" 5 | #include 6 | 7 | struct ThreadPool 8 | { 9 | bool in_release; 10 | bool blocked; 11 | size_t max_size; 12 | bool wait_for_available_thread; 13 | int wait_timeout_in_milliseconds; 14 | struct ThreadPoolThreadAPI *thread_api; 15 | bool release_thread_api; 16 | struct ThreadPoolWorker **workers; 17 | struct ThreadLock *state_lock; 18 | struct ThreadLock *notification_lock; 19 | }; 20 | 21 | static struct ThreadPoolWorker *_threadpool_start_worker(struct ThreadPool *); 22 | struct ThreadPoolWorker *_threadpool_get_available_worker(struct ThreadPool *, void (*fn)(void *), void *); 23 | 24 | struct ThreadPoolOptions threadpool_new_default_options(void) 25 | { 26 | struct ThreadPoolOptions options = 27 | { 28 | .max_size = THREADPOOL_DEFAULT_MAX_SIZE, 29 | .wait_for_available_thread = true, 30 | .wait_timeout_in_milliseconds = THREADPOOL_DEFAULT_WAIT_TIMEOUT_MILLISECONDS, 31 | }; 32 | 33 | return(options); 34 | } 35 | 36 | struct ThreadPool *threadpool_new(void) 37 | { 38 | struct ThreadPoolOptions options = threadpool_new_default_options(); 39 | 40 | return(threadpool_new_with_options(options, NULL)); 41 | } 42 | 43 | struct ThreadPool *threadpool_new_with_options(struct ThreadPoolOptions options, struct ThreadPoolThreadAPI *thread_api) 44 | { 45 | if (!options.max_size) 46 | { 47 | return(NULL); 48 | } 49 | 50 | struct ThreadLockOptions lock_options = threadlock_new_default_options(); 51 | lock_options.wait_timeout_in_milliseconds = options.wait_timeout_in_milliseconds; 52 | struct ThreadLock *state_lock = threadlock_new_with_options(lock_options); 53 | if (state_lock == NULL) 54 | { 55 | return(NULL); 56 | } 57 | struct ThreadLock *notification_lock = threadlock_new_with_options(lock_options); 58 | if (notification_lock == NULL) 59 | { 60 | threadlock_release(state_lock); 61 | return(NULL); 62 | } 63 | 64 | struct ThreadPool *pool = malloc(sizeof(struct ThreadPool)); 65 | pool->state_lock = state_lock; 66 | pool->notification_lock = notification_lock; 67 | pool->in_release = false; 68 | pool->blocked = false; 69 | pool->max_size = options.max_size; 70 | pool->wait_for_available_thread = options.wait_for_available_thread; 71 | pool->wait_timeout_in_milliseconds = options.wait_timeout_in_milliseconds; 72 | pool->thread_api = thread_api; 73 | pool->release_thread_api = thread_api == NULL; 74 | pool->workers = malloc(sizeof(struct ThreadPoolWorker *) * pool->max_size); 75 | for (size_t index = 0; index < pool->max_size; index++) 76 | { 77 | pool->workers[index] = NULL; 78 | } 79 | 80 | if (pool->thread_api == NULL) 81 | { 82 | pool->thread_api = threadpoolthreadapiimpl_new(); 83 | } 84 | 85 | return(pool); 86 | } /* threadpool_new_with_options */ 87 | 88 | 89 | void threadpool_release(struct ThreadPool *pool) 90 | { 91 | if (pool == NULL || pool->in_release) 92 | { 93 | return; 94 | } 95 | 96 | pool->in_release = true; 97 | threadpool_block(pool); 98 | 99 | for (size_t index = 0; index < pool->max_size; index++) 100 | { 101 | struct ThreadPoolWorker *worker = pool->workers[index]; 102 | if (worker == NULL) 103 | { 104 | break; 105 | } 106 | 107 | threadpoolworker_release(worker); 108 | } 109 | 110 | threadlock_release(pool->state_lock); 111 | threadlock_release(pool->notification_lock); 112 | if (pool->release_thread_api) 113 | { 114 | threadpoolthreadapiimpl_release(pool->thread_api); 115 | } 116 | free(pool->workers); 117 | free(pool); 118 | } 119 | 120 | 121 | bool threadpool_invoke(struct ThreadPool *pool, void (*fn)(void *), void *args) 122 | { 123 | if (pool == NULL || fn == NULL || pool->in_release || pool->blocked) 124 | { 125 | return(false); 126 | } 127 | 128 | struct ThreadPoolWorker *worker = _threadpool_get_available_worker(pool, fn, args); 129 | while (worker == NULL && pool->wait_for_available_thread && !pool->in_release && !pool->blocked) 130 | { 131 | // wait for worker to be available 132 | threadlock_wait_with_timeout(pool->notification_lock, true, 1000); 133 | 134 | worker = _threadpool_get_available_worker(pool, fn, args); 135 | } 136 | 137 | return(worker != NULL); 138 | } 139 | 140 | 141 | void threadpool_block(struct ThreadPool *pool) 142 | { 143 | if (pool == NULL) 144 | { 145 | return; 146 | } 147 | 148 | threadlock_lock(pool->state_lock); 149 | pool->blocked = true; 150 | 151 | for (size_t index = 0; index < pool->max_size; index++) 152 | { 153 | struct ThreadPoolWorker *worker = pool->workers[index]; 154 | if (worker == NULL) 155 | { 156 | break; 157 | } 158 | 159 | while (threadpoolworker_is_running(worker)) 160 | { 161 | // wait for worker to notify its done 162 | threadlock_wait(pool->notification_lock, true); 163 | } 164 | } 165 | 166 | pool->blocked = false; 167 | threadlock_unlock(pool->state_lock); 168 | } 169 | 170 | static struct ThreadPoolWorker *_threadpool_start_worker(struct ThreadPool *pool) 171 | { 172 | if (pool == NULL) 173 | { 174 | return(NULL); 175 | } 176 | 177 | struct ThreadPoolWorker *worker = threadpoolworker_new(pool->thread_api, pool->notification_lock, &pool->in_release, pool->wait_timeout_in_milliseconds); 178 | if (worker == NULL) 179 | { 180 | return(NULL); 181 | } 182 | 183 | return(worker); 184 | } 185 | 186 | struct ThreadPoolWorker *_threadpool_get_available_worker(struct ThreadPool *pool, void (*fn)(void *), void *args) 187 | { 188 | struct ThreadPoolWorker *worker = NULL; 189 | bool done = false; 190 | 191 | threadlock_lock(pool->state_lock); 192 | for (size_t index = 0; index < pool->max_size; index++) 193 | { 194 | worker = pool->workers[index]; 195 | if (worker == NULL) 196 | { 197 | worker = _threadpool_start_worker(pool); 198 | if (worker != NULL) 199 | { 200 | pool->workers[index] = worker; 201 | threadpoolworker_assign(worker, fn, args); 202 | done = true; 203 | } 204 | break; 205 | } 206 | else if (threadpoolworker_assign(worker, fn, args)) 207 | { 208 | done = true; 209 | break; 210 | } 211 | } 212 | 213 | threadlock_unlock(pool->state_lock); 214 | 215 | if (!done) 216 | { 217 | return(NULL); 218 | } 219 | 220 | return(worker); 221 | } 222 | 223 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------