add better pod and headers, and clean up some whitespace issues in the previous patches
[perl.git] / README.aix
1 If you read this file _as_is_, just ignore the funny characters you see.
2 It is written in the POD format (see pod/perlpod.pod) which is specially
3 designed to be readable as is.
4
5 =head1 NAME
6
7 README.aix - Perl version 5 on IBM Unix (AIX) systems
8
9 =head1 DESCRIPTION
10
11 This document describes various features of IBM's Unix operating
12 system (AIX) that will affect how Perl version 5 (hereafter just Perl)
13 is compiled and/or runs.
14
15 =head2 Compiling Perl 5 on AIX
16
17 For information on compilers on older versions of AIX, see L<Compiling 
18 Perl 5 on older AIX versions up to 4.3.3>.
19
20 When compiling Perl, you must use an ANSI C compiler. AIX does not ship
21 an ANSI compliant C-compiler with AIX by default, but binary builds of
22 gcc for AIX are widely available.
23
24 =head2 Supported Compilers
25
26 Currently all versions of IBM's "xlc", "xlc_r", "cc", "cc_r" or
27 "vac" ANSI/C compiler will work for building Perl if that compiler
28 works on your system.
29
30 If you plan to link Perl to any module that requires thread-support,
31 like DBD::Oracle, it is better to use the _r version of the compiler.
32 This will not build a threaded Perl, but a thread-enabled Perl. See
33 also L<Threaded Perl> later on.
34
35 As of writing (2008-11) only the IBM XL C for AIX or XL C/C++ for AIX
36 compiler is supported by IBM on AIX 5L/6.1.
37
38 The following compiler versions are supported by IBM:
39
40 XL C and XL C/C++ V7, V8, V9, V10
41
42 The XL C for AIX is integrated in the XL C/C++ for AIX compiler.
43
44 If you choose XL C/C++ V9 you need APAR IZ35785 installed 
45 otherwise the integrated SDBM_File do not compile correctly due 
46 to an optimization bug. You can circumvent this problem by 
47 adding -qipa to the optimization flags (-Doptimize='-O -qipa'). 
48 The PTF for APAR IZ35785 which solves this problem will be available 
49 in 1Q 2009. IBM does provide an emergency fix for this problem.
50
51 Perl can be compiled with either IBM's ANSI C compiler or with gcc. 
52 The former is recommended, as not only it can compile Perl with no 
53 difficulty, but also can take advantage of features listed later 
54 that require the use of IBM compiler-specific command-line flags.
55
56 If you decide to use gcc, make sure your installation is recent and 
57 complete, and be sure to read the Perl INSTALL file for more gcc-specific 
58 details. Please report any hoops you had to jump through to the 
59 development team.
60
61 =head2 Perl 5.8.9 was successfully compiled and tested on:
62  
63     AIX Level                 | Compiler Level          | w th | w/o th
64     --------------------------+-------------------------+------+-------
65     5.1 TL9 32 bit            | XL C/C++ V7             | OK   | OK
66     5.1 TL9 32 bit            | gcc 3.2.2               | OK   | OK
67     5.1 TL9 64 bit            | XL C/C++ V7             | OK   | OK
68     5.2 TL10 32 bit           | XL C/C++ V8             | OK   | OK
69     5.2 TL10 64 bit           | XL C/C++ V8             | OK   | OK
70     5.3 TL7 32 bit            | XL C/C++ V9 + IZ35785   | OK   | OK
71     5.3 TL7 32 bit            | gcc 4.2.4               | OK   | OK
72     5.3 TL7 64 bit            | XL C/C++ V9 + IZ35785   | OK   | OK
73     6.1 TL1 32 bit            | XL C/C++ V10            | OK   | OK
74     6.1 TL1 64 bit + IZ39077  | XL C/C++ V10            | OK   | OK
75     
76     w th   = with thread
77     w/o th = without thread
78
79 Successfully tested means that all make test runs with an result of 100% OK.
80 All tests were conducted with -Duseshrplib set.
81
82 =head2 Building Dynamic Extensions on AIX
83
84 Starting from Perl 5.7.2 (and consequently 5.8.x / 5.10.x) and AIX 4.3 
85 or newer Perl uses the AIX native dynamic loading interface in the so 
86 called runtime linking mode instead of the emulated interface that was 
87 used in Perl releases 5.6.1 and earlier or, for AIX releases 4.2 and 
88 earlier. This change does break backward compatibility with compiled 
89 modules from earlier Perl releases. The change was made to make Perl 
90 more compliant with other applications like Apache/mod_perl which are 
91 using the AIX native interface. This change also enables the use of 
92 C++ code with static constructors and destructors in Perl extensions, 
93 which was not possible using the emulated interface.
94
95 It is highly recommended to use the new interface.
96
97 =head2 Using Large Files with Perl
98
99 Should yield no problems.
100
101 =head2 Threaded Perl
102
103 Should yield no problems with AIX 5.1 / 5.2 / 5.3 and 6.1.
104
105 IBM uses the AIX system Perl (V5.6.0 on AIX 5.1 and V5.8.2 on
106 AIX 5.2 / 5.3 and 6.1) for some AIX
107 system scripts. If you switch the links in /usr/bin from the
108 AIX system Perl (/usr/opt/perl5) to the newly build Perl then you
109 get the same features as with the IBM AIX system Perl if the
110 threaded options are used.
111
112 The threaded Perl build works also on AIX 5.1 but the IBM Perl
113 build (Perl v5.6.0) is not threaded on AIX 5.1.
114
115 =head2 64-bit Perl
116
117 If your AIX system is installed with 64-bit support, you can expect 64-bit
118 configurations to work. If you want to use 64-bit Perl on AIX 6.1
119 you need a APAR for a libc.a bug which affects (n)dbm_XXX functions.
120 The APAR number for this problem is IZ39077.
121
122 If you need more memory (larger data segment) for your Perl programs you
123 can set:
124
125     /etc/security/limits
126     default:                    (or your user)
127         data = -1               (default is 262144 * 512 byte)
128
129 With the default setting the size is limited to 128MB.
130 The -1 removes this limit.
131
132 =head2 Recommended Options AIX 5.1/5.2/5.3 and 6.1 (threaded/32-bit)
133
134 With the following options you get a threaded Perl version which
135 passes all make tests in threaded 32-bit mode, which is the default
136 configuration for the Perl builds that AIX ships with.
137
138     rm config.sh
139     ./Configure \
140     -d \
141     -Dcc=cc_r \
142     -Duseshrplib \
143     -Dusethreads \
144     -Dprefix=/usr/opt/perl5_32
145
146 The -Dprefix option will install Perl in a directory parallel to the 
147 IBM AIX system Perl installation.
148
149 =head2 Recommended Options AIX 5.1/5.2/5.3 and 6.1 (32-bit)
150
151 With the following options you get a Perl version which passes 
152 all make tests in 32-bit mode.
153
154     rm config.sh
155     ./Configure \
156     -d \
157     -Dcc=cc_r \
158     -Duseshrplib \
159     -Dprefix=/usr/opt/perl5_32
160
161 The -Dprefix option will install Perl in a directory parallel to the
162 IBM AIX system Perl installation.
163
164 =head2 Recommended Options AIX 5.1/5.2/5.3 and 6.1 (threaded/64-bit)
165
166 With the following options you get a threaded Perl version which
167 passes all make tests in 64-bit mode.
168
169     export OBJECT_MODE=64 / setenv OBJECT_MODE 64 (depending on your shell)
170
171     rm config.sh
172     ./Configure \
173     -d \
174     -Dcc=cc_r \
175     -Duseshrplib \
176     -Dusethreads \
177     -Duse64bitall \
178     -Dprefix=/usr/opt/perl5_64
179
180 =head2 Recommended Options AIX 5.1/5.2/5.3 and 6.1(64-bit)
181
182 With the following options you get a Perl version which passes all 
183 make tests in 64-bit mode. 
184
185     export OBJECT_MODE=64 / setenv OBJECT_MODE 64 (depending on your shell)
186     
187     rm config.sh
188     ./Configure \
189     -d \
190     -Dcc=cc_r \
191     -Duseshrplib \
192     -Duse64bitall \
193     -Dprefix=/usr/opt/perl5_64
194
195 The -Dprefix option will install Perl in a directory parallel to the 
196 IBM AIX system Perl installation.
197
198 If you choose gcc to compile 64-bit Perl then you need to use the 
199 following options:
200
201     -Dcc='gcc -maix64'
202
203
204 =head2 Compiling Perl 5 on older AIX versions up to 4.3.3
205
206 Due to the fact that AIX 4.3.3 reached end-of-service in December 31, 
207 2003 this information  is provided as is. The Perl versions prior to 
208 Perl 5.8.9 could be compiled on AIX up to 4.3.3 with the following 
209 settings (your mileage may vary):
210
211 When compiling Perl, you must use an ANSI C compiler. AIX does not ship
212 an ANSI compliant C-compiler with AIX by default, but binary builds of
213 gcc for AIX are widely available.
214
215 At the moment of writing, AIX supports two different native C compilers,
216 for which you have to pay: B<xlC> and B<vac>. If you decide to use either
217 of these two (which is quite a lot easier than using gcc), be sure to
218 upgrade to the latest available patch level. Currently:
219
220     xlC.C     3.1.4.10 or 3.6.6.0 or 4.0.2.2 or 5.0.2.9 or 6.0.0.3
221     vac.C     4.4.0.3  or 5.0.2.6 or 6.0.0.1
222
223 note that xlC has the OS version in the name as of version 4.0.2.0, so
224 you will find xlC.C for AIX-5.0 as package
225
226     xlC.aix50.rte   5.0.2.0 or 6.0.0.3
227
228 subversions are not the same "latest" on all OS versions. For example,
229 the latest xlC-5 on aix41 is 5.0.2.9, while on aix43, it is 5.0.2.7.
230
231 Perl can be compiled with either IBM's ANSI C compiler or with gcc.
232 The former is recommended, as not only can it compile Perl with no
233 difficulty, but also can take advantage of features listed later that
234 require the use of IBM compiler-specific command-line flags.
235
236 The IBM's compiler patch levels 5.0.0.0 and 5.0.1.0 have compiler
237 optimization bugs that affect compiling perl.c and regcomp.c,
238 respectively.  If Perl's configuration detects those compiler patch
239 levels, optimization is turned off for the said source code files.
240 Upgrading to at least 5.0.2.0 is recommended.
241
242 If you decide to use gcc, make sure your installation is recent and
243 complete, and be sure to read the Perl INSTALL file for more gcc-specific
244 details. Please report any hoops you had to jump through to the development
245 team.
246
247 =head2 OS level
248
249 Before installing the patches to the IBM C-compiler you need to know the
250 level of patching for the Operating System. IBM's command 'oslevel' will
251 show the base, but is not always complete (in this example oslevel shows
252 4.3.NULL, whereas the system might run most of 4.3.THREE):
253
254     # oslevel
255     4.3.0.0
256     # lslpp -l | grep 'bos.rte '
257     bos.rte           4.3.3.75  COMMITTED  Base Operating System Runtime
258     bos.rte            4.3.2.0  COMMITTED  Base Operating System Runtime
259     #
260
261 The same might happen to AIX 5.1 or other OS levels. As a side note, Perl
262 cannot be built without bos.adt.syscalls and bos.adt.libm installed
263
264     # lslpp -l | egrep "syscalls|libm"
265     bos.adt.libm      5.1.0.25  COMMITTED  Base Application Development
266     bos.adt.syscalls  5.1.0.36  COMMITTED  System Calls Application
267     #
268
269 =head2 Building Dynamic Extensions on AIX
270
271 AIX supports dynamically loadable objects as well as shared libraries.
272 Shared libraries by convention end with the suffix .a, which is a bit
273 misleading, as an archive can contain static as well as dynamic members.
274 For Perl dynamically loaded objects we use the .so suffix also used on
275 many other platforms.
276
277 Note that starting from Perl 5.7.2 (and consequently 5.8.0) and AIX 4.3
278 or newer Perl uses the AIX native dynamic loading interface in the so
279 called runtime linking mode instead of the emulated interface that was
280 used in Perl releases 5.6.1 and earlier or, for AIX releases 4.2 and
281 earlier.  This change does break backward compatibility with compiled
282 modules from earlier Perl releases.  The change was made to make Perl
283 more compliant with other applications like Apache/mod_perl which are
284 using the AIX native interface. This change also enables the use of C++
285 code with static constructors and destructors in Perl extensions, which
286 was not possible using the emulated interface.
287
288 =head2 The IBM ANSI C Compiler
289
290 All defaults for Configure can be used.
291
292 If you've chosen to use vac 4, be sure to run 4.4.0.3. Older versions
293 will turn up nasty later on. For vac 5 be sure to run at least 5.0.1.0,
294 but vac 5.0.2.6 or up is highly recommended. Note that since IBM has
295 removed vac 5.0.2.1 through 5.0.2.5 from the software depot, these
296 versions should be considered obsolete.
297
298 Here's a brief lead of how to upgrade the compiler to the latest
299 level.  Of course this is subject to changes.  You can only upgrade
300 versions from ftp-available updates if the first three digit groups
301 are the same (in where you can skip intermediate unlike the patches
302 in the developer snapshots of Perl), or to one version up where the
303 "base" is available.  In other words, the AIX compiler patches are
304 cumulative.
305
306  vac.C.4.4.0.1 => vac.C.4.4.0.3  is OK     (vac.C.4.4.0.2 not needed)
307  xlC.C.3.1.3.3 => xlC.C.3.1.4.10 is NOT OK (xlC.C.3.1.4.0 is not available)
308
309  # ftp ftp.software.ibm.com
310  Connected to service.boulder.ibm.com.
311  : welcome message ...
312  Name (ftp.software.ibm.com:merijn): anonymous
313  331 Guest login ok, send your complete e-mail address as password.
314  Password:
315  ... accepted login stuff
316  ftp> cd /aix/fixes/v4/
317  ftp> dir other other.ll
318  output to local-file: other.ll? y
319  200 PORT command successful.
320  150 Opening ASCII mode data connection for /bin/ls.
321  226 Transfer complete.
322  ftp> dir xlc xlc.ll
323  output to local-file: xlc.ll? y
324  200 PORT command successful.
325  150 Opening ASCII mode data connection for /bin/ls.
326  226 Transfer complete.
327  ftp> bye
328  ... goodbye messages
329  # ls -l *.ll
330  -rw-rw-rw-   1 merijn   system    1169432 Nov  2 17:29 other.ll
331  -rw-rw-rw-   1 merijn   system      29170 Nov  2 17:29 xlc.ll
332
333 On AIX 4.2 using xlC, we continue:
334
335  # lslpp -l | fgrep 'xlC.C '
336    xlC.C                     3.1.4.9  COMMITTED  C for AIX Compiler
337    xlC.C                     3.1.4.0  COMMITTED  C for AIX Compiler
338  # grep 'xlC.C.3.1.4.*.bff' xlc.ll
339  -rw-r--r--   1 45776101 1        6286336 Jul 22 1996  xlC.C.3.1.4.1.bff
340  -rw-rw-r--   1 45776101 1        6173696 Aug 24 1998  xlC.C.3.1.4.10.bff
341  -rw-r--r--   1 45776101 1        6319104 Aug 14 1996  xlC.C.3.1.4.2.bff
342  -rw-r--r--   1 45776101 1        6316032 Oct 21 1996  xlC.C.3.1.4.3.bff
343  -rw-r--r--   1 45776101 1        6315008 Dec 20 1996  xlC.C.3.1.4.4.bff
344  -rw-rw-r--   1 45776101 1        6178816 Mar 28 1997  xlC.C.3.1.4.5.bff
345  -rw-rw-r--   1 45776101 1        6188032 May 22 1997  xlC.C.3.1.4.6.bff
346  -rw-rw-r--   1 45776101 1        6191104 Sep  5 1997  xlC.C.3.1.4.7.bff
347  -rw-rw-r--   1 45776101 1        6185984 Jan 13 1998  xlC.C.3.1.4.8.bff
348  -rw-rw-r--   1 45776101 1        6169600 May 27 1998  xlC.C.3.1.4.9.bff
349  # wget ftp://ftp.software.ibm.com/aix/fixes/v4/xlc/xlC.C.3.1.4.10.bff
350  #
351
352 On AIX 4.3 using vac, we continue:
353
354  # lslpp -l | grep 'vac.C '
355   vac.C                      5.0.2.2  COMMITTED  C for AIX Compiler
356   vac.C                      5.0.2.0  COMMITTED  C for AIX Compiler
357  # grep 'vac.C.5.0.2.*.bff' other.ll
358  -rw-rw-r--   1 45776101 1        13592576 Apr 16 2001  vac.C.5.0.2.0.bff
359  -rw-rw-r--   1 45776101 1        14133248 Apr  9 2002  vac.C.5.0.2.3.bff
360  -rw-rw-r--   1 45776101 1        14173184 May 20 2002  vac.C.5.0.2.4.bff
361  -rw-rw-r--   1 45776101 1        14192640 Nov 22 2002  vac.C.5.0.2.6.bff
362  # wget ftp://ftp.software.ibm.com/aix/fixes/v4/other/vac.C.5.0.2.6.bff
363  #
364
365 Likewise on all other OS levels. Then execute the following command, and
366 fill in its choices
367
368  # smit install_update
369   -> Install and Update from LATEST Available Software
370   * INPUT device / directory for software [ vac.C.5.0.2.6.bff    ]
371   [ OK ]
372   [ OK ]
373
374 Follow the messages ... and you're done.
375
376 If you like a more web-like approach, a good start point can be
377 http://www14.software.ibm.com/webapp/download/downloadaz.jsp and click
378 "C for AIX", and follow the instructions.
379
380 =head2 The usenm option
381
382 If linking miniperl
383
384  cc -o miniperl ... miniperlmain.o opmini.o perl.o ... -lm -lc ...
385
386 causes error like this
387
388  ld: 0711-317 ERROR: Undefined symbol: .aintl
389  ld: 0711-317 ERROR: Undefined symbol: .copysignl
390  ld: 0711-317 ERROR: Undefined symbol: .syscall
391  ld: 0711-317 ERROR: Undefined symbol: .eaccess
392  ld: 0711-317 ERROR: Undefined symbol: .setresuid
393  ld: 0711-317 ERROR: Undefined symbol: .setresgid
394  ld: 0711-317 ERROR: Undefined symbol: .setproctitle
395  ld: 0711-345 Use the -bloadmap or -bnoquiet option to obtain more information.
396
397 you could retry with
398
399  make realclean
400  rm config.sh
401  ./Configure -Dusenm ...
402
403 which makes Configure to use the C<nm> tool when scanning for library
404 symbols, which usually is not done in AIX.
405
406 Related to this, you probably should not use the C<-r> option of
407 Configure in AIX, because that affects of how the C<nm> tool is used.
408
409 =head2 Using GNU's gcc for building Perl
410
411 Using gcc-3.x (tested with 3.0.4, 3.1, and 3.2) now works out of the box,
412 as do recent gcc-2.9 builds available directly from IBM as part of their
413 Linux compatibility packages, available here:
414
415   http://www.ibm.com/servers/aix/products/aixos/linux/
416
417 =head2 Using Large Files with Perl
418
419 Should yield no problems.
420
421 =head2 Threaded Perl
422
423 Threads seem to work OK, though at the moment not all tests pass when
424 threads are used in combination with 64-bit configurations.
425
426 You may get a warning when doing a threaded build:
427
428   "pp_sys.c", line 4640.39: 1506-280 (W) Function argument assignment between types "unsigned char*" and "const void*" is not allowed.
429
430 The exact line number may vary, but if the warning (W) comes from a line
431 line this
432
433   hent = PerlSock_gethostbyaddr(addr, (Netdb_hlen_t) addrlen, addrtype);
434
435 in the "pp_ghostent" function, you may ignore it safely.  The warning
436 is caused by the reentrant variant of gethostbyaddr() having a slightly
437 different prototype than its non-reentrant variant, but the difference
438 is not really significant here.
439
440 =head2 64-bit Perl
441
442 If your AIX is installed with 64-bit support, you can expect 64-bit
443 configurations to work. In combination with threads some tests might
444 still fail.
445
446 =head2 AIX 4.2 and extensions using C++ with statics
447
448 In AIX 4.2 Perl extensions that use C++ functions that use statics
449 may have problems in that the statics are not getting initialized.
450 In newer AIX releases this has been solved by linking Perl with
451 the libC_r library, but unfortunately in AIX 4.2 the said library
452 has an obscure bug where the various functions related to time
453 (such as time() and gettimeofday()) return broken values, and
454 therefore in AIX 4.2 Perl is not linked against the libC_r.
455
456 =head1 AUTHORS
457
458 H.Merijn Brand <h.m.brand@xs4all.nl>
459 Rainer Tammer <tammer@tammer.net>
460
461 =head1 DATE
462
463 Version 0.0.8: 01 Dec 2008
464
465 =cut