Commit | Line | Data |
---|---|---|
9133bbab | 1 | This document is written in pod format hence there are punctuation |
a83b6f46 JH |
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. | |
9d116dd7 | 5 | |
8fde188e GS |
6 | =head1 NAME |
7 | ||
37a78d01 | 8 | README.os390 - building and installing Perl for OS/390 and z/OS |
8fde188e GS |
9 | |
10 | =head1 SYNOPSIS | |
11 | ||
12 | This document will help you Configure, build, test and install Perl | |
37a78d01 | 13 | on OS/390 (aka z/OS) Unix System Services. |
8fde188e GS |
14 | |
15 | =head1 DESCRIPTION | |
16 | ||
9133bbab NIS |
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 | |
eae55d03 | 19 | the ones we've tested it on. |
8fde188e | 20 | |
9133bbab NIS |
21 | You may need to carry out some system configuration tasks before |
22 | running the Configure script for Perl. | |
8fde188e | 23 | |
37a78d01 JH |
24 | |
25 | =head2 Tools | |
26 | ||
27 | The z/OS Unix Tools and Toys list may prove helpful and contains links | |
f110302f | 28 | to ports of much of the software helpful for building Perl. |
37a78d01 JH |
29 | http://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 JH |
34 | If using ftp remember to transfer the distribution in binary format. |
35 | ||
9d116dd7 JH |
36 | Gunzip/gzip for OS/390 is discussed at: |
37 | ||
37a78d01 | 38 | http://www-1.ibm.com/servers/eserver/zseries/zos/unix/faq/bpxqp1.html |
9d116dd7 JH |
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 | ||
bfd0ae40 JH |
44 | or |
45 | ||
46 | zcat latest.tar.Z | pax -o to=IBM-1047,from=ISO8859-1 -r | |
47 | ||
0e7519cd | 48 | If you get lots of errors of the form |
bbee22da JH |
49 | |
50 | tar: FSUM7171 ...: cannot set uid/gid: EDC5139I Operation not permitted. | |
bbee22da | 51 | |
0e7519cd JH |
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. | |
bbee22da | 58 | |
a83b6f46 | 59 | =head2 Setup and utilities for Perl on OS/390 |
8fde188e GS |
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 | ||
9133bbab | 66 | This may also be a good time to ensure that your /etc/protocol file |
8fde188e | 67 | and either your /etc/resolv.conf or /etc/hosts files are in place. |
eae55d03 PK |
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. | |
8fde188e | 71 | |
37a78d01 JH |
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>. | |
9d116dd7 | 75 | |
9133bbab NIS |
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 | |
eae55d03 PK |
81 | for OS/390 UNIX", SG24-5944-00 from IBM. |
82 | ||
9133bbab NIS |
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 | |
8dd596cc PP |
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 | ||
f2766b05 PP |
92 | You might also want to have GNU groff for OS/390 installed before |
93 | running the `make install` step for Perl. | |
94 | ||
eae55d03 PK |
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 | ||
9133bbab NIS |
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 | |
eae55d03 | 105 | and PTF's UQ46272 and UQ46271 are the (R8 at least) fixes and apply them. |
9133bbab | 106 | If left unattended that syntax error will turn up as an inability for Perl |
eae55d03 PK |
107 | to build its "Socket" extension. |
108 | ||
9133bbab | 109 | For successful testing you may need to turn on the sticky bit for your |
eae55d03 PK |
110 | world 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 NIS |
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 | |
8fde188e GS |
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 | ||
eae55d03 PK |
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 | ||
8fde188e GS |
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 | |
eae55d03 | 134 | before running Perl's Configure. This step ensures successful extraction |
9133bbab NIS |
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 | |
59c9e5d6 | 140 | attempting to re-run Configure. |
8fde188e GS |
141 | |
142 | =item * | |
143 | ||
f2766b05 PP |
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. | |
59c9e5d6 PP |
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 | ||
9133bbab | 156 | then your LIBPATH does not have the location of libperl.x and either |
59c9e5d6 PP |
157 | libperl.dll or libperl.so in it. Add that directory to your LIBPATH and |
158 | proceed. | |
8fde188e GS |
159 | |
160 | =item * | |
9d116dd7 | 161 | |
eae55d03 | 162 | Do not turn on the compiler optimization flag "-O". There is |
8fde188e GS |
163 | a bug in either the optimizer or perl that causes perl to |
164 | not work correctly when the optimizer is on. | |
9d116dd7 | 165 | |
8fde188e | 166 | =item * |
9d116dd7 | 167 | |
8fde188e GS |
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 | |
eae55d03 | 171 | an /etc/resolv.conf or an /etc/hosts, so that |
8fde188e GS |
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). | |
59c9e5d6 | 175 | You may have to look for things like HOSTNAME and DOMAINORIGIN |
9133bbab | 176 | in the "//'SYS1.TCPPARMS(TCPDATA)'" PDS member in order to |
59c9e5d6 | 177 | properly set up your /etc networking files. |
9d116dd7 | 178 | |
8fde188e GS |
179 | =back |
180 | ||
a83b6f46 | 181 | =head2 Build, Test, Install Perl on OS/390 |
8fde188e GS |
182 | |
183 | Simply put: | |
184 | ||
185 | sh Configure | |
186 | make | |
187 | make test | |
188 | ||
eae55d03 | 189 | if everything looks ok (see the next section for test/IVP diagnosis) then: |
8fde188e GS |
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 | ||
a83b6f46 | 197 | =head2 Build Anomalies with Perl on OS/390 |
eae55d03 PK |
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 | |
9133bbab | 204 | limits can be set on a per user ID basis in the USS segment of a RACF |
eae55d03 PK |
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 | ||
9133bbab | 209 | Within USS your /etc/profile or $HOME/.profile may limit your ulimit |
eae55d03 PK |
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 | ||
a83b6f46 | 221 | =head2 Testing Anomalies with Perl on OS/390 |
eae55d03 PK |
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 | comp/cpp.............ERROR CBC3191 ./.301989890.c:1 The character $ is not a | |
235 | valid C source character. | |
236 | FSUM3065 The COMPILE step ended with return code 12. | |
237 | FSUM3017 Could not compile .301989890.c. Correct the errors and try again. | |
238 | ok | |
239 | ||
240 | indicates that the t/comp/cpp.t test of Perl's -P command line switch has | |
241 | passed but that the particular invocation of c89 -E in the cpp script does | |
242 | not suppress the C compiler check of source code validity. | |
243 | ||
244 | =item * | |
245 | ||
246 | A message of the form: | |
247 | ||
248 | io/openpid...........CEE5210S The signal SIGHUP was received. | |
249 | CEE5210S The signal SIGHUP was received. | |
250 | CEE5210S The signal SIGHUP was received. | |
251 | ok | |
252 | ||
253 | indicates that the t/io/openpid.t test of Perl has passed but done so | |
254 | with extraneous messages on stderr from CEE. | |
255 | ||
256 | =item * | |
257 | ||
258 | A message of the form: | |
259 | ||
260 | lib/ftmp-security....File::Temp::_gettemp: Parent directory (/tmp/) is not safe | |
261 | (sticky bit not set when world writable?) at lib/ftmp-security.t line 100 | |
262 | File::Temp::_gettemp: Parent directory (/tmp/) is not safe (sticky bit not | |
263 | set when world writable?) at lib/ftmp-security.t line 100 | |
264 | ok | |
265 | ||
266 | indicates a problem with the permissions on your /tmp directory within the HFS. | |
267 | To correct that problem issue the command: | |
268 | ||
269 | chmod a+t /tmp | |
270 | ||
271 | from an account with write access to the directory entry for /tmp. | |
272 | ||
9133bbab NIS |
273 | =item * |
274 | ||
275 | Out of Memory! | |
276 | ||
277 | Recent perl test suite is quite memory hunrgy. In addition to the comments | |
278 | above on memory limitations it is also worth checking for _CEE_RUNOPTS | |
279 | in your environment. Perl now has (in miniperlmain.c) a C #pragma | |
210b36aa | 280 | to set CEE run options, but the environment variable wins. |
9133bbab | 281 | |
210b36aa | 282 | The C code asks for: |
9133bbab NIS |
283 | |
284 | #pragma runopts(HEAP(2M,500K,ANYWHERE,KEEP,8K,4K) STACK(,,ANY,) ALL31(ON)) | |
285 | ||
286 | The important parts of that are the second argument (the increment) to HEAP, | |
287 | and allowing the stack to be "Above the (16M) line". If the heap | |
210b36aa AMS |
288 | increment is too small then when perl (for example loading unicode/Name.pl) tries |
289 | to create a "big" (400K+) string it cannot fit in a single segment | |
9133bbab NIS |
290 | and you get "Out of Memory!" - even if there is still plenty of memory |
291 | available. | |
292 | ||
293 | A related issue is use with perl's malloc. Perl's malloc uses C<sbrk()> | |
294 | to get memory, and C<sbrk()> is limited to the first allocation so in this | |
295 | case something like: | |
296 | ||
297 | HEAP(8M,500K,ANYWHERE,KEEP,8K,4K) | |
298 | ||
299 | is needed to get through the test suite. | |
300 | ||
301 | ||
eae55d03 PK |
302 | =back |
303 | ||
a83b6f46 | 304 | =head2 Installation Anomalies with Perl on OS/390 |
f2766b05 PP |
305 | |
306 | The installman script will try to run on OS/390. There will be fewer errors | |
9133bbab | 307 | if you have a roff utility installed. You can obtain GNU groff from the |
f2766b05 PP |
308 | Redbook SG24-5944-00 ftp site. |
309 | ||
a83b6f46 | 310 | =head2 Usage Hints for Perl on OS/390 |
64d55c8a | 311 | |
9d116dd7 | 312 | When using perl on OS/390 please keep in mind that the EBCDIC and ASCII |
9133bbab NIS |
313 | character sets are different. See perlebcdic.pod for more on such character |
314 | set issues. Perl builtin functions that may behave differently under | |
eae55d03 | 315 | EBCDIC are also mentioned in the perlport.pod document. |
9d116dd7 | 316 | |
9133bbab NIS |
317 | Open Edition (UNIX System Services) from V2R8 onward does support |
318 | #!/path/to/perl script invocation. There is a PTF available from | |
eae55d03 | 319 | IBM for V2R7 that will allow shell/kernel support for #!. USS |
9133bbab | 320 | releases prior to V2R7 did not support the #! means of script invocation. |
eae55d03 | 321 | If you are running V2R6 or earlier then see: |
9d116dd7 JH |
322 | |
323 | head `whence perldoc` | |
324 | ||
325 | for an example of how to use the "eval exec" trick to ask the shell to | |
eae55d03 PK |
326 | have Perl run your scripts on those older releases of Unix System Services. |
327 | ||
59c9e5d6 | 328 | If you are having trouble with square brackets then consider switching your |
9133bbab | 329 | rlogin or telnet client. Try to avoid older 3270 emulators and ISHELL for |
59c9e5d6 PP |
330 | working with Perl on USS. |
331 | ||
a83b6f46 | 332 | =head2 Floating Point Anomalies with Perl on OS/390 |
35a77668 | 333 | |
9133bbab NIS |
334 | There appears to be a bug in the floating point implementation on S/390 |
335 | systems such that calling int() on the product of a number and a small | |
336 | magnitude number is not the same as calling int() on the quotient of | |
337 | that number and a large magnitude number. For example, in the following | |
35a77668 PP |
338 | Perl code: |
339 | ||
340 | my $x = 100000.0; | |
341 | my $y = int($x * 1e-5) * 1e5; # '0' | |
342 | my $z = int($x / 1e+5) * 1e5; # '100000' | |
343 | print "\$y is $y and \$z is $z\n"; # $y is 0 and $z is 100000 | |
344 | ||
9133bbab | 345 | Although one would expect the quantities $y and $z to be the same and equal |
35a77668 PP |
346 | to 100000 they will differ and instead will be 0 and 100000 respectively. |
347 | ||
348 | The problem can be further examined in a roughly equivalent C program: | |
349 | ||
350 | #include <stdio.h> | |
351 | #include <math.h> | |
352 | main() | |
353 | { | |
354 | double r1,r2; | |
355 | double x = 100000.0; | |
356 | double y = 0.0; | |
357 | double z = 0.0; | |
358 | x = 100000.0 * 1e-5; | |
359 | r1 = modf (x,&y); | |
360 | x = 100000.0 / 1e+5; | |
361 | r2 = modf (x,&z); | |
362 | printf("y is %e and z is %e\n",y*1e5,z*1e5); | |
363 | /* y is 0.000000e+00 and z is 1.000000e+05 (with c89) */ | |
364 | } | |
365 | ||
a83b6f46 | 366 | =head2 Modules and Extensions for Perl on OS/390 |
eae55d03 PK |
367 | |
368 | Pure pure (that is non xs) modules may be installed via the usual: | |
369 | ||
370 | perl Makefile.PL | |
371 | make | |
372 | make test | |
373 | make install | |
374 | ||
f2766b05 PP |
375 | If you built perl with dynamic loading capability then that would also |
376 | be the way to build xs based extensions. However, if you built perl with | |
9133bbab NIS |
377 | the default static linking you can still build xs based extensions for OS/390 |
378 | but you will need to follow the instructions in ExtUtils::MakeMaker for | |
379 | building statically linked perl binaries. In the simplest configurations | |
59c9e5d6 | 380 | building a static perl + xs extension boils down to: |
9d116dd7 | 381 | |
eae55d03 PK |
382 | perl Makefile.PL |
383 | make | |
384 | make perl | |
385 | make test | |
386 | make install | |
387 | make -f Makefile.aperl inst_perl MAP_TARGET=perl | |
8fde188e | 388 | |
9133bbab | 389 | In most cases people have reported better results with GNU make rather |
eae55d03 PK |
390 | than the system's /bin/make program, whether for plain modules or for |
391 | xs based extensions. | |
8fde188e | 392 | |
f2766b05 PP |
393 | If the make process encounters trouble with either compilation or |
394 | linking then try setting the _C89_CCMODE to 1. Assuming sh is your | |
395 | login shell then run: | |
396 | ||
397 | export _C89_CCMODE=1 | |
398 | ||
399 | If tcsh is your login shell then use the setenv command. | |
400 | ||
8fde188e GS |
401 | =head1 AUTHORS |
402 | ||
eae55d03 PK |
403 | David Fiander and Peter Prymmer with thanks to Dennis Longnecker |
404 | and William Raffloer for valuable reports, LPAR and PTF feedback. | |
405 | Thanks to Mike MacIsaac and Egon Terwedow for SG24-5944-00. | |
35a77668 | 406 | Thanks to Ignasi Roca for pointing out the floating point problems. |
f2766b05 | 407 | Thanks to John Goodyear for dynamic loading help. |
8fde188e GS |
408 | |
409 | =head1 SEE ALSO | |
410 | ||
eae55d03 PK |
411 | L<INSTALL>, L<perlport>, L<perlebcdic>, L<ExtUtils::MakeMaker>. |
412 | ||
37a78d01 | 413 | http://www-1.ibm.com/servers/eserver/zseries/zos/unix/bpxa1toy.html |
eae55d03 PK |
414 | |
415 | http://www.redbooks.ibm.com/abstracts/sg245944.html | |
416 | ||
1e32511c | 417 | http://www-1.ibm.com/servers/eserver/zseries/zos/unix/bpxa1ty1.html#opensrc |
eae55d03 PK |
418 | |
419 | http://www.xray.mpe.mpg.de/mailing-lists/perl-mvs/ | |
8fde188e | 420 | |
9133bbab NIS |
421 | http://publibz.boulder.ibm.com:80/cgi-bin/bookmgr_OS390/BOOKS/ceea3030/ |
422 | ||
423 | http://publibz.boulder.ibm.com:80/cgi-bin/bookmgr_OS390/BOOKS/CBCUG030/ | |
424 | ||
a83b6f46 | 425 | =head2 Mailing list for Perl on OS/390 |
8fde188e | 426 | |
3f66d419 JH |
427 | If you are interested in the VM/ESA, z/OS (formerly known as OS/390) |
428 | and POSIX-BC (BS2000) ports of Perl then see the perl-mvs mailing list. | |
429 | To subscribe, send an empty message to perl-mvs-subscribe@perl.org. | |
9d116dd7 | 430 | |
3f66d419 | 431 | See also: |
35a77668 PP |
432 | |
433 | http://lists.perl.org/showlist.cgi?name=perl-mvs | |
434 | ||
435 | There are web archives of the mailing list at: | |
eae55d03 PK |
436 | |
437 | http://www.xray.mpe.mpg.de/mailing-lists/perl-mvs/ | |
35a77668 | 438 | http://archive.develooper.com/perl-mvs@perl.org/ |
9d116dd7 | 439 | |
8fde188e GS |
440 | =head1 HISTORY |
441 | ||
442 | This document was originally written by David Fiander for the 5.005 | |
443 | release of Perl. | |
444 | ||
eae55d03 PK |
445 | This document was podified for the 5.005_03 release of Perl 11 March 1999. |
446 | ||
37a78d01 JH |
447 | Updated 28 November 2001 for broken URLs. |
448 | ||
eae55d03 | 449 | Updated 12 November 2000 for the 5.7.1 release of Perl. |
8fde188e | 450 | |
35a77668 PP |
451 | Updated 15 January 2001 for the 5.7.1 release of Perl. |
452 | ||
f2766b05 PP |
453 | Updated 24 January 2001 to mention dynamic loading. |
454 | ||
59c9e5d6 PP |
455 | Updated 12 March 2001 to mention //'SYS1.TCPPARMS(TCPDATA)'. |
456 | ||
8fde188e | 457 | =cut |
eae55d03 | 458 |