File: troubleshooting.pod

package info (click to toggle)
libapache2-mod-perl2 2.0.13-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 12,016 kB
  • sloc: perl: 97,771; ansic: 14,493; makefile: 51; sh: 18
file content (877 lines) | stat: -rw-r--r-- 26,200 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
=head1 NAME

Troubleshooting mod_perl problems

=head1 Description

Frequently encountered problems (warnings and fatal errors) and their
troubleshooting.





=head1 Building and Installation




=head2 Cannot find -lgdbm / libgdbm.so.3: open failed: No such file or directory

Please see: L<Missing or Misconfigured
libgdbm.so|docs::1.0::guide::install/Missing_or_Misconfigured_libgdbm_so>.

Also it seems that on Solaris this exact issue doesn't show up at
compile time, but at run time, so you may see the errors like:

  .../mod_perl-1.99_17/blib/arch/auto/APR/APR.so' for module APR:
  ld.so.1: /usr/local/ActivePerl-5.8/bin/perl: fatal:
  libgdbm.so.3: open failed: No such file or directory at
  ...5.8.3/sun4-solaris-thread-multi/DynaLoader.pm line 229.

the solution is the same, make sure that you have the libgdbm shared
library and it's properly symlinked.











=head1 Configuration and Startup


=head2 Can't locate F<TestFilter/in_str_consume.pm> in C<@INC>...

Sometimes you get a problem of perl not being able to locate a certain
Perl module. This can happen in the mod_perl test suite or in the
normal mod_perl setup. One of the possible reasons is a low limit on
the number of files that can be opened by a single process. To check
whether this is the problem run the process under C<strace(1)> or an
equivalent utility.

For example on OpenBSD 3.5 the default setting for a maximum number of
files opened by a single process seems to be 64, so when you try to
run the mod_perl test suite, which opens a few hundreds of files, you
will have a problem. e.g. the test suite may fail as:

  [Wed Aug 25 09:49:40 2004] [info] 26 Apache2:: modules loaded
  [Wed Aug 25 09:49:40 2004] [info] 7 APR:: modules loaded
  [Wed Aug 25 09:49:40 2004] [info] base server + 20 vhosts ready 
  to run tests
  [Wed Aug 25 09:49:40 2004] [error] Can't locate 
  TestFilter/in_str_consume.pm in @INC (@INC contains: ...

Running the system calls tracing program (C<ktrace(1)> on OpenBSD,
C<strace(1)> on Linux):

  % sudo ktrace -d /usr/local/apache/bin/httpd -d /tmp/mod_perl-2.0/t \
    -f /tmp/mod_perl-2.0/t/conf/httpd.conf -DAPACHE2 -X

looking at the ktrace dump reveals:

 16641 httpd    NAMI "/tmp/mod_perl-2.0/t/lib/TestFilter/in_str_consume.pmc"
 16641 httpd    RET   stat -1 errno 2 No such file or directory
 16641 httpd    CALL  open(0x3cdae100,0,0)
 16641 httpd    RET   open -1 errno 24 Too many open files

It's clear that Perl can't load F<TestFilter/in_str_consume.pm>
because it can't open the file.

This problem can be resolved by increasing the open file limit to 128
(or higher):

 $ ulimit -n 128








=head2 "mod_perl.c" is not compatible with this version of Apache
(found 20020628, need 20020903)

That error message means that mod_perl was built against Apache
released on or post-20020628, but you are trying to load it against
one released on or post-20020903. You will see the same error message
for any other Apache module -- this is an error coming from Apache,
not mod_perl.

Apache bumps up a special magic number every time it does a binary
incompatible change, and then it makes sure that all modules that it
loads were compiled against the same compatibility generation (which
may include only one or quite a few Apache releases).

You may encounter this situation when you upgrade to a newer Apache,
without rebuilding mod_perl. Or when you have several versions of
Apache installed on the same system. Or when you install prepackaged
binary versions which aren't coming from the source and aren't made
against the same Apache version.

The solution is to have mod_perl built against the same Apache
installed on your system. So either build from source or contact your
binary version supplier and get a proper package(s) from them.




=head2 Server Hanging at the Startup

First you need to figure out where it hangs. strace(1) or an
equivalent utility can be used to discover which call the server hangs
on. You need to start the process in the single server mode so you
will have only one process to monitor.

For example if the server hangs during 'make test', you should run:

  % cd modperl-2.0
  % strace /path/to/httpd -d t -f t/conf/httpd.conf \
    -DAPACHE2 -DONE_PROCESS -DNO_DETATCH

(and may be C<-DPERL_USEITHREADS> if it was in the original output of
C<make test>.)

If the trace ends with:

  open("/dev/random", O_RDONLY)           = 3
  read(3, <unfinished ...>

then you have a problem with your OS, as F</dev/random> doesn't have
enough entropy to give the required random data, and therefore it
hangs. This may happen in C<apr_uuid_get()> C call or Perl
C<APR::UUID-E<gt>new>.

The solution in this case is either to fix the problem with
your OS, so that

  % perl -le 'open I, "/dev/random"; read I, $d, 10; print $d'

will print some random data and not block. Or you can use an even
simpler test:

  % cat /dev/random

which should print some random data and not block.

If you can't fix the OS problem, you can rebuild Apache 2.0 with
C<--with-devrandom=/dev/urandom> - however, that is not secure for
certain needs.  Alternatively setup EGD and rebuild Apache 2.0 with
C<--with-egd>. Apache 2.1/apr-1.1 will have a self-contained PRNG
generator built-in, which won't rely on F</dev/random>.



=head2 (28)No space left on device

httpd-2.0 is not very helpful at telling which device has run out of
precious space. Most of the time when you get an error like:

  (28)No space left on device:
  mod_rewrite: could not create rewrite_log_lock

it means that your system have run out of semaphore arrays. Sometimes
it's full with legitimate semaphores at other times it's because some
application has leaked semaphores and haven't cleaned them up during
the shutdown (which is usually the case when an application
segfaults).

Use the relevant application to list the ipc facilities usage. On most
Unix platforms this is usually an C<ipcs(1)> utility. For example
linux to list the semaphore arrays you should execute:

  % ipcs -s
  ------ Semaphore Arrays --------
  key        semid      owner      perms      nsems
  0x00000000 2686976    stas      600        1
  0x00000000 2719745    stas      600        1
  0x00000000 2752514    stas      600        1

Next you have to figure out what are the dead ones and remove
them. For example to remove the semid 2719745 execute:

  % ipcrm -s 2719745

Instead of manually removing each (and sometimes there can be many of
them), and if you know that none of listed the semaphores is really
used (all leaked), you can try to remove them all:

  % ipcs -s | perl -ane '`ipcrm -s $F[1]`'

httpd-2.0 seems to use the key C<0x00000000> for its semaphores on
Linux, so to remove only those that match that key you can use:

  % ipcs -s | perl -ane '/^0x00000000/ && `ipcrm -s $F[1]`'

Notice that on other platforms the output of C<ipcs -s> might be
different, so you may need to apply a different Perl one-liner.


=head2 Segmentation Fault when Using DBI

Update DBI to at least version 1.31.


=head2 E<lt>PerlE<gt> directive missing closing 'E<gt>'

See the L<Apache2::PerlSections|docs::2.0::api::Apache2::PerlSections/E_lt_PerlE_gt__directive_missing_closing__E_gt__> manpage.


=head2 'Invalid per-unknown PerlOption: ParseHeaders' on HP-UX 11 for PA-RISC

When building mod_perl 2.0 on HP-UX 11 for PA-RISC architecture, using
the HP ANSI C compiler, please make sure you have installed patches
PHSS_29484 and PHSS_29485. Once installed the issue should go away.








=head1 Shutdown and Restart

Issues happening during server shutdown and restart, or during
specific interpreter shutdown at runtime with threaded mpm.




=head2 Subroutines in E<lt>perlE<gt> sections under threaded mpm

If you have defined a subroutine inside a E<lt>perlE<gt> section,
under threaded mpm (or under perl with enabled ithreads which spawn
its own ithreads), like so:

  <Perl>
    sub foo {}
  </Perl>

At the server shutdown, or when any interpreter quits you will see the
following error in the I<error_log>:

  Attempt to free temp prematurely: SV 0x91b8e74,
  Perl interpreter: 0x8547698 during global destruction.
  Scalars leaked: 1

This is a bug in Perl and as of Perl 5.8.4 it's not resolved. For more
information see:

http://rt.perl.org:80/rt3/Ticket/Display.html?id=29018




=head2 Modules using C<Scalar::Util::weaken> under threaded mpm

Modules using C<Scalar::Util::weaken> under threaded mpm may get:

  Attempt to free unreferenced scalar SV 0x8154f74.

when each interprter exits.

This is a bug in Perl and as of Perl 5.8.4 it's not resolved. For more
information see:

http://rt.perl.org:80/rt3/Ticket/Display.html?id=24660











=head1 Code Parsing and Compilation


=head2 Segfault with __read_nocancel Backtrace

If your application segfaults and you get a similar to the following
backtrace:

  (gdb) bt
  #0  0x4030d4d1 in __read_nocancel () from /lib/tls/libpthread.so.0
  #1  0x00000000 in ?? ()

that usually means that you've build your non-mod_perl modules with
ithreads enabled perl. Then you have built a new perl B<without>
ithreads. But you didn't nuke/rebuild the old non-mod_perl
modules. Now when you try to run those, you get the above segfault. To
solve the problem recompile all the modules. The easiest way to
accomplish that is to either remove all the modules completely, build
the new perl and then install the new modules. You could also try to
create a bundle of the existing modules using C<CPAN.pm> prior to
deleting the old modules, so you can easily reinstall all the modules
you previously had.







=head2 Registry scripts fail to load with: Unrecognized character \xEF at ...

Certain editors (in particular on win32) may add a UTF-8 Byte Order
Marker (BOM: http://www.unicode.org/faq/utf_bom.html#BOM) at the
beginning of the file. Since
C<L<ModPerl::RegistryCooker|docs::2.0::api::ModPerl::RegistryCooker>>
adds extra code in front of the original script, before compiling it,
it creates a situation where BOM appears past the beginning of the
file, which is why the error:

  Unrecognized character \xEF at ...

is thrown by Perl.

The simplest solution is to configure your editor to not add BOMs (or
switch to another editor which allows you to do that).

You could also subclass
C<L<ModPerl::RegistryCooker|docs::2.0::api::ModPerl::RegistryCooker>>
or its existing subclasses to try to remove BOM in
ModPerl::RegistryCooker::read_script():

    # remove BOM
    ${$self->{CODE}} =~ s/^(?:
        \xef\xbb\xbf     |
        \xfe\xff         |
        \xff\xfe         |
        \x00\x00\xfe\xff |
        \xff\xfe\x00\x00
    )//x;

but do you really want to add an overhead of this operation multiple
times, when you could just change the source file once? Probably
not. It was also reported that on win32 the above s/// doesn't work.









=head1 Runtime



=head2 error_log is Full of Escaped \n, \t, etc.

It's an Apache "feature", see
C<L<-DAP_UNSAFE_ERROR_LOG_UNESCAPED|docs::2.0::user::install::install/Apache>>.




=head2 Problems with Catching Signals

See L<Using Signal
Handlers|docs::2.0::user::coding::coding/Using_Signal_Handlers>.







=head2 APR::Socket::recv: (11) Resource temporarily unavailable at ...

You need to make sure that the socket is set to L<blocking IO
mode|docs::2.0::api::APR::Socket/C_opt_set_> before using it.






=head2 C<APR::UUID-E<gt>new> Hanging

See L<Server Hanging at the Startup|/Server_Hanging_at_the_Startup>.






=head2 Memory Leaks

=over

=item * s/// in perls 5.8.1 and 5.8.2

p5-porters report:
http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2003-12/msg00634.html

Fixed in 5.8.3. There is no workaround but to upgrade to 5.8.3 or
higher.


=back





=head2 C Libraries Don't See C<%ENV> Entries Set by Perl Code

For example some people have reported problems with C<DBD::Oracle>
(whose guts are implemented in C), which doesn't see environment
variables (like C<ORACLE_HOME>, C<ORACLE_SID>, etc.) set in the perl
script and therefore fails to connect.

The issue is that the C array C<environ[]> is not thread-safe.
Therefore mod_perl 2.0 unties C<%ENV> from the underlying C<environ[]>
array under the
I<L<perl-script|docs::2.0::user::config::config/C_perl_script_>>
handler.

The C<DBD::Oracle> driver or client library uses C<getenv()> (which
fetches from the C<environ[]> array).  When C<%ENV> is untied from
C<environ[]>, Perl code will see C<%ENV> changes, but C code will not.

The I<L<modperl|docs::2.0::user::config::config/C_modperl_>> handler
does not untie C<%ENV> from C<environ[]>. Still one should avoid
setting C<%ENV> values whenever possible.  And if it is required,
should be done at startup time.

In the particular case of the C<DBD::> drivers, you can set the
variables that don't change (C<$ENV{ORACLE_HOME}> and
C<$ENV{NLS_LANG}> in the startup file, and those that change pass via
the C<connect()> method, e.g.:

  my $sid      = 'ynt0';
  my $dsn      = 'dbi:Oracle:';
  my $user     = 'username/password';
  my $password = '';
  $dbh = DBI->connect("$dsn$sid", $user, $password)
      or die "Cannot connect: " . $DBI::errstr;

Also remember that C<DBD::Oracle> requires that I<ORACLE_HOME> (and
any other stuff like I<NSL_LANG> stuff) be in C<%ENV> when
C<DBD::Oracle> is loaded (which might happen indirectly via the C<DBI>
module. Therefore you need to make sure that wherever that load
happens C<%ENV> is properly set by that time.

Another solution that works B<only with prefork mpm>, is to use
C<Env::C> ( http://search.cpan.org/dist/Env-C/ ). This module sets the
process level environ, bypassing Perl's C<%ENV>. This module is not
thread-safe, due to the nature of environ process struct, so don't
even try using it in a threaded environment.









=head2 Error about not finding I<Apache.pm> with I<CGI.pm>

You need to install at least version 3.11 of CGI.pm to work
under mod_perl 2.0, as earlier CGI.pm versions aren't
mod_perl 2.0 aware.

=head2 20014:Error string not specified yet

This error is reported when some undefined Apache error happens. The
known cases are:

=over

=item when using mod_deflate

A bug in mod_deflate was triggering this error, when a response
handler would flush the data that was flushed earlier:
http://nagoya.apache.org/bugzilla/show_bug.cgi?id=22259
It has been fixed in httpd-2.0.48.

=back


=head2 (22)Invalid argument: core_output_filter: writing data to the network

Apache uses the sendfile syscall on platforms where it is available in
order to speed sending of responses. Unfortunately, on some systems,
Apache will detect the presence of sendfile at compile-time, even when
it does not work properly. This happens most frequently when using
network or other non-standard file-system.

The whole story and the solutions are documented at:
http://httpd.apache.org/docs-2.0/faq/error.html#error.sendfile


=head2 undefined symbol: apr_table_compress

After a successful mod_perl build, sometimes during the startup or a
runtime you'd get an "undefined symbol: foo" error. The following is
one possible scenario to encounter this problem and possible ways to
resolve it.

Let's say you ran mod_perl's test suite:

  % make test

and got errors, and you looked in the F<error_log> file
(F<t/logs/error_log>) and saw one or more "undefined symbol" errors,
e.g.

  % undefined symbol: apr_table_compress

=over

=item Step 1

From the source directory (same place you ran "make test") run:

  % ldd blib/arch/auto/APR/APR.so | grep apr-

ldd is not available on all platforms, e.g. not on Darwin/OS X.
Instead on Darwin/OS X, you can use their otool.

You you should get a full path, for example:

  libapr-0.so.0 => /usr/local/apache2/lib/libapr-0.so.0 (0x40003000)

or

  libapr-0.so.0 => /some/path/to/apache/lib/libapr-0.so.0 (0x40003000)

or something like that. It's that full path to libapr-0.so.0 that you
want.


=item Step 2

Do:

  % nm /path/to/your/libapr-0.so.0 | grep table_compress

for example:

  % nm /usr/local/apache2/lib/libapr-0.so.0 | grep table_compress

You should get something like this:

  0000d010 T apr_table_compress

If you get the message:

 nm: /usr/local/apache2/lib/libapr-0.so.0: no symbols

that means that the library was stripped. You probably want to obtain
Apache 2.x or libapr source, matching your binary and check it
instead. Or rebuild it with debugging enabled, which will not strip
the symbols.

Note that the "grep table_compress" is only an example, the exact
string you are looking for is the name of the "undefined symbol" from
the I<error_log> file.  So, if you get:

  undefined symbol apr_holy_grail

then you would do:

  % nm /usr/local/apache2/lib/libapr-0.so.0 | grep holy_grail




=item Step 3

Now, let's see what shared libraries your apache binary has. So, if in
step 1 you got F</usr/local/apache2/lib/libapr-0.so.0> then you will
do:

  % ldd /usr/local/apache2/bin/httpd

if in step 1 you got F</foo/bar/apache/lib/libapr-0.so.0> then you do:

  % ldd /foo/bar/apache/bin/httpd

The output should look something like this:

  libssl.so.2 => /lib/libssl.so.2 (0x40023000)
  libcrypto.so.2 => /lib/libcrypto.so.2 (0x40054000)
  libaprutil-0.so.0 => /usr/local/apache2/lib/libaprutil-0.so.0 (0x40128000)
  libgdbm.so.2 => /usr/lib/libgdbm.so.2 (0x4013c000)
  libdb-4.0.so => /lib/libdb-4.0.so (0x40143000)
  libexpat.so.0 => /usr/lib/libexpat.so.0 (0x401eb000)
  libapr-0.so.0 => /usr/local/apache2/lib/libapr-0.so.0 (0x4020b000)
  librt.so.1 => /lib/librt.so.1 (0x40228000)
  libm.so.6 => /lib/i686/libm.so.6 (0x4023a000)
  libcrypt.so.1 => /lib/libcrypt.so.1 (0x4025c000)
  libnsl.so.1 => /lib/libnsl.so.1 (0x40289000)
  libdl.so.2 => /lib/libdl.so.2 (0x4029f000)
  libpthread.so.0 => /lib/i686/libpthread.so.0 (0x402a2000)
  libc.so.6 => /lib/i686/libc.so.6 (0x42000000)
  /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0x40000000)

Those are name =E<gt> value pairs showing the shared libraries used by
the C<httpd> binary.

Take note of the value for F<libapr-0.so.0> and compare it to what you
got in step 1. They should be the same, if not, then mod_perl was
compiled pointing to the wrong Apache installation. You should run
"make clean" and then

  % perl Makefile.pl MP_APACHE_CONFIG=/path/to/apache/bin/apr-config

using the correct path for the Apache installation.

=item Step 4

You should also search for extra copies of F<libapr-0.so.0>. If you
find one in I</usr/lib> or I</usr/local/lib> that will explain the
problem. Most likely you have an old pre-installed apr package which
gets loaded before the copy you found in step 1.

On most Linux (and Mac OS X) machines you can do a fast search with:

  % locate libapr-0.so.0

which searches a database of files on your machine. The "locate"
database isn't always up-to-date so a slower, more comprehensive
search can be run (as root if possible):

  % find / -name "libapr-0.so.0*"

or

  % find /usr/local -name "libapr-0.so.0*"

You might get output like this:

  /usr/local/apache2.0.47/lib/libapr-0.so.0.9.4
  /usr/local/apache2.0.47/lib/libapr-0.so.0
  /usr/local/apache2.0.45/lib/libapr-0.so.0.9.3
  /usr/local/apache2.0.45/lib/libapr-0.so.0

in which case you would want to make sure that you are configuring and
compiling mod_perl with the latest version of apache, for example
using the above output, you would do:

  % perl Makefile.PL MP_AP_CONFIG=/usr/local/apache2.0.47
  % make
  % make test


=back

There could be other causes, but this example shows you how to act
when you encounter this problem.



=head2 Variable $x will not stay shared at

This warning is normally as a result of variables that your script is sharing
with subroutines globally, rather than passing by value or reference.  As
the cause and solution of this is virtually identical to another commonly
encountered problem (L<Sometimes it works, sometimes it
doesn't|user::troubleshooting::troubleshooting/Sometimes_it_Works__Sometimes_it_Doesn_t>),
the text is not repeated here but is instead included in that section which
follows this one.

You may have read somewhere F<out there> that this warning can be ignored,
but if you read on you will see that you should F<never> ignore the warning. 
The other thing that might confuse you is that this warning is normally
encountered when defining subroutines within subroutines.  So why would you
experience it in your script where that is not the case?  The reason is
because mod_perl wraps your script in its own subroutine (see the L<Perl
Reference|general::perl_reference::perl_reference/When_You_Cannot_Get_Rid_of_The_Inner_Subroutine>
documentation for more details).




=head2 Sometimes it Works, Sometimes it Doesn't

When you start running your scripts under mod_perl, you might find
yourself in a situation where a script seems to work, but sometimes it
screws up. And the more it runs without a restart, the more it screws
up. Often the problem is easily detectable and solvable. You have to
test your script under a server running in single process mode
(C<httpd -X>).

Generally the problem is the result of using global variables (normally accompanied
by a L<Variable $x will not stay shared at|user::troubleshooting::troubleshooting/Variable__x_will_not_stay_shared_at> warning). Because
global variables don't change from one script invocation to another
unless you change them, you can find your scripts do strange things.

Let's look at three real world examples:

=head3 An Easy Break-in

The first example is amazing: Web Services. Imagine that you enter
some site where you have an account, perhaps a free email
account. Having read your own mail you decide to take a look at
someone else's.

You type in the username you want to peek at and a dummy password and
try to enter the account. On some services this will work!!!

You say, why in the world does this happen? The answer is simple:
B<Global Variables>. You have entered the account of someone who
happened to be served by the same server child as you. Because of
sloppy programming, a global variable was not reset at the beginning
of the program and voila, you can easily peek into someone else's
email!  Here is an example of sloppy code:

  use vars ($authenticated);
  my $q = new CGI;
  my $username = $q->param('username');
  my $passwd   = $q->param('passwd');
  authenticate($username,$passwd);
    # failed, break out
  unless ($authenticated){
    print "Wrong passwd";
    exit;
  }
    # user is OK, fetch user's data
  show_user($username);
  
  sub authenticate{
    my ($username,$passwd) = @_;
    # some checking
    $authenticated = 1 if SOME_USER_PASSWD_CHECK_IS_OK;
  }

Do you see the catch? With the code above, I can type in any valid
username and any dummy password and enter that user's account,
provided she has successfully entered her account before me using the
same child process! Since C<$authenticated> is global--if it becomes 1
once, it'll stay 1 for the remainder of the child's life!!! The
solution is trivial--reset C<$authenticated> to 0 at the beginning of
the program.

A cleaner solution of course is not to rely on global variables, but
rely on the return value from the function.

  my $q = CGI->new;
  my $username = $q->param('username');
  my $passwd   = $q->param('passwd');
  my $authenticated = authenticate($username,$passwd);
    # failed, break out
  unless ($authenticated){
    print "Wrong passwd";
    exit;
  }
    # user is OK, fetch user's data
  show_user($username);
  
  sub authenticate{
    my ($username,$passwd) = @_;
    # some checking
    return (SOME_USER_PASSWD_CHECK_IS_OK) ? 1 : 0;
  }

Of course this example is trivial--but believe me it happens!

=head3 Thinking mod_cgi

Just another little one liner that can spoil your day, assuming you
forgot to reset the C<$allowed> variable.  It works perfectly OK in
plain mod_cgi:

  $allowed = 1 if $username eq 'admin';

But using mod_perl, and if your system administrator with superuser
access rights has previously used the system, anybody who is lucky
enough to be served later by the same child which served your
administrator will happen to gain the same rights.

The obvious fix is:

  $allowed = $username eq 'admin' ? 1 : 0;

=head3 Regular Expression Memory

Another good example is usage of the C</o> regular expression
modifier, which compiles a regular expression once, on its first
execution, and never compiles it again. This problem can be difficult
to detect, as after restarting the server each request you make will
be served by a different child process, and thus the regex pattern for
that child will be compiled afresh.  Only when you make a request that
happens to be served by a child which has already cached the regex
will you see the problem.  Generally you miss that. When you press
reload, you see that it works (with a new, fresh child). Eventually it
doesn't, because you get a child that has already cached the regex
and won't recompile because of the C</o> modifier.

An example of such a case would be:

  my $pat = $q->param("keyword");
  foreach( @list ) {
    print if /$pat/o;
  }

To make sure you don't miss these bugs always test your CGI in
L<single process
mode|general::control::control/Running_a_Server_in_Single_Process_Mode>.

To solve this particular C</o> modifier problem refer to L<Compiled
Regular Expressions|general::perl_reference::perl_reference/Compiled_Regular_Expressions>.

For more details and further examples please see the L<Perl Reference|general::perl_reference::perl_reference/my____Scoped_Variable_in_Nested_Subroutines> documentation.




=head1 Issues with APR Used Outside of mod_perl

It doesn't strictly belong to this document, since it's talking about
APR usages outside of mod_perl, so this may move to its own dedicated
page, some time later.

Whenever using an C<APR::> package outside of mod_perl, you need to:

  use APR;

in order to load the XS subroutines. For example:

  % perl -MAPR -MAPR::UUID -le 'print APR::UUID->new->format'







=head1 Maintainers

Maintainer is the person(s) you should contact with updates,
corrections and patches.

=over

=item * Stas Bekman

=back


=head1 Authors

=over

=item * Stas Bekman

=back

Only the major authors are listed above. For contributors see the
Changes file.


=cut