1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">
<meta name="generator" content="Hugo 0.17" />
<title>Nine Nines: NIFs and port drivers</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
<link href="/css/99s.css?r=1" rel="stylesheet">
<link rel="shortcut icon" href="/img/ico/favicon.ico">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
<link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">
</head>
<body class="">
<header id="page-head">
<div id="topbar" class="container">
<div class="row">
<div class="span2">
<h1 id="logo"><a href="/" title="99s">99s</a></h1>
</div>
<div class="span10">
<div id="side-header">
<nav>
<ul>
<li><a title="Hear my thoughts" href="/articles">Articles</a></li>
<li><a title="Watch my talks" href="/talks">Talks</a></li>
<li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
<li><a title="Request my services" href="/services">Consulting & Training</a></li>
</ul>
</nav>
<ul id="social">
<li>
<a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
</li>
<li>
<a title="Keep in touch!" href="http://twitter.com/lhoguin"><img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png"></a>
</li>
<li>
<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
</li>
</ul>
</div>
</div>
</div>
</div>
</header>
<div id="contents" class="two_col">
<div class="container">
<div class="row">
<div id="docs" class="span9 maincol">
<h1 class="lined-header"><span>NIFs and port drivers</span></h1>
<div class="paragraph"><p>Erlang.mk can not only build Erlang projects, but also the C code
that some projects come with, like NIFs and port drivers.</p></div>
<div class="paragraph"><p>There are two ways to build the C code: using a custom Makefile,
or making Erlang.mk do it directly. The C code will be built
as needed when you run <code>make</code>.</p></div>
<div class="sect1">
<h2 id="_c_source_code_location_and_erlang_environment">C source code location and Erlang environment</h2>
<div class="sectionbody">
<div class="paragraph"><p>The C source code should be located in the <em>$(C_SRC_DIR)</em> directory.
It defaults to <em>c_src/</em>. Should you need to modify it, all you
need to do is to set the variable in your Makefile before including
Erlang.mk:</p></div>
<div class="listingblock">
<div class="content"></div></div>
<div class="paragraph"><p>When this directory exists, Erlang.mk will automatically create a
file named <em>$(C_SRC_ENV)</em>. This file defaults to <em>$(C_SRC_DIR)/env.mk</em>.
This can also be changed:</p></div>
<div class="listingblock">
<div class="content"></div></div>
<div class="paragraph"><p>It contains a few variable definitions for the environment used for the build:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>ERTS_INCLUDE_DIR</code>
</dt>
<dd>
<p>
Path to the ERTS include files (<em>erl_driver.h</em>, <em>erl_nif.h</em> and more).
</p>
</dd>
<dt class="hdlist1">
<code>ERL_INTERFACE_INCLUDE_DIR</code>
</dt>
<dd>
<p>
Path to the Erl_Interface include files (<em>ei.h</em> and related).
</p>
</dd>
<dt class="hdlist1">
<code>ERL_INTERFACE_LIB_DIR</code>
</dt>
<dd>
<p>
Path to the Erl_Interface static libraries.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_using_a_custom_makefile">Using a custom Makefile</h2>
<div class="sectionbody">
<div class="paragraph"><p>Erlang.mk will automatically run <code>make</code> if it detects a Makefile
in <em>$(C_SRC_DIR)/Makefile</em>.</p></div>
<div class="paragraph"><p>The Makefile should have at least two targets: a default target
(which can be anything, for example <code>all</code>) which is invoked when
building the C code, and a <code>clean</code> target invoked when cleaning
it.</p></div>
<div class="paragraph"><p>You can include the <em>env.mk</em> file to benefit from the Erlang
environment detection:</p></div>
<div class="listingblock">
<div class="content"></div></div>
</div>
</div>
<div class="sect1">
<h2 id="_using_erlang_mk_directly">Using Erlang.mk directly</h2>
<div class="sectionbody">
<div class="paragraph"><p>You don’t need to write a Makefile to build C source code, however.
Erlang.mk comes with rules to build both shared libraries and
executables, using the source files it finds in <em>$(C_SRC_DIR)</em>.</p></div>
<div class="paragraph"><p>By default, Erlang.mk will create a shared library. To change
this and create an executable instead, put this in your Makefile
before including Erlang.mk:</p></div>
<div class="listingblock">
<div class="content"></div></div>
<div class="paragraph"><p>The generated file name varies depending on the type of project
you have (shared library or executable) and on the platform you
build the project on.</p></div>
<div class="paragraph"><p>For shared libraries, the generated file name will be
<em>$(C_SRC_OUTPUT)$(C_SRC_SHARED_EXTENSION)</em>, with the default
being <em>$(CURDIR)/priv/$(PROJECT)</em> followed by the extension:
<code>.dll</code> on Windows, <code>.so</code> everywhere else.</p></div>
<div class="paragraph"><p>For executables, the generated file name is
<em>$(C_SRC_OUTPUT)$(C_SRC_EXECUTABLE_EXTENSION)</em>, with the same
default except for the extension: <code>.exe</code> on Windows, and otherwise
nothing.</p></div>
<div class="paragraph"><p>Erlang.mk sets appropriate compile and linker flags by default.
These flags vary depending on the platform, and can of course
be overriden.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>CC</code>
</dt>
<dd>
<p>
The compiler to be used.
</p>
</dd>
<dt class="hdlist1">
<code>CFLAGS</code>
</dt>
<dd>
<p>
C compiler flags.
</p>
</dd>
<dt class="hdlist1">
<code>CXXFLAGS</code>
</dt>
<dd>
<p>
C++ compiler flags.
</p>
</dd>
<dt class="hdlist1">
<code>LDFLAGS</code>
</dt>
<dd>
<p>
Linker flags.
</p>
</dd>
<dt class="hdlist1">
<code>LDLIBS</code>
</dt>
<dd>
<p>
Libraries to link against.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>The source files are automatically gathered from the contents
of <em>$(C_SRC_DIR)</em>. Erlang.mk looks for <em>.c</em>, <em>.C</em>, <em>.cc</em> and <em>.cpp</em>
source files. You can define the variable <code>SOURCES</code> to manually
list the files to compile.</p></div>
</div>
</div>
<nav style="margin:1em 0">
<a style="float:left" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/deps/">
Packages and dependencies
</a>
<a style="float:right" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/releases/">
Releases
</a>
</nav>
</div>
<div class="span3 sidecol">
<h3>
Erlang.mk
1
User Guide
</h3>
<ul>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/erlang.mk/1/guide">1</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="span6">
<p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
<nav>
<ul>
<li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
</ul>
</nav>
</div>
<div class="span6 credits">
<p><img src="/img/footer_logo.png"></p>
<p>Copyright © Loïc Hoguin 2012-2016</p>
</div>
</div>
</div>
</footer>
<script src="/js/custom.js"></script>
</body>
</html>
|
