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