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