sdk/2.1/docs/man/cl_khr_terminate_context.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">

<refentry>
    <refentryinfo>
        <keywordset>
            <keyword>cl_khr_terminate_context</keyword>
        </keywordset>
    </refentryinfo>

    <refmeta>
        <refentrytitle>cl_khr_terminate_context</refentrytitle>

        <refmiscinfo>
            <copyright>
                <year>2007-2013</year>
                <holder>The Khronos Group Inc.
 Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.</holder>
            </copyright>
        </refmiscinfo>
        <manvolnum>3</manvolnum>
    </refmeta>

<!-- ================================ SYNOPSIS -->

    <refnamediv id="cl_khr_terminate_context">
        <refname>cl_khr_terminate_context</refname>

        <refpurpose>
            Extension to allow an API to release a context.
        </refpurpose>
    </refnamediv>

    <!-- ALTERNATIVE SYNTAX SYNOPSIS (NON-FUNCTION) -->

    <refsect2 id="synopsis">
        <title>
        </title>

        <informaltable frame="none">
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
                <colspec colname="col1" colnum="1" />
                <tbody>
                    <row>
                        <entry>
#pragma OPENCL EXTENSION cl_khr_terminate_context : enable
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect2>

<!-- ================================ DESCRIPTION  -->

    <refsect1 id="description"><title>Description</title>
        <para>
            Today, OpenCL provides an API to release a context. This operation is done only after
            all queues, memory object, programs and kernels are released, which in turn might wait
            for all ongoing operations to complete. However, there are cases in which a fast release is 
            required, or release operation cannot be done, as commands are stuck in mid execution. An 
            example of the first case can be program termination due to exception, or quick shutdown due to 
            low power. Examples of the second case are when a kernel is running too long, or gets stuck,
            or it may result from user action which makes the results of the computation unnecessary.
        </para>

        <para>
            In many cases, the driver or the device is capable of speeding up the closure of ongoing 
            operations when the results are no longer required in a much more expedient manner than 
            waiting for all previously enqueued operations to finish.
        </para>

        <para>
            This extension implements a new query to check whether a device can terminate an OpenCL 
            context and adds an API to terminate a context.
        </para>

        <para>
            This extensions enables the following function:
        </para>

        <informaltable frame="none">
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
                <colspec colname="col1" colnum="1" />
                <tbody>
                    <row>
                        <entry>
                            <citerefentry><refentrytitle>clTerminateContextKHR</refentrytitle></citerefentry>
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>

        <para>
            This extensions adds changes to the following:
        </para>

        <informaltable frame="none">
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
                <colspec colname="col1" colnum="1" />
                <tbody>
                    <row>
                        <entry>
                            <citerefentry><refentrytitle>clGetDeviceInfo</refentrytitle></citerefentry>
                        </entry>
                    </row>

                    <row>
                        <entry>
                            <citerefentry><refentrytitle>clCreateContext</refentrytitle></citerefentry>
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>

    </refsect1>


<!-- ================================ EXAMPLE  -->
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
<!--
    <refsect2 id="example1">
        <title>
            Example
        </title>

        <informaltable frame="none">
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
                <colspec colname="col1" colnum="1" />
                <tbody>
                    <row>
                        <entry>
                            Example goes here - it will be set in "code" type with white space preserved.
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect2>
-->

<!-- ================================ SPECIFICATION  -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
-->
    <refsect1 id="specification"><title>Specification</title>
        <para>
            <imageobject>
                <imagedata fileref="pdficon_small1.gif" format="gif" />
            </imageobject>

            <olink uri="cl_khr_terminate_context">OpenCL Specification</olink>
        </para>
    </refsect1>

<!-- ================================ ALSO SEE  -->

    <refsect1 id="seealso"><title>Also see</title>
        <para>
            <citerefentry>
                <refentrytitle>clTerminateContextKHR</refentrytitle>,
                <citerefentry><refentrytitle>clGetDeviceInfo</refentrytitle></citerefentry>,
                <citerefentry><refentrytitle>clCreateContext</refentrytitle></citerefentry>
            </citerefentry>
        </para>
    </refsect1>

<!-- ============================== COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->

    <refsect3 id="Copyright"><title></title>
        <imageobject>
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
        </imageobject>
        <para />
    </refsect3>

 <!-- 4-Nov-2015, API rev. 19; Ext rev. 10 -->
</refentry>