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