1PAR::Tutorial(3) User Contributed Perl Documentation PAR::Tutorial(3)
2
6 PAR::Tutorial - Cross-Platform Packaging and Deployment with PAR
7
9 This is a tutorial on PAR, first appeared at the 7th Perl Conference.
10 The HTML version of this tutorial is available online as
11 <http://search.cpan.org/perldoc?PAR::Tutorial>
12
14 On Deploying Perl Applications
15 % sshnuke.pl 10.2.2.2 -rootpw="Z1ON0101"
16 Perl v5.6.1 required--this is only v5.6.0, stopped at sshnuke.pl line 1.
17 BEGIN failed--compilation aborted at sshnuke.pl line 1.
18 · Q: "Help! I can't run your program!"
20 · A1: Install Perl & "perl -MCPAN -e'install(...)'"
22 · How do we know which modules are needed?
24 · New versions of CPAN modules may break "sshnuke.pl"
26 · A2: Install Perl & "tar zxf my_perllib.tgz"
28 · Possibly overwriting existing modules; not cross-platform at
30 all
31 · A3: Use the executable generated by "perlcc sshnuke.pl"
33 · Impossible to debug; "perlcc" usually does not work anyway
35 PAR, the Perl Archive Toolkit
37 · Do what JAR (Java Archive) does for Perl
38 · Aggregates modules, scripts and other files into a Zip file
40 · Easy to generate, update and extract
42 · Version consistency: solves forward-compatibility problems
44 · Developed by community: "par@perl.org"
46 · PAR files can be packed into self-contained scripts
48 · Automatically scans perl script for dependencies
50 · Bundles all necessary 3rd-party modules with it
52 · Requires only core Perl to run on the target machine
54 · PAR also comes with "pp", the Perl Packager:
56 % pp -o sshnuke.exe sshnuke.pl # stand-alone executable!
58 Simple Packaging
60 · PAR files are just Zip files with modules in it
61 · Any Zip tools can generate them:
63 % zip foo.par Hello.pm World.pm # pack two modules
65 % zip -r bar.par lib/ # grab all modules in lib/
66 · To load modules from PAR files:
68 use PAR;
70 use lib "foo.par"; # the .par part is optional
71 use Hello;
72 · This also works:
74 use PAR "/home/mylibs/*.par"; # put all of them into @INC
76 use Hello;
77 PAR Loaders
79 · Use "par.pl" to run files inside a PAR archive:
80 % par.pl foo.par # looks for 'main.pl' by default
82 % par.pl foo.par test.pl # runs script/test.pl in foo.par
83 · Same thing, with the stand-alone "parl" or "parl.exe":
85 % parl foo.par # no perl or PAR.pm needed!
87 % parl foo.par test.pl # ditto
88 · The PAR loader can prepend itself to a PAR file:
90 · "-b" bundles non-core modules needed by "PAR.pm":
92 % par.pl -b -O./foo.pl foo.par # self-contained script
94 · "-B" bundles core modules in addition to "-b":
96 % parl -B -O./foo.exe foo.par # self-contained binary
98 Dependency Scanning
100 · Recursively scan dependencies with "scandeps.pl":
101 % scandeps.pl sshnuke.pl
103 # Legend: [C]ore [X]ternal [S]ubmodule [?]NotOnCPAN
104 'Crypt::SSLeay' => '0', # X #
105 'Net::HTTP' => '0', # #
106 'Crypt::SSLeay::X509' => '0', # S # Crypt::SSLeay
107 'Net::HTTP::Methods' => '0', # S # Net::HTTP
108 'Compress::Zlib' => '0', # X # Net::HTTP::Methods
109 · Scan an one-liner, list all involved files:
111 % scandeps.pl -V -e "use Dynaloader;"
113 ...
114 # auto/DynaLoader/dl_findfile.al [autoload]
115 # auto/DynaLoader/extralibs.ld [autoload]
116 # auto/File/Glob/Glob.bs [data]
117 # auto/File/Glob/Glob.so [shared]
118 ...
119 Perl Packager: "pp"
121 · Combines scanning, zipping and loader-embedding:
122 % pp -o out.exe src.pl # self-contained .exe
124 % out.exe # runs anywhere on the same OS
125 · Bundle additional modules:
127 % pp -o out.exe -M CGI src.pl # pack CGI + its dependencies, too
129 · Pack one-liners:
131 % pp -o out.exe -e 'print "Hi!"' # turns one-liner into executable
133 · Generate PAR files instead of executables:
135 % pp -p src.pl # makes 'source.par'
137 % pp -B -p src.pl # include core modules
138 How it works
140 · Command-line options are almost identical to "perlcc"'s
141 · Also supports "gcc"-style long options:
143 % pp --gui --verbose --output=out.exe src.pl
145 · Small initial overhead; no runtime overhead
147 · Dependencies are POD-stripped before packing
149 · Loads modules directly into memory on demand
151 · Shared libraries (DLLs) are extracted with File::Temp
153 · Works on Perl 5.6.0 or above
155 · Tested on Win32 (VC++ and MinGW), FreeBSD, NetBSD, Linux, MacOSX,
157 Cygwin, AIX, Solaris, HP-UX, Tru64...
158 Aggregating multiple programs
160 · A common question:
161 > I have used pp to make several standalone applications which work
163 > great, the only problem is that for each executable that I make, I am
164 > assuming the parl.exe is somehow bundled into the resulting exe.
165 · The obvious workaround:
167 You can ship parl.exe by itself, along with .par files built
169 by "pp -p", and run those PAR files by associating them to parl.exe.
170 · On platforms that have "ln", there is a better solution:
172 % pp --output=a.out a.pl b.pl # two scripts in one!
174 % ln a.out b.out # symlink also works
175 % ./a.out # runs a.pl
176 % ./b.out # runs b.pl
177 Cross-platform Packages
179 · Of course, there is no cross-platform binary format
180 · Pure-perl PAR packages are cross-platform by default
182 · However, XS modules are specific to Perl version and platform
184 · Multiple versions of a XS module can co-exist in a PAR file
186 · Suppose we need "out.par" on both Win32 and Finix:
188 C:\> pp --multiarch --output=out.par src.pl
190 ...copy src.pl and out.par to a Finix machine...
191 % pp --multiarch --output=out.par src.pl
192 · Now it works on both platforms:
194 % parl out.par # runs src.pl
196 % perl -MPAR=out.par -e '...' # uses modules inside out.par
197 The Anatomy of a PAR file
199 · Modules can reside in several directories:
200 / # casual packaging only
202 /lib/ # standard location
203 /arch/ # for creating from blib/
204 /i386-freebsd/ # i.e. $Config{archname}
205 /5.8.0/ # i.e. Perl version number
206 /5.8.0/i386-freebsd/ # combination of the two above
207 · Scripts are stored in one of the two locations:
209 / # casual packaging only
211 /script/ # standard location
212 · Shared libraries may be architecture- or perl-version-specific:
214 /shlib/(5.8.0/)?(i386-freebsd/)?
216 · PAR files may recursively contain other PAR files:
218 /par/(5.8.0/)?(i386-freebsd/)?
220 Special files
222 · MANIFEST
223 · Index of all files inside PAR
225 · Can be parsed with "ExtUtils::Manifest"
227 · META.yml
229 · Dependency, license, runtime options
231 · Can be parsed with "YAML"
233 · SIGNATURE
235 · OpenPGP-signed digital signature
237 · Can be parsed and verified with "Module::Signature"
239 Advantages over perlcc, PerlApp and Perl2exe
241 · This is not meant to be a flame
242 · All three maintainers have contributed to PAR directly; I'm
244 grateful
245 · perlcc
247 · "The code generated in this way is not guaranteed to work...
249 Use for production purposes is strongly discouraged." (from
250 perldoc perlcc)
251 · Guaranteed to not work is more like it
253 · PerlApp / Perl2exe
255 · Expensive: Need to pay for each upgrade
257 · Non-portable: Only available for limited platforms
259 · Proprietary: Cannot extend its features or fix bugs
261 · Obfuscated: Vendor and black-hats can see your code, but you
263 can't
264 · Inflexible: Does not work with existing Perl installations
266 MANIFEST: Best viewed with Mozilla
268 · The URL of "MANIFEST" inside "/home/autrijus/foo.par":
269 jar:file:///home/autrijus/foo.par!/MANIFEST
271 · Open it in a Gecko browser (e.g. Netscape 6+) with Javascript
273 enabled:
274 · No needed to unzip anything; just click on files to view them
276 META.yml: Metadata galore
278 · Static, machine-readable distribution metadata
279 · Supported by "Module::Build", "ExtUtils::MakeMaker",
281 "Module::Install"
282 · A typical "pp"-generated "META.yml" looks like this:
284 build_requires: {}
286 conflicts: {}
287 dist_name: out.par
288 distribution_type: par
289 dynamic_config: 0
290 generated_by: 'Perl Packager version 0.03'
291 license: unknown
292 par:
293 clean: 0
294 signature: ''
295 verbatim: 0
296 version: 0.68
297 · The "par:" settings controls its runtime behavior
299 SIGNATURE: Signing and verifying packages
301 · OpenPGP clear-signed manifest with SHA1 digests
302 · Supported by "Module::Signature", "CPANPLUS" and
304 "Module::Build"
305 · A typical "SIGNATURE" looks like this:
307 -----BEGIN PGP SIGNED MESSAGE-----
309 Hash: SHA1
310 SHA1 8a014cd6d0f6775552a01d1e6354a69eb6826046 AUTHORS
312 ...
313 -----BEGIN PGP SIGNATURE-----
314 ...
315 -----END PGP SIGNATURE-----
316 · Use "pp" and "cpansign" to work with signatures:
318 % pp -s -o foo.par bar.pl # make and sign foo.par from bar.pl
320 % cpansign -s foo.par # sign this PAR file
321 % cpansign -v foo.par # verify this PAR file
322 Perl Servlets with Apache::PAR
324 · Framework for self-contained Web applications
325 · Similar to Java's "Web Application Archive" (WAR) files
327 · Works with mod_perl 1.x or 2.x
329 · A complete web application inside a ".par" file
331 · Apache configuration, static files, Perl modules...
333 · Supports Static, Registry and PerlRun handlers
335 · Can also load all PARs under a directory
337 · One additional special file: "web.conf"
339 Alias /myapp/cgi-perl/ ##PARFILE##/
341 <Location /myapp/cgi-perl>
342 Options +ExecCGI
343 SetHandler perl-script
344 PerlHandler Apache::PAR::Registry
345 </Location>
346 Hon Dah, A-par-che!
348 · First, make a "hondah.par" from an one-liner:
349 # use the "web.conf" from the previous slide
351 % pp -p -o hondah.par -e 'print "Hon Dah!\n"' \
352 --add web.conf
353 % chmod a+x hondah.par
354 · Add this to "httpd.conf", then restart apache:
356 <IfDefine MODPERL2>
358 PerlModule Apache2
359 </IfDefine>
360 PerlAddVar PARInclude /home/autrijus/hondah.par
361 PerlModule Apache::PAR
362 · Test it out:
364 % GET http://localhost/myapp/cgi-perl/main.pl
366 Hon Dah!
367 · Instant one-liner web application that works!
369 On-demand library fetching
371 · With LWP installed, your can use remote PAR files:
372 use PAR;
374 use lib 'http://aut.dyndns.org/par/DBI-latest.par';
375 use DBI; # always up to date!
376 · Modules are now cached under $ENV{PAR_GLOBAL_TEMP}
378 · Auto-updates with "LWP::Simple::mirror"
380 · Download only if modified
382 · Safe for offline use after the first time
384 · May use "SIGNATURE" to prevent DNS-spoofing
386 · Makes large-scale deployment a breeze
388 · Upgrades from a central location
390 · No installers needed
392 Code Obfuscation
394 · Also known as source-hiding techniques
395 · It is not encryption
397 · Offered by PerlApp, Perl2Exe, Stunnix...
399 · Usually easy to defeat
401 · Take optree dump from memory, feed to "B::Deparse"
403 · If you just want to stop a casual "grep", "deflate" already
405 works
406 · PAR now supports pluggable input filters with "pp -f"
408 · Bundled examples: Bleach, PodStrip and PatchContent
410 · True encryption using "Crypt::*"
412 · Or even _product activation_ over the internet
414 · Alternatively, just keep core logic in your server and use RPC
416 Accessing packed files
418 · To get the host archive from a packed program:
419 my $zip = PAR::par_handle($0); # an Archive::Zip object
421 my $content = $zip->contents('MANIFEST');
422 · Same thing, but with "read_file()":
424 my $content = PAR::read_file('MANIFEST');
426 · Loaded PAR files are stored in %PAR::LibCache:
428 use PAR '/home/mylibs/*.par';
430 while (my ($filename, $zip) = each %PAR::LibCache) {
431 print "[$filename - MANIFEST]\n";
432 print $zip->contents('MANIFEST');
433 }
434 Packing GUI applications
436 · GUI toolkits often need to link with shared libraries:
437 # search for libncurses under library paths and pack it
439 % pp -l ncurses curses_app.pl # same for Tk, Wx, Gtk, Qt...
440 · Use "pp --gui" on Win32 to eliminate the console window:
442 # pack 'src.pl' into a console-less 'out.exe' (Win32 only)
444 % pp --gui -o out.exe src.pl
445 · "Can't locate Foo/Widget/Bar.pm in @INC"?
447 · Some toolkits (notably Tk) autoloads modules without "use" or
449 "require"
450 · Hence "pp" and "Module::ScanDeps" may fail to detect them
452 · Tk problems mostly fixed by now, but other toolkits may still
454 break
455 · You can work around it with "pp -M" or an explicit "require"
457 · Or better, send a short test-case to "par@perl.org" so we can
459 fix it
460 Precompiled CPAN distributions
462 · Installing XS extensions from CPAN was difficult
463 · Some platforms do not come with a compiler (Win32, MacOSX...)
465 · Some headers or libraries may be missing
467 · PAR.pm itself used to suffer from both problems
469 · ...but not anymore -- "Module::Install" to the rescue!
471 # same old Makefile.PL, with a few changes
473 use inc::Module::Install; # was "use ExtUtils::MakeMaker;"
474 WriteMakefile( ... ); # same as the original
475 check_nmake(); # make sure the user have nmake
476 par_base('AUTRIJUS'); # your CPAN ID or a URL
477 fetch_par() unless can_cc(); # use precompiled PAR only if necessary
478 · Users will not notice anything, except now it works
480 · Of course, you still need to type "make par" and upload the
482 precompiled package
483 · PAR users can also install it directly with "parl -i"
485 Platform-specific Tips
487 · Win32 and other icon-savvy platforms
488 · Needs 3rd-party tools to add icons to "pp"-generated
490 executables
491 · PE Header manipulation in Perl -- volunteers wanted!
493 · Linux and other libc-based platforms
495 · Try to avoid running "pp" on a bleeding-edge version of the OS
497 · Older versions with an earlier libc won't work with new ones
499 · Solaris and other zlib-lacking platforms (but not Win32)
501 · You need a static-linked "Compress::Zlib" before installing PAR
503 · In the future, PAR may depend on "Compress::Zlib::Static"
505 instead
506 · Any platform with limited bandwidth or disk space
508 · Use UPX to minimize the executable size
510 Thank you!
512 · Additional resources
513 · Mailing list: "par@perl.org"
515 · Subscribe: Send a blank email to "par-subscribe@perl.org"
517 · List archive: <http://nntp.x.perl.org/group/perl.par>
519 · PAR::Intro: <http://search.cpan.org/dist/PAR/lib/PAR/Intro.pod>
521 · Apache::PAR: http://search.cpan.org/dist/Apache-PAR/
523 <http://search.cpan.org/dist/Apache-PAR/>
524 · Module::Install: http://search.cpan.org/dist/Module-Install/
526 <http://search.cpan.org/dist/Module-Install/>
527 · Any questions?
529 Bonus Slides: PAR Internals
531 Overview of PAR.pm's Implementation
532 · Here begins the scary part
533 · Grues, Dragons and Jabberwocks abound...
535 · You are going to learn weird things about Perl internals
537 · PAR invokes four areas of Perl arcana:
539 · @INC code references
541 · On-the-fly source filtering
543 · Overriding "DynaLoader::bootstrap()" to handle XS modules
545 · Making self-bootstrapping binary executables
547 · The first two only works on 5.6 or later
549 · DynaLoader and %INC are there since Perl 5 was born
551 · PAR currently needs 5.6, but a 5.005 port is possible
553 Code References in @INC
555 · On 1999-07-19, Ken Fox submitted a patch to P5P
556 · To _enable using remote modules_ by putting hooks in @INC
558 · It's accepted to come in Perl 5.6, but undocumented until 5.8
560 · Type "perldoc -f require" to read the nitty-gritty details
562 · Coderefs in @INC may return a fh, or undef to 'pass':
564 push @INC, sub {
566 my ($coderef, $filename) = @_; # $coderef is \&my_sub
567 open my $fh, "wget ftp://example.com/$filename |";
568 return $fh; # using remote modules, indeed!
569 };
570 · Perl 5.8 let you open a file handle to a string, so we just use
572 that:
573 open my $fh, '<', \($zip->memberNamed($filename)->contents);
575 return $fh;
576 · But Perl 5.6 does not have that, and I don't want to use temp
578 files...
579 Source Filtering without Filter::* Modules
581 · ... Undocumented features to the rescue!
582 · It turns out that @INC hooks can return two values
584 · The first is still the file handle
586 · The second is a code reference for line-by-line source
588 filtering!
589 · This is how "Acme::use::strict::with::pride" works:
591 # Force all modules used to use strict and warnings
593 open my $fh, "<", $filename or return;
594 my @lines = ("use strict; use warnings;\n", "#line 1 \"$full\"\n");
595 return ($fh, sub {
596 return 0 unless @lines;
597 push @lines, $_; $_ = shift @lines; return length $_;
598 });
599 Source Filtering without Filter::* Modules (cont.)
601 · But we don't really have a filehandle for anything
602 · Another undocumented feature saves the day!
604 · We can actually omit the first return value altogether:
606 # Return all contents line-by-line from the file inside PAR
608 my @lines = split(
609 /(?<=\n)/,
610 $zip->memberNamed($filename)->contents
611 );
612 return (sub {
613 $_ = shift(@lines);
614 return length $_;
615 });
616 Overriding DynaLoader::bootstrap
618 · XS modules have dynamically loaded libraries
619 · They cannot be loaded as part of a zip file, so we extract them
621 out
622 · Must intercept DynaLoader's library-finding process
624 · Module names are passed to "bootstrap" for XS loading
626 · During the process, it calls "dl_findfile" to locate the file
628 · So we install pre-hooks around both functions
630 · Our "_bootstrap" just checks if the library is in PARs
632 · If yes, extract it to a "File::Temp" temp file
634 · The file will be automatically cleaned up when the program
636 ends
637 · It then pass the arguments to the original "bootstrap"
639 · Finally, our "dl_findfile" intercepts known filenames and
641 return it
642 Anatomy of a Self-Contained PAR executable
644 · The par script ($0) itself
645 · May be in plain-text or native executable format
647 · Any number of embedded files
649 · Typically used to bootstrap PAR's various dependencies
651 · Each section begins with the magic string "FILE"
653 · Length of filename in pack('N') format and the filename
655 (auto/.../)
656 · File length in pack('N') and the file's content (not
658 compressed)
659 · One PAR file
661 · Just a regular zip file with the magic string "PK\003\004"
663 · Ending section
665 · A pack('N') number of the total length of FILE and PAR sections
667 · Finally, there must be a 8-bytes magic string: "\012PAR.pm\012"
669 Self-Bootstrapping Tricks
671 · All we can expect is a working perl interpreter
672 · The self-contained script *must not* use any modules at all
674 · But to process PAR files, we need XS modules like
676 Compress::Zlib
677 · Answer: bundle all modules + libraries used by PAR.pm
679 · That's what the "FILE" section in the previous slide is for
681 · Load modules to memory, and write object files to disk
683 · Then use a local @INC hook to load them on demand
685 · Minimizing the amount of temporary files
687 · First, try to load PerlIO::scalar and File::Temp
689 · Set up an END hook to unlink all temp files up to this point
691 · Load other bundled files, and look in the compressed PAR
693 section
694 · This can be much easier with a pure-perl "inflate()"; patches
696 welcome!
697 Thank you (again)!
699 · Any questions, please?
700
702 PAR, pp, par.pl, parl
703 ex::lib::zip, Acme::use::strict::with::pride
705 App::Packer, Apache::PAR, CPANPLUS, Module::Install
707
709 Audrey Tang <cpan@audreyt.org>
710 <http://par.perl.org/> is the official PAR website. You can write to
712 the mailing list at <par@perl.org>, or send an empty mail to
713 <par-subscribe@perl.org> to participate in the discussion.
714 Please submit bug reports to <bug-par@rt.cpan.org>.
716
718 Copyright 2003, 2004, 2005, 2006 by Audrey Tang <cpan@audreyt.org>.
719 This document is free documentation; you can redistribute it and/or
721 modify it under the same terms as Perl itself.
722 See <http://www.perl.com/perl/misc/Artistic.html>
724perl v5.12.1 2010-04-10 PAR::Tutorial(3)