blob: 621d0d9ea9952d7940ab968e42e777d77b369398 [file] [log] [blame]
Jim Cownie5e8470a2013-09-27 10:38:44 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<!-- Material used from: HTML 4.01 specs: http://www.w3.org/TR/html401/ -->
4<html>
5<head>
6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7 <title>OpenMP* : Support for the OpenMP language</title>
8 <link type="text/css" rel="stylesheet" href="menu.css">
9 <link type="text/css" rel="stylesheet" href="content.css">
10</head>
11
12<body>
13<div id="menu">
14 <div>
15 <a href="http://llvm.org/">LLVM Home</a>
16 </div>
17
18 <div class="submenu">
19 <label>OpenMP Info</label>
20 <a href="/index.html">About</a>
21 </div>
22
23 <div class="submenu">
24 <label>Quick Links</label>
25 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/openmp-dev">openmp-dev</a>
Andrey Churbanovcfda4512013-10-03 07:27:25 +000026 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/openmp-commits">openmp-commits</a>
Jim Cownie5e8470a2013-09-27 10:38:44 +000027 <a href="http://llvm.org/bugs/">Bug Reports</a>
28 <a href="http://llvm.org/svn/llvm-project/openmp/trunk/">Browse SVN</a>
29 <a href="http://llvm.org/viewvc/llvm-project/openmp/trunk/">Browse ViewVC</a>
30 </div>
31</div>
32
33<div id="content">
34 <!--*********************************************************************-->
35 <h1>"OpenMP*" Support for the OpenMP language</h1>
36 <!--*********************************************************************-->
37
38 <p>The OpenMP subproject of LLVM is intended to contain all of the
39 components required to build an executing OpenMP program that are
40 outside the compiler itself. Support for OpenMP 3.1 in Clang is in the
41 process of being promoted into the Clang mainline, and can be
42 found at <a href="http://clang-omp.github.io/">OpenMP/Clang</a>.
43 </p>
44
45 <p>Here you can find the code for the runtime library against which
46 code compiled by the OpenMP/Clang compiler must be linked before it
47 can run.
48 </p>
49
50 <p>We are, however, still missing test code. Any contributions in
51 that area would be greatly appreciated!
52 </p>
53
54 <p>All of the code here is <a
55 href="http://llvm.org/docs/DeveloperPolicy.html#license">dual licensed</a>
56 under the MIT license and the UIUC License (a BSD-like license).
57 The LICENSE.txt file at the top of the OpenMP project contains
58 the license text and associated patent grants.
59 </p>
60
61 <!--=====================================================================-->
62 <h2 id="goals">Features and Goals</h2>
63 <!--=====================================================================-->
64
65 <ul>
66 <li>Correctness as defined by the
67 <a href="http://www.openmp.org/mp-documents/OpenMP3.1.pdf">OpenMP
68 3.1 standard (PDF)</a> </li>
69 <li>High performance.</li>
70 <li>ABI compatibility Intel's existing OpenMP compiler.</li>
71 </ul>
72
73 <!--=====================================================================-->
74 <h2 id="why">Why have the runtime code here?</h2>
75 <!--=====================================================================-->
76
77 <p>It makes sense to have the runtime sources in the same place
78 (and with the same license) as the compiler.
79 </p>
80
81 <!--=====================================================================-->
82 <h2 id="requirements">Platform Support</h2>
83 <!--=====================================================================-->
84
85 <p>The OpenMP runtime is known to work on 32 and 64 bit X86
86 processors when compiled with either the Intel compiler or gcc, and also the Intel&reg;&nbsp;Xeon Phi&trade; product family, when compiled with
87 the Intel compiler.
88 </p>
89
90 <p>A full OS compatibility matrix is in a
91 <a href="runtime/README.txt">runtime/README.txt</a>
92 </p>
93
94
95 <!--=====================================================================-->
96 <h2 id="dir-structure">Current Status</h2>
97 <!--=====================================================================-->
98
99 <p>Currently the runtime is built with either gcc or icc. Obviously
100 it would be good also to build with Clang. If anyone wants to
101 submit patches to do that (or replace the complicated historical
102 build system with CMake) that'd be great!
103 </p>
104
105
106 <!--=====================================================================-->
107 <h2>Get it and get involved!</h2>
108 <!--=====================================================================-->
109
110 <p>First please review our
111 <a href="http://llvm.org/docs/DeveloperPolicy.html">Developer's Policy</a>.
112
113 <p>To check out the code, use:</p>
114
115 <ul>
116 <li><code>svn co http://llvm.org/svn/llvm-project/openmp/trunk openmp</code></li>
117 </ul>
118
119 <p>
120 Next:
121 </p>
122
123 <ul>
124 <li><code>cd openmp/runtime</code></li>
125 <li><code>make compiler=gcc</code></li>
126 </ul>
127
128 <p>Full details of how to build are in the
129 <a href="runtime/README.txt">runtime/README.txt</a>
130 </p>
131
132 <!--=====================================================================-->
133 <h3>Notes</h3>
134 <!--=====================================================================-->
135
136<p>
137
138</p>
139
140 <p>Send discussions to the
141 (<a href="http://lists.cs.uiuc.edu/mailman/listinfo/openmp-dev">OpenMP mailing list</a>).</p>
142
143
144 <!--=====================================================================-->
145 <h2>Design Documents</h2>
146 <!--=====================================================================-->
147
148<ul>
149<li><a href="runtime/doc/Reference.pdf">Runtime design (PDF)</a></li>
150</ul>
151
152</div>
153</body>
154</html>