Blame - docs/GettingStarted.html - fp2-dev/platform/external/llvm

2003-06-12 19:34:44 +0000

[diff] [blame]

3

<head>

4

<title>Getting Started with LLVM System</title>

</head>

<center><h1>Getting Started with the LLVM System By: <a

9

href="mailto:gshi1@uiuc.edu">Guochun Shi</a>,

John Criswell

cb27f1e

2003-07-01 21:55:57 +0000

[diff] [blame]

10

<a href="mailto:sabre@nondot.org">Chris Lattner</a>,

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

11

<a href="mailto:criswell@uiuc.edu">John Criswell</a>,

12

<a href="http://misha.brukman.net">Misha Brukman</a>, and

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

13

<a href="http://www.cs.uiuc.edu/~vadve">Vikram Adve</a>

14

</h1></center>

15

16

17

<h2><a name="Contents">Contents</a></h2>

18

19

20

<ul>

21

<li><a href="#overview">Overview</a>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

22

<ol>

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

23

<li><a href="#requirements">Requirements</a>

24

<ol>

25

<li><a href="#hardware">Hardware</a>

26

<li><a href="#software">Software</a>

27

</ol>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

28

</ol>

29

<li><a href="#starting">Getting started with LLVM</a>

30

<ol>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

31

<li><a href="#quickstart">Getting Started Quickly (A Summary)</a>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

32

<li><a href="#terminology">Terminology and Notation</tt></a>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

33

<li><a href="#environment">Setting Up Your Environment</a>

John Criswell

2003-07-07 19:27:35 +0000

[diff] [blame]

34

<li><a href="#unpack">Unpacking the LLVM Archives</a>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

35

<li><a href="#checkout">Checkout LLVM from CVS</a>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

36

<li><a href="#installcf">Install the C Front End</a>

37

<li><a href="#config">Local LLVM Configuration</tt></a>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

38

<li><a href="#compile">Compiling the LLVM Suite Source Code</a>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

39

<li><a href="#objfiles">The Location of LLVM Object Files</tt></a>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

40

</ol>

41

<li><a href="#layout">Program layout</a>

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

42

<ol>

43

<li><a href="#cvsdir"><tt>CVS</tt> directories</a>

44

<li><a href="#include"><tt>llvm/include</tt></a>

45

46

47

<li><a href="#tools"><tt>llvm/tools</tt></a>

48

<li><a href="#utils"><tt>llvm/utils</tt></a>

49

</ol>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

50

<li><a href="#cfront">Compiling the LLVM C Front End</a>

51

<li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>

52

<li><a href="#problems">Common Problems</a>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

53

<li><a href="#links">Links</a>

</ul>

58

59

<h2><a name="overview">Overview</a></h2>

60

</center>

61

62

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

63

Welcome to LLVM! In order to get started, you first need to know some

basic information.

First, LLVM comes in two pieces. The first piece is the LLVM suite. This

68

contains all of the tools, libraries, and header files needed to use the

69

low level virtual machine. It also contains a test suite that can be used

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

70

to test the LLVM tools and the C front end.

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

71

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

72

The second piece is the C front end. This component provides a version

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

73

of GCC that compiles C code into LLVM bytecode. Currently, the C front end

74

is a modified version of GCC 3.4 (we track the GCC 3.4 development).

75

Once compiled into LLVM bytecode, a program can be manipulated with the

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

76

LLVM tools from the LLVM suite.

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

77

78

79

<h3><a name="requirements">Requirements</a></h3>

80

81

82

Before you begin to use the LLVM system, review the requirements given

83

below. This may save you some trouble by knowing ahead of time what

84

hardware and software you will need.

85

86

87

<h4><a name="hardware">Hardware</a></h4>

88

89

LLVM is known to work on the following platforms:

90

<ul>

91

<li> Linux on x86

92

<ul>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

93

<li> Approximately 760 MB of Free Disk Space

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

94

<ul>

95

<li>Source code: 30 MB

96

<li>Object code: 670 MB

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

97

<li>C front end: 60 MB

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

98

</ul>

99

</ul>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

103

<li> Solaris on SparcV9 (Ultrasparc)

104

<ul>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

105

<li> Approximately 1.24 GB of Free Disk Space

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

106

<ul>

107

<li>Source code: 30 MB

108

<li>Object code: 1000 MB

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

109

<li>C front end: 210 MB

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

</ul>

</ul>

</ul>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

114

115

If you want to compile your own version of the C front end, you will need

116

additional disk space:

<ul>

<li>Linux on x86

<ul>

<li> Approximately 249 MB of Free Disk Space

123

<ul>

124

<li>Source code: 146 MB

125

<li>Object code: 82 MB

126

<li>Installed binaries: 21 MB

</ul>

</ul>

<li>Solaris on Sparc

<ul>

<li> Approximately 264 MB of Free Disk Space

135

<ul>

136

<li>Source code: 146 MB

137

<li>Object code: 93 MB

138

<li>Installed binaries: 25 MB

</ul>

</ul>

</ul>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

144

LLVM may compile on other platforms. The LLVM utilities should work

145

on other platforms, so it should be possible to generate and produce LLVM

146

bytecode on unsupported platforms (although bytecode generated on one

147

platform may not work on another platform). However, the code generators

Misha Brukman

c56e582

2003-07-03 16:29:36 +0000

[diff] [blame]

148

and Just-In-Time (JIT) compilers only generate SparcV9 or x86 machine code.

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

149

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

150

151

152

<h4><a name="software">Software</a></h4>

153

154

John Criswell

6dd90d2

2003-07-03 16:43:01 +0000

[diff] [blame]

155

156

Unpacking the distribution requires the following tools:

<dt>GNU Zip (gzip)

<dt>GNU Tar

<dd>

These tools are needed to uncompress and unarchive the software.

162

Regular Solaris <tt>tar</tt> may work for unpacking the TAR archive but

is untested.

</dl>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

166

Compiling LLVM requires that you have several different software packages

installed:

<dt> GCC

<dd>

The GNU Compiler Collection must be installed with C and C++ language

173

support. GCC 3.2.x works, and GCC 3.x is generally supported.

174

175

176

Note that we currently do not support any other C++ compiler.

<dt> GNU Make

<dd>

The LLVM build system relies upon GNU Make extensions. Therefore, you

182

will need GNU Make (sometimes known as gmake) to build LLVM.

<dt> Flex and Bison

<dd>

The LLVM source code is built using flex and bison. You will not be

188

able to configure and compile LLVM without them.

<dt> GNU M4

<dd>

If you are installing Bison on your machine for the first time, you

194

will need GNU M4 (version 1.4 or higher).

</dl>

There are some additional tools that you may want to have when working with

LLVM:

<ul>

<li>GNU Autoconf

<li>GNU M4

If you want to make changes to the configure scripts, you will need

207

GNU autoconf (2.53 or higher), and consequently, GNU M4 (version 1.4

or higher).

</ul>

The <a href="starting">next section</a> of this guide is meant to get

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

214

you up and running with LLVM and to give you some basic information about

215

the LLVM environment. The <a href"#quickstart">first subsection</a> gives

216

a short summary for those who are already familiar with the system and

217

want to get started as quickly as possible.

218

219

The later sections of this guide describe the <a

John Criswell

cb27f1e

2003-07-01 21:55:57 +0000

[diff] [blame]

220

href="#layout">general layout</a> of the the LLVM source-tree, a <a

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

221

href="#tutorial">simple example</a> using the LLVM tool chain, and <a

222

href="#links">links</a> to find more information about LLVM or to get

223

help via e-mail.

224

225

226

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

227

<h2><a name="starting">Getting Started with LLVM</a></h2>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

228

</center>

229

230

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

231

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

232

<h3><a name="quickstart">Getting Started Quickly (A Summary)</a></h3>

233

234

235

Here's the short story for getting up and running quickly with LLVM:

Chris Lattner

96768ea

2003-02-14 04:22:13 +0000

[diff] [blame]

236

<ol>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

237

<li>Install the C front end:

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

238

<ol>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

239

<li><tt>cd where-you-want-the-C-front-end-to-live</tt>

240

<li><tt>gunzip --stdout cfrontend.platform.tar.gz | tar -xvf

241

-</tt>

242

</ol>

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

243

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

244

245

246

<li>Get the Source Code

247

<ul>

248

<li>With the distributed files:

249

<ol>

250

<li><tt>cd where-you-want-llvm-to-live</tt>

251

<li><tt>gunzip --stdout llvm.tar.gz | tar -xvf -</tt>

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

252

<li><tt>gunzip --stdout cfrontend.platform.tar.gz | tar

253

-xvf -</tt>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

</ol>

<li>With anonymous CVS access:

260

<ol>

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

261

<li>Find the path to the CVS repository containing LLVM (we'll

262

call this CVSROOTDIR).

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

263

<li><tt>cd where-you-want-llvm-to-live</tt>

264

<li><tt>cvs -d CVSROOTDIR checkout llvm</tt>

</ol>

</ul>

</ul>

<li>Configure the LLVM Build Environment

273

<ol>

274

<li>Run <tt>configure</tt> to configure the Makefiles and header

275

files for the default platform.

276

Useful options include:

277

<ul>

278

<li><tt>--with-objroot=directory</tt>

279

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

280

Specify where object files should be placed during the

281

build.

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

282

283

<li><tt>--with-llvmgccdir=directory</tt>

284

285

Specify where the LLVM C frontend is going to be installed.

</ul>

</ol>

<li>Build the LLVM Suite

292

<ol>

293

<li>Set your LLVM_LIB_SEARCH_PATH environment variable.

294

<li><tt>gmake -k |& tee gnumake.out

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

295

# this is csh or tcsh syntax</tt>

296

</ol>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

297

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

298

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

299

Chris Lattner

96768ea

2003-02-14 04:22:13 +0000

[diff] [blame]

300

</ol>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

301

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

302

See <a href="#environment">Setting Up Your Environment</a> on tips to

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

303

simplify working with the LLVM front-end and compiled tools. See the

304

other sub-sections below for other useful details in working with LLVM,

305

or go straight to <a href="#layout">Program Layout</a> to learn about the

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

306

layout of the source code tree. For information on building the C front

307

end yourself, see <a href="#cfront">Compiling the LLVM C Front End</a> for

308

information.

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

309

310

311

<h3><a name="terminology">Terminology and Notation</a></h3>

312

313

314

Throughout this manual, the following names are used to denote paths

315

specific to the local system and working environment. These are not

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

316

environment variables you need to set but just strings used in the rest

317

of this document below. In any of the examples below, simply replace

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

318

each of these names with the appropriate pathname on your local system.

Chris Lattner

1db872d

2002-09-06 16:26:13 +0000

[diff] [blame]

319

All these paths are absolute:

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

<dt>CVSROOTDIR

<dd>

This is the path for the CVS repository containing the LLVM source

324

code. Ask the person responsible for your local LLVM installation to

give you this path.

<dt>OBJ_ROOT

<dd>

This is the top level directory for where the LLVM suite object files

331

will be placed during the build.

<dt>LLVMGCCDIR

<dd>

This is the pathname to the location where the LLVM C Front End will

John Criswell

6dd90d2

2003-07-03 16:43:01 +0000

[diff] [blame]

337

be installed. Note that the C front end does not need to be installed

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

338

during the LLVM suite build; you will just need to know where it will

339

go for configuring the build system and running the test suite later.

340

John Criswell

a27028b

2003-07-03 16:49:40 +0000

[diff] [blame]

341

For the pre-built C front end binaries, the LLVMGCCDIR is

342

<tt>cfrontend/platform/llvm-gcc</tt>.

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

<dt>GCCSRC

<dd>

This is the pathname of the directory where the LLVM C front end source

code can be found.

<dt>GCCOBJ

<dd>

This is the pathname of the directory where the LLVM C front end object

353

code will be placed during the build. It can be safely removed once

354

the build is complete.

355

</dl>

356

357

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

358

<h3><a name="environment">Setting Up Your Environment</a></h3>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

359

360

361

362

In order to compile and use LLVM, you will need to set some environment

363

variables. There are also some shell aliases which you may find useful.

364

You can set these on the command line, or better yet, set them in your

365

<tt>.cshrc</tt> or <tt>.profile</tt>.

366

367

368

<dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt>LLVMGCCDIR/llvm-gcc/bytecode-libs</tt>

369

<dd>

370

This environment variable helps the LLVM C front end find bytecode

371

libraries that it will need for compilation.

372

373

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

374

<dt>alias llvmgcc LLVMGCCDIR<tt>/bin/llvm-gcc</tt>

375

<dd>

376

This alias allows you to use the LLVM C front end without putting it in

377

your <tt>PATH</tt> or typing in its complete pathname.

378

</dl>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

379

380

John Criswell

2003-07-07 19:27:35 +0000

[diff] [blame]

381

<h3><a name="unpack">Unpacking the LLVM Archives</a></h3>

382

383

384

385

If you have the LLVM distribution, you will need to unpack it before you

386

can begin to compile it. LLVM is distributed as a set of four files. Each

387

file is a TAR archive that is compressed with the gzip program.

388

389

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

390

The four files are as follows:

John Criswell

2003-07-07 19:27:35 +0000

[diff] [blame]

391

392

<dt>llvm.tar.gz

393

<dd>This is the source code to the LLVM suite.

394

395

396

<dt>cfrontend.sparc.tar.gz

397

<dd>This is the binary release of the C front end for Solaris/Sparc.

398

399

400

<dt>cfrontend.x86.tar.gz

401

<dd>This is the binary release of the C front end for Linux/x86.

402

403

404

<dt>cfrontend-src.tar.gz

405

<dd>This is the source code release of the C front end.

</dl>

John Criswell

2003-07-07 19:27:35 +0000

[diff] [blame]

409

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

410

<h3><a name="checkout">Checkout LLVM from CVS</a></h3>

411

412

John Criswell

2003-07-07 19:27:35 +0000

[diff] [blame]

413

If you have access to our CVS repository, you can get a fresh copy of

414

the entire source code. All you need to do is check it out from CVS as

415

follows:

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

416

<ul>

417

<li><tt>cd where-you-want-llvm-to-live</tt>

418

<li><tt>cvs -d CVSROOTDIR checkout llvm</tt>

419

</ul>

420

421

This will create an '<tt>llvm</tt>' directory in the current

422

directory and fully populate it with the LLVM source code, Makefiles,

423

test directories, and local copies of documentation files.

424

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

425

426

Note that the C front end is not included in the CVS repository. You

427

should have either downloaded the source, or better yet, downloaded the

428

binary distribution for your platform.

429

430

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

431

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

432

<h3><a name="installcf">Install the C Front End</a></h3>

433

434

435

436

Before configuring and compiling the LLVM suite, it is best to extract the

437

LLVM C front end. While not used in building, the C front end is used by

438

the LLVM test suite, and its location must be given to the

439

<tt>configure</tt> script before the LLVM suite can be built.

To install the C front end, do the following:

444

<ol>

445

<li><tt>cd where-you-want-the-front-end-to-live</tt>

446

<li><tt>gunzip --stdout cfrontend.platform.tar.gz | tar -xvf

-</tt>

</ol>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

451

<h3><a name="config">Local LLVM Configuration</a></h3>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

452

453

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

454

Once checked out from the CVS repository, the LLVM suite source code

455

must be configured via the <tt>configure</tt> script. This script sets

456

variables in <tt>llvm/Makefile.config</tt> and

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

457

<tt>llvm/include/Config/config.h</tt>.

458

459

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

460

The following environment variables are used by the <tt>configure</tt>

461

script to configure the build system:

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

462

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

463

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

<tr>

<th>Variable</th>

<th>

Purpose

</th>

</tr>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

471

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

<tr>

<td>

Tells <tt>configure</tt> which C compiler to use. By default,

476

<tt>configure</tt> will look for the first GCC compiler in

477

<tt>PATH</tt>. Use this variable to override

478

<tt>configure</tt>'s default behavior.

</td>

</tr>

<tr>

<td>

Tells <tt>configure</tt> which C++ compiler to use. By default,

486

<tt>configure</tt> will look for the first GCC compiler in

487

<tt>PATH</tt>. Use this variable to override

488

<tt>configure</tt>'s default behavior.

</td>

</tr>

</table>

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

494

The following options can be used to set or enable LLVM specific options:

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

495

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

496

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

497

498

<dt>--with-objroot=OBJ_ROOT

499

<dd>

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

500

Path to the directory where

501

object files, libraries, and executables should be placed.

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

502

If this is set to <tt>.</tt>, then the object files will be placed

503

within the source code tree. If left unspecified, the default value is

John Criswell

ef0096f

2003-08-08 22:36:30 +0000

[diff] [blame]

the following:

<ul>

<li>

If the USER environment variable is specified and the directory

508

<tt>/localhome/$USER</tt> exists, then the default value is

509

<tt>/localhome/$USER</tt>.

510

511

<li>

512

Otherwise, the default value is <tt>.</tt>.

513

</ul>

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

514

(See the Section on <a href=#objfiles>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

515

The Location of LLVM Object Files</a>

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

516

for more information.)

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

517

518

<dt>--with-llvmgccdir=LLVMGCCDIR

519

<dd>

520

Path to the location where the LLVM C front end binaries and

521

associated libraries will be installed.

522

523

<dt>--enable-optimized

524

<dd>

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

525

Enables optimized compilation (debugging symbols are removed and GCC

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

526

optimization flags are enabled). The default is to use an unoptimized

527

build (also known as a debug build).

528

529

<dt>--enable-jit

530

<dd>

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

531

Compile the Just In Time (JIT) functionality. This is not available

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

532

on all platforms. The default is dependent on platform, so it is best

533

to explicitly enable it if you want it.

534

</dl>

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

535

536

In addition to running <tt>configure</tt>, you must set the

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

537

<tt>LLVM_LIB_SEARCH_PATH</tt> environment variable in your startup scripts.

538

This environment variable is used to locate "system" libraries like

539

"<tt>-lc</tt>" and "<tt>-lm</tt>" when linking. This variable should be set

540

to the absolute path for the bytecode-libs subdirectory of the C front-end

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

541

install, or LLVMGCCDIR/llvm-gcc/bytecode-libs. For example, one might

542

set <tt>LLVM_LIB_SEARCH_PATH</tt> to

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

543

<tt>/home/vadve/lattner/local/x86/llvm-gcc/bytecode-libs</tt> for the X86

544

version of the C front-end on our research machines.

545

546

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

547

<h3><a name="compile">Compiling the LLVM Suite Source Code</a></h3>

548

549

550

Once you have configured LLVM, you can build it. There are three types of

builds:

<dt>Debug Builds

<dd>

These builds are the default. They compile the tools and libraries

557

with debugging information.

558

559

560

<dt>Release (Optimized) Builds

561

<dd>

562

These builds are enabled with the <tt>--enable-optimized</tt> option to

563

<tt>configure</tt>. They compile the tools and libraries with GCC

564

optimizer flags on and strip debugging information from the libraries

565

and executables it generates.

<dt>Profile Builds

<dd>

These builds are for use with profiling. They compile profiling

571

information into the code for use with programs like <tt>gprof</tt>.

572

Profile builds must be started by setting variables on the

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

573

<tt>gmake</tt> command line.

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

574

</dl>

575

576

Once you have LLVM configured, you can build it by entering the top level

577

<tt>llvm</tt> directory and issuing the following command:

578

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

579

<tt>gmake</tt>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

580

581

582

If you have multiple processors in your machine, you may wish to use some

583

of the parallel build options provided by GNU Make. For example, you could

use the command:

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

588

<tt>gmake -j2</tt>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

589

590

591

There are several other targets which are useful when working with the LLVM

source code:

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

595

<dt><tt>gmake clean</tt>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

596

<dd>

597

Removes all files generated by the build. This includes object files,

598

generated C/C++ files, libraries, and executables.

599

600

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

601

<dt><tt>gmake distclean</tt>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

602

<dd>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

603

Removes everything that <tt>gmake clean</tt> does, but also removes

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

604

files generated by <tt>configure</tt>. It attempts to return the

605

source tree to the original state in which it was shipped.

</dl>

It is also possible to override default values from <tt>configure</tt> by

610

declaring variables on the command line. The following are some examples:

611

612

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

613

<dt><tt>gmake ENABLE_OPTIMIZED=1</tt>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

614

<dd>

615

Perform a Release (Optimized) build.

616

617

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

618

<dt><tt>gmake ENABLE_PROFILING=1</tt>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

619

<dd>

620

Perform a Profiling build.

621

622

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

623

<dt><tt>gmake VERBOSE=1</tt>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

624

<dd>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

625

Print what <tt>gmake</tt> is doing on standard output.

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

</dl>

Every directory in the LLVM source tree includes a <tt>Makefile</tt> to

630

build it and any subdirectories that it contains. Entering any directory

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

631

inside the LLVM source tree and typing <tt>gmake</tt> should rebuild

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

632

anything in or below that directory that is out of date.

633

634

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

635

<h3><a name="objfiles">The Location of LLVM Object Files</a></h3>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

636

637

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

638

The LLVM build system sends most output files generated during the build

639

into the directory defined by the variable OBJ_ROOT in

640

<tt>llvm/Makefile.config</tt>, which is set by the --with-objroot

641

option in <tt>configure</tt>. This can be either just your normal LLVM

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

642

source tree or some other directory writable by you. You may wish to put

643

object files on a different filesystem either to keep them from being backed

644

up or to speed up local builds.

645

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

646

647

If OBJ_ROOT is specified, then the build system will create a

648

directory tree underneath it that resembles the source code's pathname

John Criswell

ef0096f

2003-08-08 22:36:30 +0000

[diff] [blame]

649

relative to your home directory (unless OBJ_ROOT is set to

650

<tt>.</tt>, in which case object files are placed within the LLVM source

tree).

Note that

--with-objroot=<tt>.</tt>

657

and

658

--with-objroot=<tt>`pwd`</tt>

659

are not the same thing. The former will simply place object files within

660

the source tree, while the latter will set the location of object files

661

using the source tree's relative path from the home directory.

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

662

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

663

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

664

665

For example, suppose that OBJ_ROOT is set to <tt>/tmp</tt> and the

666

LLVM suite source code is located in <tt>/usr/home/joe/src/llvm</tt>, where

667

<tt>/usr/home/joe</tt> is the home directory of a user named Joe. Then,

668

the object files will be placed in <tt>/tmp/src/llvm</tt>.

669

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

670

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

671

672

The LLVM build will place files underneath OBJ_ROOT in directories

673

named after the build type:

674

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

675

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

<dt>Debug Builds

<dd>

<dt>Tools

<dd><tt>OBJ_ROOT/llvm/tools/Debug</tt>

682

<dt>Libraries

683

<dd><tt>OBJ_ROOT/llvm/lib/Debug</tt>

684

</dl>

685

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

686

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

<dt>Release Builds

<dd>

<dt>Tools

<dd><tt>OBJ_ROOT/llvm/tools/Release</tt>

692

<dt>Libraries

693

<dd><tt>OBJ_ROOT/llvm/lib/Release</tt>

694

</dl>

695

Chris Lattner

7fe7f81

2002-07-24 19:51:14 +0000

[diff] [blame]

696

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

<dt>Profile Builds

<dd>

<dt>Tools

<dd><tt>OBJ_ROOT/llvm/tools/Profile</tt>

702

<dt>Libraries

703

<dd><tt>OBJ_ROOT/llvm/lib/Profile</tt>

704

</dl>

705

</dl>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

706

707

708

709

<h2><a name="layout">Program Layout</a></h2>

710

</center>

711

712

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

713

One useful source of information about the LLVM source base is the LLVM <a

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

714

href="http://www.doxygen.org">doxygen</a> documentation, available at <tt><a

715

href="http://llvm.cs.uiuc.edu/doxygen/">http://llvm.cs.uiuc.edu/doxygen/</a></tt>. The

716

following is a brief introduction to code layout:

717

718

719

720

<h3><a name="cvsdir"><tt>CVS</tt> directories</a></h3>

721

722

723

Every directory checked out of CVS will contain a <tt>CVS</tt> directory;

724

for the most part these can just be ignored.

725

726

727

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

728

<h3><a name="include"><tt>llvm/include</tt></a></h3>

729

730

731

This directory contains public header files exported from the LLVM

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

732

library. The three main subdirectories of this directory are:

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

733

John Criswell

8df90e0

2003-06-11 20:46:40 +0000

[diff] [blame]

734

<ol>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

735

<li><tt>llvm/include/llvm</tt> - This directory contains all of the LLVM

736

specific header files. This directory also has subdirectories for

737

different portions of LLVM: <tt>Analysis</tt>, <tt>CodeGen</tt>,

738

<tt>Reoptimizer</tt>, <tt>Target</tt>, <tt>Transforms</tt>, etc...

739

740

<li><tt>llvm/include/Support</tt> - This directory contains generic

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

741

support libraries that are independent of LLVM, but are used by LLVM.

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

742

For example, some C++ STL utilities and a Command Line option processing

743

library.

744

745

<li><tt>llvm/include/Config</tt> - This directory contains header files

746

configured by the <tt>configure</tt> script. They wrap "standard" UNIX

747

and C header files. Source code can include these header files which

748

automatically take care of the conditional #includes that the configure

749

script generates.

Chris Lattner

7fe7f81

2002-07-24 19:51:14 +0000

[diff] [blame]

750

</ol>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

751

752

753

754

755

John Criswell

2003-06-30 21:59:07 +0000

[diff] [blame]

756

This directory contains most of the source files of the LLVM system. In

757

LLVM almost all

758

code exists in libraries, making it very easy to share code among the

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

759

different <a href="#tools">tools</a>.

760

761

762

<dt><tt>llvm/lib/VMCore/</tt><dd> This directory holds the core LLVM

763

source files that implement core classes like Instruction and BasicBlock.

764

765

<dt><tt>llvm/lib/AsmParser/</tt><dd> This directory holds the source code

766

for the LLVM assembly language parser library.

767

768

<dt><tt>llvm/lib/ByteCode/</tt><dd> This directory holds code for reading

769

and write LLVM bytecode.

770

771

<dt><tt>llvm/lib/CWriter/</tt><dd> This directory implements the LLVM to C

772

converter.

773

774

<dt><tt>llvm/lib/Analysis/</tt><dd> This directory contains a variety of

775

different program analyses, such as Dominator Information, Call Graphs,

776

Induction Variables, Interval Identification, Natural Loop Identification,

777

etc...

778

779

<dt><tt>llvm/lib/Transforms/</tt><dd> This directory contains the source

780

code for the LLVM to LLVM program transformations, such as Aggressive Dead

781

Code Elimination, Sparse Conditional Constant Propagation, Inlining, Loop

John Criswell

0c4dccc

2003-08-08 22:46:30 +0000

[diff] [blame]

782

Invarient Code Motion, Dead Global Elimination, and many others...

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

783

784

<dt><tt>llvm/lib/Target/</tt><dd> This directory contains files that

785

describe various target architectures for code generation. For example,

786

the llvm/lib/Target/Sparc directory holds the Sparc machine

787

description.

788

789

<dt><tt>llvm/lib/CodeGen/</tt><dd> This directory contains the major parts

790

of the code generator: Instruction Selector, Instruction Scheduling, and

791

Register Allocation.

792

793

<dt><tt>llvm/lib/Reoptimizer/</tt><dd> This directory holds code related

794

to the runtime reoptimizer framework that is currently under development.

795

796

<dt><tt>llvm/lib/Support/</tt><dd> This directory contains the source code

797

that corresponds to the header files located in

798

<tt>llvm/include/Support/</tt>.

799

</dl>

800

801

802

803

804

805

This directory contains regression tests and source code that is used to

806

test the LLVM infrastructure...

807

808

809

<h3><a name="tools"><tt>llvm/tools</tt></a></h3>

810

811

812

The tools directory contains the executables built out of the

813

libraries above, which form the main part of the user interface. You can

814

always get help for a tool by typing <tt>tool_name --help</tt>. The

815

following is a brief introduction to the most important tools.

816

817

Misha Brukman

2003-10-06 19:23:34 +0000

[diff] [blame^]

818

<dt>

819

820

<dt><tt>analyze</tt><dd> <tt>analyze</tt> is used to run a specific

821

analysis on an input LLVM bytecode file and print out the results. It is

822

primarily useful for debugging analyses, or familiarizing yourself with

823

what an analysis does.

824

825

<dt><tt>bugpoint</tt><dd> <tt>bugpoint</tt> is used to debug

826

optimization passes or code generation backends by narrowing down the

827

given test case to the minimum number of passes and/or instructions that

828

still cause a problem, whether it is a crash or miscompilation. See <a

829

href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information

830

on using <tt>bugpoint</tt>.

831

832

<dt><tt>llvm-ar</tt><dd>The archiver produces an archive containing

833

the given LLVM bytecode files, optionally with an index for faster

834

lookup.

835

Misha Brukman

2003-08-28 22:02:50 +0000

[diff] [blame]

836

<dt><tt>llvm-as</tt><dd>The assembler transforms the human readable

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

837

LLVM assembly to LLVM bytecode.

838

Misha Brukman

2003-08-28 22:02:50 +0000

[diff] [blame]

839

<dt><tt>llvm-dis</tt><dd>The disassembler transforms the LLVM

Misha Brukman

2003-10-06 19:23:34 +0000

[diff] [blame^]

840

bytecode to human readable LLVM assembly. Additionally, it can convert

Misha Brukman

2003-08-28 22:02:50 +0000

[diff] [blame]

841

LLVM bytecode to C, which is enabled with the <tt>-c</tt> option.

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

842

Misha Brukman

2003-10-06 19:23:34 +0000

[diff] [blame^]

843

<dt><tt>llvm-link</tt><dd> <tt>llvm-link</tt>, not surprisingly,

844

links multiple LLVM modules into a single program.

845

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

846

<dt><tt>lli</tt><dd> <tt>lli</tt> is the LLVM interpreter, which

847

can directly execute LLVM bytecode (although very slowly...). In addition

Misha Brukman

2003-10-06 19:23:34 +0000

[diff] [blame^]

848

to a simple interpreter, <tt>lli</tt> also has a tracing mode (entered by

849

specifying <tt>-trace</tt> on the command line). Finally, for

850

architectures that support it (currently only x86 and Sparc), by default,

851

<tt>lli</tt> will function as a Just-In-Time compiler (if the

852

functionality was compiled in), and will execute the code much

853

faster than the interpreter.

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

854

855

<dt><tt>llc</tt><dd> <tt>llc</tt> is the LLVM backend compiler,

Misha Brukman

c56e582

2003-07-03 16:29:36 +0000

[diff] [blame]

856

which translates LLVM bytecode to a SPARC or x86 assembly file.

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

857

Misha Brukman

2003-10-06 19:23:34 +0000

[diff] [blame^]

858

<dt><tt>llvmgcc</tt><dd> <tt>llvmgcc</tt> is a GCC-based C frontend

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

859

that has been retargeted to emit LLVM code as the machine code output. It

860

works just like any other GCC compiler, taking the typical <tt>-c, -S, -E,

861

-o</tt> options that are typically used. The source code for the

862

<tt>llvmgcc</tt> tool is currently not included in the LLVM cvs tree

863

because it is quite large and not very interesting.

864

865

<ol>

866

<dt><tt>gccas</tt><dd> This tool is invoked by the

867

<tt>llvmgcc</tt> frontend as the "assembler" part of the compiler. This

868

tool actually assembles LLVM assembly to LLVM bytecode,

Misha Brukman

2003-10-06 19:23:34 +0000

[diff] [blame^]

869

performs a variety of optimizations, and outputs LLVM bytecode. Thus

870

when you invoke <tt>llvmgcc -c x.c -o x.o</tt>, you are causing

871

<tt>gccas</tt> to be run, which writes the <tt>x.o</tt> file (which is

872

an LLVM bytecode file that can be disassembled or manipulated just like

873

any other bytecode file). The command line interface to <tt>gccas</tt>

874

is designed to be as close as possible to the system

875

`<tt>as</tt>' utility so that the gcc frontend itself did not have to be

876

modified to interface to a "weird" assembler.

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

877

878

<dt><tt>gccld</tt><dd> <tt>gccld</tt> links together several LLVM

879

bytecode files into one bytecode file and does some optimization. It is

880

the linker invoked by the gcc frontend when multiple .o files need to be

881

linked together. Like <tt>gccas</tt> the command line interface of

882

<tt>gccld</tt> is designed to match the system linker, to aid

883

interfacing with the GCC frontend.

884

</ol>

885

886

<dt><tt>opt</tt><dd> <tt>opt</tt> reads LLVM bytecode, applies a

887

series of LLVM to LLVM transformations (which are specified on the command

888

line), and then outputs the resultant bytecode. The '<tt>opt --help</tt>'

889

command is a good way to get a list of the program transformations

890

available in LLVM.

891

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

892

</dl>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

893

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

894

895

<h3><a name="utils"><tt>llvm/utils</tt></a></h3>

896

897

898

This directory contains utilities for working with LLVM sourcecode, and some

899

of the utilities are actually required as part of the build process because

900

they are code generators for parts of LLVM infrastructure.

901

902

Misha Brukman

2003-08-11 19:13:12 +0000

[diff] [blame]

903

<td><tt>Burg/</tt><dd> <tt>Burg</tt> is an instruction selector

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

904

generator -- it builds trees on which it then performs pattern-matching to

905

select instructions according to the patterns the user has specified. Burg

906

is currently used in the Sparc V9 backend.

907

908

<dt><tt>codegen-diff</tt><dd> <tt>codegen-diff</tt> is a script

909

that finds differences between code that LLC generates and code that LLI

910

generates. This is a useful tool if you are debugging one of them,

911

assuming that the other generates correct output. For the full user

912

manual, run <tt>`perldoc codegen-diff'</tt>.

913

914

<dt><tt>cvsupdate</tt><dd> <tt>cvsupdate</tt> is a script that will

915

update your CVS tree, but produce a much cleaner and more organized output

916

than simply running <tt>`cvs up -dP'</tt> will. For example, it will group

917

together all the new and updated files and modified files in separate

918

sections, so you can see at a glance what has changed. If you are at the

919

top of your LLVM CVS tree, running <tt>utils/cvsupdate</tt> is the

920

preferred way of updating the tree.

921

Misha Brukman

2003-08-11 19:13:12 +0000

[diff] [blame]

922

<dt><tt>emacs/</tt><dd> The <tt>emacs</tt> directory contains

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

923

syntax-highlighting files which will work with Emacs and XEmacs editors,

924

providing syntax highlighting support for LLVM assembly files and TableGen

Misha Brukman

2003-08-11 19:13:12 +0000

[diff] [blame]

925

description files. For information on how to use the syntax files, consult

926

the <tt>README</tt> file in that directory.

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

927

928

<dt><tt>getsrcs.sh</tt><dd> The <tt>getsrcs.sh</tt> script finds

929

and outputs all non-generated source files, which is useful if one wishes

930

to do a lot of development across directories and does not want to

931

individually find each file. One way to use it is to run, for example:

932

<tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source

933

tree.

934

935

<dt><tt>makellvm</tt><dd> The <tt>makellvm</tt> script compiles all

936

files in the current directory and then compiles and links the tool that

937

is the first argument. For example, assuming you are in the directory

938

<tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,

939

simply running <tt>makellvm llc</tt> will make a build of the current

940

directory, switch to directory <tt>llvm/tools/llc</tt> and build it,

941

causing a re-linking of LLC.

942

943

<dt><tt>NightlyTest.pl</tt> and

944

<tt>NightlyTestTemplate.html</tt><dd> These files are used in a

945

cron script to generate nightly status reports of the functionality of

946

tools, and the results can be seen by following the appropriate link on

947

the <a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a>.

948

Misha Brukman

2003-08-11 19:13:12 +0000

[diff] [blame]

949

<dt><tt>TableGen/</tt><dd> The <tt>TableGen</tt> directory contains

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

950

the tool used to generate register descriptions, instruction set

Chris Lattner

a8f5de3

2003-08-11 18:53:14 +0000

[diff] [blame]

951

descriptions, and even assemblers from common TableGen description

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

952

files.

953

Misha Brukman

2003-08-11 19:13:12 +0000

[diff] [blame]

954

<dt><tt>vim/</tt><dd> The <tt>vim</tt> directory contains

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

955

syntax-highlighting files which will work with the VIM editor, providing

956

syntax highlighting support for LLVM assembly files and TableGen

Misha Brukman

2003-08-11 19:13:12 +0000

[diff] [blame]

957

description files. For information on how to use the syntax files, consult

958

the <tt>README</tt> file in that directory.

Misha Brukman

2003-08-11 18:45:46 +0000

[diff] [blame]

</dl>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

962

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

963

<h2><center><a name="cfront">Compiling the LLVM C Front End</center></h2>

964

John Criswell

2003-08-08 22:46:30 +0000

[diff] [blame]

968

This step is optional if you have the C front end binary distribution for

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

your platform.

Now that you have the LLVM suite built, you can build the C front end. For

974

those of you that have built GCC before, the process is very similar.

975

976

Be forewarned, though: the build system for the C front end is not as

977

polished as the rest of the LLVM code, so there will be many warnings and

978

errors that you will need to ignore for now:

979

980

<ol>

981

<li>Ensure that <tt>OBJ_ROOT/llvm/tools/Debug</tt> is at the

982

end of your <tt>PATH</tt> environment variable. The front end

983

build needs to know where to find the LLVM tools, but you want to

984

ensure that these tools are not found before the system assembler and

985

linker that you normally use for compilation.

986

987

<li><tt>cd GCCOBJ</tt>

988

989

<li>Configure the source code:

990

<ul>

991

<li>On Linux/x86, use

992

<ul>

993

<li><tt>GCCSRC/configure --prefix=LLVMGCCDIR

994

--enable-languages=c</tt>

995

</ul>

996

997

<li>On Solaris/Sparc, use

998

<ul>

999

<li><tt>GCCSRC/configure --prefix=LLVMGCCDIR

1000

--enable-languages=c --target=sparcv9-sun-solaris2</tt>

</ul>

</ul>

<li><tt>gmake</tt>

<li>The build will eventually fail. Don't worry; chances are good that

1007

everything that needed to build is built.

1008

1009

<li><tt>gmake -k install</tt>

</ol>

Once this is done, you should have a built front end compiler in

<tt>LLVMGCCDIR</tt>.

1018

<h2>

1019

<center><a name="tutorial">An Example Using the LLVM Tool Chain</center>

1020

</h2>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

1021

1022

1023

<ol>

1024

<li>First, create a simple C file, name it 'hello.c':

<pre>

#include <stdio.h>

int main() {

printf("hello world\n");

return 0;

}

</pre>

<li>Next, compile the C file into a LLVM bytecode file:

1034

1035

<tt>% llvmgcc hello.c -o hello</tt>

1036

1037

This will create two result files: <tt>hello</tt> and

1038

<tt>hello.bc</tt>. The <tt>hello.bc</tt> is the LLVM bytecode that

1039

corresponds the the compiled program and the library facilities that it

1040

required. <tt>hello</tt> is a simple shell script that runs the bytecode

1041

file with <tt>lli</tt>, making the result directly executable.

1042

1043

<li>Run the program. To make sure the program ran, execute one of the

1044

following commands:

John Criswell

8df90e0

2003-06-11 20:46:40 +0000

[diff] [blame]

1045

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

<tt>% ./hello</tt>

or

<tt>% lli hello.bc</tt>

1051

Misha Brukman

2003-08-28 22:02:50 +0000

[diff] [blame]

1052

<li>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

1053

code:

1054

Misha Brukman

2003-08-28 22:02:50 +0000

[diff] [blame]

1055

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

1056

1057

<li>Compile the program to native Sparc assembly using the code

Misha Brukman

c56e582

2003-07-03 16:29:36 +0000

[diff] [blame]

1058

generator (assuming you are currently on a Sparc system):

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

1059

1060

<tt>% llc hello.bc -o hello.s</tt>

1061

1062

<li>Assemble the native sparc assemble file into a program:

1063

1064

<tt>% /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.sparc</tt>

1065

1066

<li>Execute the native sparc program:

1067

1068

<tt>% ./hello.sparc</tt>

</ol>

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

1074

<h2>

1075

<center><a name="problems">Common Problems</a></center>

1076

</h2>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

1077

1078

1079

Below are common problems and their remedies:

1080

1081

1082

<dt>When I run configure, it finds the wrong C compiler.

1083

<dd>

1084

The <tt>configure</tt> script attempts to locate first <tt>gcc</tt> and

1085

then <tt>cc</tt>, unless it finds compiler paths set in <tt>CC</tt> and

1086

<tt>CXX</tt> for the C and C++ compiler, respectively.

1087

1088

If <tt>configure</tt> finds the wrong compiler, either adjust your

1089

<tt>PATH</tt> environment variable or set <tt>CC</tt> and <tt>CXX</tt>

explicitly.

<dt>I compile the code, and I get some error about /localhome.

1094

<dd>

1095

There are several possible causes for this. The first is that you

1096

didn't set a pathname properly when using <tt>configure</tt>, and it

1097

defaulted to a pathname that we use on our research machines.

1098

1099

Another possibility is that we hardcoded a path in our Makefiles. If

1100

you see this, please email the LLVM bug mailing list with the name of

1101

the offending Makefile and a description of what is wrong with it.

1102

1103

<dt>The <tt>configure</tt> script finds the right C compiler, but it

1104

uses the LLVM linker from a previous build. What do I do?

1105

<dd>

1106

The <tt>configure</tt> script uses the <tt>PATH</tt> to find

1107

executables, so if it's grabbing the wrong linker/assembler/etc, there

1108

are two ways to fix it:

1109

<ol>

1110

<li>Adjust your <tt>PATH</tt> environment variable so that the

1111

correct program appears first in the <tt>PATH</tt>. This may work,

1112

but may not be convenient when you want them first in your

path for other work.

<li>Run <tt>configure</tt> with an alternative <tt>PATH</tt> that

1117

is correct. In a Borne compatible shell, the syntax would be:

1118

1119

<tt>PATH=<the path without the bad program> ./configure ...</tt>

1120

1121

This is still somewhat inconvenient, but it allows

1122

<tt>configure</tt> to do its work without having to adjust your

1123

<tt>PATH</tt> permanently.

1124

</ol>

John Criswell

3c852b6

2003-08-08 22:43:39 +0000

[diff] [blame]

1125

1126

<dt>I've upgraded to a new version of LLVM, and I get strange build

1127

errors.

1128

<dd>

1129

Sometimes changes to the LLVM source code alters how the build system

1130

works. Changes in libtool, autoconf, or header file dependencies are

1131

especially prone to this sort of problem.

1132

1133

The best thing to try is to remove the old files and re-build. In most

1134

cases, this takes care of the problem. To do this, just type <tt>make

1135

clean</tt> and then <tt>make</tt> in the directory that fails to build.

1136

1137

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

1138

</dl>

1139

1140

John Criswell

2003-07-08 20:35:59 +0000

[diff] [blame]

1141

<h2><center><a name="links">Links</a></center></h2>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

1142

1143

1144

This document is just an introduction to how to use LLVM to do

1145

some simple things... there are many more interesting and complicated things

1146

that you can do that aren't documented here (but we'll gladly accept a patch

1147

if you want to write something up!). For more information about LLVM, check

out:

<ul>

<li><a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a></li>

1152

<li><a href="http://llvm.cs.uiuc.edu/doxygen/">LLVM doxygen tree</a></li>

John Criswell

2003-07-03 16:01:38 +0000

[diff] [blame]

1153

<li><a href="http://llvm.cs.uiuc.edu/docs/Projects.html">Starting a Project that Uses LLVM</a></li>

John Criswell

2003-06-12 19:34:44 +0000

[diff] [blame]

</ul>

<hr>

If you have any questions or run into any snags (or you have any

1159

additions...), please send an email to

1160

<a href="mailto:sabre@nondot.org">Chris Lattner</a>.

1161

1162

1163

Chris Lattner

a8f5de3

2003-08-11 18:53:14 +0000

[diff] [blame]

1164

Last modified: Mon Aug 11 13:52:22 CDT 2003

John Criswell