.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "docs::api::Apache2::SubProcess 3pm"
.TH docs::api::Apache2::SubProcess 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Apache2::SubProcess \-\- Executing SubProcesses under mod_perl
.SH Synopsis
.IX Header "Synopsis"
.Vb 1
\&  use Apache2::SubProcess ();
\&  
\&  use Config;
\&  use constant PERLIO_IS_ENABLED => $Config{useperlio};
\&  
\&  # pass @ARGV / read from the process
\&  $command = "/tmp/argv.pl";
\&  @argv = qw(foo bar);
\&  $out_fh = $r\->spawn_proc_prog($command, \e@argv);
\&  $output = read_data($out_fh);
\&  
\&  # pass environment / read from the process
\&  $command = "/tmp/env.pl";
\&  $r\->subprocess_env\->set(foo => "bar");
\&  $out_fh = $r\->spawn_proc_prog($command);
\&  $output = read_data($out_fh);
\&  
\&  # write to/read from the process
\&  $command = "/tmp/in_out_err.pl";
\&  ($in_fh, $out_fh, $err_fh) = $r\->spawn_proc_prog($command);
\&  print $in_fh "hello\en";
\&  $output = read_data($out_fh);
\&  $error  = read_data($err_fh);
\&  
\&  # helper function to work w/ and w/o perlio\-enabled Perl
\&  sub read_data {
\&      my ($fh) = @_;
\&      my $data;
\&      if (PERLIO_IS_ENABLED || IO::Select\->new($fh)\->can_read(10)) {
\&          $data = <$fh>;
\&      }
\&      return defined $data ? $data : \*(Aq\*(Aq;
\&  }
\&  
\&  # pass @ARGV but don\*(Aqt ask for any communication channels
\&  $command = "/tmp/argv.pl";
\&  @argv = qw(foo bar);
\&  $r\->spawn_proc_prog($command, \e@argv);
.Ve
.SH Description
.IX Header "Description"
\&\f(CW\*(C`Apache2::SubProcess\*(C'\fR provides the Perl API for running and
communicating with processes spawned from mod_perl handlers.
.PP
At the moment it's possible to spawn only external program in a new
process. It's possible to provide other interfaces, e.g. executing a
sub-routine reference (via \f(CW\*(C`B::Deparse\*(C'\fR) and may be spawn a new
program in a thread (since the APR api includes API for spawning
threads, e.g. that's how it's running mod_cgi on win32).
.SH API
.IX Header "API"
.ie n .SS """spawn_proc_prog"""
.el .SS \f(CWspawn_proc_prog\fP
.IX Subsection "spawn_proc_prog"
Spawn a sub-process and return STD communication pipes:
.PP
.Vb 6
\&                               $r\->spawn_proc_prog($command);
\&                               $r\->spawn_proc_prog($command, \e@argv);
\&  $out_fh                    = $r\->spawn_proc_prog($command);
\&  $out_fh                    = $r\->spawn_proc_prog($command, \e@argv);
\&  ($in_fh, $out_fh, $err_fh) = $r\->spawn_proc_prog($command);
\&  ($in_fh, $out_fh, $err_fh) = $r\->spawn_proc_prog($command, \e@argv);
.Ve
.ie n .IP "obj: $r ( ""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
.PD 0
.ie n .IP "arg1: $command ( string )" 4
.el .IP "arg1: \f(CW$command\fR ( string )" 4
.IX Item "arg1: $command ( string )"
.PD
The command to be \f(CW$exec()\fR'ed.
.ie n .IP "opt arg2: ""\e@argv"" ( ARRAY ref )" 4
.el .IP "opt arg2: \f(CW\e@argv\fR ( ARRAY ref )" 4
.IX Item "opt arg2: @argv ( ARRAY ref )"
A reference to an array of arguments to be passed to the process as
the process' \f(CW\*(C`ARGV\*(C'\fR.
.IP "ret: ..." 4
.IX Item "ret: ..."
In VOID context returns no filehandles (all std streams to the spawned
process are closed).
.Sp
In SCALAR context returns the output filehandle of the spawned process
(the in and err std streams to the spawned process are closed).
.Sp
In LIST context returns the input, outpur and error filehandles of the
spawned process.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
It's possible to pass environment variables as well, by calling:
.PP
.Vb 1
\&  $r\->subprocess_env\->set($key => $value);
.Ve
.PP
before spawning the subprocess.
.PP
There is an issue with reading from the read filehandle (\f(CW$in_fh\fR)):
.PP
A pipe filehandle returned under perlio-disabled Perl needs to call
\&\fBselect()\fR if the other end is not fast enough to send the data, since
the read is non-blocking.
.PP
A pipe filehandle returned under perlio-enabled Perl on the other hand
does the \fBselect()\fR internally, because it's really a filehandle opened
via \f(CW\*(C`:APR\*(C'\fR layer, which internally uses APR to communicate with the
pipe. The way APR is implemented Perl's \fBselect()\fR cannot be used with
it (mainly because \fBselect()\fR wants \fBfileno()\fR and APR is a crossplatform
implementation which hides the internal datastructure).
.PP
Therefore to write a portable code, you want to use select for
perlio-disabled Perl and do nothing for perlio-enabled Perl, hence you
can use something similar to the \f(CWread_data()\fR wrapper shown in the
Synopsis section.
.PP
Several examples appear in the Synopsis section.
.PP
\&\f(CWspawn_proc_prog()\fR is similar to \f(CWfork()\fR, but provides you a
better framework to communicate with that process and handles the
cleanups for you. But that means that just like \f(CWfork()\fR it gives you
a different process, so you don't use the current Perl interpreter in
that new process. If you try to use that method or fork to run a
high-performance parallel processing you should look elsewhere. You
could try Perl threads, but they are \fBvery\fR expensive to start if you
have a lot of things loaded into memory (since \f(CWperl_clone()\fR dups
almost everything in the perl land, but the opcode tree). In the
mod_perl "paradigm" this is much more expensive than fork, since
normally most of the time we have lots of perl things loaded into
memory. Most likely the best solution here is to offload the job to
PPerl or some other daemon, with the only added complexity of
communication.
.PP
To spawn a completely independent process, which will be able to run
after Apache has been shutdown and which won't prevent Apache from
restarting (releasing the ports Apache is listening to) call
\&\fBspawn_proc_prog()\fR in a void context and make the script detach and
close/reopen its communication streams. For example, spawn a process
as:
.PP
.Vb 2
\&  use Apache2::SubProcess ();
\&  $r\->spawn_proc_prog (\*(Aq/path/to/detach_script.pl\*(Aq, $args);
.Ve
.PP
and the \fI/path/to/detach_script.pl\fR contents are:
.PP
.Vb 4
\&  # file:detach_script.pl
\&  #!/usr/bin/perl \-w
\&  use strict;
\&  use warnings;
\&  
\&  use POSIX \*(Aqsetsid\*(Aq;
\&  
\&  chdir \*(Aq/\*(Aq                or die "Can\*(Aqt chdir to /: $!";
\&  open STDIN, \*(Aq/dev/null\*(Aq  or die "Can\*(Aqt read /dev/null: $!";
\&  open STDOUT, \*(Aq+>>\*(Aq, \*(Aq/path/to/apache/error_log\*(Aq
\&      or die "Can\*(Aqt write to /dev/null: $!";
\&  open STDERR, \*(Aq>&STDOUT\*(Aq  or die "Can\*(Aqt dup stdout: $!";
\&  setsid or die "Can\*(Aqt start a new session: $!";
\&  
\&  # run your code here or call exec to another program
.Ve
.PP
reopening (or closing) the STD streams and called \f(CWsetsid()\fR makes
sure that the process is now fully detached from Apache and has a life
of its own. \f(CWchdir()\fR ensures that no partition is tied, in case you
need to remount it.
.SH "See Also"
.IX Header "See Also"
mod_perl 2.0 documentation.
.SH Copyright
.IX Header "Copyright"
mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.
.SH Authors
.IX Header "Authors"
The mod_perl development team and numerous
contributors.