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