1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | staticperl - perl, libc, 100 modules, all in one 500kb file |
3 | staticperl - perl, libc, 100 modules, all in one standalone 500kb file |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | staticperl help # print the embedded documentation |
7 | staticperl help # print the embedded documentation |
8 | staticperl fetch # fetch and unpack perl sources |
8 | staticperl fetch # fetch and unpack perl sources |
9 | staticperl configure # fetch and then configure perl |
9 | staticperl configure # fetch and then configure perl |
10 | staticperl build # configure and then build perl |
10 | staticperl build # configure and then build perl |
11 | staticperl install # build and then install perl |
11 | staticperl install # build and then install perl |
12 | staticperl clean # clean most intermediate files (restart at configure) |
12 | staticperl clean # clean most intermediate files (restart at configure) |
13 | staticperl distclean # delete everything installed by this script |
13 | staticperl distclean # delete everything installed by this script |
|
|
14 | staticperl perl ... # invoke the perlinterpreter |
14 | staticperl cpan # invoke CPAN shell |
15 | staticperl cpan # invoke CPAN shell |
15 | staticperl instmod path... # install unpacked modules |
16 | staticperl instsrc path... # install unpacked modules |
16 | staticperl instcpan modulename... # install modules from CPAN |
17 | staticperl instcpan modulename... # install modules from CPAN |
17 | staticperl mkbundle <bundle-args...> # see documentation |
18 | staticperl mkbundle <bundle-args...> # see documentation |
18 | staticperl mkperl <bundle-args...> # see documentation |
19 | staticperl mkperl <bundle-args...> # see documentation |
19 | staticperl mkapp appname <bundle-args...> # see documentation |
20 | staticperl mkapp appname <bundle-args...> # see documentation |
20 | |
21 | |
21 | Typical Examples: |
22 | Typical Examples: |
22 | |
23 | |
23 | staticperl install # fetch, configure, build and install perl |
24 | staticperl install # fetch, configure, build and install perl |
24 | staticperl cpan # run interactive cpan shell |
25 | staticperl cpan # run interactive cpan shell |
25 | staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V |
26 | staticperl mkperl -MConfig_heavy.pl # build a perl that supports -V |
26 | staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http |
27 | staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http |
27 | # build a perl with the above modules linked in |
28 | # build a perl with the above modules linked in |
28 | staticperl mkapp myapp --boot mainprog mymodules |
29 | staticperl mkapp myapp --boot mainprog mymodules |
29 | # build a binary "myapp" from mainprog and mymodules |
30 | # build a binary "myapp" from mainprog and mymodules |
30 | |
31 | |
… | |
… | |
38 | file that contains perl interpreter, libc, all the modules you need, all |
39 | file that contains perl interpreter, libc, all the modules you need, all |
39 | the libraries you need and of course your actual program. |
40 | the libraries you need and of course your actual program. |
40 | |
41 | |
41 | With F<uClibc> and F<upx> on x86, you can create a single 500kb binary |
42 | With F<uClibc> and F<upx> on x86, you can create a single 500kb binary |
42 | that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO, |
43 | that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO, |
43 | Coro and so on. Or any other choice of modules. |
44 | Coro and so on. Or any other choice of modules (and some other size :). |
44 | |
45 | |
45 | To see how this turns out, you can try out smallperl and bigperl, two |
46 | To see how this turns out, you can try out smallperl and bigperl, two |
46 | pre-built static and compressed perl binaries with many and even more |
47 | pre-built static and compressed perl binaries with many and even more |
47 | modules: just follow the links at L<http://staticperl.schmorp.de/>. |
48 | modules: just follow the links at L<http://staticperl.schmorp.de/>. |
48 | |
49 | |
… | |
… | |
83 | With F<staticperl>, the burden is mostly with the developer - only direct |
84 | With F<staticperl>, the burden is mostly with the developer - only direct |
84 | compile-time dependencies and L<AutoLoader> are handled automatically. |
85 | compile-time dependencies and L<AutoLoader> are handled automatically. |
85 | This means the modules to include often need to be tweaked manually. |
86 | This means the modules to include often need to be tweaked manually. |
86 | |
87 | |
87 | All this does not preclude more permissive modes to be implemented in |
88 | All this does not preclude more permissive modes to be implemented in |
88 | the future, but right now, you have to resolve state hidden dependencies |
89 | the future, but right now, you have to resolve hidden dependencies |
89 | manually. |
90 | manually. |
90 | |
91 | |
91 | =item * PAR works out of the box, F<staticperl> does not. |
92 | =item * PAR works out of the box, F<staticperl> does not. |
92 | |
93 | |
93 | Maintaining your own custom perl build can be a pain in the ass, and while |
94 | Maintaining your own custom perl build can be a pain in the ass, and while |
… | |
… | |
139 | with creating binaries and bundle files. |
140 | with creating binaries and bundle files. |
140 | |
141 | |
141 | =head2 PHASE 1 COMMANDS: INSTALLING PERL |
142 | =head2 PHASE 1 COMMANDS: INSTALLING PERL |
142 | |
143 | |
143 | The most important command is F<install>, which does basically |
144 | The most important command is F<install>, which does basically |
144 | everything. The default is to download and install perl 5.12.2 and a few |
145 | everything. The default is to download and install perl 5.12.3 and a few |
145 | modules required by F<staticperl> itself, but all this can (and should) be |
146 | modules required by F<staticperl> itself, but all this can (and should) be |
146 | changed - see L<CONFIGURATION>, below. |
147 | changed - see L<CONFIGURATION>, below. |
147 | |
148 | |
148 | The command |
149 | The command |
149 | |
150 | |
… | |
… | |
186 | =item F<staticperl install> |
187 | =item F<staticperl install> |
187 | |
188 | |
188 | Wipes the perl installation directory (usually F<~/.staticperl/perl>) and |
189 | Wipes the perl installation directory (usually F<~/.staticperl/perl>) and |
189 | installs the perl distribution, potentially after building it first. |
190 | installs the perl distribution, potentially after building it first. |
190 | |
191 | |
|
|
192 | =item F<staticperl perl> [args...] |
|
|
193 | |
|
|
194 | Invokes the compiled perl interpreter with the given args. Basically the |
|
|
195 | same as starting perl directly (usually via F<~/.staticperl/bin/perl>), |
|
|
196 | but beats typing the path sometimes. |
|
|
197 | |
|
|
198 | Example: check that the Gtk2 module is installed and loadable. |
|
|
199 | |
|
|
200 | staticperl perl -MGtk2 -e0 |
|
|
201 | |
191 | =item F<staticperl cpan> [args...] |
202 | =item F<staticperl cpan> [args...] |
192 | |
203 | |
193 | Starts an interactive CPAN shell that you can use to install further |
204 | Starts an interactive CPAN shell that you can use to install further |
194 | modules. Installs the perl first if necessary, but apart from that, |
205 | modules. Installs the perl first if necessary, but apart from that, |
195 | no magic is involved: you could just as well run it manually via |
206 | no magic is involved: you could just as well run it manually via |
196 | F<~/.staticperl/perl/bin/cpan>. |
207 | F<~/.staticperl/perl/bin/cpan>, except that F<staticperl> additionally |
|
|
208 | sets the environment variable C<$PERL> to the path of the perl |
|
|
209 | interpreter, which is handy in subshells. |
197 | |
210 | |
198 | Any additional arguments are simply passed to the F<cpan> command. |
211 | Any additional arguments are simply passed to the F<cpan> command. |
199 | |
212 | |
200 | =item F<staticperl instcpan> module... |
213 | =item F<staticperl instcpan> module... |
201 | |
214 | |
… | |
… | |
252 | |
265 | |
253 | # first make sure we have perl and the required modules |
266 | # first make sure we have perl and the required modules |
254 | staticperl instcpan AnyEvent::HTTPD |
267 | staticperl instcpan AnyEvent::HTTPD |
255 | |
268 | |
256 | # now build the perl |
269 | # now build the perl |
257 | staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \ |
270 | staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \ |
258 | -MAnyEvent::HTTPD -MURI::http \ |
271 | -MAnyEvent::HTTPD -MURI::http \ |
259 | --add 'eg/httpd httpd.pm' |
272 | --add 'eg/httpd httpd.pm' |
260 | |
273 | |
261 | # finally, invoke it |
274 | # finally, invoke it |
262 | ./perl -Mhttpd |
275 | ./perl -Mhttpd |
… | |
… | |
313 | |
326 | |
314 | =head3 OPTION PROCESSING |
327 | =head3 OPTION PROCESSING |
315 | |
328 | |
316 | All options can be given as arguments on the command line (typically |
329 | All options can be given as arguments on the command line (typically |
317 | using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since |
330 | using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since |
318 | specifying a lot of modules can make the command line very cumbersome, you |
331 | specifying a lot of options can make the command line very long and |
319 | can put all long options into a "bundle specification file" (one option |
332 | unwieldy, you can put all long options into a "bundle specification file" |
320 | per line, with or without C<--> prefix) and specify this bundle file |
333 | (one option per line, with or without C<--> prefix) and specify this |
321 | instead. |
334 | bundle file instead. |
322 | |
335 | |
323 | For example, the command given earlier could also look like this: |
336 | For example, the command given earlier to link a new F<perl> could also |
|
|
337 | look like this: |
324 | |
338 | |
325 | staticperl mkperl httpd.bundle |
339 | staticperl mkperl httpd.bundle |
326 | |
340 | |
327 | And all options could be in F<httpd.bundle>: |
341 | With all options stored in the F<httpd.bundle> file (one option per line, |
328 | |
342 | everything after the option is an argument): |
|
|
343 | |
329 | use "Config_heavy.pl" |
344 | use "Config_heavy.pl" |
330 | use AnyEvent::Impl::Perl |
345 | use AnyEvent::Impl::Perl |
331 | use AnyEvent::HTTPD |
346 | use AnyEvent::HTTPD |
332 | use URI::http |
347 | use URI::http |
333 | add eg/httpd httpd.pm |
348 | add eg/httpd httpd.pm |
334 | |
349 | |
335 | All options that specify modules or files to be added are processed in the |
350 | All options that specify modules or files to be added are processed in the |
336 | order given on the command line. |
351 | order given on the command line. |
337 | |
352 | |
338 | =head3 BUNDLE CREATION WORKFLOW |
353 | =head3 BUNDLE CREATION WORKFLOW / STATICPERL MKBUNDLE OPTIONS |
339 | |
354 | |
340 | F<staticperl mkbundle> works by first assembling a list of candidate |
355 | F<staticperl mkbundle> works by first assembling a list of candidate |
341 | files and modules to include, then filtering them by include/exclude |
356 | files and modules to include, then filtering them by include/exclude |
342 | patterns. The remaining modules (together with their direct depdendencies, |
357 | patterns. The remaining modules (together with their direct dependencies, |
343 | such as link libraries and AutoLoader files) are then converted into |
358 | such as link libraries and L<AutoLoader> files) are then converted into |
344 | bundle files suitable for embedding. Afterwards, F<staticperl mkbundle> |
359 | bundle files suitable for embedding. F<staticperl mkbundle> can then |
345 | can optionally build a new perl interpreter or a standalone application. |
360 | optionally build a new perl interpreter or a standalone application. |
346 | |
361 | |
347 | =over 4 |
362 | =over 4 |
348 | |
363 | |
349 | =item Step 0: Generic argument processing. |
364 | =item Step 0: Generic argument processing. |
350 | |
365 | |
351 | The following options influence F<staticperl mkbundle> itself. |
366 | The following options influence F<staticperl mkbundle> itself. |
352 | |
367 | |
353 | =over 4 |
368 | =over 4 |
354 | |
369 | |
355 | =item --verbose | -v |
370 | =item C<--verbose> | C<-v> |
356 | |
371 | |
357 | Increases the verbosity level by one (the default is C<1>). |
372 | Increases the verbosity level by one (the default is C<1>). |
358 | |
373 | |
359 | =item --quiet | -q |
374 | =item C<--quiet> | C<-q> |
360 | |
375 | |
361 | Decreases the verbosity level by one. |
376 | Decreases the verbosity level by one. |
362 | |
377 | |
363 | =item any other argument |
378 | =item any other argument |
364 | |
379 | |
365 | Any other argument is interpreted as a bundle specification file, which |
380 | Any other argument is interpreted as a bundle specification file, which |
366 | supports most long options (without extra quoting), one option per line. |
381 | supports all options (without extra quoting), one option per line, in the |
|
|
382 | format C<option> or C<option argument>. They will effectively be expanded |
|
|
383 | and processed as if they were directly written on the command line, in |
|
|
384 | place of the file name. |
367 | |
385 | |
368 | =back |
386 | =back |
369 | |
387 | |
370 | =item Step 1: gather candidate files and modules |
388 | =item Step 1: gather candidate files and modules |
371 | |
389 | |
… | |
… | |
376 | |
394 | |
377 | =over 4 |
395 | =over 4 |
378 | |
396 | |
379 | =item C<--use> F<module> | C<-M>F<module> |
397 | =item C<--use> F<module> | C<-M>F<module> |
380 | |
398 | |
381 | Include the named module and trace direct dependencies. This is done by |
399 | Include the named module or perl library and trace direct |
382 | C<require>'ing the module in a subprocess and tracing which other modules |
400 | dependencies. This is done by loading the module in a subprocess and |
383 | and files it actually loads. |
401 | tracing which other modules and files it actually loads. |
384 | |
402 | |
385 | Example: include AnyEvent and AnyEvent::Impl::Perl. |
403 | Example: include AnyEvent and AnyEvent::Impl::Perl. |
386 | |
404 | |
387 | staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl |
405 | staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl |
388 | |
406 | |
389 | Sometimes you want to load old-style "perl libraries" (F<.pl> files), or |
407 | Sometimes you want to load old-style "perl libraries" (F<.pl> files), or |
390 | maybe other weirdly named files. To do that, you need to quote the name in |
408 | maybe other weirdly named files. To support this, the C<--use> option |
391 | single or double quotes. When given on the command line, you probably need |
409 | actually tries to do what you mean, depending on the string you specify: |
392 | to quote once more to avoid your shell interpreting it. Common cases that |
410 | |
393 | need this are F<Config_heavy.pl> and F<utf8_heavy.pl>. |
411 | =over 4 |
|
|
412 | |
|
|
413 | =item a possibly valid module name, e.g. F<common::sense>, F<Carp>, |
|
|
414 | F<Coro::Mysql>. |
|
|
415 | |
|
|
416 | If the string contains no quotes, no F</> and no F<.>, then C<--use> |
|
|
417 | assumes that it is a normal module name. It will create a new package and |
|
|
418 | evaluate a C<use module> in it, i.e. it will load the package and do a |
|
|
419 | default import. |
|
|
420 | |
|
|
421 | The import step is done because many modules trigger more dependencies |
|
|
422 | when something is imported than without. |
|
|
423 | |
|
|
424 | =item anything that contains F</> or F<.> characters, |
|
|
425 | e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>. |
|
|
426 | |
|
|
427 | The string will be quoted and passed to require, as if you used C<require |
|
|
428 | $module>. Nothing will be imported. |
|
|
429 | |
|
|
430 | =item "path" or 'path', e.g. C<"utf8_heavy.pl">. |
|
|
431 | |
|
|
432 | If you enclose the name into single or double quotes, then the quotes will |
|
|
433 | be removed and the resulting string will be passed to require. This syntax |
|
|
434 | is form compatibility with older versions of staticperl and should not be |
|
|
435 | used anymore. |
|
|
436 | |
|
|
437 | =back |
|
|
438 | |
|
|
439 | Example: C<use> AnyEvent::Socket, once using C<use> (importing the |
|
|
440 | symbols), and once via C<require>, not importing any symbols. The first |
|
|
441 | form is preferred as many modules load some extra dependencies when asked |
|
|
442 | to export symbols. |
|
|
443 | |
|
|
444 | staticperl mkbundle -MAnyEvent::Socket # use + import |
|
|
445 | staticperl mkbundle -MAnyEvent/Socket.pm # require only |
394 | |
446 | |
395 | Example: include the required files for F<perl -V> to work in all its |
447 | Example: include the required files for F<perl -V> to work in all its |
396 | glory (F<Config.pm> is included automatically by this). |
448 | glory (F<Config.pm> is included automatically by the dependency tracker). |
397 | |
449 | |
398 | # bourne shell |
450 | # shell command |
399 | staticperl mkbundle --use '"Config_heavy.pl"' |
451 | staticperl mkbundle -MConfig_heavy.pl |
400 | |
452 | |
401 | # bundle specification file |
453 | # bundle specification file |
402 | use "Config_heavy.pl" |
454 | use Config_heavy.pl |
403 | |
455 | |
404 | The C<-M>module syntax is included as an alias that might be easier to |
456 | The C<-M>module syntax is included as a convenience that might be easier |
405 | remember than C<--use>. Or maybe it confuses people. Time will tell. Or |
457 | to remember than C<--use> - it's the same switch as perl itself uses |
|
|
458 | to load modules. Or maybe it confuses people. Time will tell. Or maybe |
406 | maybe not. Sigh. |
459 | not. Sigh. |
407 | |
460 | |
408 | =item C<--eval> "perl code" | C<-e> "perl code" |
461 | =item C<--eval> "perl code" | C<-e> "perl code" |
409 | |
462 | |
410 | Sometimes it is easier (or necessary) to specify dependencies using perl |
463 | Sometimes it is easier (or necessary) to specify dependencies using perl |
411 | code, or maybe one of the modules you use need a special use statement. In |
464 | code, or maybe one of the modules you use need a special use statement. In |
412 | that case, you can use C<--eval> to execute some perl snippet or set some |
465 | that case, you can use C<--eval> to execute some perl snippet or set some |
413 | variables or whatever you need. All files C<require>'d or C<use>'d while |
466 | variables or whatever you need. All files C<require>'d or C<use>'d while |
414 | executing the snippet are included in the final bundle. |
467 | executing the snippet are included in the final bundle. |
415 | |
468 | |
416 | Keep in mind that F<mkbundle> will only C<require> the modules named |
469 | Keep in mind that F<mkbundle> will not import any symbols from the modules |
417 | by the C<--use> option, so do not expect the symbols from modules you |
470 | named by the C<--use> option, so do not expect the symbols from modules |
418 | C<--use>'d earlier on the command line to be available. |
471 | you C<--use>'d earlier on the command line to be available. |
419 | |
472 | |
420 | Example: force L<AnyEvent> to detect a backend and therefore include it |
473 | Example: force L<AnyEvent> to detect a backend and therefore include it |
421 | in the final bundle. |
474 | in the final bundle. |
422 | |
475 | |
423 | staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect' |
476 | staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect' |
… | |
… | |
450 | This is very useful to include "everything": |
503 | This is very useful to include "everything": |
451 | |
504 | |
452 | --incglob '*' |
505 | --incglob '*' |
453 | |
506 | |
454 | It is also useful for including perl libraries, or trees of those, such as |
507 | It is also useful for including perl libraries, or trees of those, such as |
455 | the unicode database files needed by some perl builtins, the regex engine |
508 | the unicode database files needed by some perl built-ins, the regex engine |
456 | and other modules. |
509 | and other modules. |
457 | |
510 | |
458 | --incglob '/unicore/**.pl' |
511 | --incglob '/unicore/**.pl' |
459 | |
512 | |
460 | =item C<--add> F<file> | C<--add> "F<file> alias" |
513 | =item C<--add> F<file> | C<--add> "F<file> alias" |
461 | |
514 | |
462 | Adds the given (perl) file into the bundle (and optionally call it |
515 | Adds the given (perl) file into the bundle (and optionally call it |
463 | "alias"). The F<file> is either an absolute path or a path relative to |
516 | "alias"). The F<file> is either an absolute path or a path relative to the |
464 | the current directory. If an alias is specified, then this is the name it |
517 | current directory. If an alias is specified, then this is the name it will |
465 | will use for C<@INC> searches, otherfile the F<file> will be used as the |
518 | use for C<@INC> searches, otherwise the path F<file> will be used as the |
466 | internal name. |
519 | internal name. |
467 | |
520 | |
468 | This switch is used to include extra files into the bundle. |
521 | This switch is used to include extra files into the bundle. |
469 | |
522 | |
470 | Example: embed the file F<httpd> in the current directory as F<httpd.pm> |
523 | Example: embed the file F<httpd> in the current directory as F<httpd.pm> |
471 | when creating the bundle. |
524 | when creating the bundle. |
472 | |
525 | |
473 | staticperl mkperl --add "httpd httpd.pm" |
526 | staticperl mkperl --add "httpd httpd.pm" |
|
|
527 | |
|
|
528 | # can be accessed via "use httpd" |
|
|
529 | |
|
|
530 | Example: add a file F<initcode> from the current directory. |
|
|
531 | |
|
|
532 | staticperl mkperl --add 'initcode &initcode' |
|
|
533 | |
|
|
534 | # can be accessed via "do '&initcode'" |
474 | |
535 | |
475 | Example: add local files as extra modules in the bundle. |
536 | Example: add local files as extra modules in the bundle. |
476 | |
537 | |
477 | # specification file |
538 | # specification file |
478 | add file1 myfiles/file1.pm |
539 | add file1 myfiles/file1.pm |
… | |
… | |
482 | # then later, in perl, use |
543 | # then later, in perl, use |
483 | use myfiles::file1; |
544 | use myfiles::file1; |
484 | require myfiles::file2; |
545 | require myfiles::file2; |
485 | my $res = do "myfiles/file3.pl"; |
546 | my $res = do "myfiles/file3.pl"; |
486 | |
547 | |
487 | =item C<--binadd> F<file> | C<--add> "F<file> alias" |
548 | =item C<--addbin> F<file> | C<--addbin> "F<file> alias" |
488 | |
549 | |
489 | Just like C<--add>, except that it treats the file as binary and adds it |
550 | Just like C<--add>, except that it treats the file as binary and adds it |
490 | without any postprocessing (perl files might get stripped to reduce their |
551 | without any postprocessing (perl files might get stripped to reduce their |
491 | size). |
552 | size). |
492 | |
553 | |
493 | You should probably add a C</> prefix to avoid clashing with embedded perl |
554 | If you specify an alias you should probably add a C</> prefix to avoid |
494 | files (whose paths do not start with C</>), and/or use a special directory |
555 | clashing with embedded perl files (whose paths never start with C</>), |
495 | prefix, such as C</res/name>. |
556 | and/or use a special directory prefix, such as C</res/name>. |
496 | |
557 | |
497 | You can later get a copy of these files by calling C<staticperl::find |
558 | You can later get a copy of these files by calling C<static::find |
498 | "alias">. |
559 | "alias">. |
499 | |
560 | |
500 | An alternative way to embed binary files is to convert them to perl and |
561 | An alternative way to embed binary files is to convert them to perl and |
501 | use C<do> to get the contents - this method is a bit cumbersome, but works |
562 | use C<do> to get the contents - this method is a bit cumbersome, but works |
502 | both inside and outside of a staticperl bundle: |
563 | both inside and outside of a staticperl bundle, without extra ado: |
503 | |
564 | |
504 | # a "binary" file, call it "bindata.pl" |
565 | # a "binary" file, call it "bindata.pl" |
505 | <<'SOME_MARKER' |
566 | <<'SOME_MARKER' |
506 | binary data NOT containing SOME_MARKER |
567 | binary data NOT containing SOME_MARKER |
507 | SOME_MARKER |
568 | SOME_MARKER |
508 | |
569 | |
509 | # load the binary |
570 | # load the binary |
510 | chomp (my $data = do "bindata.pl"); |
571 | chomp (my $data = do "bindata.pl"); |
511 | |
572 | |
|
|
573 | =item C<--allow-dynamic> |
|
|
574 | |
|
|
575 | By default, when F<mkbundle> hits a dynamic perl extension (e.g. a F<.so> |
|
|
576 | or F<.dll> file), it will stop with a fatal error. |
|
|
577 | |
|
|
578 | When this option is enabled, F<mkbundle> packages the shared |
|
|
579 | object into the bundle instead, with a prefix of F<!> |
|
|
580 | (e.g. F<!auto/List/Util/Util.so>). What you do with that is currently up |
|
|
581 | to you, F<staticperl> has no special support for this at the moment, apart |
|
|
582 | from working around the lack of availability of F<PerlIO::scalar> while |
|
|
583 | bootstrapping, at a speed cost. |
|
|
584 | |
|
|
585 | One way to deal with this is to write all files starting with F<!> into |
|
|
586 | some directory and then C<unshift> that path onto C<@INC>. |
|
|
587 | |
|
|
588 | #TODO: example |
|
|
589 | |
512 | =back |
590 | =back |
513 | |
591 | |
514 | =item Step 2: filter all files using C<--include> and C<--exclude> options. |
592 | =item Step 2: filter all files using C<--include> and C<--exclude> options. |
515 | |
593 | |
516 | After all candidate files and modules are added, they are I<filtered> |
594 | After all candidate files and modules are added, they are I<filtered> |
517 | by a combination of C<--include> and C<--exclude> patterns (there is an |
595 | by a combination of C<--include> and C<--exclude> patterns (there is an |
518 | implicit C<--include **> at the end, so if no filters are specified, all |
596 | implicit C<--include *> at the end, so if no filters are specified, all |
519 | files are included). |
597 | files are included). |
520 | |
598 | |
521 | All that this step does is potentially reduce the number of files that are |
599 | All that this step does is potentially reduce the number of files that are |
522 | to be included - no new files are added during this step. |
600 | to be included - no new files are added during this step. |
523 | |
601 | |
… | |
… | |
548 | that are added automatically. Only one (F<.packlist> files) is currently |
626 | that are added automatically. Only one (F<.packlist> files) is currently |
549 | optional and can be influenced, the others are always included: |
627 | optional and can be influenced, the others are always included: |
550 | |
628 | |
551 | =over 4 |
629 | =over 4 |
552 | |
630 | |
553 | =item C<--usepacklist> |
631 | =item C<--usepacklists> |
554 | |
632 | |
555 | Read F<.packlist> files for each distribution that happens to match a |
633 | Read F<.packlist> files for each distribution that happens to match a |
556 | module name you specified. Sounds weird, and it is, so expect semantics to |
634 | module name you specified. Sounds weird, and it is, so expect semantics to |
557 | change somehow in the future. |
635 | change somehow in the future. |
558 | |
636 | |
… | |
… | |
626 | Last not least, if you need accurate line numbers in error messages, |
704 | Last not least, if you need accurate line numbers in error messages, |
627 | or in the unlikely case where C<pod> is too slow, or some module gets |
705 | or in the unlikely case where C<pod> is too slow, or some module gets |
628 | mistreated, you can specify C<none> to not mangle included perl sources in |
706 | mistreated, you can specify C<none> to not mangle included perl sources in |
629 | any way. |
707 | any way. |
630 | |
708 | |
631 | =item --perl |
709 | =item C<--perl> |
632 | |
710 | |
633 | After writing out the bundle files, try to link a new perl interpreter. It |
711 | After writing out the bundle files, try to link a new perl interpreter. It |
634 | will be called F<perl> and will be left in the current working |
712 | will be called F<perl> and will be left in the current working |
635 | directory. The bundle files will be removed. |
713 | directory. The bundle files will be removed. |
636 | |
714 | |
… | |
… | |
641 | it will be even smaller than the standard perl interpreter as none of the |
719 | it will be even smaller than the standard perl interpreter as none of the |
642 | modules of the base distribution (such as L<Fcntl>) will be included. |
720 | modules of the base distribution (such as L<Fcntl>) will be included. |
643 | |
721 | |
644 | staticperl mkperl -Mcommon::sense |
722 | staticperl mkperl -Mcommon::sense |
645 | |
723 | |
646 | =item --app name |
724 | =item C<--app> F<name> |
647 | |
725 | |
648 | After writing out the bundle files, try to link a new standalone |
726 | After writing out the bundle files, try to link a new standalone |
649 | program. It will be called C<name>, and the bundle files get removed after |
727 | program. It will be called C<name>, and the bundle files get removed after |
650 | linking it. |
728 | linking it. |
651 | |
729 | |
… | |
… | |
655 | The difference to the (mutually exclusive) C<--perl> option is that the |
733 | The difference to the (mutually exclusive) C<--perl> option is that the |
656 | binary created by this option will not try to act as a perl interpreter - |
734 | binary created by this option will not try to act as a perl interpreter - |
657 | instead it will simply initialise the perl interpreter, clean it up and |
735 | instead it will simply initialise the perl interpreter, clean it up and |
658 | exit. |
736 | exit. |
659 | |
737 | |
660 | This means that, by default, it will do nothing but burna few CPU cycles |
738 | This means that, by default, it will do nothing but burn a few CPU cycles |
661 | - for it to do something useful you I<must> add some boot code, e.g. with |
739 | - for it to do something useful you I<must> add some boot code, e.g. with |
662 | the C<--boot> option. |
740 | the C<--boot> option. |
663 | |
741 | |
664 | Example: create a standalone perl binary called F<./myexe> that will |
742 | Example: create a standalone perl binary called F<./myexe> that will |
665 | execute F<appfile> when it is started. |
743 | execute F<appfile> when it is started. |
666 | |
744 | |
667 | staticperl mkbundle --app myexe --boot appfile |
745 | staticperl mkbundle --app myexe --boot appfile |
668 | |
746 | |
|
|
747 | =item C<--ignore-env> |
|
|
748 | |
|
|
749 | Generates extra code to unset some environment variables before |
|
|
750 | initialising/running perl. Perl supports a lot of environment variables |
|
|
751 | that might alter execution in ways that might be undesirablre for |
|
|
752 | standalone applications, and this option removes those known to cause |
|
|
753 | trouble. |
|
|
754 | |
|
|
755 | Specifically, these are removed: |
|
|
756 | |
|
|
757 | C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause undesirable |
|
|
758 | output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and |
|
|
759 | C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>, |
|
|
760 | C<PERLIO_DEBUG> and C<PERLIO> can affect input and output. |
|
|
761 | |
|
|
762 | The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the |
|
|
763 | startup code used by F<staticperl> overrides C<@INC> in all cases. |
|
|
764 | |
|
|
765 | This option will not make your program more secure (unless you are |
|
|
766 | running with elevated privileges), but it will reduce the surprise effect |
|
|
767 | when a user has these environment variables set and doesn't expect your |
|
|
768 | standalone program to act like a perl interpreter. |
|
|
769 | |
669 | =item --static |
770 | =item C<--static> |
670 | |
771 | |
671 | Add C<-static> to F<bundle.ldopts>, which means a fully static (if |
772 | Add C<-static> to F<bundle.ldopts>, which means a fully static (if |
672 | supported by the OS) executable will be created. This is not immensely |
773 | supported by the OS) executable will be created. This is not immensely |
673 | useful when just creating the bundle files, but is most useful when |
774 | useful when just creating the bundle files, but is most useful when |
674 | linking a binary with the C<--perl> or C<--app> options. |
775 | linking a binary with the C<--perl> or C<--app> options. |
… | |
… | |
681 | systems based on GNU libc don't really support it in a very usable |
782 | systems based on GNU libc don't really support it in a very usable |
682 | fashion either. Try uClibc if you want to create fully statically linked |
783 | fashion either. Try uClibc if you want to create fully statically linked |
683 | executables, or try the C<--staticlib> option to link only some libraries |
784 | executables, or try the C<--staticlib> option to link only some libraries |
684 | statically. |
785 | statically. |
685 | |
786 | |
686 | =item --staticlib libname |
787 | =item C<--staticlib> libname |
687 | |
788 | |
688 | When not linking fully statically, this option allows you to link specific |
789 | When not linking fully statically, this option allows you to link specific |
689 | libraries statically. What it does is simply replace all occurances of |
790 | libraries statically. What it does is simply replace all occurrences of |
690 | C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic> |
791 | C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic> |
691 | option. |
792 | option. |
692 | |
793 | |
693 | This will have no effect unless the library is actually linked against, |
794 | This will have no effect unless the library is actually linked against, |
694 | specifically, C<--staticlib> will not link against the named library |
795 | specifically, C<--staticlib> will not link against the named library |
695 | unless it would be linked against anyway. |
796 | unless it would be linked against anyway. |
696 | |
797 | |
697 | Example: link libcrypt statically into the binary. |
798 | Example: link libcrypt statically into the final binary. |
698 | |
799 | |
699 | staticperl mkperl -MIO::AIO --staticlib crypt |
800 | staticperl mkperl -MIO::AIO --staticlib crypt |
700 | |
801 | |
701 | # ldopts might now contain: |
802 | # ldopts might now contain: |
702 | # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread |
803 | # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread |
… | |
… | |
723 | =item Patterns not starting with F</> will be anchored at the end of the path. |
824 | =item Patterns not starting with F</> will be anchored at the end of the path. |
724 | |
825 | |
725 | That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the |
826 | That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the |
726 | hierarchy, but not any directories of the same name. |
827 | hierarchy, but not any directories of the same name. |
727 | |
828 | |
728 | =item A F<*> matches any single component. |
829 | =item A F<*> matches anything within a single path component. |
729 | |
830 | |
730 | That is, F</unicore/*.pl> would match all F<.pl> files directly inside |
831 | That is, F</unicore/*.pl> would match all F<.pl> files directly inside |
731 | C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*> |
832 | C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*> |
732 | will not match slashes. |
833 | will not match slashes. |
733 | |
834 | |
… | |
… | |
800 | =item C<STATICPERL> |
901 | =item C<STATICPERL> |
801 | |
902 | |
802 | The directory where staticperl stores all its files |
903 | The directory where staticperl stores all its files |
803 | (default: F<~/.staticperl>). |
904 | (default: F<~/.staticperl>). |
804 | |
905 | |
|
|
906 | =item C<DLCACHE> |
|
|
907 | |
|
|
908 | The path to a directory (will be created if it doesn't exist) where |
|
|
909 | downloaded perl sources are being cached, to avoid downloading them |
|
|
910 | again. The default is empty, which means there is no cache. |
|
|
911 | |
|
|
912 | =item C<PERL_VERSION> |
|
|
913 | |
|
|
914 | The perl version to install - default is currently C<5.12.3>, but C<5.8.9> |
|
|
915 | is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is |
|
|
916 | about as big as 5.12.3). |
|
|
917 | |
805 | =item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ... |
918 | =item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ... |
806 | |
919 | |
807 | Usually set to C<1> to make modules "less inquisitive" during their |
920 | Usually set to C<1> to make modules "less inquisitive" during their |
808 | installation, you can set any environment variable you want - some modules |
921 | installation. You can set (and export!) any environment variable you want |
809 | (such as L<Coro> or L<EV>) use environment variables for further tweaking. |
922 | - some modules (such as L<Coro> or L<EV>) use environment variables for |
810 | |
923 | further tweaking. |
811 | =item C<PERL_VERSION> |
|
|
812 | |
|
|
813 | The perl version to install - default is currently C<5.12.2>, but C<5.8.9> |
|
|
814 | is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is |
|
|
815 | about as big as 5.12.2). |
|
|
816 | |
924 | |
817 | =item C<PERL_PREFIX> |
925 | =item C<PERL_PREFIX> |
818 | |
926 | |
819 | The prefix where perl gets installed (default: F<$STATICPERL/perl>), |
927 | The directory where perl gets installed (default: F<$STATICPERL/perl>), |
820 | i.e. where the F<bin> and F<lib> subdirectories will end up. |
928 | i.e. where the F<bin> and F<lib> subdirectories will end up. Previous |
|
|
929 | contents will be removed on installation. |
821 | |
930 | |
822 | =item C<PERL_CONFIGURE> |
931 | =item C<PERL_CONFIGURE> |
823 | |
932 | |
824 | Additional Configure options - these are simply passed to the perl |
933 | Additional Configure options - these are simply passed to the perl |
825 | Configure script. For example, if you wanted to enable dynamic loading, |
934 | Configure script. For example, if you wanted to enable dynamic loading, |
… | |
… | |
841 | F<~/.staticperlrc> to override them. |
950 | F<~/.staticperlrc> to override them. |
842 | |
951 | |
843 | Most of the variables override (or modify) the corresponding F<Configure> |
952 | Most of the variables override (or modify) the corresponding F<Configure> |
844 | variable, except C<PERL_CCFLAGS>, which gets appended. |
953 | variable, except C<PERL_CCFLAGS>, which gets appended. |
845 | |
954 | |
|
|
955 | The default for C<PERL_OPTIMIZE> is C<-Os> (assuming gcc), and for |
|
|
956 | C<PERL_LIBS> is C<-lm -lcrypt>, which should be good for most (but not |
|
|
957 | all) systems. |
|
|
958 | |
|
|
959 | For other compilers or more customised optimisation settings, you need to |
|
|
960 | adjust these, e.g. in your F<~/.staticperlrc>. |
|
|
961 | |
|
|
962 | With gcc on x86 and amd64, you can get more space-savings by using: |
|
|
963 | |
|
|
964 | -Os -ffunction-sections -fdata-sections -finline-limit=8 -mpush-args |
|
|
965 | -mno-inline-stringops-dynamically -mno-align-stringops |
|
|
966 | |
|
|
967 | And on x86 and pentium3 and newer (basically everything you might ever |
|
|
968 | want to run on), adding these is even better for space-savings (use |
|
|
969 | -mtune=core2 or something newer for much faster code, too): |
|
|
970 | |
|
|
971 | -fomit-frame-pointer -march=pentium3 -mtune=i386 |
|
|
972 | |
846 | =back |
973 | =back |
847 | |
974 | |
848 | =head4 Variables you probably I<do not want> to override |
975 | =head4 Variables you probably I<do not want> to override |
849 | |
976 | |
850 | =over 4 |
977 | =over 4 |
… | |
… | |
868 | =head3 OVERRIDABLE HOOKS |
995 | =head3 OVERRIDABLE HOOKS |
869 | |
996 | |
870 | In addition to environment variables, it is possible to provide some |
997 | In addition to environment variables, it is possible to provide some |
871 | shell functions that are called at specific times. To provide your own |
998 | shell functions that are called at specific times. To provide your own |
872 | commands, just define the corresponding function. |
999 | commands, just define the corresponding function. |
|
|
1000 | |
|
|
1001 | The actual order in which hooks are invoked during a full install |
|
|
1002 | from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>, |
|
|
1003 | C<postbuild>, C<postinstall>. |
873 | |
1004 | |
874 | Example: install extra modules from CPAN and from some directories |
1005 | Example: install extra modules from CPAN and from some directories |
875 | at F<staticperl install> time. |
1006 | at F<staticperl install> time. |
876 | |
1007 | |
877 | postinstall() { |
1008 | postinstall() { |
… | |
… | |
884 | |
1015 | |
885 | =over 4 |
1016 | =over 4 |
886 | |
1017 | |
887 | =item preconfigure |
1018 | =item preconfigure |
888 | |
1019 | |
889 | Called just before running F<./Configur> in the perl source |
1020 | Called just before running F<./Configure> in the perl source |
890 | directory. Current working directory is the perl source directory. |
1021 | directory. Current working directory is the perl source directory. |
891 | |
1022 | |
892 | This can be used to set any C<PERL_xxx> variables, which might be costly |
1023 | This can be used to set any C<PERL_xxx> variables, which might be costly |
893 | to compute. |
1024 | to compute. |
894 | |
1025 | |
|
|
1026 | =item patchconfig |
|
|
1027 | |
|
|
1028 | Called after running F<./Configure> in the perl source directory to create |
|
|
1029 | F<./config.sh>, but before running F<./Configure -S> to actually apply the |
|
|
1030 | config. Current working directory is the perl source directory. |
|
|
1031 | |
|
|
1032 | Can be used to tailor/patch F<config.sh> or do any other modifications. |
|
|
1033 | |
895 | =item postconfigure |
1034 | =item postconfigure |
896 | |
1035 | |
897 | Called after configuring, but before building perl. Current working |
1036 | Called after configuring, but before building perl. Current working |
898 | directory is the perl source directory. |
1037 | directory is the perl source directory. |
899 | |
|
|
900 | Could be used to tailor/patch config.sh (followed by F<sh Configure -S>) |
|
|
901 | or do any other modifications. |
|
|
902 | |
1038 | |
903 | =item postbuild |
1039 | =item postbuild |
904 | |
1040 | |
905 | Called after building, but before installing perl. Current working |
1041 | Called after building, but before installing perl. Current working |
906 | directory is the perl source directory. |
1042 | directory is the perl source directory. |
… | |
… | |
944 | A header file that contains the prototypes of the few symbols "exported" |
1080 | A header file that contains the prototypes of the few symbols "exported" |
945 | by bundle.c, and also exposes the perl headers to the application. |
1081 | by bundle.c, and also exposes the perl headers to the application. |
946 | |
1082 | |
947 | =over 4 |
1083 | =over 4 |
948 | |
1084 | |
949 | =item staticperl_init () |
1085 | =item staticperl_init (xs_init = 0) |
950 | |
1086 | |
951 | Initialises the perl interpreter. You can use the normal perl functions |
1087 | Initialises the perl interpreter. You can use the normal perl functions |
952 | after calling this function, for example, to define extra functions or |
1088 | after calling this function, for example, to define extra functions or |
953 | to load a .pm file that contains some initialisation code, or the main |
1089 | to load a .pm file that contains some initialisation code, or the main |
954 | program function: |
1090 | program function: |
… | |
… | |
961 | } |
1097 | } |
962 | |
1098 | |
963 | static void |
1099 | static void |
964 | run_myapp(void) |
1100 | run_myapp(void) |
965 | { |
1101 | { |
966 | staticperl_init (); |
1102 | staticperl_init (0); |
967 | newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); |
1103 | newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); |
968 | eval_pv ("require myapp::main", 1); // executes "myapp/main.pm" |
1104 | eval_pv ("require myapp::main", 1); // executes "myapp/main.pm" |
969 | } |
1105 | } |
970 | |
1106 | |
|
|
1107 | When your bootcode already wants to access some XS functions at |
|
|
1108 | compiletime, then you need to supply an C<xs_init> function pointer that |
|
|
1109 | is called as soon as perl is initialised enough to define XS functions, |
|
|
1110 | but before the preamble code is executed: |
|
|
1111 | |
|
|
1112 | static void |
|
|
1113 | xs_init (pTHX) |
|
|
1114 | { |
|
|
1115 | newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); |
|
|
1116 | } |
|
|
1117 | |
|
|
1118 | static void |
|
|
1119 | run_myapp(void) |
|
|
1120 | { |
|
|
1121 | staticperl_init (xs_init); |
|
|
1122 | } |
|
|
1123 | |
|
|
1124 | =item staticperl_cleanup () |
|
|
1125 | |
|
|
1126 | In the unlikely case that you want to destroy the perl interpreter, here |
|
|
1127 | is the corresponding function. |
|
|
1128 | |
971 | =item staticperl_xs_init (pTHX) |
1129 | =item staticperl_xs_init (pTHX) |
972 | |
1130 | |
973 | Sometimes you need direct control over C<perl_parse> and C<perl_run>, in |
1131 | Sometimes you need direct control over C<perl_parse> and C<perl_run>, in |
974 | which case you do not want to use C<staticperl_init> but call them on your |
1132 | which case you do not want to use C<staticperl_init> but call them on your |
975 | own. |
1133 | own. |
976 | |
1134 | |
977 | Then you need this function - either pass it directly as the C<xs_init> |
1135 | Then you need this function - either pass it directly as the C<xs_init> |
978 | function to C<perl_parse>, or call it from your own C<xs_init> function. |
1136 | function to C<perl_parse>, or call it as one of the first things from your |
979 | |
1137 | own C<xs_init> function. |
980 | =item staticperl_cleanup () |
|
|
981 | |
|
|
982 | In the unlikely case that you want to destroy the perl interpreter, here |
|
|
983 | is the corresponding function. |
|
|
984 | |
1138 | |
985 | =item PerlInterpreter *staticperl |
1139 | =item PerlInterpreter *staticperl |
986 | |
1140 | |
987 | The perl interpreter pointer used by staticperl. Not normally so useful, |
1141 | The perl interpreter pointer used by staticperl. Not normally so useful, |
988 | but there it is. |
1142 | but there it is. |
… | |
… | |
1001 | |
1155 | |
1002 | =back |
1156 | =back |
1003 | |
1157 | |
1004 | =head1 RUNTIME FUNCTIONALITY |
1158 | =head1 RUNTIME FUNCTIONALITY |
1005 | |
1159 | |
1006 | Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which |
1160 | Binaries created with C<mkbundle>/C<mkperl> contain extra functionality, |
1007 | are required to access the bundled perl sources, but might be useful for |
1161 | mostly related to the extra files bundled in the binary (the virtual |
1008 | other purposes. |
1162 | filesystem). All of this data is statically compiled into the binary, and |
|
|
1163 | accessing means copying it from a read-only section of your binary. Data |
|
|
1164 | pages in this way is usually freed by the operating system, as it isn't |
|
|
1165 | use more the onace. |
|
|
1166 | |
|
|
1167 | =head2 VIRTUAL FILESYSTEM |
|
|
1168 | |
|
|
1169 | Every bundle has a virtual filesystem. The only information stored in it |
|
|
1170 | is the path and contents of each file that was bundled. |
|
|
1171 | |
|
|
1172 | =head3 LAYOUT |
|
|
1173 | |
|
|
1174 | Any path starting with an ampersand (F<&>) or exclamation mark (F<!>) are |
|
|
1175 | reserved by F<staticperl>. They must only be used as described in this |
|
|
1176 | section. |
|
|
1177 | |
|
|
1178 | =over 4 |
|
|
1179 | |
|
|
1180 | =item ! |
|
|
1181 | |
|
|
1182 | All files that typically cannot be loaded from memory (such as dynamic |
|
|
1183 | objects or shared libraries), but have to reside in the filesystem, are |
|
|
1184 | prefixed with F<!>. Typically these files get written out to some |
|
|
1185 | (semi-)temporary directory shortly after program startup, or before being |
|
|
1186 | used. |
|
|
1187 | |
|
|
1188 | =item !boot |
|
|
1189 | |
|
|
1190 | The bootstrap file, if specified during bundling. |
|
|
1191 | |
|
|
1192 | =item !auto/ |
|
|
1193 | |
|
|
1194 | Shared objects or dlls corresponding to dynamically-linked perl extensions |
|
|
1195 | are stored with an F<!auto/> prefix. |
|
|
1196 | |
|
|
1197 | =item !lib/ |
|
|
1198 | |
|
|
1199 | External shared libraries are stored in this directory. |
|
|
1200 | |
|
|
1201 | =item any letter |
|
|
1202 | |
|
|
1203 | Any path starting with a letter is a perl library file. For example, |
|
|
1204 | F<Coro/AIO.pm> corresponds to the file loaded by C<use Coro::AIO>, and |
|
|
1205 | F<Coro/jit.pl> corresponds to C<require "Coro/jit.pl">. |
|
|
1206 | |
|
|
1207 | Obviously, module names shouldn't start with any other characters than |
|
|
1208 | letters :) |
|
|
1209 | |
|
|
1210 | =back |
|
|
1211 | |
|
|
1212 | =head3 FUNCTIONS |
|
|
1213 | |
|
|
1214 | =over 4 |
|
|
1215 | |
|
|
1216 | =item $file = static::find $path |
|
|
1217 | |
|
|
1218 | Returns the data associated with the given C<$path> |
|
|
1219 | (e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>). |
|
|
1220 | |
|
|
1221 | Returns C<undef> if the file isn't embedded. |
|
|
1222 | |
|
|
1223 | =item @paths = static::list |
|
|
1224 | |
|
|
1225 | Returns the list of all paths embedded in this binary. |
|
|
1226 | |
|
|
1227 | =back |
|
|
1228 | |
|
|
1229 | =head2 EXTRA FEATURES |
1009 | |
1230 | |
1010 | In addition, for the embedded loading of perl files to work, F<staticperl> |
1231 | In addition, for the embedded loading of perl files to work, F<staticperl> |
1011 | overrides the C<@INC> array. |
1232 | overrides the C<@INC> array. |
1012 | |
1233 | |
1013 | =over 4 |
|
|
1014 | |
|
|
1015 | =item $file = staticperl::find $path |
|
|
1016 | |
|
|
1017 | Returns the data associated with the given C<$path> |
|
|
1018 | (e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically |
|
|
1019 | the UNIX path relative to the perl library directory. |
|
|
1020 | |
|
|
1021 | Returns C<undef> if the file isn't embedded. |
|
|
1022 | |
|
|
1023 | =item @paths = staticperl::list |
|
|
1024 | |
|
|
1025 | Returns the list of all paths embedded in this binary. |
|
|
1026 | |
|
|
1027 | =back |
|
|
1028 | |
|
|
1029 | =head1 FULLY STATIC BINARIES - BUILDROOT |
1234 | =head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT |
1030 | |
1235 | |
1031 | To make truly static (Linux-) libraries, you might want to have a look at |
1236 | To make truly static (Linux-) libraries, you might want to have a look at |
1032 | buildroot (L<http://buildroot.uclibc.org/>). |
1237 | buildroot (L<http://buildroot.uclibc.org/>). |
1033 | |
1238 | |
1034 | Buildroot is primarily meant to set up a cross-compile environment (which |
1239 | Buildroot is primarily meant to set up a cross-compile environment (which |
… | |
… | |
1041 | good experiences with GCC 4.4.x but not GCC 4.5. |
1246 | good experiences with GCC 4.4.x but not GCC 4.5. |
1042 | |
1247 | |
1043 | To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections |
1248 | To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections |
1044 | -finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386> |
1249 | -finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386> |
1045 | doesn't decrease codesize much, but it makes the file much more |
1250 | doesn't decrease codesize much, but it makes the file much more |
1046 | compressible. |
1251 | compressible (and the execution a lot slower...). |
1047 | |
1252 | |
1048 | If you don't need Coro or threads, you can go with "linuxthreads.old" (or |
1253 | If you don't need Coro or threads, you can go with "linuxthreads.old" (or |
1049 | no thread support). For Coro, it is highly recommended to switch to a |
1254 | no thread support). For Coro, it is highly recommended to switch to a |
1050 | uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201 |
1255 | uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201 |
1051 | snapshot) and enable NPTL, otherwise Coro needs to be configured with the |
1256 | snapshot) and enable NPTL, otherwise Coro needs to be configured with the |
… | |
… | |
1053 | twice the address space needed for stacks). |
1258 | twice the address space needed for stacks). |
1054 | |
1259 | |
1055 | If you use C<linuxthreads.old>, then you should also be aware that |
1260 | If you use C<linuxthreads.old>, then you should also be aware that |
1056 | uClibc shares C<errno> between all threads when statically linking. See |
1261 | uClibc shares C<errno> between all threads when statically linking. See |
1057 | L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a |
1262 | L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a |
1058 | workaround (And L<https://bugs.uclibc.org/2089> for discussion). |
1263 | workaround (and L<https://bugs.uclibc.org/2089> for discussion). |
1059 | |
1264 | |
1060 | C<ccache> support is also recommended, especially if you want |
1265 | C<ccache> support is also recommended, especially if you want |
1061 | to play around with buildroot options. Enabling the C<miniperl> |
1266 | to play around with buildroot options. Enabling the C<miniperl> |
1062 | package will probably enable all options required for a successful |
1267 | package will probably enable all options required for a successful |
1063 | perl build. F<staticperl> itself additionally needs either C<wget> |
1268 | perl build. F<staticperl> itself additionally needs either C<wget> |
… | |
… | |
1071 | it from working properly in a chroot - either use dash (and link it to |
1276 | it from working properly in a chroot - either use dash (and link it to |
1072 | F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's |
1277 | F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's |
1073 | built-in ash shell. |
1278 | built-in ash shell. |
1074 | |
1279 | |
1075 | Finally, you need F</dev/null> inside the chroot for many scripts to work |
1280 | Finally, you need F</dev/null> inside the chroot for many scripts to work |
1076 | - F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will |
1281 | - either F<cp /dev/null output/target/dev> or bind-mounting your F</dev> |
1077 | both provide this. |
1282 | will provide this. |
1078 | |
1283 | |
1079 | After you have compiled and set up your buildroot target, you can copy |
1284 | After you have compiled and set up your buildroot target, you can copy |
1080 | F<staticperl> from the C<App::Staticperl> distribution or from your |
1285 | F<staticperl> from the C<App::Staticperl> distribution or from your |
1081 | perl f<bin> directory (if you installed it) into the F<output/target> |
1286 | perl F<bin> directory (if you installed it) into the F<output/target> |
1082 | filesystem, chroot inside and run it. |
1287 | filesystem, chroot inside and run it. |
1083 | |
1288 | |
1084 | =head1 RECIPES / SPECIFIC MODULES |
1289 | =head1 RECIPES / SPECIFIC MODULES |
1085 | |
1290 | |
1086 | This section contains some common(?) recipes and information about |
1291 | This section contains some common(?) recipes and information about |
… | |
… | |
1095 | |
1300 | |
1096 | Some functionality in the utf8 module, such as swash handling (used |
1301 | Some functionality in the utf8 module, such as swash handling (used |
1097 | for unicode character ranges in regexes) is implemented in the |
1302 | for unicode character ranges in regexes) is implemented in the |
1098 | C<"utf8_heavy.pl"> library: |
1303 | C<"utf8_heavy.pl"> library: |
1099 | |
1304 | |
1100 | -M'"utf8_heavy.pl"' |
1305 | -Mutf8_heavy.pl |
1101 | |
1306 | |
1102 | Many Unicode properties in turn are defined in separate modules, |
1307 | Many Unicode properties in turn are defined in separate modules, |
1103 | such as C<"unicore/Heavy.pl"> and more specific data tables such as |
1308 | such as C<"unicore/Heavy.pl"> and more specific data tables such as |
1104 | C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables |
1309 | C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables |
1105 | are big (7MB uncompressed, although F<staticperl> contains special |
1310 | are big (7MB uncompressed, although F<staticperl> contains special |
1106 | handling for those files), so including them on demand by your application |
1311 | handling for those files), so including them on demand by your application |
1107 | only might pay off. |
1312 | only might pay off. |
1108 | |
1313 | |
1109 | To simply include the whole unicode database, use: |
1314 | To simply include the whole unicode database, use: |
1110 | |
1315 | |
1111 | --incglob '/unicore/*.pl' |
1316 | --incglob '/unicore/**.pl' |
1112 | |
1317 | |
1113 | =item AnyEvent |
1318 | =item AnyEvent |
1114 | |
1319 | |
1115 | AnyEvent needs a backend implementation that it will load in a delayed |
1320 | AnyEvent needs a backend implementation that it will load in a delayed |
1116 | fashion. The L<AnyEvent::Impl::Perl> backend is the default choice |
1321 | fashion. The L<AnyEvent::Impl::Perl> backend is the default choice |
… | |
… | |
1121 | |
1326 | |
1122 | If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn |
1327 | If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn |
1123 | functions), you also need to include C<"AnyEvent/Util/idna.pl"> and |
1328 | functions), you also need to include C<"AnyEvent/Util/idna.pl"> and |
1124 | C<"AnyEvent/Util/uts46data.pl">. |
1329 | C<"AnyEvent/Util/uts46data.pl">. |
1125 | |
1330 | |
1126 | Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include |
1331 | Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include |
1127 | everything. |
1332 | everything. |
|
|
1333 | |
|
|
1334 | =item Cairo |
|
|
1335 | |
|
|
1336 | See Glib, same problem, same solution. |
1128 | |
1337 | |
1129 | =item Carp |
1338 | =item Carp |
1130 | |
1339 | |
1131 | Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of |
1340 | Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of |
1132 | perl 5.12.2 (maybe earlier), this dependency no longer exists. |
1341 | perl 5.12.2 (maybe earlier), this dependency no longer exists. |
… | |
… | |
1135 | |
1344 | |
1136 | The F<perl -V> switch (as well as many modules) needs L<Config>, which in |
1345 | The F<perl -V> switch (as well as many modules) needs L<Config>, which in |
1137 | turn might need L<"Config_heavy.pl">. Including the latter gives you |
1346 | turn might need L<"Config_heavy.pl">. Including the latter gives you |
1138 | both. |
1347 | both. |
1139 | |
1348 | |
|
|
1349 | =item Glib |
|
|
1350 | |
|
|
1351 | Glib literally requires Glib to be installed already to build - it tries |
|
|
1352 | to fake this by running Glib out of the build directory before being |
|
|
1353 | built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and |
|
|
1354 | C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable. |
|
|
1355 | |
|
|
1356 | =item Gtk2 |
|
|
1357 | |
|
|
1358 | See Pango, same problems, same solution. |
|
|
1359 | |
|
|
1360 | =item Net::SSLeay |
|
|
1361 | |
|
|
1362 | This module hasn't been significantly updated since OpenSSL is called |
|
|
1363 | OpenSSL, and fails to properly link against dependent libraries, most |
|
|
1364 | commonly, it forgets to specify -ldl when linking. |
|
|
1365 | |
|
|
1366 | On GNU/Linux systems this usually goes undetected, as perl usually links |
|
|
1367 | against -ldl itself and OpenSSL just happens to pick it up that way, by |
|
|
1368 | chance. |
|
|
1369 | |
|
|
1370 | For static builds, you either have to configure -ldl manually, or you |
|
|
1371 | cna use the following snippet in your C<postinstall> hook which patches |
|
|
1372 | Net::SSLeay after installation, which happens to work most of the time: |
|
|
1373 | |
|
|
1374 | postinstall() { |
|
|
1375 | # first install it |
|
|
1376 | instcpan Net::SSLeay |
|
|
1377 | # then add -ldl for future linking |
|
|
1378 | chmod u+w "$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld |
|
|
1379 | echo " -ldl" >>"$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld |
|
|
1380 | } |
|
|
1381 | |
|
|
1382 | =item Pango |
|
|
1383 | |
|
|
1384 | In addition to the C<MAN3PODS> problem in Glib, Pango also routes around |
|
|
1385 | L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl> |
|
|
1386 | tries to patch L<ExtUtils::MM_Unix> to route around Pango. |
|
|
1387 | |
1140 | =item Term::ReadLine::Perl |
1388 | =item Term::ReadLine::Perl |
1141 | |
1389 | |
1142 | Also needs L<Term::ReadLine::readline>, or C<--usepacklist>. |
1390 | Also needs L<Term::ReadLine::readline>, or C<--usepacklists>. |
1143 | |
1391 | |
1144 | =item URI |
1392 | =item URI |
1145 | |
1393 | |
1146 | URI implements schemes as separate modules - the generic URL scheme is |
1394 | URI implements schemes as separate modules - the generic URL scheme is |
1147 | implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If |
1395 | implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If |
1148 | you need to use any of these schemes, you should include these manually, |
1396 | you need to use any of these schemes, you should include these manually, |
1149 | or use C<--usepacklist>. |
1397 | or use C<--usepacklists>. |
1150 | |
1398 | |
1151 | =back |
1399 | =back |
1152 | |
1400 | |
1153 | =head2 RECIPES |
1401 | =head2 RECIPES |
1154 | |
1402 | |
1155 | =over 4 |
1403 | =over 4 |
1156 | |
1404 | |
1157 | =item Linking everything in |
1405 | =item Just link everything in |
1158 | |
1406 | |
1159 | To link just about everything installed in the perl library into a new |
1407 | To link just about everything installed in the perl library into a new |
1160 | perl, try this: |
1408 | perl, try this (the first time this runs it will take a long time, as a |
|
|
1409 | lot of files need to be parsed): |
1161 | |
1410 | |
1162 | staticperl mkperl --strip ppi --incglob '*' |
1411 | staticperl mkperl -v --strip ppi --incglob '*' |
1163 | |
1412 | |
|
|
1413 | If you don't mind the extra megabytes, this can be a very effective way of |
|
|
1414 | creating bundles without having to worry about forgetting any modules. |
|
|
1415 | |
|
|
1416 | You get even more useful variants of this method by first selecting |
|
|
1417 | everything, and then excluding stuff you are reasonable sure not to need - |
|
|
1418 | L<bigperl|http://staticperl.schmorp.de/bigperl.html> uses this approach. |
|
|
1419 | |
1164 | =item Getting rid of netdb function |
1420 | =item Getting rid of netdb functions |
1165 | |
1421 | |
1166 | The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent> |
1422 | The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent> |
1167 | and so on) that few applications use. You can avoid compiling them in by |
1423 | and so on) that few applications use. You can avoid compiling them in by |
1168 | putting the following fragment into a C<preconfigure> hook: |
1424 | putting the following fragment into a C<preconfigure> hook: |
1169 | |
1425 | |
… | |
… | |
1186 | do |
1442 | do |
1187 | PERL_CONFIGURE="$PERL_CONFIGURE -U$sym" |
1443 | PERL_CONFIGURE="$PERL_CONFIGURE -U$sym" |
1188 | done |
1444 | done |
1189 | } |
1445 | } |
1190 | |
1446 | |
1191 | This mostly gains space when linking staticaly, as the functions will |
1447 | This mostly gains space when linking statically, as the functions will |
1192 | likely not be linked in. The gain for dynamically-linked binaries is |
1448 | likely not be linked in. The gain for dynamically-linked binaries is |
1193 | smaller. |
1449 | smaller. |
1194 | |
1450 | |
1195 | Also, this leaves C<gethostbyname> in - not only is it actually used |
1451 | Also, this leaves C<gethostbyname> in - not only is it actually used |
1196 | often, the L<Socket> module also exposes it, so leaving it out usually |
1452 | often, the L<Socket> module also exposes it, so leaving it out usually |