build.xml 36.1 KB
Newer Older
1 2 3 4 5
<project
	name="disl" default="build" basedir="."
	xmlns:ivy="antlib:org.apache.ivy.ant"
	xmlns:ac="antlib:net.sf.ant-contrib"
>
Lukáš Marek's avatar
Lukáš Marek committed
6

7
	<property name="build.sysclasspath" value="ignore"/>
8

9
	<property file="disl.version.properties"/>
10

11 12
	<property file="dependencies.local.properties"/>
	<property file="dependencies.properties"/>
13

14 15
	<property file="build.local.properties"/>
	<property file="build.properties"/>
Lukáš Marek's avatar
Lukáš Marek committed
16

17 18
	<property file="common.properties" />

19

20 21 22 23
	<!-- ================================================================== -->
	<!-- IVY SETUP & TASKS                                                  -->
	<!-- ================================================================== -->

24
	<!--
25
		Downloads the Ivy dependency manager from the Maven central repository.
26
	-->
27
	<available file="${build.ivy.path}" property="build.ivy.downloaded"/>
28
	<target name="-download-ivy" unless="build.ivy.downloaded">
29
		<mkdir dir="${lib.ant.dir}"/>
30 31
		<get src="${build.ivy.url}" dest="${build.ivy.path}" usetimestamp="true"/>
	</target>
32 33 34


	<!--
35
		Registers Ivy tasks within Ant.
36
	-->
37
	<target name="-setup-ivy" depends="-download-ivy">
38
		<taskdef resource="org/apache/ivy/ant/antlib.xml" uri="antlib:org.apache.ivy.ant" classpath="${build.ivy.path}"/>
39
	</target>
40

41

42 43 44 45 46 47
	<!--
		Downloads dependencies for compilation. This target should allow
		unconditional execution so that the download can be always forced.
	-->
	<target name="download-deps" depends="-setup-ivy" description="Downloads dependencies for compilation.">
		<ivy:resolve conf="ant,disl,test" file="${build.ivy.file}"/>
48
		<ivy:retrieve pattern="${lib.dir}/[conf]/[artifact].[ext]"/>
49
	</target>
František Haas's avatar
František Haas committed
50

51

52 53 54 55 56 57 58
	<!--
		Downloads dependency sources (for IDE integration).
	-->
	<target name="download-sources" depends="download-deps" description="Downloads dependency sources (for IDE integration).">
		<ivy:resolve conf="devel" file="${build.ivy.file}"/>
		<ivy:retrieve type="source" pattern="${lib.dir}/[conf]/[artifact]-[type].[ext]"/>
	</target>
59 60


61 62 63
	<!-- ================================================================== -->
	<!-- ARTIFACT LIST                                                      -->
	<!-- ================================================================== -->
64

65
	<!--
66
		Downloads dependencies and stores the list of retrieved artifacts
67
		so that their presence can be checked in subsequent invocations
68
		without Ivy. This target should allow unconditional execution so
69 70 71 72
		that the update of the artifact list can be always forced.
	-->
	<target name="update-artifact-list" depends="download-deps" description="Updates the list of expected dependency artifacts.">
		<collect-artifacts id="build.artifacts"/>
73

74 75 76 77 78 79
		<local name="artifacts.text"/>
		<path-to-text
			property="artifacts.text" refid="build.artifacts"
			mapfrom="${basedir}${file.separator}${lib.dir}"
			mapto="${lib.dir}"
		/>
80

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
		<echo file="${build.artifacts.list}">${artifacts.text}</echo>
	</target>


	<!--
		Determines whether the artifact list is up-to-date and sets the value
		of the 'build.artifacts.list.uptodate' property accordingly. The list
		is considered up-to-date if it contains at least one non-empty line
		and is newer than both the files describing the dependency properties.
	-->
	<target name="-check-artifact-list">
		<condition property="build.artifacts.list.uptodate"><and>
			<resourcecount when="greater" count="0">
				<tokens><concat>
					<filterchain>
						<tokenfilter><ignoreblank/></tokenfilter>
					</filterchain>
					<file file="${build.artifacts.list}"/>
				</concat></tokens>
			</resourcecount>

			<uptodate targetfile="${build.artifacts.list}">
103
				<srcfiles dir="${basedir}" includes="dependencies*.properties"/>
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
			</uptodate>
		</and></condition>
	</target>


	<!--
		Creates artifact list if it is missing or not up-to-date. This will
		trigger an initial download of artifacts so that the list is build
		from the downloaded artifacts.
	-->
	<target name="-create-artifact-list" depends="-check-artifact-list" unless="build.artifacts.list.uptodate">
		<antcall target="update-artifact-list"/>
	</target>


	<!--
		Collects downloaded artifacts into a fileset.
	-->
	<macrodef name="collect-artifacts">
		<attribute name="id"/>
		<sequential>
			<fileset dir="${basedir}" id="@{id}">
				<include name="${lib.ant.dir}/*.jar"/>
				<include name="${lib.disl.dir}/*.jar"/>
				<include name="${lib.test.dir}/*.jar"/>
			</fileset>
		</sequential>
	</macrodef>


	<!--
		Converts a path-like entity to text, one entry per line.
		Optionally performs mapping from one path prefix to another.
	-->
	<macrodef name="path-to-text">
		<attribute name="property"/>
		<attribute name="refid"/>
		<attribute name="mapfrom" default=""/>
		<attribute name="mapto" default=""/>
		<sequential>
			<pathconvert pathsep="${line.separator}" property="@{property}" refid="@{refid}">
				<map from="@{mapfrom}" to="@{mapto}"/>
			</pathconvert>
		</sequential>
	</macrodef>


	<!-- ================================================================== -->
	<!-- DEPENDENCY CHECKS                                                  -->
	<!-- ================================================================== -->

	<!--
		Determines if any of the expected artifacts are missing and sets
		the value of the 'build.artifacts.missing' property accordingly.
158
		This may trigger creating the list of expected artifacts after an
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
		initial download of dependencies.
	-->
	<target name="-check-artifacts" depends="-create-artifact-list">
		<find-missing-files file="${build.artifacts.list}" id="build.artifacts.missing.list"/>

		<condition property="build.artifacts.missing">
			<not><resourcecount refid="build.artifacts.missing.list" count="0"/></not>
		</condition>
	</target>


	<!--
		Download dependency artifacts if they are missing.
	-->
	<target name="-download-artifacts" depends="-check-artifacts" if="build.artifacts.missing">
174
		<antcall target="download-deps"/>
175 176 177 178 179 180 181 182 183 184 185 186 187 188
	</target>


	<!--
		Checks that none of the required artifacts are missing. This may
		trigger an initial download of dependency artifacts, but generally
		they will checked against a list of expected artifacts. If any of
		the artifacts are missing at this point, the build will fail.
	-->
	<target name="-check-deps" depends="-download-artifacts">
		<find-missing-files file="${build.artifacts.list}" id="build.artifacts.really.missing.list"/>

		<!-- Sanitize the path names of potentially missing artifacts. -->
		<local name="missing.text"/>
189
		<path-to-text
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
			property="missing.text" refid="build.artifacts.really.missing.list"
			mapfrom="${basedir}${file.separator}${lib.dir}"
			mapto="${lib.dir}"
		/>

		<!-- Fail if there are any missing artifacts. -->
		<fail message="missing artifacts${line.separator}${missing.text}${line.separator}Try running 'ant download-deps' to re-download dependencies.">
			<condition>
				<not><resourcecount refid="build.artifacts.really.missing.list" count="0"/></not>
			</condition>
		</fail>
	</target>


	<!--
		Loads a list of files and selects those that are missing.
	-->
	<macrodef name="find-missing-files">
		<attribute name="file"/>
		<attribute name="id"/>
		<sequential>
			<restrict id="@{id}">
				<resourcelist>
					<file file="@{file}"/>
				</resourcelist>
				<not><exists/></not>
			</restrict>
		</sequential>
	</macrodef>


	<!-- ================================================================== -->
	<!-- INITIALIZATION                                                     -->
	<!-- ================================================================== -->

	<!--
		Setup Ant extensions and define class paths involving both the
		downloaded artifacts and project classes.
	-->
	<target name="-init" depends="-check-deps">
		<path id="build.ant.classpath">
231
			<fileset dir="${lib.ant.dir}" includes="*.jar"/>
232 233
		</path>

234
		<taskdef resource="net/sf/antcontrib/antlib.xml" uri="antlib:net.sf.ant-contrib" classpathref="build.ant.classpath"/>
235 236 237

		<!-- Dependency class paths -->
		<path id="asm.classpath">
238
			<fileset dir="${lib.disl.dir}" includes="asm*.jar" id="asm.fileset"/>
239 240 241
		</path>

		<!-- Get ASM libs from ASM class path. -->
242
		<pathconvert pathsep=" " property="asm.libs" refid="asm.classpath">
243 244 245 246
			<mapper type="flatten"/>
		</pathconvert>

		<path id="log4j.classpath">
247
			<fileset dir="${lib.disl.dir}" includes="log4j*.jar"/>
248 249 250
		</path>

		<path id="junit.classpath">
251
			<fileset dir="${lib.test.dir}" includes="*.jar"/>
252 253
		</path>

254 255 256 257 258 259 260 261 262
		<path id="protobuf.classpath">
			<fileset dir="${lib.disl.dir}" includes="protobuf*.jar"/>
		</path>

		<!-- Get ProtoBuf Java libs from ProtoBuf class path. -->
		<pathconvert pathsep=" " property="protobuf.libs" refid="protobuf.classpath">
			<mapper type="flatten"/>
		</pathconvert>

263 264
		<!-- Project class paths -->
		<path id="util.classpath">
265
			<pathelement location="${build.util}"/>
266 267 268
		</path>

		<path id="disl.classpath">
269
			<pathelement location="${src.disl.prefix}/${build.disl}"/>
270 271
		</path>

272 273 274 275
		<path id="disl-server.classpath">
			<pathelement location="${src.disl-server.prefix}/${build.disl-server}"/>
		</path>

276
		<path id="disl.bypass.classpath">
277
			<pathelement location="${build.disl.bypass}/dynamic"/>
278 279 280
		</path>

		<path id="shvm.classpath">
281
			<pathelement location="${src.shvm.prefix}/${build.shvm}"/>
282
			<pathelement location="${build.shvm.dispatch}"/>
283 284 285 286 287 288 289 290 291 292
		</path>
	</target>


	<!--
		Determines the names of native agent libraries.
		Mac OS X (Darwin) is considered a Unix family.
	-->
	<target name="-determine-lib-names" depends="-init">
		<ac:if>
293
			<os family="windows"/>
294
			<ac:then>
295 296
				<property name="dl.prefix" value=""/>
				<property name="dl.suffix" value=".dll"/>
297
				<property name="disl.agent.os" value="windows"/>
298 299
			</ac:then><ac:else>
				<ac:if>
300
					<os family="unix"/>
301
					<ac:then>
302
						<property name="dl.prefix" value="lib"/>
303
						<ac:if>
304
							<os name="Mac OS X"/>
305
							<ac:then>
306
								<property name="dl.suffix" value=".jnilib"/>
307
								<property name="disl.agent.os" value="macosx"/>
308
							</ac:then><ac:else>
309
								<property name="dl.suffix" value=".so"/>
310
								<property name="disl.agent.os" value="linux"/>
311 312 313
							</ac:else>
						</ac:if>
					</ac:then><ac:else>
314
						<fail message="Unsupported operating system: ${os.name}"/>
315 316 317 318
					</ac:else>
				</ac:if>
			</ac:else>
		</ac:if>
319

320 321 322 323 324 325
		<ac:switch value="${os.arch}" caseinsensitive="true">
			<case value="x86_64"><property name="disl.agent.arch" value="x86_64"/></case>
			<case value="amd64"><property name="disl.agent.arch" value="x86_64"/></case>
			<default><property name="disl.agent.arch" value="x86"/></default>
		</ac:switch>

326 327
		<property name="disl.agent.lib" value="${dl.prefix}${disl.agent.lib.base}${dl.suffix}"/>
		<property name="shvm.agent.lib" value="${dl.prefix}${shvm.agent.lib.base}${dl.suffix}"/>
328 329 330
	</target>


331 332 333 334 335 336
	<!--
		Looks for a class file or a source file with a given name, and
		sets the value of a given property to the fully qualified
		class name when a matching class (or source) file is found.
	-->
	<macrodef name="find-class">
337 338 339 340 341
		<attribute name="dir"/>
		<attribute name="name"/>
		<attribute name="property"/>
		<attribute name="suffix" default=".class"/>
		<attribute name="setonempty" default="true"/>
342 343
		<sequential>
			<pathconvert property="@{property}" setonempty="@{setonempty}">
344 345
				<fileset dir="@{dir}" includes="**/@{name}@{suffix}"/>
				<mapper type="package" from="${basedir}/@{dir}/*@{suffix}" to="*"/>
346 347 348 349 350
			</pathconvert>
		</sequential>
	</macrodef>


351 352
	<!-- Build tools -->

353
	<target name="compile-tools" depends="-init">
354
		<mkdir dir="${build.tools}"/>
355 356
		<javac destdir="${build.tools}" srcdir="${src.tools}">
			<classpath>
357 358
				<path refid="asm.classpath"/>
				<path location="${ant.core.lib}"/>
359 360 361 362 363
			</classpath>
		</javac>
	</target>


364 365
	<!-- DiSL bypass -->

366 367 368 369 370 371 372 373
	<!--
		To compile DiSL bypass code, we need an extended Thread class
		containing a public "bypass" field used by the dynamic bypass
		code. When running an application with DiSL instrumentation,
		the Thread class will be extended at load time, but we need
		one also for compilation.

		Here we first check if the extended Thread class exists, and
374 375
		if not, we use a thread extended from build tools to generate
		the extended Thread class.
376
	-->
377
	<!-- pathconvert property="build.disl.thread.available" setonempty="false">
378
		<fileset dir="." includes="${build.disl.thread}/**/Thread.class"/>
379
	</pathconvert -->
380 381 382 383 384 385 386 387 388 389
	<target name="-check-disl-thread">
		<condition property="build.disl.thread.available"><and>
			<available file="${build.disl.thread}/java/lang/Thread.class"/>
			<length file="${build.disl.thread}/java/lang/Thread.class" when="greater" length="1024"/>
		</and></condition>
	</target>

	<target name="-create-disl-thread-if-needed" unless="build.disl.thread.available" depends="-check-disl-thread">
		<antcall target="-create-disl-thread"/>
	</target>
Lukáš Marek's avatar
Lukáš Marek committed
390

391
	<target name="-create-disl-thread" depends="compile-tools">
392 393
		<local name="extender.class"/>
		<find-class property="extender.class" dir="${build.tools}" name="ExtendThread"/>
394

395
		<mkdir dir="${build.disl.thread}"/>
396
		<java classname="${extender.class}" fork="true">
397
			<classpath>
398 399
				<path location="${build.tools}"/>
				<path refid="asm.classpath"/>
400
			</classpath>
401
			<arg value="${basedir}/${build.disl.thread}"/>
402
		</java>
Lukáš Marek's avatar
Lukáš Marek committed
403 404 405
	</target>


406 407 408 409 410 411
	<!--
		Compile multiple versions of the bypass code: one which always
		bypasses the instrumentation, one which never bypasses the
		instrumentation, and one that checks the "bypass" field in
		the extended Thread class to determine whether to bypass the
		instrumentation or not.
Lukáš Marek's avatar
Lukáš Marek committed
412

413 414 415 416 417 418 419
		After compiling, create a file set of default bypass classes.
		The DiSL agent requires those so that instrumented application
		can find the BypassCheck class, and after switch to dynamic
		bypass performed by the agent, also the DynamicBypass class.
		The DiSL server requires both classes to create class literals
		in the weaver code.
	-->
420
	<target name="compile-disl-bypass" depends="-init,-create-disl-thread-if-needed">
421
		<ac:for list="always,never,dynamic" param="variant">
422
			<sequential>
423
				<mkdir dir="${build.disl.bypass}/@{variant}"/>
424
				<javac destdir="${build.disl.bypass}/@{variant}" srcdir="${src.disl.bypass}/@{variant}" debug="true" source="${target.disl.bypass}" target="${target.disl.bypass}">
425
					<compilerarg value="-Xbootclasspath/p:${basedir}/${build.disl.thread}"/>
426 427
				</javac>
			</sequential>
428
		</ac:for>
429

430
		<union id="disl.bypass.files">
431 432
			<fileset dir="${build.disl.bypass}/always" includes="**/BypassCheck.class"/>
			<fileset dir="${build.disl.bypass}/dynamic" includes="**/DynamicBypass.class"/>
433
		</union>
434 435
	</target>

436

437 438 439 440 441 442 443 444
	<!--
		Package the default variant of the bypass code which will
		be included in the boot classpath. By default, we include
		a BypassCheck variant that always bypasses instrumentation.
		We also include DynamicBypass class that is needed by the
		dynamic variant of the BypassCheck class, which will be
		substituted by the DiSL agent in place of the default on.
	-->
445
	<target name="build-disl-bypass" depends="compile-disl-bypass">
446
		<jar destfile="${out.lib}/${disl.bypass.lib}">
447
			<resources refid="disl.bypass.files"/>
448
		</jar>
449 450
	</target>

451 452 453

	<!-- Shared utility code -->

454
	<target name="compile-util" depends="-init">
455
		<mkdir dir="${build.util}"/>
456
		<javac destdir="${build.util}" srcdir="${src.util}" debug="true">
457
			<classpath refid="asm.classpath"/>
458
			<classpath refid="log4j.classpath"/>
459
		</javac>
460 461 462

		<!-- Register logging providers -->
		<!--
463 464
		<local name="service.dir"/>
		<property name="service.dir" value="${build.util}/META-INF/services"/>
465

466 467
		<local name="logging.package"/>
		<property name="logging.package" value="ch.usi.dag.util.logging"/>
468

469 470 471 472
		<local name="service.file"/>
		<property name="service.file" value="${service.dir}/${logging.package}.Provider"/>

		<mkdir dir="${service.dir}"/>
473 474 475
		<echo file="${service.file}" append="false">${logging.package}.JavaProvider${line.separator}</echo>
		<echo file="${service.file}" append="true">${logging.package}.Log4jProvider${line.separator}</echo>
		-->
476 477
	</target>

478 479 480

	<!-- DiSL -->

481
	<target name="compile-disl" depends="compile-util,compile-disl-bypass">
482
		<ant antfile="${src.disl.prefix}/build.xml" target="compile" usenativebasedir="true"/>
483 484
	</target>

485 486 487
	<target name="compile-disl-server" depends="compile-disl">
		<ant dir="${src.disl-server.prefix}" target="compile"/>
	</target>
Lukáš Marek's avatar
Lukáš Marek committed
488

489

490 491 492
	<target name="build-disl" depends="compile-disl,build-disl-bypass">
		<ant dir="${src.disl-server.prefix}" target="build" />
		<copy file="${src.disl-server.prefix}/${out.lib}/${disl.lib}" tofile="${out.lib}/${disl.lib}" />
493 494
	</target>

495 496 497

	<!-- DiSL agent -->

498 499 500 501 502
	<!--
		The DiSL agent requires a header file containing flags for
		various code generation options. This target generates the
		header using "javah" after compiling DiSL.
	-->
503
	<target name="-check-disl-agent-codeflags">
504
		<property name="build.disl.agent.codeflags.path" value="${src.disl.agent}/codeflags.h"/>
505
		<uptodate property="build.disl.agent.codeflags.uptodate" targetfile="${build.disl.agent.codeflags.path}">
506
			<srcfiles dir="${src.disl.prefix}/src" includes="**/DiSL.java"/>
507
		</uptodate>
508 509
	</target>

510 511 512
	<target name="-generate-disl-agent-codeflags-if-needed" unless="build.disl.agent.codeflags.uptodate" depends="-check-disl-agent-codeflags">
		<antcall target="-generate-disl-agent-codeflags"/>
	</target>
513

514
	<target name="-generate-disl-agent-codeflags" depends="compile-disl">
515
		<local name="flags.class"/>
516
		<find-class property="flags.class" dir="${src.disl.prefix}/${build.disl}" name="*CodeOption$Flag"/>
517

518
		<javah outputFile="${build.disl.agent.codeflags.path}" force="yes">
519 520
			<class name="${flags.class}"/>
			<classpath refid="disl.classpath"/>
521 522 523 524 525 526
		</javah>
	</target>


	<!--
		The DiSL agent requires the bytecode of several bypass
527 528
		classes. This target generates the "bytecode.c" containing
		the necessary bytecode.
529
	-->
530
	<target name="-check-disl-agent-bytecode">
531
		<property name="build.disl.agent.bytecode.path" value="${src.disl.agent}/bytecode.c"/>
532
		<uptodate property="build.disl.agent.bytecode.uptodate" targetfile="${build.disl.agent.bytecode.path}">
533
			<srcfiles dir="${src.disl.bypass}"/>
534
		</uptodate>
535 536
	</target>

537
	<target name="-generate-disl-agent-bytecode-if-needed" unless="build.disl.agent.bytecode.uptodate" depends="-check-disl-agent-bytecode">
538
		<antcall target="-generate-disl-agent-bytecode"/>
539
	</target>
540

541
	<target name="-generate-disl-agent-bytecode" depends="compile-disl,compile-tools">
542 543
		<taskdef name="bytedump" classname="ch.usi.dag.disl.tools.ByteDumpTask">
			<classpath>
544
				<pathelement location="${build.tools}"/>
545 546 547
			</classpath>
		</taskdef>

548 549
		<local name="output.file"/>
		<property name="output.file" value="${build.disl.agent.bytecode.path}"/>
550

551 552 553
		<echo file="${output.file}">/**${line.separator}</echo>
		<echo file="${output.file}" append="true"> * DO NOT EDIT!${line.separator}</echo>
		<echo file="${output.file}" append="true"> *${line.separator}</echo>
554
		<echo file="${output.file}" append="true"> * This file was generated using the '-generate-disl-agent-bytecode' target.${line.separator}</echo>
555 556
		<echo file="${output.file}" append="true"> */${line.separator}</echo>
		<echo file="${output.file}" append="true">#include &lt;jvmti.h&gt;${line.separator}</echo>
557

558
		<ac:for param="file.path">
559
			<path>
560
				<fileset dir="${build.disl.bypass}" includes="**/BypassCheck.class"/>
561 562 563
				<!-- fileset dir="${build.disl.bypass}" includes="**/DynamicBypass.class" /-->
			</path>
			<sequential>
564
				<!-- Variant of the class, i.e., the top-level directory name. -->
565
				<local name="file.variant"/>
566
				<pathconvert property="file.variant">
567 568
					<path path="@{file.path}"/>
					<mapper type="regexp" from="${basedir}/${build.disl.bypass}/([^/]+)/.*" to="\1"/>
569
				</pathconvert>
570 571

				<!-- Name of the class. -->
572
				<local name="file.class"/>
573
				<pathconvert property="file.class">
574 575
					<path path="@{file.path}"/>
					<mapper type="regexp" from=".*/([^/]+).class" to="\1"/>
576 577
				</pathconvert>

578 579
				<local name="file.length"/>
				<length property="file.length" file="@{file.path}"/>
580 581

				<!-- Define a structure for each class file. -->
582 583 584
				<echo file="${output.file}" append="true">${line.separator}jvmtiClassDefinition ${file.variant}_${file.class}_classdef = {${line.separator}</echo>
				<echo file="${output.file}" append="true">&#9;.class_byte_count = ${file.length},${line.separator}</echo>
				<echo file="${output.file}" append="true">&#9;.class_bytes = (unsigned char *)${line.separator}</echo>
585
				<bytedump
586
					srcFile="@{file.path}" destFile="${output.file}" append="true"
587 588 589
					blockLength="16"  byteFormat="\x%02x"
					blockPrefix="&#9;&#9;&quot;" blockSuffix="&quot;${line.separator}" lastSuffix="&quot;,${line.separator}"
				/>
590
				<echo file="${output.file}" append="true">};${line.separator}</echo>
591
			</sequential>
592
		</ac:for>
593 594
	</target>

595

596
	<target name="prepare-disl-agent" depends="-generate-disl-agent-codeflags-if-needed,-generate-disl-agent-bytecode-if-needed"/>
597 598


599 600
	<target name="compile-disl-agent" depends="prepare-disl-agent">
		<exec executable="make" dir="${src.disl.agent}"/>
601 602 603 604 605 606 607 608
	</target>


	<!--
		This target cross-compiles the DiSL agent library for
		Windows using MinGW. It is currently not used in the
		default build, but should be used for binary releases.
	-->
609
	<target name="compile-disl-agent-mingw" depends="prepare-disl-agent">
610
		<exec executable="make" dir="${src.disl.agent}">
611 612
			<arg value="WHOLE=1"/>
			<arg value="TARGET_ENV=MinGW"/>
613
		</exec>
Lukáš Marek's avatar
Lukáš Marek committed
614 615 616
	</target>


617
	<target name="build-disl-agent" depends="compile-disl-agent,-determine-lib-names">
618
		<copy file="${src.disl.agent}/${disl.agent.os}-${disl.agent.arch}/${disl.agent.lib}" todir="${out.lib}"/>
619
	</target>
Lukáš Marek's avatar
Lukáš Marek committed
620 621


622
	<!-- Shadow VM -->
Lukáš Marek's avatar
Lukáš Marek committed
623

624
	<target name="compile-shvm-dispatch">
625 626
		<mkdir dir="${build.shvm.dispatch}"/>
		<javac destdir="${build.shvm.dispatch}" srcdir="${src.shvm.dispatch}" debug="true" source="${target.shvm.dispatch}" target="${target.shvm.dispatch}"/>
627 628 629
	</target>


630
	<target name="build-shvm-dispatch" depends="compile-shvm-dispatch">
631
		<jar destfile="${out.lib}/${shvm.dispatch.lib}" basedir="${build.shvm.dispatch}"/>
632 633 634
	</target>


635
	<target name="compile-shvm" depends="compile-util,compile-shvm-dispatch">
636
		<ant antfile="${src.shvm.prefix}/build.xml" target="compile" usenativebasedir="true"/>
Lukáš Marek's avatar
Lukáš Marek committed
637 638
	</target>

639

640
	<target name="build-shvm" depends="compile-shvm,build-shvm-dispatch">
641 642
		<ant antfile="${src.shvm.prefix}/build.xml" target="build" usenativebasedir="true"/>
		<copy file="${src.shvm.prefix}/${out.lib}/${shvm.lib}" tofile="${out.lib}/${shvm.lib}" />
643 644
	</target>

645
	<!-- Shadow VM agent -->
Lukáš Marek's avatar
Lukáš Marek committed
646

647
	<target name="compile-shvm-agent">
648
		<exec executable="make" dir="${src.shvm.agent}">
649
			<arg value="WHOLE=1"/>
650
		</exec>
651 652 653
	</target>


654
	<target name="build-shvm-agent" depends="compile-shvm-agent,-determine-lib-names">
655
		<copy file="${src.shvm.agent}/${shvm.agent.lib}" todir="${out.lib}"/>
656
	</target>
František Haas's avatar
František Haas committed
657

658

659
	<!-- JUnit tests and DiSL/Shadow VM test suites -->
660

661
	<path id="test.classpath">
662 663
		<path refid="util.classpath"/>
		<path refid="disl.classpath"/>
664
		<path refid="disl-server.classpath"/>
665 666 667
		<path refid="shvm.classpath"/>
		<path refid="junit.classpath"/>
		<path refid="asm.classpath"/>
668 669
	</path>

670
	<target name="compile-test" depends="-init,compile-util,compile-disl,compile-shvm">
671
		<mkdir dir="${build.test}"/>
672
		<javac destdir="${build.test}" srcdir="${src.test}" debug="true">
673
			<classpath refid="test.classpath"/>
674
		</javac>
František Haas's avatar
František Haas committed
675

676 677 678
		<!-- Copy test resource files from source to class output directory. -->
		<copy todir="${build.test}">
			<fileset dir="${src.test}">
679
				<include name="**/*.resource"/>
680 681
			</fileset>
		</copy>
František Haas's avatar
František Haas committed
682 683 684
	</target>


685
	<macrodef name="package2path">
686 687
		<attribute name="package"/>
		<attribute name="property"/>
688 689
		<sequential>
			<pathconvert property="@{property}">
690 691
				<path path="@{package}"/>
				<mapper type="unpackage" from="${basedir}/*" to="*"/>
692 693 694
			</pathconvert>
		</sequential>
	</macrodef>
František Haas's avatar
František Haas committed
695

František Haas's avatar
František Haas committed
696

697
	<target name="build-test" depends="-init,compile-test">
698 699
		<property name="suite.base.pkg" value="ch.usi.dag.disl.test.suite"/>
		<package2path package="${suite.base.pkg}" property="suite.base.path"/>
700 701

		<condition property="test.suites" value="${test.name}" else="*">
702
			<isset property="test.name"/>
703
		</condition>
František Haas's avatar
František Haas committed
704

705
		<ac:for param="suite.path">
František Haas's avatar
František Haas committed
706
			<path>
707
				<dirset dir="${src.test}/${suite.base.path}">
708
					<include name="${test.suites}"/>
František Haas's avatar
František Haas committed
709 710 711
				</dirset>
			</path>
			<sequential>
712 713 714
				<local name="suite.name"/>
				<basename file="@{suite.path}" property="suite.name"/>
				<build-test-suite name="${suite.name}" path="${suite.base.path}/${suite.name}" pkg="${suite.base.pkg}.${suite.name}"/>
František Haas's avatar
František Haas committed
715
			</sequential>
716
		</ac:for>
František Haas's avatar
František Haas committed
717 718
	</target>

František Haas's avatar
František Haas committed
719

720 721 722 723 724 725 726
	<macrodef name="build-test-suite">
		<attribute name="name"/>
		<attribute name="path"/>
		<attribute name="pkg"/>
		<sequential>
			<!-- Package target application classes. -->
			<jar destfile="${out.test}/@{name}-app.jar">
727
				<fileset dir="${build.test}" includes="@{path}/app/**"/>
728
				<manifest>
729
					<attribute name="Main-Class" value="@{pkg}.app.TargetClass"/>
730 731 732 733 734 735 736 737 738 739 740 741
				</manifest>
			</jar>

			<!--
				Process annotations to find DiSL classes.

				Use an empty directory as destination for the classes to
				make the "javac" task actually execute "javac" with the
				source files. Using the normal build destination directory
				would result in "javac" task excluding all source files
				for which it could find up-to-date class files.
			-->
742 743
			<local name="classfinder.output"/>
			<tempfile property="classfinder.output" prefix="@{name}-disl-classes-" suffix=".lst" destDir="${out.dir}" createFile="true" deleteOnExit="true"/>
744

745
			<local name="classfinder.class"/>
746
			<find-class property="classfinder.class" dir="${src.disl.prefix}/${build.disl}" name="DislClassFinder"/>
747

748
			<mkdir dir="${out.dir}/empty"/>
749
			<javac srcdir="${src.test}" destDir="${out.dir}/empty">
750
				<classpath refid="test.classpath"/>
751

752 753 754 755
				<compilerArg value="-proc:only"/>
				<compilerArg line="-processor ${classfinder.class}"/>
				<compilerArg value="-Adisl.classfinder.output=${classfinder.output}"/>
				<compilerArg value="-Adisl.classfinder.separator=,"/>
756

757
				<include name="@{path}/**/*.java"/>
758 759
			</javac>

760 761
			<local name="disl.classes"/>
			<loadfile property="disl.classes" srcFile="${classfinder.output}"/>
762 763 764 765

			<!-- Package instrumentation classes. -->
			<jar destfile="${out.test}/@{name}-inst.jar">
				<manifest>
766
					<attribute name="DiSL-Classes" value="${disl.classes}"/>
767 768
				</manifest>

769
				<fileset dir="${build.test}" includes="@{path}/instr/**"/>
770 771 772
			</jar>
		</sequential>
	</macrodef>
František Haas's avatar
František Haas committed
773

774 775
	<!-- Run the instrumentation library unit tests -->
	<target name="test-disl">
776
		<ant antfile="${src.disl.prefix}/build.xml" target="test" usenativebasedir="true"/>
777 778 779 780
	</target>

	<!-- Run the shadow VM unit tests -->
	<target name="test-shvm">
781
		<ant antfile="${src.shvm.prefix}/build.xml" target="test" usenativebasedir="true" />
782 783 784
	</target>

	<!-- Run all tests -->
785
	<target name="test" depends="test-disl,test-shvm,test-compound"></target>
786 787

	<!-- Run compound tests -->
788
	<target name="test-compound" depends="build,build-test" description="Runs all tests or a selected (-Dtest.name=...) test suite.">
František Haas's avatar
František Haas committed
789

790 791 792 793
		<!--
			If test.name is set to a name of a test suite, only include the test suite
			in the batch of tests to be run, otherwise include all tests and suites.
		-->
794
		<ac:if>
795
			<isset property="test.name"/>
796
			<ac:then>
797 798
				<echo>Running a single test suite: ${test.name}</echo>
				<fileset id="test.batch" dir="${src.test}">
799
					<include name="**/suite/${test.name}/junit/*Test.java"/>
800
				</fileset>
801
			</ac:then><ac:else>
802 803
				<echo>Running all tests.</echo>
				<fileset id="test.batch" dir="${src.test}">
804 805 806
					<include name="**/junit/*Test.java"/>
					<include name="**/disl/*Test.java"/>
					<include name="**/disl/scope/*Test.java"/>
807
					<include name="**/disl/util/cfg/*Test.java"/>
808
					<include name="**/dislreserver/shadow/*Test.java"/>
809
				</fileset>
810 811
			</ac:else>
		</ac:if>
František Haas's avatar
František Haas committed
812

813 814 815
		<!--
			Run the batch of junit tests and junit-wrapped test suites.
		-->
816
		<mkdir dir="${out.junit}"/>
817
		<junit haltonfailure="yes" haltonerror="yes" failureproperty="junit.failure">
818 819
			<formatter type="brief" usefile="false"/>
			<formatter type="xml"/>
820 821

			<classpath>
822 823 824 825
				<path refid="asm.classpath"/>
				<path refid="junit.classpath"/>
				<pathelement location="${build.test}"/>
				<pathelement location="${build.util}"/>
826
				<pathelement location="${src.disl-server.prefix}/${build.disl-server}" />
827
				<pathelement location="${src.disl.prefix}/${build.disl}"/>
828
				<pathelement location="${src.shvm.prefix}/${build.shvm}" />
829 830
			</classpath>

831
			<!-- pass properties starting with "disl.", "dislserver.", and "dislreserver." to the tests -->
František Haas's avatar
František Haas committed
832
			<syspropertyset>
833 834 835
				<propertyref prefix="disl."/>
				<propertyref prefix="dislserver."/>
				<propertyref prefix="dislreserver."/>
František Haas's avatar
František Haas committed
836
			</syspropertyset>
837

838 839 840 841 842 843
			<sysproperty key="runner.disl.lib.dir" value="${out.lib}"/>
			<sysproperty key="runner.lib.dir" value="${out.test}"/>
			<sysproperty key="runner.disl.agent.lib" value="${disl.agent.lib}"/>
			<sysproperty key="runner.shvm.agent.lib" value="${shvm.agent.lib}"/>
			<sysproperty key="runner.debug" value="${test.debug}"/>
			<sysproperty key="test.verbose" value="${test.verbose}"/>
844

845
			<batchtest fork="yes" todir="${out.junit}">
846
				<fileset refid="test.batch"/>
František Haas's avatar
František Haas committed
847 848 849
			</batchtest>
		</junit>
	</target>
850 851 852 853


	<!-- Eclipse support -->

854
	<target name="build-eclipse-agent">
855 856
		<local name="agent.class"/>
		<find-class property="agent.class" dir="${src.test}" name="Agent" suffix=".java"/>
857 858

		<jar destfile="${out.lib}/${eclipse.agent.lib}">
859
			<manifest>
860
				<attribute name="Premain-Class" value="${agent.class}"/>
861 862 863 864 865 866 867
			</manifest>
		</jar>
	</target>


	<!-- Documentation -->

868
	<macrodef name="pdflatex">
869 870
		<attribute name="dir" default="."/>
		<element name="exec-elements" implicit="yes"/>
871
		<sequential>
872 873
			<local name="pdflatex.output"/>
			<local name="pdflatex.result"/>
874

875
			<exec executable="pdflatex" dir="@{dir}" outputProperty="pdflatex.output" resultProperty="pdflatex.result">
876
				<exec-elements/>
877 878
			</exec>
			<fail message="${pdflatex.output}">
879
				<condition><isfailure code="${pdflatex.result}"/></condition>
880 881 882 883 884 885
			</fail>
		</sequential>
	</macrodef>


	<target name="check-doc">
886 887 888
		<property name="doc.intro.tex" value="dislintro.tex"/>
		<property name="doc.intro.pdf" value="${build.doc.intro}/dislintro.pdf"/>
		<fileset id="doc.intro.files" dir="${src.doc.intro}"/>
889

890
		<uptodate property="doc.intro.uptodate" targetFile="${doc.intro.pdf}">
891
			<srcfiles refid="doc.intro.files"/>
892 893 894 895 896
		</uptodate>
	</target>


	<target name="build-doc" depends="check-doc" unless="doc.intro.uptodate">
897
		<delete dir="${build.doc.intro}"/>
898
		<copy todir="${build.doc.intro}">
899
			<fileset refid="doc.intro.files"/>
900
		</copy>
901 902 903

		<echo>Compiling Introduction to Instrumentation with DiSL</echo>
		<pdflatex dir="${build.doc.intro}">
904 905
			<arg value="-draftmode"/>
			<arg value="${doc.intro.tex}"/>
906 907 908
		</pdflatex>

		<pdflatex dir="${build.doc.intro}">
909
			<arg value="${doc.intro.tex}"/>
910
		</pdflatex>
911 912 913
	</target>


914
	<target name="build-jdoc" depends="-init,compile">
915
		<mkdir dir="${out.doc.jdoc}"/>
916 917
		<javadoc destdir="${out.doc.jdoc}"
			access="public" author="true" version="true" use="true"
918 919
			noDeprecated="false" nodeprecatedlist="false"
			noIndex="false" splitIndex="true" noNavbar="false" noTree="false"
920
			overview="${src.doc.jdoc}/overview.html"
921
			source="1.8"
922 923
		>
			<sourcepath>
924
				<pathelement path="${src.disl.prefix}/src"/>
925 926 927
			</sourcepath>

			<sourcefiles>
928
				<fileset dir="${src.disl.prefix}/src">
929 930 931 932 933 934
					<include name="**/DiSL.java"/>
					<include name="**/Reflection.java"/>
					<include name="**/Scope.java"/>
					<include name="**/ScopeMatcher.java"/>
					<include name="**/Shadow.java"/>
					<include name="**/Transformer.java"/>
935 936
				</fileset>
				<fileset dir="${src.disl.bypass}">
937
					<include name="**/DynamicBypass.java"/>
938
				</fileset>
939 940

				<fileset dir="${src.shvm}">
941 942 943 944 945
					<include name="**/RemoteAnalysis.java"/>
					<include name="**/ShadowObject.java"/>
					<include name="**/ShadowString.java"/>
					<include name="**/ShadowThread.java"/>
					<include name="**/ShadowClass.java"/>
946 947
				</fileset>
				<fileset dir="${src.shvm.dispatch}">
948
					<include name="**/REDispatch.java"/>
949
				</fileset>
950 951 952
			</sourcefiles>

			<classpath>
953 954 955 956
				<path refid="disl.bypass.classpath"/>
				<path refid="shvm.classpath"/>
				<path refid="util.classpath"/>
				<path refid="asm.classpath"/>
957 958 959 960 961 962 963
			</classpath>
		</javadoc>
	</target>


	<!-- Miscellaneous -->

964
	<target name="copy-libs" depends="-init">
965 966
		<copy todir="${out.lib}" flatten="true">
			<path refid="asm.classpath"/>
967
			<path refid="protobuf.classpath"/>
968
		</copy>
969 970 971 972
	</target>


	<target name="package-src">
973
		<zip destfile="${out.src}/src.zip">
974
			<zipfileset dir="${src.disl.prefix}/src"/>
975 976 977 978
			<zipfileset dir="${src.disl.bypass}/dynamic"/>
			<zipfileset dir="${src.shvm}"/>
			<zipfileset dir="${src.shvm.dispatch}"/>
			<zipfileset dir="${src.util}"/>
979 980 981 982 983 984
		</zip>
	</target>


	<!-- Releases -->

985
	<target name="release-bin" depends="build,package-src">
986
		<!-- Collect the artifacts from output and source directories. -->
987
		<zip destfile="${release.bin.zip}">
988
			<zipfileset prefix="${disl.prefix}/${dist.bin}" dir="${src.bin}" fileMode="755"/>
989
			<zipfileset prefix="${disl.prefix}/${dist.lib}" dir="${out.lib}"/>
990 991
			<zipfileset prefix="${disl.prefix}/${dist.doc.intro}" file="${doc.intro.pdf}"/>
			<zipfileset prefix="${disl.prefix}/${dist.doc.jdoc}" dir="${out.doc.jdoc}"/>
992
			<zipfileset prefix="${disl.prefix}/${dist.examples}" dir="${src.examples}">
993
				<exclude name="build-override.properties"/>
994
			</zipfileset>
995
			<zipfileset prefix="${disl.prefix}/${dist.src}" dir="${out.src}"/>
996
			<zipfileset prefix="${disl.prefix}" dir=".">
997 998 999
				<include name="COPYING"/>
				<include name="README"/>
				<include name="USER_ERRORS"/>
1000
			</zipfileset>
1001 1002
		</zip>

1003
		<!-- Convert the zip archive to bzip2 compressed tar. -->
1004
		<tar destfile="${release.bin.tar}" compression="bzip2">
1005
			<zipfileset src="${release.bin.zip}"/>
1006 1007 1008 1009
		</tar>
	</target>


1010
	<target name="release-src" depends="clean-examples">
1011 1012
		<zip destfile="${release.src.zip}">
			<zipfileset prefix="disl-${disl.version}" dir=".">
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
				<include name="${src.bin}/"/>
				<include name="${src.doc}/"/>
				<include name="${src.examples}/"/>
				<include name="${lib.dir}/README"/>
				<include name="${lib.dir}/*.lst"/>
				<include name="COPYING"/>
				<include name="README"/>
				<include name="README_TESTS"/>
				<include name="USER_ERRORS"/>
				<include name="build.properties"/>
				<include name="build.xml"/>
				<include name="dependencies.properties"/>
				<include name="${build.ivy.file}"/>
				<include name="disl.version"/>
				<include name=".settings/"/>
				<include name=".project"/>
				<include name=".classpath"/>
				<include name="eclipse.*"/>
1031
			</zipfileset>
1032 1033
			<zipfileset prefix="disl-${disl.version}" dir="." includes="src*/" excludes="**/var,**/find.sh,**/*.so,**.jnilib,**/*.o"/>
			<zipfileset prefix="disl-${disl.version}" dir="." includes="src*/**/find.sh" filemode="755"/>
1034 1035 1036
		</zip>

		<tar destfile="${release.src.tar}" compression="bzip2">
1037
			<zipfileset src="${release.src.zip}"/>
1038 1039 1040 1041 1042
		</tar>
	</target>


	<!-- Summary targets -->
1043 1044 1045
        <target name="properties" depends="-determine-lib-names">
		<echoproperties/>
        </target>
1046

1047
	<target name="compile" depends="compile-disl,compile-disl-agent,compile-shvm,compile-shvm-agent" description="Compiles DiSL, Shadow VM, and the JVM agents for both."/>
1048

1049
	<target name="build" depends="build-disl,build-disl-agent,build-shvm,build-shvm-agent,copy-libs" description="Builds DiSL and Shadow VM, without documentation."/>
1050

1051
	<target name="eclipse" depends="download-sources,build-eclipse-agent,build-disl-bypass" description="Creates libraries for developing DiSL under Eclipse."/>