perldelta: close setting $! is a bugfix
[perl.git] / README.os390
1 This document is written in pod format hence there are punctuation
2 characters in odd places.  Do not worry, you've apparently got the
3 ASCII->EBCDIC translation worked out correctly.  You can read more
4 about pod in pod/perlpod.pod or the short summary in the INSTALL file.
5
6 =head1 NAME
7
8 perlos390 - building and installing Perl for OS/390 and z/OS
9
10 =head1 SYNOPSIS
11
12 This document will help you Configure, build, test and install Perl
13 on OS/390 (aka z/OS) Unix System Services.
14
15 B<This document needs to be updated, but we don't know what it should say.
16 Please email comments to L<perlbug@perl.org|mailto:perlbug@perl.org>.>
17
18 =head1 DESCRIPTION
19
20 This is a fully ported Perl for OS/390 Version 2 Release 3, 5, 6, 7,
21 8, and 9.  It may work on other versions or releases, but those are
22 the ones we've tested it on.
23
24 You may need to carry out some system configuration tasks before
25 running the Configure script for Perl.
26
27
28 =head2 Tools
29
30 The z/OS Unix Tools and Toys list may prove helpful and contains links
31 to ports of much of the software helpful for building Perl.
32 http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1toy.html
33
34
35 =head2 Unpacking Perl distribution on OS/390
36
37 If using ftp remember to transfer the distribution in binary format.
38
39 Gunzip/gzip for OS/390 is discussed at:
40
41   http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1ty1.html
42
43 to extract an ASCII tar archive on OS/390, try this:
44
45    pax -o to=IBM-1047,from=ISO8859-1 -r < latest.tar
46
47 or
48
49    zcat latest.tar.Z | pax -o to=IBM-1047,from=ISO8859-1 -r
50
51 If you get lots of errors of the form
52
53   tar: FSUM7171 ...: cannot set uid/gid: EDC5139I Operation not permitted.
54
55 you didn't read the above and tried to use tar instead of pax, you'll
56 first have to remove the (now corrupt) perl directory
57
58    rm -rf perl-...
59
60 and then use pax.
61
62 =head2 Setup and utilities for Perl on OS/390
63
64 Be sure that your yacc installation is in place including any necessary
65 parser template files. If you have not already done so then be sure to:
66
67   cp /samples/yyparse.c /etc
68
69 This may also be a good time to ensure that your /etc/protocol file
70 and either your /etc/resolv.conf or /etc/hosts files are in place.
71 The IBM document that described such USS system setup issues was
72 SC28-1890-07 "OS/390 UNIX System Services Planning", in particular
73 Chapter 6 on customizing the OE shell.
74
75 GNU make for OS/390, which is recommended for the build of perl (as
76 well as building CPAN modules and extensions), is available from the
77 L</Tools>.
78
79 Some people have reported encountering "Out of memory!" errors while
80 trying to build Perl using GNU make binaries.  If you encounter such
81 trouble then try to download the source code kit and build GNU make
82 from source to eliminate any such trouble.  You might also find GNU make
83 (as well as Perl and Apache) in the red-piece/book "Open Source Software
84 for OS/390 UNIX", SG24-5944-00 from IBM.
85
86 If instead of the recommended GNU make you would like to use the system
87 supplied make program then be sure to install the default rules file
88 properly via the shell command:
89
90     cp /samples/startup.mk /etc
91
92 and be sure to also set the environment variable _C89_CCMODE=1 (exporting
93 _C89_CCMODE=1 is also a good idea for users of GNU make).
94
95 You might also want to have GNU groff for OS/390 installed before
96 running the "make install" step for Perl.
97
98 There is a syntax error in the /usr/include/sys/socket.h header file
99 that IBM supplies with USS V2R7, V2R8, and possibly V2R9.  The problem with
100 the header file is that near the definition of the SO_REUSEPORT constant
101 there is a spurious extra '/' character outside of a comment like so:
102
103  #define SO_REUSEPORT    0x0200    /* allow local address & port
104                                       reuse */                    /
105
106 You could edit that header yourself to remove that last '/', or you might
107 note that Language Environment (LE) APAR PQ39997 describes the problem
108 and PTF's UQ46272 and UQ46271 are the (R8 at least) fixes and apply them.
109 If left unattended that syntax error will turn up as an inability for Perl
110 to build its "Socket" extension.
111
112 For successful testing you may need to turn on the sticky bit for your
113 world readable /tmp directory if you have not already done so (see man chmod).
114
115 =head2 Configure Perl on OS/390
116
117 Once you've unpacked the distribution, run "sh Configure" (see INSTALL
118 for a full discussion of the Configure options).  There is a "hints" file
119 for os390 that specifies the correct values for most things.  Some things
120 to watch out for include:
121
122 =over 4
123
124 =item *
125
126 A message of the form:
127
128  (I see you are using the Korn shell.  Some ksh's blow up on Configure,
129  mainly on older exotic systems.  If yours does, try the Bourne shell instead.)
130
131 is nothing to worry about at all.
132
133 =item *
134
135 Some of the parser default template files in /samples are needed in /etc.
136 In particular be sure that you at least copy /samples/yyparse.c to /etc
137 before running Perl's Configure.  This step ensures successful extraction
138 of EBCDIC versions of parser files such as perly.c and perly.h.
139 This has to be done before running Configure the first time.  If you failed
140 to do so then the easiest way to re-Configure Perl is to delete your
141 misconfigured build root and re-extract the source from the tar ball.
142 Then you must ensure that /etc/yyparse.c is properly in place before
143 attempting to re-run Configure.
144
145 =item *
146
147 This port will support dynamic loading, but it is not selected by
148 default.  If you would like to experiment with dynamic loading then
149 be sure to specify -Dusedl in the arguments to the Configure script.
150 See the comments in hints/os390.sh for more information on dynamic loading.
151 If you build with dynamic loading then you will need to add the
152 $archlibexp/CORE directory to your LIBPATH environment variable in order
153 for perl to work.  See the config.sh file for the value of $archlibexp.
154 If in trying to use Perl you see an error message similar to:
155
156  CEE3501S The module libperl.dll was not found.
157          From entry point __dllstaticinit at compile unit offset +00000194 at
158
159 then your LIBPATH does not have the location of libperl.x and either
160 libperl.dll or libperl.so in it.  Add that directory to your LIBPATH and
161 proceed.
162
163 =item *
164
165 Do not turn on the compiler optimization flag "-O".  There is
166 a bug in either the optimizer or perl that causes perl to
167 not work correctly when the optimizer is on.
168
169 =item *
170
171 Some of the configuration files in /etc used by the
172 networking APIs are either missing or have the wrong
173 names.  In particular, make sure that there's either
174 an /etc/resolv.conf or an /etc/hosts, so that
175 gethostbyname() works, and make sure that the file
176 /etc/proto has been renamed to /etc/protocol (NOT
177 /etc/protocols, as used by other Unix systems).
178 You may have to look for things like HOSTNAME and DOMAINORIGIN
179 in the "//'SYS1.TCPPARMS(TCPDATA)'" PDS member in order to
180 properly set up your /etc networking files.
181
182 =back
183
184 =head2 Build, Test, Install Perl on OS/390
185
186 Simply put:
187
188     sh Configure
189     make
190     make test
191
192 if everything looks ok (see the next section for test/IVP diagnosis) then:
193
194     make install
195
196 this last step may or may not require UID=0 privileges depending
197 on how you answered the questions that Configure asked and whether
198 or not you have write access to the directories you specified.
199
200 =head2 Build Anomalies with Perl on OS/390
201
202 "Out of memory!" messages during the build of Perl are most often fixed
203 by re building the GNU make utility for OS/390 from a source code kit.
204
205 Another memory limiting item to check is your MAXASSIZE parameter in your
206 'SYS1.PARMLIB(BPXPRMxx)' data set (note too that as of V2R8 address space
207 limits can be set on a per user ID basis in the USS segment of a RACF
208 profile).  People have reported successful builds of Perl with MAXASSIZE
209 parameters as small as 503316480 (and it may be possible to build Perl
210 with a MAXASSIZE smaller than that).
211
212 Within USS your /etc/profile or $HOME/.profile may limit your ulimit
213 settings.  Check that the following command returns reasonable values:
214
215     ulimit -a
216
217 To conserve memory you should have your compiler modules loaded into the
218 Link Pack Area (LPA/ELPA) rather than in a link list or step lib.
219
220 If the c89 compiler complains of syntax errors during the build of the
221 Socket extension then be sure to fix the syntax error in the system
222 header /usr/include/sys/socket.h.
223
224 =head2 Testing Anomalies with Perl on OS/390
225
226 The "make test" step runs a Perl Verification Procedure, usually before
227 installation.  You might encounter STDERR messages even during a successful
228 run of "make test".  Here is a guide to some of the more commonly seen
229 anomalies:
230
231 =over 4
232
233 =item *
234
235 A message of the form:
236
237  io/openpid...........CEE5210S The signal SIGHUP was received.
238  CEE5210S The signal SIGHUP was received.
239  CEE5210S The signal SIGHUP was received.
240  ok
241
242 indicates that the t/io/openpid.t test of Perl has passed but done so
243 with extraneous messages on stderr from CEE.
244
245 =item *
246
247 A message of the form:
248
249  lib/ftmp-security....File::Temp::_gettemp: Parent directory (/tmp/) is not safe
250  (sticky bit not set when world writable?) at lib/ftmp-security.t line 100
251  File::Temp::_gettemp: Parent directory (/tmp/) is not safe (sticky bit not
252  set when world writable?) at lib/ftmp-security.t line 100
253  ok
254
255 indicates a problem with the permissions on your /tmp directory within the HFS.
256 To correct that problem issue the command:
257
258      chmod a+t /tmp
259
260 from an account with write access to the directory entry for /tmp.
261
262 =item *
263
264 Out of Memory!
265
266 Recent perl test suite is quite memory hungry. In addition to the comments
267 above on memory limitations it is also worth checking for _CEE_RUNOPTS
268 in your environment. Perl now has (in miniperlmain.c) a C #pragma
269 to set CEE run options, but the environment variable wins.
270
271 The C code asks for:
272
273  #pragma runopts(HEAP(2M,500K,ANYWHERE,KEEP,8K,4K) STACK(,,ANY,) ALL31(ON))
274
275 The important parts of that are the second argument (the increment) to HEAP,
276 and allowing the stack to be "Above the (16M) line". If the heap
277 increment is too small then when perl (for example loading unicode/Name.pl) tries
278 to create a "big" (400K+) string it cannot fit in a single segment
279 and you get "Out of Memory!" - even if there is still plenty of memory
280 available.
281
282 A related issue is use with perl's malloc. Perl's malloc uses C<sbrk()>
283 to get memory, and C<sbrk()> is limited to the first allocation so in this
284 case something like:
285
286   HEAP(8M,500K,ANYWHERE,KEEP,8K,4K)
287
288 is needed to get through the test suite.
289
290
291 =back
292
293 =head2 Installation Anomalies with Perl on OS/390
294
295 The installman script will try to run on OS/390.  There will be fewer errors
296 if you have a roff utility installed.  You can obtain GNU groff from the
297 Redbook SG24-5944-00 ftp site.
298
299 =head2 Usage Hints for Perl on OS/390
300
301 When using perl on OS/390 please keep in mind that the EBCDIC and ASCII
302 character sets are different.  See perlebcdic.pod for more on such character
303 set issues.  Perl builtin functions that may behave differently under
304 EBCDIC are also mentioned in the perlport.pod document.
305
306 Open Edition (UNIX System Services) from V2R8 onward does support
307 #!/path/to/perl script invocation.  There is a PTF available from
308 IBM for V2R7 that will allow shell/kernel support for #!.  USS
309 releases prior to V2R7 did not support the #! means of script invocation.
310 If you are running V2R6 or earlier then see:
311
312     head `whence perldoc`
313
314 for an example of how to use the "eval exec" trick to ask the shell to
315 have Perl run your scripts on those older releases of Unix System Services.
316
317 If you are having trouble with square brackets then consider switching your
318 rlogin or telnet client.  Try to avoid older 3270 emulators and ISHELL for
319 working with Perl on USS.
320
321 =head2 Floating Point Anomalies with Perl on OS/390
322
323 There appears to be a bug in the floating point implementation on S/390
324 systems such that calling int() on the product of a number and a small
325 magnitude number is not the same as calling int() on the quotient of
326 that number and a large magnitude number.  For example, in the following
327 Perl code:
328
329     my $x = 100000.0;
330     my $y = int($x * 1e-5) * 1e5; # '0'
331     my $z = int($x / 1e+5) * 1e5;  # '100000'
332     print "\$y is $y and \$z is $z\n"; # $y is 0 and $z is 100000
333
334 Although one would expect the quantities $y and $z to be the same and equal
335 to 100000 they will differ and instead will be 0 and 100000 respectively.
336
337 The problem can be further examined in a roughly equivalent C program:
338
339     #include <stdio.h>
340     #include <math.h>
341     main()
342     {
343     double r1,r2;
344     double x = 100000.0;
345     double y = 0.0;
346     double z = 0.0;
347     x = 100000.0 * 1e-5;
348     r1 = modf (x,&y);
349     x = 100000.0 / 1e+5;
350     r2 = modf (x,&z);
351     printf("y is %e and z is %e\n",y*1e5,z*1e5);
352     /* y is 0.000000e+00 and z is 1.000000e+05 (with c89) */
353     }
354
355 =head2 Modules and Extensions for Perl on OS/390
356
357 Pure pure (that is non xs) modules may be installed via the usual:
358
359     perl Makefile.PL
360     make
361     make test
362     make install
363
364 If you built perl with dynamic loading capability then that would also
365 be the way to build xs based extensions.  However, if you built perl with
366 the default static linking you can still build xs based extensions for OS/390
367 but you will need to follow the instructions in ExtUtils::MakeMaker for
368 building statically linked perl binaries.  In the simplest configurations
369 building a static perl + xs extension boils down to:
370
371     perl Makefile.PL
372     make
373     make perl
374     make test
375     make install
376     make -f Makefile.aperl inst_perl MAP_TARGET=perl
377
378 In most cases people have reported better results with GNU make rather
379 than the system's /bin/make program, whether for plain modules or for
380 xs based extensions.
381
382 If the make process encounters trouble with either compilation or
383 linking then try setting the _C89_CCMODE to 1.  Assuming sh is your
384 login shell then run:
385
386     export _C89_CCMODE=1
387
388 If tcsh is your login shell then use the setenv command.
389
390 =head1 AUTHORS
391
392 David Fiander and Peter Prymmer with thanks to Dennis Longnecker
393 and William Raffloer for valuable reports, LPAR and PTF feedback.
394 Thanks to Mike MacIsaac and Egon Terwedow for SG24-5944-00.
395 Thanks to Ignasi Roca for pointing out the floating point problems.
396 Thanks to John Goodyear for dynamic loading help.
397
398 =head1 SEE ALSO
399
400 L<INSTALL>, L<perlport>, L<perlebcdic>, L<ExtUtils::MakeMaker>.
401
402     http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1toy.html
403
404     http://www.redbooks.ibm.com/redbooks/SG245944.html
405
406     http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1ty1.html#opensrc
407
408     http://www.xray.mpe.mpg.de/mailing-lists/perl-mvs/
409
410     http://publibz.boulder.ibm.com:80/cgi-bin/bookmgr_OS390/BOOKS/ceea3030/
411
412     http://publibz.boulder.ibm.com:80/cgi-bin/bookmgr_OS390/BOOKS/CBCUG030/
413
414 =head2 Mailing list for Perl on OS/390
415
416 If you are interested in the z/OS (formerly known as OS/390)
417 and POSIX-BC (BS2000) ports of Perl then see the perl-mvs mailing list.
418 To subscribe, send an empty message to perl-mvs-subscribe@perl.org.
419
420 See also:
421
422     http://lists.perl.org/list/perl-mvs.html
423
424 There are web archives of the mailing list at:
425
426     http://www.xray.mpe.mpg.de/mailing-lists/perl-mvs/
427     http://archive.develooper.com/perl-mvs@perl.org/
428
429 =head1 HISTORY
430
431 This document was originally written by David Fiander for the 5.005
432 release of Perl.
433
434 This document was podified for the 5.005_03 release of Perl 11 March 1999.
435
436 Updated 28 November 2001 for broken URLs.
437
438 Updated 12 November 2000 for the 5.7.1 release of Perl.
439
440 Updated 15 January 2001 for the 5.7.1 release of Perl.
441
442 Updated 24 January 2001 to mention dynamic loading.
443
444 Updated 12 March 2001 to mention //'SYS1.TCPPARMS(TCPDATA)'.
445
446 =cut
447