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