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