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