Encode tweaks for VMS
[perl.git] / README.hpux
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.hpux - Perl version 5 on Hewlett-Packard Unix (HP-UX) systems
8
9 =head1 DESCRIPTION
10
11 This document describes various features of HP's Unix operating system
12 (HP-UX) that will affect how Perl version 5 (hereafter just Perl) is
13 compiled and/or runs.
14
15 =head2 Using perl as shipped with HP-UX
16
17 As of application release September 2001, HP-UX 11.00 is shipped with
18 perl-5.6.1 in /opt/perl. The first occurrence is on CD 5012-7954 and
19 can be installed using
20
21     swinstall -s /cdrom perl
22
23 assuming you have mounted that CD on /cdrom. In this version the
24 following modules are installed:
25
26     ActivePerl::DocTools-0.04   HTML::Parser-3.19   XML::DOM-1.25
27     Archive::Tar-0.072          HTML::Tagset-3.03   XML::Parser-2.27
28     Compress::Zlib-1.08         MIME::Base64-2.11   XML::Simple-1.05
29     Convert::ASN1-0.10          Net-1.07            XML::XPath-1.09
30     Digest::MD5-2.11            PPM-2.1.5           XML::XSLT-0.32
31     File::CounterFile-0.12      SOAP::Lite-0.46     libwww-perl-5.51
32     Font::AFM-1.18              Storable-1.011      libxml-perl-0.07
33     HTML-Tree-3.11              URI-1.11            perl-ldap-0.23
34
35 The build is a portable hppa-1.1 multithread build that supports large
36 files compiled with gcc-2.9-hppa-991112
37
38 If you perform a new installation, then Perl will be installed
39 automatically.
40
41 =head2 Compiling Perl 5 on HP-UX
42
43 When compiling Perl, you must use an ANSI C compiler.  The C compiler
44 that ships with all HP-UX systems is a K&R compiler that should only be
45 used to build new kernels.
46
47 Perl can be compiled with either HP's ANSI C compiler or with gcc.  The
48 former is recommended, as not only can it compile Perl with no
49 difficulty, but also can take advantage of features listed later that
50 require the use of HP compiler-specific command-line flags.
51
52 If you decide to use gcc, make sure your installation is recent and
53 complete, and be sure to read the Perl README file for more gcc-specific
54 details.
55
56 =head2 PA-RISC
57
58 HP's current Unix systems run on its own Precision Architecture
59 (PA-RISC) chip.  HP-UX used to run on the Motorola MC68000 family of
60 chips, but any machine with this chip in it is quite obsolete and this
61 document will not attempt to address issues for compiling Perl on the
62 Motorola chipset.
63
64 The most recent version of PA-RISC at the time of this document's last
65 update is 2.0.
66
67 =head2 PA-RISC 1.0
68
69 The original version of PA-RISC, HP no longer sells any system with this chip.
70
71 The following systems contained PA-RISC 1.0 chips:
72
73     600, 635, 645, 808, 815, 822, 825, 832, 834, 835, 840, 842, 845, 850,
74     852, 855, 860, 865, 870, 890
75
76 =head2 PA-RISC 1.1
77
78 An upgrade to the PA-RISC design, it shipped for many years in many different
79 system.
80
81 The following systems contain with PA-RISC 1.1 chips:
82
83     705, 710, 712, 715, 720, 722, 725, 728, 730, 735, 742, 743, 744, 745,
84     747, 750, 755, 770, 777, 778, 779, 800, 801, 803, 806, 807, 809, 811,
85     813, 816, 817, 819, 821, 826, 827, 829, 831, 837, 839, 841, 847, 849,
86     851, 856, 857, 859, 867, 869, 877, 887, 891, 892, 897, A180, A180C,
87     B115, B120, B132L, B132L+, B160L, B180L, C100, C110, C115, C120,
88     C160L, D200, D210, D220, D230, D250, D260, D310, D320, D330, D350,
89     D360, D410, DX0, DX5, DXO, E25, E35, E45, E55, F10, F20, F30, G30,
90     G40, G50, G60, G70, H20, H30, H40, H50, H60, H70, I30, I40, I50, I60,
91     I70, J200, J210, J210XC, K100, K200, K210, K220, K230, K400, K410,
92     K420, S700i, S715, S744, S760, T500, T520
93
94 =head2 PA-RISC 2.0
95
96 The most recent upgrade to the PA-RISC design, it added support for
97 64-bit integer data.
98
99 As of the date of this document's last update, the following systems
100 contain PA-RISC 2.0 chips:
101
102     700, 780, 781, 782, 783, 785, 802, 804, 810, 820, 861, 871, 879, 889,
103     893, 895, 896, 898, 899, A400, A500, B1000, B2000, C130, C140, C160,
104     C180, C180+, C180-XP, C200+, C400+, C3000, C360, C3600, CB260, D270,
105     D280, D370, D380, D390, D650, J220, J2240, J280, J282, J400, J410,
106     J5000, J5500XM, J5600, J7000, J7600, K250, K260, K260-EG, K270, K360,
107     K370, K380, K450, K460, K460-EG, K460-XP, K470, K570, K580, L1000,
108     L2000, L3000, N4000, R380, R390, RP2400, RP2430, RP2450, RP2470,
109     RP5400, RP5430, RP5450, RP5470, RP7400, RP7410, RP8400, SD16000,
110     SD32000, SD64000, T540, T600, V2000, V2200, V2250, V2500, V2600
111
112 =head2 Itanium
113
114 HP also ships servers with the 128-bit Itanium processor(s). As of the
115 date of this document's last update, the following systems contain
116 Itanium chips (this is very likely to be out of date):
117
118     RX4610, RX9610
119
120 A complete list of models at the time the OS was built is in the file
121 /opt/langtools/lib/sched.models.  The first column corresponds to the
122 output of the "uname -m" command (without the leading "9000/").  The
123 second column is the PA-RISC version and the third column is the exact
124 chip type used. (Start browsing at the bottom to prevent confusion ;-)
125
126 =head2 Portability Between PA-RISC Versions
127
128 An executable compiled on a PA-RISC 2.0 platform will not execute on a
129 PA-RISC 1.1 platform, even if they are running the same version of
130 HP-UX.  If you are building Perl on a PA-RISC 2.0 platform and want that
131 Perl to also run on a PA-RISC 1.1, the compiler flags +DAportable and
132 +DS32 should be used.
133
134 It is no longer possible to compile PA-RISC 1.0 executables on either
135 the PA-RISC 1.1 or 2.0 platforms.  The command-line flags are accepted,
136 but the resulting executable will not run when transferred to a PA-RISC
137 1.0 system.
138
139 =head2 Itanium Processor Family and HP-UX
140
141 HP-UX also runs on the new Itanium processor.  This requires the use
142 of a different version of HP-UX (currently 11.20), and with the exception
143 of a few differences detailed below and in later sections, Perl should
144 compile with no problems.
145
146 Although PA-RISC binaries can run on Itanium systems, you should not
147 attempt to use a PA-RISC version of Perl on an Itanium system.  This is
148 because shared libraries created on an Itanium system cannot be loaded
149 while running a PA-RISC executable.
150
151 =head2 Building Dynamic Extensions on HP-UX
152
153 HP-UX supports dynamically loadable libraries (shared libraries).
154 Shared libraries end with the suffix .sl.  On Itanium systems,
155 they end with the suffix .so.
156
157 Shared libraries created on a platform using a particular PA-RISC
158 version are not usable on platforms using an earlier PA-RISC version by
159 default.  However, this backwards compatibility may be enabled using the
160 same +DAportable compiler flag (with the same PA-RISC 1.0 caveat
161 mentioned above).
162
163 Shared libraries created on an Itanium platform cannot be loaded on
164 a PA-RISC platform.  Shared libraries created on a PA-RISC platform
165 can only be loaded on an Itanium platform if it is a PA-RISC executable
166 that is attempting to load the PA-RISC library.  A PA-RISC shared
167 library cannot be loaded into an Itanium executable nor vice-versa.
168
169 To create a shared library, the following steps must be performed:
170
171     1. Compile source modules with +z or +Z flag to create a .o module
172        which contains Position-Independent Code (PIC).  The linker will
173        tell you in the next step if +Z was needed.
174
175     2. Link the shared library using the -b flag.  If the code calls
176        any functions in other system libraries (e.g., libm), it must
177        be included on this line.
178
179 (Note that these steps are usually handled automatically by the extension's
180 Makefile).
181
182 If these dependent libraries are not listed at shared library creation
183 time, you will get fatal "Unresolved symbol" errors at run time when the
184 library is loaded.
185
186 You may create a shared library that refers to another library, which
187 may be either an archive library or a shared library.  If this second
188 library is a shared library, this is called a "dependent library".  The
189 dependent library's name is recorded in the main shared library, but it
190 is not linked into the shared library.  Instead, it is loaded when the
191 main shared library is loaded.  This can cause problems if you build an
192 extension on one system and move it to another system where the
193 libraries may not be located in the same place as on the first system.
194
195 If the referred library is an archive library, then it is treated as a
196 simple collection of .o modules (all of which must contain PIC).  These
197 modules are then linked into the shared library.
198
199 Note that it is okay to create a library which contains a dependent
200 library that is already linked into perl.
201
202 Some extensions, like DB_File and Compress::Zlib use/require prebuilt
203 libraries for the perl extensions/modules to work. If these libraries
204 are built using the default configuration, it might happen that you
205 run into an error like "invalid loader fixup" during load phase.
206 HP is aware of this problem.  Search the HP-UX cxx-dev forums for
207 discussions about the subject.  The short answer is that B<everything>
208 (all libraries, everything) must be compiled with C<+z> or C<+Z> to be
209 PIC (position independent code).  In HP-UX 11.00 or newer the linker
210 error message should tell the name of the offending object file.
211
212 A more general approach is to intervene manually, as with an example for
213 the DB_File module, which requires SleepyCat's libdb.sl:
214
215     # cd .../db-3.2.9/build_unix
216     # vi Makefile
217     ... add +Z to all cflags to create shared objects
218     CFLAGS=         -c $(CPPFLAGS) +Z -Ae +O2 +Onolimit \
219                     -I/usr/local/include -I/usr/include/X11R6
220     CXXFLAGS=       -c $(CPPFLAGS) +Z -Ae +O2 +Onolimit \
221                     -I/usr/local/include -I/usr/include/X11R6
222
223     # make clean
224     # make
225     # mkdir tmp
226     # cd tmp
227     # ar x ../libdb.a
228     # ld -b -o libdb-3.2.sl *.o
229     # mv libdb-3.2.sl /usr/local/lib
230     # rm *.o
231     # cd /usr/local/lib
232     # rm -f libdb.sl
233     # ln -s libdb-3.2.sl libdb.sl
234
235     # cd .../DB_File-1.76
236     # make distclean
237     # perl Makefile.PL
238     # make
239     # make test
240     # make install
241
242 It is no longer possible to link PA-RISC 1.0 shared libraries (even
243 though the command-line flags are still present).
244
245 PA-RISC and Itanium object files are not interchangeable.  Although
246 you may be able to use ar to create an archive library of PA-RISC
247 object files on an Itanium system, you cannot link against it using
248 an Itanium link editor.
249
250 =head2 The HP ANSI C Compiler
251
252 When using this compiler to build Perl, you should make sure that the
253 flag -Aa is added to the cpprun and cppstdin variables in the config.sh
254 file (though see the section on 64-bit perl below). If you are using a
255 recent version of the Perl distribution, these flags are set automatically.
256
257 =head2 Using Large Files with Perl on HP-UX
258
259 Beginning with HP-UX version 10.20, files larger than 2GB (2^31 bytes)
260 may be created and manipulated.  Three separate methods of doing this
261 are available.  Of these methods, the best method for Perl is to compile
262 using the -Duselargefiles flag to Configure.  This causes Perl to be
263 compiled using structures and functions in which these are 64 bits wide,
264 rather than 32 bits wide.  (Note that this will only work with HP's ANSI
265 C compiler.  If you want to compile Perl using gcc, you will have to get
266 a version of the compiler that support 64-bit operations.)
267
268 There are some drawbacks to this approach.  One is that any extension
269 which calls any file-manipulating C function will need to be recompiled
270 (just follow the usual "perl Makefile.PL; make; make test; make install"
271 procedure).
272
273 The list of functions that will need to recompiled is:
274 creat,          fgetpos,        fopen,
275 freopen,        fsetpos,        fstat,
276 fstatvfs,       fstatvfsdev,    ftruncate,
277 ftw,            lockf,          lseek,
278 lstat,          mmap,           nftw,
279 open,           prealloc,       stat,
280 statvfs,        statvfsdev,     tmpfile,
281 truncate,       getrlimit,      setrlimit
282
283 Another drawback is only valid for Perl versions before 5.6.0.  This
284 drawback is that the seek and tell functions (both the builtin version
285 and POSIX module version) will not perform correctly.
286
287 It is strongly recommended that you use this flag when you run
288 Configure.  If you do not do this, but later answer the question about
289 large files when Configure asks you, you may get a configuration that
290 cannot be compiled, or that does not function as expected.
291
292 =head2 Threaded Perl on HP-UX
293
294 It is possible to compile a version of threaded Perl on any version of
295 HP-UX before 10.30, but it is strongly suggested that you be running on
296 HP-UX 11.00 at least.
297
298 To compile Perl with threads, add -Dusethreads to the arguments of
299 Configure.  Verify that the -D_POSIX_C_SOURCE=199506L compiler flag is
300 automatically added to the list of flags.  Also make sure that -lpthread
301 is listed before -lc in the list of libraries to link Perl with. The
302 hints provided for HP-UX during Configure will try very hard to get
303 this right for you.
304
305 HP-UX versions before 10.30 require a separate installation of a POSIX
306 threads library package. Two examples are the HP DCE package, available
307 on "HP-UX Hardware Extensions 3.0, Install and Core OS, Release 10.20,
308 April 1999 (B3920-13941)" or the Freely available PTH package, available
309 though worldwide HP-UX mirrors of precompiled packages
310 (e.g. http://hpux.tn.tudelft.nl/hppd/hpux/)
311
312 If you are going to use the HP DCE package, the library used for threading
313 is /usr/lib/libcma.sl, but there have been multiple updates of that
314 library over time. Perl will build with the first version, but it
315 will not pass the test suite. Older Oracle versions might be a compelling
316 reason not to update that library, otherwise please find a newer version
317 in one of the following patches: PHSS_19739, PHSS_20608, or PHSS_23672
318
319 reformatted output:
320
321   d3:/usr/lib 106 > what libcma-*.1
322   libcma-00000.1:
323      HP DCE/9000 1.5               Module: libcma.sl (Export)
324                                    Date: Apr 29 1996 22:11:24
325   libcma-19739.1:
326      HP DCE/9000 1.5 PHSS_19739-40 Module: libcma.sl (Export)
327                                    Date: Sep  4 1999 01:59:07
328   libcma-20608.1:
329      HP DCE/9000 1.5 PHSS_20608    Module: libcma.1 (Export)
330                                    Date: Dec  8 1999 18:41:23
331   libcma-23672.1:
332      HP DCE/9000 1.5 PHSS_23672    Module: libcma.1 (Export)
333                                    Date: Apr  9 2001 10:01:06
334   d3:/usr/lib 107 >
335
336
337 =head2 64-bit Perl on HP-UX
338
339 Beginning with HP-UX 11.00, programs compiled under HP-UX can take
340 advantage of the LP64 programming environment (LP64 means Longs and
341 Pointers are 64 bits wide).
342
343 Work is being performed on Perl to make it 64-bit compliant on all
344 versions of Unix.  Once this is complete, scalar variables will be able
345 to hold numbers larger than 2^32 with complete precision.
346
347 As of the date of this document, Perl is not 64-bit compliant on HP-UX.
348
349 Should a user wish to experiment with compiling Perl in the LP64
350 environment, use the -Duse64bitall flag to Configure.  This will force
351 Perl to be compiled in a pure LP64 environment (via the +DD64 flag).
352
353 You can also use the -Duse64bitint flag to Configure.  Although there
354 are some minor differences between compiling Perl with this flag versus
355 the -Duse64bitall flag, they should not be noticeable from a Perl user's
356 perspective.
357
358 In both cases, it is strongly recommended that you use these flags when
359 you run Configure.  If you do not use do this, but later answer the
360 questions about 64-bit numbers when Configure asks you, you may get a
361 configuration that cannot be compiled, or that does not function as
362 expected.
363
364 (Note that these Configure flags will only work with HP's ANSI C
365 compiler.  If you want to compile Perl using gcc, you will have to get a
366 version of the compiler that support 64-bit operations.)
367
368 =head2 GDBM and Threads on HP-UX
369
370 If you attempt to compile Perl with threads on an 11.X system and also
371 link in the GDBM library, then Perl will immediately core dump when it
372 starts up.  The only workaround at this point is to relink the GDBM
373 library under 11.X, then relink it into Perl.
374
375 =head2 NFS filesystems and utime(2) on HP-UX
376
377 If you are compiling Perl on a remotely-mounted NFS filesystem, the test
378 io/fs.t may fail on test #18.  This appears to be a bug in HP-UX and no
379 fix is currently available.
380
381 =head2 perl -P and // and HP-UX
382
383 In HP-UX Perl is compiled with flags that will cause problems if the
384 -P flag of Perl (preprocess Perl code with the C preprocessor before
385 perl sees it) is used.  The problem is that C<//>, being a C++-style
386 until-end-of-line comment, will disappear along with the remainder
387 of the line.  This means that common Perl constructs like
388
389     s/foo//;
390
391 will turn into illegal code
392
393     s/foo
394
395 The workaround is to use some other quoting separator than C<"/">,
396 like for example C<"!">:
397
398     s!foo!!;
399
400 =head2 HP-UX Kernel Parameters (maxdsiz) for Compiling Perl
401
402 By default, HP-UX comes configured with a maximum data segment size of
403 64MB.  This is too small to correctly compile Perl with the maximum
404 optimization levels.  You can increase the size of the maxdsiz kernel
405 parameter through the use of SAM.
406
407 When using the GUI version of SAM, click on the Kernel Configuration
408 icon, then the Configurable Parameters icon.  Scroll down and select
409 the maxdsiz line.  From the Actions menu, select the Modify Configurable
410 Parameter item.  Insert the new formula into the Formula/Value box.
411 Then follow the instructions to rebuild your kernel and reboot your
412 system.
413
414 In general, a value of 256MB (or "256*1024*1024") is sufficient for
415 Perl to compile at maximum optimization.
416
417 =head1 nss_delete core dump from op/pwent or op/grent
418
419 You may get a bus error core dump from the op/pwent or op/grent
420 tests. If compiled with -g you will see a stack trace much like
421 the following:
422
423   #0  0xc004216c in  () from /usr/lib/libc.2
424   #1  0xc00d7550 in __nss_src_state_destr () from /usr/lib/libc.2
425   #2  0xc00d7768 in __nss_src_state_destr () from /usr/lib/libc.2
426   #3  0xc00d78a8 in nss_delete () from /usr/lib/libc.2 
427   #4  0xc01126d8 in endpwent () from /usr/lib/libc.2 
428   #5  0xd1950 in Perl_pp_epwent () from ./perl
429   #6  0x94d3c in Perl_runops_standard () from ./perl
430   #7  0x23728 in S_run_body () from ./perl
431   #8  0x23428 in perl_run () from ./perl
432   #9  0x2005c in main () from ./perl
433
434 The key here is the C<nss_delete> call.  One workaround for this
435 bug seems to be to create add to the file F</etc/nsswitch.conf>
436 (at least) the following lines
437
438   group: files 
439   passwd: files
440
441 Whether you are using NIS does not matter.  Amazingly enough,
442 the same bug affects also Solaris.
443
444 =head1 AUTHOR
445
446 Jeff Okamoto <okamoto@corp.hp.com>
447 H.Merijn Brand <h.m.brand@hccnet.nl>
448
449 With much assistance regarding shared libraries from Marc Sabatella.
450
451 =head1 DATE
452
453 Version 0.6.5: 2002-02-27
454
455 =cut