├── CONTRIBUTING.md ├── tests └── integration │ ├── tests │ ├── conftest.py │ ├── pytest.ini │ ├── fixtures.py │ ├── plays.py │ ├── basic.py │ ├── event.py │ ├── include_task.py │ └── utils.py │ ├── include_task │ ├── tasks │ │ ├── include_no_templating.yml │ │ └── include_templating.yml │ ├── playbook_no_templating.yml │ └── playbook_templating.yml │ ├── inventories │ ├── one_host.ini │ └── multiple_hosts.ini │ ├── plays │ ├── otherplays.yml │ ├── nested.yml │ └── base.yml │ ├── basic │ └── basic.yml │ └── ansible.cfg ├── ansible-trace-lockstep.png ├── ansible-trace-marked-up.png ├── ansible-trace-slice-details.png ├── meta └── runtime.yml ├── .gitignore ├── .github └── workflows │ ├── deploy.yml │ └── CI.yml ├── plugins ├── README.md └── callback │ └── trace.py ├── galaxy.yml ├── README.md └── LICENSE /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | ## Code Reviews 2 | 3 | We accept code reviews via GitHub pull requests. 4 | -------------------------------------------------------------------------------- /tests/integration/tests/conftest.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from fixtures import ansible_play 3 | 4 | -------------------------------------------------------------------------------- /ansible-trace-lockstep.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mhansen/ansible-trace/HEAD/ansible-trace-lockstep.png -------------------------------------------------------------------------------- /ansible-trace-marked-up.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mhansen/ansible-trace/HEAD/ansible-trace-marked-up.png -------------------------------------------------------------------------------- /ansible-trace-slice-details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mhansen/ansible-trace/HEAD/ansible-trace-slice-details.png -------------------------------------------------------------------------------- /meta/runtime.yml: -------------------------------------------------------------------------------- 1 | # Probably works fine with older Ansible, I just haven't tested it. 2 | requires_ansible: ">=2.11" 3 | -------------------------------------------------------------------------------- /tests/integration/tests/pytest.ini: -------------------------------------------------------------------------------- 1 | [pytest] 2 | markers = 3 | ansible_strategy 4 | ansible_playbook 5 | ansible_inventory 6 | -------------------------------------------------------------------------------- /tests/integration/include_task/tasks/include_no_templating.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: Random task without templating 4 | shell: "echo 'hello world!'" 5 | 6 | -------------------------------------------------------------------------------- /tests/integration/include_task/tasks/include_templating.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: "Echo {{ include_message }}" 4 | shell: "echo {{ include_message }}" 5 | 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | tests/integration/inventory.ini 3 | tests/integration/trace 4 | tests/integration/tests/__pycache__ 5 | tests/integration/tests/.pytest_cache 6 | -------------------------------------------------------------------------------- /tests/integration/inventories/one_host.ini: -------------------------------------------------------------------------------- 1 | [all] 2 | localhost ansible_connection=local 3 | 4 | [group_a] 5 | 127.0.0.1 ansible_connection=local 6 | 7 | [group_b] 8 | 127.0.0.1 ansible_connection=local 9 | -------------------------------------------------------------------------------- /tests/integration/plays/otherplays.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - hosts: group_a 4 | name: Random play 5 | environment: 6 | CALLBACKS_ENABLED: trace 7 | TRACE_OUTPUT_DIR: /ansible_collections/mhansen/ansible-trace 8 | TRACE_HIDE_TASK_ARGUMENTS: True 9 | tasks: 10 | - name: A fake task 11 | shell: "echo 'hello there'" 12 | 13 | -------------------------------------------------------------------------------- /tests/integration/basic/basic.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - hosts: all 4 | environment: 5 | CALLBACKS_ENABLED: trace 6 | TRACE_OUTPUT_DIR: /ansible_collections/mhansen/ansible-trace 7 | TRACE_HIDE_TASK_ARGUMENTS: True 8 | tasks: 9 | - name: Ping self 10 | ansible.builtin.ping: 11 | 12 | - name: Hello world 13 | shell: "echo 'hello world!'" 14 | 15 | -------------------------------------------------------------------------------- /tests/integration/include_task/playbook_no_templating.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - hosts: all 4 | environment: 5 | CALLBACKS_ENABLED: trace 6 | TRACE_OUTPUT_DIR: /ansible_collections/mhansen/ansible-trace 7 | TRACE_HIDE_TASK_ARGUMENTS: True 8 | tasks: 9 | - name: Include task with no templating 10 | include_tasks: "tasks/include_no_templating.yml" 11 | 12 | -------------------------------------------------------------------------------- /tests/integration/plays/nested.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - hosts: group_b 4 | name: Third play 5 | environment: 6 | CALLBACKS_ENABLED: trace 7 | TRACE_OUTPUT_DIR: /ansible_collections/mhansen/ansible-trace 8 | TRACE_HIDE_TASK_ARGUMENTS: True 9 | tasks: 10 | - name: Random task 11 | shell: "echo 'Hello world'" 12 | 13 | - name: Nested play 14 | import_playbook: otherplays.yml 15 | 16 | -------------------------------------------------------------------------------- /tests/integration/include_task/playbook_templating.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - hosts: all 4 | environment: 5 | CALLBACKS_ENABLED: trace 6 | TRACE_OUTPUT_DIR: /ansible_collections/mhansen/ansible-trace 7 | TRACE_HIDE_TASK_ARGUMENTS: True 8 | tasks: 9 | - name: Include task with templating 10 | include_tasks: "tasks/include_templating.yml" 11 | vars: 12 | include_message: "Foo" 13 | 14 | -------------------------------------------------------------------------------- /.github/workflows/deploy.yml: -------------------------------------------------------------------------------- 1 | name: Ansible Galaxy 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | paths: 8 | - 'galaxy.yml' 9 | jobs: 10 | deploy: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v2 14 | 15 | - name: Deploy the collection 16 | uses: artis3n/ansible_galaxy_collection@v2 17 | with: 18 | api_key: ${{ secrets.GALAXY_API_KEY }} 19 | -------------------------------------------------------------------------------- /tests/integration/plays/base.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - hosts: group_a 4 | name: First play 5 | environment: 6 | CALLBACKS_ENABLED: trace 7 | TRACE_OUTPUT_DIR: /ansible_collections/mhansen/ansible-trace 8 | TRACE_HIDE_TASK_ARGUMENTS: True 9 | tasks: 10 | - name: One task before import 11 | shell: "echo 'Play 1'" 12 | 13 | - name: Second play 14 | import_playbook: otherplays.yml 15 | 16 | - name: Third play 17 | import_playbook: nested.yml 18 | -------------------------------------------------------------------------------- /tests/integration/inventories/multiple_hosts.ini: -------------------------------------------------------------------------------- 1 | [all] 2 | 127.0.0.1 ansible_connection=local 3 | 127.0.0.2 ansible_connection=local 4 | 127.0.0.3 ansible_connection=local 5 | 127.0.0.4 ansible_connection=local 6 | 127.0.0.5 ansible_connection=local 7 | 127.0.0.6 ansible_connection=local 8 | 127.0.0.7 ansible_connection=local 9 | 127.0.0.8 ansible_connection=local 10 | 127.0.0.9 ansible_connection=local 11 | 127.0.0.10 ansible_connection=local 12 | 13 | [group_a] 14 | 127.0.0.1 ansible_connection=local 15 | 127.0.0.2 ansible_connection=local 16 | 127.0.0.8 ansible_connection=local 17 | 127.0.0.9 ansible_connection=local 18 | 127.0.0.10 ansible_connection=local 19 | 20 | [group_b] 21 | 127.0.0.8 ansible_connection=local 22 | 127.0.0.9 ansible_connection=local 23 | 127.0.0.10 ansible_connection=local 24 | 127.0.0.11 ansible_connection=local 25 | -------------------------------------------------------------------------------- /tests/integration/tests/fixtures.py: -------------------------------------------------------------------------------- 1 | import os 2 | import pytest 3 | from pytest_ansible_playbook import runner 4 | 5 | 6 | @pytest.fixture 7 | def ansible_play(request): 8 | 9 | # Get required marks, raise exception if not defined or invalid params 10 | inventory = request.node.get_closest_marker('ansible_inventory').args[0] 11 | strategy = request.node.get_closest_marker('ansible_strategy').args[0] 12 | playbook = request.node.get_closest_marker('ansible_playbook').args[0] 13 | 14 | # Set params for ansible runner 15 | request.config.option.ansible_playbook_directory = "." 16 | request.config.option.ansible_playbook_inventory = inventory 17 | 18 | # Assign strategy 19 | os.environ["ANSIBLE_STRATEGY"] = strategy 20 | 21 | # Test required playbook 22 | with runner(request, [playbook]): 23 | yield 24 | -------------------------------------------------------------------------------- /plugins/README.md: -------------------------------------------------------------------------------- 1 | # Collections Plugins Directory 2 | 3 | This directory can be used to ship various plugins inside an Ansible collection. Each plugin is placed in a folder that 4 | is named after the type of plugin it is in. It can also include the `module_utils` and `modules` directory that 5 | would contain module utils and modules respectively. 6 | 7 | Here is an example directory of the majority of plugins currently supported by Ansible: 8 | 9 | ``` 10 | └── plugins 11 | ├── action 12 | ├── become 13 | ├── cache 14 | ├── callback 15 | ├── cliconf 16 | ├── connection 17 | ├── filter 18 | ├── httpapi 19 | ├── inventory 20 | ├── lookup 21 | ├── module_utils 22 | ├── modules 23 | ├── netconf 24 | ├── shell 25 | ├── strategy 26 | ├── terminal 27 | ├── test 28 | └── vars 29 | ``` 30 | 31 | A full list of plugin types can be found at [Working With Plugins](https://docs.ansible.com/ansible-core/2.11/plugins/plugins.html). 32 | -------------------------------------------------------------------------------- /.github/workflows/CI.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | pull_request: 5 | push: 6 | 7 | jobs: 8 | integration: 9 | runs-on: ubuntu-latest 10 | 11 | strategy: 12 | fail-fast: false 13 | matrix: 14 | ansible: 15 | - stable-2.11 16 | - stable-2.12 17 | - stable-2.13 18 | 19 | steps: 20 | - name: Checkout repository 21 | uses: actions/checkout@v2 22 | with: 23 | path: ansible_collections/mhansen/ansible-trace 24 | 25 | - name: Set up Python 26 | uses: actions/setup-python@v3 27 | with: 28 | python-version: 3.8 29 | 30 | - name: Install ansible-base (${{ matrix.ansible }}) 31 | run: pip3 install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check 32 | 33 | - name: Install test dependencies 34 | run: pip3 install pytest mypy pytest-ansible-playbook 35 | 36 | - name: Run integration tests 37 | run: pytest -v $(ls tests/*.py) 38 | working-directory: ansible_collections/mhansen/ansible-trace/tests/integration 39 | 40 | -------------------------------------------------------------------------------- /tests/integration/tests/plays.py: -------------------------------------------------------------------------------- 1 | # Handle integration tests 2 | from typing import Union, Dict, List, Any 3 | from utils import get_last_trace, parse_and_validate_trace 4 | from event import HostEvent 5 | import pytest 6 | 7 | JSONTYPE = Union[None, int, str, bool, List[Any], Dict[str, Any]] 8 | 9 | 10 | @pytest.mark.ansible_playbook('plays/base.yml') 11 | @pytest.mark.ansible_inventory('inventories/multiple_hosts.ini') 12 | @pytest.mark.ansible_strategy('free') 13 | def test_basic_multiple_free(ansible_play): 14 | trace_hosts: Dict[int, HostEvent] 15 | trace_events: Dict[int, Any] 16 | trace_json: JSONTYPE = get_last_trace() 17 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 18 | 19 | 20 | @pytest.mark.ansible_playbook('plays/base.yml') 21 | @pytest.mark.ansible_inventory('inventories/multiple_hosts.ini') 22 | @pytest.mark.ansible_strategy('linear') 23 | def test_basic_multiple_linear(ansible_play): 24 | trace_hosts: Dict[int, HostEvent] 25 | trace_events: Dict[int, Any] 26 | trace_json: JSONTYPE = get_last_trace() 27 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 28 | 29 | 30 | @pytest.mark.ansible_playbook('plays/base.yml') 31 | @pytest.mark.ansible_inventory('inventories/one_host.ini') 32 | @pytest.mark.ansible_strategy('linear') 33 | def test_basic_single_linear(ansible_play): 34 | trace_hosts: Dict[int, HostEvent] 35 | trace_events: Dict[int, Any] 36 | trace_json: JSONTYPE = get_last_trace() 37 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 38 | -------------------------------------------------------------------------------- /tests/integration/tests/basic.py: -------------------------------------------------------------------------------- 1 | # Handle integration tests 2 | from typing import Union, Dict, List, Any 3 | from utils import get_last_trace, parse_and_validate_trace 4 | from event import HostEvent 5 | import pytest 6 | 7 | JSONTYPE = Union[None, int, str, bool, List[Any], Dict[str, Any]] 8 | 9 | 10 | @pytest.mark.ansible_playbook('basic/basic.yml') 11 | @pytest.mark.ansible_inventory('inventories/multiple_hosts.ini') 12 | @pytest.mark.ansible_strategy('free') 13 | def test_basic_multiple_free(ansible_play): 14 | trace_hosts: Dict[int, HostEvent] 15 | trace_events: Dict[int, Any] 16 | trace_json: JSONTYPE = get_last_trace() 17 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 18 | 19 | 20 | @pytest.mark.ansible_playbook('basic/basic.yml') 21 | @pytest.mark.ansible_inventory('inventories/multiple_hosts.ini') 22 | @pytest.mark.ansible_strategy('linear') 23 | def test_basic_multiple_linear(ansible_play): 24 | trace_hosts: Dict[int, HostEvent] 25 | trace_events: Dict[int, Any] 26 | trace_json: JSONTYPE = get_last_trace() 27 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 28 | 29 | 30 | @pytest.mark.ansible_playbook('basic/basic.yml') 31 | @pytest.mark.ansible_inventory('inventories/one_host.ini') 32 | @pytest.mark.ansible_strategy('linear') 33 | def test_basic_single_linear(ansible_play): 34 | trace_hosts: Dict[int, HostEvent] 35 | trace_events: Dict[int, Any] 36 | trace_json: JSONTYPE = get_last_trace() 37 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 38 | -------------------------------------------------------------------------------- /tests/integration/tests/event.py: -------------------------------------------------------------------------------- 1 | import re 2 | 3 | class Event: 4 | 5 | pid: int 6 | name: str 7 | ph: str 8 | 9 | def __init__(self, dict): 10 | if not 'pid' in dict: 11 | raise ValueError('Event must be linked to pid') 12 | self.pid = dict['pid'] 13 | self.ph = dict['ph'] 14 | 15 | class DurationEvent(Event): 16 | 17 | id: int 18 | ts: float 19 | 20 | def __init__(self, dict): 21 | if not 'id' in dict: 22 | raise ValueError('Duration event needs to have id') 23 | self.id = dict['id'] 24 | if not 'ts' in dict: 25 | raise ValueError('Duration event {} needs to have a timestamp'.format(self.id)) 26 | if not 'name' in dict: 27 | raise ValueError('Duration event {} needs to have a name'.format(self.id)) 28 | if not 'ph' in dict or not re.search("^(B|E)$", dict['ph']): 29 | raise ValueError('Duration event {} needs to have a ph either set to B or E'.format(self.id)) 30 | self.ts = dict['ts'] 31 | self.name = dict['name'] 32 | 33 | super().__init__(dict) 34 | 35 | class HostEvent(Event): 36 | 37 | def __init__(self, dict): 38 | if not 'ph' in dict or dict['ph'] != 'M': 39 | raise ValueError('Host event needs to have a ph set to M') 40 | if not 'args' in dict or not 'name' in dict['args']: 41 | raise ValueError('Host events needs to have name') 42 | 43 | self.name = dict['args']['name'] 44 | 45 | super().__init__(dict) 46 | 47 | -------------------------------------------------------------------------------- /tests/integration/tests/include_task.py: -------------------------------------------------------------------------------- 1 | # Handle integration tests 2 | 3 | from event import HostEvent 4 | import pytest 5 | from utils import get_last_trace, parse_and_validate_trace 6 | from typing import Union, Dict, List, Any 7 | JSONTYPE = Union[None, int, str, bool, List[Any], Dict[str, Any]] 8 | 9 | 10 | @pytest.mark.ansible_playbook('include_task/playbook_no_templating.yml') 11 | @pytest.mark.ansible_inventory('inventories/multiple_hosts.ini') 12 | @pytest.mark.ansible_strategy('free') 13 | def test_include_task_multiple_free(ansible_play): 14 | trace_hosts: Dict[int, HostEvent] 15 | trace_events: Dict[int, Any] 16 | trace_json: JSONTYPE = get_last_trace() 17 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 18 | 19 | 20 | @pytest.mark.ansible_playbook('include_task/playbook_no_templating.yml') 21 | @pytest.mark.ansible_inventory('inventories/multiple_hosts.ini') 22 | @pytest.mark.ansible_strategy('linear') 23 | def test_include_task_multiple_linear(ansible_play): 24 | trace_hosts: Dict[int, HostEvent] 25 | trace_events: Dict[int, Any] 26 | trace_json: JSONTYPE = get_last_trace() 27 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 28 | 29 | 30 | @pytest.mark.ansible_playbook('include_task/playbook_no_templating.yml') 31 | @pytest.mark.ansible_inventory('inventories/one_host.ini') 32 | @pytest.mark.ansible_strategy('linear') 33 | def test_include_task_single_linear(ansible_play): 34 | trace_hosts: Dict[int, HostEvent] 35 | trace_events: Dict[int, Any] 36 | trace_json: JSONTYPE = get_last_trace() 37 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 38 | 39 | 40 | @pytest.mark.ansible_playbook('include_task/playbook_templating.yml') 41 | @pytest.mark.ansible_inventory('inventories/multiple_hosts.ini') 42 | @pytest.mark.ansible_strategy('free') 43 | def test_include_task_templating_multiple_free(ansible_play): 44 | trace_hosts: Dict[int, HostEvent] 45 | trace_events: Dict[int, Any] 46 | trace_json: JSONTYPE = get_last_trace() 47 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 48 | 49 | 50 | @pytest.mark.ansible_playbook('include_task/playbook_templating.yml') 51 | @pytest.mark.ansible_inventory('inventories/multiple_hosts.ini') 52 | @pytest.mark.ansible_strategy('linear') 53 | def test_include_task_templating_multiple_linear(ansible_play): 54 | trace_hosts: Dict[int, HostEvent] 55 | trace_events: Dict[int, Any] 56 | trace_json: JSONTYPE = get_last_trace() 57 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 58 | 59 | 60 | @pytest.mark.ansible_playbook('include_task/playbook_templating.yml') 61 | @pytest.mark.ansible_inventory('inventories/one_host.ini') 62 | @pytest.mark.ansible_strategy('linear') 63 | def test_include_task_templating_single_linear(ansible_play): 64 | trace_hosts: Dict[int, HostEvent] 65 | trace_events: Dict[int, Any] 66 | trace_json: JSONTYPE = get_last_trace() 67 | trace_hosts, trace_events = parse_and_validate_trace(trace_json) 68 | -------------------------------------------------------------------------------- /galaxy.yml: -------------------------------------------------------------------------------- 1 | ### REQUIRED 2 | # The namespace of the collection. This can be a company/brand/organization or product namespace under which all 3 | # content lives. May only contain alphanumeric lowercase characters and underscores. Namespaces cannot start with 4 | # underscores or numbers and cannot contain consecutive underscores 5 | namespace: mhansen 6 | 7 | # The name of the collection. Has the same character restrictions as 'namespace' 8 | name: ansible_trace 9 | 10 | # The version of the collection. Must be compatible with semantic versioning 11 | version: 0.0.8 12 | 13 | # The path to the Markdown (.md) readme file. This path is relative to the root of the collection 14 | readme: README.md 15 | 16 | # A list of the collection's content authors. Can be just the name or in the format 'Full Name (url) 17 | # @nicks:irc/im.site#channel' 18 | authors: 19 | - Mark Hansen 20 | 21 | 22 | ### OPTIONAL but strongly recommended 23 | # A short summary description of the collection 24 | description: "Visualise where time is spent in your Ansible playbooks: what tasks, and what hosts, so you can find where to optimise and decrease playbook latency." 25 | 26 | # Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only 27 | # accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file' 28 | license: 29 | - GPL-3.0-only 30 | 31 | # The path to the license file for the collection. This path is relative to the root of the collection. This key is 32 | # mutually exclusive with 'license' 33 | license_file: '' 34 | 35 | # A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character 36 | # requirements as 'namespace' and 'name' 37 | tags: ['trace', 'tracing', 'profile', 'profiling', 'speed', 'latency'] 38 | 39 | # Collections that this collection requires to be installed for it to be usable. The key of the dict is the 40 | # collection label 'namespace.name'. The value is a version range 41 | # L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version 42 | # range specifiers can be set and are separated by ',' 43 | dependencies: {} 44 | 45 | # The URL of the originating SCM repository 46 | repository: http://github.com/mhansen/ansible-trace 47 | 48 | # The URL to any online docs 49 | documentation: https://github.com/mhansen/ansible-trace#readme 50 | 51 | # The URL to the homepage of the collection/project 52 | homepage: http://github.com/mhansen/ansible-trace 53 | 54 | # The URL to the collection issue tracker 55 | issues: https://github.com/mhansen/ansible-trace/issues 56 | 57 | # A list of file glob-like patterns used to filter any files or directories that should not be included in the build 58 | # artifact. A pattern is matched from the relative path of the file or directory of the collection directory. This 59 | # uses 'fnmatch' to match the files or directories. Some directories and files like 'galaxy.yml', '*.pyc', '*.retry', 60 | # and '.git' are always filtered 61 | build_ignore: [] 62 | 63 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ansible-trace 2 | 3 | [![Version on Galaxy](https://img.shields.io/badge/dynamic/json?style=flat&label=ansible-galaxy&prefix=v&url=https://galaxy.ansible.com/api/v2/collections/mhansen/ansible_trace/&query=latest_version.version)](https://galaxy.ansible.com/mhansen/ansible_trace) 4 | 5 | Visualise where time is spent in your Ansible playbooks: what tasks, and what hosts, so you can find where to optimise and decrease playbook latency. 6 | 7 | An Ansible [Callback Function](https://docs.ansible.com/ansible/latest/plugins/callback.html) which traces the execution time of Ansible playooks, outputting [Chrome's Trace Event Format](https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview) for visualising in the [Perfetto](https://ui.perfetto.dev/) in-browser trace UI. 8 | 9 | Here's a trace of me deploying to my home Raspberry Pi cluster, with the default [`strategy: linear`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/linear_strategy.html#linear-strategy). You can see that now all the tasks are synchronized across hosts, with each host waiting for the slowest host before proceeding to the next task: 10 | 11 | ![Perfetto window showing tasks all happening synchronized](ansible-trace-lockstep.png) 12 | 13 | Here's the same playbook ran with [`strategy: free`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/free_strategy.html) so fast hosts run to completion without waiting for slow hosts: 14 | 15 | ![Perfetto window showing durations](ansible-trace-marked-up.png) 16 | 17 | You can click on tasks to see details about them: 18 | 19 | ![Perfetto window showing details showing arguments and filename of task](ansible-trace-slice-details.png) 20 | 21 | ## Interactive Example 22 | 23 | 1. Download (Right-click -> Save Link As) [example-trace.json](https://raw.githubusercontent.com/mhansen/ansible-trace/main/example-trace.json). 24 | 1. Open https://ui.perfetto.dev/, and drag and drop in the downloaded example-trace.json. 25 | 26 | ## Usage 27 | 28 | 1. Install with Ansible-Galaxy: 29 | 30 | ```shell 31 | ansible-galaxy collection install mhansen.ansible_trace 32 | ``` 33 | 34 | 1. Enable the `mhansen.ansible_trace.trace` callback plugin in your `ansible.cfg`: 35 | 36 | ```ini 37 | [defaults] 38 | callbacks_enabled = mhansen.ansible_trace.trace 39 | ``` 40 | 41 | Or, enable it at the top of your playbook yml: 42 | 43 | ```yml 44 | ansible: 45 | env: 46 | CALLBACKS_ENABLED: mhansen.ansible_trace.trace 47 | TRACE_OUTPUT_DIR: ./trace 48 | TRACE_HIDE_TASK_ARGUMENTS: True 49 | ``` 50 | 51 | 1. Run your Ansible Playbook: 52 | 53 | ```shell 54 | $ ansible-playbook site.yml 55 | ``` 56 | 57 | This will output `trace-.json` in the `TRACE_OUTPUT_DIR` (by default: `./trace/`). 58 | 59 | 1. Open https://ui.perfetto.dev/, and drag-and-drop in the `trace-.json`. 60 | 61 | You don't have to wait for the trace to finish; you can open in-progress trace files. 62 | 63 | ## Other Trace Viewers 64 | 65 | Perfetto is the most mature trace viewer, but here are some other options: 66 | 67 | - chrome://tracing (aka [Catapult Trace Viewer](https://chromium.googlesource.com/external/github.com/catapult-project/catapult/+/refs/heads/master/tracing/docs/getting-started.md)) is the older version of Perfetto. Supports generating a standalone HTML page. 68 | - [Speedscope](https://www.speedscope.app/) can open the traces, but only shows one host at a time. 69 | - [Firefox Profiler](https://profiler.firefox.com/) can open the traces, showing trace spans in the "Marker Chart" tab: [example](https://share.firefox.dev/3mGRPJc). 70 | 71 | ## Other Ansible Profiling Tools 72 | 73 | ### profile_tasks 74 | 75 | [`ansible.posix.profile_tasks`](https://docs.ansible.com/ansible/latest/collections/ansible/posix/profile_tasks_callback.html) displays task timing as console output, but can't visualise gaps in the timing (e.g. with `strategy: linear` when fast hosts wait for slow hosts). 76 | 77 | ### ansible-playbook -vvvv 78 | 79 | [Adding extra `v`s adds more debug info](https://docs.ansible.com/ansible/latest/cli/ansible-playbook.html#cmdoption-ansible-playbook-v), `-vvvv` enables connection debugging. 80 | 81 | ### Logging and Tracing Plusing in community.general 82 | 83 | [`community.general`](https://docs.ansible.com/ansible/latest/collections/community/general/index.html#callback-plugins) 84 | contains many callback plugins for logging task events to various outputs, 85 | including Azure Log Analyics, LogDNA, Logentries, Logstash, Nagios, 86 | OpenTelemetry, Splunk, Sumologic, and Syslog. 87 | 88 | ### Mitogen for Ansible 89 | 90 | [Mitogen](https://mitogen.networkgenomics.com/ansible_detailed.html) promises to speed up your Ansible playbooks with a persistent interpreter. They profile their runs for bandwidth an time by analysing network packet captures. 91 | 92 | You need to install from HEAD to support latest Ansible versions, because there hasn't been a tagged release since 2019. 93 | -------------------------------------------------------------------------------- /tests/integration/ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | # (boolean) By default Ansible will issue a warning when received from a task action (module or action plugin) 3 | # These warnings can be silenced by adjusting this setting to False. 4 | ;action_warnings=True 5 | 6 | # (list) Accept list of cowsay templates that are 'safe' to use, set to empty list if you want to enable all installed templates. 7 | ;cowsay_enabled_stencils=bud-frogs, bunny, cheese, daemon, default, dragon, elephant-in-snake, elephant, eyes, hellokitty, kitty, luke-koala, meow, milk, moofasa, moose, ren, sheep, small, stegosaurus, stimpy, supermilker, three-eyes, turkey, turtle, tux, udder, vader-koala, vader, www 8 | 9 | # (string) Specify a custom cowsay path or swap in your cowsay implementation of choice 10 | ;cowpath= 11 | 12 | # (string) This allows you to chose a specific cowsay stencil for the banners or use 'random' to cycle through them. 13 | ;cow_selection=default 14 | 15 | # (boolean) This option forces color mode even when running without a TTY or the "nocolor" setting is True. 16 | ;force_color=False 17 | 18 | # (boolean) This setting allows suppressing colorizing output, which is used to give a better indication of failure and status information. 19 | ;nocolor=False 20 | 21 | # (boolean) If you have cowsay installed but want to avoid the 'cows' (why????), use this. 22 | ;nocows=False 23 | 24 | # (boolean) Sets the default value for the any_errors_fatal keyword, if True, Task failures will be considered fatal errors. 25 | ;any_errors_fatal=False 26 | 27 | # (path) The password file to use for the become plugin. --become-password-file. 28 | # If executable, it will be run and the resulting stdout will be used as the password. 29 | ;become_password_file= 30 | 31 | # (pathspec) Colon separated paths in which Ansible will search for Become Plugins. 32 | ;become_plugins=~/.ansible/plugins/become:/usr/share/ansible/plugins/become 33 | 34 | # (string) Chooses which cache plugin to use, the default 'memory' is ephemeral. 35 | ;fact_caching=memory 36 | 37 | # (string) Defines connection or path information for the cache plugin 38 | ;fact_caching_connection= 39 | 40 | # (string) Prefix to use for cache plugin files/tables 41 | ;fact_caching_prefix=ansible_facts 42 | 43 | # (integer) Expiration timeout for the cache plugin data 44 | ;fact_caching_timeout=86400 45 | 46 | # (list) Whitelist of callable methods to be made available to template evaluation 47 | ;callable_enabled= 48 | 49 | # (list) List of enabled callbacks, not all callbacks need enabling, but many of those shipped with Ansible do as we don't want them activated by default. 50 | ;callbacks_enabled= 51 | 52 | # (string) When a collection is loaded that does not support the running Ansible version (via the collection metadata key `requires_ansible`), the default behavior is to issue a warning and continue anyway. Setting this value to `ignore` skips the warning entirely, while setting it to `fatal` will immediately halt Ansible execution. 53 | ;collections_on_ansible_version_mismatch=warning 54 | 55 | # (pathspec) Colon separated paths in which Ansible will search for collections content. Collections must be in nested *subdirectories*, not directly in these directories. For example, if ``COLLECTIONS_PATHS`` includes ``~/.ansible/collections``, and you want to add ``my.collection`` to that directory, it must be saved as ``~/.ansible/collections/ansible_collections/my/collection``. 56 | 57 | ;collections_path=~/.ansible/collections:/usr/share/ansible/collections 58 | 59 | # (boolean) A boolean to enable or disable scanning the sys.path for installed collections 60 | ;collections_scan_sys_path=True 61 | 62 | # (boolean) Ansible can issue a warning when the shell or command module is used and the command appears to be similar to an existing Ansible module. 63 | # These warnings can be silenced by adjusting this setting to False. You can also control this at the task level with the module option ``warn``. 64 | # As of version 2.11, this is disabled by default. 65 | ;command_warnings=False 66 | 67 | # (path) The password file to use for the connection plugin. --connection-password-file. 68 | ;connection_password_file= 69 | 70 | # (pathspec) Colon separated paths in which Ansible will search for Action Plugins. 71 | ;action_plugins=~/.ansible/plugins/action:/usr/share/ansible/plugins/action 72 | 73 | # (boolean) When enabled, this option allows lookup plugins (whether used in variables as ``{{lookup('foo')}}`` or as a loop as with_foo) to return data that is not marked 'unsafe'. 74 | # By default, such data is marked as unsafe to prevent the templating engine from evaluating any jinja2 templating language, as this could represent a security risk. This option is provided to allow for backward compatibility, however users should first consider adding allow_unsafe=True to any lookups which may be expected to contain data which may be run through the templating engine late 75 | ;allow_unsafe_lookups=False 76 | 77 | # (boolean) This controls whether an Ansible playbook should prompt for a login password. If using SSH keys for authentication, you probably do not needed to change this setting. 78 | ;ask_pass=False 79 | 80 | # (boolean) This controls whether an Ansible playbook should prompt for a vault password. 81 | ;ask_vault_pass=False 82 | 83 | # (pathspec) Colon separated paths in which Ansible will search for Cache Plugins. 84 | ;cache_plugins=~/.ansible/plugins/cache:/usr/share/ansible/plugins/cache 85 | 86 | # (pathspec) Colon separated paths in which Ansible will search for Callback Plugins. 87 | callback_plugins=../../plugins/callback 88 | callbacks_enabled = trace 89 | 90 | -------------------------------------------------------------------------------- /tests/integration/tests/utils.py: -------------------------------------------------------------------------------- 1 | import os 2 | import json 3 | import glob 4 | import re 5 | from collections import deque 6 | from typing import Union, Dict, List, Any, TextIO, Deque, Tuple 7 | from event import HostEvent, DurationEvent 8 | 9 | JSONTYPE = Union[None, int, str, bool, List[Any], Dict[str, Any]] 10 | 11 | 12 | def get_last_trace() -> JSONTYPE: 13 | list_of_files: List[str] = glob.glob('trace/*') 14 | latest_file: str = max(list_of_files, key=os.path.getctime) 15 | 16 | file: TextIO = open(latest_file, encoding="utf-8") 17 | trace_json: JSONTYPE = json.load(file) 18 | file.close() 19 | return trace_json 20 | 21 | 22 | def parse_and_validate_trace(trace: JSONTYPE) -> Tuple[Dict[int, HostEvent], 23 | Dict[int, Any]]: 24 | hosts: Dict[int, HostEvent] = {} 25 | duration_events: Dict[int, Any] = {} 26 | duration_stacks: Dict[int, Deque] = {} 27 | 28 | # Parse events in trace 29 | for event in trace: 30 | if 'ph' in event and event['ph'] == 'M': 31 | hosts, duration_events, duration_stacks = add_hosts( 32 | hosts, duration_events, duration_stacks, event) 33 | elif 'ph' in event and re.search("^(B|E)$", event['ph']): 34 | duration_events, duration_stacks = add_duration_event( 35 | hosts, duration_events, duration_stacks, event) 36 | else: 37 | raise ValueError('Event cannot be handled') 38 | 39 | return (hosts, duration_events) 40 | 41 | 42 | def add_hosts( 43 | hosts: Dict[int, HostEvent], 44 | duration_events: Dict[int, Any], 45 | duration_stacks: Dict[int, Deque], 46 | event_hash: Any) -> Tuple[Dict[int, HostEvent], 47 | Dict[int, Any], Dict[int, Deque]]: 48 | 49 | event = HostEvent(event_hash) 50 | 51 | hosts[event.pid] = event 52 | duration_events[event.pid] = {} 53 | duration_stacks[event.pid] = deque() 54 | 55 | return (hosts, duration_events, duration_stacks) 56 | 57 | 58 | def add_duration_event( 59 | hosts: Dict[int, HostEvent], 60 | events: Dict[int, Any], 61 | curr_stacks: Dict[int, Deque], 62 | event_hash: Any) -> Tuple[Dict[int, Any], Dict[int, Deque]]: 63 | 64 | event = DurationEvent(event_hash) 65 | 66 | if event.pid not in hosts: 67 | raise ValueError( 68 | f'Duration event {event.id} host with pid {event.pid}' 69 | 'does not match any registered host') 70 | 71 | if event.ph == 'B': 72 | 73 | # Check if event already exists 74 | if event.id in events[event.pid]: 75 | raise ValueError(f'Event {event.id} already registered') 76 | 77 | events[event.pid][event.id] = {'B': event, 'children_ids': []} 78 | 79 | # If there is event in stack, must declare this event as child of last 80 | # event in stack 81 | if curr_stacks[event.pid]: 82 | parent_id: int = curr_stacks[event.pid][-1] 83 | if parent_id not in events[event.pid]: 84 | raise ValueError( 85 | f'Event id {parent_id} in stack, ' 86 | 'is not present in host events') 87 | 88 | # Check if child timestamp is inferior or equal to parent 89 | if events[event.pid][parent_id]['B'].ts > event.ts: 90 | raise ValueError(f'Event id {event.id}' 91 | f'begin timestamp {event.ts}' 92 | 'is inferior to its parent id' 93 | f'{events[event.pid][parent_id]["B"].id}' 94 | 'with timestamp' 95 | f'{events[event.pid][parent_id]["B"].ts}') 96 | 97 | events[event.pid][parent_id]['children_ids'].append(event.id) 98 | events[event.pid][event.id]['parent_id'] = parent_id 99 | 100 | curr_stacks[event.pid].append(event.id) 101 | return (events, curr_stacks) 102 | 103 | if event.ph == 'E': 104 | 105 | # Check if there is B event 106 | if (event.id not in events[event.pid] 107 | or 'B' not in events[event.pid][event.id]): 108 | raise ValueError(f'Event {event.id} is not registered') 109 | 110 | # Check if timestamp is superior or equal to B event 111 | if events[event.pid][event.id]['B'].ts > event.ts: 112 | raise ValueError(f'Event id {event.id} timestamp {event.ts}' 113 | 'is lower than its begin event with timestamp' 114 | f'{events[event.pid][event.id]["B"].ts}') 115 | 116 | # Check we don't have children event not yet ended 117 | if(not curr_stacks[event.pid] 118 | or curr_stacks[event.pid][-1] != event.id): 119 | raise ValueError( 120 | f'Cannot end event id {event.id}' 121 | 'if I have child that are not yet ended' 122 | f'(id {curr_stacks[event.pid][-1]} ongoing)') 123 | 124 | # Check E event has the same name than the B events 125 | if events[event.pid][event.id]['B'].name != event.name: 126 | raise ValueError(f'Event id {event.id} with name {event.name}' 127 | ' does not have the same name as event B' 128 | f'{events[event.pid][event.id]["B"].name}') 129 | 130 | events[event.pid][event.id]['E'] = event 131 | curr_stacks[event.pid].pop() 132 | 133 | return (events, curr_stacks) 134 | -------------------------------------------------------------------------------- /plugins/callback/trace.py: -------------------------------------------------------------------------------- 1 | # Copyright 2021 Google LLC 2 | # 3 | # This program is free software; you can redistribute it and/or 4 | # modify it under the terms of the GNU General Public License 5 | # version 3 as published by the Free Software Foundation. 6 | # 7 | # This program is distributed in the hope that it will be useful, 8 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 9 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 10 | # GNU General Public License for more details. 11 | 12 | from __future__ import (absolute_import, division, print_function) 13 | __metaclass__ = type 14 | 15 | from ansible.plugins.callback import CallbackBase 16 | from typing import Dict, TextIO 17 | from datetime import datetime 18 | from dataclasses import dataclass 19 | import time 20 | import os 21 | import json 22 | import atexit 23 | 24 | DOCUMENTATION = ''' 25 | name: trace 26 | type: aggregate 27 | short_description: Write playbook output to Chrome\'s Trace Event Format file 28 | description: 29 | - This callback writes playbook output to Chrome Trace Event Format file. 30 | author: Mark Hansen (@mhansen) 31 | options: 32 | trace_output_dir: 33 | name: output dir 34 | default: ./trace 35 | description: Directory to write files to. 36 | env: 37 | - name: TRACE_OUTPUT_DIR 38 | hide_task_arguments: 39 | name: Hide the arguments for a task 40 | default: False 41 | description: Hide the arguments for a task 42 | env: 43 | - name: HIDE_TASK_ARGUMENTS 44 | requirements: 45 | - enable in configuration 46 | ''' 47 | 48 | 49 | class CallbackModule(CallbackBase): 50 | """ 51 | This callback traces execution time of tasks to Trace Event Format. 52 | 53 | This plugin makes use of the following environment variables: 54 | TRACE_OUTPUT_DIR (optional): Directory to write JSON files to. 55 | Default: ./trace 56 | TRACE_HIDE_TASK_ARGUMENTS (optional): Hide the arguments for a task 57 | Default: False 58 | """ 59 | 60 | CALLBACK_VERSION = 2.0 61 | CALLBACK_TYPE = 'aggregate' 62 | CALLBACK_NAME = 'trace' 63 | CALLBACK_NEEDS_ENABLED = True 64 | 65 | def __init__(self): 66 | super(CallbackModule, self).__init__() 67 | 68 | self._output_dir: str = os.getenv( 69 | 'TRACE_OUTPUT_DIR', os.path.join(os.path.expanduser('.'), 'trace')) 70 | self._hide_task_arguments: str = os.getenv( 71 | 'TRACE_HIDE_TASK_ARGUMENTS', 'False').lower() 72 | self._hosts: Dict[Host] = {} 73 | self._next_pid: int = 1 74 | self._first: bool = True 75 | self._start_date: str = datetime.now().isoformat() 76 | self._output_file: str = 'trace-%s.json' % self._start_date 77 | self._current_play: str = '' 78 | self._play_id: int = 0 79 | self._tasks: Dict[str] = {} 80 | 81 | if not os.path.exists(self._output_dir): 82 | os.makedirs(self._output_dir) 83 | output_file = os.path.join(self._output_dir, self._output_file) 84 | self._f: TextIO = open(output_file, 'w') 85 | self._f.write("[\n") 86 | 87 | atexit.register(self._end) 88 | 89 | # Permits to handle interpolation in task name in linear strategy 90 | def v2_playbook_on_task_start(self, task, is_conditional): 91 | self._tasks[task._uuid] = task.get_name().strip() 92 | 93 | def _write_event(self, e: Dict): 94 | if not self._first: 95 | self._f.write(",\n") 96 | self._first = False 97 | # sort for reproducibility 98 | json.dump(e, self._f, sort_keys=True, indent=2) 99 | self._f.flush() 100 | 101 | def v2_playbook_on_play_start(self, play): 102 | 103 | self._end_play_span() 104 | self._current_play = play 105 | self._play_id += 1 106 | 107 | def v2_runner_on_start(self, host, task): 108 | uuid = task._uuid 109 | name = self._tasks[uuid] 110 | 111 | args = None 112 | if not task.no_log and self._hide_task_arguments == 'false': 113 | args = task.args 114 | 115 | host_uuid = host._uuid 116 | if host_uuid not in self._hosts: 117 | pid = self._next_pid 118 | self._hosts[host_uuid] = Host(pid=pid, name=host.name) 119 | self._next_pid += 1 120 | # https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview#bookmark=id.iycbnb4z7i9g 121 | self._write_event({ 122 | "name": "process_name", 123 | "pid": pid, 124 | "cat": "process", 125 | "ph": "M", 126 | "args": { 127 | "name": host.name, 128 | }, 129 | }) 130 | 131 | # If it's the first task of the host for the play, start duration event for the current play 132 | if not self._hosts[host_uuid].hasTaskInPlay: 133 | self._write_event({ 134 | "name": self._current_play.get_name().strip(), 135 | "cat": "play", 136 | "ph": "B", # Begin 137 | "ts": time.time_ns() / 1000 if "time_ns" in time.__dict__ else time.time() * 100000, 138 | "pid": self._hosts[host_uuid].pid, 139 | "id": self._play_id, 140 | "args": { 141 | "host": host.name, 142 | }, 143 | }) 144 | self._hosts[host_uuid].hasTaskInPlay = True 145 | 146 | # See "Duration Events" in: 147 | # https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview#heading=h.nso4gcezn7n1 148 | self._write_event({ 149 | "name": name, 150 | "cat": "runner", 151 | "ph": "B", # Begin 152 | "ts": time.time_ns() / 1000 if "time_ns" in time.__dict__ else time.time() * 100000, 153 | "pid": self._hosts[host_uuid].pid, 154 | "id": abs(hash(uuid)), 155 | "args": { 156 | "args": args, 157 | "task": name, 158 | "path": task.get_path(), 159 | "host": host.name, 160 | }, 161 | }) 162 | 163 | def _end_play_span(self): 164 | # Spawn ending play event for each play that are done and then reset flag 165 | for host in self._hosts.values(): 166 | if host.hasTaskInPlay: 167 | # Write end event 168 | self._write_event({ 169 | "name": self._current_play.get_name().strip(), 170 | "cat": "play", 171 | "id": self._play_id, 172 | "ph": "E", # End 173 | "ts": time.time_ns() / 1000 if "time_ns" in time.__dict__ else time.time() * 100000, 174 | "pid": host.pid, 175 | }) 176 | 177 | host.hasTaskInPlay = False 178 | 179 | def _end_span(self, result, status: str): 180 | task = result._task 181 | uuid = task._uuid 182 | # See "Duration Events" in: 183 | # https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview#heading=h.nso4gcezn7n1 184 | self._write_event({ 185 | "name": task.get_name().strip(), 186 | "cat": "runner", 187 | "id": abs(hash(uuid)), 188 | "ph": "E", # End 189 | "ts": time.time_ns() / 1000 if "time_ns" in time.__dict__ else time.time() * 100000, 190 | "pid": self._hosts[result._host._uuid].pid, 191 | "args": { 192 | "status": status, 193 | }, 194 | }) 195 | 196 | def v2_runner_on_ok(self, result): 197 | self._end_span(result, status="ok") 198 | 199 | def v2_runner_on_unreachable(self, result): 200 | self._end_span(result, 'unreachable') 201 | 202 | def v2_runner_on_failed(self, result, ignore_errors=False): 203 | self._end_span(result, status='failed') 204 | 205 | def v2_runner_on_skipped(self, result): 206 | self._end_span(result, status='skipped') 207 | 208 | def _end(self): 209 | 210 | self._end_play_span() 211 | self._f.write("\n]") 212 | self._f.close() 213 | 214 | 215 | @dataclass 216 | class Host: 217 | name: str 218 | pid: int 219 | hasTaskInPlay: bool = False 220 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 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 | 635 | Copyright (C) 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 . 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 | Copyright (C) 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 | . 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 | . 675 | 676 | --------------------------------------------------------------------------------