This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
implement diagnostics ignore/restore macros for Visual C++
[perl5.git] / util.c
CommitLineData
a0d0e21e 1/* util.c
a687059c 2 *
1129b882
NC
3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
a687059c 5 *
d48672a2
LW
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8d063cd8 8 *
8d063cd8 9 */
a0d0e21e
LW
10
11/*
4ac71550
TC
12 * 'Very useful, no doubt, that was to Saruman; yet it seems that he was
13 * not content.' --Gandalf to Pippin
14 *
cdad3b53 15 * [p.598 of _The Lord of the Rings_, III/xi: "The Palantír"]
a0d0e21e 16 */
8d063cd8 17
166f8a29
DM
18/* This file contains assorted utility routines.
19 * Which is a polite way of saying any stuff that people couldn't think of
20 * a better place for. Amongst other things, it includes the warning and
21 * dieing stuff, plus wrappers for malloc code.
22 */
23
8d063cd8 24#include "EXTERN.h"
864dbfa3 25#define PERL_IN_UTIL_C
8d063cd8 26#include "perl.h"
7dc86639 27#include "reentr.h"
62b28dd9 28
97cb92d6 29#if defined(USE_PERLIO)
2e0cfa16 30#include "perliol.h" /* For PerlIOUnix_refcnt */
6f408c34 31#endif
2e0cfa16 32
64ca3a65 33#ifndef PERL_MICRO
a687059c 34#include <signal.h>
36477c24
PP
35#ifndef SIG_ERR
36# define SIG_ERR ((Sighandler_t) -1)
37#endif
64ca3a65 38#endif
36477c24 39
3be8f094
TC
40#include <math.h>
41#include <stdlib.h>
42
172d2248
OS
43#ifdef __Lynx__
44/* Missing protos on LynxOS */
45int putenv(char *);
46#endif
47
40262ff4
AB
48#ifdef __amigaos__
49# include "amigaos4/amigaio.h"
50#endif
51
868439a2
JH
52#ifdef HAS_SELECT
53# ifdef I_SYS_SELECT
54# include <sys/select.h>
55# endif
56#endif
57
470dd224 58#ifdef USE_C_BACKTRACE
0762e42f
JH
59# ifdef I_BFD
60# define USE_BFD
61# ifdef PERL_DARWIN
62# undef USE_BFD /* BFD is useless in OS X. */
63# endif
64# ifdef USE_BFD
65# include <bfd.h>
66# endif
67# endif
470dd224
JH
68# ifdef I_DLFCN
69# include <dlfcn.h>
70# endif
71# ifdef I_EXECINFO
72# include <execinfo.h>
73# endif
74#endif
75
b001a0d1
FC
76#ifdef PERL_DEBUG_READONLY_COW
77# include <sys/mman.h>
78#endif
79
8d063cd8 80#define FLUSH
8d063cd8 81
a687059c
LW
82/* NOTE: Do not call the next three routines directly. Use the macros
83 * in handy.h, so that we can easily redefine everything to do tracking of
84 * allocated hunks back to the original New to track down any memory leaks.
20cec16a 85 * XXX This advice seems to be widely ignored :-( --AD August 1996.
a687059c
LW
86 */
87
79a92154 88#if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
1f4d2d4e
NC
89# define ALWAYS_NEED_THX
90#endif
91
b001a0d1
FC
92#if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
93static void
94S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
95{
96 if (header->readonly
97 && mprotect(header, header->size, PROT_READ|PROT_WRITE))
98 Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
99 header, header->size, errno);
100}
101
102static void
103S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
104{
105 if (header->readonly
106 && mprotect(header, header->size, PROT_READ))
107 Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
108 header, header->size, errno);
109}
110# define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
111# define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
112#else
113# define maybe_protect_rw(foo) NOOP
114# define maybe_protect_ro(foo) NOOP
115#endif
116
3f07c2bc
FC
117#if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
118 /* Use memory_debug_header */
119# define USE_MDH
120# if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
121 || defined(PERL_DEBUG_READONLY_COW)
122# define MDH_HAS_SIZE
123# endif
124#endif
125
26fa51c3
AMS
126/* paranoid version of system's malloc() */
127
bd4080b3 128Malloc_t
4f63d024 129Perl_safesysmalloc(MEM_SIZE size)
8d063cd8 130{
1f4d2d4e 131#ifdef ALWAYS_NEED_THX
54aff467 132 dTHX;
0cb20dae 133#endif
bd4080b3 134 Malloc_t ptr;
9efda33a
TC
135
136#ifdef USE_MDH
137 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
138 goto out_of_memory;
a78adc84 139 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
9efda33a 140#endif
34de22dd 141#ifdef DEBUGGING
03c5309f 142 if ((SSize_t)size < 0)
147e3846 143 Perl_croak_nocontext("panic: malloc, size=%" UVuf, (UV) size);
34de22dd 144#endif
b001a0d1
FC
145 if (!size) size = 1; /* malloc(0) is NASTY on our system */
146#ifdef PERL_DEBUG_READONLY_COW
147 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
148 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
149 perror("mmap failed");
150 abort();
151 }
152#else
153 ptr = (Malloc_t)PerlMem_malloc(size?size:1);
154#endif
da927450 155 PERL_ALLOC_CHECK(ptr);
bd61b366 156 if (ptr != NULL) {
3f07c2bc 157#ifdef USE_MDH
7cb608b5
NC
158 struct perl_memory_debug_header *const header
159 = (struct perl_memory_debug_header *)ptr;
9a083ecf
NC
160#endif
161
162#ifdef PERL_POISON
7e337ee0 163 PoisonNew(((char *)ptr), size, char);
9a083ecf 164#endif
7cb608b5 165
9a083ecf 166#ifdef PERL_TRACK_MEMPOOL
7cb608b5
NC
167 header->interpreter = aTHX;
168 /* Link us into the list. */
169 header->prev = &PL_memory_debug_header;
170 header->next = PL_memory_debug_header.next;
171 PL_memory_debug_header.next = header;
b001a0d1 172 maybe_protect_rw(header->next);
7cb608b5 173 header->next->prev = header;
b001a0d1
FC
174 maybe_protect_ro(header->next);
175# ifdef PERL_DEBUG_READONLY_COW
176 header->readonly = 0;
cd1541b2 177# endif
e8dda941 178#endif
3f07c2bc 179#ifdef MDH_HAS_SIZE
b001a0d1
FC
180 header->size = size;
181#endif
b033d668 182 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
147e3846 183 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
b033d668
DD
184
185 }
8d063cd8 186 else {
296f0d56 187#ifdef USE_MDH
9efda33a 188 out_of_memory:
296f0d56
TC
189#endif
190 {
191#ifndef ALWAYS_NEED_THX
192 dTHX;
193#endif
194 if (PL_nomemok)
195 ptr = NULL;
196 else
197 croak_no_mem();
198 }
8d063cd8 199 }
b033d668 200 return ptr;
8d063cd8
LW
201}
202
f2517201 203/* paranoid version of system's realloc() */
8d063cd8 204
bd4080b3 205Malloc_t
4f63d024 206Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
8d063cd8 207{
1f4d2d4e 208#ifdef ALWAYS_NEED_THX
54aff467 209 dTHX;
0cb20dae 210#endif
bd4080b3 211 Malloc_t ptr;
b001a0d1
FC
212#ifdef PERL_DEBUG_READONLY_COW
213 const MEM_SIZE oldsize = where
a78adc84 214 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
b001a0d1
FC
215 : 0;
216#endif
8d063cd8 217
7614df0c 218 if (!size) {
f2517201 219 safesysfree(where);
b033d668 220 ptr = NULL;
7614df0c 221 }
b033d668
DD
222 else if (!where) {
223 ptr = safesysmalloc(size);
224 }
225 else {
3f07c2bc 226#ifdef USE_MDH
b033d668 227 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
9efda33a
TC
228 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
229 goto out_of_memory;
b033d668
DD
230 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
231 {
232 struct perl_memory_debug_header *const header
233 = (struct perl_memory_debug_header *)where;
7cb608b5 234
b001a0d1 235# ifdef PERL_TRACK_MEMPOOL
b033d668
DD
236 if (header->interpreter != aTHX) {
237 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
238 header->interpreter, aTHX);
239 }
240 assert(header->next->prev == header);
241 assert(header->prev->next == header);
cd1541b2 242# ifdef PERL_POISON
b033d668
DD
243 if (header->size > size) {
244 const MEM_SIZE freed_up = header->size - size;
245 char *start_of_freed = ((char *)where) + size;
246 PoisonFree(start_of_freed, freed_up, char);
247 }
cd1541b2 248# endif
b001a0d1 249# endif
3f07c2bc 250# ifdef MDH_HAS_SIZE
b033d668 251 header->size = size;
b001a0d1 252# endif
b033d668 253 }
e8dda941 254#endif
34de22dd 255#ifdef DEBUGGING
b033d668 256 if ((SSize_t)size < 0)
147e3846 257 Perl_croak_nocontext("panic: realloc, size=%" UVuf, (UV)size);
34de22dd 258#endif
b001a0d1 259#ifdef PERL_DEBUG_READONLY_COW
b033d668
DD
260 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
261 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
262 perror("mmap failed");
263 abort();
264 }
265 Copy(where,ptr,oldsize < size ? oldsize : size,char);
266 if (munmap(where, oldsize)) {
267 perror("munmap failed");
268 abort();
269 }
b001a0d1 270#else
b033d668 271 ptr = (Malloc_t)PerlMem_realloc(where,size);
b001a0d1 272#endif
b033d668 273 PERL_ALLOC_CHECK(ptr);
a1d180c4 274
4fd0a9b8
NC
275 /* MUST do this fixup first, before doing ANYTHING else, as anything else
276 might allocate memory/free/move memory, and until we do the fixup, it
277 may well be chasing (and writing to) free memory. */
b033d668 278 if (ptr != NULL) {
b001a0d1 279#ifdef PERL_TRACK_MEMPOOL
b033d668
DD
280 struct perl_memory_debug_header *const header
281 = (struct perl_memory_debug_header *)ptr;
7cb608b5 282
9a083ecf 283# ifdef PERL_POISON
b033d668
DD
284 if (header->size < size) {
285 const MEM_SIZE fresh = size - header->size;
286 char *start_of_fresh = ((char *)ptr) + size;
287 PoisonNew(start_of_fresh, fresh, char);
288 }
9a083ecf
NC
289# endif
290
b033d668
DD
291 maybe_protect_rw(header->next);
292 header->next->prev = header;
293 maybe_protect_ro(header->next);
294 maybe_protect_rw(header->prev);
295 header->prev->next = header;
296 maybe_protect_ro(header->prev);
b001a0d1 297#endif
b033d668
DD
298 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
299 }
4fd0a9b8
NC
300
301 /* In particular, must do that fixup above before logging anything via
302 *printf(), as it can reallocate memory, which can cause SEGVs. */
303
147e3846
KW
304 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
305 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
4fd0a9b8 306
b033d668 307 if (ptr == NULL) {
296f0d56 308#ifdef USE_MDH
9efda33a 309 out_of_memory:
296f0d56
TC
310#endif
311 {
312#ifndef ALWAYS_NEED_THX
313 dTHX;
314#endif
315 if (PL_nomemok)
316 ptr = NULL;
317 else
318 croak_no_mem();
319 }
0cb20dae 320 }
8d063cd8 321 }
b033d668 322 return ptr;
8d063cd8
LW
323}
324
f2517201 325/* safe version of system's free() */
8d063cd8 326
54310121 327Free_t
4f63d024 328Perl_safesysfree(Malloc_t where)
8d063cd8 329{
79a92154 330#ifdef ALWAYS_NEED_THX
54aff467 331 dTHX;
155aba94 332#endif
147e3846 333 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
378cc40b 334 if (where) {
3f07c2bc 335#ifdef USE_MDH
6edcbed6 336 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
cd1541b2 337 {
7cb608b5 338 struct perl_memory_debug_header *const header
6edcbed6 339 = (struct perl_memory_debug_header *)where_intrn;
7cb608b5 340
3f07c2bc 341# ifdef MDH_HAS_SIZE
b001a0d1
FC
342 const MEM_SIZE size = header->size;
343# endif
344# ifdef PERL_TRACK_MEMPOOL
7cb608b5 345 if (header->interpreter != aTHX) {
5637ef5b
NC
346 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
347 header->interpreter, aTHX);
7cb608b5
NC
348 }
349 if (!header->prev) {
cd1541b2
NC
350 Perl_croak_nocontext("panic: duplicate free");
351 }
5637ef5b
NC
352 if (!(header->next))
353 Perl_croak_nocontext("panic: bad free, header->next==NULL");
354 if (header->next->prev != header || header->prev->next != header) {
355 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
356 "header=%p, ->prev->next=%p",
357 header->next->prev, header,
358 header->prev->next);
cd1541b2 359 }
7cb608b5 360 /* Unlink us from the chain. */
b001a0d1 361 maybe_protect_rw(header->next);
7cb608b5 362 header->next->prev = header->prev;
b001a0d1
FC
363 maybe_protect_ro(header->next);
364 maybe_protect_rw(header->prev);
7cb608b5 365 header->prev->next = header->next;
b001a0d1
FC
366 maybe_protect_ro(header->prev);
367 maybe_protect_rw(header);
7cb608b5 368# ifdef PERL_POISON
6edcbed6 369 PoisonNew(where_intrn, size, char);
cd1541b2 370# endif
7cb608b5
NC
371 /* Trigger the duplicate free warning. */
372 header->next = NULL;
b001a0d1
FC
373# endif
374# ifdef PERL_DEBUG_READONLY_COW
6edcbed6 375 if (munmap(where_intrn, size)) {
b001a0d1
FC
376 perror("munmap failed");
377 abort();
378 }
379# endif
7cb608b5 380 }
6edcbed6
DD
381#else
382 Malloc_t where_intrn = where;
383#endif /* USE_MDH */
b001a0d1 384#ifndef PERL_DEBUG_READONLY_COW
6edcbed6 385 PerlMem_free(where_intrn);
b001a0d1 386#endif
378cc40b 387 }
8d063cd8
LW
388}
389
f2517201 390/* safe version of system's calloc() */
1050c9ca 391
bd4080b3 392Malloc_t
4f63d024 393Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
1050c9ca 394{
1f4d2d4e 395#ifdef ALWAYS_NEED_THX
54aff467 396 dTHX;
0cb20dae 397#endif
bd4080b3 398 Malloc_t ptr;
3f07c2bc 399#if defined(USE_MDH) || defined(DEBUGGING)
ad7244db 400 MEM_SIZE total_size = 0;
4b1123b9 401#endif
1050c9ca 402
ad7244db 403 /* Even though calloc() for zero bytes is strange, be robust. */
4b1123b9 404 if (size && (count <= MEM_SIZE_MAX / size)) {
3f07c2bc 405#if defined(USE_MDH) || defined(DEBUGGING)
ad7244db 406 total_size = size * count;
4b1123b9
NC
407#endif
408 }
ad7244db 409 else
d1decf2b 410 croak_memory_wrap();
3f07c2bc 411#ifdef USE_MDH
a78adc84
DM
412 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
413 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
ad7244db 414 else
d1decf2b 415 croak_memory_wrap();
ad7244db 416#endif
1050c9ca 417#ifdef DEBUGGING
03c5309f 418 if ((SSize_t)size < 0 || (SSize_t)count < 0)
147e3846 419 Perl_croak_nocontext("panic: calloc, size=%" UVuf ", count=%" UVuf,
5637ef5b 420 (UV)size, (UV)count);
1050c9ca 421#endif
b001a0d1
FC
422#ifdef PERL_DEBUG_READONLY_COW
423 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
424 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
425 perror("mmap failed");
426 abort();
427 }
428#elif defined(PERL_TRACK_MEMPOOL)
e1a95402
NC
429 /* Have to use malloc() because we've added some space for our tracking
430 header. */
ad7244db
JH
431 /* malloc(0) is non-portable. */
432 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
e1a95402
NC
433#else
434 /* Use calloc() because it might save a memset() if the memory is fresh
435 and clean from the OS. */
ad7244db
JH
436 if (count && size)
437 ptr = (Malloc_t)PerlMem_calloc(count, size);
438 else /* calloc(0) is non-portable. */
439 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
e8dda941 440#endif
da927450 441 PERL_ALLOC_CHECK(ptr);
22730398 442 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) calloc %zu x %zu = %zu bytes\n",PTR2UV(ptr),(long)PL_an++, count, size, total_size));
bd61b366 443 if (ptr != NULL) {
3f07c2bc 444#ifdef USE_MDH
7cb608b5
NC
445 {
446 struct perl_memory_debug_header *const header
447 = (struct perl_memory_debug_header *)ptr;
448
b001a0d1 449# ifndef PERL_DEBUG_READONLY_COW
e1a95402 450 memset((void*)ptr, 0, total_size);
b001a0d1
FC
451# endif
452# ifdef PERL_TRACK_MEMPOOL
7cb608b5
NC
453 header->interpreter = aTHX;
454 /* Link us into the list. */
455 header->prev = &PL_memory_debug_header;
456 header->next = PL_memory_debug_header.next;
457 PL_memory_debug_header.next = header;
b001a0d1 458 maybe_protect_rw(header->next);
7cb608b5 459 header->next->prev = header;
b001a0d1
FC
460 maybe_protect_ro(header->next);
461# ifdef PERL_DEBUG_READONLY_COW
462 header->readonly = 0;
463# endif
464# endif
3f07c2bc 465# ifdef MDH_HAS_SIZE
e1a95402 466 header->size = total_size;
cd1541b2 467# endif
a78adc84 468 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
7cb608b5 469 }
e8dda941 470#endif
1050c9ca
PP
471 return ptr;
472 }
0cb20dae 473 else {
1f4d2d4e 474#ifndef ALWAYS_NEED_THX
0cb20dae
NC
475 dTHX;
476#endif
477 if (PL_nomemok)
478 return NULL;
4cbe3a7d 479 croak_no_mem();
0cb20dae 480 }
1050c9ca
PP
481}
482
cae6d0e5
GS
483/* These must be defined when not using Perl's malloc for binary
484 * compatibility */
485
486#ifndef MYMALLOC
487
488Malloc_t Perl_malloc (MEM_SIZE nbytes)
489{
20b7effb
JH
490#ifdef PERL_IMPLICIT_SYS
491 dTHX;
492#endif
077a72a9 493 return (Malloc_t)PerlMem_malloc(nbytes);
cae6d0e5
GS
494}
495
496Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
497{
20b7effb
JH
498#ifdef PERL_IMPLICIT_SYS
499 dTHX;
500#endif
077a72a9 501 return (Malloc_t)PerlMem_calloc(elements, size);
cae6d0e5
GS
502}
503
504Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
505{
20b7effb
JH
506#ifdef PERL_IMPLICIT_SYS
507 dTHX;
508#endif
077a72a9 509 return (Malloc_t)PerlMem_realloc(where, nbytes);
cae6d0e5
GS
510}
511
512Free_t Perl_mfree (Malloc_t where)
513{
20b7effb
JH
514#ifdef PERL_IMPLICIT_SYS
515 dTHX;
516#endif
cae6d0e5
GS
517 PerlMem_free(where);
518}
519
520#endif
521
19e16554
DM
522/* copy a string up to some (non-backslashed) delimiter, if any.
523 * With allow_escape, converts \<delimiter> to <delimiter>, while leaves
524 * \<non-delimiter> as-is.
525 * Returns the position in the src string of the closing delimiter, if
526 * any, or returns fromend otherwise.
527 * This is the internal implementation for Perl_delimcpy and
528 * Perl_delimcpy_no_escape.
529 */
8d063cd8 530
ba0a4150 531static char *
31ee10f1 532S_delimcpy_intern(char *to, const char *toend, const char *from,
ba0a4150
FC
533 const char *fromend, int delim, I32 *retlen,
534 const bool allow_escape)
8d063cd8 535{
eb578fdb 536 I32 tolen;
35da51f7 537
7918f24d
NC
538 PERL_ARGS_ASSERT_DELIMCPY;
539
fc36a67e 540 for (tolen = 0; from < fromend; from++, tolen++) {
19e16554 541 if (allow_escape && *from == '\\' && from + 1 < fromend) {
35da51f7 542 if (from[1] != delim) {
fc36a67e
PP
543 if (to < toend)
544 *to++ = *from;
545 tolen++;
fc36a67e 546 }
35da51f7 547 from++;
378cc40b 548 }
bedebaa5 549 else if (*from == delim)
8d063cd8 550 break;
fc36a67e
PP
551 if (to < toend)
552 *to++ = *from;
8d063cd8 553 }
bedebaa5
CS
554 if (to < toend)
555 *to = '\0';
fc36a67e 556 *retlen = tolen;
73d840c0 557 return (char *)from;
8d063cd8
LW
558}
559
ba0a4150
FC
560char *
561Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
562{
563 PERL_ARGS_ASSERT_DELIMCPY;
564
31ee10f1 565 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 1);
ba0a4150
FC
566}
567
568char *
569Perl_delimcpy_no_escape(char *to, const char *toend, const char *from,
570 const char *fromend, int delim, I32 *retlen)
571{
572 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
573
31ee10f1 574 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 0);
ba0a4150
FC
575}
576
fcfc5a27
KW
577/*
578=head1 Miscellaneous Functions
579
580=for apidoc Am|char *|ninstr|char * big|char * bigend|char * little|char * little_end
581
582Find the first (leftmost) occurrence of a sequence of bytes within another
583sequence. This is the Perl version of C<strstr()>, extended to handle
584arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
585is what the initial C<n> in the function name stands for; some systems have an
586equivalent, C<memmem()>, but with a somewhat different API).
587
588Another way of thinking about this function is finding a needle in a haystack.
589C<big> points to the first byte in the haystack. C<big_end> points to one byte
590beyond the final byte in the haystack. C<little> points to the first byte in
591the needle. C<little_end> points to one byte beyond the final byte in the
592needle. All the parameters must be non-C<NULL>.
593
594The function returns C<NULL> if there is no occurrence of C<little> within
595C<big>. If C<little> is the empty string, C<big> is returned.
596
597Because this function operates at the byte level, and because of the inherent
598characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
599needle and the haystack are strings with the same UTF-8ness, but not if the
600UTF-8ness differs.
601
602=cut
603
604*/
a687059c
LW
605
606char *
04c9e624 607Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
8d063cd8 608{
7918f24d 609 PERL_ARGS_ASSERT_NINSTR;
b8070b07
KW
610
611#ifdef HAS_MEMMEM
612 return ninstr(big, bigend, little, lend);
613#else
614
4c8626be
GA
615 if (little >= lend)
616 return (char*)big;
617 {
8ba22ff4 618 const char first = *little;
8ba22ff4 619 bigend -= lend - little++;
4c8626be
GA
620 OUTER:
621 while (big <= bigend) {
b0ca24ee 622 if (*big++ == first) {
19742f39 623 const char *s, *x;
b0ca24ee
JH
624 for (x=big,s=little; s < lend; x++,s++) {
625 if (*s != *x)
626 goto OUTER;
627 }
628 return (char*)(big-1);
4c8626be 629 }
4c8626be 630 }
378cc40b 631 }
bd61b366 632 return NULL;
b8070b07
KW
633
634#endif
635
a687059c
LW
636}
637
fcfc5a27
KW
638/*
639=head1 Miscellaneous Functions
640
641=for apidoc Am|char *|rninstr|char * big|char * bigend|char * little|char * little_end
642
643Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
644sequence of bytes within another sequence, returning C<NULL> if there is no
645such occurrence.
646
647=cut
648
649*/
a687059c
LW
650
651char *
5aaab254 652Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
a687059c 653{
eb578fdb
KW
654 const char *bigbeg;
655 const I32 first = *little;
656 const char * const littleend = lend;
a687059c 657
7918f24d
NC
658 PERL_ARGS_ASSERT_RNINSTR;
659
260d78c9 660 if (little >= littleend)
08105a92 661 return (char*)bigend;
a687059c
LW
662 bigbeg = big;
663 big = bigend - (littleend - little++);
664 while (big >= bigbeg) {
eb578fdb 665 const char *s, *x;
a687059c
LW
666 if (*big-- != first)
667 continue;
668 for (x=big+2,s=little; s < littleend; /**/ ) {
4fc877ac 669 if (*s != *x)
a687059c 670 break;
4fc877ac
AL
671 else {
672 x++;
673 s++;
a687059c
LW
674 }
675 }
676 if (s >= littleend)
08105a92 677 return (char*)(big+1);
378cc40b 678 }
bd61b366 679 return NULL;
378cc40b 680}
a687059c 681
cf93c79d
IZ
682/* As a space optimization, we do not compile tables for strings of length
683 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
684 special-cased in fbm_instr().
685
686 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
687
954c1994 688/*
ccfc67b7
JH
689=head1 Miscellaneous Functions
690
954c1994
GS
691=for apidoc fbm_compile
692
41715441 693Analyzes the string in order to make fast searches on it using C<fbm_instr()>
954c1994
GS
694-- the Boyer-Moore algorithm.
695
696=cut
697*/
698
378cc40b 699void
7506f9c3 700Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
378cc40b 701{
eb578fdb 702 const U8 *s;
ea725ce6 703 STRLEN i;
0b71040e 704 STRLEN len;
79072805 705 U32 frequency = 256;
2bda37ba 706 MAGIC *mg;
00cccd05 707 PERL_DEB( STRLEN rarest = 0 );
79072805 708
7918f24d
NC
709 PERL_ARGS_ASSERT_FBM_COMPILE;
710
948d2370 711 if (isGV_with_GP(sv) || SvROK(sv))
4265b45d
NC
712 return;
713
9402563a
NC
714 if (SvVALID(sv))
715 return;
716
c517dc2b 717 if (flags & FBMcf_TAIL) {
890ce7af 718 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
396482e1 719 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
c517dc2b
JH
720 if (mg && mg->mg_len >= 0)
721 mg->mg_len++;
722 }
11609d9c 723 if (!SvPOK(sv) || SvNIOKp(sv))
66379c06
FC
724 s = (U8*)SvPV_force_mutable(sv, len);
725 else s = (U8 *)SvPV_mutable(sv, len);
d1be9408 726 if (len == 0) /* TAIL might be on a zero-length string. */
cf93c79d 727 return;
c13a5c80 728 SvUPGRADE(sv, SVt_PVMG);
78d0cf80 729 SvIOK_off(sv);
8eeaf79a 730 SvNOK_off(sv);
2bda37ba 731
a5c7cb08 732 /* add PERL_MAGIC_bm magic holding the FBM lookup table */
2bda37ba
NC
733
734 assert(!mg_find(sv, PERL_MAGIC_bm));
735 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
736 assert(mg);
737
02128f11 738 if (len > 2) {
21aeb718
NC
739 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
740 the BM table. */
66a1b24b 741 const U8 mlen = (len>255) ? 255 : (U8)len;
2bda37ba 742 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
eb578fdb 743 U8 *table;
cf93c79d 744
2bda37ba 745 Newx(table, 256, U8);
7506f9c3 746 memset((void*)table, mlen, 256);
2bda37ba
NC
747 mg->mg_ptr = (char *)table;
748 mg->mg_len = 256;
749
750 s += len - 1; /* last char */
02128f11 751 i = 0;
cf93c79d
IZ
752 while (s >= sb) {
753 if (table[*s] == mlen)
7506f9c3 754 table[*s] = (U8)i;
cf93c79d
IZ
755 s--, i++;
756 }
378cc40b 757 }
378cc40b 758
9cbe880b 759 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
bbce6d69 760 for (i = 0; i < len; i++) {
22c35a8c 761 if (PL_freq[s[i]] < frequency) {
00cccd05 762 PERL_DEB( rarest = i );
22c35a8c 763 frequency = PL_freq[s[i]];
378cc40b
LW
764 }
765 }
cf93c79d 766 BmUSEFUL(sv) = 100; /* Initial value */
b4204fb6 767 ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
147e3846 768 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %" UVuf "\n",
d80cf470 769 s[rarest], (UV)rarest));
378cc40b
LW
770}
771
cf93c79d 772
954c1994
GS
773/*
774=for apidoc fbm_instr
775
3f4963df 776Returns the location of the SV in the string delimited by C<big> and
41c8d07a
DM
777C<bigend> (C<bigend>) is the char following the last char).
778It returns C<NULL> if the string can't be found. The C<sv>
796b6530 779does not have to be C<fbm_compiled>, but the search will not be as fast
954c1994
GS
780then.
781
782=cut
41c8d07a
DM
783
784If SvTAIL(littlestr) is true, a fake "\n" was appended to to the string
785during FBM compilation due to FBMcf_TAIL in flags. It indicates that
786the littlestr must be anchored to the end of bigstr (or to any \n if
787FBMrf_MULTILINE).
788
789E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
790while /abc$/ compiles to "abc\n" with SvTAIL() true.
791
792A littlestr of "abc", !SvTAIL matches as /abc/;
793a littlestr of "ab\n", SvTAIL matches as:
794 without FBMrf_MULTILINE: /ab\n?\z/
795 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
796
797(According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
798 "If SvTAIL is actually due to \Z or \z, this gives false positives
799 if multiline".
954c1994
GS
800*/
801
41c8d07a 802
378cc40b 803char *
5aaab254 804Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
378cc40b 805{
eb578fdb 806 unsigned char *s;
cf93c79d 807 STRLEN l;
eb578fdb
KW
808 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
809 STRLEN littlelen = l;
810 const I32 multiline = flags & FBMrf_MULTILINE;
4e8879f3
DM
811 bool valid = SvVALID(littlestr);
812 bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
cf93c79d 813
7918f24d
NC
814 PERL_ARGS_ASSERT_FBM_INSTR;
815
bb152a4b
DM
816 assert(bigend >= big);
817
eb160463 818 if ((STRLEN)(bigend - big) < littlelen) {
e08d24ff 819 if ( tail
eb160463 820 && ((STRLEN)(bigend - big) == littlelen - 1)
a1d180c4 821 && (littlelen == 1
12ae5dfc 822 || (*big == *little &&
27da23d5 823 memEQ((char *)big, (char *)little, littlelen - 1))))
cf93c79d 824 return (char*)big;
bd61b366 825 return NULL;
cf93c79d 826 }
378cc40b 827
21aeb718
NC
828 switch (littlelen) { /* Special cases for 0, 1 and 2 */
829 case 0:
830 return (char*)big; /* Cannot be SvTAIL! */
41c8d07a 831
21aeb718 832 case 1:
e08d24ff 833 if (tail && !multiline) /* Anchor only! */
147f21b5
DM
834 /* [-1] is safe because we know that bigend != big. */
835 return (char *) (bigend - (bigend[-1] == '\n'));
836
837 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
838 if (s)
839 return (char *)s;
e08d24ff 840 if (tail)
cf93c79d 841 return (char *) bigend;
bd61b366 842 return NULL;
41c8d07a 843
21aeb718 844 case 2:
e08d24ff 845 if (tail && !multiline) {
147f21b5
DM
846 /* a littlestr with SvTAIL must be of the form "X\n" (where X
847 * is a single char). It is anchored, and can only match
848 * "....X\n" or "....X" */
849 if (bigend[-2] == *little && bigend[-1] == '\n')
cf93c79d
IZ
850 return (char*)bigend - 2;
851 if (bigend[-1] == *little)
852 return (char*)bigend - 1;
bd61b366 853 return NULL;
cf93c79d 854 }
147f21b5 855
cf93c79d 856 {
147f21b5
DM
857 /* memchr() is likely to be very fast, possibly using whatever
858 * hardware support is available, such as checking a whole
859 * cache line in one instruction.
860 * So for a 2 char pattern, calling memchr() is likely to be
861 * faster than running FBM, or rolling our own. The previous
862 * version of this code was roll-your-own which typically
863 * only needed to read every 2nd char, which was good back in
864 * the day, but no longer.
865 */
866 unsigned char c1 = little[0];
867 unsigned char c2 = little[1];
868
869 /* *** for all this case, bigend points to the last char,
870 * not the trailing \0: this makes the conditions slightly
871 * simpler */
872 bigend--;
873 s = big;
874 if (c1 != c2) {
875 while (s < bigend) {
876 /* do a quick test for c1 before calling memchr();
877 * this avoids the expensive fn call overhead when
878 * there are lots of c1's */
879 if (LIKELY(*s != c1)) {
880 s++;
881 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
882 if (!s)
883 break;
884 }
885 if (s[1] == c2)
886 return (char*)s;
887
888 /* failed; try searching for c2 this time; that way
889 * we don't go pathologically slow when the string
890 * consists mostly of c1's or vice versa.
891 */
892 s += 2;
893 if (s > bigend)
894 break;
895 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
896 if (!s)
897 break;
898 if (s[-1] == c1)
899 return (char*)s - 1;
900 }
901 }
902 else {
903 /* c1, c2 the same */
904 while (s < bigend) {
905 if (s[0] == c1) {
906 got_1char:
907 if (s[1] == c1)
908 return (char*)s;
909 s += 2;
910 }
911 else {
912 s++;
913 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
914 if (!s || s >= bigend)
915 break;
916 goto got_1char;
917 }
918 }
919 }
920
921 /* failed to find 2 chars; try anchored match at end without
922 * the \n */
e08d24ff 923 if (tail && bigend[0] == little[0])
147f21b5
DM
924 return (char *)bigend;
925 return NULL;
926 }
41c8d07a 927
21aeb718
NC
928 default:
929 break; /* Only lengths 0 1 and 2 have special-case code. */
d48672a2 930 }
21aeb718 931
e08d24ff 932 if (tail && !multiline) { /* tail anchored? */
bbce6d69 933 s = bigend - littlelen;
a1d180c4 934 if (s >= big && bigend[-1] == '\n' && *s == *little
cf93c79d
IZ
935 /* Automatically of length > 2 */
936 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
7506f9c3 937 {
bbce6d69 938 return (char*)s; /* how sweet it is */
7506f9c3
GS
939 }
940 if (s[1] == *little
941 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
942 {
cf93c79d 943 return (char*)s + 1; /* how sweet it is */
7506f9c3 944 }
bd61b366 945 return NULL;
02128f11 946 }
41c8d07a 947
4e8879f3 948 if (!valid) {
147f21b5 949 /* not compiled; use Perl_ninstr() instead */
c4420975 950 char * const b = ninstr((char*)big,(char*)bigend,
cf93c79d
IZ
951 (char*)little, (char*)little + littlelen);
952
add424da 953 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
cf93c79d 954 return b;
a687059c 955 }
a1d180c4 956
3566a07d
NC
957 /* Do actual FBM. */
958 if (littlelen > (STRLEN)(bigend - big))
959 return NULL;
960
961 {
2bda37ba 962 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
eb578fdb 963 const unsigned char *oldlittle;
cf93c79d 964
316ebaf2
JH
965 assert(mg);
966
cf93c79d
IZ
967 --littlelen; /* Last char found by table lookup */
968
969 s = big + littlelen;
970 little += littlelen; /* last char */
971 oldlittle = little;
972 if (s < bigend) {
316ebaf2 973 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
147f21b5 974 const unsigned char lastc = *little;
eb578fdb 975 I32 tmp;
cf93c79d
IZ
976
977 top2:
7506f9c3 978 if ((tmp = table[*s])) {
147f21b5
DM
979 /* *s != lastc; earliest position it could match now is
980 * tmp slots further on */
981 if ((s += tmp) >= bigend)
982 goto check_end;
983 if (LIKELY(*s != lastc)) {
984 s++;
985 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
986 if (!s) {
987 s = bigend;
988 goto check_end;
989 }
990 goto top2;
991 }
cf93c79d 992 }
147f21b5
DM
993
994
995 /* hand-rolled strncmp(): less expensive than calling the
996 * real function (maybe???) */
997 {
eb578fdb 998 unsigned char * const olds = s;
cf93c79d
IZ
999
1000 tmp = littlelen;
1001
1002 while (tmp--) {
1003 if (*--s == *--little)
1004 continue;
cf93c79d
IZ
1005 s = olds + 1; /* here we pay the price for failure */
1006 little = oldlittle;
1007 if (s < bigend) /* fake up continue to outer loop */
1008 goto top2;
1009 goto check_end;
1010 }
1011 return (char *)s;
a687059c 1012 }
378cc40b 1013 }
cf93c79d 1014 check_end:
c8029a41 1015 if ( s == bigend
e08d24ff 1016 && tail
12ae5dfc
JH
1017 && memEQ((char *)(bigend - littlelen),
1018 (char *)(oldlittle - littlelen), littlelen) )
cf93c79d 1019 return (char*)bigend - littlelen;
bd61b366 1020 return NULL;
378cc40b 1021 }
378cc40b
LW
1022}
1023
8d063cd8
LW
1024/* copy a string to a safe spot */
1025
954c1994 1026/*
ccfc67b7
JH
1027=head1 Memory Management
1028
954c1994
GS
1029=for apidoc savepv
1030
72d33970
FC
1031Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1032string which is a duplicate of C<pv>. The size of the string is
30a15352
KW
1033determined by C<strlen()>, which means it may not contain embedded C<NUL>
1034characters and must have a trailing C<NUL>. The memory allocated for the new
1035string can be freed with the C<Safefree()> function.
954c1994 1036
0358c255
KW
1037On some platforms, Windows for example, all allocated memory owned by a thread
1038is deallocated when that thread ends. So if you need that not to happen, you
1039need to use the shared memory functions, such as C<L</savesharedpv>>.
1040
954c1994
GS
1041=cut
1042*/
1043
8d063cd8 1044char *
efdfce31 1045Perl_savepv(pTHX_ const char *pv)
8d063cd8 1046{
96a5add6 1047 PERL_UNUSED_CONTEXT;
e90e2364 1048 if (!pv)
bd61b366 1049 return NULL;
66a1b24b
AL
1050 else {
1051 char *newaddr;
1052 const STRLEN pvlen = strlen(pv)+1;
10edeb5d
JH
1053 Newx(newaddr, pvlen, char);
1054 return (char*)memcpy(newaddr, pv, pvlen);
66a1b24b 1055 }
8d063cd8
LW
1056}
1057
a687059c
LW
1058/* same thing but with a known length */
1059
954c1994
GS
1060/*
1061=for apidoc savepvn
1062
72d33970 1063Perl's version of what C<strndup()> would be if it existed. Returns a
61a925ed 1064pointer to a newly allocated string which is a duplicate of the first
72d33970 1065C<len> bytes from C<pv>, plus a trailing
6602b933 1066C<NUL> byte. The memory allocated for
cbf82dd0 1067the new string can be freed with the C<Safefree()> function.
954c1994 1068
0358c255
KW
1069On some platforms, Windows for example, all allocated memory owned by a thread
1070is deallocated when that thread ends. So if you need that not to happen, you
1071need to use the shared memory functions, such as C<L</savesharedpvn>>.
1072
954c1994
GS
1073=cut
1074*/
1075
a687059c 1076char *
5aaab254 1077Perl_savepvn(pTHX_ const char *pv, I32 len)
a687059c 1078{
eb578fdb 1079 char *newaddr;
96a5add6 1080 PERL_UNUSED_CONTEXT;
a687059c 1081
223f01db
KW
1082 assert(len >= 0);
1083
a02a5408 1084 Newx(newaddr,len+1,char);
92110913 1085 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
efdfce31 1086 if (pv) {
e90e2364
NC
1087 /* might not be null terminated */
1088 newaddr[len] = '\0';
07409e01 1089 return (char *) CopyD(pv,newaddr,len,char);
92110913
NIS
1090 }
1091 else {
07409e01 1092 return (char *) ZeroD(newaddr,len+1,char);
92110913 1093 }
a687059c
LW
1094}
1095
05ec9bb3
NIS
1096/*
1097=for apidoc savesharedpv
1098
61a925ed
AMS
1099A version of C<savepv()> which allocates the duplicate string in memory
1100which is shared between threads.
05ec9bb3
NIS
1101
1102=cut
1103*/
1104char *
efdfce31 1105Perl_savesharedpv(pTHX_ const char *pv)
05ec9bb3 1106{
eb578fdb 1107 char *newaddr;
490a0e98 1108 STRLEN pvlen;
dc3bf405
BF
1109
1110 PERL_UNUSED_CONTEXT;
1111
e90e2364 1112 if (!pv)
bd61b366 1113 return NULL;
e90e2364 1114
490a0e98
NC
1115 pvlen = strlen(pv)+1;
1116 newaddr = (char*)PerlMemShared_malloc(pvlen);
e90e2364 1117 if (!newaddr) {
4cbe3a7d 1118 croak_no_mem();
05ec9bb3 1119 }
10edeb5d 1120 return (char*)memcpy(newaddr, pv, pvlen);
05ec9bb3
NIS
1121}
1122
2e0de35c 1123/*
d9095cec
NC
1124=for apidoc savesharedpvn
1125
1126A version of C<savepvn()> which allocates the duplicate string in memory
796b6530 1127which is shared between threads. (With the specific difference that a C<NULL>
d9095cec
NC
1128pointer is not acceptable)
1129
1130=cut
1131*/
1132char *
1133Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1134{
1135 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
7918f24d 1136
dc3bf405 1137 PERL_UNUSED_CONTEXT;
6379d4a9 1138 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
7918f24d 1139
d9095cec 1140 if (!newaddr) {
4cbe3a7d 1141 croak_no_mem();
d9095cec
NC
1142 }
1143 newaddr[len] = '\0';
1144 return (char*)memcpy(newaddr, pv, len);
1145}
1146
1147/*
2e0de35c
NC
1148=for apidoc savesvpv
1149
6832267f 1150A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2e0de35c
NC
1151the passed in SV using C<SvPV()>
1152
0358c255
KW
1153On some platforms, Windows for example, all allocated memory owned by a thread
1154is deallocated when that thread ends. So if you need that not to happen, you
1155need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1156
2e0de35c
NC
1157=cut
1158*/
1159
1160char *
1161Perl_savesvpv(pTHX_ SV *sv)
1162{
1163 STRLEN len;
7452cf6a 1164 const char * const pv = SvPV_const(sv, len);
eb578fdb 1165 char *newaddr;
2e0de35c 1166
7918f24d
NC
1167 PERL_ARGS_ASSERT_SAVESVPV;
1168
26866f99 1169 ++len;
a02a5408 1170 Newx(newaddr,len,char);
07409e01 1171 return (char *) CopyD(pv,newaddr,len,char);
2e0de35c 1172}
05ec9bb3 1173
9dcc53ea
Z
1174/*
1175=for apidoc savesharedsvpv
1176
1177A version of C<savesharedpv()> which allocates the duplicate string in
1178memory which is shared between threads.
1179
1180=cut
1181*/
1182
1183char *
1184Perl_savesharedsvpv(pTHX_ SV *sv)
1185{
1186 STRLEN len;
1187 const char * const pv = SvPV_const(sv, len);
1188
1189 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1190
1191 return savesharedpvn(pv, len);
1192}
05ec9bb3 1193
cea2e8a9 1194/* the SV for Perl_form() and mess() is not kept in an arena */
fc36a67e 1195
76e3520e 1196STATIC SV *
cea2e8a9 1197S_mess_alloc(pTHX)
fc36a67e
PP
1198{
1199 SV *sv;
1200 XPVMG *any;
1201
627364f1 1202 if (PL_phase != PERL_PHASE_DESTRUCT)
84bafc02 1203 return newSVpvs_flags("", SVs_TEMP);
e72dc28c 1204
0372dbb6
GS
1205 if (PL_mess_sv)
1206 return PL_mess_sv;
1207
fc36a67e 1208 /* Create as PVMG now, to avoid any upgrading later */
a02a5408
JC
1209 Newx(sv, 1, SV);
1210 Newxz(any, 1, XPVMG);
fc36a67e
PP
1211 SvFLAGS(sv) = SVt_PVMG;
1212 SvANY(sv) = (void*)any;
6136c704 1213 SvPV_set(sv, NULL);
fc36a67e 1214 SvREFCNT(sv) = 1 << 30; /* practically infinite */
e72dc28c 1215 PL_mess_sv = sv;
fc36a67e
PP
1216 return sv;
1217}
1218
c5be433b 1219#if defined(PERL_IMPLICIT_CONTEXT)
cea2e8a9
GS
1220char *
1221Perl_form_nocontext(const char* pat, ...)
1222{
1223 dTHX;
c5be433b 1224 char *retval;
cea2e8a9 1225 va_list args;
7918f24d 1226 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
cea2e8a9 1227 va_start(args, pat);
c5be433b 1228 retval = vform(pat, &args);
cea2e8a9 1229 va_end(args);
c5be433b 1230 return retval;
cea2e8a9 1231}
c5be433b 1232#endif /* PERL_IMPLICIT_CONTEXT */
cea2e8a9 1233
7c9e965c 1234/*
ccfc67b7 1235=head1 Miscellaneous Functions
7c9e965c
JP
1236=for apidoc form
1237
1238Takes a sprintf-style format pattern and conventional
1239(non-SV) arguments and returns the formatted string.
1240
1241 (char *) Perl_form(pTHX_ const char* pat, ...)
1242
1243can be used any place a string (char *) is required:
1244
1245 char * s = Perl_form("%d.%d",major,minor);
1246
1247Uses a single private buffer so if you want to format several strings you
1248must explicitly copy the earlier strings away (and free the copies when you
1249are done).
1250
1251=cut
1252*/
1253
8990e307 1254char *
864dbfa3 1255Perl_form(pTHX_ const char* pat, ...)
8990e307 1256{
c5be433b 1257 char *retval;
46fc3d4c 1258 va_list args;
7918f24d 1259 PERL_ARGS_ASSERT_FORM;
46fc3d4c 1260 va_start(args, pat);
c5be433b 1261 retval = vform(pat, &args);
46fc3d4c 1262 va_end(args);
c5be433b
GS
1263 return retval;
1264}
1265
1266char *
1267Perl_vform(pTHX_ const char *pat, va_list *args)
1268{
2d03de9c 1269 SV * const sv = mess_alloc();
7918f24d 1270 PERL_ARGS_ASSERT_VFORM;
4608196e 1271 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
e72dc28c 1272 return SvPVX(sv);
46fc3d4c 1273}
a687059c 1274
c5df3096
Z
1275/*
1276=for apidoc Am|SV *|mess|const char *pat|...
1277
1278Take a sprintf-style format pattern and argument list. These are used to
1279generate a string message. If the message does not end with a newline,
1280then it will be extended with some indication of the current location
1281in the code, as described for L</mess_sv>.
1282
1283Normally, the resulting message is returned in a new mortal SV.
1284During global destruction a single SV may be shared between uses of
1285this function.
1286
1287=cut
1288*/
1289
5a844595
GS
1290#if defined(PERL_IMPLICIT_CONTEXT)
1291SV *
1292Perl_mess_nocontext(const char *pat, ...)
1293{
1294 dTHX;
1295 SV *retval;
1296 va_list args;
7918f24d 1297 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
5a844595
GS
1298 va_start(args, pat);
1299 retval = vmess(pat, &args);
1300 va_end(args);
1301 return retval;
1302}
1303#endif /* PERL_IMPLICIT_CONTEXT */
1304
06bf62c7 1305SV *
5a844595
GS
1306Perl_mess(pTHX_ const char *pat, ...)
1307{
1308 SV *retval;
1309 va_list args;
7918f24d 1310 PERL_ARGS_ASSERT_MESS;
5a844595
GS
1311 va_start(args, pat);
1312 retval = vmess(pat, &args);
1313 va_end(args);
1314 return retval;
1315}
1316
25502127
FC
1317const COP*
1318Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1319 bool opnext)
ae7d165c 1320{
25502127
FC
1321 /* Look for curop starting from o. cop is the last COP we've seen. */
1322 /* opnext means that curop is actually the ->op_next of the op we are
1323 seeking. */
ae7d165c 1324
7918f24d
NC
1325 PERL_ARGS_ASSERT_CLOSEST_COP;
1326
25502127
FC
1327 if (!o || !curop || (
1328 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1329 ))
fabdb6c0 1330 return cop;
ae7d165c
PJ
1331
1332 if (o->op_flags & OPf_KIDS) {
5f66b61c 1333 const OP *kid;
e6dae479 1334 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
5f66b61c 1335 const COP *new_cop;
ae7d165c
PJ
1336
1337 /* If the OP_NEXTSTATE has been optimised away we can still use it
1338 * the get the file and line number. */
1339
1340 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
5f66b61c 1341 cop = (const COP *)kid;
ae7d165c
PJ
1342
1343 /* Keep searching, and return when we've found something. */
1344
25502127 1345 new_cop = closest_cop(cop, kid, curop, opnext);
fabdb6c0
AL
1346 if (new_cop)
1347 return new_cop;
ae7d165c
PJ
1348 }
1349 }
1350
1351 /* Nothing found. */
1352
5f66b61c 1353 return NULL;
ae7d165c
PJ
1354}
1355
c5df3096
Z
1356/*
1357=for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1358
1359Expands a message, intended for the user, to include an indication of
1360the current location in the code, if the message does not already appear
1361to be complete.
1362
1363C<basemsg> is the initial message or object. If it is a reference, it
1364will be used as-is and will be the result of this function. Otherwise it
1365is used as a string, and if it already ends with a newline, it is taken
1366to be complete, and the result of this function will be the same string.
1367If the message does not end with a newline, then a segment such as C<at
1368foo.pl line 37> will be appended, and possibly other clauses indicating
1369the current state of execution. The resulting message will end with a
1370dot and a newline.
1371
1372Normally, the resulting message is returned in a new mortal SV.
1373During global destruction a single SV may be shared between uses of this
1374function. If C<consume> is true, then the function is permitted (but not
1375required) to modify and return C<basemsg> instead of allocating a new SV.
1376
1377=cut
1378*/
1379
5a844595 1380SV *
c5df3096 1381Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
46fc3d4c 1382{
c5df3096 1383 SV *sv;
46fc3d4c 1384
0762e42f 1385#if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
470dd224
JH
1386 {
1387 char *ws;
22ff3130 1388 UV wi;
470dd224 1389 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
22ff3130
HS
1390 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1391 && grok_atoUV(ws, &wi, NULL)
1392 && wi <= PERL_INT_MAX
1393 ) {
1394 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
470dd224
JH
1395 }
1396 }
1397#endif
1398
c5df3096
Z
1399 PERL_ARGS_ASSERT_MESS_SV;
1400
1401 if (SvROK(basemsg)) {
1402 if (consume) {
1403 sv = basemsg;
1404 }
1405 else {
1406 sv = mess_alloc();
1407 sv_setsv(sv, basemsg);
1408 }
1409 return sv;
1410 }
1411
1412 if (SvPOK(basemsg) && consume) {
1413 sv = basemsg;
1414 }
1415 else {
1416 sv = mess_alloc();
1417 sv_copypv(sv, basemsg);
1418 }
7918f24d 1419
46fc3d4c 1420 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
ae7d165c
PJ
1421 /*
1422 * Try and find the file and line for PL_op. This will usually be
1423 * PL_curcop, but it might be a cop that has been optimised away. We
1424 * can try to find such a cop by searching through the optree starting
1425 * from the sibling of PL_curcop.
1426 */
1427
f4c61774
DM
1428 if (PL_curcop) {
1429 const COP *cop =
1430 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1431 if (!cop)
1432 cop = PL_curcop;
1433
1434 if (CopLINE(cop))
1435 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1436 OutCopFILE(cop), (IV)CopLINE(cop));
1437 }
1438
191f87d5
DH
1439 /* Seems that GvIO() can be untrustworthy during global destruction. */
1440 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1441 && IoLINES(GvIOp(PL_last_in_gv)))
1442 {
2748e602 1443 STRLEN l;
e1ec3a88 1444 const bool line_mode = (RsSIMPLE(PL_rs) &&
2748e602 1445 *SvPV_const(PL_rs,l) == '\n' && l == 1);
147e3846 1446 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
3b46b707
BF
1447 SVfARG(PL_last_in_gv == PL_argvgv
1448 ? &PL_sv_no
1449 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
edc2eac3
JH
1450 line_mode ? "line" : "chunk",
1451 (IV)IoLINES(GvIOp(PL_last_in_gv)));
a687059c 1452 }
627364f1 1453 if (PL_phase == PERL_PHASE_DESTRUCT)
5f66b61c
AL
1454 sv_catpvs(sv, " during global destruction");
1455 sv_catpvs(sv, ".\n");
a687059c 1456 }
06bf62c7 1457 return sv;
a687059c
LW
1458}
1459
c5df3096
Z
1460/*
1461=for apidoc Am|SV *|vmess|const char *pat|va_list *args
1462
1463C<pat> and C<args> are a sprintf-style format pattern and encapsulated
801caa78
KW
1464argument list, respectively. These are used to generate a string message. If
1465the
c5df3096
Z
1466message does not end with a newline, then it will be extended with
1467some indication of the current location in the code, as described for
1468L</mess_sv>.
1469
1470Normally, the resulting message is returned in a new mortal SV.
1471During global destruction a single SV may be shared between uses of
1472this function.
1473
1474=cut
1475*/
1476
1477SV *
1478Perl_vmess(pTHX_ const char *pat, va_list *args)
1479{
c5df3096
Z
1480 SV * const sv = mess_alloc();
1481
1482 PERL_ARGS_ASSERT_VMESS;
1483
1484 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1485 return mess_sv(sv, 1);
1486}
1487
7ff03255 1488void
7d0994e0 1489Perl_write_to_stderr(pTHX_ SV* msv)
7ff03255
SG
1490{
1491 IO *io;
1492 MAGIC *mg;
1493
7918f24d
NC
1494 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1495
7ff03255
SG
1496 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1497 && (io = GvIO(PL_stderrgv))
daba3364 1498 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
36925d9e 1499 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
d1d7a15d 1500 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
7ff03255 1501 else {
53c1dcc0 1502 PerlIO * const serr = Perl_error_log;
7ff03255 1503
83c55556 1504 do_print(msv, serr);
7ff03255 1505 (void)PerlIO_flush(serr);
7ff03255
SG
1506 }
1507}
1508
c5df3096
Z
1509/*
1510=head1 Warning and Dieing
1511*/
1512
1513/* Common code used in dieing and warning */
1514
1515STATIC SV *
1516S_with_queued_errors(pTHX_ SV *ex)
1517{
1518 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1519 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1520 sv_catsv(PL_errors, ex);
1521 ex = sv_mortalcopy(PL_errors);
1522 SvCUR_set(PL_errors, 0);
1523 }
1524 return ex;
1525}
3ab1ac99 1526
46d9c920 1527STATIC bool
c5df3096 1528S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
63315e18 1529{
1565c085 1530 dVAR;
63315e18
NC
1531 HV *stash;
1532 GV *gv;
1533 CV *cv;
46d9c920
NC
1534 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1535 /* sv_2cv might call Perl_croak() or Perl_warner() */
1536 SV * const oldhook = *hook;
1537
2460a496 1538 if (!oldhook || oldhook == PERL_WARNHOOK_FATAL)
c5df3096 1539 return FALSE;
63315e18 1540
63315e18 1541 ENTER;
46d9c920
NC
1542 SAVESPTR(*hook);
1543 *hook = NULL;
1544 cv = sv_2cv(oldhook, &stash, &gv, 0);
63315e18
NC
1545 LEAVE;
1546 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1547 dSP;
c5df3096 1548 SV *exarg;
63315e18
NC
1549
1550 ENTER;
2782061f 1551 save_re_context();
46d9c920
NC
1552 if (warn) {
1553 SAVESPTR(*hook);
1554 *hook = NULL;
1555 }
c5df3096
Z
1556 exarg = newSVsv(ex);
1557 SvREADONLY_on(exarg);
1558 SAVEFREESV(exarg);
63315e18 1559
46d9c920 1560 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
63315e18 1561 PUSHMARK(SP);
c5df3096 1562 XPUSHs(exarg);
63315e18 1563 PUTBACK;
daba3364 1564 call_sv(MUTABLE_SV(cv), G_DISCARD);
63315e18
NC
1565 POPSTACK;
1566 LEAVE;
46d9c920 1567 return TRUE;
63315e18 1568 }
46d9c920 1569 return FALSE;
63315e18
NC
1570}
1571
c5df3096
Z
1572/*
1573=for apidoc Am|OP *|die_sv|SV *baseex
e07360fa 1574
c5df3096
Z
1575Behaves the same as L</croak_sv>, except for the return type.
1576It should be used only where the C<OP *> return type is required.
1577The function never actually returns.
e07360fa 1578
c5df3096
Z
1579=cut
1580*/
e07360fa 1581
6879a07b
TK
1582/* silence __declspec(noreturn) warnings */
1583MSVC_DIAG_IGNORE(4646 4645)
c5df3096
Z
1584OP *
1585Perl_die_sv(pTHX_ SV *baseex)
36477c24 1586{
c5df3096
Z
1587 PERL_ARGS_ASSERT_DIE_SV;
1588 croak_sv(baseex);
e5964223 1589 /* NOTREACHED */
117af67d 1590 NORETURN_FUNCTION_END;
36477c24 1591}
6879a07b 1592MSVC_DIAG_RESTORE
36477c24 1593
c5df3096
Z
1594/*
1595=for apidoc Am|OP *|die|const char *pat|...
1596
1597Behaves the same as L</croak>, except for the return type.
1598It should be used only where the C<OP *> return type is required.
1599The function never actually returns.
1600
1601=cut
1602*/
1603
c5be433b 1604#if defined(PERL_IMPLICIT_CONTEXT)
6879a07b
TK
1605
1606/* silence __declspec(noreturn) warnings */
1607MSVC_DIAG_IGNORE(4646 4645)
cea2e8a9
GS
1608OP *
1609Perl_die_nocontext(const char* pat, ...)
a687059c 1610{
cea2e8a9 1611 dTHX;
a687059c 1612 va_list args;
cea2e8a9 1613 va_start(args, pat);
c5df3096 1614 vcroak(pat, &args);
e5964223 1615 NOT_REACHED; /* NOTREACHED */
cea2e8a9 1616 va_end(args);
117af67d 1617 NORETURN_FUNCTION_END;
cea2e8a9 1618}
6879a07b
TK
1619MSVC_DIAG_RESTORE
1620
c5be433b 1621#endif /* PERL_IMPLICIT_CONTEXT */
cea2e8a9 1622
6879a07b
TK
1623/* silence __declspec(noreturn) warnings */
1624MSVC_DIAG_IGNORE(4646 4645)
cea2e8a9
GS
1625OP *
1626Perl_die(pTHX_ const char* pat, ...)
1627{
cea2e8a9
GS
1628 va_list args;
1629 va_start(args, pat);
c5df3096 1630 vcroak(pat, &args);
e5964223 1631 NOT_REACHED; /* NOTREACHED */
cea2e8a9 1632 va_end(args);
117af67d 1633 NORETURN_FUNCTION_END;
cea2e8a9 1634}
6879a07b 1635MSVC_DIAG_RESTORE
cea2e8a9 1636
c5df3096
Z
1637/*
1638=for apidoc Am|void|croak_sv|SV *baseex
1639
1640This is an XS interface to Perl's C<die> function.
1641
1642C<baseex> is the error message or object. If it is a reference, it
1643will be used as-is. Otherwise it is used as a string, and if it does
1644not end with a newline then it will be extended with some indication of
1645the current location in the code, as described for L</mess_sv>.
1646
1647The error message or object will be used as an exception, by default
1648returning control to the nearest enclosing C<eval>, but subject to
1649modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1650function never returns normally.
1651
1652To die with a simple string message, the L</croak> function may be
1653more convenient.
1654
1655=cut
1656*/
1657
c5be433b 1658void
c5df3096 1659Perl_croak_sv(pTHX_ SV *baseex)
cea2e8a9 1660{
c5df3096
Z
1661 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1662 PERL_ARGS_ASSERT_CROAK_SV;
1663 invoke_exception_hook(ex, FALSE);
1664 die_unwind(ex);
1665}
1666
1667/*
1668=for apidoc Am|void|vcroak|const char *pat|va_list *args
1669
1670This is an XS interface to Perl's C<die> function.
1671
1672C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1673argument list. These are used to generate a string message. If the
1674message does not end with a newline, then it will be extended with
1675some indication of the current location in the code, as described for
1676L</mess_sv>.
1677
1678The error message will be used as an exception, by default
1679returning control to the nearest enclosing C<eval>, but subject to
1680modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1681function never returns normally.
a687059c 1682
c5df3096
Z
1683For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1684(C<$@>) will be used as an error message or object instead of building an
1685error message from arguments. If you want to throw a non-string object,
1686or build an error message in an SV yourself, it is preferable to use
1687the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
5a844595 1688
c5df3096
Z
1689=cut
1690*/
1691
1692void
1693Perl_vcroak(pTHX_ const char* pat, va_list *args)
1694{
1695 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1696 invoke_exception_hook(ex, FALSE);
1697 die_unwind(ex);
a687059c
LW
1698}
1699
c5df3096
Z
1700/*
1701=for apidoc Am|void|croak|const char *pat|...
1702
1703This is an XS interface to Perl's C<die> function.
1704
1705Take a sprintf-style format pattern and argument list. These are used to
1706generate a string message. If the message does not end with a newline,
1707then it will be extended with some indication of the current location
1708in the code, as described for L</mess_sv>.
1709
1710The error message will be used as an exception, by default
1711returning control to the nearest enclosing C<eval>, but subject to
1712modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1713function never returns normally.
1714
1715For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1716(C<$@>) will be used as an error message or object instead of building an
1717error message from arguments. If you want to throw a non-string object,
1718or build an error message in an SV yourself, it is preferable to use
1719the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1720
1721=cut
1722*/
1723
c5be433b 1724#if defined(PERL_IMPLICIT_CONTEXT)
8990e307 1725void
cea2e8a9 1726Perl_croak_nocontext(const char *pat, ...)
a687059c 1727{
cea2e8a9 1728 dTHX;
a687059c 1729 va_list args;
cea2e8a9 1730 va_start(args, pat);
c5be433b 1731 vcroak(pat, &args);
e5964223 1732 NOT_REACHED; /* NOTREACHED */
cea2e8a9
GS
1733 va_end(args);
1734}
1735#endif /* PERL_IMPLICIT_CONTEXT */
1736
c5df3096
Z
1737void
1738Perl_croak(pTHX_ const char *pat, ...)
1739{
1740 va_list args;
1741 va_start(args, pat);
1742 vcroak(pat, &args);
e5964223 1743 NOT_REACHED; /* NOTREACHED */
c5df3096
Z
1744 va_end(args);
1745}
1746
954c1994 1747/*
6ad8f254
NC
1748=for apidoc Am|void|croak_no_modify
1749
1750Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
72d33970 1751terser object code than using C<Perl_croak>. Less code used on exception code
6ad8f254
NC
1752paths reduces CPU cache pressure.
1753
d8e47b5c 1754=cut
6ad8f254
NC
1755*/
1756
1757void
88772978 1758Perl_croak_no_modify(void)
6ad8f254 1759{
cb077ed2 1760 Perl_croak_nocontext( "%s", PL_no_modify);
6ad8f254
NC
1761}
1762
4cbe3a7d
DD
1763/* does not return, used in util.c perlio.c and win32.c
1764 This is typically called when malloc returns NULL.
1765*/
1766void
88772978 1767Perl_croak_no_mem(void)
4cbe3a7d
DD
1768{
1769 dTHX;
77c1c05b 1770
375ed12a
JH
1771 int fd = PerlIO_fileno(Perl_error_log);
1772 if (fd < 0)
1773 SETERRNO(EBADF,RMS_IFI);
1774 else {
1775 /* Can't use PerlIO to write as it allocates memory */
b469f1e0 1776 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
375ed12a 1777 }
4cbe3a7d
DD
1778 my_exit(1);
1779}
1780
3d04513d
DD
1781/* does not return, used only in POPSTACK */
1782void
1783Perl_croak_popstack(void)
1784{
1785 dTHX;
1786 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1787 my_exit(1);
1788}
1789
6ad8f254 1790/*
c5df3096 1791=for apidoc Am|void|warn_sv|SV *baseex
ccfc67b7 1792
c5df3096 1793This is an XS interface to Perl's C<warn> function.
954c1994 1794
c5df3096
Z
1795C<baseex> is the error message or object. If it is a reference, it
1796will be used as-is. Otherwise it is used as a string, and if it does
1797not end with a newline then it will be extended with some indication of
1798the current location in the code, as described for L</mess_sv>.
9983fa3c 1799
c5df3096
Z
1800The error message or object will by default be written to standard error,
1801but this is subject to modification by a C<$SIG{__WARN__}> handler.
9983fa3c 1802
c5df3096
Z
1803To warn with a simple string message, the L</warn> function may be
1804more convenient.
954c1994
GS
1805
1806=cut
1807*/
1808
cea2e8a9 1809void
c5df3096 1810Perl_warn_sv(pTHX_ SV *baseex)
cea2e8a9 1811{
c5df3096
Z
1812 SV *ex = mess_sv(baseex, 0);
1813 PERL_ARGS_ASSERT_WARN_SV;
1814 if (!invoke_exception_hook(ex, TRUE))
1815 write_to_stderr(ex);
cea2e8a9
GS
1816}
1817
c5df3096
Z
1818/*
1819=for apidoc Am|void|vwarn|const char *pat|va_list *args
1820
1821This is an XS interface to Perl's C<warn> function.
1822
1823C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1824argument list. These are used to generate a string message. If the
1825message does not end with a newline, then it will be extended with
1826some indication of the current location in the code, as described for
1827L</mess_sv>.
1828
1829The error message or object will by default be written to standard error,
1830but this is subject to modification by a C<$SIG{__WARN__}> handler.
1831
1832Unlike with L</vcroak>, C<pat> is not permitted to be null.
1833
1834=cut
1835*/
1836
c5be433b
GS
1837void
1838Perl_vwarn(pTHX_ const char* pat, va_list *args)
cea2e8a9 1839{
c5df3096 1840 SV *ex = vmess(pat, args);
7918f24d 1841 PERL_ARGS_ASSERT_VWARN;
c5df3096
Z
1842 if (!invoke_exception_hook(ex, TRUE))
1843 write_to_stderr(ex);
1844}
7918f24d 1845
c5df3096
Z
1846/*
1847=for apidoc Am|void|warn|const char *pat|...
87582a92 1848
c5df3096
Z
1849This is an XS interface to Perl's C<warn> function.
1850
1851Take a sprintf-style format pattern and argument list. These are used to
1852generate a string message. If the message does not end with a newline,
1853then it will be extended with some indication of the current location
1854in the code, as described for L</mess_sv>.
1855
1856The error message or object will by default be written to standard error,
1857but this is subject to modification by a C<$SIG{__WARN__}> handler.
1858
1859Unlike with L</croak>, C<pat> is not permitted to be null.
1860
1861=cut
1862*/
8d063cd8 1863
c5be433b 1864#if defined(PERL_IMPLICIT_CONTEXT)
cea2e8a9
GS
1865void
1866Perl_warn_nocontext(const char *pat, ...)
1867{
1868 dTHX;
1869 va_list args;
7918f24d 1870 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
cea2e8a9 1871 va_start(args, pat);
c5be433b 1872 vwarn(pat, &args);
cea2e8a9
GS
1873 va_end(args);
1874}
1875#endif /* PERL_IMPLICIT_CONTEXT */
1876
1877void
1878Perl_warn(pTHX_ const char *pat, ...)
1879{
1880 va_list args;
7918f24d 1881 PERL_ARGS_ASSERT_WARN;
cea2e8a9 1882 va_start(args, pat);
c5be433b 1883 vwarn(pat, &args);
cea2e8a9
GS
1884 va_end(args);
1885}
1886
c5be433b
GS
1887#if defined(PERL_IMPLICIT_CONTEXT)
1888void
1889Perl_warner_nocontext(U32 err, const char *pat, ...)
1890{
27da23d5 1891 dTHX;
c5be433b 1892 va_list args;
7918f24d 1893 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
c5be433b
GS
1894 va_start(args, pat);
1895 vwarner(err, pat, &args);
1896 va_end(args);
1897}
1898#endif /* PERL_IMPLICIT_CONTEXT */
1899
599cee73 1900void
9b387841
NC
1901Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1902{
1903 PERL_ARGS_ASSERT_CK_WARNER_D;
1904
1905 if (Perl_ckwarn_d(aTHX_ err)) {
1906 va_list args;
1907 va_start(args, pat);
1908 vwarner(err, pat, &args);
1909 va_end(args);
1910 }
1911}
1912
1913void
a2a5de95
NC
1914Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1915{
1916 PERL_ARGS_ASSERT_CK_WARNER;
1917
1918 if (Perl_ckwarn(aTHX_ err)) {
1919 va_list args;
1920 va_start(args, pat);
1921 vwarner(err, pat, &args);
1922 va_end(args);
1923 }
1924}
1925
1926void
864dbfa3 1927Perl_warner(pTHX_ U32 err, const char* pat,...)
599cee73
PM
1928{
1929 va_list args;
7918f24d 1930 PERL_ARGS_ASSERT_WARNER;
c5be433b
GS
1931 va_start(args, pat);
1932 vwarner(err, pat, &args);
1933 va_end(args);
1934}
1935
1936void
1937Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1938{
27da23d5 1939 dVAR;
7918f24d 1940 PERL_ARGS_ASSERT_VWARNER;
46b27d2f
LM
1941 if (
1942 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1943 !(PL_in_eval & EVAL_KEEPERR)
1944 ) {
a3b680e6 1945 SV * const msv = vmess(pat, args);
599cee73 1946
594b6fac
LM
1947 if (PL_parser && PL_parser->error_count) {
1948 qerror(msv);
1949 }
1950 else {
1951 invoke_exception_hook(msv, FALSE);
1952 die_unwind(msv);
1953 }
599cee73
PM
1954 }
1955 else {
d13b0d77 1956 Perl_vwarn(aTHX_ pat, args);
599cee73
PM
1957 }
1958}
1959
f54ba1c2
DM
1960/* implements the ckWARN? macros */
1961
1962bool
1963Perl_ckwarn(pTHX_ U32 w)
1964{
ad287e37 1965 /* If lexical warnings have not been set, use $^W. */
3c3f8cd6
AB
1966 if (isLEXWARN_off)
1967 return PL_dowarn & G_WARN_ON;
ad287e37 1968
26c7b074 1969 return ckwarn_common(w);
f54ba1c2
DM
1970}
1971
1972/* implements the ckWARN?_d macro */
1973
1974bool
1975Perl_ckwarn_d(pTHX_ U32 w)
1976{
ad287e37 1977 /* If lexical warnings have not been set then default classes warn. */
3c3f8cd6
AB
1978 if (isLEXWARN_off)
1979 return TRUE;
ad287e37 1980
26c7b074
NC
1981 return ckwarn_common(w);
1982}
1983
1984static bool
1985S_ckwarn_common(pTHX_ U32 w)
1986{
3c3f8cd6
AB
1987 if (PL_curcop->cop_warnings == pWARN_ALL)
1988 return TRUE;
ad287e37
NC
1989
1990 if (PL_curcop->cop_warnings == pWARN_NONE)
1991 return FALSE;
1992
98fe6610
NC
1993 /* Check the assumption that at least the first slot is non-zero. */
1994 assert(unpackWARN1(w));
1995
1996 /* Check the assumption that it is valid to stop as soon as a zero slot is
1997 seen. */
1998 if (!unpackWARN2(w)) {
1999 assert(!unpackWARN3(w));
2000 assert(!unpackWARN4(w));
2001 } else if (!unpackWARN3(w)) {
2002 assert(!unpackWARN4(w));
2003 }
2004
26c7b074
NC
2005 /* Right, dealt with all the special cases, which are implemented as non-
2006 pointers, so there is a pointer to a real warnings mask. */
98fe6610
NC
2007 do {
2008 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2009 return TRUE;
2010 } while (w >>= WARNshift);
2011
2012 return FALSE;
f54ba1c2
DM
2013}
2014
72dc9ed5
NC
2015/* Set buffer=NULL to get a new one. */
2016STRLEN *
8ee4cf24 2017Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
72dc9ed5 2018 STRLEN size) {
5af88345
FC
2019 const MEM_SIZE len_wanted =
2020 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
35da51f7 2021 PERL_UNUSED_CONTEXT;
7918f24d 2022 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
72dc9ed5 2023
10edeb5d
JH
2024 buffer = (STRLEN*)
2025 (specialWARN(buffer) ?
2026 PerlMemShared_malloc(len_wanted) :
2027 PerlMemShared_realloc(buffer, len_wanted));
72dc9ed5
NC
2028 buffer[0] = size;
2029 Copy(bits, (buffer + 1), size, char);
5af88345
FC
2030 if (size < WARNsize)
2031 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
72dc9ed5
NC
2032 return buffer;
2033}
f54ba1c2 2034
e6587932
DM
2035/* since we've already done strlen() for both nam and val
2036 * we can use that info to make things faster than
2037 * sprintf(s, "%s=%s", nam, val)
2038 */
2039#define my_setenv_format(s, nam, nlen, val, vlen) \
2040 Copy(nam, s, nlen, char); \
2041 *(s+nlen) = '='; \
2042 Copy(val, s+(nlen+1), vlen, char); \
2043 *(s+(nlen+1+vlen)) = '\0'
2044
adebb90d
DM
2045
2046
c5d12488 2047#ifdef USE_ENVIRON_ARRAY
de5576aa 2048/* NB: VMS' my_setenv() is in vms.c */
34716e2a 2049
3d50648c
DM
2050/* Configure doesn't test for HAS_SETENV yet, so decide based on platform.
2051 * For Solaris, setenv() and unsetenv() were introduced in Solaris 9, so
2052 * testing for HAS UNSETENV is sufficient.
2053 */
2054# if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2055# define MY_HAS_SETENV
2056# endif
2057
34716e2a
DM
2058/* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2059 * 'current' is non-null, with up to three sizes that are added together.
2060 * It handles integer overflow.
2061 */
3d50648c 2062# ifndef MY_HAS_SETENV
34716e2a
DM
2063static char *
2064S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2065{
2066 void *p;
2067 Size_t sl, l = l1 + l2;
2068
2069 if (l < l2)
2070 goto panic;
2071 l += l3;
2072 if (l < l3)
2073 goto panic;
2074 sl = l * size;
2075 if (sl < l)
2076 goto panic;
2077
2078 p = current
2079 ? safesysrealloc(current, sl)
2080 : safesysmalloc(sl);
2081 if (p)
2082 return (char*)p;
2083
2084 panic:
2085 croak_memory_wrap();
2086}
3d50648c 2087# endif
34716e2a
DM
2088
2089
adebb90d 2090# if !defined(WIN32) && !defined(NETWARE)
34716e2a 2091
8d063cd8 2092void
e1ec3a88 2093Perl_my_setenv(pTHX_ const char *nam, const char *val)
8d063cd8 2094{
27da23d5 2095 dVAR;
adebb90d 2096# ifdef __amigaos4__
6e3136a6 2097 amigaos4_obtain_environ(__FUNCTION__);
adebb90d
DM
2098# endif
2099
2100# ifdef USE_ITHREADS
4efc5df6
GS
2101 /* only parent thread can modify process environment */
2102 if (PL_curinterp == aTHX)
adebb90d 2103# endif
4efc5df6 2104 {
adebb90d
DM
2105
2106# ifndef PERL_USE_SAFE_PUTENV
50acdf95 2107 if (!PL_use_safe_putenv) {
b7d87861 2108 /* most putenv()s leak, so we manipulate environ directly */
34716e2a
DM
2109 UV i;
2110 Size_t vlen, nlen = strlen(nam);
b7d87861
JH
2111
2112 /* where does it go? */
2113 for (i = 0; environ[i]; i++) {
34716e2a 2114 if (strnEQ(environ[i], nam, nlen) && environ[i][nlen] == '=')
b7d87861
JH
2115 break;
2116 }
c5d12488 2117
b7d87861 2118 if (environ == PL_origenviron) { /* need we copy environment? */
34716e2a 2119 UV j, max;
b7d87861
JH
2120 char **tmpenv;
2121
2122 max = i;
2123 while (environ[max])
2124 max++;
adebb90d 2125
34716e2a
DM
2126 /* XXX shouldn't that be max+1 rather than max+2 ??? - DAPM */
2127 tmpenv = (char**)S_env_alloc(NULL, max, 2, 0, sizeof(char*));
adebb90d 2128
b7d87861 2129 for (j=0; j<max; j++) { /* copy environment */
34716e2a
DM
2130 const Size_t len = strlen(environ[j]);
2131 tmpenv[j] = S_env_alloc(NULL, len, 1, 0, 1);
b7d87861
JH
2132 Copy(environ[j], tmpenv[j], len+1, char);
2133 }
adebb90d 2134
b7d87861
JH
2135 tmpenv[max] = NULL;
2136 environ = tmpenv; /* tell exec where it is now */
2137 }
adebb90d 2138
b7d87861
JH
2139 if (!val) {
2140 safesysfree(environ[i]);
2141 while (environ[i]) {
2142 environ[i] = environ[i+1];
2143 i++;
2144 }
adebb90d 2145# ifdef __amigaos4__
6e3136a6 2146 goto my_setenv_out;
adebb90d 2147# else
b7d87861 2148 return;
adebb90d 2149# endif
b7d87861 2150 }
adebb90d 2151
b7d87861 2152 if (!environ[i]) { /* does not exist yet */
34716e2a 2153 environ = (char**)S_env_alloc(environ, i, 2, 0, sizeof(char*));
b7d87861
JH
2154 environ[i+1] = NULL; /* make sure it's null terminated */
2155 }
2156 else
2157 safesysfree(environ[i]);
34716e2a 2158
b7d87861
JH
2159 vlen = strlen(val);
2160
34716e2a 2161 environ[i] = S_env_alloc(NULL, nlen, vlen, 2, 1);
b7d87861
JH
2162 /* all that work just for this */
2163 my_setenv_format(environ[i], nam, nlen, val, vlen);
adebb90d
DM
2164 }
2165 else {
2166
2167# endif /* !PERL_USE_SAFE_PUTENV */
2168
3d50648c 2169# ifdef MY_HAS_SETENV
adebb90d 2170# if defined(HAS_UNSETENV)
88f5bc07
AB
2171 if (val == NULL) {
2172 (void)unsetenv(nam);
2173 } else {
2174 (void)setenv(nam, val, 1);
2175 }
adebb90d 2176# else /* ! HAS_UNSETENV */
88f5bc07 2177 (void)setenv(nam, val, 1);
adebb90d
DM
2178# endif /* HAS_UNSETENV */
2179
2180# elif defined(HAS_UNSETENV)
2181
88f5bc07 2182 if (val == NULL) {
ba88ff58
MJ
2183 if (environ) /* old glibc can crash with null environ */
2184 (void)unsetenv(nam);
88f5bc07 2185 } else {
34716e2a
DM
2186 const Size_t nlen = strlen(nam);
2187 const Size_t vlen = strlen(val);
2188 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
88f5bc07
AB
2189 my_setenv_format(new_env, nam, nlen, val, vlen);
2190 (void)putenv(new_env);
2191 }
adebb90d
DM
2192
2193# else /* ! HAS_UNSETENV */
2194
88f5bc07 2195 char *new_env;
34716e2a
DM
2196 const Size_t nlen = strlen(nam);
2197 Size_t vlen;
88f5bc07
AB
2198 if (!val) {
2199 val = "";
2200 }
2201 vlen = strlen(val);
34716e2a 2202 new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
88f5bc07
AB
2203 /* all that work just for this */
2204 my_setenv_format(new_env, nam, nlen, val, vlen);
2205 (void)putenv(new_env);
adebb90d 2206
3d50648c 2207# endif /* MY_HAS_SETENV */
adebb90d
DM
2208
2209# ifndef PERL_USE_SAFE_PUTENV
50acdf95 2210 }
adebb90d 2211# endif
4efc5df6 2212 }
adebb90d
DM
2213
2214# ifdef __amigaos4__
6e3136a6
AB
2215my_setenv_out:
2216 amigaos4_release_environ(__FUNCTION__);
adebb90d 2217# endif
8d063cd8
LW
2218}
2219
adebb90d 2220# else /* WIN32 || NETWARE */
68dc0745
PP
2221
2222void
72229eff 2223Perl_my_setenv(pTHX_ const char *nam, const char *val)
68dc0745 2224{
27da23d5 2225 dVAR;
eb578fdb 2226 char *envstr;
34716e2a
DM
2227 const Size_t nlen = strlen(nam);
2228 Size_t vlen;
e6587932 2229
c5d12488
JH
2230 if (!val) {
2231 val = "";
ac5c734f 2232 }
c5d12488 2233 vlen = strlen(val);
34716e2a 2234 envstr = S_env_alloc(NULL, nlen, vlen, 2, 1);
c5d12488
JH
2235 my_setenv_format(envstr, nam, nlen, val, vlen);
2236 (void)PerlEnv_putenv(envstr);
2237 Safefree(envstr);
3e3baf6d
TB
2238}
2239
adebb90d
DM
2240# endif /* WIN32 || NETWARE */
2241
2242#endif /* USE_ENVIRON_ARRAY */
2243
2244
3e3baf6d 2245
378cc40b 2246
16d20bd9 2247#ifdef UNLINK_ALL_VERSIONS
79072805 2248I32
6e732051 2249Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
378cc40b 2250{
35da51f7 2251 I32 retries = 0;
378cc40b 2252
7918f24d
NC
2253 PERL_ARGS_ASSERT_UNLNK;
2254
35da51f7
AL
2255 while (PerlLIO_unlink(f) >= 0)
2256 retries++;
2257 return retries ? 0 : -1;
378cc40b
LW
2258}
2259#endif
2260
4a7d1889 2261PerlIO *
c9289b7b 2262Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
4a7d1889 2263{
f6fb4e44 2264#if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
1f852d0d 2265 int p[2];
eb578fdb
KW
2266 I32 This, that;
2267 Pid_t pid;
1f852d0d
NIS
2268 SV *sv;
2269 I32 did_pipes = 0;
2270 int pp[2];
2271
7918f24d
NC
2272 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2273
1f852d0d
NIS
2274 PERL_FLUSHALL_FOR_CHILD;
2275 This = (*mode == 'w');
2276 that = !This;
284167a5 2277 if (TAINTING_get) {
1f852d0d
NIS
2278 taint_env();
2279 taint_proper("Insecure %s%s", "EXEC");
2280 }
884fc2d3 2281 if (PerlProc_pipe_cloexec(p) < 0)
4608196e 2282 return NULL;
1f852d0d 2283 /* Try for another pipe pair for error return */
74df577f 2284 if (PerlProc_pipe_cloexec(pp) >= 0)
1f852d0d 2285 did_pipes = 1;
52e18b1f 2286 while ((pid = PerlProc_fork()) < 0) {
1f852d0d
NIS
2287 if (errno != EAGAIN) {
2288 PerlLIO_close(p[This]);
4e6dfe71 2289 PerlLIO_close(p[that]);
1f852d0d
NIS
2290 if (did_pipes) {
2291 PerlLIO_close(pp[0]);
2292 PerlLIO_close(pp[1]);
2293 }
4608196e 2294 return NULL;
1f852d0d 2295 }
a2a5de95 2296 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
1f852d0d
NIS
2297 sleep(5);
2298 }
2299 if (pid == 0) {
2300 /* Child */
1f852d0d
NIS
2301#undef THIS
2302#undef THAT
2303#define THIS that
2304#define THAT This
1f852d0d 2305 /* Close parent's end of error status pipe (if any) */
74df577f 2306 if (did_pipes)
1f852d0d 2307 PerlLIO_close(pp[0]);
1f852d0d
NIS
2308 /* Now dup our end of _the_ pipe to right position */
2309 if (p[THIS] != (*mode == 'r')) {
2310 PerlLIO_dup2(p[THIS], *mode == 'r');
2311 PerlLIO_close(p[THIS]);
4e6dfe71
GS
2312 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2313 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
1f852d0d 2314 }
30c869b8
LT
2315 else {
2316 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
4e6dfe71 2317 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
30c869b8 2318 }
1f852d0d
NIS
2319#if !defined(HAS_FCNTL) || !defined(F_SETFD)
2320 /* No automatic close - do it by hand */
b7953727
JH
2321# ifndef NOFILE
2322# define NOFILE 20
2323# endif
a080fe3d
NIS
2324 {
2325 int fd;
2326
2327 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
3aed30dc 2328 if (fd != pp[1])
a080fe3d
NIS
2329 PerlLIO_close(fd);
2330 }
1f852d0d
NIS
2331 }
2332#endif
a0714e2c 2333 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
1f852d0d
NIS
2334 PerlProc__exit(1);
2335#undef THIS
2336#undef THAT
2337 }
2338 /* Parent */
1f852d0d
NIS
2339 if (did_pipes)
2340 PerlLIO_close(pp[1]);
2341 /* Keep the lower of the two fd numbers */
2342 if (p[that] < p[This]) {
884fc2d3 2343 PerlLIO_dup2_cloexec(p[This], p[that]);
1f852d0d
NIS
2344 PerlLIO_close(p[This]);
2345 p[This] = p[that];
2346 }
4e6dfe71
GS
2347 else
2348 PerlLIO_close(p[that]); /* close child's end of pipe */
2349
1f852d0d 2350 sv = *av_fetch(PL_fdpid,p[This],TRUE);
862a34c6 2351 SvUPGRADE(sv,SVt_IV);
45977657 2352 SvIV_set(sv, pid);
1f852d0d
NIS
2353 PL_forkprocess = pid;
2354 /* If we managed to get status pipe check for exec fail */
2355 if (did_pipes && pid > 0) {
2356 int errkid;
bb7a0f54 2357 unsigned n = 0;
1f852d0d
NIS
2358
2359 while (n < sizeof(int)) {
19742f39 2360 const SSize_t n1 = PerlLIO_read(pp[0],
1f852d0d
NIS
2361 (void*)(((char*)&errkid)+n),
2362 (sizeof(int)) - n);
2363 if (n1 <= 0)
2364 break;
2365 n += n1;
2366 }
2367 PerlLIO_close(pp[0]);
2368 did_pipes = 0;
2369 if (n) { /* Error */
2370 int pid2, status;
8c51524e 2371 PerlLIO_close(p[This]);
1f852d0d 2372 if (n != sizeof(int))
5637ef5b 2373 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
1f852d0d
NIS
2374 do {
2375 pid2 = wait4pid(pid, &status, 0);
2376 } while (pid2 == -1 && errno == EINTR);
2377 errno = errkid; /* Propagate errno from kid */
4608196e 2378 return NULL;
1f852d0d
NIS
2379 }
2380 }
2381 if (did_pipes)
2382 PerlLIO_close(pp[0]);
2383 return PerlIO_fdopen(p[This], mode);
2384#else
8492b23f 2385# if defined(OS2) /* Same, without fork()ing and all extra overhead... */
4e205ed6 2386 return my_syspopen4(aTHX_ NULL, mode, n, args);
8492b23f
TC
2387# elif defined(WIN32)
2388 return win32_popenlist(mode, n, args);
9d419b5f 2389# else
4a7d1889
NIS
2390 Perl_croak(aTHX_ "List form of piped open not implemented");
2391 return (PerlIO *) NULL;
9d419b5f 2392# endif
1f852d0d 2393#endif
4a7d1889
NIS
2394}
2395
4dd5370d
AB
2396 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2397#if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
760ac839 2398PerlIO *
3dd43144 2399Perl_my_popen(pTHX_ const char *cmd, const char *mode)
a687059c
LW
2400{
2401 int p[2];
eb578fdb
KW
2402 I32 This, that;
2403 Pid_t pid;
79072805 2404 SV *sv;
bfce84ec 2405 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
e446cec8
IZ
2406 I32 did_pipes = 0;
2407 int pp[2];
a687059c 2408
7918f24d
NC
2409 PERL_ARGS_ASSERT_MY_POPEN;
2410
45bc9206 2411 PERL_FLUSHALL_FOR_CHILD;
ddcf38b7
IZ
2412#ifdef OS2
2413 if (doexec) {
23da6c43 2414 return my_syspopen(aTHX_ cmd,mode);
ddcf38b7 2415 }
a1d180c4 2416#endif
8ac85365
NIS
2417 This = (*mode == 'w');
2418 that = !This;
284167a5 2419 if (doexec && TAINTING_get) {
bbce6d69
PP
2420 taint_env();
2421 taint_proper("Insecure %s%s", "EXEC");
d48672a2 2422 }
884fc2d3 2423 if (PerlProc_pipe_cloexec(p) < 0)
4608196e 2424 return NULL;
74df577f 2425 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
e446cec8 2426 did_pipes = 1;
52e18b1f 2427 while ((pid = PerlProc_fork()) < 0) {
a687059c 2428 if (errno != EAGAIN) {
6ad3d225 2429 PerlLIO_close(p[This]);
b5ac89c3 2430 PerlLIO_close(p[that]);
e446cec8
IZ
2431 if (did_pipes) {
2432 PerlLIO_close(pp[0]);
2433 PerlLIO_close(pp[1]);
2434 }
a687059c 2435 if (!doexec)
b3647a36 2436 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
4608196e 2437 return NULL;
a687059c 2438 }
a2a5de95 2439 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
a687059c
LW
2440 sleep(5);
2441 }
2442 if (pid == 0) {
79072805 2443
30ac6d9b
GS
2444#undef THIS
2445#undef THAT
a687059c 2446#define THIS that
8ac85365 2447#define THAT This
74df577f 2448 if (did_pipes)
e446cec8 2449 PerlLIO_close(pp[0]);
a687059c 2450 if (p[THIS] != (*mode == 'r')) {
6ad3d225
GS
2451 PerlLIO_dup2(p[THIS], *mode == 'r');
2452 PerlLIO_close(p[THIS]);
b5ac89c3
NIS
2453 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2454 PerlLIO_close(p[THAT]);
a687059c 2455 }
c6fe5b98
LT
2456 else {
2457 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
b5ac89c3 2458 PerlLIO_close(p[THAT]);
c6fe5b98 2459 }
4435c477 2460#ifndef OS2
a687059c 2461 if (doexec) {
a0d0e21e 2462#if !defined(HAS_FCNTL) || !defined(F_SETFD)
ae986130
LW
2463#ifndef NOFILE
2464#define NOFILE 20
2465#endif
a080fe3d 2466 {
3aed30dc 2467 int fd;
a080fe3d
NIS
2468
2469 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2470 if (fd != pp[1])
3aed30dc 2471 PerlLIO_close(fd);
a080fe3d 2472 }
ae986130 2473#endif
a080fe3d
NIS
2474 /* may or may not use the shell */
2475 do_exec3(cmd, pp[1], did_pipes);
6ad3d225 2476 PerlProc__exit(1);
a687059c 2477 }
4435c477 2478#endif /* defined OS2 */
713cef20
IZ
2479
2480#ifdef PERLIO_USING_CRLF
2481 /* Since we circumvent IO layers when we manipulate low-level
2482 filedescriptors directly, need to manually switch to the
2483 default, binary, low-level mode; see PerlIOBuf_open(). */
2484 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2485#endif
3280af22 2486 PL_forkprocess = 0;
ca0c25f6 2487#ifdef PERL_USES_PL_PIDSTATUS
3280af22 2488 hv_clear(PL_pidstatus); /* we have no children */
ca0c25f6 2489#endif
4608196e 2490 return NULL;
a687059c
LW
2491#undef THIS
2492#undef THAT
2493 }
e446cec8
IZ
2494 if (did_pipes)
2495 PerlLIO_close(pp[1]);
8ac85365 2496 if (p[that] < p[This]) {
884fc2d3 2497 PerlLIO_dup2_cloexec(p[This], p[that]);
6ad3d225 2498 PerlLIO_close(p[This]);
8ac85365 2499 p[This] = p[that];
62b28dd9 2500 }
b5ac89c3
NIS
2501 else
2502 PerlLIO_close(p[that]);
2503
3280af22 2504 sv = *av_fetch(PL_fdpid,p[This],TRUE);
862a34c6 2505 SvUPGRADE(sv,SVt_IV);
45977657 2506 SvIV_set(sv, pid);
3280af22 2507 PL_forkprocess = pid;
e446cec8
IZ
2508 if (did_pipes && pid > 0) {
2509 int errkid;
bb7a0f54 2510 unsigned n = 0;
e446cec8
IZ
2511
2512 while (n < sizeof(int)) {
19742f39 2513 const SSize_t n1 = PerlLIO_read(pp[0],
e446cec8
IZ
2514 (void*)(((char*)&errkid)+n),
2515 (sizeof(int)) - n);
2516 if (n1 <= 0)
2517 break;
2518 n += n1;
2519 }
2f96c702
IZ
2520 PerlLIO_close(pp[0]);
2521 did_pipes = 0;
e446cec8 2522 if (n) { /* Error */
faa466a7 2523 int pid2, status;
8c51524e 2524 PerlLIO_close(p[This]);
e446cec8 2525 if (n != sizeof(int))
5637ef5b 2526 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
faa466a7
RG
2527 do {
2528 pid2 = wait4pid(pid, &status, 0);
2529 } while (pid2 == -1 && errno == EINTR);
e446cec8 2530 errno = errkid; /* Propagate errno from kid */
4608196e 2531 return NULL;
e446cec8
IZ
2532 }
2533 }
2534 if (did_pipes)
2535 PerlLIO_close(pp[0]);
8ac85365 2536 return PerlIO_fdopen(p[This], mode);
a687059c 2537}
8ad758c7 2538#elif defined(DJGPP)
2b96b0a5
JH
2539FILE *djgpp_popen();
2540PerlIO *
cef6ea9d 2541Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2b96b0a5
JH
2542{
2543 PERL_FLUSHALL_FOR_CHILD;
2544 /* Call system's popen() to get a FILE *, then import it.
2545 used 0 for 2nd parameter to PerlIO_importFILE;
2546 apparently not used
2547 */
2548 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2549}
8ad758c7 2550#elif defined(__LIBCATAMOUNT__)
9c12f1e5
RGS
2551PerlIO *
2552Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2553{
2554 return NULL;
2555}
7c0587c8
LW
2556
2557#endif /* !DOSISH */
a687059c 2558
52e18b1f
GS
2559/* this is called in parent before the fork() */
2560void
2561Perl_atfork_lock(void)
80b94025
JH
2562#if defined(USE_ITHREADS)
2563# ifdef USE_PERLIO
2564 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2565# endif
2566# ifdef MYMALLOC
2567 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2568# endif
2569 PERL_TSA_ACQUIRE(PL_op_mutex)
2570#endif
52e18b1f 2571{
3db8f154 2572#if defined(USE_ITHREADS)
20b7effb 2573 dVAR;
52e18b1f 2574 /* locks must be held in locking order (if any) */
4da80956
P
2575# ifdef USE_PERLIO
2576 MUTEX_LOCK(&PL_perlio_mutex);
2577# endif
52e18b1f
GS
2578# ifdef MYMALLOC
2579 MUTEX_LOCK(&PL_malloc_mutex);
2580# endif
2581 OP_REFCNT_LOCK;
2582#endif
2583}
2584
2585/* this is called in both parent and child after the fork() */
2586void
2587Perl_atfork_unlock(void)
80b94025
JH
2588#if defined(USE_ITHREADS)
2589# ifdef USE_PERLIO
2590 PERL_TSA_RELEASE(PL_perlio_mutex)
2591# endif
2592# ifdef MYMALLOC
2593 PERL_TSA_RELEASE(PL_malloc_mutex)
2594# endif
2595 PERL_TSA_RELEASE(PL_op_mutex)
2596#endif
52e18b1f 2597{
3db8f154 2598#if defined(USE_ITHREADS)
20b7effb 2599 dVAR;
52e18b1f 2600 /* locks must be released in same order as in atfork_lock() */
4da80956
P
2601# ifdef USE_PERLIO
2602 MUTEX_UNLOCK(&PL_perlio_mutex);
2603# endif
52e18b1f
GS
2604# ifdef MYMALLOC
2605 MUTEX_UNLOCK(&PL_malloc_mutex);
2606# endif
2607 OP_REFCNT_UNLOCK;
2608#endif
2609}
2610
2611Pid_t
2612Perl_my_fork(void)
2613{
2614#if defined(HAS_FORK)
2615 Pid_t pid;
3db8f154 2616#if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
52e18b1f
GS
2617 atfork_lock();
2618 pid = fork();
2619 atfork_unlock();
2620#else
2621 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2622 * handlers elsewhere in the code */
2623 pid = fork();
2624#endif
2625 return pid;
40262ff4
AB
2626#elif defined(__amigaos4__)
2627 return amigaos_fork();
52e18b1f
GS
2628#else
2629 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2630 Perl_croak_nocontext("fork() not available");
b961a566 2631 return 0;
52e18b1f
GS
2632#endif /* HAS_FORK */
2633}
2634
fe14fcc3 2635#ifndef HAS_DUP2
fec02dd3 2636int
ba106d47 2637dup2(int oldfd, int newfd)
a687059c 2638{
a0d0e21e 2639#if defined(HAS_FCNTL) && defined(F_DUPFD)
fec02dd3
AD
2640 if (oldfd == newfd)
2641 return oldfd;
6ad3d225 2642 PerlLIO_close(newfd);
fec02dd3 2643 return fcntl(oldfd, F_DUPFD, newfd);
62b28dd9 2644#else
fc36a67e
PP
2645#define DUP2_MAX_FDS 256
2646 int fdtmp[DUP2_MAX_FDS];
79072805 2647 I32 fdx = 0;
ae986130
LW
2648 int fd;
2649
fe14fcc3 2650 if (oldfd == newfd)
fec02dd3 2651 return oldfd;
6ad3d225 2652 PerlLIO_close(newfd);
fc36a67e 2653 /* good enough for low fd's... */
6ad3d225 2654 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
fc36a67e 2655 if (fdx >= DUP2_MAX_FDS) {
6ad3d225 2656 PerlLIO_close(fd);
fc36a67e
PP
2657 fd = -1;
2658 break;
2659 }
ae986130 2660 fdtmp[fdx++] = fd;
fc36a67e 2661 }
ae986130 2662 while (fdx > 0)
6ad3d225 2663 PerlLIO_close(fdtmp[--fdx]);
fec02dd3 2664 return fd;
62b28dd9 2665#endif
a687059c
LW
2666}
2667#endif
2668
64ca3a65 2669#ifndef PERL_MICRO
ff68c719
PP
2670#ifdef HAS_SIGACTION
2671
2672Sighandler_t
864dbfa3 2673Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
ff68c719
PP
2674{
2675 struct sigaction act, oact;
2676
a10b1e10 2677#ifdef USE_ITHREADS
20b7effb 2678 dVAR;
a10b1e10
JH
2679 /* only "parent" interpreter can diddle signals */
2680 if (PL_curinterp != aTHX)
8aad04aa 2681 return (Sighandler_t) SIG_ERR;
a10b1e10
JH
2682#endif
2683
8aad04aa 2684 act.sa_handler = (void(*)(int))handler;
ff68c719
PP
2685 sigemptyset(&act.sa_mask);
2686 act.sa_flags = 0;
2687#ifdef SA_RESTART
4ffa73a3
JH
2688 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2689 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
0a8e0eff 2690#endif
358837b8 2691#if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
8aad04aa 2692 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
85264bed
CS
2693 act.sa_flags |= SA_NOCLDWAIT;
2694#endif
ff68c719 2695 if (sigaction(signo, &act, &oact) == -1)
8aad04aa 2696 return (Sighandler_t) SIG_ERR;
ff68c719 2697 else
8aad04aa 2698 return (Sighandler_t) oact.sa_handler;
ff68c719
PP
2699}
2700
2701Sighandler_t
864dbfa3 2702Perl_rsignal_state(pTHX_ int signo)
ff68c719
PP
2703{
2704 struct sigaction oact;
96a5add6 2705 PERL_UNUSED_CONTEXT;
ff68c719
PP
2706
2707 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
8aad04aa 2708 return (Sighandler_t) SIG_ERR;
ff68c719 2709 else
8aad04aa 2710 return (Sighandler_t) oact.sa_handler;
ff68c719
PP
2711}
2712
2713int
864dbfa3 2714Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
ff68c719 2715{
20b7effb 2716#ifdef USE_ITHREADS
27da23d5 2717 dVAR;
20b7effb 2718#endif
ff68c719
PP
2719 struct sigaction act;
2720
7918f24d
NC
2721 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2722
a10b1e10
JH
2723#ifdef USE_ITHREADS
2724 /* only "parent" interpreter can diddle signals */
2725 if (PL_curinterp != aTHX)
2726 return -1;
2727#endif
2728
8aad04aa 2729 act.sa_handler = (void(*)(int))handler;
ff68c719
PP
2730 sigemptyset(&act.sa_mask);
2731 act.sa_flags = 0;
2732#ifdef SA_RESTART
4ffa73a3
JH
2733 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2734 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
0a8e0eff 2735#endif
36b5d377 2736#if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
8aad04aa 2737 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
85264bed
CS
2738 act.sa_flags |= SA_NOCLDWAIT;
2739#endif
ff68c719
PP
2740 return sigaction(signo, &act, save);
2741}
2742
2743int
864dbfa3 2744Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
ff68c719 2745{
20b7effb 2746#ifdef USE_ITHREADS
27da23d5 2747 dVAR;
20b7effb
JH
2748#endif
2749 PERL_UNUSED_CONTEXT;
a10b1e10
JH
2750#ifdef USE_ITHREADS
2751 /* only "parent" interpreter can diddle signals */
2752 if (PL_curinterp != aTHX)
2753 return -1;
2754#endif
2755
ff68c719
PP
2756 return sigaction(signo, save, (struct sigaction *)NULL);
2757}
2758
2759#else /* !HAS_SIGACTION */
2760
2761Sighandler_t
864dbfa3 2762Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
ff68c719 2763{
39f1703b 2764#if defined(USE_ITHREADS) && !defined(WIN32)
a10b1e10
JH
2765 /* only "parent" interpreter can diddle signals */
2766 if (PL_curinterp != aTHX)
8aad04aa 2767 return (Sighandler_t) SIG_ERR;
a10b1e10
JH
2768#endif
2769
6ad3d225 2770 return PerlProc_signal(signo, handler);
ff68c719
PP
2771}
2772
fabdb6c0 2773static Signal_t
4e35701f 2774sig_trap(int signo)
ff68c719 2775{
27da23d5
JH
2776 dVAR;
2777 PL_sig_trapped++;
ff68c719
PP
2778}
2779
2780Sighandler_t
864dbfa3 2781Perl_rsignal_state(pTHX_ int signo)
ff68c719 2782{
27da23d5 2783 dVAR;
ff68c719
PP
2784 Sighandler_t oldsig;
2785
39f1703b 2786#if defined(USE_ITHREADS) && !defined(WIN32)
a10b1e10
JH
2787 /* only "parent" interpreter can diddle signals */
2788 if (PL_curinterp != aTHX)
8aad04aa 2789 return (Sighandler_t) SIG_ERR;
a10b1e10
JH
2790#endif
2791
27da23d5 2792 PL_sig_trapped = 0;
6ad3d225
GS
2793 oldsig = PerlProc_signal(signo, sig_trap);
2794 PerlProc_signal(signo, oldsig);
27da23d5 2795 if (PL_sig_trapped)
3aed30dc 2796 PerlProc_kill(PerlProc_getpid(), signo);
ff68c719
PP
2797 return oldsig;
2798}
2799
2800int
864dbfa3 2801Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
ff68c719 2802{
39f1703b 2803#if defined(USE_ITHREADS) && !defined(WIN32)
a10b1e10
JH
2804 /* only "parent" interpreter can diddle signals */
2805 if (PL_curinterp != aTHX)
2806 return -1;
2807#endif
6ad3d225 2808 *save = PerlProc_signal(signo, handler);
8aad04aa 2809 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
ff68c719
PP
2810}
2811
2812int
864dbfa3 2813Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
ff68c719 2814{
39f1703b 2815#if defined(USE_ITHREADS) && !defined(WIN32)
a10b1e10
JH
2816 /* only "parent" interpreter can diddle signals */
2817 if (PL_curinterp != aTHX)
2818 return -1;
2819#endif
8aad04aa 2820 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
ff68c719
PP
2821}
2822
2823#endif /* !HAS_SIGACTION */
64ca3a65 2824#endif /* !PERL_MICRO */
ff68c719 2825
5f05dabc 2826 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
53f73940 2827#if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
79072805 2828I32
864dbfa3 2829Perl_my_pclose(pTHX_ PerlIO *ptr)
a687059c 2830{
a687059c 2831 int status;
a0d0e21e 2832 SV **svp;
d8a83dd3 2833 Pid_t pid;
2e0cfa16 2834 Pid_t pid2 = 0;
03136e13 2835 bool close_failed;
4ee39169 2836 dSAVEDERRNO;
2e0cfa16 2837 const int fd = PerlIO_fileno(ptr);
e9d373c4
TC
2838 bool should_wait;
2839
2840 svp = av_fetch(PL_fdpid,fd,TRUE);
2841 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2842 SvREFCNT_dec(*svp);
2843 *svp = NULL;
2e0cfa16 2844
97cb92d6 2845#if defined(USE_PERLIO)
2e0cfa16
FC
2846 /* Find out whether the refcount is low enough for us to wait for the
2847 child proc without blocking. */
e9d373c4 2848 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
b6ae43b7 2849#else
e9d373c4 2850 should_wait = pid > 0;
b6ae43b7 2851#endif
a687059c 2852
ddcf38b7
IZ
2853#ifdef OS2
2854 if (pid == -1) { /* Opened by popen. */
2855 return my_syspclose(ptr);
2856 }
a1d180c4 2857#endif
f1618b10
CS
2858 close_failed = (PerlIO_close(ptr) == EOF);
2859 SAVE_ERRNO;
2e0cfa16 2860 if (should_wait) do {
1d3434b8
GS
2861 pid2 = wait4pid(pid, &status, 0);
2862 } while (pid2 == -1 && errno == EINTR);
03136e13 2863 if (close_failed) {
4ee39169 2864 RESTORE_ERRNO;
03136e13
CS
2865 return -1;
2866 }
2e0cfa16
FC
2867 return(
2868 should_wait
2869 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2870 : 0
2871 );
20188a90 2872}
8ad758c7 2873#elif defined(__LIBCATAMOUNT__)
9c12f1e5
RGS
2874I32
2875Perl_my_pclose(pTHX_ PerlIO *ptr)
2876{
2877 return -1;
2878}
4633a7c4
LW
2879#endif /* !DOSISH */
2880
e37778c2 2881#if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
79072805 2882I32
d8a83dd3 2883Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
20188a90 2884{
27da23d5 2885 I32 result = 0;
7918f24d 2886 PERL_ARGS_ASSERT_WAIT4PID;
ca0c25f6 2887#ifdef PERL_USES_PL_PIDSTATUS
d4c02743
TC
2888 if (!pid) {
2889 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2890 waitpid() nor wait4() is available, or on OS/2, which
2891 doesn't appear to support waiting for a progress group
2892 member, so we can only treat a 0 pid as an unknown child.
2893 */
2894 errno = ECHILD;
2895 return -1;
2896 }
b7953727 2897 {
3aed30dc 2898 if (pid > 0) {
12072db5
NC
2899 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2900 pid, rather than a string form. */
c4420975 2901 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3aed30dc
HS
2902 if (svp && *svp != &PL_sv_undef) {
2903 *statusp = SvIVX(*svp);
12072db5
NC
2904 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2905 G_DISCARD);
3aed30dc
HS
2906 return pid;
2907 }
2908 }
2909 else {
2910 HE *entry;
2911
2912 hv_iterinit(PL_pidstatus);
2913 if ((entry = hv_iternext(PL_pidstatus))) {
c4420975 2914 SV * const sv = hv_iterval(PL_pidstatus,entry);
7ea75b61 2915 I32 len;
0bcc34c2 2916 const char * const spid = hv_iterkey(entry,&len);
27da23d5 2917
12072db5
NC
2918 assert (len == sizeof(Pid_t));
2919 memcpy((char *)&pid, spid, len);
3aed30dc 2920 *statusp = SvIVX(sv);
7b9a3241
NC
2921 /* The hash iterator is currently on this entry, so simply
2922 calling hv_delete would trigger the lazy delete, which on
f6bab5f6 2923 aggregate does more work, because next call to hv_iterinit()
7b9a3241
NC
2924 would spot the flag, and have to call the delete routine,
2925 while in the meantime any new entries can't re-use that
2926 memory. */
2927 hv_iterinit(PL_pidstatus);
7ea75b61 2928 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3aed30dc
HS
2929 return pid;
2930 }
20188a90
LW
2931 }
2932 }
68a29c53 2933#endif
79072805 2934#ifdef HAS_WAITPID
367f3c24
IZ
2935# ifdef HAS_WAITPID_RUNTIME
2936 if (!HAS_WAITPID_RUNTIME)
2937 goto hard_way;
2938# endif
cddd4526 2939 result = PerlProc_waitpid(pid,statusp,flags);
dfcfdb64 2940 goto finish;
367f3c24
IZ
2941#endif
2942#if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
d4c02743 2943 result = wait4(pid,statusp,flags,NULL);
dfcfdb64 2944 goto finish;
367f3c24 2945#endif
ca0c25f6 2946#ifdef PERL_USES_PL_PIDSTATUS
27da23d5 2947#if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
367f3c24 2948 hard_way:
27da23d5 2949#endif
a0d0e21e 2950 {
a0d0e21e 2951 if (flags)
cea2e8a9 2952 Perl_croak(aTHX_ "Can't do waitpid with flags");
a0d0e21e 2953 else {
76e3520e 2954 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
a0d0e21e
LW
2955 pidgone(result,*statusp);
2956 if (result < 0)
2957 *statusp = -1;
2958 }
a687059c
LW
2959 }
2960#endif
27da23d5 2961#if defined(HAS_WAITPID) || defined(HAS_WAIT4)
dfcfdb64 2962 finish:
27da23d5 2963#endif
cddd4526
NIS
2964 if (result < 0 && errno == EINTR) {
2965 PERL_ASYNC_CHECK();
48dbb59e 2966 errno = EINTR; /* reset in case a signal handler changed $! */
cddd4526
NIS
2967 }
2968 return result;
a687059c 2969}
2986a63f 2970#endif /* !DOSISH || OS2 || WIN32 || NETWARE */
a687059c 2971
ca0c25f6 2972#ifdef PERL_USES_PL_PIDSTATUS
7c0587c8 2973void
ed4173ef 2974S_pidgone(pTHX_ Pid_t pid, int status)
a687059c 2975{
eb578fdb 2976 SV *sv;
a687059c 2977
12072db5 2978 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
862a34c6 2979 SvUPGRADE(sv,SVt_IV);
45977657 2980 SvIV_set(sv, status);
20188a90 2981 return;
a687059c 2982}
ca0c25f6 2983#endif
a687059c 2984
6de23f80 2985#if defined(OS2)
7c0587c8 2986int pclose();
ddcf38b7
IZ
2987#ifdef HAS_FORK
2988int /* Cannot prototype with I32
2989 in os2ish.h. */
ba106d47 2990my_syspclose(PerlIO *ptr)
ddcf38b7 2991#else
79072805 2992I32
864dbfa3 2993Perl_my_pclose(pTHX_ PerlIO *ptr)
a1d180c4 2994#endif
a687059c 2995{
760ac839 2996 /* Needs work for PerlIO ! */
c4420975 2997 FILE * const f = PerlIO_findFILE(ptr);
7452cf6a 2998 const I32 result = pclose(f);
2b96b0a5
JH
2999 PerlIO_releaseFILE(ptr,f);
3000 return result;
3001}
3002#endif
3003
933fea7f 3004#if defined(DJGPP)
2b96b0a5
JH
3005int djgpp_pclose();
3006I32
3007Perl_my_pclose(pTHX_ PerlIO *ptr)
3008{
3009 /* Needs work for PerlIO ! */
c4420975 3010 FILE * const f = PerlIO_findFILE(ptr);
2b96b0a5 3011 I32 result = djgpp_pclose(f);
933fea7f 3012 result = (result << 8) & 0xff00;
760ac839
LW
3013 PerlIO_releaseFILE(ptr,f);
3014 return result;
a687059c 3015}
7c0587c8 3016#endif
9f68db38 3017
16fa5c11 3018#define PERL_REPEATCPY_LINEAR 4
9f68db38 3019void
5aaab254 3020Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
9f68db38 3021{
7918f24d
NC
3022 PERL_ARGS_ASSERT_REPEATCPY;
3023
223f01db
KW
3024 assert(len >= 0);
3025
2709980d 3026 if (count < 0)
d1decf2b 3027 croak_memory_wrap();
2709980d 3028
16fa5c11
VP
3029 if (len == 1)
3030 memset(to, *from, count);
3031 else if (count) {
eb578fdb 3032 char *p = to;
26e1303d 3033 IV items, linear, half;
16fa5c11
VP
3034
3035 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3036 for (items = 0; items < linear; ++items) {
eb578fdb 3037 const char *q = from;
26e1303d 3038 IV todo;
16fa5c11
VP
3039 for (todo = len; todo > 0; todo--)
3040 *p++ = *q++;
3041 }
3042
3043 half = count / 2;
3044 while (items <= half) {
26e1303d 3045 IV size = items * len;
16fa5c11
VP
3046 memcpy(p, to, size);
3047 p += size;
3048 items *= 2;
9f68db38 3049 }
16fa5c11
VP
3050
3051 if (count > items)
3052 memcpy(p, to, (count - items) * len);
9f68db38
LW
3053 }
3054}
0f85fab0 3055
fe14fcc3 3056#ifndef HAS_RENAME
79072805 3057I32
4373e329 3058Perl_same_dirent(pTHX_ const char *a, const char *b)
62b28dd9 3059{
93a17b20
LW
3060 char *fa = strrchr(a,'/');
3061 char *fb = strrchr(b,'/');
c623ac67
GS
3062 Stat_t tmpstatbuf1;
3063 Stat_t tmpstatbuf2;
c4420975 3064 SV * const tmpsv = sv_newmortal();
62b28dd9 3065
7918f24d
NC
3066 PERL_ARGS_ASSERT_SAME_DIRENT;
3067
62b28dd9
LW
3068 if (fa)
3069 fa++;
3070 else
3071 fa = a;
3072 if (fb)
3073 fb++;
3074 else
3075 fb = b;
3076 if (strNE(a,b))
3077 return FALSE;
3078 if (fa == a)
76f68e9b 3079 sv_setpvs(tmpsv, ".");
62b28dd9 3080 else
46fc3d4c 3081 sv_setpvn(tmpsv, a, fa - a);
95a20fc0 3082 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
62b28dd9
LW
3083 return FALSE;
3084 if (fb == b)
76f68e9b 3085 sv_setpvs(tmpsv, ".");
62b28dd9 3086 else
46fc3d4c 3087 sv_setpvn(tmpsv, b, fb - b);
95a20fc0 3088 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
62b28dd9
LW
3089 return FALSE;
3090 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3091 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3092}
fe14fcc3
LW
3093#endif /* !HAS_RENAME */
3094
491527d0 3095char*
7f315aed
NC
3096Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3097 const char *const *const search_ext, I32 flags)
491527d0 3098{
bd61b366
SS
3099 const char *xfound = NULL;
3100 char *xfailed = NULL;
0f31cffe 3101 char tmpbuf[MAXPATHLEN];
eb578fdb 3102 char *s;
5f74f29c 3103 I32 len = 0;
491527d0 3104 int retval;
39a02377 3105 char *bufend;
7c458fae 3106#if defined(DOSISH) && !defined(OS2)
491527d0
GS
3107# define SEARCH_EXTS ".bat", ".cmd", NULL
3108# define MAX_EXT_LEN 4
3109#endif
3110#ifdef OS2
3111# define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3112# define MAX_EXT_LEN 4
3113#endif
3114#ifdef VMS
3115# define SEARCH_EXTS ".pl", ".com", NULL
3116# define MAX_EXT_LEN 4
3117#endif
3118 /* additional extensions to try in each dir if scriptname not found */
3119#ifdef SEARCH_EXTS
0bcc34c2 3120 static const char *const exts[] = { SEARCH_EXTS };
7f315aed 3121 const char *const *const ext = search_ext ? search_ext : exts;
491527d0 3122 int extidx = 0, i = 0;
bd61b366 3123 const char *curext = NULL;
491527d0 3124#else
53c1dcc0 3125 PERL_UNUSED_ARG(search_ext);
491527d0
GS
3126# define MAX_EXT_LEN 0
3127#endif
3128
7918f24d
NC
3129 PERL_ARGS_ASSERT_FIND_SCRIPT;
3130
491527d0
GS
3131 /*
3132 * If dosearch is true and if scriptname does not contain path
3133 * delimiters, search the PATH for scriptname.
3134 *
3135 * If SEARCH_EXTS is also defined, will look for each
3136 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3137 * while searching the PATH.
3138 *
3139 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3140 * proceeds as follows:
3141 * If DOSISH or VMSISH:
3142 * + look for ./scriptname{,.foo,.bar}
3143 * + search the PATH for scriptname{,.foo,.bar}
3144 *
3145 * If !DOSISH:
3146 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3147 * this will not look in '.' if it's not in the PATH)
3148 */
84486fc6 3149 tmpbuf[0] = '\0';
491527d0
GS
3150
3151#ifdef VMS
3152# ifdef ALWAYS_DEFTYPES
3153 len = strlen(scriptname);
3154 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
c4420975 3155 int idx = 0, deftypes = 1;
491527d0
GS
3156 bool seen_dot = 1;
3157
bd61b366 3158 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
491527d0
GS
3159# else
3160 if (dosearch) {
c4420975 3161 int idx = 0, deftypes = 1;
491527d0
GS
3162 bool seen_dot = 1;
3163
bd61b366 3164 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
491527d0
GS
3165# endif
3166 /* The first time through, just add SEARCH_EXTS to whatever we
3167 * already have, so we can check for default file types. */
3168 while (deftypes ||
84486fc6 3169 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
491527d0 3170 {
2aa28b86 3171 Stat_t statbuf;
491527d0
GS
3172 if (deftypes) {
3173 deftypes = 0;
84486fc6 3174 *tmpbuf = '\0';
491527d0 3175 }
84486fc6
GS
3176 if ((strlen(tmpbuf) + strlen(scriptname)
3177 + MAX_EXT_LEN) >= sizeof tmpbuf)
491527d0 3178 continue; /* don't search dir with too-long name */
6fca0082 3179 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
491527d0
GS
3180#else /* !VMS */
3181
3182#ifdef DOSISH
3183 if (strEQ(scriptname, "-"))
3184 dosearch = 0;
3185 if (dosearch) { /* Look in '.' first. */
fe2774ed 3186 const char *cur = scriptname;
491527d0
GS
3187#ifdef SEARCH_EXTS
3188 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3189 while (ext[i])
3190 if (strEQ(ext[i++],curext)) {
3191 extidx = -1; /* already has an ext */
3192 break;
3193 }
3194 do {
3195#endif
3196 DEBUG_p(PerlIO_printf(Perl_debug_log,
3197 "Looking for %s\n",cur));
45a23732 3198 {
0cc19a43 3199 Stat_t statbuf;
45a23732
DD
3200 if (PerlLIO_stat(cur,&statbuf) >= 0
3201 && !S_ISDIR(statbuf.st_mode)) {
3202 dosearch = 0;
3203 scriptname = cur;
491527d0 3204#ifdef SEARCH_EXTS
45a23732 3205 break;
491527d0 3206#endif
45a23732 3207 }
491527d0
GS
3208 }
3209#ifdef SEARCH_EXTS
3210 if (cur == scriptname) {
3211 len = strlen(scriptname);
84486fc6 3212 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
491527d0 3213 break;
9e4425f7
SH
3214 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3215 cur = tmpbuf;
491527d0
GS
3216 }
3217 } while (extidx >= 0 && ext[extidx] /* try an extension? */
6fca0082 3218 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
491527d0
GS
3219#endif
3220 }
3221#endif
3222
3223 if (dosearch && !strchr(scriptname, '/')
3224#ifdef DOSISH
3225 && !strchr(scriptname, '\\')
3226#endif
cd39f2b6 3227 && (s = PerlEnv_getenv("PATH")))
cd39f2b6 3228 {
491527d0 3229 bool seen_dot = 0;
92f0c265 3230
39a02377
DM
3231 bufend = s + strlen(s);
3232 while (s < bufend) {
45a23732 3233 Stat_t statbuf;
7c458fae 3234# ifdef DOSISH
491527d0 3235 for (len = 0; *s
491527d0 3236 && *s != ';'; len++, s++) {
84486fc6
GS
3237 if (len < sizeof tmpbuf)
3238 tmpbuf[len] = *s;
491527d0 3239 }
84486fc6
GS
3240 if (len < sizeof tmpbuf)
3241 tmpbuf[len] = '\0';
7c458fae 3242# else
e80af1fd
TC
3243 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3244 ':', &len);
7c458fae 3245# endif
39a02377 3246 if (s < bufend)
491527d0 3247 s++;
84486fc6 3248 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
491527d0
GS
3249 continue; /* don't search dir with too-long name */
3250 if (len
7c458fae 3251# ifdef DOSISH
84486fc6
GS
3252 && tmpbuf[len - 1] != '/'
3253 && tmpbuf[len - 1] != '\\'
490a0e98 3254# endif
491527d0 3255 )
84486fc6
GS
3256 tmpbuf[len++] = '/';
3257 if (len == 2 && tmpbuf[0] == '.')
491527d0 3258 seen_dot = 1;
28f0d0ec 3259 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
491527d0
GS
3260#endif /* !VMS */
3261
3262#ifdef SEARCH_EXTS
84486fc6 3263 len = strlen(tmpbuf);
491527d0
GS
3264 if (extidx > 0) /* reset after previous loop */
3265 extidx = 0;
3266 do {
3267#endif
84486fc6 3268 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
45a23732
DD
3269 retval = PerlLIO_stat(tmpbuf,&statbuf);
3270 if (S_ISDIR(statbuf.st_mode)) {
017f25f1
IZ
3271 retval = -1;
3272 }
491527d0
GS
3273#ifdef SEARCH_EXTS
3274 } while ( retval < 0 /* not there */
3275 && extidx>=0 && ext[extidx] /* try an extension? */
6fca0082 3276 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
491527d0
GS
3277 );
3278#endif
3279 if (retval < 0)
3280 continue;
45a23732
DD
3281 if (S_ISREG(statbuf.st_mode)
3282 && cando(S_IRUSR,TRUE,&statbuf)
e37778c2 3283#if !defined(DOSISH)
45a23732 3284 && cando(S_IXUSR,TRUE,&statbuf)
491527d0
GS
3285#endif
3286 )
3287 {
3aed30dc 3288 xfound = tmpbuf; /* bingo! */
491527d0
GS
3289 break;
3290 }
3291 if (!xfailed)
84486fc6 3292 xfailed = savepv(tmpbuf);
491527d0
GS
3293 }
3294#ifndef DOSISH
45a23732
DD
3295 {
3296 Stat_t statbuf;
3297 if (!xfound && !seen_dot && !xfailed &&
3298 (PerlLIO_stat(scriptname,&statbuf) < 0
3299 || S_ISDIR(statbuf.st_mode)))
3300#endif
3301 seen_dot = 1; /* Disable message. */
3302#ifndef DOSISH
3303 }
491527d0 3304#endif
9ccb31f9
GS
3305 if (!xfound) {
3306 if (flags & 1) { /* do or die? */
6ad282c7 3307 /* diag_listed_as: Can't execute %s */
3aed30dc 3308 Perl_croak(aTHX_ "Can't %s %s%s%s",
9ccb31f9
GS
3309 (xfailed ? "execute" : "find"),
3310 (xfailed ? xfailed : scriptname),
3311 (xfailed ? "" : " on PATH"),
3312 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3313 }
bd61b366 3314 scriptname = NULL;
9ccb31f9 3315 }
43c5f42d 3316 Safefree(xfailed);
491527d0
GS
3317 scriptname = xfound;
3318 }
bd61b366 3319 return (scriptname ? savepv(scriptname) : NULL);
491527d0
GS
3320}
3321
ba869deb
GS
3322#ifndef PERL_GET_CONTEXT_DEFINED
3323
3324void *
3325Perl_get_context(void)
3326{
3db8f154 3327#if defined(USE_ITHREADS)
20b7effb 3328 dVAR;
ba869deb
GS
3329# ifdef OLD_PTHREADS_API
3330 pthread_addr_t t;
5637ef5b
NC
3331 int error = pthread_getspecific(PL_thr_key, &t)
3332 if (error)
3333 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
ba869deb 3334 return (void*)t;
8ad758c7 3335# elif defined(I_MACH_CTHREADS)
8b8b35ab 3336 return (void*)cthread_data(cthread_self());
8ad758c7 3337# else
8b8b35ab 3338 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
c44d3fdb 3339# endif
ba869deb
GS
3340#else
3341 return (void*)NULL;
3342#endif
3343}
3344
3345void
3346Perl_set_context(void *t)
3347{
20b7effb 3348#if defined(USE_ITHREADS)
8772537c 3349 dVAR;
20b7effb 3350#endif
7918f24d 3351 PERL_ARGS_ASSERT_SET_CONTEXT;
3db8f154 3352#if defined(USE_ITHREADS)
c44d3fdb
GS
3353# ifdef I_MACH_CTHREADS
3354 cthread_set_data(cthread_self(), t);
3355# else
5637ef5b
NC
3356 {
3357 const int error = pthread_setspecific(PL_thr_key, t);
3358 if (error)
3359 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3360 }
c44d3fdb 3361# endif
b464bac0 3362#else
8772537c 3363 PERL_UNUSED_ARG(t);
ba869deb
GS
3364#endif
3365}
3366
3367#endif /* !PERL_GET_CONTEXT_DEFINED */
491527d0 3368
27da23d5 3369#if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
22239a37 3370struct perl_vars *
864dbfa3 3371Perl_GetVars(pTHX)
22239a37 3372{
23491f1d
JH
3373 PERL_UNUSED_CONTEXT;
3374 return &PL_Vars;
22239a37 3375}
31fb1209
NIS
3376#endif
3377
1cb0ed9b 3378char **
864dbfa3 3379Perl_get_op_names(pTHX)
31fb1209 3380{
96a5add6
AL
3381 PERL_UNUSED_CONTEXT;
3382 return (char **)PL_op_name;
31fb1209
NIS
3383}
3384
1cb0ed9b 3385char **
864dbfa3 3386Perl_get_op_descs(pTHX)
31fb1209 3387{
96a5add6
AL
3388 PERL_UNUSED_CONTEXT;
3389 return (char **)PL_op_desc;
31fb1209 3390}
9e6b2b00 3391
e1ec3a88 3392const char *
864dbfa3 3393Perl_get_no_modify(pTHX)
9e6b2b00 3394{
96a5add6
AL
3395 PERL_UNUSED_CONTEXT;
3396 return PL_no_modify;
9e6b2b00
GS
3397}
3398
3399U32 *
864dbfa3 3400Perl_get_opargs(pTHX)
9e6b2b00 3401{
96a5add6
AL
3402 PERL_UNUSED_CONTEXT;
3403 return (U32 *)PL_opargs;
9e6b2b00 3404}
51aa15f3 3405
0cb96387
GS
3406PPADDR_t*
3407Perl_get_ppaddr(pTHX)
3408{
96a5add6
AL
3409 dVAR;
3410 PERL_UNUSED_CONTEXT;
3411 return (PPADDR_t*)PL_ppaddr;
0cb96387
GS
3412}
3413
a6c40364
GS
3414#ifndef HAS_GETENV_LEN
3415char *
bf4acbe4 3416Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
a6c40364 3417{
8772537c 3418 char * const env_trans = PerlEnv_getenv(env_elem);
96a5add6 3419 PERL_UNUSED_CONTEXT;
7918f24d 3420 PERL_ARGS_ASSERT_GETENV_LEN;
a6c40364
GS
3421 if (env_trans)
3422 *len = strlen(env_trans);
3423 return env_trans;
f675dbe5
CB
3424}
3425#endif
3426
dc9e4912
GS
3427
3428MGVTBL*
864dbfa3 3429Perl_get_vtbl(pTHX_ int vtbl_id)
dc9e4912 3430{
96a5add6 3431 PERL_UNUSED_CONTEXT;
dc9e4912 3432
c7fdacb9 3433 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
31114fe9 3434 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
dc9e4912
GS
3435}
3436
767df6a1 3437I32
864dbfa3 3438Perl_my_fflush_all(pTHX)
767df6a1 3439{
97cb92d6 3440#if defined(USE_PERLIO) || defined(FFLUSH_NULL)
ce720889 3441 return PerlIO_flush(NULL);
767df6a1 3442#else
8fbdfb7c 3443# if defined(HAS__FWALK)
f13a2bc0 3444 extern int fflush(FILE *);
74cac757
JH
3445 /* undocumented, unprototyped, but very useful BSDism */
3446 extern void _fwalk(int (*)(FILE *));
8fbdfb7c 3447 _fwalk(&fflush);
74cac757 3448 return 0;
8fa7f367 3449# else
8fbdfb7c 3450# if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
8fa7f367 3451 long open_max = -1;
8fbdfb7c 3452# ifdef PERL_FFLUSH_ALL_FOPEN_MAX
d2201af2 3453 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
8ad758c7 3454# elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
767df6a1 3455 open_max = sysconf(_SC_OPEN_MAX);
8ad758c7 3456# elif defined(FOPEN_MAX)
74cac757 3457 open_max = FOPEN_MAX;
8ad758c7 3458# elif defined(OPEN_MAX)
74cac757 3459 open_max = OPEN_MAX;
8ad758c7 3460# elif defined(_NFILE)
d2201af2 3461 open_max = _NFILE;
8ad758c7 3462# endif
767df6a1
JH
3463 if (open_max > 0) {
3464 long i;
3465 for (i = 0; i < open_max; i++)
d2201af2
AD
3466 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3467 STDIO_STREAM_ARRAY[i]._file < open_max &&
3468 STDIO_STREAM_ARRAY[i]._flag)
3469 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
767df6a1
JH
3470 return 0;
3471 }
8fbdfb7c 3472# endif
93189314 3473 SETERRNO(EBADF,RMS_IFI);
767df6a1 3474 return EOF;
74cac757 3475# endif
767df6a1
JH
3476#endif
3477}
097ee67d 3478
69282e91 3479void
45219de6 3480Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
a5390457
NC
3481{
3482 if (ckWARN(WARN_IO)) {
0223a801 3483 HEK * const name
c6e4ff34 3484 = gv && (isGV_with_GP(gv))
0223a801 3485 ? GvENAME_HEK((gv))
3b46b707 3486 : NULL;
a5390457
NC
3487 const char * const direction = have == '>' ? "out" : "in";
3488
b3c81598 3489 if (name && HEK_LEN(name))
a5390457 3490 Perl_warner(aTHX_ packWARN(WARN_IO),
147e3846 3491 "Filehandle %" HEKf " opened only for %sput",
10bafe90 3492 HEKfARG(name), direction);
a5390457
NC
3493 else
3494 Perl_warner(aTHX_ packWARN(WARN_IO),
3495 "Filehandle opened only for %sput", direction);
3496 }
3497}
3498
3499void
831e4cc3 3500Perl_report_evil_fh(pTHX_ const GV *gv)
bc37a18f 3501{
65820a28 3502 const IO *io = gv ? GvIO(gv) : NULL;
831e4cc3 3503 const PERL_BITFIELD16 op = PL_op->op_type;
a5390457
NC
3504 const char *vile;
3505 I32 warn_type;
3506
65820a28 3507 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
a5390457
NC
3508 vile = "closed";
3509 warn_type = WARN_CLOSED;
2dd78f96
JH
3510 }
3511 else {
a5390457
NC
3512 vile = "unopened";
3513 warn_type = WARN_UNOPENED;
3514 }
3515
3516 if (ckWARN(warn_type)) {
3b46b707 3517 SV * const name
5c5c5f45 3518 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3b46b707 3519 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
a5390457
NC
3520 const char * const pars =
3521 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3522 const char * const func =
3523 (const char *)
d955f84c
FC
3524 (op == OP_READLINE || op == OP_RCATLINE
3525 ? "readline" : /* "<HANDLE>" not nice */
a5390457 3526 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
a5390457
NC
3527 PL_op_desc[op]);
3528 const char * const type =
3529 (const char *)
65820a28 3530 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
a5390457 3531 ? "socket" : "filehandle");
1e00d6e9 3532 const bool have_name = name && SvCUR(name);
65d99836 3533 Perl_warner(aTHX_ packWARN(warn_type),
147e3846 3534 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
65d99836
FC
3535 have_name ? " " : "",
3536 SVfARG(have_name ? name : &PL_sv_no));
3537 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
a5390457
NC
3538 Perl_warner(