sdk/2.1/docs/man/xhtml/sharedVirtualMemory.html

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <style xmlns="" type="text/css">
    /* This style sets a margin around the entire page */
        html, body {
            margin: 10px;
        }

        p {
            font: normal 16px verdana, sans-serif;
            margin: 0;
            padding-bottom:12px;
        }

        h1 {
            font: bold 25px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h2 {
            font: bold 19px verdana, sans-serif;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h3 {
            font: bold 19px verdana, sans-serif !important;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        li {
            font: normal 16px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 18px;
            padding-top: 0;
            padding-bottom: 0;
        }

        .pdparam {
            font: italic 16px verdana, sans-serif;
        }

                .term {
                        font: italic 16px verdana, sans-serif;
                        font-weight: normal;
                }

                .type {
                        font: normal 16px verdana, sans-serif !important;
                }

                .parameter {
                        font-style: italic;
                        }

        a:link, a:visited {
            color: blue;
            text-decoration: none;
            font: normal 16px;
        }

        a:hover {
            background-color: #FFFF99;
            font: normal 16px;
        }

        div.funcsynopsis {
            text-align: left;
            background-color: #e6e6e6;
            font: normal 16px verdana, sans-serif;
                        padding-top: 10px;
                        padding-bottom: 10px;
        }

        div.funcsynopsis table {
            border-collapse: separate;
            font: normal 16px verdana, sans-serif;
        }

        div.funcsynopsis td {
            background-color: #e6e6e6;
            border: 0 solid #000;
            padding: 1px;
            font: normal 16px verdana, sans-serif;
        }

        div.refsect1 {
            font-family: verdana, sans-serif;
            font-size: 16px;
        }

        code.constant {
            font: normal 16px courier new, monospace !important;
        }

                span.errorname {
            font: normal 16px verdana, sans-serif !important;
        }

        code.function {
            font: bold 16px verdana, sans-serif !important;
        }

        b.fsfunc {
            font: bold 16px verdana, sans-serif !important;
        }

        code.varname {
            font: italic 16px verdana, sans-serif;
        }

        code.replaceable {
            font: italic 16px courier new, monospace;
        }

        code.funcdef {
            font: normal 16px verdana, sans-serif !important;
        }

        .citerefentry {
            font: normal 16px verdana, sans-serif !important;
        }

        .parameter {
            font-style: italic;
        }

        code.fsfunc {
            font: normal 16px verdana, sans-serif !important;
        }

        /* PARAMETER: This style controls spacing between the terms in Parameter section */
        dt {
            margin-top: 15px;
        }

        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
        div.refsect1 table {
            width: 100%;
                        margin-top: 10px;
            background-color: #FFF;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
                        font: normal 16px verdana, sans-serif;
        }

        div.refsect1 th {
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: bold 16px verdana, sans-serif;
        }

        div.refsect1 td {
            background-color: #FFF;
            padding: 5px;
            vertical-align: text-top;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: normal 16px verdana, sans-serif;
        }

                  div.refsect1 p{
            font: normal 16px verdana, sans-serif;
            margin-top: 8px;
            margin-bottom: 8px;
            padding-top: 0;
            padding-bottom: 0;
        }


        /* EXAMPLE: These styles apply only to the Example section */
        div.refsect2 {
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 table {
            margin-top: 0;
            background-color: #e6e6e6;
            width: 100%;
            border: 0 solid #000;
            padding: 2px;
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 td {
            background-color: #e6e6e6;
            font: normal 16px courier new, monospace !important;
                        white-space:pre;
        }

        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
        div.refsect3 {
            font: normal 11px verdana, sans-serif;
            margin-top: 50px;
            margin-bottom: 20px;
            padding-top: 0;
            padding-bottom: 0;
        }

</style>
    <title>Shared Virtual Memory</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
    <meta name="keywords" content="Shared Virtual Memory" />
  </head>
  <body>
    <div class="refentry">
      <a id="id-1"></a>
      <div class="titlepage"></div>
      <div xmlns="" class="refnamediv">
        <h1>Shared Virtual Memory (SVM) Functions</h1>
        <p>Click an item in the table below for details about that function.</p>
      </div>
      <div class="refsect1">
        <a id="springboard"></a>
        <h2></h2>
        <div class="informaltable">
          <table class="informaltable" border="1">
            <colgroup>
              <col align="left" class="col1" />
              <col align="left" class="col2" />
            </colgroup>
            <tbody>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="clSVMAlloc.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">clSVMAlloc</span>
                    </span>
                  </a>
                </td>
                <td align="left">Allocates a shared virtual memory buffer</td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="clSVMFree.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">clSVMFree</span>
                    </span>
                  </a>
                </td>
                <td align="left">Frees a shared virtual memory buffer</td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="clEnqueueSVMFree.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">clEnqueueSVMFree</span>
                    </span>
                  </a>
                </td>
                <td align="left">
               Enqueues a command to free the shared virtual memory allocated using
               <a class="citerefentry" href="clSVMAlloc.html"><span class="citerefentry"><span class="refentrytitle">clSVMAlloc</span></span></a>
               or a shared system memory pointer
            </td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="clEnqueueSVMMemcpy.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">clEnqueueSVMMemcpy</span>
                    </span>
                  </a>
                </td>
                <td align="left">Enqueues a command to do a memcpy operation</td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="clEnqueueSVMMemFill.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">clEnqueueSVMMemFill</span>
                    </span>
                  </a>
                </td>
                <td align="left">Enqueues a command to fill a region in memory with a pattern of a given pattern size</td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="clEnqueueSVMMap.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">clEnqueueSVMMap</span>
                    </span>
                  </a>
                </td>
                <td align="left">Enqueues a command that will allow the host to update a region of a SVM buffer</td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="clEnqueueSVMUnmap.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">clEnqueueSVMUnmap</span>
                    </span>
                  </a>
                </td>
                <td align="left">Enqueues a command to indicate that the host has completed updating a specified region</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="description"></a>
        <h2>Description</h2>
        <p>
            Shared Virtual Memory (SVM) (Glossary): An address space exposed to both the host and the devices
            within a context. SVM causes addresses to be meaningful between the host and all of the devices
            within a context and therefore supports the use of pointer based data structures in OpenCL
            kernels. It logically extends a portion of the global memory into the host address space therefore
            giving work-items access to the host address space. There are three types of SVM in OpenCL
            Coarse-Grained buffer SVM: Sharing occurs at the granularity of regions of OpenCL buffer
            memory objects. Fine-Grained buffer SVM: Sharing occurs at the granularity of individual
            loads/stores into bytes within OpenCL buffer memory objects. Fine-Grained system SVM:
            Sharing occurs at the granularity of individual loads/stores into bytes occurring anywhere within
            the host memory.
        </p>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p>
            <img src="pdficon_small1.gif" />

            <a href="https://www.khronos.org/registry/cl/specs/opencl-2.1.pdf#page=174" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2015 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.
</div>
    </div>
  </body>
</html>