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