summaryrefslogtreecommitdiff
path: root/ACE-INSTALL.html
blob: 7f4449a66e6ffbbc0e0de57aa83d65da14169318 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
<HTML>
<!-- $Id$ -->

<HEAD>
<TITLE>Building and Installing ACE and Its Network Services</TITLE>
<link rev=made href="mailto:schmidt@cs.wustl.edu">
</HEAD>

<BODY text = "#000000"
link="#000fff"
vlink="#ff0f0f"
bgcolor="#ffffff">

<HR>
<H3>Building and Installing ACE and Its Network Services</H3>

<H4>Synopsis</H4>

The file explains how to build and install ACE and its Network
Services on the various OS platforms and compilers that it has been
ported to.  Please consult the <A HREF="ChangeLog">ChangeLog</A> file
to see whether any recent changes to the release will affect your
code.  In addition, you might want to read the ACE <A
HREF="ACE.FAQ.html">FAQ</A> before building and installing ACE.

<H4>Document Index</H4>

<UL>
  <LI><A HREF="#platforms">Supported Platforms and C++ Compilers</A>
  <LI><A HREF="#installnotes">Installation Notes for Supported Platforms</A>
  <LI><A HREF="#g++">Compiling ACE with GNU g++</A>
  <LI><A HREF="#egcs">Compiling ACE with egcs</A>
  <LI><A HREF="#aceinstall">Building and Installing ACE</A>
  <LI><A HREF="#svcsinstall">Building and Installing ACE Network Services</A>
  <LI><A HREF="#advanced">Advanced Topics</A>
</UL>

<P><HR><P>
<H3><A NAME="platforms">Supported Platforms and C++ Compilers</A></H3>

<!--#include virtual="/~schmidt/ACE-versions-i.html" -->

<p>The following table summarizes platforms on which ACE runs:<P>

<table width="100%" border=1>
  <tr valign=top>
    <td><b>Fully supported, i.e., continually tested and used daily</b></td>
    <td>Solaris 2.5 and 2.6, Windows NT (MSVC++ 4.x and 5.0),
        DEC Alpha Windows NT (MSVC++ 5.0), Linux/Intel,
        Linux/Alpha, VxWorks, LynxOS, Digital UNIX 4.0,
        HP/UX, AIX
    </td>
  </tr>
  <tr valign=top bgcolor="#AFAFAF">
   <td><b>Nearly fully supported, i.e., periodically tested</b></td>
   <td>Windows 95, IRIX 6.x, MVS
   </td>
  </tr>
  <tr valign=top>
    <td><b>Partially supported, i.e., infrequently tested</b></td>
    <td> Windows CE, Tandem, Chorus, SCO, UnixWare, SunOS 4.x, FreeBSD, NetBSD
    </td>
  </tr>
  <tr valign=top bgcolor="#AFAFAF">
    <td><b>Planned support, i.e., pending</b></td>
    <td> pSoS, </td>
  </tr>
</table>

<P>Any UNIX/POSIX/Win32 variation is a potential target platform for
ACE.  If you have <A
HREF="http://www.cs.wustl.edu/~schmidt/ACE_wrappers/etc/ACE-porting.html">porting
questions</A> or have a problem compiling the ACE wrappers on the
platforms shown above please send email to either <A
HREF="news:comp.soft-sys.ace">ACE Newsgroup</A> or the <A
HREF="mailto:ace-users@cs.wustl.edu">ACE mailing list</A> and we'll
try to help you fix the problems.

<P><HR><P>
<H3><A NAME="installnotes">Installation Notes for Supported Platforms</A></H3>

<UL>
  <LI> <B>Win32 (Windows NT/i386, NT/Alpha and Windows '95) </B><P>

      All of ACE has been ported to the Win32 API (which includes Windows NT
      and Windows '95).  The entire release now compiles using the Microsoft
      Visual C++ 4.x and 5.0 compilers (the 2.0 compiler may also work, but
      we haven't tested it recently).  ACE can be built as both a static and
      dynamic library, using the Win32 installation process described
      below.<P>

  <li> <b>Windows CE</b><p>

      Most of ACE has been ported to Windows CE using Visual C++ 5.0 with CE
      Toolkit.  ACE has been tested on x86 Emulator and an HP 360LX
      with an SH series CPU.  Please be sure to read this file (<a
      href="CE-status.txt">CE-status.txt</a>) for
      up-to-date information about ACE on CE.  ACE can only be built as
      DLL library now.<p>

  <LI> <B> Sun OS 5.x/4.x (a.k.a. Solaris 2.x/1.x) using Sun CC 3.0.1, Sun
      C++ 4.0.x, Centerline C++ 2.x, and GNU gcc 2.7.x. </B> <P>

      All the source code and tests should build and run without
      any problems on the Solaris and SunOS platforms using the
      Sun C++ compilers.<P>

  <LI> <B> Sun OS 4.1.x using Centerline C++ 2.x, Sun CC 3.x, and Lucid
      Energize 3.2. </B> <P>

      Note that shared libraries do not interact very well with
      Centerline C++ or Sun C++ on SunOS 4.1.x.  This is due to
      odd behavior of the SunOS 4.1.x linker, which (1) does not
      properly call constructors of global objects within shared
      libraries and (2) does not call the init() and fini()
      functions in shared libraries, even though the manual claims
      that these functions are called!  In particular, this means
      that the tests in the directory
      $(ACE_ROOT)/tests/Service_Configurator/IPC-tests/server/
      will not work for statically linked services...<P>

      Some versions of SunOS 4.1.x do not contain the
      /usr/lib/libnsl.a library.  This library seems to be
      optional since System V Transport Layer Interface (TLI)
      support is optional on SunOS 4.1.x (in contrast, it's the
      "preferred" transport interface on Solaris).<P>

      The best work-around for now is probably to either add a
      dummy libnsl.a in /lib (which may not be feasible) or simply
      comment out the line:<P>

      LIBS += -lnsl<P>

      in the <CODE>$ACE_ROOT/include/makeinclude/wrapper_macros.GNU</CODE>
      file.  Naturally, any programs, e.g., the TLI_SAP tests,
      that use the TLI wrappers aren't going to work!<P>

      Note that on SunOS 4.x you may get warnings from the linker
      that "archive has no table of contents; add one using
      ranlib(1)" for certain libraries, e.g., libASX.a,
      libThreads.a, and libSPIPE.a.  This occurs since SunOS 4.x
      does not support these features.<P>

  <LI><B>AIX</B><P>

      The ACE port to AIX assumes that the user has installed the
      AIX patch containing the dl*() APIs.  To use these APIs, IBM
      has created a separate product (free to AIX licensees)
      called shared library hookable symbols (or slhs/6000).  If
      you don't have this patch, the sv* commands for compiling
      and linking will not be present on the system.<P>

      If you are using AIX 4.2.1 or later, there is no patch needed;
      the dynamic library APIs are included in the base operating
      system.<P>

      BTW, here's a technique from Rob Jordan &lt<A
      HREF="mailto:jordan@hursley.ibm.com">jordan@hursley.ibm.com</A>&gt
      that can reduce the size of the ACE libraries by
      about one third, and can also be applied to applications.  It works
      by optimising the sharing of template functions, which are created in an
      ``unusual'' way under AIX. It also speeds up compilation.<P>

      Here's how to optimise the ACE library generation:<P>

      Look at the <A
      HREF="http://www.cs.wustl.edu/~schmidt/ACE_wrappers/ace/Makefile">Makefile</a>
      in <CODE>$ACE_ROOT/ace</CODE>. Create a file called
      <CODE>ACE_All_Src.cpp</CODE>, and add a line to #include
      each of the source files
      listed under <CODE>FILES=</CODE> in the Makefile. Create a
      file called <CODE>ACE_All_Tmp.h</CODE>
      and add a line to #include each of the .h files listed under
      <CODE>TEMPLATE_FILES=</CODE> in the Makefile. Now update the Makefile so that
      <CODE>FILES=ACE_All_Src</CODE> and <CODE>TEMPLATE_FILES=ACE_All_Tmp</CODE>.<P>

  <LI><B>Linux</B><P>

      ACE has been ported to <A
      HREF="http://www.cs.wustl.edu/~cleeland/ace/">Linux</A> on both Intel
      and Alpha platforms.  If you use a RedHat 5.x distribution, it's best
      to use RedHat 5.1.  ACE will work without any modifications on
      RedHat 5.1; use the
      <code>include/makeinclude/platform_linux_lxpthreads.GNU</code>
      and <code>ace/config_linux_lxpthreads.h</code> platform/config
      files.<p>

      <strong>NOTE:</strong> The TAO NameService uses IP multicasting
      by default, though it is not required.  IP multicast on Linux
      requires the following:<p>
      <ul>
        <li>Enable IP multicast in the Linux kernel.  It is enabled in
            the default RedHat 5.1 kernel.  In older distributions, you
            can enable it by rebuilding your kernel with CONFIG_IP_MULTICAST
            enabled.<p>
        <li>Enable IP multicast in ACE.  It is enabled by default in
            <code>ace/config-linux-common.h</code>.  If you don't use
            IP multicast, add <code>#define ACE_HAS_IP_MULTICAST 0</code>
            to your <code>ace/config.h</code> before building ACE.<p>
        <li>There must be a network interface that is up and supports
            multicast.  If you have linuxconf, it's easiest to use that
            to add a network route for multicast (224.0.0.0) on one of
            your network interfaces, such as <code>eth0</code>.  If
            you don't have or use linuxconf, try adding a multicast
            routing table entry using something like this:<p>
            <pre>
             <code># route add -net 224.0.0.0 netmask 240.0.0.0 dev eth0</code>
            </pre><p>
      </ul>

      With RedHat 5.0, you'll need some
      <a href="os-patches/linux-patches.html">updates and possibly some
      patches</a> to get ACE working with LinuxThreads.  Some of the patches
      are necessary with Alpha CPUs and with some older kernels.  egcs 1.0.1
      can also be used, but it may need patches, described there, as well.<p>

      <strong>NOTE:</strong> Be careful when installing egcs.  If
      you don't remove your old gcc and libg++ RPMs, it's best to
      install egcs in a different directory than /usr, such as /usr/local,
      and set your PATH and LD_LIBRARY_PATH accordingly.<p>

      Some of the ACE tests fail on older, pre-glibc2 Linux platforms,
      such as RedHat 4.2.  The problems are with threads and thread-specific
      storage.<p>

  <LI><B>SCO UNIX</B><P>

      ACE has been ported to SCO UNIX using the GNU g++ 2.7.2 compiler.
      Arturo Montes &lt<A
      HREF="mailto:mitosys@colomsat.net.co">mitosys@colomsat.net.co</A>&gt
      maintains this code.  In addition, he also maintains a version of <A
      HREF="http://www.cs.wustl.edu/~schmidt/ACE_wrappers/FSU-threads.ps.gz">FSU
      pthreads</A>.<P>

  <LI><B>SGI IRIX 5.x and 6.x</B><P>

      ACE used to build fine using the SGI C++ and GNU GCC compilers for
      IRIX 5.x.
      It has been ported to IRIX 6.x using the SGI MipsPro 7.1 C++
      compiler;
      be aware that in IRIX 6.2 there is a number of patches that
      have to be installed and exceptions appear to fail with the
      O32 ABI.
      Please check the config files for the details.<P>

  <LI> <B> HP-UX 9.x, 10.x, and 11.00 </B> <P>

      HP sells 2 C++ compilers for HP-UX 10.x and 11.00.  If you are using 9.x,
      there's only the first one.
      <UL>
        <LI>HP C++ - this is CC, HP's cfront-based compiler.  As of ACE 4.4, it
            can be used, but some people have problems with templates.
            Caveat emptor.  It's been said that you should run version 10.24,
            if not later.

        <LI>HP aC++ - this is aCC, HP's new, ANSI-to-be compiler.  It handles ACE
            pretty well.  You should use version A.01.12 on HP-UX 10.x and
            version A.03.05 on HP-UX 11.00.  Also see further notes on
            this platform at Riverace's
            <A HREF="http://www.riverace.com/ACE/hints_hpux.html">HP-UX Hints</A>
            page.

      </UL>
      <P>

  <LI> <B>OSF/1 3.2 and 4.0 (a.k.a. Digital UNIX 4.0)</B> <P>

      The OSF/1 C++ 5.4 through 5.7 compilers have problems with ACE's
      templates.  They compile the lib and most of the test programs,
      although they warn about template usage.  Most tests run, some dump
      core.<P>

      CXX 6.0 and 6.1 are _much_ improved in this regard:  they build all of
      ACE cleanly.  Please note that
      <code>include/makeinclude/platform_osf1_4.0.GNU</code> has a
      <strong><code>WARNING_FLAGS</code></strong> macro that is disabled by
      default, to support users who don't have 6.0 yet.  If you do, enable
      that macro definition by either adding CXX_VER=POST_5X to your gmake
      invocation, or editing your include/makeinclude/platform_macros.GNU
      file.  All of the tests in ACE_wrappers/tests run successfully with
      CXX 6.0 and CXX 6.1.<P>

      GNU gcc 2.7.2.1 compiles without problems. All tests run (besides
      minor problems).  Thanks to Thilo Kielmann &lt<A
      HREF="mailto:kielmann@informatik.uni-siegen.de">
      kielmann@informatik.uni-siegen.de</A>&gt and David Trumble &lt<A
      HREF="mailto:trumble@cvg.enet.dec.com">trumble@cvg.enet.dec.com</A>&gt
      for help with this port.<P>

  <li><b> FreeBSD </b><p>

      FreeBSD is a fast evolving platform.  However, it has the
      advantage of having standard releases.  At this moment, ACE
      supports both -stable (2.2.x) and -current (3.0).  Threaded version of ACE is
      only supported on -current.  It might just work for -stable but
      we never tried that.  <p>

      Notice that on FreeBSD, <code>ld.so</code> only looks for so
      libraries with <b>version number</b> appended.  ACE makefiles
      create symlink for most libraries they generate to
      <code>$ACE_ROOT/ace</code> with appropriate ACE version.
      However, this does not work for libACE.so itself so you have to
      create it manually (If you figure out how to do this, please
      let us know) like this: <p>

      <code>ln -sf $ACE_ROOT/ace/libACE.so $ACE_ROOT/ace/libACE.so.4.5</code><p>

  <li><b>NetBSD</b><p>

      Like FreeBSD, NetBSD's <code>ld.so</code> also requires
      versioned .so files.<p>

  <LI><B> UnixWare </B> <P>

      Steve Huston &lt<A HREF="mailto:shuston@riverace.com">shuston@riverace.com</A>&gt
      has ported ACE to work with UnixWare 2.01 and g++.<P>

      Ganesh Pai &lt<A HREF="mailto:gpai@voicetek.com">gpai@voicetek.com</A>&gt
      subsequently did the port for version 2.1.2, also with g++.<P>

  <LI><B>Chorus</B> <P>

      Wei Chiang &lt<A HREF="mailto:chiang@tele.nokia.fi">chiang@tele.nokia.fi</A>&gt
      has ported ACE to Chorus 3.1 using GNU g++ 2.7.2.<P>

  <LI><B>LynxOS</B> <P>

      Dave Mayerhoefer &lt<A HREF="mailto:davem@lynx.com">davem@lynx.com</A>&gt
      has ported ACE to LynxOS 2.5 using GNU g++ 2.7.2.  However, you may need
      to apply some <A HREF="os-patches/lynxos-patches.html">patches
      to LynxOS</A> to get ACE working.<P>

  <LI><STRONG>VxWorks</STRONG><P>

      <A HREF="http://www.cs.wustl.edu/~levine/">David Levine</A> &lt<A
      HREF="mailto:levine@cs.wustl.edu">levine@cs.wustl.edu</A>&gt has
      ported ACE to VxWorks 5.2/5.3/5.3.1 with the GreenHills 1.8.8
      and g++ 2.7.2 compilers.<P>

      In addition to all of the other benefits of ACE, it helps
      work around some deficiencies with VxWorks 5.3/5.3.1.
      Some of these apply only with g++, at least thru version 2.7.2.
      That is the version that is shipped with Tornado 1.0.1/
      VxWorks 5.3.1.  The problems are:<P>
      <OL>
        <LI>The program entry point cannot be called ``main'' with g++.  ACE
            renames it to ``ace_main'' (configurable via ACE_MAIN) on VxWorks.
            While this may seem trivial, it is important with legacy code.
            ACE itself ran into this problem.<P>

        <LI>argc/argv isn't used with VxWorks entry points.  ACE provides
            a wrapper function that transparently converts shell command
            line arguments to argc/argv form.  See <A HREF="#spa">below</a>
            for details.<P>

        <LI>Unsigned long long support is not available with the g++ that
            is distributed with Tornado 1.0.1/VxWorks 5.3.1, or with
            GreenHills 1.8.8.  The documentation says that it is supported
            by g++, but try using it :-)   Wind River technical support verified
            that it doesn't work.  ACE provides its own 64-bit unsigned integer
            type, ACE_hrtime_t, so you don't even have to worry about this
            problem if you use it.<P>

        <LI>There a gory problem with munch that is severely aggravated
            by the presence of a static in the Wind River/g++ iostream.h.
            ACE hides this and provides an easy-to-use workaround in the
            very unlikely situation where it becomes a problem.
            Please see ace/config-vxworks5.2-g++.h for more information.<P>
      </OL>
      In addition, as noted <A HREF="#g++">below</A> following the
      discussion of the g++ -fno-implicit-templates option,
      -fno-implicit-templates is broken.  And, -O2 is not supported on some
      targets.<P>

      Please note that ACE uses one of the spare fields in
      the Wind River task control block, spare4, for thread-
      specific storage.  This field is specified in only one
      place, in ace/OS.i, so it can easily be changed to one
      of the other spare fields, if necessary.<P>

      Versions of ACE from 4.3.3 and beyond destroy dynamically
      allocated singletons in the ACE library.  But, they may not
      properly destroy some static objects.  If you have trouble
      running a program multiple times, it may be necessary to
      unload the module, using unld, and reload it between runs.
      Alternatively, you could try calling <code>cplusDtors</code>
      and then <code>cplusCtors</code> between runs.<P>

  <LI><B>MVS OpenEdition</B> <P>

      All of ACE has been ported to OpenEdition by Chuck Gehr &lt<A
      HREF="mailto:gehr@sweng.stortek.com">gehr@sweng.stortek.com</A>&gt.
      The ACE library, all the tests and most of the examples and apps build
      clean.  There are still some problems that need to be ironed out:<P>

      MVS does not support the dynamic linking dl...() calls that the Service
      Configurator uses to dynamically link services at run time. As a result, all
      the examples and apps that use a svc.conf file (for dynamically configuring
      service objects) do not work, however, most of these apps can be built/run
      statically.  Also, the Svc_Conf_l.cpp and Svc_Conf_y.cpp files are generated
      using flex and yacc on a ascii (not ebcdic) machine and as a result they don't
      work very well with ebcdic svc.conf files.  We should be able to regenerate
      these files on MVS but MVS doesn't have flex.  This is something that needs
      to be done.<P>

      Some of the tests do not execute properly.  This is a minority and over time
      the goal is to get to 100%.<P>

      The make scheme for some of the apps still doesn't work perfectly on MVS.
      This is mainly due to the way shared libraries are handled on MVS.  See
      <A HREF="#mvs">additional build tips for MVS</A> for more on
      this.<P>
</UL>

<HR>
<H4><A NAME="g++">Compiling ACE with GNU g++</A></H4>

If you use the GNU GCC g++ compiler please note the following:

<UL>
  <LI>With g++ 2.8.0, an internal compiler error is raised when
      trying to compile ACE_Map_Manager instantiations.  One workaround
      is to disable optimization.  The easiest way to do that is:

      <pre><code>% make optimize=0</code></pre>

      Or, you can edit your include/makeinclude/platform_sunos5_g++.GNU,
      and comment out the <code>OCFLAGS</code> line.<P>

  <LI>Earlier (prior to 2.7.2) versions of g++ may not compile
      certain parts of ACE correctly due to compiler bugs.  Please
      upgrade to g++ 2.7.2 or greater.<P>

  <LI>Make sure to update your gcc <code>config.status</code>
      file.  This file is produced when installing gcc; it specifies
      where to install the binary files that gcc uses.  For example,
      it specifies whether to use Solaris's
      <code>/usr/ccs/bin</code> binary utils or GNU binary
      utils.  The <code>config.status</code> file is an output of
      the gcc <code>configure</code> script; it is preferable to use
      the <code>--prefix</code> option to <code>configure</code> instead
      of hacking its output.<P>

  <LI>If you are getting weird link errors when building libACE
      on Solaris you are probably using the GNU linker.  Try using
      the Sun linker (/usr/ccs/bin/ld) instead.  Note that gcc
      first looks for the GNU linker if it is installed along
      with gcc.  The only way to not use the GNU linker is to
      delete it from the installation or to build your own
      compiler with no linker. Be aware that you still need the
      libraries and includes of gcc.<P>

  <LI>Don't get too confused about contradictory statements in
      the gcc documentation. It was written by different
      people...<P>

  <LI>Make sure that the linker invoked by gcc produces code
      that initializes static objects.  Please see gcc's
      documentation for using <CODE>collect2</CODE>.<P>

  <LI>By default, gcc (thru version 2.7.2, at least) uses
      implicit template instantiation.  Besides wasting space,
      this breaks the use of ACE_Singleton:  instead of one
      singleton instance, there could be one instance per object
      (.o) file that "sees" the template.  Therefore, we have
      overridden this default in ACE by enabling the
      -fno-implicit-templates option to CCFLAGS in all
      include/makeinclude/platform_*.GNU files that set CXX to g++.<P>

  <LI>The disadvantage of this approach is that you must
      add template specializations for all templates that your
      application uses to your own code.  (The ACE libraries are
      self-contained:  you don't need to add the templates that
      they use internally.)  Examples of template specializations
      occur in quite a few ACE .cpp files; see
      apps/Gateway/Gateway/Proxy_Handler.cpp for one example.
      An easy way to figure out what template instantiations are
      need is to try to build your executable and pipe the output
      through c++filt.  The linker will report the missing
      instantiations as undefined symbols.  Iteration may be
      necessary, if the template instantiations themselves reference
      other templates.<P>

  <LI>Alternatively, you could apply the
      <a href="ftp://ftp.cygnus.com/pub/g++/">Cygnus template repository
      patches</a> and use the -frepo option instead of
      -fno-implicit-templates.  ACE readily this option for
      application code:  to enable it just add <code>repo=1</code>
      to your <code>make</code> invocation, or to your
      <code>include/makeinclude/platform_macros.GNU</code>.  ACE
      still uses explicit template instantiation for building its
      libraries to help avoid link conflicts.  Please see the g++
      FAQ and gcc manual for more information on the -frepo option.<p>

  <li>The implementation of templates for g++ version 2.8
      eliminates the restriction against static data members
      in template classes.<p>

  <li>A final alternative is to
      remove the -fno-implicit-templates option from the CCFLAGS
      macro in your include/makeinclude/platform_macros.GNU, and
      thereby use the default g++ implicit template instantiation.<P>

  <LI>Thanks to Thilo Kielmann &lt<A
      HREF="mailto:kielmann@informatik.uni-siegen.de">
      kielmann@informatik.uni-siegen.de</A>&gt;
      for reporting the problem with ACE_Singleton on g++, and
      for helping to find and implement these solutions.<P>

  <LI>On VxWorks only, g++ (thru version 2.7.2, at least, distributed
      with Tornado 1.0.1/VxWorks 5.3.1), -fno-implicit-templates is
      broken.  In addition, -O2 is not supported on some targets.<P>

</UL>


<P><HR>
<H4><A NAME="egcs">Compiling ACE with egcs</A></H4>
<ul>
  <li>ACE transparently supports egcs, for the most part.  Please see
      <a href="#g++">Compiling ACE with g++</a> in this document.  And,
      please use the appropriate g++ config and platform files for the OS on
      which you will use egcs.<p>

  <li><strong><blink><font color="#ff0000">WARNING:</font></blink></strong>
      The default behavior of the ACE Makefiles is to add
      <code>-fno-exceptions</code> to egcs (and g++ starting with version
      2.8.0) invocations.  This disables exception handling support.  On
      Solaris/sparc and Linux/alpha, it results in a 25 percent reduction
      in the size of libACE.so.  To enable exception handling, add
      <code>exceptions=1</code> to your <code>make</code> command line
      invocation, or to your
      <code>$ACE_ROOT/include/makeinclude/platform_macros.GNU</code>.<p>

  <li>egcs may have trouble linking the ACE IOStream_Test if
      its static libraries are used.  It's best to build
      egcs with the <code>--enabled-shared</code> config option,
      so that it provides shared libraries.  Be sure to set your
      <code>LD_LIBRARY_PATH</code> environment variable, if necessary,
      to pick up those shared libraries.<p>

  <li>On DEC Alpha, egcs through version 1.03a, at least, may fail
      to build ACE if debugging (-g) is enabled.  The fix is to
      edit the egcs gcc/mips-file.c file, at line 976, and change
      <code>PAGE_SIZE</code> to 8192.  Then rebuild ACE.  Thanks to
      <a href="mailto:gpai@voicetek.com">Ganesh Pai</a> for this
      information.<p>
</ul>


<P><HR>
<H3><A NAME="aceinstall">Building and Installing ACE</A></H3>

The following explains how to build the ACE on <A
HREF="#unix">UNIX</A> and <A HREF="#win32">Win32</A>.

<H4><A NAME="unix">Building and Installing ACE on UNIX</A></H4>

Building and installing ACE on UNIX is relatively simple (the <A
HREF="#win32">process</A> for Win32 is different).  Here's what you
need to do:<P>

<OL>
  <LI> Install GNU make 3.7 or greater on your system (available via
      anonymous ftp from prep.ai.mit.edu in the pub/gnu directory).
      You <EM>must</EM> use GNU make or ACE won't compile.<P>

  <LI> Add an environment variable called ACE_ROOT that contains the
      name of the root of the directory where you keep the ACE wrapper
      source tree.  The ACE recursive Makefile scheme needs this information.
      There are several ways to set the ACE_ROOT variable.  For
      instance, in my .login file I have the following entry:<P>

      <pre><code>
      % setenv ACE_ROOT /home/cs/faculty/schmidt/ACE_wrappers
      </code></pre><P>

      However, if you're building a number of versions of ACE, e.g., for
      different OS platforms or for different releases of ACE, you might use
      the following approach:

      <pre><code>
      % setenv ACE_ROOT $cwd
      </code></pre>

  <LI> Edit the $ACE_ROOT/ace/OS.h file to update things like default
      hostname and port numbers you'd like the programs in the
      $ACE_ROOT/{apps,tests} directories to use by default.  Note,
      however that you can normally skip this step because the defaults
      are typically fine for most systems. <P>

  <LI> Create a <code>$ACE_ROOT/ace/config.h</code> file that includes
      the appropriate platform/compiler-specific header configurations
      (such as <code>config-sunos5-sunc++-4.x.h</code>).  This file
      contains the #defines that
      are used throughout ACE to indicate which features your system
      supports (see the <code>$ACE_ROOT/ace/OS.h</code> file for many
      examples of how the ACE build configuration is affected by these
      macro settings).  Make sure you settings are placed
      <strong>before</strong> the inclusion of the platform-specific
      header file.<P>

      There are config files for most versions of UNIX.  If there isn't a
      version of this file that matches your platform/compiler, you'll
      need to make one.  Please send me email if you get it working so I
      can add it to the master ACE release.<P>

  <LI> Set the $ACE_ROOT/include/makeinclude/platform_macros.GNU file
      to point to the appropriate platform/compiler-specific Makefile
      configurations, e.g., platform_sunos5_sunc++.GNU.  This file
      contains the compiler and Makefile directives that are
      platform/compiler-specific<P>

  <LI> Note that since ACE builds shared libraries, you'll need to set
      LD_LIBRARY_PATH to whereever you put the binary version of the
      ACE library.  For example, you probably want to do something like
      the following<P>

      <pre><code>
      % setenv LD_LIBRARY_PATH $ACE_ROOT/ace:$LD_LIBRARY_PATH
      </code></pre><P>

  <LI> When all this is done, hopefully all you'll need to do is type:<P>

      <pre><code>
      % make
      </code></pre><P>

      at the root of the ACE source tree.  This will build the ACE library,
      tests, the examples, and the sample applications.  Building the entire
      ACE release can take a long time, however.  Therefore, you might
      consider cd'ing into the $ACE_ROOT/ace/ directory and running
      <CODE>make</CODE> there to build just the ACE library.  As a sanity
      check, you might also want to build and run the automated <A
      HREF="http://www.cs.wustl.edu/~schmidt/ACE_wrappers/tests/README">``one-button'' tests</A> in
      $ACE_ROOT/tests/.<P>

  <LI> If you need to regenerate the Svc_Conf_y.cpp file, you'll need to
      get <A HREF="http://www.cs.wustl.edu/~schmidt/byacc.tar.gz">Berkeley
      YACC</A>.  However, you should rarely, if ever, need to do this.<P>

</OL>

<P><HR><P>
<H4><A NAME="win32">Building and Installing ACE on Win32</A></H4>

ACE contains project files for Microsoft Visual C++ 4.x (*.mdp) and
5.0 with Service Pack 2 or 3 (*.dsw), as well as Borland C++ 5.x (ace.ide).
<P>

There are also project group files (BPG) to compile ACE and the
one-button tests with Borland C++ Builder 3.0. This port has not
been completed yet, so basically you are on your own here. The
port was started by <A HREF="mailto:gonzo@ing.puc.cl">
Gonzalo A. Diethelm</A>, so contact him for any further directions.<P>

<EM>Note concerning MSVC 5.0 and Service Pack 3:</EM> There has been
confusion regarding MSVC 5 and its Service Pack 3.  Some ACE
users have, in the past, had problems with SP3 that were not present in SP2.
Thanks to the diligent efforts of
<A HREF="mailto:fultonb@pcnet1.ascs.aro.allied.com">Bill Fulton</A>,
the mystery appears to be solved.
The key?  (Oh, this is a good one...) It would appear that there are
actually multiple versions of SP3 in existence.  The
earlier ones have the bug, while later ones have it fixed.  The service
pack downloadable from Microsoft's web site as of June 16, 1998 works fine.
The CD containing SP3, if it has part number X03-50158 on the disc (the part
number on the jacket is probably different), also works fine.
<P>
So, if you are experiencing problems with SP3, get a newer one - it'll
probably work.  Sheesh...
<P>
Note, however, that regardless of the version of SP3,
there are some STL bugs in SP3 which you should get corrected.  Please see
<A HREF="http://www.dinkumware.com/vc_fixes.html">
http://www.dinkumware.com/vc_fixes.html</A> for details.
Thank you to <A HREF="mailto:ben@jetpen.com">Ben Eng</A> for the pointer to
the STL fixes.

<OL>
  <LI> Create a directory, e.g., C:\ACE, and copy all of the ACE
      distribution into it.  This directory will be referred to as
      ACE_ROOT in the rest of this discussion.<BR><BR>
  <LI> Create a file called config.h in the ACE_ROOT\ace directory
      that contains: <BR>
      <BR>
      <CODE>#include "ace/config-win32.h"</CODE><BR>
      <BR>
  <LI> Now load up the project file for ACE (ACE_ROOT\ace\ACE_Library.mdp or
      ACE_ROOT\ace\ace.dsw). <BR><BR>
  <LI> Each project will contain 8 different configurations.  These
      are a mixture of Debug/Release, Unicode/non-Unicode, and
      Static/Dynamic library versions for both i386 and Alpha machines.
      <STRONG>Note:</STRONG> If you
      use the dynamic libraries, make sure you include ACE_ROOT\ace
      in your PATH whenever you run programs that use ACE.<BR><BR>
  <LI> If you are building for Windows NT then you can start building
      now.  If you are building on Windows 95, then you should add
      the line <BR>
      <BR>
      <CODE>#define ACE_HAS_WINNT4 0</CODE><BR>
      <BR>
      before the #include statement in ACE_ROOT\ace\config.h and it
      will turn off Windows NT 4 specific code.<BR>
      <BR>
      If you want to use the standard C++ headers (iostream, cstdio, ...
      as defined by the C++ Standard Draft 2) that comes with MSVC 5,
      then add the line <BR>
      <BR>
      <CODE>#define ACE_HAS_STANDARD_CPP_LIBRARY 1</CODE><BR>
      <BR>
      before the #include statement in ACE_ROOT\ace\config.h.<BR>
      If you are building for Windows CE, you need to add the line <BR>
      <br>
      <code>#define ACE_HAS_WINCE</code>
      <br>
      before including &lt;ace/config-win32.h&gt;.  Notice that CE uses a
      different set of dsw/dsp files.<br> <br>

      The default project files which build ACE library have various
      configurations to build dynamic/static, with or without Unicode
      support.  Although we recommend using the dynamic library, if,
      for some reasons, you would rather work with static library,
      you'll need to add the line <BR>
      <BR>
      <CODE>#define ACE_HAS_DLL 0</CODE><BR>
      <BR>
      before the #include statement in ACE_ROOT\ace\config.h.
      Optionally but highly recommended, you can also add the line <BR>
      <BR>
      <CODE>#define __ACE_INLINE__ 0</CODE><BR>
      <BR>
      before the #include statement in ACE_ROOT\ace\config.h to disable
      inline function and reduce the size of static libraries (and your
      executables.)<BR><BR>
</Ol>

<B>ACE TESTS</B><P>

The tests are located in ACE_ROOT\tests.  There are two corresponding
project files in that directory also (tests.mdp and tests.dsp).<P>

Once you build all the tests (Batch Build works well for this) you can
run the batch file run_tests.bat in that directory to try all the
tests.<P>

<B> BUILDING ACE ON A WIN32 MACHINE THAT LACKS A NETWORK CARD </B><P>

You may want to run ACE on a non-networked machine. To do so, you must
install TCP/IP and configure it to ignore the absence of a network
card.  This is one method:<P>

<OL>
  <LI>  Run Control Panel
  <LI>  Choose Network from Control Panel
  <LI>  Add Adapter: MS Loopback Adapter
  <LI>  Configure MS Loopback Adapter with 802.3 (default)
  <LI>  Add Protocol: TCP/IP Protocol
  <LI>  Configure TCP/IP Protocol with a valid IP address and subnet mask.
      Leave everything else at the default settings.
  <LI>  Add Service: Workstation
  <LI>  Exit and Restart System
  <LI>  Run Control Panel again
  <LI> Choose Services from Control Panel
  <LI> The following services are not necessary and may
      be set to Disabled Startup: <BR>
      Alerter<BR>
      Computer Browser<BR>
      Net logon<BR>
      Messanger<BR>
  <LI> Choose Network from Control Panel
  <LI> Confirm the following setup. This is all you need to run ACE:<BR>
      Installed Software:<BR>
      Computer Browser<BR>
      MS Loopback Adapter Driver<BR>
      TCP/IP Protocol<BR>
      Workstation<BR>
      Installed Adapter Cards:<BR>
      MS Loopback Adapter<P>
</OL>

<B>ALPHA CONFIGURATIONS</B><P>

<P>Many project files already contain Alpha NT configurations.  For those that
do not, follow these steps to add them.</P>

<OL>
  <LI>Load the project on the Alpha machine.
  <LI>Go to the Build menu and then Configurations.
  <LI>Select the project that you want to convert.
  <LI>Click on Add.
  <LI>Select the x86 configuration to &quot;Copy settings from&qout; 
      (either Debug or Release versions).
  <LI>Prepend &quot;Alpha &quot; to the beginning of the name under 
      &quot;Configuration&quot;.
  <LI>Click OK.
  <LI>Close the &quot;Configurations&quot; window.
  <LI>Now go to the Project settings.
  <LI>For the General Settings, change the output directories to standard ACE
      output directores. Intermediate Directories are &quot;Debug&quot; and 
	  &quot;Release&quot; in most cases.  The Output Directories are blank,
	  except for Release versions of executables, in which it is also 
	  &quot;Release&quot;.
  <LI>For the C/C++ Settings, make sure that the Code Generation's runtime
      library is set to &quot;Multithreaded DLL&quot; or &quot;Debug Multithreaded 
	  DLL&quot;.
</OL>

<HR>
<H4><A NAME="vxworks">Building and Installing ACE on VxWorks</A></H4>
For the most part, you should be able to follow the instructions above
to build ACE and applications that use it.  Start with the
<a href="#unix">Unix instructions</a> above to build ACE and the
applications that use it.  Please see below for mroe information on
<a href="#VxWorks/NT">building ACE on NT hosts for VxWorks targets</a>.<P>

A few notes on VxWorks builds (thanks to
<a href="mailto:Paul_von_Behren@stortek.com">Paul von Behren</a>
for these notes):<p>
<UL>
  <LI>VxWorks builds are done with a cross compiler, i.e., the compiles
      are done on a workstation creating object modules which are
      downloaded and loaded into the VxWorks target system.<p>
  <LI>C++ object modules must be post-processed by a VxWorks
      utility called ``munch.''  ACE includes a perl script called
      <A
      HREF="http://www.cs.wustl.edu/~schmidt/ACE_wrappers/bin/ace_ld">$ACE_ROOT/bin/ace_ld</A>,
      which is called from the Makefiles, replacing
      the traditional <code>ld</code> step.  You must have Perl installed
      to use <code>ace_ld</code>. <P>

  <LI>Wind River provides GCC/G++ cross-compilers for the
      supported target platforms.  The executables are named cc&lt;target&gt;
      and g++&lt;target&gt;; for example, ccppc and g++cpp for PowerPC targets.
</UL>

You'll have to let ACE know the target type at compile time.
There are several ways to do this; please see the
$ACE_ROOT/include/makeinclude/platform_vxworks5.x_g++.GNU
platform file for detailed information.<P>

The VxWorks platform_vxworks*.GNU files are set up so that shared
libraries are not built on VxWorks.  Only static libraries,
with .a extension, are built.  Therefore, it's not necessary
to set the LD_LIBRARY_PATH environment variable on your host
system when building for VxWorks targets.  Please note, however,
if you use TAO on VxWorks that you will need to set your LD_LIBRARY_PATH
to find the TAO IDL compiler libraries (installed in the ace directory)
on the host.<P>

With g++, $ACE_ROOT/bin/ace_ld is used to munch object files and
libraries to set up calls to static constructors and destructors.
bin/ace_ld requires perl on the host platform.<P>

These non-default VxWorks kernel configuration <code>#defines</code>
are required with ACE:<P>

<pre>
#define INCLUDE_CPLUS           /* include C++ support */
#define INCLUDE_CPLUS_IOSTREAMS /* include iostreams classes */
#define INCLUDE_POSIX_ALL       /* include all available POSIX functions */
</pre>

For completeness, here are the non-default <code>#defines</code> that
we used for VxWorks 5.3.1/g++ 2.7.2:

<pre>
#define INCLUDE_CPLUS           /* include C++ support */
#define INCLUDE_CPLUS_IOSTREAMS /* include iostreams classes */
#define INCLUDE_CONFIGURATION_5_2 /* pre-tornado tools */
#define INCLUDE_DEBUG           /* pre-tornado debugging */
#define INCLUDE_LOADER          /* object module loading */
#define INCLUDE_NET_SYM_TBL     /* load symbol table from network */
#define INCLUDE_SYM_TBL_SYNC    /* synchronize host and target symbol tables */
#define INCLUDE_NFS             /* nfs package */
#define INCLUDE_PING            /* ping() utility */
#define INCLUDE_POSIX_ALL       /* include all available POSIX functions */
#define INCLUDE_RDB             /* remote debugging package */
#define INCLUDE_RLOGIN          /* remote login */
#define INCLUDE_RPC             /* rpc package */
#define INCLUDE_SECURITY        /* shell security for network access */
#define INCLUDE_SHELL           /* interactive c-expression interpreter */
#define INCLUDE_SHOW_ROUTINES   /* show routines for system facilities*/
#define INCLUDE_SPY             /* spyLib for task monitoring */
#define INCLUDE_STARTUP_SCRIPT  /* execute start-up script */
#define INCLUDE_STAT_SYM_TBL    /* create user-readable error status */
#define INCLUDE_SYM_TBL         /* symbol table package */
#define INCLUDE_UNLOADER        /* object module unloading */
#define INCLUDE_WINDVIEW        /* WindView command server */
</pre>

If you use TAO, it's also a good idea to increase the
<code>NUM_FILES</code> parameter from its default of 50 to,
say, 1000.<p>

Please note that those VxWorks kernel configuration parameters
are set in the VxWorks configAll.h file.  You must rebuild your
VxWorks kernel after modifying that file.<p>

It probably wouldn't take much effort to modify the
ACE library to not require <code>INCLUDE_CPLUS_IOSTREAMS</code>,
if necessary.<p>

If you're first getting started with ACE and/or VxWorks, I recommend
just building the ACE library and tests first.  (Some of the ACE
examples, in System_V_IPC, don't build on VxWorks yet.)  Then try
running the tests.  Please see $ACE_ROOT/tests/README for the latest
status of the ACE tests on VxWorks.<P>

Please note that the <code>main</code> entry point is renamed to
<code>ace_main</code> (configurable via ACE_MAIN) on VxWorks with g++,
to comply with its restriction against using <code>main</code>.
In addition, ACE_HAS_NONSTATIC_OBJECT_MANAGER is enabled by default
to cleanly support construction and destruction of static objects.
This requires that <code>main</code> be declared with its arguments
even if they're not used, and with <code>int</code> return type:

<pre><code>
int
main (int, char *[])
</code></pre>

Alternatively, this feature can be disabled by commenting out the
#define ACE_HAS_NONSTATIC_OBJECT_MANAGER in your ace/config.h.
But, that will make repeated testing more difficult on VxWorks.
You'd either have to call static constructors and destructors
manually or unload/load the program between runs.<p>

<strong><blink><font color="#ff0000">WARNING:</font></blink></strong>
ACE on VxWorks assumes that your <code>main</code> function is named
<code>main</code> when using ACE_HAS_NONSTATIC_OBJECT_MANAGER.  Any
violation of this assumption is at your peril.  If you really need to
call your entry point something other than <code>main</code>, you'll
need to construct an ACE_Object_Manager.  Please see the
<code>#define</code> of <code>main (int, char *[])</code> in
<code>ace/OS.h</code> to see how ACE does that for entry points named
<code>main</code>.<p>

ACE threads (VxWorks tasks) can be named, for example, by supplying a
non-null argument to the Thread_Manager spawn routines.  However,
names beginning with <code>"==ace_t=="</code> are forbidden because
that prefix is used internally by ACE.<p>

You can spawn a new task to run <code>ace_main</code>, using either
VxWorks <code>sp</code>, or ACE'S <A NAME="spa"><code>spa</code></A>.
<code>spa</code> can be used from the VxWorks shell to pass arguments
to <code>ace_main</code>.  Its usage is:

<pre><code>
spa ace_main, "arg1" [, ...]
</code></pre>

All arguments must be quoted, even numbers.<p>

By default, the ACE Makefiles link the ACE library into every
executable.  If you want to run multiple ACE executables but just use
a single ACE library, it should be possible, though I haven't tried
it.  Just link the first executable to be loaded onto the target with
the ACE library, as usual.  All other executables can be linked
without the ACE library by added <code>ACELIB=</code> to the make
invocation when building them.  When they are loaded onto the target,
the should load against the symbols from the ACE library from the
first executable that was loaded.<p>

<h5><a name="VxWorks/NT">Building ACE on Tornado/NT hosts for VxWorks targets</a>.</h5>
The following, very useful information was contributed by
<a href="http://people.qualcomm.com/cryan">Chris Ryan</a>
and <a href="mailto:Paul_von_Behren@stortek.com">Paul von Behren</a>.
Please submit corrections, additions, or clarifications to the
the <a href="mailto:ace-users@cs.wustl.edu">ACE mailing list</a>.<p>

A few additional Windows Notes, from Paul von Behren:<p>
<UL>
  <LI>Cygnus has created a Win32 API which is compatible with a
      ``generic'' Unix environment.  Using this library, they have ported a
      large collection of GNU tools to WinNT/95 - including a port of
      gcc/g++.  See <A href="http://www.cygnus.com/miscgni-win32/">
      http://www.cygnus.com/miscgni-win32/</A>
      WindRiver provides a subset of these tools - including make
      and gcc cross-compilers.<p>
  <LI>To set up the command-prompt build environemnt, run
      <code>Tornado\host\x86-win32\bin\TorVars.bat</code>.  This is done
      implicitly within the Tornado IDE.<p>
  <LI>To run <code>ace_ld</code>, you still need perl installed -
      see <A href="http://www.activestate.com/software/default.htm">
      http://www.activestate.com/software/default.htm</A> for Windows
      perl.<p>
  <LI>There's a bug in the windows port of Make (or at least an
      incompatability) related to ACE Make's directory-spanning
      logic (<code>ACE_ROOT\include\makeinclude\rules.nested.GNU</code>
      (the error message says something about "dir unexpected").<p>
  <LI>But make does work in "leaf" directories (those with no
      subdirectries).  You can make the <code>ACE_ROOT\ace directory</code>
      creating the library libACE.a.  If perl is available, make also works
      in the ACE_ROOT\tests directory (ignore the final error
      attempting to run /bin/true).<p>
  <LI>The Tornado IDE will use a standard Makefile for project
      builds, but does not have a GUI interface for managing the
      Makefile.  By default, it will use rules from Makefile in the current
      directory and you can configure it to add certain Makefile
      targets to the project.  If you have <code>ACE_ROOT</code> defined
      before starting Tornado, you can specify an ACE Makefile as a Tornado
      target and Tornado will then call make from the menu.<p>
</UL>

And Chris Ryan's instructions for building for VxWorks targets
on Windows NT hosts:

<ol>
  <li>Create UNIX-like environment in NT Command Prompt windows by
      downloading GNU bash, perl, and so forth from your favorite ftp
      site. I went to <a href="ftp://ftp.cygnus.com/pub/gnu-win32/latest/">ftp://ftp.cygnus.com/pub/gnu-win32/latest/</a>
      and downloaded <code>cdk.exe</code> and installed that on my NT box.
      I downloaded perl5.0 from where I can't remember.  There may have been
      bits and pieces from other places for things like <code>vi</code> and
      <code>less</code>.

  <li>Download latest ACE.  Create 2 parallel trees, say
      <code>/ace/ACE_wrappers.NT</code> and
      <code>/ace/ACE_wrappers.vxworks</code>.  The NT tree is for building
      <code>aced.dll</code> and <code>tao_idl.exe</code> as currently
      documented for ACE/TAO on NT/VC++5.0. The VxWorks tree is the
      cross compilation tree.

  <li>Path setting that seems to be working is:<p>
      <pre>
      /tornado/host/x86-win32/bin:
      /tornado/host/x86-win32/lib/gcc-lib/i386-wrs-vxworks/cygnus-2.7.2-960126:
      /tornado/host/x86-win32/i386-wrs-vxworks/bin:
      /ace/ace_wrappers/bin:
      /gnuwin32/b18/H-i386-cygwin32/bin:
      /gnuwin32/b18/tcl/bin:
      /WINNT/system32:
      /WINNT:
      /WINNT/system32/nls/ENGLISH:
      /bin
      </pre>

      Other environment variables:<p>
      <pre>
      WIND_BASE=/tornado
      SHELL=/bin/sh.exe
      TERM=pcbios
      TAO_ROOT=/ace/ACE_wrappers.vxworks/TAO
      CPP_LOCATION=/Program Files/DevStudio/VC/bin/CL.EXE
      GCC_EXEC_PREFIX=/tornado/host/x86-win32/lib/gcc-lib/
      WIND_HOST_TYPE=x86-win32
      ACE_ROOT=/ace/ACE_wrappers.vxworks
      </pre>

  <li><code>/tornado</code> is the root of the Tornado install
      (<code>$WIND_BASE</code>).

  <li><code>/gnuwin32</code> is the root of a Cygnus GNU download and install.

  <li><code>/bin</code> content is:<p>
      <pre>
      aced.dll
      cygwin.dll
      perl.exe
      rm.exe
      sh.exe
      true
      </pre>

      <code>aced.dll</code> is produced in an ACE NT source tree according to
      documented procedure for NT VC++5.0 ACE build.

      <code>cygwin.dll</code> is from the Cygnus GNU software download and install.

  <li>Basically, follow documented procedure for ACE build/install on UNIX
      platform. Create a <code>$ACE_ROOT/ace/config.h</code> that looks like:<p>
      <pre>
      #define __ACE_INLINE__ 0
      #define ACE_HAS_DLL 0
      #include "config-vxworks5.x.h"
      </pre>

      And create a <code>$ACE_ROOT/include/makeinclude/platform_macros.GNU</code>
      that looks like:<p>
      <pre>
      WIND_BASE = /tornado
      WIND_HOST_TYPE = x86-win32
      PATH += :$(WIND_BASE)/host/$(WIND_HOST_TYPE)/bin
      CPU = I80486
      include $(ACE_ROOT)/include/makeinclude/platform_NTvxworks5.x_g++.GNU
      </pre>

      (But, I guess the PATH+= line is superfluous based on the PATH as shown
      previously).

      Finally, create a
      <code>$ACE_ROOT/include/makeinclude/platform_NTvxworks5.x_g++.GNU</code>
      with diff output from 'diff platform_vxworks5.x_g++.GNU
      platform_NTvxworks5.x_g++.GNU' that looks like:

      <pre>
      58c58
      &lt; HOST_DIR        = $(WIND_BASE)/host/sun4-solaris2
      ---
      &gt; HOST_DIR        = $(WIND_BASE)/host/x86-win32
      62,63c62,63
      &lt; CXX             = g++$(TOOLENV)
      &lt; CFLAGS          += -DVXWORKS -D_REENTRANT -ansi -fno-builtin
      -fno-defer-pop -fvolatile -nostdinc -nostdlib -pipe -Wall
      ---
      &gt; CXX             = $(CC)
      &gt; CFLAGS          += -DVXWORKS -D_REENTRANT -ansi -fno-builtin -fno-defer-pop \
      -fvolatile -nostdinc -nostdlib -Wall #-pipe
      </pre>

  <li>Now, follow the existing documentation for a UNIX platform build of ACE
      such as:
      <pre>
      cd $ACE_ROOT/ace; make
      </pre>

  <li>To build $ACE_ROOT/tests, I had to use the <code>make.exe</code> in the
      <code>/gnuwin32/b18/H-i386-cygwin32/bin</code> directory as I couldn't get
      make shipped with Tornado to run ace_ld and I couldn't figure out any
      other work around.<p>

      <pre>
      cd $ACE_ROOT/tests; /gnuwin32/b18/H-i386-cygwin32/bin/make
      </pre>

      Also, running the tests works as already documented.
</ol>

<h5>TAO on NT Tornado host, VxWorks target.</h5>

<ol>
  <li>Build ACE and TAO_IDL in the NT tree as already documented. As
      mentioned above, I put <code>aced.dll</code> in <code>/bin</code>.

  <li>Copy TAO_IDL/tao_idl.exe to TAO_IDL directory in the ACE/TAO vxworks
      source tree. (I didn't spend any time yet looking for the place where the
      makefiles are using the absolute path to tao_idl.exe.)

  <li>Build orbsvcs.
      <pre>
      CPP_LOCATION=/Program Files/DevStudio/VC/bin/CL.exe
      cd $TAO_ROOT/orbsvcs/orbsvcs
      /gnuwin32/b18/H-i386-cygwin32/bin/make
      </pre>

  <li>Build $TAO_ROOT/tao
      <pre>
      CPP_LOCATION=/Program Files/DevStudio/VC/bin/CL.exe
      cd $TAO_ROOT/tao
      /gnuwin32/b18/H-i386-cygwin32/bin/make
      </pre>

  <li>Build $TAO_ROOT/tests
</ol>


<HR>
<H3><A NAME="svcsinstall">Building and Installing ACE Network Services</A></H3>

The following explains how to build the ACE <A
HREF="http://www.cs.wustl.edu/~schmidt/ACE-netsvcs.html">network services</A> on <A
HREF="#unixsvcs">UNIX</A> and <A HREF="#win32svcs">Win32</A>.

<H4><A NAME="unixsvcs">Building and Installing ACE Network Services on UNIX</A></H4>

Building and installing ACE Network Services on UNIX is relatively
simple (the <A HREF="#win32svcs">process</A> for Win32 is different).
Here's what you need to do:<P>

<OL>

  <LI> Build and install ACE on UNIX as described <A
      HREF="#unix">earlier</A>.  If ACE is built at the root of the ACE
      source tree (and ACE has been ported to your platform, of course) the
      netsvcs static and shared object libraries should be built
      automatically.  In addition, the server driver program
      (<CODE>main</CODE>) contained in <A
      HREF="http://www.cs.wustl.edu/~schmidt/ACE_wrappers/netsvcs/servers/main.cpp">
      $ACE_ROOT/netsvcs/servers/main.cpp</A> should also be compiled and ready to run.<P>

  <LI> Set your LD_LIBRARY_PATH environment variable to where the binary
      version of the ACE netsvcs library.  For example, you probably
      want to do something like the following<P>

      <pre><code>
      % setenv LD_LIBRARY_PATH $ACE_ROOT/ace:$LD_LIBRARY_PATH
      </code></pre><P>

  <LI>By default, if the shared object library is built, the services
      are linked into the <CODE>main</CODE> driver program dynamically.
      To specify which services should be linked in and executed, edit the
      <A
      HREF="http://www.cs.wustl.edu/~schmidt/ACE_wrappers/netsvcs/servers/svc.conf">
      $ACE_ROOT/netsvcs/servers/svc.conf</A> file.  During your editing,
      you should update information (such as the default service port
      numbers) that affects the initialization of services in this
      file.  Refer to the <A HREF="ACE-papers.html#config">Service Configurator</A>
      documentation to learn how the configuration file is parsed and
      how the services are dynamically linked and executed.  In
      addition, refer to the <A HREF="ACE-netsvcs.html">Network
      Services</A> documentation to learn more about how to configure
      each network service.<P>

  <LI>If you only want to link the services statically, simply remove
      or rename the svc.conf file.<P>
</OL>

<H4><A NAME="win32svcs">Building and Installing ACE Network Services on Win32</A></H4>

Once again, there are supplied project for both MSVC 4.x and 5.0 for
the Network Services.<P>

If you are using MSVC 4.x, you will need to add another directory to
your global include and library paths, ACE_ROOT/netsvcs/lib.  When you
use the dynamic libraries, make sure to also include ACE_ROOT/netsvcs/lib
in your PATH.<P>

<HR><P>
<H3><A NAME="advanced">Advanced Topics</A></H3>

<UL>
  <LI><A
      HREF="http://www.cs.wustl.edu/~schmidt/ACE_wrappers/etc/ACE-porting.html">Porting ACE and TAO to a New OS Platform</A>
  <LI><A HREF="#cloning">Cloning the Source Tree</A>
  <LI><A HREF="#corba">Building CORBA Versions of ACE</A>
  <LI><A HREF="#mvs">Additional Build Tips for MVS</A>
  <LI><A HREF="#flags">Makfile Flags</A>
  <LI><A HREF="http://www.cs.wustl.edu/~levine/CVS.html">Version Control</A>
  <LI><A HREF="http://www.cs.wustl.edu/~cleeland/ace/makefile-hints.html">ACE Makefile hints</a>
</UL>

<H4><A NAME="cloning">Cloning the Source Tree</A></H4>

On UNIX platforms, I typically like to support multiple platform
builds using the same ACE source tree.  This idiom is supported by ACE
using the $(ACE_ROOT)/bin/clone.c program.  To build clone,
perform the following steps:<P>

<pre>
% cd $ACE_ROOT/bin
% make
% mv clone ~/bin
% rehash
</pre><P>

Then create a ./build subdirectory someplace, e.g., under
$ACE_ROOT, and then invoke the top-level Makefile with the
``clone'' target, e.g.:<P>

<pre>
% cd $ACE_ROOT
% mkdir build-SunOS5
% cd build-SunOS5
% make -f ../Makefile clone
% (cd ace; echo "\#include "ace/config-sunos5.5-g++.h" > config.h)
% (cd include/makeincludes; ln -s platform_sunos5-g++.h platform_macros.GNU)
% setenv ACE_ROOT $cwd
% make
</pre><P>

This will establish a complete tree of links.  Note that you must
build a config.h and platform_macros.GNU in cloned directory.  In
addition, make sure you set your LD_LIBRARY_PATH to
$ACE_ROOT/ace:$LD_LIBRARY_PATH on SVR4 UNIX platforms.<P>

When you do a make in the $ACE_ROOT directory you will be producing
object code that is not stored in the same place as the original
source tree.  This way, you can easily build another platform in a
parallel tree structure.<P>

<B> VERY IMPORTANT! </B><P>

If you use the ``clone trick'' discussed above, make sure that the
symbolic links are correctly in place before starting the build.  In
particular, if you plan to clone the tree, it is preferable to do so
before you start a build procedure on the original tree.  This is
because the build procedure create object directories (.obj and
.shobj) and the cloning procedure will clone these directories also.
You would end up with links pointing to object files of another
platform.  If you clone the tree after you've done a build on the
original tree, make sure to remove all ".obj", ".shobj" and (any other
files or directories) in all subdirectories before starting the build
on your cloned tree.<P>

Alternatively, the perl script
<code>ACE_wrappers/bin/create_ace_build</code> can be used to create
build trees.  It creates them below <code>ACE_wrappers/build</code>.
It filters out all but the necessary files, so the warning above does
not apply.  See the comments at the top of the script itself for usage
information.

<HR><P>
<H4><A NAME="corba">Building CORBA Versions of ACE</A></H4>

Note that if you are compiling with IONA's Orbix implementation of
CORBA or Visigenix's implementation of CORBA, you'll also need to set
ORBIX_ROOT to point to the root of the Orbix source tree and
ORBELINE_ROOT to point to the root of the ORBeline source tree.  Since
many platforms don't have these CORBA tools the default for ACE does
*not* incorporate them.  Thus, if you are compiling with Orbix or
ORBeline, make sure that you set up
$ACE_ROOT/include/makeinclude/platform_macros.GNU and
$ACE_ROOT/ace/config.h to use the config* and platform*
files that have "-orbix" in them!

<P><HR><P>
<H4><A NAME="mvs">Additional Build Tips for MVS</A></H4>

For all intents and purpose, MVS OpenEdition (OE) is another flavor of
UNIX, therefore, the instructions under <A HREF="#aceinstall">Building
and Installing ACE on Unix</A> can be used along with the following
additional tips:<P>

You can get a copy of GNU make that has been ported to MVS OpenEdition from
the <A HREF="http://www.s390.ibm.com/products/oe/index.html">IBM OpenEdition web site</A>.
ACE's make scheme generates compile commands that have options and
operands interspersed.  By default, the c89/cc/c++ compiler expects all options to
precede all operands.  To get around this, you must set a special
compiler environment variable (_CXX_CCMODE) to 1 which tells the compiler
to allow options and operands to be interspersed.<P>

Note that the environment variable LD_LIBRARY_PATH is called LIBPATH
on MVS.<P>

Shared objects are built a little different on MVS than on
other UNIX implementations.  This has been accounted for in the makefiles
that come with ACE   When the linker (via the cxx command) builds the
libACE.so file it will also create a file called libACE.x.  This is a
side-deck file and it must be included in subsequent link edits with
application code.  For more information on this see the C/C++ MVS
Programming Guide.  If you want to build your application statically,
i.e., using libACE.a instead of libACE.so, you can set ACELIB to
ACELIB_STATIC in platform_mvs.GNU.<P>

When the libACE.so file is built (via the MVS pre-linker and binder), you
will get a rc=4 from the pre-linker.  This is ok.  This is due to some
warnings about unresolved references which should get resolved during the
link step.  Note, however, there shouldn't be any unresolved references
from the binder (linkage editor).   You can get pre-link and link maps by
uncommenting the PMAP and LMAP lines in the platform_mvs.GNU file.<P>

<HR><P>
<H4><A NAME="flags">Makefile Flags</A></H4>

ACE supports the following flags.  They can be enabled either on the command
line, e.g., "make purify=1", or added to your platform_macros.GNU.  To
disable the option, set the flag to null, e.g., "make debug=".  Some flags
support setting to 0 disable, e.g., "make debug=0".  debug=1 is enabled in
the platform files that are released with ACE.<P>

Please note that the effects of a flag may be platform specific.
Also, combinations of certain flags may or may not be allowed on
specific platforms, e.g., debug=1 opt=1 is supported by g++ but
not all other C++ compilers.<P>

<PRE>
Flag             Description
----             -----------
debug            Enable debugging; see DCFLAGS and DCCFLAGS.
exceptions       Enable exception handling (not supported by all platforms).
fast             Enable -fast option, e.g., with Sun C++.
inline           Enable ACE inlining.  Some platforms enable inlining by
default, others do not.
optimize         Enable optimization; see OCFLAGS and OCCFLAGS.
orbix            Enable use of Orbix.
probe            Enable ACE_Timeprobes.
profile          Enable profiling; see PCFLAGS and PCCFLAGS.
purify           Purify all executables.
quantify         Quantify all executables.
repo             Use GNU template repository (g++ with repo patches and
                   egcs only).
rtti             Enable run-time type identification.  On some platforms,
                   it is enabled by default, so this is ignored.  It is
                   only currently supported with Sun C++.
shared_libs      Build shared libraries. Ignored if static_libs_only is set.
static_libs      Build shared libraries. Ignored if shared_libs_only is set.
shared_libs_only Only build shared libraries.  Ignored if no SHLIBs are
specified by the Makefile, as in performance-tests/Misc.
static_libs_only Only build static libraries.
threads          Build with thread support.
xt_reactor       Build the XtReactor.

Usually, users do not need to be concerned with make targets.
Just enter ``make'' on the command line to build.  A few notable
targets are listed below.

Target             Description
------             -----------
show_statics       Lists all static objects in object files built for
current directory.  Only supported for g++.
show_uninit        Lists all uninitialized in object files built for
current directory.  Only supported for g++.

</PRE>
<HR><P>

Back to the <A HREF="http://www.cs.wustl.edu/~schmidt/ACE.html">ACE</A>
home page.

<!--#include virtual="/~schmidt/cgi-sig.html" -->
</BODY>
</HTML>