Retract the mergesort code, way too incompatible licensing
[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 Compiling Perl 5 on HP-UX
16
17 When compiling Perl, you must use an ANSI C compiler.  The C compiler
18 that ships with all HP-UX systems is a K&R compiler that should only be
19 used to build new kernels.
20
21 Perl can be compiled with either HP's ANSI C compiler or with gcc.  The
22 former is recommended, as not only can it compile Perl with no
23 difficulty, but also can take advantage of features listed later that
24 require the use of HP compiler-specific command-line flags.
25
26 If you decide to use gcc, make sure your installation is recent and
27 complete, and be sure to read the Perl README file for more gcc-specific
28 details.
29
30 =head2 PA-RISC
31
32 HP's current Unix systems run on its own Precision Architecture
33 (PA-RISC) chip.  HP-UX used to run on the Motorola MC68000 family of
34 chips, but any machine with this chip in it is quite obsolete and this
35 document will not attempt to address issues for compiling Perl on the
36 Motorola chipset.
37
38 The most recent version of PA-RISC at the time of this document's last
39 update is 2.0.
40
41 =head2 PA-RISC 1.0
42
43 The original version of PA-RISC, HP no longer sells any system with this chip.
44
45 The following systems contain PA-RISC 1.0 chips:
46
47     600, 635, 645, 808, 815, 822, 825, 832, 834, 835, 840, 842, 845, 850, 852,
48     855, 860, 865, 870, 890
49
50 =head2 PA-RISC 1.1
51
52 An upgrade to the PA-RISC design, it shipped for many years in many different
53 system.
54
55 The following systems contain with PA-RISC 1.1 chips:
56
57     705, 710, 712, 715, 720, 722, 725, 728, 730, 735, 742, 743, 745, 747, 750,
58     755, 770, 777, 778, 779, 800, 801, 803, 806, 807, 809, 811, 813, 816, 817,
59     819, 821, 826, 827, 829, 831, 837, 839, 841, 847, 849, 851, 856, 857, 859,
60     867, 869, 877, 887, 891, 892, 897, A180, A180C, B115, B120, B132L, B132L+,
61     B160L, B180L, C100, C110, C115, C120, C160L, D200, D210, D220, D230, D250,
62     D260, D310, D320, D330, D350, D360, D410, DX0, DX5, DZO, E25, E35, E45,
63     E55, F10, F20, F30, G30, G40, G50, G60, G70, H20, H30, H40, H50, H60, H70,
64     I30, I40, I50, I60, I70, J200, J210, J210XC, K100, K200, K210, K220, K230,
65     K400, K410, K420, S700i, S715, S724, S760, T500, T520
66
67 =head2 PA-RISC 2.0
68
69 The most recent upgrade to the PA-RISC design, it added support for
70 64-bit integer data.
71
72 As of the date of this document's last update, the following systems
73 contain PA-RISC 2.0 chips (this is very likely to be out of date):
74
75     700, 780, 781, 782, 783, 785, 802, 804, 810, 820, 861, 871, 879, 889, 893,
76     895, 896, 898, 899, B1000, C130, C140, C160, C180, C180+, C180-XP, C200+,
77     C400+, C3000, C360, CB260, D270, D280, D370, D380, D390, D650, J220, J2240,
78     J280, J282, J400, J410, J5000, J7000, K250, K260, K260-EG, K270, K360,
79     K370, K380, K450, K460, K460-EG, K460-XP, K470, K570, K580, L1000, L2000,
80     N4000, R380, R390, T540, T600, V2000, V2200, V2250, V2500
81
82 A complete list of models at the time the OS was built is in the file
83 /opt/langtools/lib/sched.models.  The first column corresponds to the
84 output of the "uname -m" command (without the leading "9000/").  The
85 second column is the PA-RISC version and the third column is the exact
86 chip type used.
87
88 =head2 Portability Between PA-RISC Versions
89
90 An executable compiled on a PA-RISC 2.0 platform will not execute on a
91 PA-RISC 1.1 platform, even if they are running the same version of
92 HP-UX.  If you are building Perl on a PA-RISC 2.0 platform and want that
93 Perl to to also run on a PA-RISC 1.1, the compiler flags +DAportable and
94 +DS32 should be used.
95
96 It is no longer possible to compile PA-RISC 1.0 executables on either
97 the PA-RISC 1.1 or 2.0 platforms.
98
99 =head2 Building Dynamic Extensions on HP-UX
100
101 HP-UX supports dynamically loadable libraries (shared libraries).
102 Shared libraries end with the suffix .sl.
103
104 Shared libraries created on a platform using a particular PA-RISC
105 version are not usable on platforms using an earlier PA-RISC version by
106 default.  However, this backwards compatibility may be enabled using the
107 same +DAportable compiler flag (with the same PA-RISC 1.0 caveat
108 mentioned above).
109
110 To create a shared library, the following steps must be performed:
111
112     1. Compile source modules with +z or +Z flag to create a .o module
113        which contains Position-Independent Code (PIC).  The linker will
114        tell you in the next step if +Z was needed.
115
116     2. Link the shared library using the -b flag.  If the code calls
117        any functions in other system libraries (e.g., libm), it must
118        be included on this line.
119
120 (Note that these steps are usually handled automatically by the extension's
121 Makefile).
122
123 If these dependent libraries are not listed at shared library creation
124 time, you will get fatal "Unresolved symbol" errors at run time when the
125 library is loaded.
126
127 You may create a shared library that refers to another library, which
128 may be either an archive library or a shared library.  If this second
129 library is a shared library, this is called a "dependent library".  The
130 dependent library's name is recorded in the main shared library, but it
131 is not linked into the shared library.  Instead, it is loaded when the
132 main shared library is loaded.  This can cause problems if you build an
133 extension on one system and move it to another system where the
134 libraries may not be located in the same place as on the first system.
135
136 If the referred library is an archive library, then it is treated as a
137 simple collection of .o modules (all of which must contain PIC).  These
138 modules are then linked into the shared library.
139
140 Note that it is okay to create a library which contains a dependent
141 library that is already linked into perl.
142
143 It is no longer possible to link PA-RISC 1.0 shared libraries.
144
145 =head2 The HP ANSI C Compiler
146
147 When using this compiler to build Perl, you should make sure that the
148 flag -Aa is added to the cpprun and cppstdin variables in the config.sh
149 file (though see the section on 64-bit perl below).
150
151 =head2 Using Large Files with Perl
152
153 Beginning with HP-UX version 10.20, files larger than 2GB (2^31 bytes)
154 may be created and manipulated.  Three separate methods of doing this
155 are available.  Of these methods, the best method for Perl is to compile
156 using the -Duselargefiles flag to Configure.  This causes Perl to be
157 compiled using structures and functions in which these are 64 bits wide,
158 rather than 32 bits wide.  (Note that this will only work with HP's ANSI
159 C compiler.  If you want to compile Perl using gcc, you will have to get
160 a version of the compiler that support 64-bit operations.)
161
162 There are some drawbacks to this approach.  One is that any extension
163 which calls any file-manipulating C function will need to be recompiled
164 (just follow the usual "perl Makefile.PL; make; make test; make install"
165 procedure).
166
167 The list of functions that will need to recompiled is:
168 creat,          fgetpos,        fopen,
169 freopen,        fsetpos,        fstat,
170 fstatvfs,       fstatvfsdev,    ftruncate,
171 ftw,            lockf,          lseek,
172 lstat,          mmap,           nftw,
173 open,           prealloc,       stat,
174 statvfs,        statvfsdev,     tmpfile,
175 truncate,       getrlimit,      setrlimit
176
177 Another drawback is only valid for Perl versions before 5.6.0.  This
178 drawback is that the seek and tell functions (both the builtin version
179 and POSIX module version) will not perform correctly.
180
181 It is strongly recommended that you use this flag when you run
182 Configure.  If you do not do this, but later answer the question about
183 large files when Configure asks you, you may get a configuration that
184 cannot be compiled, or that does not function as expected.
185
186 =head2 Threaded Perl
187
188 It is impossible to compile a version of threaded Perl on any version of
189 HP-UX before 10.30, and it is strongly suggested that you be running on
190 HP-UX 11.00 at least.
191
192 To compile Perl with threads, add -Dusethreads to the arguments of
193 Configure.  Verify that the -D_POSIX_C_SOURCE=199506L compiler flag is
194 automatically added to the list of flags.  Also make sure that -lpthread
195 is listed before -lc in the list of libraries to link Perl with.
196
197 As of the date of this document, Perl threads are not fully supported on
198 HP-UX.
199
200 =head2 64-bit Perl
201
202 Beginning with HP-UX 11.00, programs compiled under HP-UX can take
203 advantage of the LP64 programming environment (LP64 means Longs and
204 Pointers are 64 bits wide).
205
206 Work is being performed on Perl to make it 64-bit compliant on all
207 versions of Unix.  Once this is complete, scalar variables will be able
208 to hold numbers larger than 2^32 with complete precision.
209
210 As of the date of this document, Perl is not 64-bit compliant on HP-UX.
211
212 Should a user wish to experiment with compiling Perl in the LP64
213 environment, use the -Duse64bitall flag to Configure.  This will force
214 Perl to be compiled in a pure LP64 environment (via the +DD64 flag).
215
216 You can also use the -Duse64bitint flag to Configure.  Although there
217 are some minor differences between compiling Perl with this flag versus
218 the -Duse64bitall flag, they should not be noticeable from a Perl user's
219 perspective.
220
221 In both cases, it is strongly recommended that you use these flags when
222 you run Configure.  If you do not use do this, but later answer the
223 questions about 64-bit numbers when Configure asks you, you may get a
224 configuration that cannot be compiled, or that does not function as
225 expected.
226
227 (Note that these Configure flags will only work with HP's ANSI C
228 compiler.  If you want to compile Perl using gcc, you will have to get a
229 version of the compiler that support 64-bit operations.)
230
231 =head2 GDBM and Threads
232
233 If you attempt to compile Perl with threads on an 11.X system and also
234 link in the GDBM library, then Perl will immediately core dump when it
235 starts up.  The only workaround at this point is to relink the GDBM
236 library under 11.X, then relink it into Perl.
237
238 =head2 NFS filesystems and utime(2)
239
240 If you are compiling Perl on a remotely-mounted NFS filesystem, the test
241 io/fs.t may fail on test #18.  This appears to be a bug in HP-UX and no
242 fix is currently available.
243
244 =head2 perl -P and //
245
246 In HP-UX perl is compiled with flags that will cause problems if the
247 -P flag of Perl (preprocess Perl code with the C preprocessor before
248 perl sees it) is used.  The problem is that C<//>, being a C++-style
249 until-end-of-line comment, will disappear along with the remainder
250 of the line.  This means that common Perl constructs like
251
252         s/foo//;
253
254 will turn into illegal code
255
256         s/foo
257
258 The workaround is to use some other quoting characters than /,
259 like for example !
260
261         s!foo!!;
262
263 =head1 AUTHOR
264
265 Jeff Okamoto <okamoto@corp.hp.com>
266
267 With much assistance regarding shared libraries from Marc Sabatella.
268
269 =head1 DATE
270
271 Version 0.6.1: 2000/06/20
272
273 =cut