This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regcomp.c: Allow a fcn param to be NULL
[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 35#ifndef SIG_ERR
36# define SIG_ERR ((Sighandler_t) -1)
37#endif
64ca3a65 38#endif
36477c24 39
3be8f094
TC
40#include <math.h>
41#include <stdlib.h>
42
172d2248
OS
43#ifdef __Lynx__
44/* Missing protos on LynxOS */
45int putenv(char *);
46#endif
47
40262ff4
AB
48#ifdef __amigaos__
49# include "amigaos4/amigaio.h"
50#endif
51
868439a2
JH
52#ifdef HAS_SELECT
53# ifdef I_SYS_SELECT
54# include <sys/select.h>
55# endif
56#endif
57
470dd224 58#ifdef USE_C_BACKTRACE
0762e42f
JH
59# ifdef I_BFD
60# define USE_BFD
61# ifdef PERL_DARWIN
62# undef USE_BFD /* BFD is useless in OS X. */
63# endif
64# ifdef USE_BFD
65# include <bfd.h>
66# endif
67# endif
470dd224
JH
68# ifdef I_DLFCN
69# include <dlfcn.h>
70# endif
71# ifdef I_EXECINFO
72# include <execinfo.h>
73# endif
74#endif
75
b001a0d1
FC
76#ifdef PERL_DEBUG_READONLY_COW
77# include <sys/mman.h>
78#endif
79
8d063cd8 80#define FLUSH
8d063cd8 81
a687059c
LW
82/* NOTE: Do not call the next three routines directly. Use the macros
83 * in handy.h, so that we can easily redefine everything to do tracking of
84 * allocated hunks back to the original New to track down any memory leaks.
20cec16a 85 * XXX This advice seems to be widely ignored :-( --AD August 1996.
a687059c
LW
86 */
87
79a92154 88#if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
1f4d2d4e
NC
89# define ALWAYS_NEED_THX
90#endif
91
b001a0d1
FC
92#if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
93static void
94S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
95{
96 if (header->readonly
97 && mprotect(header, header->size, PROT_READ|PROT_WRITE))
98 Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
99 header, header->size, errno);
100}
101
102static void
103S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
104{
105 if (header->readonly
106 && mprotect(header, header->size, PROT_READ))
107 Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
108 header, header->size, errno);
109}
110# define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
111# define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
112#else
113# define maybe_protect_rw(foo) NOOP
114# define maybe_protect_ro(foo) NOOP
115#endif
116
3f07c2bc
FC
117#if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
118 /* Use memory_debug_header */
119# define USE_MDH
120# if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
121 || defined(PERL_DEBUG_READONLY_COW)
122# define MDH_HAS_SIZE
123# endif
124#endif
125
26fa51c3
AMS
126/* paranoid version of system's malloc() */
127
bd4080b3 128Malloc_t
4f63d024 129Perl_safesysmalloc(MEM_SIZE size)
8d063cd8 130{
1f4d2d4e 131#ifdef ALWAYS_NEED_THX
54aff467 132 dTHX;
0cb20dae 133#endif
bd4080b3 134 Malloc_t ptr;
9efda33a
TC
135
136#ifdef USE_MDH
137 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
138 goto out_of_memory;
a78adc84 139 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
9efda33a 140#endif
34de22dd 141#ifdef DEBUGGING
03c5309f 142 if ((SSize_t)size < 0)
147e3846 143 Perl_croak_nocontext("panic: malloc, size=%" UVuf, (UV) size);
34de22dd 144#endif
b001a0d1
FC
145 if (!size) size = 1; /* malloc(0) is NASTY on our system */
146#ifdef PERL_DEBUG_READONLY_COW
147 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
148 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
149 perror("mmap failed");
150 abort();
151 }
152#else
153 ptr = (Malloc_t)PerlMem_malloc(size?size:1);
154#endif
da927450 155 PERL_ALLOC_CHECK(ptr);
bd61b366 156 if (ptr != NULL) {
3f07c2bc 157#ifdef USE_MDH
7cb608b5
NC
158 struct perl_memory_debug_header *const header
159 = (struct perl_memory_debug_header *)ptr;
9a083ecf
NC
160#endif
161
162#ifdef PERL_POISON
7e337ee0 163 PoisonNew(((char *)ptr), size, char);
9a083ecf 164#endif
7cb608b5 165
9a083ecf 166#ifdef PERL_TRACK_MEMPOOL
7cb608b5
NC
167 header->interpreter = aTHX;
168 /* Link us into the list. */
169 header->prev = &PL_memory_debug_header;
170 header->next = PL_memory_debug_header.next;
171 PL_memory_debug_header.next = header;
b001a0d1 172 maybe_protect_rw(header->next);
7cb608b5 173 header->next->prev = header;
b001a0d1
FC
174 maybe_protect_ro(header->next);
175# ifdef PERL_DEBUG_READONLY_COW
176 header->readonly = 0;
cd1541b2 177# endif
e8dda941 178#endif
3f07c2bc 179#ifdef MDH_HAS_SIZE
b001a0d1
FC
180 header->size = size;
181#endif
b033d668 182 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
147e3846 183 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
b033d668
DD
184
185 }
8d063cd8 186 else {
296f0d56 187#ifdef USE_MDH
9efda33a 188 out_of_memory:
296f0d56
TC
189#endif
190 {
191#ifndef ALWAYS_NEED_THX
192 dTHX;
193#endif
194 if (PL_nomemok)
195 ptr = NULL;
196 else
197 croak_no_mem();
198 }
8d063cd8 199 }
b033d668 200 return ptr;
8d063cd8
LW
201}
202
f2517201 203/* paranoid version of system's realloc() */
8d063cd8 204
bd4080b3 205Malloc_t
4f63d024 206Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
8d063cd8 207{
1f4d2d4e 208#ifdef ALWAYS_NEED_THX
54aff467 209 dTHX;
0cb20dae 210#endif
bd4080b3 211 Malloc_t ptr;
b001a0d1
FC
212#ifdef PERL_DEBUG_READONLY_COW
213 const MEM_SIZE oldsize = where
a78adc84 214 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
b001a0d1
FC
215 : 0;
216#endif
8d063cd8 217
7614df0c 218 if (!size) {
f2517201 219 safesysfree(where);
b033d668 220 ptr = NULL;
7614df0c 221 }
b033d668
DD
222 else if (!where) {
223 ptr = safesysmalloc(size);
224 }
225 else {
3f07c2bc 226#ifdef USE_MDH
b033d668 227 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
9efda33a
TC
228 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
229 goto out_of_memory;
b033d668
DD
230 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
231 {
232 struct perl_memory_debug_header *const header
233 = (struct perl_memory_debug_header *)where;
7cb608b5 234
b001a0d1 235# ifdef PERL_TRACK_MEMPOOL
b033d668
DD
236 if (header->interpreter != aTHX) {
237 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
238 header->interpreter, aTHX);
239 }
240 assert(header->next->prev == header);
241 assert(header->prev->next == header);
cd1541b2 242# ifdef PERL_POISON
b033d668
DD
243 if (header->size > size) {
244 const MEM_SIZE freed_up = header->size - size;
245 char *start_of_freed = ((char *)where) + size;
246 PoisonFree(start_of_freed, freed_up, char);
247 }
cd1541b2 248# endif
b001a0d1 249# endif
3f07c2bc 250# ifdef MDH_HAS_SIZE
b033d668 251 header->size = size;
b001a0d1 252# endif
b033d668 253 }
e8dda941 254#endif
34de22dd 255#ifdef DEBUGGING
b033d668 256 if ((SSize_t)size < 0)
147e3846 257 Perl_croak_nocontext("panic: realloc, size=%" UVuf, (UV)size);
34de22dd 258#endif
b001a0d1 259#ifdef PERL_DEBUG_READONLY_COW
b033d668
DD
260 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
261 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
262 perror("mmap failed");
263 abort();
264 }
265 Copy(where,ptr,oldsize < size ? oldsize : size,char);
266 if (munmap(where, oldsize)) {
267 perror("munmap failed");
268 abort();
269 }
b001a0d1 270#else
b033d668 271 ptr = (Malloc_t)PerlMem_realloc(where,size);
b001a0d1 272#endif
b033d668 273 PERL_ALLOC_CHECK(ptr);
a1d180c4 274
4fd0a9b8
NC
275 /* MUST do this fixup first, before doing ANYTHING else, as anything else
276 might allocate memory/free/move memory, and until we do the fixup, it
277 may well be chasing (and writing to) free memory. */
b033d668 278 if (ptr != NULL) {
b001a0d1 279#ifdef PERL_TRACK_MEMPOOL
b033d668
DD
280 struct perl_memory_debug_header *const header
281 = (struct perl_memory_debug_header *)ptr;
7cb608b5 282
9a083ecf 283# ifdef PERL_POISON
b033d668
DD
284 if (header->size < size) {
285 const MEM_SIZE fresh = size - header->size;
286 char *start_of_fresh = ((char *)ptr) + size;
287 PoisonNew(start_of_fresh, fresh, char);
288 }
9a083ecf
NC
289# endif
290
b033d668
DD
291 maybe_protect_rw(header->next);
292 header->next->prev = header;
293 maybe_protect_ro(header->next);
294 maybe_protect_rw(header->prev);
295 header->prev->next = header;
296 maybe_protect_ro(header->prev);
b001a0d1 297#endif
b033d668
DD
298 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
299 }
4fd0a9b8
NC
300
301 /* In particular, must do that fixup above before logging anything via
302 *printf(), as it can reallocate memory, which can cause SEGVs. */
303
147e3846
KW
304 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
305 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
4fd0a9b8 306
b033d668 307 if (ptr == NULL) {
296f0d56 308#ifdef USE_MDH
9efda33a 309 out_of_memory:
296f0d56
TC
310#endif
311 {
312#ifndef ALWAYS_NEED_THX
313 dTHX;
314#endif
315 if (PL_nomemok)
316 ptr = NULL;
317 else
318 croak_no_mem();
319 }
0cb20dae 320 }
8d063cd8 321 }
b033d668 322 return ptr;
8d063cd8
LW
323}
324
f2517201 325/* safe version of system's free() */
8d063cd8 326
54310121 327Free_t
4f63d024 328Perl_safesysfree(Malloc_t where)
8d063cd8 329{
79a92154 330#ifdef ALWAYS_NEED_THX
54aff467 331 dTHX;
155aba94 332#endif
147e3846 333 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
378cc40b 334 if (where) {
3f07c2bc 335#ifdef USE_MDH
6edcbed6 336 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
cd1541b2 337 {
7cb608b5 338 struct perl_memory_debug_header *const header
6edcbed6 339 = (struct perl_memory_debug_header *)where_intrn;
7cb608b5 340
3f07c2bc 341# ifdef MDH_HAS_SIZE
b001a0d1
FC
342 const MEM_SIZE size = header->size;
343# endif
344# ifdef PERL_TRACK_MEMPOOL
7cb608b5 345 if (header->interpreter != aTHX) {
5637ef5b
NC
346 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
347 header->interpreter, aTHX);
7cb608b5
NC
348 }
349 if (!header->prev) {
cd1541b2
NC
350 Perl_croak_nocontext("panic: duplicate free");
351 }
5637ef5b
NC
352 if (!(header->next))
353 Perl_croak_nocontext("panic: bad free, header->next==NULL");
354 if (header->next->prev != header || header->prev->next != header) {
355 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
356 "header=%p, ->prev->next=%p",
357 header->next->prev, header,
358 header->prev->next);
cd1541b2 359 }
7cb608b5 360 /* Unlink us from the chain. */
b001a0d1 361 maybe_protect_rw(header->next);
7cb608b5 362 header->next->prev = header->prev;
b001a0d1
FC
363 maybe_protect_ro(header->next);
364 maybe_protect_rw(header->prev);
7cb608b5 365 header->prev->next = header->next;
b001a0d1
FC
366 maybe_protect_ro(header->prev);
367 maybe_protect_rw(header);
7cb608b5 368# ifdef PERL_POISON
6edcbed6 369 PoisonNew(where_intrn, size, char);
cd1541b2 370# endif
7cb608b5
NC
371 /* Trigger the duplicate free warning. */
372 header->next = NULL;
b001a0d1
FC
373# endif
374# ifdef PERL_DEBUG_READONLY_COW
6edcbed6 375 if (munmap(where_intrn, size)) {
b001a0d1
FC
376 perror("munmap failed");
377 abort();
378 }
379# endif
7cb608b5 380 }
6edcbed6
DD
381#else
382 Malloc_t where_intrn = where;
383#endif /* USE_MDH */
b001a0d1 384#ifndef PERL_DEBUG_READONLY_COW
6edcbed6 385 PerlMem_free(where_intrn);
b001a0d1 386#endif
378cc40b 387 }
8d063cd8
LW
388}
389
f2517201 390/* safe version of system's calloc() */
1050c9ca 391
bd4080b3 392Malloc_t
4f63d024 393Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
1050c9ca 394{
1f4d2d4e 395#ifdef ALWAYS_NEED_THX
54aff467 396 dTHX;
0cb20dae 397#endif
bd4080b3 398 Malloc_t ptr;
3f07c2bc 399#if defined(USE_MDH) || defined(DEBUGGING)
ad7244db 400 MEM_SIZE total_size = 0;
4b1123b9 401#endif
1050c9ca 402
ad7244db 403 /* Even though calloc() for zero bytes is strange, be robust. */
4b1123b9 404 if (size && (count <= MEM_SIZE_MAX / size)) {
3f07c2bc 405#if defined(USE_MDH) || defined(DEBUGGING)
ad7244db 406 total_size = size * count;
4b1123b9
NC
407#endif
408 }
ad7244db 409 else
d1decf2b 410 croak_memory_wrap();
3f07c2bc 411#ifdef USE_MDH
a78adc84
DM
412 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
413 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
ad7244db 414 else
d1decf2b 415 croak_memory_wrap();
ad7244db 416#endif
1050c9ca 417#ifdef DEBUGGING
03c5309f 418 if ((SSize_t)size < 0 || (SSize_t)count < 0)
147e3846 419 Perl_croak_nocontext("panic: calloc, size=%" UVuf ", count=%" UVuf,
5637ef5b 420 (UV)size, (UV)count);
1050c9ca 421#endif
b001a0d1
FC
422#ifdef PERL_DEBUG_READONLY_COW
423 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
424 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
425 perror("mmap failed");
426 abort();
427 }
428#elif defined(PERL_TRACK_MEMPOOL)
e1a95402
NC
429 /* Have to use malloc() because we've added some space for our tracking
430 header. */
ad7244db
JH
431 /* malloc(0) is non-portable. */
432 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
e1a95402
NC
433#else
434 /* Use calloc() because it might save a memset() if the memory is fresh
435 and clean from the OS. */
ad7244db
JH
436 if (count && size)
437 ptr = (Malloc_t)PerlMem_calloc(count, size);
438 else /* calloc(0) is non-portable. */
439 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
e8dda941 440#endif
da927450 441 PERL_ALLOC_CHECK(ptr);
147e3846 442 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) calloc %ld x %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)count,(long)total_size));
bd61b366 443 if (ptr != NULL) {
3f07c2bc 444#ifdef USE_MDH
7cb608b5
NC
445 {
446 struct perl_memory_debug_header *const header
447 = (struct perl_memory_debug_header *)ptr;
448
b001a0d1 449# ifndef PERL_DEBUG_READONLY_COW
e1a95402 450 memset((void*)ptr, 0, total_size);
b001a0d1
FC
451# endif
452# ifdef PERL_TRACK_MEMPOOL
7cb608b5
NC
453 header->interpreter = aTHX;
454 /* Link us into the list. */
455 header->prev = &PL_memory_debug_header;
456 header->next = PL_memory_debug_header.next;
457 PL_memory_debug_header.next = header;
b001a0d1 458 maybe_protect_rw(header->next);
7cb608b5 459 header->next->prev = header;
b001a0d1
FC
460 maybe_protect_ro(header->next);
461# ifdef PERL_DEBUG_READONLY_COW
462 header->readonly = 0;
463# endif
464# endif
3f07c2bc 465# ifdef MDH_HAS_SIZE
e1a95402 466 header->size = total_size;
cd1541b2 467# endif
a78adc84 468 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
7cb608b5 469 }
e8dda941 470#endif
1050c9ca 471 return ptr;
472 }
0cb20dae 473 else {
1f4d2d4e 474#ifndef ALWAYS_NEED_THX
0cb20dae
NC
475 dTHX;
476#endif
477 if (PL_nomemok)
478 return NULL;
4cbe3a7d 479 croak_no_mem();
0cb20dae 480 }
1050c9ca 481}
482
cae6d0e5
GS
483/* These must be defined when not using Perl's malloc for binary
484 * compatibility */
485
486#ifndef MYMALLOC
487
488Malloc_t Perl_malloc (MEM_SIZE nbytes)
489{
20b7effb
JH
490#ifdef PERL_IMPLICIT_SYS
491 dTHX;
492#endif
077a72a9 493 return (Malloc_t)PerlMem_malloc(nbytes);
cae6d0e5
GS
494}
495
496Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
497{
20b7effb
JH
498#ifdef PERL_IMPLICIT_SYS
499 dTHX;
500#endif
077a72a9 501 return (Malloc_t)PerlMem_calloc(elements, size);
cae6d0e5
GS
502}
503
504Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
505{
20b7effb
JH
506#ifdef PERL_IMPLICIT_SYS
507 dTHX;
508#endif
077a72a9 509 return (Malloc_t)PerlMem_realloc(where, nbytes);
cae6d0e5
GS
510}
511
512Free_t Perl_mfree (Malloc_t where)
513{
20b7effb
JH
514#ifdef PERL_IMPLICIT_SYS
515 dTHX;
516#endif
cae6d0e5
GS
517 PerlMem_free(where);
518}
519
520#endif
521
19e16554
DM
522/* copy a string up to some (non-backslashed) delimiter, if any.
523 * With allow_escape, converts \<delimiter> to <delimiter>, while leaves
524 * \<non-delimiter> as-is.
525 * Returns the position in the src string of the closing delimiter, if
526 * any, or returns fromend otherwise.
527 * This is the internal implementation for Perl_delimcpy and
528 * Perl_delimcpy_no_escape.
529 */
8d063cd8 530
ba0a4150 531static char *
31ee10f1 532S_delimcpy_intern(char *to, const char *toend, const char *from,
ba0a4150
FC
533 const char *fromend, int delim, I32 *retlen,
534 const bool allow_escape)
8d063cd8 535{
eb578fdb 536 I32 tolen;
35da51f7 537
7918f24d
NC
538 PERL_ARGS_ASSERT_DELIMCPY;
539
fc36a67e 540 for (tolen = 0; from < fromend; from++, tolen++) {
19e16554 541 if (allow_escape && *from == '\\' && from + 1 < fromend) {
35da51f7 542 if (from[1] != delim) {
fc36a67e 543 if (to < toend)
544 *to++ = *from;
545 tolen++;
fc36a67e 546 }
35da51f7 547 from++;
378cc40b 548 }
bedebaa5 549 else if (*from == delim)
8d063cd8 550 break;
fc36a67e 551 if (to < toend)
552 *to++ = *from;
8d063cd8 553 }
bedebaa5
CS
554 if (to < toend)
555 *to = '\0';
fc36a67e 556 *retlen = tolen;
73d840c0 557 return (char *)from;
8d063cd8
LW
558}
559
ba0a4150
FC
560char *
561Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
562{
563 PERL_ARGS_ASSERT_DELIMCPY;
564
31ee10f1 565 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 1);
ba0a4150
FC
566}
567
568char *
569Perl_delimcpy_no_escape(char *to, const char *toend, const char *from,
570 const char *fromend, int delim, I32 *retlen)
571{
572 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
573
31ee10f1 574 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 0);
ba0a4150
FC
575}
576
fcfc5a27
KW
577/*
578=head1 Miscellaneous Functions
579
580=for apidoc Am|char *|ninstr|char * big|char * bigend|char * little|char * little_end
581
582Find the first (leftmost) occurrence of a sequence of bytes within another
583sequence. This is the Perl version of C<strstr()>, extended to handle
584arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
585is what the initial C<n> in the function name stands for; some systems have an
586equivalent, C<memmem()>, but with a somewhat different API).
587
588Another way of thinking about this function is finding a needle in a haystack.
589C<big> points to the first byte in the haystack. C<big_end> points to one byte
590beyond the final byte in the haystack. C<little> points to the first byte in
591the needle. C<little_end> points to one byte beyond the final byte in the
592needle. All the parameters must be non-C<NULL>.
593
594The function returns C<NULL> if there is no occurrence of C<little> within
595C<big>. If C<little> is the empty string, C<big> is returned.
596
597Because this function operates at the byte level, and because of the inherent
598characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
599needle and the haystack are strings with the same UTF-8ness, but not if the
600UTF-8ness differs.
601
602=cut
603
604*/
a687059c
LW
605
606char *
04c9e624 607Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
8d063cd8 608{
7918f24d 609 PERL_ARGS_ASSERT_NINSTR;
b8070b07
KW
610
611#ifdef HAS_MEMMEM
612 return ninstr(big, bigend, little, lend);
613#else
614
4c8626be
GA
615 if (little >= lend)
616 return (char*)big;
617 {
8ba22ff4 618 const char first = *little;
8ba22ff4 619 bigend -= lend - little++;
4c8626be
GA
620 OUTER:
621 while (big <= bigend) {
b0ca24ee 622 if (*big++ == first) {
19742f39 623 const char *s, *x;
b0ca24ee
JH
624 for (x=big,s=little; s < lend; x++,s++) {
625 if (*s != *x)
626 goto OUTER;
627 }
628 return (char*)(big-1);
4c8626be 629 }
4c8626be 630 }
378cc40b 631 }
bd61b366 632 return NULL;
b8070b07
KW
633
634#endif
635
a687059c
LW
636}
637
fcfc5a27
KW
638/*
639=head1 Miscellaneous Functions
640
641=for apidoc Am|char *|rninstr|char * big|char * bigend|char * little|char * little_end
642
643Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
644sequence of bytes within another sequence, returning C<NULL> if there is no
645such occurrence.
646
647=cut
648
649*/
a687059c
LW
650
651char *
5aaab254 652Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
a687059c 653{
eb578fdb
KW
654 const char *bigbeg;
655 const I32 first = *little;
656 const char * const littleend = lend;
a687059c 657
7918f24d
NC
658 PERL_ARGS_ASSERT_RNINSTR;
659
260d78c9 660 if (little >= littleend)
08105a92 661 return (char*)bigend;
a687059c
LW
662 bigbeg = big;
663 big = bigend - (littleend - little++);
664 while (big >= bigbeg) {
eb578fdb 665 const char *s, *x;
a687059c
LW
666 if (*big-- != first)
667 continue;
668 for (x=big+2,s=little; s < littleend; /**/ ) {
4fc877ac 669 if (*s != *x)
a687059c 670 break;
4fc877ac
AL
671 else {
672 x++;
673 s++;
a687059c
LW
674 }
675 }
676 if (s >= littleend)
08105a92 677 return (char*)(big+1);
378cc40b 678 }
bd61b366 679 return NULL;
378cc40b 680}
a687059c 681
cf93c79d
IZ
682/* As a space optimization, we do not compile tables for strings of length
683 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
684 special-cased in fbm_instr().
685
686 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
687
954c1994 688/*
ccfc67b7
JH
689=head1 Miscellaneous Functions
690
954c1994
GS
691=for apidoc fbm_compile
692
796b6530 693Analyses the string in order to make fast searches on it using C<fbm_instr()>
954c1994
GS
694-- the Boyer-Moore algorithm.
695
696=cut
697*/
698
378cc40b 699void
7506f9c3 700Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
378cc40b 701{
eb578fdb 702 const U8 *s;
ea725ce6 703 STRLEN i;
0b71040e 704 STRLEN len;
79072805 705 U32 frequency = 256;
2bda37ba 706 MAGIC *mg;
00cccd05 707 PERL_DEB( STRLEN rarest = 0 );
79072805 708
7918f24d
NC
709 PERL_ARGS_ASSERT_FBM_COMPILE;
710
948d2370 711 if (isGV_with_GP(sv) || SvROK(sv))
4265b45d
NC
712 return;
713
9402563a
NC
714 if (SvVALID(sv))
715 return;
716
c517dc2b 717 if (flags & FBMcf_TAIL) {
890ce7af 718 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
396482e1 719 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
c517dc2b
JH
720 if (mg && mg->mg_len >= 0)
721 mg->mg_len++;
722 }
11609d9c 723 if (!SvPOK(sv) || SvNIOKp(sv))
66379c06
FC
724 s = (U8*)SvPV_force_mutable(sv, len);
725 else s = (U8 *)SvPV_mutable(sv, len);
d1be9408 726 if (len == 0) /* TAIL might be on a zero-length string. */
cf93c79d 727 return;
c13a5c80 728 SvUPGRADE(sv, SVt_PVMG);
78d0cf80 729 SvIOK_off(sv);
8eeaf79a 730 SvNOK_off(sv);
2bda37ba 731
a5c7cb08 732 /* add PERL_MAGIC_bm magic holding the FBM lookup table */
2bda37ba
NC
733
734 assert(!mg_find(sv, PERL_MAGIC_bm));
735 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
736 assert(mg);
737
02128f11 738 if (len > 2) {
21aeb718
NC
739 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
740 the BM table. */
66a1b24b 741 const U8 mlen = (len>255) ? 255 : (U8)len;
2bda37ba 742 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
eb578fdb 743 U8 *table;
cf93c79d 744
2bda37ba 745 Newx(table, 256, U8);
7506f9c3 746 memset((void*)table, mlen, 256);
2bda37ba
NC
747 mg->mg_ptr = (char *)table;
748 mg->mg_len = 256;
749
750 s += len - 1; /* last char */
02128f11 751 i = 0;
cf93c79d
IZ
752 while (s >= sb) {
753 if (table[*s] == mlen)
7506f9c3 754 table[*s] = (U8)i;
cf93c79d
IZ
755 s--, i++;
756 }
378cc40b 757 }
378cc40b 758
9cbe880b 759 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
bbce6d69 760 for (i = 0; i < len; i++) {
22c35a8c 761 if (PL_freq[s[i]] < frequency) {
00cccd05 762 PERL_DEB( rarest = i );
22c35a8c 763 frequency = PL_freq[s[i]];
378cc40b
LW
764 }
765 }
cf93c79d 766 BmUSEFUL(sv) = 100; /* Initial value */
b4204fb6 767 ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
147e3846 768 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %" UVuf "\n",
d80cf470 769 s[rarest], (UV)rarest));
378cc40b
LW
770}
771
cf93c79d 772
954c1994
GS
773/*
774=for apidoc fbm_instr
775
3f4963df 776Returns the location of the SV in the string delimited by C<big> and
41c8d07a
DM
777C<bigend> (C<bigend>) is the char following the last char).
778It returns C<NULL> if the string can't be found. The C<sv>
796b6530 779does not have to be C<fbm_compiled>, but the search will not be as fast
954c1994
GS
780then.
781
782=cut
41c8d07a
DM
783
784If SvTAIL(littlestr) is true, a fake "\n" was appended to to the string
785during FBM compilation due to FBMcf_TAIL in flags. It indicates that
786the littlestr must be anchored to the end of bigstr (or to any \n if
787FBMrf_MULTILINE).
788
789E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
790while /abc$/ compiles to "abc\n" with SvTAIL() true.
791
792A littlestr of "abc", !SvTAIL matches as /abc/;
793a littlestr of "ab\n", SvTAIL matches as:
794 without FBMrf_MULTILINE: /ab\n?\z/
795 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
796
797(According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
798 "If SvTAIL is actually due to \Z or \z, this gives false positives
799 if multiline".
954c1994
GS
800*/
801
41c8d07a 802
378cc40b 803char *
5aaab254 804Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
378cc40b 805{
eb578fdb 806 unsigned char *s;
cf93c79d 807 STRLEN l;
eb578fdb
KW
808 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
809 STRLEN littlelen = l;
810 const I32 multiline = flags & FBMrf_MULTILINE;
4e8879f3
DM
811 bool valid = SvVALID(littlestr);
812 bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
cf93c79d 813
7918f24d
NC
814 PERL_ARGS_ASSERT_FBM_INSTR;
815
bb152a4b
DM
816 assert(bigend >= big);
817
eb160463 818 if ((STRLEN)(bigend - big) < littlelen) {
e08d24ff 819 if ( tail
eb160463 820 && ((STRLEN)(bigend - big) == littlelen - 1)
a1d180c4 821 && (littlelen == 1
12ae5dfc 822 || (*big == *little &&
27da23d5 823 memEQ((char *)big, (char *)little, littlelen - 1))))
cf93c79d 824 return (char*)big;
bd61b366 825 return NULL;
cf93c79d 826 }
378cc40b 827
21aeb718
NC
828 switch (littlelen) { /* Special cases for 0, 1 and 2 */
829 case 0:
830 return (char*)big; /* Cannot be SvTAIL! */
41c8d07a 831
21aeb718 832 case 1:
e08d24ff 833 if (tail && !multiline) /* Anchor only! */
147f21b5
DM
834 /* [-1] is safe because we know that bigend != big. */
835 return (char *) (bigend - (bigend[-1] == '\n'));
836
837 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
838 if (s)
839 return (char *)s;
e08d24ff 840 if (tail)
cf93c79d 841 return (char *) bigend;
bd61b366 842 return NULL;
41c8d07a 843
21aeb718 844 case 2:
e08d24ff 845 if (tail && !multiline) {
147f21b5
DM
846 /* a littlestr with SvTAIL must be of the form "X\n" (where X
847 * is a single char). It is anchored, and can only match
848 * "....X\n" or "....X" */
849 if (bigend[-2] == *little && bigend[-1] == '\n')
cf93c79d
IZ
850 return (char*)bigend - 2;
851 if (bigend[-1] == *little)
852 return (char*)bigend - 1;
bd61b366 853 return NULL;
cf93c79d 854 }
147f21b5 855
cf93c79d 856 {
147f21b5
DM
857 /* memchr() is likely to be very fast, possibly using whatever
858 * hardware support is available, such as checking a whole
859 * cache line in one instruction.
860 * So for a 2 char pattern, calling memchr() is likely to be
861 * faster than running FBM, or rolling our own. The previous
862 * version of this code was roll-your-own which typically
863 * only needed to read every 2nd char, which was good back in
864 * the day, but no longer.
865 */
866 unsigned char c1 = little[0];
867 unsigned char c2 = little[1];
868
869 /* *** for all this case, bigend points to the last char,
870 * not the trailing \0: this makes the conditions slightly
871 * simpler */
872 bigend--;
873 s = big;
874 if (c1 != c2) {
875 while (s < bigend) {
876 /* do a quick test for c1 before calling memchr();
877 * this avoids the expensive fn call overhead when
878 * there are lots of c1's */
879 if (LIKELY(*s != c1)) {
880 s++;
881 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
882 if (!s)
883 break;
884 }
885 if (s[1] == c2)
886 return (char*)s;
887
888 /* failed; try searching for c2 this time; that way
889 * we don't go pathologically slow when the string
890 * consists mostly of c1's or vice versa.
891 */
892 s += 2;
893 if (s > bigend)
894 break;
895 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
896 if (!s)
897 break;
898 if (s[-1] == c1)
899 return (char*)s - 1;
900 }
901 }
902 else {
903 /* c1, c2 the same */
904 while (s < bigend) {
905 if (s[0] == c1) {
906 got_1char:
907 if (s[1] == c1)
908 return (char*)s;
909 s += 2;
910 }
911 else {
912 s++;
913 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
914 if (!s || s >= bigend)
915 break;
916 goto got_1char;
917 }
918 }
919 }
920
921 /* failed to find 2 chars; try anchored match at end without
922 * the \n */
e08d24ff 923 if (tail && bigend[0] == little[0])
147f21b5
DM
924 return (char *)bigend;
925 return NULL;
926 }
41c8d07a 927
21aeb718
NC
928 default:
929 break; /* Only lengths 0 1 and 2 have special-case code. */
d48672a2 930 }
21aeb718 931
e08d24ff 932 if (tail && !multiline) { /* tail anchored? */
bbce6d69 933 s = bigend - littlelen;
a1d180c4 934 if (s >= big && bigend[-1] == '\n' && *s == *little
cf93c79d
IZ
935 /* Automatically of length > 2 */
936 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
7506f9c3 937 {
bbce6d69 938 return (char*)s; /* how sweet it is */
7506f9c3
GS
939 }
940 if (s[1] == *little
941 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
942 {
cf93c79d 943 return (char*)s + 1; /* how sweet it is */
7506f9c3 944 }
bd61b366 945 return NULL;
02128f11 946 }
41c8d07a 947
4e8879f3 948 if (!valid) {
147f21b5 949 /* not compiled; use Perl_ninstr() instead */
c4420975 950 char * const b = ninstr((char*)big,(char*)bigend,
cf93c79d
IZ
951 (char*)little, (char*)little + littlelen);
952
add424da 953 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
cf93c79d 954 return b;
a687059c 955 }
a1d180c4 956
3566a07d
NC
957 /* Do actual FBM. */
958 if (littlelen > (STRLEN)(bigend - big))
959 return NULL;
960
961 {
2bda37ba 962 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
eb578fdb 963 const unsigned char *oldlittle;
cf93c79d 964
316ebaf2
JH
965 assert(mg);
966
cf93c79d
IZ
967 --littlelen; /* Last char found by table lookup */
968
969 s = big + littlelen;
970 little += littlelen; /* last char */
971 oldlittle = little;
972 if (s < bigend) {
316ebaf2 973 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
147f21b5 974 const unsigned char lastc = *little;
eb578fdb 975 I32 tmp;
cf93c79d
IZ
976
977 top2:
7506f9c3 978 if ((tmp = table[*s])) {
147f21b5
DM
979 /* *s != lastc; earliest position it could match now is
980 * tmp slots further on */
981 if ((s += tmp) >= bigend)
982 goto check_end;
983 if (LIKELY(*s != lastc)) {
984 s++;
985 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
986 if (!s) {
987 s = bigend;
988 goto check_end;
989 }
990 goto top2;
991 }
cf93c79d 992 }
147f21b5
DM
993
994
995 /* hand-rolled strncmp(): less expensive than calling the
996 * real function (maybe???) */
997 {
eb578fdb 998 unsigned char * const olds = s;
cf93c79d
IZ
999
1000 tmp = littlelen;
1001
1002 while (tmp--) {
1003 if (*--s == *--little)
1004 continue;
cf93c79d
IZ
1005 s = olds + 1; /* here we pay the price for failure */
1006 little = oldlittle;
1007 if (s < bigend) /* fake up continue to outer loop */
1008 goto top2;
1009 goto check_end;
1010 }
1011 return (char *)s;
a687059c 1012 }
378cc40b 1013 }
cf93c79d 1014 check_end:
c8029a41 1015 if ( s == bigend
e08d24ff 1016 && tail
12ae5dfc
JH
1017 && memEQ((char *)(bigend - littlelen),
1018 (char *)(oldlittle - littlelen), littlelen) )
cf93c79d 1019 return (char*)bigend - littlelen;
bd61b366 1020 return NULL;
378cc40b 1021 }
378cc40b
LW
1022}
1023
8d063cd8
LW
1024/* copy a string to a safe spot */
1025
954c1994 1026/*
ccfc67b7
JH
1027=head1 Memory Management
1028
954c1994
GS
1029=for apidoc savepv
1030
72d33970
FC
1031Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1032string which is a duplicate of C<pv>. The size of the string is
30a15352
KW
1033determined by C<strlen()>, which means it may not contain embedded C<NUL>
1034characters and must have a trailing C<NUL>. The memory allocated for the new
1035string can be freed with the C<Safefree()> function.
954c1994 1036
0358c255
KW
1037On some platforms, Windows for example, all allocated memory owned by a thread
1038is deallocated when that thread ends. So if you need that not to happen, you
1039need to use the shared memory functions, such as C<L</savesharedpv>>.
1040
954c1994
GS
1041=cut
1042*/
1043
8d063cd8 1044char *
efdfce31 1045Perl_savepv(pTHX_ const char *pv)
8d063cd8 1046{
96a5add6 1047 PERL_UNUSED_CONTEXT;
e90e2364 1048 if (!pv)
bd61b366 1049 return NULL;
66a1b24b
AL
1050 else {
1051 char *newaddr;
1052 const STRLEN pvlen = strlen(pv)+1;
10edeb5d
JH
1053 Newx(newaddr, pvlen, char);
1054 return (char*)memcpy(newaddr, pv, pvlen);
66a1b24b 1055 }
8d063cd8
LW
1056}
1057
a687059c
LW
1058/* same thing but with a known length */
1059
954c1994
GS
1060/*
1061=for apidoc savepvn
1062
72d33970 1063Perl's version of what C<strndup()> would be if it existed. Returns a
61a925ed 1064pointer to a newly allocated string which is a duplicate of the first
72d33970 1065C<len> bytes from C<pv>, plus a trailing
6602b933 1066C<NUL> byte. The memory allocated for
cbf82dd0 1067the new string can be freed with the C<Safefree()> function.
954c1994 1068
0358c255
KW
1069On some platforms, Windows for example, all allocated memory owned by a thread
1070is deallocated when that thread ends. So if you need that not to happen, you
1071need to use the shared memory functions, such as C<L</savesharedpvn>>.
1072
954c1994
GS
1073=cut
1074*/
1075
a687059c 1076char *
5aaab254 1077Perl_savepvn(pTHX_ const char *pv, I32 len)
a687059c 1078{
eb578fdb 1079 char *newaddr;
96a5add6 1080 PERL_UNUSED_CONTEXT;
a687059c 1081
223f01db
KW
1082 assert(len >= 0);
1083
a02a5408 1084 Newx(newaddr,len+1,char);
92110913 1085 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
efdfce31 1086 if (pv) {
e90e2364
NC
1087 /* might not be null terminated */
1088 newaddr[len] = '\0';
07409e01 1089 return (char *) CopyD(pv,newaddr,len,char);
92110913
NIS
1090 }
1091 else {
07409e01 1092 return (char *) ZeroD(newaddr,len+1,char);
92110913 1093 }
a687059c
LW
1094}
1095
05ec9bb3
NIS
1096/*
1097=for apidoc savesharedpv
1098
61a925ed
AMS
1099A version of C<savepv()> which allocates the duplicate string in memory
1100which is shared between threads.
05ec9bb3
NIS
1101
1102=cut
1103*/
1104char *
efdfce31 1105Perl_savesharedpv(pTHX_ const char *pv)
05ec9bb3 1106{
eb578fdb 1107 char *newaddr;
490a0e98 1108 STRLEN pvlen;
dc3bf405
BF
1109
1110 PERL_UNUSED_CONTEXT;
1111
e90e2364 1112 if (!pv)
bd61b366 1113 return NULL;
e90e2364 1114
490a0e98
NC
1115 pvlen = strlen(pv)+1;
1116 newaddr = (char*)PerlMemShared_malloc(pvlen);
e90e2364 1117 if (!newaddr) {
4cbe3a7d 1118 croak_no_mem();
05ec9bb3 1119 }
10edeb5d 1120 return (char*)memcpy(newaddr, pv, pvlen);
05ec9bb3
NIS
1121}
1122
2e0de35c 1123/*
d9095cec
NC
1124=for apidoc savesharedpvn
1125
1126A version of C<savepvn()> which allocates the duplicate string in memory
796b6530 1127which is shared between threads. (With the specific difference that a C<NULL>
d9095cec
NC
1128pointer is not acceptable)
1129
1130=cut
1131*/
1132char *
1133Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1134{
1135 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
7918f24d 1136
dc3bf405 1137 PERL_UNUSED_CONTEXT;
6379d4a9 1138 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
7918f24d 1139
d9095cec 1140 if (!newaddr) {
4cbe3a7d 1141 croak_no_mem();
d9095cec
NC
1142 }
1143 newaddr[len] = '\0';
1144 return (char*)memcpy(newaddr, pv, len);
1145}
1146
1147/*
2e0de35c
NC
1148=for apidoc savesvpv
1149
6832267f 1150A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2e0de35c
NC
1151the passed in SV using C<SvPV()>
1152
0358c255
KW
1153On some platforms, Windows for example, all allocated memory owned by a thread
1154is deallocated when that thread ends. So if you need that not to happen, you
1155need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1156
2e0de35c
NC
1157=cut
1158*/
1159
1160char *
1161Perl_savesvpv(pTHX_ SV *sv)
1162{
1163 STRLEN len;
7452cf6a 1164 const char * const pv = SvPV_const(sv, len);
eb578fdb 1165 char *newaddr;
2e0de35c 1166
7918f24d
NC
1167 PERL_ARGS_ASSERT_SAVESVPV;
1168
26866f99 1169 ++len;
a02a5408 1170 Newx(newaddr,len,char);
07409e01 1171 return (char *) CopyD(pv,newaddr,len,char);
2e0de35c 1172}
05ec9bb3 1173
9dcc53ea
Z
1174/*
1175=for apidoc savesharedsvpv
1176
1177A version of C<savesharedpv()> which allocates the duplicate string in
1178memory which is shared between threads.
1179
1180=cut
1181*/
1182
1183char *
1184Perl_savesharedsvpv(pTHX_ SV *sv)
1185{
1186 STRLEN len;
1187 const char * const pv = SvPV_const(sv, len);
1188
1189 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1190
1191 return savesharedpvn(pv, len);
1192}
05ec9bb3 1193
cea2e8a9 1194/* the SV for Perl_form() and mess() is not kept in an arena */
fc36a67e 1195
76e3520e 1196STATIC SV *
cea2e8a9 1197S_mess_alloc(pTHX)
fc36a67e 1198{
1199 SV *sv;
1200 XPVMG *any;
1201
627364f1 1202 if (PL_phase != PERL_PHASE_DESTRUCT)
84bafc02 1203 return newSVpvs_flags("", SVs_TEMP);
e72dc28c 1204
0372dbb6
GS
1205 if (PL_mess_sv)
1206 return PL_mess_sv;
1207
fc36a67e 1208 /* Create as PVMG now, to avoid any upgrading later */
a02a5408
JC
1209 Newx(sv, 1, SV);
1210 Newxz(any, 1, XPVMG);
fc36a67e 1211 SvFLAGS(sv) = SVt_PVMG;
1212 SvANY(sv) = (void*)any;
6136c704 1213 SvPV_set(sv, NULL);
fc36a67e 1214 SvREFCNT(sv) = 1 << 30; /* practically infinite */
e72dc28c 1215 PL_mess_sv = sv;
fc36a67e 1216 return sv;
1217}
1218
c5be433b 1219#if defined(PERL_IMPLICIT_CONTEXT)
cea2e8a9
GS
1220char *
1221Perl_form_nocontext(const char* pat, ...)
1222{
1223 dTHX;
c5be433b 1224 char *retval;
cea2e8a9 1225 va_list args;
7918f24d 1226 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
cea2e8a9 1227 va_start(args, pat);
c5be433b 1228 retval = vform(pat, &args);
cea2e8a9 1229 va_end(args);
c5be433b 1230 return retval;
cea2e8a9 1231}
c5be433b 1232#endif /* PERL_IMPLICIT_CONTEXT */
cea2e8a9 1233
7c9e965c 1234/*
ccfc67b7 1235=head1 Miscellaneous Functions
7c9e965c
JP
1236=for apidoc form
1237
1238Takes a sprintf-style format pattern and conventional
1239(non-SV) arguments and returns the formatted string.
1240
1241 (char *) Perl_form(pTHX_ const char* pat, ...)
1242
1243can be used any place a string (char *) is required:
1244
1245 char * s = Perl_form("%d.%d",major,minor);
1246
1247Uses a single private buffer so if you want to format several strings you
1248must explicitly copy the earlier strings away (and free the copies when you
1249are done).
1250
1251=cut
1252*/
1253
8990e307 1254char *
864dbfa3 1255Perl_form(pTHX_ const char* pat, ...)
8990e307 1256{
c5be433b 1257 char *retval;
46fc3d4c 1258 va_list args;
7918f24d 1259 PERL_ARGS_ASSERT_FORM;
46fc3d4c 1260 va_start(args, pat);
c5be433b 1261 retval = vform(pat, &args);
46fc3d4c 1262 va_end(args);
c5be433b
GS
1263 return retval;
1264}
1265
1266char *
1267Perl_vform(pTHX_ const char *pat, va_list *args)
1268{
2d03de9c 1269 SV * const sv = mess_alloc();
7918f24d 1270 PERL_ARGS_ASSERT_VFORM;
4608196e 1271 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
e72dc28c 1272 return SvPVX(sv);
46fc3d4c 1273}
a687059c 1274
c5df3096
Z
1275/*
1276=for apidoc Am|SV *|mess|const char *pat|...
1277
1278Take a sprintf-style format pattern and argument list. These are used to
1279generate a string message. If the message does not end with a newline,
1280then it will be extended with some indication of the current location
1281in the code, as described for L</mess_sv>.
1282
1283Normally, the resulting message is returned in a new mortal SV.
1284During global destruction a single SV may be shared between uses of
1285this function.
1286
1287=cut
1288*/
1289
5a844595
GS
1290#if defined(PERL_IMPLICIT_CONTEXT)
1291SV *
1292Perl_mess_nocontext(const char *pat, ...)
1293{
1294 dTHX;
1295 SV *retval;
1296 va_list args;
7918f24d 1297 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
5a844595
GS
1298 va_start(args, pat);
1299 retval = vmess(pat, &args);
1300 va_end(args);
1301 return retval;
1302}
1303#endif /* PERL_IMPLICIT_CONTEXT */
1304
06bf62c7 1305SV *
5a844595
GS
1306Perl_mess(pTHX_ const char *pat, ...)
1307{
1308 SV *retval;
1309 va_list args;
7918f24d 1310 PERL_ARGS_ASSERT_MESS;
5a844595
GS
1311 va_start(args, pat);
1312 retval = vmess(pat, &args);
1313 va_end(args);
1314 return retval;
1315}
1316
25502127
FC
1317const COP*
1318Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1319 bool opnext)
ae7d165c 1320{
25502127
FC
1321 /* Look for curop starting from o. cop is the last COP we've seen. */
1322 /* opnext means that curop is actually the ->op_next of the op we are
1323 seeking. */
ae7d165c 1324
7918f24d
NC
1325 PERL_ARGS_ASSERT_CLOSEST_COP;
1326
25502127
FC
1327 if (!o || !curop || (
1328 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1329 ))
fabdb6c0 1330 return cop;
ae7d165c
PJ
1331
1332 if (o->op_flags & OPf_KIDS) {
5f66b61c 1333 const OP *kid;
e6dae479 1334 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
5f66b61c 1335 const COP *new_cop;
ae7d165c
PJ
1336
1337 /* If the OP_NEXTSTATE has been optimised away we can still use it
1338 * the get the file and line number. */
1339
1340 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
5f66b61c 1341 cop = (const COP *)kid;
ae7d165c
PJ
1342
1343 /* Keep searching, and return when we've found something. */
1344
25502127 1345 new_cop = closest_cop(cop, kid, curop, opnext);
fabdb6c0
AL
1346 if (new_cop)
1347 return new_cop;
ae7d165c
PJ
1348 }
1349 }
1350
1351 /* Nothing found. */
1352
5f66b61c 1353 return NULL;
ae7d165c
PJ
1354}
1355
c5df3096
Z
1356/*
1357=for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1358
1359Expands a message, intended for the user, to include an indication of
1360the current location in the code, if the message does not already appear
1361to be complete.
1362
1363C<basemsg> is the initial message or object. If it is a reference, it
1364will be used as-is and will be the result of this function. Otherwise it
1365is used as a string, and if it already ends with a newline, it is taken
1366to be complete, and the result of this function will be the same string.
1367If the message does not end with a newline, then a segment such as C<at
1368foo.pl line 37> will be appended, and possibly other clauses indicating
1369the current state of execution. The resulting message will end with a
1370dot and a newline.
1371
1372Normally, the resulting message is returned in a new mortal SV.
1373During global destruction a single SV may be shared between uses of this
1374function. If C<consume> is true, then the function is permitted (but not
1375required) to modify and return C<basemsg> instead of allocating a new SV.
1376
1377=cut
1378*/
1379
5a844595 1380SV *
c5df3096 1381Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
46fc3d4c 1382{
c5df3096 1383 SV *sv;
46fc3d4c 1384
0762e42f 1385#if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
470dd224
JH
1386 {
1387 char *ws;
22ff3130 1388 UV wi;
470dd224 1389 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
22ff3130
HS
1390 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1391 && grok_atoUV(ws, &wi, NULL)
1392 && wi <= PERL_INT_MAX
1393 ) {
1394 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
470dd224
JH
1395 }
1396 }
1397#endif
1398
c5df3096
Z
1399 PERL_ARGS_ASSERT_MESS_SV;
1400
1401 if (SvROK(basemsg)) {
1402 if (consume) {
1403 sv = basemsg;
1404 }
1405 else {
1406 sv = mess_alloc();
1407 sv_setsv(sv, basemsg);
1408 }
1409 return sv;
1410 }
1411
1412 if (SvPOK(basemsg) && consume) {
1413 sv = basemsg;
1414 }
1415 else {
1416 sv = mess_alloc();
1417 sv_copypv(sv, basemsg);
1418 }
7918f24d 1419
46fc3d4c 1420 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
ae7d165c
PJ
1421 /*
1422 * Try and find the file and line for PL_op. This will usually be
1423 * PL_curcop, but it might be a cop that has been optimised away. We
1424 * can try to find such a cop by searching through the optree starting
1425 * from the sibling of PL_curcop.
1426 */
1427
f4c61774
DM
1428 if (PL_curcop) {
1429 const COP *cop =
1430 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1431 if (!cop)
1432 cop = PL_curcop;
1433
1434 if (CopLINE(cop))
1435 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1436 OutCopFILE(cop), (IV)CopLINE(cop));
1437 }
1438
191f87d5
DH
1439 /* Seems that GvIO() can be untrustworthy during global destruction. */
1440 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1441 && IoLINES(GvIOp(PL_last_in_gv)))
1442 {
2748e602 1443 STRLEN l;
e1ec3a88 1444 const bool line_mode = (RsSIMPLE(PL_rs) &&
2748e602 1445 *SvPV_const(PL_rs,l) == '\n' && l == 1);
147e3846 1446 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
3b46b707
BF
1447 SVfARG(PL_last_in_gv == PL_argvgv
1448 ? &PL_sv_no
1449 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
edc2eac3
JH
1450 line_mode ? "line" : "chunk",
1451 (IV)IoLINES(GvIOp(PL_last_in_gv)));
a687059c 1452 }
627364f1 1453 if (PL_phase == PERL_PHASE_DESTRUCT)
5f66b61c
AL
1454 sv_catpvs(sv, " during global destruction");
1455 sv_catpvs(sv, ".\n");
a687059c 1456 }
06bf62c7 1457 return sv;
a687059c
LW
1458}
1459
c5df3096
Z
1460/*
1461=for apidoc Am|SV *|vmess|const char *pat|va_list *args
1462
1463C<pat> and C<args> are a sprintf-style format pattern and encapsulated
801caa78
KW
1464argument list, respectively. These are used to generate a string message. If
1465the
c5df3096
Z
1466message does not end with a newline, then it will be extended with
1467some indication of the current location in the code, as described for
1468L</mess_sv>.
1469
1470Normally, the resulting message is returned in a new mortal SV.
1471During global destruction a single SV may be shared between uses of
1472this function.
1473
1474=cut
1475*/
1476
1477SV *
1478Perl_vmess(pTHX_ const char *pat, va_list *args)
1479{
c5df3096
Z
1480 SV * const sv = mess_alloc();
1481
1482 PERL_ARGS_ASSERT_VMESS;
1483
1484 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1485 return mess_sv(sv, 1);
1486}
1487
7ff03255 1488void
7d0994e0 1489Perl_write_to_stderr(pTHX_ SV* msv)
7ff03255
SG
1490{
1491 IO *io;
1492 MAGIC *mg;
1493
7918f24d
NC
1494 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1495
7ff03255
SG
1496 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1497 && (io = GvIO(PL_stderrgv))
daba3364 1498 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
36925d9e 1499 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
d1d7a15d 1500 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
7ff03255 1501 else {
53c1dcc0 1502 PerlIO * const serr = Perl_error_log;
7ff03255 1503
83c55556 1504 do_print(msv, serr);
7ff03255 1505 (void)PerlIO_flush(serr);
7ff03255
SG
1506 }
1507}
1508
c5df3096
Z
1509/*
1510=head1 Warning and Dieing
1511*/
1512
1513/* Common code used in dieing and warning */
1514
1515STATIC SV *
1516S_with_queued_errors(pTHX_ SV *ex)
1517{
1518 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1519 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1520 sv_catsv(PL_errors, ex);
1521 ex = sv_mortalcopy(PL_errors);
1522 SvCUR_set(PL_errors, 0);
1523 }
1524 return ex;
1525}
3ab1ac99 1526
46d9c920 1527STATIC bool
c5df3096 1528S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
63315e18
NC
1529{
1530 HV *stash;
1531 GV *gv;
1532 CV *cv;
46d9c920
NC
1533 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1534 /* sv_2cv might call Perl_croak() or Perl_warner() */
1535 SV * const oldhook = *hook;
1536
c5df3096
Z
1537 if (!oldhook)
1538 return FALSE;
63315e18 1539
63315e18 1540 ENTER;
46d9c920
NC
1541 SAVESPTR(*hook);
1542 *hook = NULL;
1543 cv = sv_2cv(oldhook, &stash, &gv, 0);
63315e18
NC
1544 LEAVE;
1545 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1546 dSP;
c5df3096 1547 SV *exarg;
63315e18
NC
1548
1549 ENTER;
2782061f 1550 save_re_context();
46d9c920
NC
1551 if (warn) {
1552 SAVESPTR(*hook);
1553 *hook = NULL;
1554 }
c5df3096
Z
1555 exarg = newSVsv(ex);
1556 SvREADONLY_on(exarg);
1557 SAVEFREESV(exarg);
63315e18 1558
46d9c920 1559 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
63315e18 1560 PUSHMARK(SP);
c5df3096 1561 XPUSHs(exarg);
63315e18 1562 PUTBACK;
daba3364 1563 call_sv(MUTABLE_SV(cv), G_DISCARD);
63315e18
NC
1564 POPSTACK;
1565 LEAVE;
46d9c920 1566 return TRUE;
63315e18 1567 }
46d9c920 1568 return FALSE;
63315e18
NC
1569}
1570
c5df3096
Z
1571/*
1572=for apidoc Am|OP *|die_sv|SV *baseex
e07360fa 1573
c5df3096
Z
1574Behaves the same as L</croak_sv>, except for the return type.
1575It should be used only where the C<OP *> return type is required.
1576The function never actually returns.
e07360fa 1577
c5df3096
Z
1578=cut
1579*/
e07360fa 1580
f8d5a522
DD
1581#ifdef _MSC_VER
1582# pragma warning( push )
1583# pragma warning( disable : 4646 ) /* warning C4646: function declared with
1584 __declspec(noreturn) has non-void return type */
1585# pragma warning( disable : 4645 ) /* warning C4645: function declared with
1586__declspec(noreturn) has a return statement */
1587#endif
c5df3096
Z
1588OP *
1589Perl_die_sv(pTHX_ SV *baseex)
36477c24 1590{
c5df3096
Z
1591 PERL_ARGS_ASSERT_DIE_SV;
1592 croak_sv(baseex);
e5964223 1593 /* NOTREACHED */
117af67d 1594 NORETURN_FUNCTION_END;
36477c24 1595}
f8d5a522
DD
1596#ifdef _MSC_VER
1597# pragma warning( pop )
1598#endif
36477c24 1599
c5df3096
Z
1600/*
1601=for apidoc Am|OP *|die|const char *pat|...
1602
1603Behaves the same as L</croak>, except for the return type.
1604It should be used only where the C<OP *> return type is required.
1605The function never actually returns.
1606
1607=cut
1608*/
1609
c5be433b 1610#if defined(PERL_IMPLICIT_CONTEXT)
f8d5a522
DD
1611#ifdef _MSC_VER
1612# pragma warning( push )
1613# pragma warning( disable : 4646 ) /* warning C4646: function declared with
1614 __declspec(noreturn) has non-void return type */
1615# pragma warning( disable : 4645 ) /* warning C4645: function declared with
1616__declspec(noreturn) has a return statement */
1617#endif
cea2e8a9
GS
1618OP *
1619Perl_die_nocontext(const char* pat, ...)
a687059c 1620{
cea2e8a9 1621 dTHX;
a687059c 1622 va_list args;
cea2e8a9 1623 va_start(args, pat);
c5df3096 1624 vcroak(pat, &args);
e5964223 1625 NOT_REACHED; /* NOTREACHED */
cea2e8a9 1626 va_end(args);
117af67d 1627 NORETURN_FUNCTION_END;
cea2e8a9 1628}
f8d5a522
DD
1629#ifdef _MSC_VER
1630# pragma warning( pop )
1631#endif
c5be433b 1632#endif /* PERL_IMPLICIT_CONTEXT */
cea2e8a9 1633
f8d5a522
DD
1634#ifdef _MSC_VER
1635# pragma warning( push )
1636# pragma warning( disable : 4646 ) /* warning C4646: function declared with
1637 __declspec(noreturn) has non-void return type */
1638# pragma warning( disable : 4645 ) /* warning C4645: function declared with
1639__declspec(noreturn) has a return statement */
1640#endif
cea2e8a9
GS
1641OP *
1642Perl_die(pTHX_ const char* pat, ...)
1643{
cea2e8a9
GS
1644 va_list args;
1645 va_start(args, pat);
c5df3096 1646 vcroak(pat, &args);
e5964223 1647 NOT_REACHED; /* NOTREACHED */
cea2e8a9 1648 va_end(args);
117af67d 1649 NORETURN_FUNCTION_END;
cea2e8a9 1650}
f8d5a522
DD
1651#ifdef _MSC_VER
1652# pragma warning( pop )
1653#endif
cea2e8a9 1654
c5df3096
Z
1655/*
1656=for apidoc Am|void|croak_sv|SV *baseex
1657
1658This is an XS interface to Perl's C<die> function.
1659
1660C<baseex> is the error message or object. If it is a reference, it
1661will be used as-is. Otherwise it is used as a string, and if it does
1662not end with a newline then it will be extended with some indication of
1663the current location in the code, as described for L</mess_sv>.
1664
1665The error message or object will be used as an exception, by default
1666returning control to the nearest enclosing C<eval>, but subject to
1667modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1668function never returns normally.
1669
1670To die with a simple string message, the L</croak> function may be
1671more convenient.
1672
1673=cut
1674*/
1675
c5be433b 1676void
c5df3096 1677Perl_croak_sv(pTHX_ SV *baseex)
cea2e8a9 1678{
c5df3096
Z
1679 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1680 PERL_ARGS_ASSERT_CROAK_SV;
1681 invoke_exception_hook(ex, FALSE);
1682 die_unwind(ex);
1683}
1684
1685/*
1686=for apidoc Am|void|vcroak|const char *pat|va_list *args
1687
1688This is an XS interface to Perl's C<die> function.
1689
1690C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1691argument list. These are used to generate a string message. If the
1692message does not end with a newline, then it will be extended with
1693some indication of the current location in the code, as described for
1694L</mess_sv>.
1695
1696The error message will be used as an exception, by default
1697returning control to the nearest enclosing C<eval>, but subject to
1698modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1699function never returns normally.
a687059c 1700
c5df3096
Z
1701For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1702(C<$@>) will be used as an error message or object instead of building an
1703error message from arguments. If you want to throw a non-string object,
1704or build an error message in an SV yourself, it is preferable to use
1705the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
5a844595 1706
c5df3096
Z
1707=cut
1708*/
1709
1710void
1711Perl_vcroak(pTHX_ const char* pat, va_list *args)
1712{
1713 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1714 invoke_exception_hook(ex, FALSE);
1715 die_unwind(ex);
a687059c
LW
1716}
1717
c5df3096
Z
1718/*
1719=for apidoc Am|void|croak|const char *pat|...
1720
1721This is an XS interface to Perl's C<die> function.
1722
1723Take a sprintf-style format pattern and argument list. These are used to
1724generate a string message. If the message does not end with a newline,
1725then it will be extended with some indication of the current location
1726in the code, as described for L</mess_sv>.
1727
1728The error message will be used as an exception, by default
1729returning control to the nearest enclosing C<eval>, but subject to
1730modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1731function never returns normally.
1732
1733For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1734(C<$@>) will be used as an error message or object instead of building an
1735error message from arguments. If you want to throw a non-string object,
1736or build an error message in an SV yourself, it is preferable to use
1737the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1738
1739=cut
1740*/
1741
c5be433b 1742#if defined(PERL_IMPLICIT_CONTEXT)
8990e307 1743void
cea2e8a9 1744Perl_croak_nocontext(const char *pat, ...)
a687059c 1745{
cea2e8a9 1746 dTHX;
a687059c 1747 va_list args;
cea2e8a9 1748 va_start(args, pat);
c5be433b 1749 vcroak(pat, &args);
e5964223 1750 NOT_REACHED; /* NOTREACHED */
cea2e8a9
GS
1751 va_end(args);
1752}
1753#endif /* PERL_IMPLICIT_CONTEXT */
1754
c5df3096
Z
1755void
1756Perl_croak(pTHX_ const char *pat, ...)
1757{
1758 va_list args;
1759 va_start(args, pat);
1760 vcroak(pat, &args);
e5964223 1761 NOT_REACHED; /* NOTREACHED */
c5df3096
Z
1762 va_end(args);
1763}
1764
954c1994 1765/*
6ad8f254
NC
1766=for apidoc Am|void|croak_no_modify
1767
1768Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
72d33970 1769terser object code than using C<Perl_croak>. Less code used on exception code
6ad8f254
NC
1770paths reduces CPU cache pressure.
1771
d8e47b5c 1772=cut
6ad8f254
NC
1773*/
1774
1775void
88772978 1776Perl_croak_no_modify(void)
6ad8f254 1777{
cb077ed2 1778 Perl_croak_nocontext( "%s", PL_no_modify);
6ad8f254
NC
1779}
1780
4cbe3a7d
DD
1781/* does not return, used in util.c perlio.c and win32.c
1782 This is typically called when malloc returns NULL.
1783*/
1784void
88772978 1785Perl_croak_no_mem(void)
4cbe3a7d
DD
1786{
1787 dTHX;
77c1c05b 1788
375ed12a
JH
1789 int fd = PerlIO_fileno(Perl_error_log);
1790 if (fd < 0)
1791 SETERRNO(EBADF,RMS_IFI);
1792 else {
1793 /* Can't use PerlIO to write as it allocates memory */
b469f1e0 1794 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
375ed12a 1795 }
4cbe3a7d
DD
1796 my_exit(1);
1797}
1798
3d04513d
DD
1799/* does not return, used only in POPSTACK */
1800void
1801Perl_croak_popstack(void)
1802{
1803 dTHX;
1804 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1805 my_exit(1);
1806}
1807
6ad8f254 1808/*
c5df3096 1809=for apidoc Am|void|warn_sv|SV *baseex
ccfc67b7 1810
c5df3096 1811This is an XS interface to Perl's C<warn> function.
954c1994 1812
c5df3096
Z
1813C<baseex> is the error message or object. If it is a reference, it
1814will be used as-is. Otherwise it is used as a string, and if it does
1815not end with a newline then it will be extended with some indication of
1816the current location in the code, as described for L</mess_sv>.
9983fa3c 1817
c5df3096
Z
1818The error message or object will by default be written to standard error,
1819but this is subject to modification by a C<$SIG{__WARN__}> handler.
9983fa3c 1820
c5df3096
Z
1821To warn with a simple string message, the L</warn> function may be
1822more convenient.
954c1994
GS
1823
1824=cut
1825*/
1826
cea2e8a9 1827void
c5df3096 1828Perl_warn_sv(pTHX_ SV *baseex)
cea2e8a9 1829{
c5df3096
Z
1830 SV *ex = mess_sv(baseex, 0);
1831 PERL_ARGS_ASSERT_WARN_SV;
1832 if (!invoke_exception_hook(ex, TRUE))
1833 write_to_stderr(ex);
cea2e8a9
GS
1834}
1835
c5df3096
Z
1836/*
1837=for apidoc Am|void|vwarn|const char *pat|va_list *args
1838
1839This is an XS interface to Perl's C<warn> function.
1840
1841C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1842argument list. These are used to generate a string message. If the
1843message does not end with a newline, then it will be extended with
1844some indication of the current location in the code, as described for
1845L</mess_sv>.
1846
1847The error message or object will by default be written to standard error,
1848but this is subject to modification by a C<$SIG{__WARN__}> handler.
1849
1850Unlike with L</vcroak>, C<pat> is not permitted to be null.
1851
1852=cut
1853*/
1854
c5be433b
GS
1855void
1856Perl_vwarn(pTHX_ const char* pat, va_list *args)
cea2e8a9 1857{
c5df3096 1858 SV *ex = vmess(pat, args);
7918f24d 1859 PERL_ARGS_ASSERT_VWARN;
c5df3096
Z
1860 if (!invoke_exception_hook(ex, TRUE))
1861 write_to_stderr(ex);
1862}
7918f24d 1863
c5df3096
Z
1864/*
1865=for apidoc Am|void|warn|const char *pat|...
87582a92 1866
c5df3096
Z
1867This is an XS interface to Perl's C<warn> function.
1868
1869Take a sprintf-style format pattern and argument list. These are used to
1870generate a string message. If the message does not end with a newline,
1871then it will be extended with some indication of the current location
1872in the code, as described for L</mess_sv>.
1873
1874The error message or object will by default be written to standard error,
1875but this is subject to modification by a C<$SIG{__WARN__}> handler.
1876
1877Unlike with L</croak>, C<pat> is not permitted to be null.
1878
1879=cut
1880*/
8d063cd8 1881
c5be433b 1882#if defined(PERL_IMPLICIT_CONTEXT)
cea2e8a9
GS
1883void
1884Perl_warn_nocontext(const char *pat, ...)
1885{
1886 dTHX;
1887 va_list args;
7918f24d 1888 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
cea2e8a9 1889 va_start(args, pat);
c5be433b 1890 vwarn(pat, &args);
cea2e8a9
GS
1891 va_end(args);
1892}
1893#endif /* PERL_IMPLICIT_CONTEXT */
1894
1895void
1896Perl_warn(pTHX_ const char *pat, ...)
1897{
1898 va_list args;
7918f24d 1899 PERL_ARGS_ASSERT_WARN;
cea2e8a9 1900 va_start(args, pat);
c5be433b 1901 vwarn(pat, &args);
cea2e8a9
GS
1902 va_end(args);
1903}
1904
c5be433b
GS
1905#if defined(PERL_IMPLICIT_CONTEXT)
1906void
1907Perl_warner_nocontext(U32 err, const char *pat, ...)
1908{
27da23d5 1909 dTHX;
c5be433b 1910 va_list args;
7918f24d 1911 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
c5be433b
GS
1912 va_start(args, pat);
1913 vwarner(err, pat, &args);
1914 va_end(args);
1915}
1916#endif /* PERL_IMPLICIT_CONTEXT */
1917
599cee73 1918void
9b387841
NC
1919Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1920{
1921 PERL_ARGS_ASSERT_CK_WARNER_D;
1922
1923 if (Perl_ckwarn_d(aTHX_ err)) {
1924 va_list args;
1925 va_start(args, pat);
1926 vwarner(err, pat, &args);
1927 va_end(args);
1928 }
1929}
1930
1931void
a2a5de95
NC
1932Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1933{
1934 PERL_ARGS_ASSERT_CK_WARNER;
1935
1936 if (Perl_ckwarn(aTHX_ err)) {
1937 va_list args;
1938 va_start(args, pat);
1939 vwarner(err, pat, &args);
1940 va_end(args);
1941 }
1942}
1943
1944void
864dbfa3 1945Perl_warner(pTHX_ U32 err, const char* pat,...)
599cee73
PM
1946{
1947 va_list args;
7918f24d 1948 PERL_ARGS_ASSERT_WARNER;
c5be433b
GS
1949 va_start(args, pat);
1950 vwarner(err, pat, &args);
1951 va_end(args);
1952}
1953
1954void
1955Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1956{
27da23d5 1957 dVAR;
7918f24d 1958 PERL_ARGS_ASSERT_VWARNER;
46b27d2f
LM
1959 if (
1960 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1961 !(PL_in_eval & EVAL_KEEPERR)
1962 ) {
a3b680e6 1963 SV * const msv = vmess(pat, args);
599cee73 1964
594b6fac
LM
1965 if (PL_parser && PL_parser->error_count) {
1966 qerror(msv);
1967 }
1968 else {
1969 invoke_exception_hook(msv, FALSE);
1970 die_unwind(msv);
1971 }
599cee73
PM
1972 }
1973 else {
d13b0d77 1974 Perl_vwarn(aTHX_ pat, args);
599cee73
PM
1975 }
1976}
1977
f54ba1c2
DM
1978/* implements the ckWARN? macros */
1979
1980bool
1981Perl_ckwarn(pTHX_ U32 w)
1982{
ad287e37 1983 /* If lexical warnings have not been set, use $^W. */
3c3f8cd6
AB
1984 if (isLEXWARN_off)
1985 return PL_dowarn & G_WARN_ON;
ad287e37 1986
26c7b074 1987 return ckwarn_common(w);
f54ba1c2
DM
1988}
1989
1990/* implements the ckWARN?_d macro */
1991
1992bool
1993Perl_ckwarn_d(pTHX_ U32 w)
1994{
ad287e37 1995 /* If lexical warnings have not been set then default classes warn. */
3c3f8cd6
AB
1996 if (isLEXWARN_off)
1997 return TRUE;
ad287e37 1998
26c7b074
NC
1999 return ckwarn_common(w);
2000}
2001
2002static bool
2003S_ckwarn_common(pTHX_ U32 w)
2004{
3c3f8cd6
AB
2005 if (PL_curcop->cop_warnings == pWARN_ALL)
2006 return TRUE;
ad287e37
NC
2007
2008 if (PL_curcop->cop_warnings == pWARN_NONE)
2009 return FALSE;
2010
98fe6610
NC
2011 /* Check the assumption that at least the first slot is non-zero. */
2012 assert(unpackWARN1(w));
2013
2014 /* Check the assumption that it is valid to stop as soon as a zero slot is
2015 seen. */
2016 if (!unpackWARN2(w)) {
2017 assert(!unpackWARN3(w));
2018 assert(!unpackWARN4(w));
2019 } else if (!unpackWARN3(w)) {
2020 assert(!unpackWARN4(w));
2021 }
2022
26c7b074
NC
2023 /* Right, dealt with all the special cases, which are implemented as non-
2024 pointers, so there is a pointer to a real warnings mask. */
98fe6610
NC
2025 do {
2026 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2027 return TRUE;
2028 } while (w >>= WARNshift);
2029
2030 return FALSE;
f54ba1c2
DM
2031}
2032
72dc9ed5
NC
2033/* Set buffer=NULL to get a new one. */
2034STRLEN *
8ee4cf24 2035Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
72dc9ed5 2036 STRLEN size) {
5af88345
FC
2037 const MEM_SIZE len_wanted =
2038 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
35da51f7 2039 PERL_UNUSED_CONTEXT;
7918f24d 2040 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
72dc9ed5 2041
10edeb5d
JH
2042 buffer = (STRLEN*)
2043 (specialWARN(buffer) ?
2044 PerlMemShared_malloc(len_wanted) :
2045 PerlMemShared_realloc(buffer, len_wanted));
72dc9ed5
NC
2046 buffer[0] = size;
2047 Copy(bits, (buffer + 1), size, char);
5af88345
FC
2048 if (size < WARNsize)
2049 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
72dc9ed5
NC
2050 return buffer;
2051}
f54ba1c2 2052
e6587932
DM
2053/* since we've already done strlen() for both nam and val
2054 * we can use that info to make things faster than
2055 * sprintf(s, "%s=%s", nam, val)
2056 */
2057#define my_setenv_format(s, nam, nlen, val, vlen) \
2058 Copy(nam, s, nlen, char); \
2059 *(s+nlen) = '='; \
2060 Copy(val, s+(nlen+1), vlen, char); \
2061 *(s+(nlen+1+vlen)) = '\0'
2062
c5d12488
JH
2063#ifdef USE_ENVIRON_ARRAY
2064 /* VMS' my_setenv() is in vms.c */
2065#if !defined(WIN32) && !defined(NETWARE)
8d063cd8 2066void
e1ec3a88 2067Perl_my_setenv(pTHX_ const char *nam, const char *val)
8d063cd8 2068{
27da23d5 2069 dVAR;
ea34f6bd 2070#ifdef __amigaos4__
6e3136a6
AB
2071 amigaos4_obtain_environ(__FUNCTION__);
2072#endif
4efc5df6
GS
2073#ifdef USE_ITHREADS
2074 /* only parent thread can modify process environment */
2075 if (PL_curinterp == aTHX)
2076#endif
2077 {
f2517201 2078#ifndef PERL_USE_SAFE_PUTENV
50acdf95 2079 if (!PL_use_safe_putenv) {
b7d87861
JH
2080 /* most putenv()s leak, so we manipulate environ directly */
2081 I32 i;
2082 const I32 len = strlen(nam);
2083 int nlen, vlen;
2084
2085 /* where does it go? */
2086 for (i = 0; environ[i]; i++) {
2087 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2088 break;
2089 }
c5d12488 2090
b7d87861
JH
2091 if (environ == PL_origenviron) { /* need we copy environment? */
2092 I32 j;
2093 I32 max;
2094 char **tmpenv;
2095
2096 max = i;
2097 while (environ[max])
2098 max++;
2099 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2100 for (j=0; j<max; j++) { /* copy environment */
2101 const int len = strlen(environ[j]);
2102 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2103 Copy(environ[j], tmpenv[j], len+1, char);
2104 }
2105 tmpenv[max] = NULL;
2106 environ = tmpenv; /* tell exec where it is now */
2107 }
2108 if (!val) {
2109 safesysfree(environ[i]);
2110 while (environ[i]) {
2111 environ[i] = environ[i+1];
2112 i++;
2113 }
ea34f6bd 2114#ifdef __amigaos4__
6e3136a6
AB
2115 goto my_setenv_out;
2116#else
b7d87861 2117 return;
6e3136a6 2118#endif
b7d87861
JH
2119 }
2120 if (!environ[i]) { /* does not exist yet */
2121 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2122 environ[i+1] = NULL; /* make sure it's null terminated */
2123 }
2124 else
2125 safesysfree(environ[i]);
2126 nlen = strlen(nam);
2127 vlen = strlen(val);
2128
2129 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2130 /* all that work just for this */
2131 my_setenv_format(environ[i], nam, nlen, val, vlen);
50acdf95 2132 } else {
c5d12488 2133# endif
235c1d5f
AD
2134 /* This next branch should only be called #if defined(HAS_SETENV), but
2135 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2136 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2137 */
12ffbb10 2138# if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
88f5bc07
AB
2139# if defined(HAS_UNSETENV)
2140 if (val == NULL) {
2141 (void)unsetenv(nam);
2142 } else {
2143 (void)setenv(nam, val, 1);
2144 }
2145# else /* ! HAS_UNSETENV */
2146 (void)setenv(nam, val, 1);
2147# endif /* HAS_UNSETENV */
8ad758c7 2148# elif defined(HAS_UNSETENV)
88f5bc07 2149 if (val == NULL) {
ba88ff58
MJ
2150 if (environ) /* old glibc can crash with null environ */
2151 (void)unsetenv(nam);
88f5bc07 2152 } else {
c4420975
AL
2153 const int nlen = strlen(nam);
2154 const int vlen = strlen(val);
2155 char * const new_env =
88f5bc07
AB
2156 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2157 my_setenv_format(new_env, nam, nlen, val, vlen);
2158 (void)putenv(new_env);
2159 }
8ad758c7 2160# else /* ! HAS_UNSETENV */
88f5bc07 2161 char *new_env;
c4420975
AL
2162 const int nlen = strlen(nam);
2163 int vlen;
88f5bc07
AB
2164 if (!val) {
2165 val = "";
2166 }
2167 vlen = strlen(val);
2168 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2169 /* all that work just for this */
2170 my_setenv_format(new_env, nam, nlen, val, vlen);
2171 (void)putenv(new_env);
47dafe4d 2172# endif /* __CYGWIN__ */
50acdf95
MS
2173#ifndef PERL_USE_SAFE_PUTENV
2174 }
2175#endif
4efc5df6 2176 }
ea34f6bd 2177#ifdef __amigaos4__
6e3136a6
AB
2178my_setenv_out:
2179 amigaos4_release_environ(__FUNCTION__);
2180#endif
8d063cd8
LW
2181}
2182
c5d12488 2183#else /* WIN32 || NETWARE */
68dc0745 2184
2185void
72229eff 2186Perl_my_setenv(pTHX_ const char *nam, const char *val)
68dc0745 2187{
27da23d5 2188 dVAR;
eb578fdb 2189 char *envstr;
c5d12488
JH
2190 const int nlen = strlen(nam);
2191 int vlen;
e6587932 2192
c5d12488
JH
2193 if (!val) {
2194 val = "";
ac5c734f 2195 }
c5d12488
JH
2196 vlen = strlen(val);
2197 Newx(envstr, nlen+vlen+2, char);
2198 my_setenv_format(envstr, nam, nlen, val, vlen);
2199 (void)PerlEnv_putenv(envstr);
2200 Safefree(envstr);
3e3baf6d
TB
2201}
2202
c5d12488 2203#endif /* WIN32 || NETWARE */
3e3baf6d 2204
739a0b84 2205#endif /* !VMS */
378cc40b 2206
16d20bd9 2207#ifdef UNLINK_ALL_VERSIONS
79072805 2208I32
6e732051 2209Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
378cc40b 2210{
35da51f7 2211 I32 retries = 0;
378cc40b 2212
7918f24d
NC
2213 PERL_ARGS_ASSERT_UNLNK;
2214
35da51f7
AL
2215 while (PerlLIO_unlink(f) >= 0)
2216 retries++;
2217 return retries ? 0 : -1;
378cc40b
LW
2218}
2219#endif
2220
4a7d1889 2221PerlIO *
c9289b7b 2222Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
4a7d1889 2223{
f6fb4e44 2224#if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
1f852d0d 2225 int p[2];
eb578fdb
KW
2226 I32 This, that;
2227 Pid_t pid;
1f852d0d
NIS
2228 SV *sv;
2229 I32 did_pipes = 0;
2230 int pp[2];
2231
7918f24d
NC
2232 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2233
1f852d0d
NIS
2234 PERL_FLUSHALL_FOR_CHILD;
2235 This = (*mode == 'w');
2236 that = !This;
284167a5 2237 if (TAINTING_get) {
1f852d0d
NIS
2238 taint_env();
2239 taint_proper("Insecure %s%s", "EXEC");
2240 }
884fc2d3 2241 if (PerlProc_pipe_cloexec(p) < 0)
4608196e 2242 return NULL;
1f852d0d 2243 /* Try for another pipe pair for error return */
74df577f 2244 if (PerlProc_pipe_cloexec(pp) >= 0)
1f852d0d 2245 did_pipes = 1;
52e18b1f 2246 while ((pid = PerlProc_fork()) < 0) {
1f852d0d
NIS
2247 if (errno != EAGAIN) {
2248 PerlLIO_close(p[This]);
4e6dfe71 2249 PerlLIO_close(p[that]);
1f852d0d
NIS
2250 if (did_pipes) {
2251 PerlLIO_close(pp[0]);
2252 PerlLIO_close(pp[1]);
2253 }
4608196e 2254 return NULL;
1f852d0d 2255 }
a2a5de95 2256 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
1f852d0d
NIS
2257 sleep(5);
2258 }
2259 if (pid == 0) {
2260 /* Child */
1f852d0d
NIS
2261#undef THIS
2262#undef THAT
2263#define THIS that
2264#define THAT This
1f852d0d 2265 /* Close parent's end of error status pipe (if any) */
74df577f 2266 if (did_pipes)
1f852d0d 2267 PerlLIO_close(pp[0]);
1f852d0d
NIS
2268 /* Now dup our end of _the_ pipe to right position */
2269 if (p[THIS] != (*mode == 'r')) {
2270 PerlLIO_dup2(p[THIS], *mode == 'r');
2271 PerlLIO_close(p[THIS]);
4e6dfe71
GS
2272 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2273 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
1f852d0d 2274 }
4e6dfe71
GS
2275 else
2276 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
1f852d0d
NIS
2277#if !defined(HAS_FCNTL) || !defined(F_SETFD)
2278 /* No automatic close - do it by hand */
b7953727
JH
2279# ifndef NOFILE
2280# define NOFILE 20
2281# endif
a080fe3d
NIS
2282 {
2283 int fd;
2284
2285 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
3aed30dc 2286 if (fd != pp[1])
a080fe3d
NIS
2287 PerlLIO_close(fd);
2288 }
1f852d0d
NIS
2289 }
2290#endif
a0714e2c 2291 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
1f852d0d
NIS
2292 PerlProc__exit(1);
2293#undef THIS
2294#undef THAT
2295 }
2296 /* Parent */
1f852d0d
NIS
2297 if (did_pipes)
2298 PerlLIO_close(pp[1]);
2299 /* Keep the lower of the two fd numbers */
2300 if (p[that] < p[This]) {
884fc2d3 2301 PerlLIO_dup2_cloexec(p[This], p[that]);
1f852d0d
NIS
2302 PerlLIO_close(p[This]);
2303 p[This] = p[that];
2304 }
4e6dfe71
GS
2305 else
2306 PerlLIO_close(p[that]); /* close child's end of pipe */
2307
1f852d0d 2308 sv = *av_fetch(PL_fdpid,p[This],TRUE);
862a34c6 2309 SvUPGRADE(sv,SVt_IV);
45977657 2310 SvIV_set(sv, pid);
1f852d0d
NIS
2311 PL_forkprocess = pid;
2312 /* If we managed to get status pipe check for exec fail */
2313 if (did_pipes && pid > 0) {
2314 int errkid;
bb7a0f54 2315 unsigned n = 0;
1f852d0d
NIS
2316
2317 while (n < sizeof(int)) {
19742f39 2318 const SSize_t n1 = PerlLIO_read(pp[0],
1f852d0d
NIS
2319 (void*)(((char*)&errkid)+n),
2320 (sizeof(int)) - n);
2321 if (n1 <= 0)
2322 break;
2323 n += n1;
2324 }
2325 PerlLIO_close(pp[0]);
2326 did_pipes = 0;
2327 if (n) { /* Error */
2328 int pid2, status;
8c51524e 2329 PerlLIO_close(p[This]);
1f852d0d 2330 if (n != sizeof(int))
5637ef5b 2331 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
1f852d0d
NIS
2332 do {
2333 pid2 = wait4pid(pid, &status, 0);
2334 } while (pid2 == -1 && errno == EINTR);
2335 errno = errkid; /* Propagate errno from kid */
4608196e 2336 return NULL;
1f852d0d
NIS
2337 }
2338 }
2339 if (did_pipes)
2340 PerlLIO_close(pp[0]);
2341 return PerlIO_fdopen(p[This], mode);
2342#else
8492b23f 2343# if defined(OS2) /* Same, without fork()ing and all extra overhead... */
4e205ed6 2344 return my_syspopen4(aTHX_ NULL, mode, n, args);
8492b23f
TC
2345# elif defined(WIN32)
2346 return win32_popenlist(mode, n, args);
9d419b5f 2347# else
4a7d1889
NIS
2348 Perl_croak(aTHX_ "List form of piped open not implemented");
2349 return (PerlIO *) NULL;
9d419b5f 2350# endif
1f852d0d 2351#endif
4a7d1889
NIS
2352}
2353
4dd5370d
AB
2354 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2355#if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
760ac839 2356PerlIO *
3dd43144 2357Perl_my_popen(pTHX_ const char *cmd, const char *mode)
a687059c
LW
2358{
2359 int p[2];
eb578fdb
KW
2360 I32 This, that;
2361 Pid_t pid;
79072805 2362 SV *sv;
bfce84ec 2363 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
e446cec8
IZ
2364 I32 did_pipes = 0;
2365 int pp[2];
a687059c 2366
7918f24d
NC
2367 PERL_ARGS_ASSERT_MY_POPEN;
2368
45bc9206 2369 PERL_FLUSHALL_FOR_CHILD;
ddcf38b7
IZ
2370#ifdef OS2
2371 if (doexec) {
23da6c43 2372 return my_syspopen(aTHX_ cmd,mode);
ddcf38b7 2373 }
a1d180c4 2374#endif
8ac85365
NIS
2375 This = (*mode == 'w');
2376 that = !This;
284167a5 2377 if (doexec && TAINTING_get) {
bbce6d69 2378 taint_env();
2379 taint_proper("Insecure %s%s", "EXEC");
d48672a2 2380 }
884fc2d3 2381 if (PerlProc_pipe_cloexec(p) < 0)
4608196e 2382 return NULL;
74df577f 2383 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
e446cec8 2384 did_pipes = 1;
52e18b1f 2385 while ((pid = PerlProc_fork()) < 0) {
a687059c 2386 if (errno != EAGAIN) {
6ad3d225 2387 PerlLIO_close(p[This]);
b5ac89c3 2388 PerlLIO_close(p[that]);
e446cec8
IZ
2389 if (did_pipes) {
2390 PerlLIO_close(pp[0]);
2391 PerlLIO_close(pp[1]);
2392 }
a687059c 2393 if (!doexec)
b3647a36 2394 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
4608196e 2395 return NULL;
a687059c 2396 }
a2a5de95 2397 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
a687059c
LW
2398 sleep(5);
2399 }
2400 if (pid == 0) {
79072805 2401
30ac6d9b
GS
2402#undef THIS
2403#undef THAT
a687059c 2404#define THIS that
8ac85365 2405#define THAT This
74df577f 2406 if (did_pipes)
e446cec8 2407 PerlLIO_close(pp[0]);
a687059c 2408 if (p[THIS] != (*mode == 'r')) {
6ad3d225
GS
2409 PerlLIO_dup2(p[THIS], *mode == 'r');
2410 PerlLIO_close(p[THIS]);
b5ac89c3
NIS
2411 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2412 PerlLIO_close(p[THAT]);
a687059c 2413 }
b5ac89c3
NIS
2414 else
2415 PerlLIO_close(p[THAT]);
4435c477 2416#ifndef OS2
a687059c 2417 if (doexec) {
a0d0e21e 2418#if !defined(HAS_FCNTL) || !defined(F_SETFD)
ae986130
LW
2419#ifndef NOFILE
2420#define NOFILE 20
2421#endif
a080fe3d 2422 {
3aed30dc 2423 int fd;
a080fe3d
NIS
2424
2425 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2426 if (fd != pp[1])
3aed30dc 2427 PerlLIO_close(fd);
a080fe3d 2428 }
ae986130 2429#endif
a080fe3d
NIS
2430 /* may or may not use the shell */
2431 do_exec3(cmd, pp[1], did_pipes);
6ad3d225 2432 PerlProc__exit(1);
a687059c 2433 }
4435c477 2434#endif /* defined OS2 */
713cef20
IZ
2435
2436#ifdef PERLIO_USING_CRLF
2437 /* Since we circumvent IO layers when we manipulate low-level
2438 filedescriptors directly, need to manually switch to the
2439 default, binary, low-level mode; see PerlIOBuf_open(). */
2440 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2441#endif
3280af22 2442 PL_forkprocess = 0;
ca0c25f6 2443#ifdef PERL_USES_PL_PIDSTATUS
3280af22 2444 hv_clear(PL_pidstatus); /* we have no children */
ca0c25f6 2445#endif
4608196e 2446 return NULL;
a687059c
LW
2447#undef THIS
2448#undef THAT
2449 }
e446cec8
IZ
2450 if (did_pipes)
2451 PerlLIO_close(pp[1]);
8ac85365 2452 if (p[that] < p[This]) {
884fc2d3 2453 PerlLIO_dup2_cloexec(p[This], p[that]);
6ad3d225 2454 PerlLIO_close(p[This]);
8ac85365 2455 p[This] = p[that];
62b28dd9 2456 }
b5ac89c3
NIS
2457 else
2458 PerlLIO_close(p[that]);
2459
3280af22 2460 sv = *av_fetch(PL_fdpid,p[This],TRUE);
862a34c6 2461 SvUPGRADE(sv,SVt_IV);
45977657 2462 SvIV_set(sv, pid);
3280af22 2463 PL_forkprocess = pid;
e446cec8
IZ
2464 if (did_pipes && pid > 0) {
2465 int errkid;
bb7a0f54 2466 unsigned n = 0;
e446cec8
IZ
2467
2468 while (n < sizeof(int)) {
19742f39 2469 const SSize_t n1 = PerlLIO_read(pp[0],
e446cec8
IZ
2470 (void*)(((char*)&errkid)+n),
2471 (sizeof(int)) - n);
2472 if (n1 <= 0)
2473 break;
2474 n += n1;
2475 }
2f96c702
IZ
2476 PerlLIO_close(pp[0]);
2477 did_pipes = 0;
e446cec8 2478 if (n) { /* Error */
faa466a7 2479 int pid2, status;
8c51524e 2480 PerlLIO_close(p[This]);
e446cec8 2481 if (n != sizeof(int))
5637ef5b 2482 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
faa466a7
RG
2483 do {
2484 pid2 = wait4pid(pid, &status, 0);
2485 } while (pid2 == -1 && errno == EINTR);
e446cec8 2486 errno = errkid; /* Propagate errno from kid */
4608196e 2487 return NULL;
e446cec8
IZ
2488 }
2489 }
2490 if (did_pipes)
2491 PerlLIO_close(pp[0]);
8ac85365 2492 return PerlIO_fdopen(p[This], mode);
a687059c 2493}
8ad758c7 2494#elif defined(DJGPP)
2b96b0a5
JH
2495FILE *djgpp_popen();
2496PerlIO *
cef6ea9d 2497Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2b96b0a5
JH
2498{
2499 PERL_FLUSHALL_FOR_CHILD;
2500 /* Call system's popen() to get a FILE *, then import it.
2501 used 0 for 2nd parameter to PerlIO_importFILE;
2502 apparently not used
2503 */
2504 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2505}
8ad758c7 2506#elif defined(__LIBCATAMOUNT__)
9c12f1e5
RGS
2507PerlIO *
2508Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2509{
2510 return NULL;
2511}
7c0587c8
LW
2512
2513#endif /* !DOSISH */
a687059c 2514
52e18b1f
GS
2515/* this is called in parent before the fork() */
2516void
2517Perl_atfork_lock(void)
80b94025
JH
2518#if defined(USE_ITHREADS)
2519# ifdef USE_PERLIO
2520 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2521# endif
2522# ifdef MYMALLOC
2523 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2524# endif
2525 PERL_TSA_ACQUIRE(PL_op_mutex)
2526#endif
52e18b1f 2527{
3db8f154 2528#if defined(USE_ITHREADS)
20b7effb 2529 dVAR;
52e18b1f 2530 /* locks must be held in locking order (if any) */
4da80956
P
2531# ifdef USE_PERLIO
2532 MUTEX_LOCK(&PL_perlio_mutex);
2533# endif
52e18b1f
GS
2534# ifdef MYMALLOC
2535 MUTEX_LOCK(&PL_malloc_mutex);
2536# endif
2537 OP_REFCNT_LOCK;
2538#endif
2539}
2540
2541/* this is called in both parent and child after the fork() */
2542void
2543Perl_atfork_unlock(void)
80b94025
JH
2544#if defined(USE_ITHREADS)
2545# ifdef USE_PERLIO
2546 PERL_TSA_RELEASE(PL_perlio_mutex)
2547# endif
2548# ifdef MYMALLOC
2549 PERL_TSA_RELEASE(PL_malloc_mutex)
2550# endif
2551 PERL_TSA_RELEASE(PL_op_mutex)
2552#endif
52e18b1f 2553{
3db8f154 2554#if defined(USE_ITHREADS)
20b7effb 2555 dVAR;
52e18b1f 2556 /* locks must be released in same order as in atfork_lock() */
4da80956
P
2557# ifdef USE_PERLIO
2558 MUTEX_UNLOCK(&PL_perlio_mutex);
2559# endif
52e18b1f
GS
2560# ifdef MYMALLOC
2561 MUTEX_UNLOCK(&PL_malloc_mutex);
2562# endif
2563 OP_REFCNT_UNLOCK;
2564#endif
2565}
2566
2567Pid_t
2568Perl_my_fork(void)
2569{
2570#if defined(HAS_FORK)
2571 Pid_t pid;
3db8f154 2572#if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
52e18b1f
GS
2573 atfork_lock();
2574 pid = fork();
2575 atfork_unlock();
2576#else
2577 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2578 * handlers elsewhere in the code */
2579 pid = fork();
2580#endif
2581 return pid;
40262ff4
AB
2582#elif defined(__amigaos4__)
2583 return amigaos_fork();
52e18b1f
GS
2584#else
2585 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2586 Perl_croak_nocontext("fork() not available");
b961a566 2587 return 0;
52e18b1f
GS
2588#endif /* HAS_FORK */
2589}
2590
fe14fcc3 2591#ifndef HAS_DUP2
fec02dd3 2592int
ba106d47 2593dup2(int oldfd, int newfd)
a687059c 2594{
a0d0e21e 2595#if defined(HAS_FCNTL) && defined(F_DUPFD)
fec02dd3
AD
2596 if (oldfd == newfd)
2597 return oldfd;
6ad3d225 2598 PerlLIO_close(newfd);
fec02dd3 2599 return fcntl(oldfd, F_DUPFD, newfd);
62b28dd9 2600#else
fc36a67e 2601#define DUP2_MAX_FDS 256
2602 int fdtmp[DUP2_MAX_FDS];
79072805 2603 I32 fdx = 0;
ae986130
LW
2604 int fd;
2605
fe14fcc3 2606 if (oldfd == newfd)
fec02dd3 2607 return oldfd;
6ad3d225 2608 PerlLIO_close(newfd);
fc36a67e 2609 /* good enough for low fd's... */
6ad3d225 2610 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
fc36a67e 2611 if (fdx >= DUP2_MAX_FDS) {
6ad3d225 2612 PerlLIO_close(fd);
fc36a67e 2613 fd = -1;
2614 break;
2615 }
ae986130 2616 fdtmp[fdx++] = fd;
fc36a67e 2617 }
ae986130 2618 while (fdx > 0)
6ad3d225 2619 PerlLIO_close(fdtmp[--fdx]);
fec02dd3 2620 return fd;
62b28dd9 2621#endif
a687059c
LW
2622}
2623#endif
2624
64ca3a65 2625#ifndef PERL_MICRO
ff68c719 2626#ifdef HAS_SIGACTION
2627
2628Sighandler_t
864dbfa3 2629Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
ff68c719 2630{
2631 struct sigaction act, oact;
2632
a10b1e10 2633#ifdef USE_ITHREADS
20b7effb 2634 dVAR;
a10b1e10
JH
2635 /* only "parent" interpreter can diddle signals */
2636 if (PL_curinterp != aTHX)
8aad04aa 2637 return (Sighandler_t) SIG_ERR;
a10b1e10
JH
2638#endif
2639
8aad04aa 2640 act.sa_handler = (void(*)(int))handler;
ff68c719 2641 sigemptyset(&act.sa_mask);
2642 act.sa_flags = 0;
2643#ifdef SA_RESTART
4ffa73a3
JH
2644 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2645 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
0a8e0eff 2646#endif
358837b8 2647#if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
8aad04aa 2648 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
85264bed
CS
2649 act.sa_flags |= SA_NOCLDWAIT;
2650#endif
ff68c719 2651 if (sigaction(signo, &act, &oact) == -1)
8aad04aa 2652 return (Sighandler_t) SIG_ERR;
ff68c719 2653 else
8aad04aa 2654 return (Sighandler_t) oact.sa_handler;
ff68c719 2655}
2656
2657Sighandler_t
864dbfa3 2658Perl_rsignal_state(pTHX_ int signo)
ff68c719 2659{
2660 struct sigaction oact;
96a5add6 2661 PERL_UNUSED_CONTEXT;
ff68c719 2662
2663 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
8aad04aa 2664 return (Sighandler_t) SIG_ERR;
ff68c719 2665 else
8aad04aa 2666 return (Sighandler_t) oact.sa_handler;
ff68c719 2667}
2668
2669int
864dbfa3 2670Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
ff68c719 2671{
20b7effb 2672#ifdef USE_ITHREADS
27da23d5 2673 dVAR;
20b7effb 2674#endif
ff68c719 2675 struct sigaction act;
2676
7918f24d
NC
2677 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2678
a10b1e10
JH
2679#ifdef USE_ITHREADS
2680 /* only "parent" interpreter can diddle signals */
2681 if (PL_curinterp != aTHX)
2682 return -1;
2683#endif
2684
8aad04aa 2685 act.sa_handler = (void(*)(int))handler;
ff68c719 2686 sigemptyset(&act.sa_mask);
2687 act.sa_flags = 0;
2688#ifdef SA_RESTART
4ffa73a3
JH
2689 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2690 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
0a8e0eff 2691#endif
36b5d377 2692#if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
8aad04aa 2693 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
85264bed
CS
2694 act.sa_flags |= SA_NOCLDWAIT;
2695#endif
ff68c719 2696 return sigaction(signo, &act, save);
2697}
2698
2699int
864dbfa3 2700Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
ff68c719 2701{
20b7effb 2702#ifdef USE_ITHREADS
27da23d5 2703 dVAR;
20b7effb
JH
2704#endif
2705 PERL_UNUSED_CONTEXT;
a10b1e10
JH
2706#ifdef USE_ITHREADS
2707 /* only "parent" interpreter can diddle signals */
2708 if (PL_curinterp != aTHX)
2709 return -1;
2710#endif
2711
ff68c719 2712 return sigaction(signo, save, (struct sigaction *)NULL);
2713}
2714
2715#else /* !HAS_SIGACTION */
2716
2717Sighandler_t
864dbfa3 2718Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
ff68c719 2719{
39f1703b 2720#if defined(USE_ITHREADS) && !defined(WIN32)
a10b1e10
JH
2721 /* only "parent" interpreter can diddle signals */
2722 if (PL_curinterp != aTHX)
8aad04aa 2723 return (Sighandler_t) SIG_ERR;
a10b1e10
JH
2724#endif
2725
6ad3d225 2726 return PerlProc_signal(signo, handler);
ff68c719 2727}
2728
fabdb6c0 2729static Signal_t
4e35701f 2730sig_trap(int signo)
ff68c719 2731{
27da23d5
JH
2732 dVAR;
2733 PL_sig_trapped++;
ff68c719 2734}
2735
2736Sighandler_t
864dbfa3 2737Perl_rsignal_state(pTHX_ int signo)
ff68c719 2738{
27da23d5 2739 dVAR;
ff68c719 2740 Sighandler_t oldsig;
2741
39f1703b 2742#if defined(USE_ITHREADS) && !defined(WIN32)
a10b1e10
JH
2743 /* only "parent" interpreter can diddle signals */
2744 if (PL_curinterp != aTHX)
8aad04aa 2745 return (Sighandler_t) SIG_ERR;
a10b1e10
JH
2746#endif
2747
27da23d5 2748 PL_sig_trapped = 0;
6ad3d225
GS
2749 oldsig = PerlProc_signal(signo, sig_trap);
2750 PerlProc_signal(signo, oldsig);
27da23d5 2751 if (PL_sig_trapped)
3aed30dc 2752 PerlProc_kill(PerlProc_getpid(), signo);
ff68c719 2753 return oldsig;
2754}
2755
2756int
864dbfa3 2757Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
ff68c719 2758{
39f1703b 2759#if defined(USE_ITHREADS) && !defined(WIN32)
a10b1e10
JH
2760 /* only "parent" interpreter can diddle signals */
2761 if (PL_curinterp != aTHX)
2762 return -1;
2763#endif
6ad3d225 2764 *save = PerlProc_signal(signo, handler);
8aad04aa 2765 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
ff68c719 2766}
2767
2768int
864dbfa3 2769Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
ff68c719 2770{
39f1703b 2771#if defined(USE_ITHREADS) && !defined(WIN32)
a10b1e10
JH
2772 /* only "parent" interpreter can diddle signals */
2773 if (PL_curinterp != aTHX)
2774 return -1;
2775#endif
8aad04aa 2776 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
ff68c719 2777}
2778
2779#endif /* !HAS_SIGACTION */
64ca3a65 2780#endif /* !PERL_MICRO */
ff68c719 2781
5f05dabc 2782 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
53f73940 2783#if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
79072805 2784I32
864dbfa3 2785Perl_my_pclose(pTHX_ PerlIO *ptr)
a687059c 2786{
a687059c 2787 int status;
a0d0e21e 2788 SV **svp;
d8a83dd3 2789 Pid_t pid;
2e0cfa16 2790 Pid_t pid2 = 0;
03136e13 2791 bool close_failed;
4ee39169 2792 dSAVEDERRNO;
2e0cfa16 2793 const int fd = PerlIO_fileno(ptr);
e9d373c4
TC
2794 bool should_wait;
2795
2796 svp = av_fetch(PL_fdpid,fd,TRUE);
2797 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2798 SvREFCNT_dec(*svp);
2799 *svp = NULL;
2e0cfa16 2800
97cb92d6 2801#if defined(USE_PERLIO)
2e0cfa16
FC
2802 /* Find out whether the refcount is low enough for us to wait for the
2803 child proc without blocking. */
e9d373c4 2804 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
b6ae43b7 2805#else
e9d373c4 2806 should_wait = pid > 0;
b6ae43b7 2807#endif
a687059c 2808
ddcf38b7
IZ
2809#ifdef OS2
2810 if (pid == -1) { /* Opened by popen. */
2811 return my_syspclose(ptr);
2812 }
a1d180c4 2813#endif
f1618b10
CS
2814 close_failed = (PerlIO_close(ptr) == EOF);
2815 SAVE_ERRNO;
2e0cfa16 2816 if (should_wait) do {
1d3434b8
GS
2817 pid2 = wait4pid(pid, &status, 0);
2818 } while (pid2 == -1 && errno == EINTR);
03136e13 2819 if (close_failed) {
4ee39169 2820 RESTORE_ERRNO;
03136e13
CS
2821 return -1;
2822 }
2e0cfa16
FC
2823 return(
2824 should_wait
2825 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2826 : 0
2827 );
20188a90 2828}
8ad758c7 2829#elif defined(__LIBCATAMOUNT__)
9c12f1e5
RGS
2830I32
2831Perl_my_pclose(pTHX_ PerlIO *ptr)
2832{
2833 return -1;
2834}
4633a7c4
LW
2835#endif /* !DOSISH */
2836
e37778c2 2837#if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
79072805 2838I32
d8a83dd3 2839Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
20188a90 2840{
27da23d5 2841 I32 result = 0;
7918f24d 2842 PERL_ARGS_ASSERT_WAIT4PID;
ca0c25f6 2843#ifdef PERL_USES_PL_PIDSTATUS
d4c02743
TC
2844 if (!pid) {
2845 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2846 waitpid() nor wait4() is available, or on OS/2, which
2847 doesn't appear to support waiting for a progress group
2848 member, so we can only treat a 0 pid as an unknown child.
2849 */
2850 errno = ECHILD;
2851 return -1;
2852 }
b7953727 2853 {
3aed30dc 2854 if (pid > 0) {
12072db5
NC
2855 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2856 pid, rather than a string form. */
c4420975 2857 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3aed30dc
HS
2858 if (svp && *svp != &PL_sv_undef) {
2859 *statusp = SvIVX(*svp);
12072db5
NC
2860 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2861 G_DISCARD);
3aed30dc
HS
2862 return pid;
2863 }
2864 }
2865 else {
2866 HE *entry;
2867
2868 hv_iterinit(PL_pidstatus);
2869 if ((entry = hv_iternext(PL_pidstatus))) {
c4420975 2870 SV * const sv = hv_iterval(PL_pidstatus,entry);
7ea75b61 2871 I32 len;
0bcc34c2 2872 const char * const spid = hv_iterkey(entry,&len);
27da23d5 2873
12072db5
NC
2874 assert (len == sizeof(Pid_t));
2875 memcpy((char *)&pid, spid, len);
3aed30dc 2876 *statusp = SvIVX(sv);
7b9a3241
NC
2877 /* The hash iterator is currently on this entry, so simply
2878 calling hv_delete would trigger the lazy delete, which on
f6bab5f6 2879 aggregate does more work, because next call to hv_iterinit()
7b9a3241
NC
2880 would spot the flag, and have to call the delete routine,
2881 while in the meantime any new entries can't re-use that
2882 memory. */
2883 hv_iterinit(PL_pidstatus);
7ea75b61 2884 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3aed30dc
HS
2885 return pid;
2886 }
20188a90
LW
2887 }
2888 }
68a29c53 2889#endif
79072805 2890#ifdef HAS_WAITPID
367f3c24
IZ
2891# ifdef HAS_WAITPID_RUNTIME
2892 if (!HAS_WAITPID_RUNTIME)
2893 goto hard_way;
2894# endif
cddd4526 2895 result = PerlProc_waitpid(pid,statusp,flags);
dfcfdb64 2896 goto finish;
367f3c24
IZ
2897#endif
2898#if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
d4c02743 2899 result = wait4(pid,statusp,flags,NULL);
dfcfdb64 2900 goto finish;
367f3c24 2901#endif
ca0c25f6 2902#ifdef PERL_USES_PL_PIDSTATUS
27da23d5 2903#if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
367f3c24 2904 hard_way:
27da23d5 2905#endif
a0d0e21e 2906 {
a0d0e21e 2907 if (flags)
cea2e8a9 2908 Perl_croak(aTHX_ "Can't do waitpid with flags");
a0d0e21e 2909 else {
76e3520e 2910 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
a0d0e21e
LW
2911 pidgone(result,*statusp);
2912 if (result < 0)
2913 *statusp = -1;
2914 }
a687059c
LW
2915 }
2916#endif
27da23d5 2917#if defined(HAS_WAITPID) || defined(HAS_WAIT4)
dfcfdb64 2918 finish:
27da23d5 2919#endif
cddd4526
NIS
2920 if (result < 0 && errno == EINTR) {
2921 PERL_ASYNC_CHECK();
48dbb59e 2922 errno = EINTR; /* reset in case a signal handler changed $! */
cddd4526
NIS
2923 }
2924 return result;
a687059c 2925}
2986a63f 2926#endif /* !DOSISH || OS2 || WIN32 || NETWARE */
a687059c 2927
ca0c25f6 2928#ifdef PERL_USES_PL_PIDSTATUS
7c0587c8 2929void
ed4173ef 2930S_pidgone(pTHX_ Pid_t pid, int status)
a687059c 2931{
eb578fdb 2932 SV *sv;
a687059c 2933
12072db5 2934 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
862a34c6 2935 SvUPGRADE(sv,SVt_IV);
45977657 2936 SvIV_set(sv, status);
20188a90 2937 return;
a687059c 2938}
ca0c25f6 2939#endif
a687059c 2940
6de23f80 2941#if defined(OS2)
7c0587c8 2942int pclose();
ddcf38b7
IZ
2943#ifdef HAS_FORK
2944int /* Cannot prototype with I32
2945 in os2ish.h. */
ba106d47 2946my_syspclose(PerlIO *ptr)
ddcf38b7 2947#else
79072805 2948I32
864dbfa3 2949Perl_my_pclose(pTHX_ PerlIO *ptr)
a1d180c4 2950#endif
a687059c 2951{
760ac839 2952 /* Needs work for PerlIO ! */
c4420975 2953 FILE * const f = PerlIO_findFILE(ptr);
7452cf6a 2954 const I32 result = pclose(f);
2b96b0a5
JH
2955 PerlIO_releaseFILE(ptr,f);
2956 return result;
2957}
2958#endif
2959
933fea7f 2960#if defined(DJGPP)
2b96b0a5
JH
2961int djgpp_pclose();
2962I32
2963Perl_my_pclose(pTHX_ PerlIO *ptr)
2964{
2965 /* Needs work for PerlIO ! */
c4420975 2966 FILE * const f = PerlIO_findFILE(ptr);
2b96b0a5 2967 I32 result = djgpp_pclose(f);
933fea7f 2968 result = (result << 8) & 0xff00;
760ac839
LW
2969 PerlIO_releaseFILE(ptr,f);
2970 return result;
a687059c 2971}
7c0587c8 2972#endif
9f68db38 2973
16fa5c11 2974#define PERL_REPEATCPY_LINEAR 4
9f68db38 2975void
5aaab254 2976Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
9f68db38 2977{
7918f24d
NC
2978 PERL_ARGS_ASSERT_REPEATCPY;
2979
223f01db
KW
2980 assert(len >= 0);
2981
2709980d 2982 if (count < 0)
d1decf2b 2983 croak_memory_wrap();
2709980d 2984
16fa5c11
VP
2985 if (len == 1)
2986 memset(to, *from, count);
2987 else if (count) {
eb578fdb 2988 char *p = to;
26e1303d 2989 IV items, linear, half;
16fa5c11
VP
2990
2991 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
2992 for (items = 0; items < linear; ++items) {
eb578fdb 2993 const char *q = from;
26e1303d 2994 IV todo;
16fa5c11
VP
2995 for (todo = len; todo > 0; todo--)
2996 *p++ = *q++;
2997 }
2998
2999 half = count / 2;
3000 while (items <= half) {
26e1303d 3001 IV size = items * len;
16fa5c11
VP
3002 memcpy(p, to, size);
3003 p += size;
3004 items *= 2;
9f68db38 3005 }
16fa5c11
VP
3006
3007 if (count > items)
3008 memcpy(p, to, (count - items) * len);
9f68db38
LW
3009 }
3010}
0f85fab0 3011
fe14fcc3 3012#ifndef HAS_RENAME
79072805 3013I32
4373e329 3014Perl_same_dirent(pTHX_ const char *a, const char *b)
62b28dd9 3015{
93a17b20
LW
3016 char *fa = strrchr(a,'/');
3017 char *fb = strrchr(b,'/');
c623ac67
GS
3018 Stat_t tmpstatbuf1;
3019 Stat_t tmpstatbuf2;
c4420975 3020 SV * const tmpsv = sv_newmortal();
62b28dd9 3021
7918f24d
NC
3022 PERL_ARGS_ASSERT_SAME_DIRENT;
3023
62b28dd9
LW
3024 if (fa)
3025 fa++;
3026 else
3027 fa = a;
3028 if (fb)
3029 fb++;
3030 else
3031 fb = b;
3032 if (strNE(a,b))
3033 return FALSE;
3034 if (fa == a)
76f68e9b 3035 sv_setpvs(tmpsv, ".");
62b28dd9 3036 else
46fc3d4c 3037 sv_setpvn(tmpsv, a, fa - a);
95a20fc0 3038 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
62b28dd9
LW
3039 return FALSE;
3040 if (fb == b)
76f68e9b 3041 sv_setpvs(tmpsv, ".");
62b28dd9 3042 else
46fc3d4c 3043 sv_setpvn(tmpsv, b, fb - b);
95a20fc0 3044 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
62b28dd9
LW
3045 return FALSE;
3046 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3047 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3048}
fe14fcc3
LW
3049#endif /* !HAS_RENAME */
3050
491527d0 3051char*
7f315aed
NC
3052Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3053 const char *const *const search_ext, I32 flags)
491527d0 3054{
bd61b366
SS
3055 const char *xfound = NULL;
3056 char *xfailed = NULL;
0f31cffe 3057 char tmpbuf[MAXPATHLEN];
eb578fdb 3058 char *s;
5f74f29c 3059 I32 len = 0;
491527d0 3060 int retval;
39a02377 3061 char *bufend;
7c458fae 3062#if defined(DOSISH) && !defined(OS2)
491527d0
GS
3063# define SEARCH_EXTS ".bat", ".cmd", NULL
3064# define MAX_EXT_LEN 4
3065#endif
3066#ifdef OS2
3067# define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3068# define MAX_EXT_LEN 4
3069#endif
3070#ifdef VMS
3071# define SEARCH_EXTS ".pl", ".com", NULL
3072# define MAX_EXT_LEN 4
3073#endif
3074 /* additional extensions to try in each dir if scriptname not found */
3075#ifdef SEARCH_EXTS
0bcc34c2 3076 static const char *const exts[] = { SEARCH_EXTS };
7f315aed 3077 const char *const *const ext = search_ext ? search_ext : exts;
491527d0 3078 int extidx = 0, i = 0;
bd61b366 3079 const char *curext = NULL;
491527d0 3080#else
53c1dcc0 3081 PERL_UNUSED_ARG(search_ext);
491527d0
GS
3082# define MAX_EXT_LEN 0
3083#endif
3084
7918f24d
NC
3085 PERL_ARGS_ASSERT_FIND_SCRIPT;
3086
491527d0
GS
3087 /*
3088 * If dosearch is true and if scriptname does not contain path
3089 * delimiters, search the PATH for scriptname.
3090 *
3091 * If SEARCH_EXTS is also defined, will look for each
3092 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3093 * while searching the PATH.
3094 *
3095 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3096 * proceeds as follows:
3097 * If DOSISH or VMSISH:
3098 * + look for ./scriptname{,.foo,.bar}
3099 * + search the PATH for scriptname{,.foo,.bar}
3100 *
3101 * If !DOSISH:
3102 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3103 * this will not look in '.' if it's not in the PATH)
3104 */
84486fc6 3105 tmpbuf[0] = '\0';
491527d0
GS
3106
3107#ifdef VMS
3108# ifdef ALWAYS_DEFTYPES
3109 len = strlen(scriptname);
3110 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
c4420975 3111 int idx = 0, deftypes = 1;
491527d0
GS
3112 bool seen_dot = 1;
3113
bd61b366 3114 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
491527d0
GS
3115# else
3116 if (dosearch) {
c4420975 3117 int idx = 0, deftypes = 1;
491527d0
GS
3118 bool seen_dot = 1;
3119
bd61b366 3120 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
491527d0
GS
3121# endif
3122 /* The first time through, just add SEARCH_EXTS to whatever we
3123 * already have, so we can check for default file types. */
3124 while (deftypes ||
84486fc6 3125 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
491527d0 3126 {
2aa28b86 3127 Stat_t statbuf;
491527d0
GS
3128 if (deftypes) {
3129 deftypes = 0;
84486fc6 3130 *tmpbuf = '\0';
491527d0 3131 }
84486fc6
GS
3132 if ((strlen(tmpbuf) + strlen(scriptname)
3133 + MAX_EXT_LEN) >= sizeof tmpbuf)
491527d0 3134 continue; /* don't search dir with too-long name */
6fca0082 3135 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
491527d0
GS
3136#else /* !VMS */
3137
3138#ifdef DOSISH
3139 if (strEQ(scriptname, "-"))
3140 dosearch = 0;
3141 if (dosearch) { /* Look in '.' first. */
fe2774ed 3142 const char *cur = scriptname;
491527d0
GS
3143#ifdef SEARCH_EXTS
3144 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3145 while (ext[i])
3146 if (strEQ(ext[i++],curext)) {
3147 extidx = -1; /* already has an ext */
3148 break;
3149 }
3150 do {
3151#endif
3152 DEBUG_p(PerlIO_printf(Perl_debug_log,
3153 "Looking for %s\n",cur));
45a23732 3154 {
0cc19a43 3155 Stat_t statbuf;
45a23732
DD
3156 if (PerlLIO_stat(cur,&statbuf) >= 0
3157 && !S_ISDIR(statbuf.st_mode)) {
3158 dosearch = 0;
3159 scriptname = cur;
491527d0 3160#ifdef SEARCH_EXTS
45a23732 3161 break;
491527d0 3162#endif
45a23732 3163 }
491527d0
GS
3164 }
3165#ifdef SEARCH_EXTS
3166 if (cur == scriptname) {
3167 len = strlen(scriptname);
84486fc6 3168 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
491527d0 3169 break;
9e4425f7
SH
3170 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3171 cur = tmpbuf;
491527d0
GS
3172 }
3173 } while (extidx >= 0 && ext[extidx] /* try an extension? */
6fca0082 3174 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
491527d0
GS
3175#endif
3176 }
3177#endif
3178
3179 if (dosearch && !strchr(scriptname, '/')
3180#ifdef DOSISH
3181 && !strchr(scriptname, '\\')
3182#endif
cd39f2b6 3183 && (s = PerlEnv_getenv("PATH")))
cd39f2b6 3184 {
491527d0 3185 bool seen_dot = 0;
92f0c265 3186
39a02377
DM
3187 bufend = s + strlen(s);
3188 while (s < bufend) {
45a23732 3189 Stat_t statbuf;
7c458fae 3190# ifdef DOSISH
491527d0 3191 for (len = 0; *s
491527d0 3192 && *s != ';'; len++, s++) {
84486fc6
GS
3193 if (len < sizeof tmpbuf)
3194 tmpbuf[len] = *s;
491527d0 3195 }
84486fc6
GS
3196 if (len < sizeof tmpbuf)
3197 tmpbuf[len] = '\0';
7c458fae 3198# else
e80af1fd
TC
3199 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3200 ':', &len);
7c458fae 3201# endif
39a02377 3202 if (s < bufend)
491527d0 3203 s++;
84486fc6 3204 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
491527d0
GS
3205 continue; /* don't search dir with too-long name */
3206 if (len
7c458fae 3207# ifdef DOSISH
84486fc6
GS
3208 && tmpbuf[len - 1] != '/'
3209 && tmpbuf[len - 1] != '\\'
490a0e98 3210# endif
491527d0 3211 )
84486fc6
GS
3212 tmpbuf[len++] = '/';
3213 if (len == 2 && tmpbuf[0] == '.')
491527d0 3214 seen_dot = 1;
28f0d0ec 3215 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
491527d0
GS
3216#endif /* !VMS */
3217
3218#ifdef SEARCH_EXTS
84486fc6 3219 len = strlen(tmpbuf);
491527d0
GS
3220 if (extidx > 0) /* reset after previous loop */
3221 extidx = 0;
3222 do {
3223#endif
84486fc6 3224 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
45a23732
DD
3225 retval = PerlLIO_stat(tmpbuf,&statbuf);
3226 if (S_ISDIR(statbuf.st_mode)) {
017f25f1
IZ
3227 retval = -1;
3228 }
491527d0
GS
3229#ifdef SEARCH_EXTS
3230 } while ( retval < 0 /* not there */
3231 && extidx>=0 && ext[extidx] /* try an extension? */
6fca0082 3232 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
491527d0
GS
3233 );
3234#endif
3235 if (retval < 0)
3236 continue;
45a23732
DD
3237 if (S_ISREG(statbuf.st_mode)
3238 && cando(S_IRUSR,TRUE,&statbuf)
e37778c2 3239#if !defined(DOSISH)
45a23732 3240 && cando(S_IXUSR,TRUE,&statbuf)
491527d0
GS
3241#endif
3242 )
3243 {
3aed30dc 3244 xfound = tmpbuf; /* bingo! */
491527d0
GS
3245 break;
3246 }
3247 if (!xfailed)
84486fc6 3248 xfailed = savepv(tmpbuf);
491527d0
GS
3249 }
3250#ifndef DOSISH
45a23732
DD
3251 {
3252 Stat_t statbuf;
3253 if (!xfound && !seen_dot && !xfailed &&
3254 (PerlLIO_stat(scriptname,&statbuf) < 0
3255 || S_ISDIR(statbuf.st_mode)))
3256#endif
3257 seen_dot = 1; /* Disable message. */
3258#ifndef DOSISH
3259 }
491527d0 3260#endif
9ccb31f9
GS
3261 if (!xfound) {
3262 if (flags & 1) { /* do or die? */
6ad282c7 3263 /* diag_listed_as: Can't execute %s */
3aed30dc 3264 Perl_croak(aTHX_ "Can't %s %s%s%s",
9ccb31f9
GS
3265 (xfailed ? "execute" : "find"),
3266 (xfailed ? xfailed : scriptname),
3267 (xfailed ? "" : " on PATH"),
3268 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3269 }
bd61b366 3270 scriptname = NULL;
9ccb31f9 3271 }
43c5f42d 3272 Safefree(xfailed);
491527d0
GS
3273 scriptname = xfound;
3274 }
bd61b366 3275 return (scriptname ? savepv(scriptname) : NULL);
491527d0
GS
3276}
3277
ba869deb
GS
3278#ifndef PERL_GET_CONTEXT_DEFINED
3279
3280void *
3281Perl_get_context(void)
3282{
3db8f154 3283#if defined(USE_ITHREADS)
20b7effb 3284 dVAR;
ba869deb
GS
3285# ifdef OLD_PTHREADS_API
3286 pthread_addr_t t;
5637ef5b
NC
3287 int error = pthread_getspecific(PL_thr_key, &t)
3288 if (error)
3289 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
ba869deb 3290 return (void*)t;
8ad758c7 3291# elif defined(I_MACH_CTHREADS)
8b8b35ab 3292 return (void*)cthread_data(cthread_self());
8ad758c7 3293# else
8b8b35ab 3294 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
c44d3fdb 3295# endif
ba869deb
GS
3296#else
3297 return (void*)NULL;
3298#endif
3299}
3300
3301void
3302Perl_set_context(void *t)
3303{
20b7effb 3304#if defined(USE_ITHREADS)
8772537c 3305 dVAR;
20b7effb 3306#endif
7918f24d 3307 PERL_ARGS_ASSERT_SET_CONTEXT;
3db8f154 3308#if defined(USE_ITHREADS)
c44d3fdb
GS
3309# ifdef I_MACH_CTHREADS
3310 cthread_set_data(cthread_self(), t);
3311# else
5637ef5b
NC
3312 {
3313 const int error = pthread_setspecific(PL_thr_key, t);
3314 if (error)
3315 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3316 }
c44d3fdb 3317# endif
b464bac0 3318#else
8772537c 3319 PERL_UNUSED_ARG(t);
ba869deb
GS
3320#endif
3321}
3322
3323#endif /* !PERL_GET_CONTEXT_DEFINED */
491527d0 3324
27da23d5 3325#if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
22239a37 3326struct perl_vars *
864dbfa3 3327Perl_GetVars(pTHX)
22239a37 3328{
23491f1d
JH
3329 PERL_UNUSED_CONTEXT;
3330 return &PL_Vars;
22239a37 3331}
31fb1209
NIS
3332#endif
3333
1cb0ed9b 3334char **
864dbfa3 3335Perl_get_op_names(pTHX)
31fb1209 3336{
96a5add6
AL
3337 PERL_UNUSED_CONTEXT;
3338 return (char **)PL_op_name;
31fb1209
NIS
3339}
3340
1cb0ed9b 3341char **
864dbfa3 3342Perl_get_op_descs(pTHX)
31fb1209 3343{
96a5add6
AL
3344 PERL_UNUSED_CONTEXT;
3345 return (char **)PL_op_desc;
31fb1209 3346}
9e6b2b00 3347
e1ec3a88 3348const char *
864dbfa3 3349Perl_get_no_modify(pTHX)
9e6b2b00 3350{
96a5add6
AL
3351 PERL_UNUSED_CONTEXT;
3352 return PL_no_modify;
9e6b2b00
GS
3353}
3354
3355U32 *
864dbfa3 3356Perl_get_opargs(pTHX)
9e6b2b00 3357{
96a5add6
AL
3358 PERL_UNUSED_CONTEXT;
3359 return (U32 *)PL_opargs;
9e6b2b00 3360}
51aa15f3 3361
0cb96387
GS
3362PPADDR_t*
3363Perl_get_ppaddr(pTHX)
3364{
96a5add6
AL
3365 dVAR;
3366 PERL_UNUSED_CONTEXT;
3367 return (PPADDR_t*)PL_ppaddr;
0cb96387
GS
3368}
3369
a6c40364
GS
3370#ifndef HAS_GETENV_LEN
3371char *
bf4acbe4 3372Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
a6c40364 3373{
8772537c 3374 char * const env_trans = PerlEnv_getenv(env_elem);
96a5add6 3375 PERL_UNUSED_CONTEXT;
7918f24d 3376 PERL_ARGS_ASSERT_GETENV_LEN;
a6c40364
GS
3377 if (env_trans)
3378 *len = strlen(env_trans);
3379 return env_trans;
f675dbe5
CB
3380}
3381#endif
3382
dc9e4912
GS
3383
3384MGVTBL*
864dbfa3 3385Perl_get_vtbl(pTHX_ int vtbl_id)
dc9e4912 3386{
96a5add6 3387 PERL_UNUSED_CONTEXT;
dc9e4912 3388
c7fdacb9 3389 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
31114fe9 3390 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
dc9e4912
GS
3391}
3392
767df6a1 3393I32
864dbfa3 3394Perl_my_fflush_all(pTHX)
767df6a1 3395{
97cb92d6 3396#if defined(USE_PERLIO) || defined(FFLUSH_NULL)
ce720889 3397 return PerlIO_flush(NULL);
767df6a1 3398#else
8fbdfb7c 3399# if defined(HAS__FWALK)
f13a2bc0 3400 extern int fflush(FILE *);
74cac757
JH
3401 /* undocumented, unprototyped, but very useful BSDism */
3402 extern void _fwalk(int (*)(FILE *));
8fbdfb7c 3403 _fwalk(&fflush);
74cac757 3404 return 0;
8fa7f367 3405# else
8fbdfb7c 3406# if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
8fa7f367 3407 long open_max = -1;
8fbdfb7c 3408# ifdef PERL_FFLUSH_ALL_FOPEN_MAX
d2201af2 3409 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
8ad758c7 3410# elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
767df6a1 3411 open_max = sysconf(_SC_OPEN_MAX);
8ad758c7 3412# elif defined(FOPEN_MAX)
74cac757 3413 open_max = FOPEN_MAX;
8ad758c7 3414# elif defined(OPEN_MAX)
74cac757 3415 open_max = OPEN_MAX;
8ad758c7 3416# elif defined(_NFILE)
d2201af2 3417 open_max = _NFILE;
8ad758c7 3418# endif
767df6a1
JH
3419 if (open_max > 0) {
3420 long i;
3421 for (i = 0; i < open_max; i++)
d2201af2
AD
3422 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3423 STDIO_STREAM_ARRAY[i]._file < open_max &&
3424 STDIO_STREAM_ARRAY[i]._flag)
3425 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
767df6a1
JH
3426 return 0;
3427 }
8fbdfb7c 3428# endif
93189314 3429 SETERRNO(EBADF,RMS_IFI);
767df6a1 3430 return EOF;
74cac757 3431# endif
767df6a1
JH
3432#endif
3433}
097ee67d 3434
69282e91 3435void
45219de6 3436Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
a5390457
NC
3437{
3438 if (ckWARN(WARN_IO)) {
0223a801 3439 HEK * const name
c6e4ff34 3440 = gv && (isGV_with_GP(gv))
0223a801 3441 ? GvENAME_HEK((gv))
3b46b707 3442 : NULL;
a5390457
NC
3443 const char * const direction = have == '>' ? "out" : "in";
3444
b3c81598 3445 if (name && HEK_LEN(name))
a5390457 3446 Perl_warner(aTHX_ packWARN(WARN_IO),
147e3846 3447 "Filehandle %" HEKf " opened only for %sput",
10bafe90 3448 HEKfARG(name), direction);
a5390457
NC
3449 else
3450 Perl_warner(aTHX_ packWARN(WARN_IO),
3451 "Filehandle opened only for %sput", direction);
3452 }
3453}
3454
3455void
831e4cc3 3456Perl_report_evil_fh(pTHX_ const GV *gv)
bc37a18f 3457{
65820a28 3458 const IO *io = gv ? GvIO(gv) : NULL;
831e4cc3 3459 const PERL_BITFIELD16 op = PL_op->op_type;
a5390457
NC
3460 const char *vile;
3461 I32 warn_type;
3462
65820a28 3463 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
a5390457
NC
3464 vile = "closed";
3465 warn_type = WARN_CLOSED;
2dd78f96
JH
3466 }
3467 else {
a5390457
NC
3468 vile = "unopened";
3469 warn_type = WARN_UNOPENED;
3470 }
3471
3472 if (ckWARN(warn_type)) {
3b46b707 3473 SV * const name
5c5c5f45 3474 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3b46b707 3475 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
a5390457
NC
3476 const char * const pars =
3477 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3478 const char * const func =
3479 (const char *)
d955f84c
FC
3480 (op == OP_READLINE || op == OP_RCATLINE
3481 ? "readline" : /* "<HANDLE>" not nice */
a5390457 3482 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
a5390457
NC
3483 PL_op_desc[op]);
3484 const char * const type =
3485 (const char *)
65820a28 3486 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
a5390457 3487 ? "socket" : "filehandle");
1e00d6e9 3488 const bool have_name = name && SvCUR(name);
65d99836 3489 Perl_warner(aTHX_ packWARN(warn_type),
147e3846 3490 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
65d99836
FC
3491 have_name ? " " : "",
3492 SVfARG(have_name ? name : &PL_sv_no));
3493 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
a5390457
NC
3494 Perl_warner(
3495 aTHX_ packWARN(warn_type),
147e3846 3496 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
65d99836
FC
3497 func, pars, have_name ? " " : "",
3498 SVfARG(have_name ? name : &PL_sv_no)
a5390457 3499 );
bc37a18f 3500 }
69282e91 3501}
a926ef6b 3502
f6adc668 3503/* To workaround core dumps from the uninitialised tm_zone we get the
e72cf795
JH
3504 * system to give us a reasonable struct to copy. This fix means that
3505 * strftime uses the tm_zone and tm_gmtoff values returned by
3506 * localtime(time()). That should give the desired result most of the
3507 * time. But probably not always!
3508 *
f6adc668
JH
3509 * This does not address tzname aspects of NETaa14816.
3510 *
e72cf795 3511 */
f6adc668 3512
61b27c87 3513#ifdef __GLIBC__
e72cf795
JH
3514# ifndef STRUCT_TM_HASZONE
3515# define STRUCT_TM_HASZONE
3516# endif
3517#endif
3518
f6adc668
JH
3519#ifdef STRUCT_TM_HASZONE /* Backward compat */
3520# ifndef HAS_TM_TM_ZONE
3521# define HAS_TM_TM_ZONE
3522# endif
3523#endif
3524
e72cf795 3525void
f1208910 3526Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
e72cf795 3527{
f6adc668 3528#ifdef HAS_TM_TM_ZONE
e72cf795 3529 Time_t now;
1b6737cc 3530 const struct tm* my_tm;
dc3bf405 3531 PERL_UNUSED_CONTEXT;
7918f24d 3532 PERL_ARGS_ASSERT_INIT_TM;
e72cf795 3533 (void)time(&now);
82c57498 3534 my_tm = localtime(&now);
ca46b8ee
SP
3535 if (my_tm)
3536 Copy(my_tm, ptm, 1, struct tm);
1b6737cc 3537#else
dc3bf405 3538 PERL_UNUSED_CONTEXT;
7918f24d 3539 PERL_ARGS_ASSERT_INIT_TM;
1b6737cc 3540 PERL_UNUSED_ARG(ptm);
e72cf795
JH
3541#endif
3542}
3543
3544/*
3545 * mini_mktime - normalise struct tm values without the localtime()
3546 * semantics (and overhead) of mktime().
3547 */
3548void
ddeaf645 3549Perl_mini_mktime(struct tm *ptm)
e72cf795
JH
3550{
3551 int yearday;
3552 int secs;
3553 int month, mday, year, jday;
3554 int odd_cent, odd_year;
3555
7918f24d
NC
3556 PERL_ARGS_ASSERT_MINI_MKTIME;
3557
e72cf795
JH
3558#define DAYS_PER_YEAR 365
3559#define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3560#define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3561#define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3562#define SECS_PER_HOUR (60*60)
3563#define SECS_PER_DAY (24*SECS_PER_HOUR)
3564/* parentheses deliberately absent on these two, otherwise they don't work */
3565#define MONTH_TO_DAYS 153/5
3566#define DAYS_TO_MONTH 5/153
3567/* offset to bias by March (month 4) 1st between month/mday & year finding */
3568#define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3569/* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3570#define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3571
3572/*
3573 * Year/day algorithm notes:
3574 *
3575 * With a suitable offset for numeric value of the month, one can find
3576 * an offset into the year by considering months to have 30.6 (153/5) days,
3577 * using integer arithmetic (i.e., with truncation). To avoid too much
3578 * messing about with leap days, we consider January and February to be
3579 * the 13th and 14th month of the previous year. After that transformation,
3580 * we need the month index we use to be high by 1 from 'normal human' usage,
3581 * so the month index values we use run from 4 through 15.
3582 *
3583 * Given that, and the rules for the Gregorian calendar (leap years are those
3584 * divisible by 4 unless also divisible by 100, when they must be divisible
3585 * by 400 instead), we can simply calculate the number of days since some
3586 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3587 * the days we derive from our month index, and adding in the day of the
3588 * month. The value used here is not adjusted for the actual origin which
3589 * it normally would use (1 January A.D. 1), since we're not exposing it.
3590 * We're only building the value so we can turn around and get the
3591 * normalised values for the year, month, day-of-month, and day-of-year.
3592 *
3593 * For going backward, we need to bias the value we're using so that we find
3594 * the right year value. (Basically, we don't want the contribution of
3595 * March 1st to the number to apply while deriving the year). Having done
3596 * that, we 'count up' the contribution to the year number by accounting for
3597 * full quadracenturies (400-year periods) with their extra leap days, plus
3598 * the contribution from full centuries (to avoid counting in the lost leap
3599 * days), plus the contribution from full quad-years (to count in the normal
3600 * leap days), plus the leftover contribution from any non-leap years.
3601 * At this point, if we were working with an actual leap day, we'll have 0
3602 * days left over. This is also true for March 1st, however. So, we have
3603 * to special-case that result, and (earlier) keep track of the 'odd'
3604 * century and year contributions. If we got 4 extra centuries in a qcent,
3605 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3606 * Otherwise, we add back in the earlier bias we removed (the 123 from
3607 * figuring in March 1st), find the month index (integer division by 30.6),
3608 * and the remainder is the day-of-month. We then have to convert back to
3609 * 'real' months (including fixing January and February from being 14/15 in
3610 * the previous year to being in the proper year). After that, to get
3611 * tm_yday, we work with the normalised year and get a new yearday value for
3612 * January 1st, which we subtract from the yearday value we had earlier,
3613 * representing the date we've re-built. This is done from January 1
3614 * because tm_yday is 0-origin.
3615 *
3616 * Since POSIX time routines are only guaranteed to work for times since the
3617 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3618 * applies Gregorian calendar rules even to dates before the 16th century
3619 * doesn't bother me. Besides, you'd need cultural context for a given
3620 * date to know whether it was Julian or Gregorian calendar, and that's
3621 * outside the scope for this routine. Since we convert back based on the
3622 * same rules we used to build the yearday, you'll only get strange results
3623 * for input which needed normalising, or for the 'odd' century years which
486ec47a 3624 * were leap years in the Julian calendar but not in the Gregorian one.
e72cf795
JH
3625 * I can live with that.
3626 *
3627 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3628 * that's still outside the scope for POSIX time manipulation, so I don't
3629 * care.
63f7ae8a 3630 *
efdde84a 3631 * - lwall
e72cf795
JH
3632 */
3633
3634 year = 1900 + ptm->tm_year;
3635 month = ptm->tm_mon;
3636 mday = ptm->tm_mday;
a64f08cb 3637 jday = 0;
e72cf795
JH
3638 if (month >= 2)
3639 month+=2;
3640 else
3641 month+=14, year--;
3642 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3643 yearday += month*MONTH_TO_DAYS + mday + jday;
3644 /*
3645 * Note that we don't know when leap-seconds were or will be,
3646 * so we have to trust the user if we get something which looks
3647 * like a sensible leap-second. Wild values for seconds will
3648 * be rationalised, however.
3649 */
3650 if ((unsigned) ptm->tm_sec <= 60) {
3651 secs = 0;
3652 }
3653 else {
3654 secs = ptm->tm_sec;
3655 ptm->tm_sec = 0;
3656 }
3657 secs += 60 * ptm->tm_min;
3658 secs += SECS_PER_HOUR * ptm->tm_hour;
3659 if (secs < 0) {
3660 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3661 /* got negative remainder, but need positive time */
3662 /* back off an extra day to compensate */
3663 yearday += (secs/SECS_PER_DAY)-1;
3664 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3665 }
3666 else {
3667 yearday += (secs/SECS_PER_DAY);
3668 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3669 }
3670 }
3671 else if (secs >= SECS_PER_DAY) {
3672 yearday += (secs/SECS_PER_DAY);
3673 secs %= SECS_PER_DAY;
3674 }
3675 ptm->tm_hour = secs/SECS_PER_HOUR;
3676 secs %= SECS_PER_HOUR;
3677 ptm->tm_min = secs/60;
3678 secs %= 60;
3679 ptm->tm_sec += secs;
3680 /* done with time of day effects */
3681 /*
3682 * The algorithm for yearday has (so far) left it high by 428.
3683 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3684 * bias it by 123 while trying to figure out what year it
3685 * really represents. Even with this tweak, the reverse
3686 * translation fails for years before A.D. 0001.
3687 * It would still fail for Feb 29, but we catch that one below.
3688 */
3689 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3690 yearday -= YEAR_ADJUST;
3691 year = (yearday / DAYS_PER_QCENT) * 400;
3692 yearday %= DAYS_PER_QCENT;
3693 odd_cent = yearday / DAYS_PER_CENT;
3694 year += odd_cent * 100;
3695 yearday %= DAYS_PER_CENT;
3696 year += (yearday / DAYS_PER_QYEAR) * 4;
3697 yearday %= DAYS_PER_QYEAR;
3698 odd_year = yearday / DAYS_PER_YEAR;
3699 year += odd_year;
3700 yearday %= DAYS_PER_YEAR;
3701 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3702 month = 1;
3703 yearday = 29;
3704 }
3705 else {
3706 yearday += YEAR_ADJUST; /* recover March 1st crock */
3707 month = yearday*DAYS_TO_MONTH;
3708 yearday -= month*MONTH_TO_DAYS;
3709 /* recover other leap-year adjustment */
3710 if (month > 13) {
3711 month-=14;
3712 year++;
3713 }
3714 else {
3715 month-=2;
3716 }
3717 }
3718 ptm->tm_year = year - 1900;
3719 if (yearday) {
3720 ptm->tm_mday = yearday;
3721 ptm->tm_mon = month;
3722 }
3723 else {
3724 ptm->tm_mday = 31;
3725 ptm->tm_mon = month - 1;
3726 }
3727 /* re-build yearday based on Jan 1 to get tm_yday */
3728 year--;
3729 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3730 yearday += 14*MONTH_TO_DAYS + 1;
3731 ptm->tm_yday = jday - yearday;
a64f08cb 3732 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
e72cf795 3733}
b3c85772
JH
3734
3735char *
e1ec3a88 3736Perl_my_strftime(pTHX_ const char *fmt, int sec, int min, int hour, int mday, int mon, int year, int wday, int yday, int isdst)
b3c85772
JH
3737{
3738#ifdef HAS_STRFTIME
4c17e999 3739
63f7ae8a
KW
3740 /* strftime(), but with a different API so that the return value is a pointer
3741 * to the formatted result (which MUST be arranged to be FREED BY THE
3742 * CALLER). This allows this function to increase the buffer size as needed,
3743 * so that the caller doesn't have to worry about that.
3744 *
3745 * Note that yday and wday effectively are ignored by this function, as
3746 * mini_mktime() overwrites them */
4c17e999 3747
b3c85772
JH
3748 char *buf;
3749 int buflen;
3750 struct tm mytm;
3751 int len;
3752
7918f24d
NC
3753 PERL_ARGS_ASSERT_MY_STRFTIME;
3754
b3c85772
JH
3755 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3756 mytm.tm_sec = sec;
3757 mytm.tm_min = min;
3758 mytm.tm_hour = hour;
3759 mytm.tm_mday = mday;
3760 mytm.tm_mon = mon;
3761 mytm.tm_year = year;
3762 mytm.tm_wday = wday;
3763 mytm.tm_yday = yday;
3764 mytm.tm_isdst = isdst;
3765 mini_mktime(&mytm);
c473feec
SR
3766 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3767#if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3768 STMT_START {
3769 struct tm mytm2;
3770 mytm2 = mytm;
3771 mktime(&mytm2);
3772#ifdef HAS_TM_TM_GMTOFF
3773 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3774#endif
3775#ifdef HAS_TM_TM_ZONE
3776 mytm.tm_zone = mytm2.tm_zone;
3777#endif
3778 } STMT_END;
3779#endif
b3c85772 3780 buflen = 64;
a02a5408 3781 Newx(buf, buflen, char);
5d37acd6 3782
7347ee54 3783 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
b3c85772 3784 len = strftime(buf, buflen, fmt, &mytm);
7347ee54 3785 GCC_DIAG_RESTORE_STMT;
5d37acd6 3786
b3c85772 3787 /*
877f6a72 3788 ** The following is needed to handle to the situation where
b3c85772
JH
3789 ** tmpbuf overflows. Basically we want to allocate a buffer
3790 ** and try repeatedly. The reason why it is so complicated
3791 ** is that getting a return value of 0 from strftime can indicate
3792 ** one of the following:
3793 ** 1. buffer overflowed,
3794 ** 2. illegal conversion specifier, or
3795 ** 3. the format string specifies nothing to be returned(not
3796 ** an error). This could be because format is an empty string
3797 ** or it specifies %p that yields an empty string in some locale.
3798 ** If there is a better way to make it portable, go ahead by
3799 ** all means.
3800 */
3801 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3802 return buf;
3803 else {
3804 /* Possibly buf overflowed - try again with a bigger buf */
e1ec3a88 3805 const int fmtlen = strlen(fmt);
7743c307 3806 int bufsize = fmtlen + buflen;
877f6a72 3807
c4bc4aaa 3808 Renew(buf, bufsize, char);
b3c85772 3809 while (buf) {
5d37acd6 3810
7347ee54 3811 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
b3c85772 3812 buflen = strftime(buf, bufsize, fmt, &mytm);
7347ee54 3813 GCC_DIAG_RESTORE_STMT;
5d37acd6 3814
b3c85772
JH
3815 if (buflen > 0 && buflen < bufsize)
3816 break;
3817 /* heuristic to prevent out-of-memory errors */
3818 if (bufsize > 100*fmtlen) {
3819 Safefree(buf);
3820 buf = NULL;
3821 break;
3822 }
7743c307
SH
3823 bufsize *= 2;
3824 Renew(buf, bufsize, char);
b3c85772
JH
3825 }
3826 return buf;
3827 }
3828#else
3829 Perl_croak(aTHX_ "panic: no strftime");
27da23d5 3830 return NULL;
b3c85772
JH
3831#endif
3832}
3833
877f6a72
NIS
3834
3835#define SV_CWD_RETURN_UNDEF \
e03e82a0
DM
3836 sv_set_undef(sv); \
3837 return FALSE
877f6a72
NIS
3838
3839#define SV_CWD_ISDOT(dp) \
3840 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3aed30dc 3841 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
877f6a72
NIS
3842
3843/*
ccfc67b7
JH
3844=head1 Miscellaneous Functions
3845
89423764 3846=for apidoc getcwd_sv
877f6a72 3847
796b6530 3848Fill C<sv> with current working directory
877f6a72
NIS
3849
3850=cut
3851*/
3852
3853/* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3854 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3855 * getcwd(3) if available
f6bab5f6 3856 * Comments from the original:
877f6a72
NIS
3857 * This is a faster version of getcwd. It's also more dangerous
3858 * because you might chdir out of a directory that you can't chdir
3859 * back into. */
3860
877f6a72 3861int
5aaab254 3862Perl_getcwd_sv(pTHX_ SV *sv)
877f6a72
NIS
3863{
3864#ifndef PERL_MICRO
ea715489 3865 SvTAINTED_on(sv);
ea715489 3866
7918f24d
NC
3867 PERL_ARGS_ASSERT_GETCWD_SV;
3868
8f95b30d
JH
3869#ifdef HAS_GETCWD
3870 {
60e110a8
DM
3871 char buf[MAXPATHLEN];
3872
3aed30dc 3873 /* Some getcwd()s automatically allocate a buffer of the given
60e110a8
DM
3874 * size from the heap if they are given a NULL buffer pointer.
3875 * The problem is that this behaviour is not portable. */
3aed30dc 3876 if (getcwd(buf, sizeof(buf) - 1)) {
42d9b98d 3877 sv_setpv(sv, buf);
3aed30dc
HS
3878 return TRUE;
3879 }
3880 else {
e03e82a0 3881 SV_CWD_RETURN_UNDEF;
3aed30dc 3882 }
8f95b30d
JH
3883 }
3884
3885#else
3886
c623ac67 3887 Stat_t statbuf;
877f6a72 3888 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4373e329 3889 int pathlen=0;
877f6a72 3890 Direntry_t *dp;
877f6a72 3891
862a34c6 3892 SvUPGRADE(sv, SVt_PV);
877f6a72 3893
877f6a72 3894 if (PerlLIO_lstat(".", &statbuf) < 0) {
3aed30dc 3895 SV_CWD_RETURN_UNDEF;
877f6a72
NIS
3896 }
3897
3898 orig_cdev = statbuf.st_dev;
3899 orig_cino = statbuf.st_ino;
3900 cdev = orig_cdev;
3901 cino = orig_cino;
3902
3903 for (;;) {
4373e329 3904 DIR *dir;
f56ed502 3905 int namelen;
3aed30dc
HS
3906 odev = cdev;
3907 oino = cino;
3908
3909 if (PerlDir_chdir("..") < 0) {
3910 SV_CWD_RETURN_UNDEF;
3911 }
3912 if (PerlLIO_stat(".", &statbuf) < 0) {
3913 SV_CWD_RETURN_UNDEF;
3914 }
3915
3916 cdev = statbuf.st_dev;
3917 cino = statbuf.st_ino;
3918
3919 if (odev == cdev && oino == cino) {
3920 break;
3921 }
3922 if (!(dir = PerlDir_open("."))) {
3923 SV_CWD_RETURN_UNDEF;
3924 }
3925
3926 while ((dp = PerlDir_read(dir)) != NULL) {
877f6a72 3927#ifdef DIRNAMLEN
f56ed502 3928 namelen = dp->d_namlen;
877f6a72 3929#else
f56ed502 3930 namelen = strlen(dp->d_name);
877f6a72 3931#endif
3aed30dc
HS
3932 /* skip . and .. */
3933 if (SV_CWD_ISDOT(dp)) {
3934 continue;
3935 }
3936
3937 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
3938 SV_CWD_RETURN_UNDEF;
3939 }
3940
3941 tdev = statbuf.st_dev;
3942 tino = statbuf.st_ino;
3943 if (tino == oino && tdev == odev) {
3944 break;
3945 }
cb5953d6
JH
3946 }
3947
3aed30dc
HS
3948 if (!dp) {
3949 SV_CWD_RETURN_UNDEF;
3950 }
3951
3952 if (pathlen + namelen + 1 >= MAXPATHLEN) {
3953 SV_CWD_RETURN_UNDEF;
3954 }
877f6a72 3955
3aed30dc
HS
3956 SvGROW(sv, pathlen + namelen + 1);
3957
3958 if (pathlen) {
3959 /* shift down */
95a20fc0 3960 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
3aed30dc 3961 }
877f6a72 3962
3aed30dc
HS
3963 /* prepend current directory to the front */
3964 *SvPVX(sv) = '/';
3965 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
3966 pathlen += (namelen + 1);
877f6a72
NIS
3967
3968#ifdef VOID_CLOSEDIR
3aed30dc 3969 PerlDir_close(dir);
877f6a72 3970#else
3aed30dc
HS
3971 if (PerlDir_close(dir) < 0) {
3972 SV_CWD_RETURN_UNDEF;
3973 }
877f6a72
NIS
3974#endif
3975 }
3976
60e110a8 3977 if (pathlen) {
3aed30dc
HS
3978 SvCUR_set(sv, pathlen);
3979 *SvEND(sv) = '\0';
3980 SvPOK_only(sv);
877f6a72 3981
95a20fc0 3982 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
3aed30dc
HS
3983 SV_CWD_RETURN_UNDEF;
3984 }
877f6a72
NIS
3985 }
3986 if (PerlLIO_stat(".", &statbuf) < 0) {
3aed30dc 3987 SV_CWD_RETURN_UNDEF;
877f6a72
NIS
3988 }
3989
3990 cdev = statbuf.st_dev;
3991 cino = statbuf.st_ino;
3992
3993 if (cdev != orig_cdev || cino != orig_cino) {
3aed30dc
HS
3994 Perl_croak(aTHX_ "Unstable directory path, "
3995 "current directory changed unexpectedly");
877f6a72 3996 }
877f6a72
NIS
3997
3998 return TRUE;
793b8d8e
JH
3999#endif
4000
877f6a72
NIS
4001#else
4002 return FALSE;
4003#endif
4004}
4005
abc6d738 4006#include "vutil.c"
ad63d80f 4007
c95c94b1 4008#if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
2bc69dc4
NIS
4009# define EMULATE_SOCKETPAIR_UDP
4010#endif
4011
4012#ifdef EMULATE_SOCKETPAIR_UDP
02fc2eee
NC
4013static int
4014S_socketpair_udp (int fd[2]) {
e10bb1e9 4015 dTHX;
02fc2eee
NC
4016 /* Fake a datagram socketpair using UDP to localhost. */
4017 int sockets[2] = {-1, -1};
4018 struct sockaddr_in addresses[2];
4019 int i;
3aed30dc 4020 Sock_size_t size = sizeof(struct sockaddr_in);
ae92b34e 4021 unsigned short port;
02fc2eee
NC
4022 int got;
4023
3aed30dc 4024 memset(&addresses, 0, sizeof(addresses));
02fc2eee
NC
4025 i = 1;
4026 do {
3aed30dc
HS
4027 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4028 if (sockets[i] == -1)
4029 goto tidy_up_and_fail;
4030
4031 addresses[i].sin_family = AF_INET;
4032 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4033 addresses[i].sin_port = 0; /* kernel choses port. */
4034 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4035 sizeof(struct sockaddr_in)) == -1)
4036 goto tidy_up_and_fail;
02fc2eee
NC
4037 } while (i--);
4038
4039 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4040 for each connect the other socket to it. */
4041 i = 1;
4042 do {
3aed30dc
HS
4043 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4044 &size) == -1)
4045 goto tidy_up_and_fail;
4046 if (size != sizeof(struct sockaddr_in))
4047 goto abort_tidy_up_and_fail;
4048 /* !1 is 0, !0 is 1 */
4049 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4050 sizeof(struct sockaddr_in)) == -1)
4051 goto tidy_up_and_fail;
02fc2eee
NC
4052 } while (i--);
4053
4054 /* Now we have 2 sockets connected to each other. I don't trust some other
4055 process not to have already sent a packet to us (by random) so send
4056 a packet from each to the other. */
4057 i = 1;
4058 do {
3aed30dc
HS
4059 /* I'm going to send my own port number. As a short.
4060 (Who knows if someone somewhere has sin_port as a bitfield and needs
4061 this routine. (I'm assuming crays have socketpair)) */
4062 port = addresses[i].sin_port;
4063 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4064 if (got != sizeof(port)) {
4065 if (got == -1)
4066 goto tidy_up_and_fail;
4067 goto abort_tidy_up_and_fail;
4068 }
02fc2eee
NC
4069 } while (i--);
4070
4071 /* Packets sent. I don't trust them to have arrived though.
4072 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4073 connect to localhost will use a second kernel thread. In 2.6 the
4074 first thread running the connect() returns before the second completes,
4075 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4076 returns 0. Poor programs have tripped up. One poor program's authors'
4077 had a 50-1 reverse stock split. Not sure how connected these were.)
4078 So I don't trust someone not to have an unpredictable UDP stack.
4079 */
4080
4081 {
3aed30dc
HS
4082 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4083 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4084 fd_set rset;
4085
4086 FD_ZERO(&rset);
ea407a0c
NC
4087 FD_SET((unsigned int)sockets[0], &rset);
4088 FD_SET((unsigned int)sockets[1], &rset);
3aed30dc
HS
4089
4090 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4091 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4092 || !FD_ISSET(sockets[1], &rset)) {
4093 /* I hope this is portable and appropriate. */
4094 if (got == -1)
4095 goto tidy_up_and_fail;
4096 goto abort_tidy_up_and_fail;
4097 }
02fc2eee 4098 }
f4758303 4099
02fc2eee
NC
4100 /* And the paranoia department even now doesn't trust it to have arrive
4101 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4102 {
3aed30dc
HS
4103 struct sockaddr_in readfrom;
4104 unsigned short buffer[2];
02fc2eee 4105
3aed30dc
HS
4106 i = 1;
4107 do {
02fc2eee 4108#ifdef MSG_DONTWAIT
3aed30dc
HS
4109 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4110 sizeof(buffer), MSG_DONTWAIT,
4111 (struct sockaddr *) &readfrom, &size);
02fc2eee 4112#else
3aed30dc
HS
4113 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4114 sizeof(buffer), 0,
4115 (struct sockaddr *) &readfrom, &size);
e10bb1e9 4116#endif
02fc2eee 4117
3aed30dc
HS
4118 if (got == -1)
4119 goto tidy_up_and_fail;
4120 if (got != sizeof(port)
4121 || size != sizeof(struct sockaddr_in)
4122 /* Check other socket sent us its port. */
4123 || buffer[0] != (unsigned short) addresses[!i].sin_port
4124 /* Check kernel says we got the datagram from that socket */
4125 || readfrom.sin_family != addresses[!i].sin_family
4126 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4127 || readfrom.sin_port != addresses[!i].sin_port)
4128 goto abort_tidy_up_and_fail;
4129 } while (i--);
02fc2eee
NC
4130 }
4131 /* My caller (my_socketpair) has validated that this is non-NULL */
4132 fd[0] = sockets[0];
4133 fd[1] = sockets[1];
4134 /* I hereby declare this connection open. May God bless all who cross
4135 her. */
4136 return 0;
4137
4138 abort_tidy_up_and_fail:
4139 errno = ECONNABORTED;
4140 tidy_up_and_fail:
4141 {
4ee39169 4142 dSAVE_ERRNO;
3aed30dc
HS
4143 if (sockets[0] != -1)
4144 PerlLIO_close(sockets[0]);
4145 if (sockets[1] != -1)
4146 PerlLIO_close(sockets[1]);
4ee39169 4147 RESTORE_ERRNO;
3aed30dc 4148 return -1;
02fc2eee
NC
4149 }
4150}
85ca448a 4151#endif /* EMULATE_SOCKETPAIR_UDP */
02fc2eee 4152
b5ac89c3 4153#if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
02fc2eee
NC
4154int
4155Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4156 /* Stevens says that family must be AF_LOCAL, protocol 0.
2948e0bd 4157 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
2bcd6579 4158 dTHXa(NULL);
02fc2eee
NC
4159 int listener = -1;
4160 int connector = -1;
4161 int acceptor = -1;
4162 struct sockaddr_in listen_addr;
4163 struct sockaddr_in connect_addr;
4164 Sock_size_t size;
4165
50458334
JH
4166 if (protocol
4167#ifdef AF_UNIX
4168 || family != AF_UNIX
4169#endif
3aed30dc
HS
4170 ) {
4171 errno = EAFNOSUPPORT;
4172 return -1;
02fc2eee 4173 }
2948e0bd 4174 if (!fd) {
3aed30dc
HS
4175 errno = EINVAL;
4176 return -1;
2948e0bd 4177 }
02fc2eee 4178
a50ffd24
Z
4179#ifdef SOCK_CLOEXEC
4180 type &= ~SOCK_CLOEXEC;
4181#endif
4182
2bc69dc4 4183#ifdef EMULATE_SOCKETPAIR_UDP
02fc2eee 4184 if (type == SOCK_DGRAM)
3aed30dc 4185 return S_socketpair_udp(fd);
2bc69dc4 4186#endif
02fc2eee 4187
2bcd6579 4188 aTHXa(PERL_GET_THX);
3aed30dc 4189 listener = PerlSock_socket(AF_INET, type, 0);
02fc2eee 4190 if (listener == -1)
3aed30dc
HS
4191 return -1;
4192 memset(&listen_addr, 0, sizeof(listen_addr));
02fc2eee 4193 listen_addr.sin_family = AF_INET;
3aed30dc 4194 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
02fc2eee 4195 listen_addr.sin_port = 0; /* kernel choses port. */
3aed30dc
HS
4196 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4197 sizeof(listen_addr)) == -1)
4198 goto tidy_up_and_fail;
e10bb1e9 4199 if (PerlSock_listen(listener, 1) == -1)
3aed30dc 4200 goto tidy_up_and_fail;
02fc2eee 4201
3aed30dc 4202 connector = PerlSock_socket(AF_INET, type, 0);
02fc2eee 4203 if (connector == -1)
3aed30dc 4204 goto tidy_up_and_fail;
02fc2eee 4205 /* We want to find out the port number to connect to. */
3aed30dc
HS
4206 size = sizeof(connect_addr);
4207 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4208 &size) == -1)
4209 goto tidy_up_and_fail;
4210 if (size != sizeof(connect_addr))
4211 goto abort_tidy_up_and_fail;
e10bb1e9 4212 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
3aed30dc
HS
4213 sizeof(connect_addr)) == -1)
4214 goto tidy_up_and_fail;
02fc2eee 4215
3aed30dc
HS
4216 size = sizeof(listen_addr);
4217 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4218 &size);
02fc2eee 4219 if (acceptor == -1)
3aed30dc
HS
4220 goto tidy_up_and_fail;
4221 if (size != sizeof(listen_addr))
4222 goto abort_tidy_up_and_fail;
4223 PerlLIO_close(listener);
02fc2eee
NC
4224 /* Now check we are talking to ourself by matching port and host on the
4225 two sockets. */
3aed30dc
HS
4226 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4227 &size) == -1)
4228 goto tidy_up_and_fail;
4229 if (size != sizeof(connect_addr)
4230 || listen_addr.sin_family != connect_addr.sin_family
4231 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4232 || listen_addr.sin_port != connect_addr.sin_port) {
4233 goto abort_tidy_up_and_fail;
02fc2eee
NC
4234 }
4235 fd[0] = connector;
4236 fd[1] = acceptor;
4237 return 0;
4238
4239 abort_tidy_up_and_fail:
27da23d5
JH
4240#ifdef ECONNABORTED
4241 errno = ECONNABORTED; /* This would be the standard thing to do. */
8ad758c7 4242#elif defined(ECONNREFUSED)
27da23d5 4243 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
8ad758c7 4244#else
27da23d5 4245 errno = ETIMEDOUT; /* Desperation time. */
27da23d5 4246#endif
02fc2eee
NC
4247 tidy_up_and_fail:
4248 {
4ee39169 4249 dSAVE_ERRNO;
3aed30dc
HS
4250 if (listener != -1)
4251 PerlLIO_close(listener);
4252 if (connector != -1)
4253 PerlLIO_close(connector);
4254 if (acceptor != -1)
4255 PerlLIO_close(acceptor);
4ee39169 4256 RESTORE_ERRNO;
3aed30dc 4257 return -1;
02fc2eee
NC
4258 }
4259}
85ca448a 4260#else
48ea76d1 4261/* In any case have a stub so that there's code corresponding
d500e60d 4262 * to the my_socketpair in embed.fnc. */
48ea76d1
JH
4263int
4264Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
daf16542 4265#ifdef HAS_SOCKETPAIR
48ea76d1 4266 return socketpair(family, type, protocol, fd);
daf16542
JH
4267#else
4268 return -1;
4269#endif
48ea76d1
JH
4270}
4271#endif
4272
68795e93
NIS
4273/*
4274
4275=for apidoc sv_nosharing
4276
4277Dummy routine which "shares" an SV when there is no sharing module present.
72d33970
FC
4278Or "locks" it. Or "unlocks" it. In other
4279words, ignores its single SV argument.
796b6530 4280Exists to avoid test for a C<NULL> function pointer and because it could
d5b2b27b 4281potentially warn under some level of strict-ness.
68795e93
NIS
4282
4283=cut
4284*/
4285
4286void
4287Perl_sv_nosharing(pTHX_ SV *sv)
4288{
96a5add6 4289 PERL_UNUSED_CONTEXT;
53c1dcc0 4290 PERL_UNUSED_ARG(sv);
68795e93
NIS
4291}
4292
eba16661
JH
4293/*
4294
4295=for apidoc sv_destroyable
4296
4297Dummy routine which reports that object can be destroyed when there is no
4298sharing module present. It ignores its single SV argument, and returns
796b6530 4299'true'. Exists to avoid test for a C<NULL> function pointer and because it
eba16661
JH
4300could potentially warn under some level of strict-ness.
4301
4302=cut
4303*/
4304
4305bool
4306Perl_sv_destroyable(pTHX_ SV *sv)
4307{
4308 PERL_UNUSED_CONTEXT;
4309 PERL_UNUSED_ARG(sv);
4310 return TRUE;
4311}
4312
a05d7ebb 4313U32
e1ec3a88 4314Perl_parse_unicode_opts(pTHX_ const char **popt)
a05d7ebb 4315{
e1ec3a88 4316 const char *p = *popt;
a05d7ebb
JH
4317 U32 opt = 0;
4318
7918f24d
NC
4319 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4320
a05d7ebb
JH
4321 if (*p) {
4322 if (isDIGIT(*p)) {
96e440d2 4323 const char* endptr;
22ff3130 4324 UV uv;
89d84ff9 4325 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
22ff3130 4326 opt = (U32)uv;
89d84ff9
HS
4327 p = endptr;
4328 if (p && *p && *p != '\n' && *p != '\r') {
4329 if (isSPACE(*p))
4330 goto the_end_of_the_opts_parser;
4331 else
4332 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4333 }
22ff3130 4334 }
817e3e2c
TC
4335 else {
4336 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4337 }
22ff3130
HS
4338 }
4339 else {
a05d7ebb
JH
4340 for (; *p; p++) {
4341 switch (*p) {
4342 case PERL_UNICODE_STDIN:
4343 opt |= PERL_UNICODE_STDIN_FLAG; break;
4344 case PERL_UNICODE_STDOUT:
4345 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4346 case PERL_UNICODE_STDERR:
4347 opt |= PERL_UNICODE_STDERR_FLAG; break;
4348 case PERL_UNICODE_STD:
4349 opt |= PERL_UNICODE_STD_FLAG; break;
4350 case PERL_UNICODE_IN:
4351 opt |= PERL_UNICODE_IN_FLAG; break;
4352 case PERL_UNICODE_OUT:
4353 opt |= PERL_UNICODE_OUT_FLAG; break;
4354 case PERL_UNICODE_INOUT:
4355 opt |= PERL_UNICODE_INOUT_FLAG; break;
4356 case PERL_UNICODE_LOCALE:
4357 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4358 case PERL_UNICODE_ARGV:
4359 opt |= PERL_UNICODE_ARGV_FLAG; break;
5a22a2bb
NC
4360 case PERL_UNICODE_UTF8CACHEASSERT:
4361 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
a05d7ebb 4362 default:
d4a59e54
FC
4363 if (*p != '\n' && *p != '\r') {
4364 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4365 else
7c91f477
JH
4366 Perl_croak(aTHX_
4367 "Unknown Unicode option letter '%c'", *p);
d4a59e54 4368 }
a05d7ebb
JH
4369 }
4370 }
4371 }
4372 }
4373 else
4374 opt = PERL_UNICODE_DEFAULT_FLAGS;
4375
d4a59e54
FC
4376 the_end_of_the_opts_parser:
4377
a05d7ebb 4378 if (opt & ~PERL_UNICODE_ALL_FLAGS)
147e3846 4379 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
a05d7ebb
JH
4380 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4381
4382 *popt = p;
4383
4384 return opt;
4385}
4386
25bbd826
CB
4387#ifdef VMS
4388# include <starlet.h>
4389#endif
4390
132efe8b
JH
4391U32
4392Perl_seed(pTHX)
4393{
4394 /*
4395 * This is really just a quick hack which grabs various garbage
4396 * values. It really should be a real hash algorithm which
4397 * spreads the effect of every input bit onto every output bit,
4398 * if someone who knows about such things would bother to write it.
4399 * Might be a good idea to add that function to CORE as well.
4400 * No numbers below come from careful analysis or anything here,
4401 * except they are primes and SEED_C1 > 1E6 to get a full-width
4402 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4403 * probably be bigger too.
4404 */
4405#if RANDBITS > 16
4406# define SEED_C1 1000003
4407#define SEED_C4 73819
4408#else
4409# define SEED_C1 25747
4410#define SEED_C4 20639
4411#endif
4412#define SEED_C2 3
4413#define SEED_C3 269
4414#define SEED_C5 26107
4415
4416#ifndef PERL_NO_DEV_RANDOM
4417 int fd;
4418#endif
4419 U32 u;
95a8bf05 4420#ifdef HAS_GETTIMEOFDAY
132efe8b 4421 struct timeval when;
95a8bf05 4422#else
132efe8b 4423 Time_t when;
132efe8b
JH
4424#endif
4425
4426/* This test is an escape hatch, this symbol isn't set by Configure. */
4427#ifndef PERL_NO_DEV_RANDOM
4428#ifndef PERL_RANDOM_DEVICE
4429 /* /dev/random isn't used by default because reads from it will block
4430 * if there isn't enough entropy available. You can compile with
4431 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4432 * is enough real entropy to fill the seed. */
afa49a03
AB
4433# ifdef __amigaos4__
4434# define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4435# else
4436# define PERL_RANDOM_DEVICE "/dev/urandom"
4437# endif
132efe8b 4438#endif
74df577f 4439 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
132efe8b 4440 if (fd != -1) {
27da23d5 4441 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
132efe8b
JH
4442 u = 0;
4443 PerlLIO_close(fd);
4444 if (u)
4445 return u;
4446 }
4447#endif
4448
95a8bf05 4449#ifdef HAS_GETTIMEOFDAY
132efe8b
JH
4450 PerlProc_gettimeofday(&when,NULL);
4451 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
95a8bf05 4452#else
132efe8b
JH
4453 (void)time(&when);
4454 u = (U32)SEED_C1 * when;
132efe8b
JH
4455#endif
4456 u += SEED_C3 * (U32)PerlProc_getpid();
4457 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4458#ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4459 u += SEED_C5 * (U32)PTR2UV(&when);
4460#endif
4461 return u;
4462}
4463
7dc86639 4464void
a2098e20 4465Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
bed60192 4466{
95309d6b 4467#ifndef NO_PERL_HASH_ENV
a2098e20 4468 const char *env_pv;
95309d6b 4469#endif
a2098e20 4470 unsigned long i;
7dc86639
YO
4471
4472 PERL_ARGS_ASSERT_GET_HASH_SEED;
bed60192 4473
95309d6b 4474#ifndef NO_PERL_HASH_ENV
a2098e20 4475 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
7dc86639 4476
a2098e20 4477 if ( env_pv )
7dc86639 4478 {
a2098e20
YO
4479 /* ignore leading spaces */
4480 while (isSPACE(*env_pv))
4481 env_pv++;
95309d6b 4482# ifdef USE_PERL_PERTURB_KEYS
a2098e20
YO
4483 /* if they set it to "0" we disable key traversal randomization completely */
4484 if (strEQ(env_pv,"0")) {
6a5b4183
YO
4485 PL_hash_rand_bits_enabled= 0;
4486 } else {
a2098e20 4487 /* otherwise switch to deterministic mode */
6a5b4183
YO
4488 PL_hash_rand_bits_enabled= 2;
4489 }
95309d6b 4490# endif
a2098e20
YO
4491 /* ignore a leading 0x... if it is there */
4492 if (env_pv[0] == '0' && env_pv[1] == 'x')
4493 env_pv += 2;
bed60192 4494
a2098e20
YO
4495 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4496 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4497 if ( isXDIGIT(*env_pv)) {
4498 seed_buffer[i] |= READ_XDIGIT(env_pv);
7dc86639 4499 }
7dc86639 4500 }
a2098e20
YO
4501 while (isSPACE(*env_pv))
4502 env_pv++;
4503
4504 if (*env_pv && !isXDIGIT(*env_pv)) {
aac486f1 4505 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
73cf895c 4506 }
7dc86639 4507 /* should we check for unparsed crap? */
a2098e20
YO
4508 /* should we warn about unused hex? */
4509 /* should we warn about insufficient hex? */
7dc86639
YO
4510 }
4511 else
1a237f4f 4512#endif /* NO_PERL_HASH_ENV */
7dc86639 4513 {
a2098e20 4514 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
f26b33bd 4515 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
7dc86639 4516 }
0e0ab621 4517 }
6a5b4183 4518#ifdef USE_PERL_PERTURB_KEYS
0e0ab621
YO
4519 { /* initialize PL_hash_rand_bits from the hash seed.
4520 * This value is highly volatile, it is updated every
4521 * hash insert, and is used as part of hash bucket chain
4522 * randomization and hash iterator randomization. */
a2098e20 4523 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
0e0ab621 4524 for( i = 0; i < sizeof(UV) ; i++ ) {
6a5b4183
YO
4525 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4526 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
0e0ab621
YO
4527 }
4528 }
95309d6b 4529# ifndef NO_PERL_HASH_ENV
a2098e20
YO
4530 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4531 if (env_pv) {
4532 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
6a5b4183 4533 PL_hash_rand_bits_enabled= 0;
a2098e20 4534 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
6a5b4183 4535 PL_hash_rand_bits_enabled= 1;
a2098e20 4536 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
6a5b4183
YO
4537 PL_hash_rand_bits_enabled= 2;
4538 } else {
a2098e20 4539 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
6a5b4183
YO
4540 }
4541 }
95309d6b 4542# endif
6a5b4183 4543#endif
bed60192 4544}
27da23d5
JH
4545
4546#ifdef PERL_GLOBAL_STRUCT
4547
bae1192d
JH
4548#define PERL_GLOBAL_STRUCT_INIT
4549#include "opcode.h" /* the ppaddr and check */
4550
27da23d5
JH
4551struct perl_vars *
4552Perl_init_global_struct(pTHX)
4553{
4554 struct perl_vars *plvarsp = NULL;
bae1192d 4555# ifdef PERL_GLOBAL_STRUCT
c3caa5c3
JH
4556 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4557 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
23491f1d 4558 PERL_UNUSED_CONTEXT;
27da23d5
JH
4559# ifdef PERL_GLOBAL_STRUCT_PRIVATE
4560 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4561 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4562 if (!plvarsp)
4563 exit(1);
4564# else
4565 plvarsp = PL_VarsPtr;
4566# endif /* PERL_GLOBAL_STRUCT_PRIVATE */
aadb217d
JH
4567# undef PERLVAR
4568# undef PERLVARA
4569# undef PERLVARI
4570# undef PERLVARIC
115ff745
NC
4571# define PERLVAR(prefix,var,type) /**/
4572# define PERLVARA(prefix,var,n,type) /**/
4573# define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4574# define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
27da23d5
JH
4575# include "perlvars.h"
4576# undef PERLVAR
4577# undef PERLVARA
4578# undef PERLVARI
4579# undef PERLVARIC
27da23d5 4580# ifdef PERL_GLOBAL_STRUCT
bae1192d
JH
4581 plvarsp->Gppaddr =
4582 (Perl_ppaddr_t*)
4583 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
27da23d5
JH
4584 if (!plvarsp->Gppaddr)
4585 exit(1);
bae1192d
JH
4586 plvarsp->Gcheck =
4587 (Perl_check_t*)
4588 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
27da23d5
JH
4589 if (!plvarsp->Gcheck)
4590 exit(1);
4591 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4592 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4593# endif
4594# ifdef PERL_SET_VARS
4595 PERL_SET_VARS(plvarsp);
4596# endif
5c64bffd
NC
4597# ifdef PERL_GLOBAL_STRUCT_PRIVATE
4598 plvarsp->Gsv_placeholder.sv_flags = 0;
4599 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4600# endif
bae1192d
JH
4601# undef PERL_GLOBAL_STRUCT_INIT
4602# endif
27da23d5
JH
4603 return plvarsp;
4604}
4605
4606#endif /* PERL_GLOBAL_STRUCT */
4607
4608#ifdef PERL_GLOBAL_STRUCT
4609
4610void
4611Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4612{
c1181d2b
DM
4613 int veto = plvarsp->Gveto_cleanup;
4614
7918f24d 4615 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
23491f1d 4616 PERL_UNUSED_CONTEXT;
bae1192d 4617# ifdef PERL_GLOBAL_STRUCT
27da23d5
JH
4618# ifdef PERL_UNSET_VARS
4619 PERL_UNSET_VARS(plvarsp);
4620# endif
c1181d2b
DM
4621 if (veto)
4622 return;
27da23d5
JH
4623 free(plvarsp->Gppaddr);
4624 free(plvarsp->Gcheck);
bae1192d 4625# ifdef PERL_GLOBAL_STRUCT_PRIVATE
27da23d5 4626 free(plvarsp);
bae1192d
JH
4627# endif
4628# endif
27da23d5
JH
4629}
4630
4631#endif /* PERL_GLOBAL_STRUCT */
4632
fe4f188c
JH
4633#ifdef PERL_MEM_LOG
4634
22ff3130 4635/* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
73d1d973
JC
4636 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4637 * given, and you supply your own implementation.
65ceff02 4638 *
2e5b5004 4639 * The default implementation reads a single env var, PERL_MEM_LOG,
1cd8acb5
JC
4640 * expecting one or more of the following:
4641 *
22ff3130 4642 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
2e5b5004 4643 * 'm' - memlog was PERL_MEM_LOG=1
1cd8acb5
JC
4644 * 's' - svlog was PERL_SV_LOG=1
4645 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
0b0ab801 4646 *
1cd8acb5
JC
4647 * This makes the logger controllable enough that it can reasonably be
4648 * added to the system perl.
65ceff02
JH
4649 */
4650
1cd8acb5 4651/* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
65ceff02
JH
4652 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4653 */
e352bcff
JH
4654#define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4655
1cd8acb5
JC
4656/* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4657 * writes to. In the default logger, this is settable at runtime.
65ceff02
JH
4658 */
4659#ifndef PERL_MEM_LOG_FD
4660# define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4661#endif
4662
73d1d973 4663#ifndef PERL_MEM_LOG_NOIMPL
d7a2c63c
MHM
4664
4665# ifdef DEBUG_LEAKING_SCALARS
4666# define SV_LOG_SERIAL_FMT " [%lu]"
4667# define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4668# else
4669# define SV_LOG_SERIAL_FMT
4670# define _SV_LOG_SERIAL_ARG(sv)
4671# endif
4672
0b0ab801 4673static void
73d1d973
JC
4674S_mem_log_common(enum mem_log_type mlt, const UV n,
4675 const UV typesize, const char *type_name, const SV *sv,
4676 Malloc_t oldalloc, Malloc_t newalloc,
4677 const char *filename, const int linenumber,
4678 const char *funcname)
0b0ab801 4679{
1cd8acb5 4680 const char *pmlenv;
4ca7bcef 4681
1cd8acb5 4682 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4ca7bcef 4683
1cd8acb5
JC
4684 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4685 if (!pmlenv)
4686 return;
4687 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
65ceff02
JH
4688 {
4689 /* We can't use SVs or PerlIO for obvious reasons,
4690 * so we'll use stdio and low-level IO instead. */
4691 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
1cd8acb5 4692
5b692037 4693# ifdef HAS_GETTIMEOFDAY
0b0ab801
MHM
4694# define MEM_LOG_TIME_FMT "%10d.%06d: "
4695# define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4696 struct timeval tv;
65ceff02 4697 gettimeofday(&tv, 0);
0b0ab801
MHM
4698# else
4699# define MEM_LOG_TIME_FMT "%10d: "
4700# define MEM_LOG_TIME_ARG (int)when
4701 Time_t when;
4702 (void)time(&when);
5b692037
JH
4703# endif
4704 /* If there are other OS specific ways of hires time than
d0b0e707 4705 * gettimeofday() (see dist/Time-HiRes), the easiest way is
5b692037
JH
4706 * probably that they would be used to fill in the struct
4707 * timeval. */
65ceff02 4708 {
0b0ab801 4709 STRLEN len;
96e440d2 4710 const char* endptr;
22ff3130
HS
4711 int fd;
4712 UV uv;
4713 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4714 && uv && uv <= PERL_INT_MAX
4715 ) {
4716 fd = (int)uv;
4717 } else {
1cd8acb5 4718 fd = PERL_MEM_LOG_FD;
22ff3130 4719 }
0b0ab801 4720
1cd8acb5 4721 if (strchr(pmlenv, 't')) {
0b0ab801
MHM
4722 len = my_snprintf(buf, sizeof(buf),
4723 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
acfd4d8e 4724 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
0b0ab801 4725 }
0b0ab801
MHM
4726 switch (mlt) {
4727 case MLT_ALLOC:
4728 len = my_snprintf(buf, sizeof(buf),
147e3846
KW
4729 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4730 " %s = %" IVdf ": %" UVxf "\n",
0b0ab801 4731 filename, linenumber, funcname, n, typesize,
bef8a128 4732 type_name, n * typesize, PTR2UV(newalloc));
0b0ab801
MHM
4733 break;
4734 case MLT_REALLOC:
4735 len = my_snprintf(buf, sizeof(buf),
147e3846
KW
4736 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4737 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
0b0ab801 4738 filename, linenumber, funcname, n, typesize,
bef8a128 4739 type_name, n * typesize, PTR2UV(oldalloc),
0b0ab801
MHM
4740 PTR2UV(newalloc));
4741 break;
4742 case MLT_FREE:
4743 len = my_snprintf(buf, sizeof(buf),
147e3846 4744 "free: %s:%d:%s: %" UVxf "\n",
0b0ab801
MHM
4745 filename, linenumber, funcname,
4746 PTR2UV(oldalloc));
4747 break;
d7a2c63c
MHM
4748 case MLT_NEW_SV:
4749 case MLT_DEL_SV:
4750 len = my_snprintf(buf, sizeof(buf),
147e3846 4751 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
d7a2c63c
MHM
4752 mlt == MLT_NEW_SV ? "new" : "del",
4753 filename, linenumber, funcname,
4754 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4755 break;
73d1d973
JC
4756 default:
4757 len = 0;
0b0ab801 4758 }
acfd4d8e 4759 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
65ceff02
JH
4760 }
4761 }
0b0ab801 4762}
73d1d973
JC
4763#endif /* !PERL_MEM_LOG_NOIMPL */
4764
4765#ifndef PERL_MEM_LOG_NOIMPL
4766# define \
4767 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4768 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4769#else
4770/* this is suboptimal, but bug compatible. User is providing their
486ec47a 4771 own implementation, but is getting these functions anyway, and they
73d1d973
JC
4772 do nothing. But _NOIMPL users should be able to cope or fix */
4773# define \
4774 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4775 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
0b0ab801
MHM
4776#endif
4777
4778Malloc_t
73d1d973
JC
4779Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4780 Malloc_t newalloc,
4781 const char *filename, const int linenumber,
4782 const char *funcname)
4783{
6fb87544
MH
4784 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4785
73d1d973
JC
4786 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4787 NULL, NULL, newalloc,
4788 filename, linenumber, funcname);
fe4f188c
JH
4789 return newalloc;
4790}
4791
4792Malloc_t
73d1d973
JC
4793Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4794 Malloc_t oldalloc, Malloc_t newalloc,
4795 const char *filename, const int linenumber,
4796 const char *funcname)
4797{
6fb87544
MH
4798 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4799
73d1d973
JC
4800 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4801 NULL, oldalloc, newalloc,
4802 filename, linenumber, funcname);
fe4f188c
JH
4803 return newalloc;
4804}
4805
4806Malloc_t
73d1d973
JC
4807Perl_mem_log_free(Malloc_t oldalloc,
4808 const char *filename, const int linenumber,
4809 const char *funcname)
fe4f188c 4810{
6fb87544
MH
4811 PERL_ARGS_ASSERT_MEM_LOG_FREE;
4812
73d1d973
JC
4813 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4814 filename, linenumber, funcname);
fe4f188c
JH
4815 return oldalloc;
4816}
4817
d7a2c63c 4818void
73d1d973
JC
4819Perl_mem_log_new_sv(const SV *sv,
4820 const char *filename, const int linenumber,
4821 const char *funcname)
d7a2c63c 4822{
73d1d973
JC
4823 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4824 filename, linenumber, funcname);
d7a2c63c
MHM
4825}
4826
4827void
73d1d973
JC
4828Perl_mem_log_del_sv(const SV *sv,
4829 const char *filename, const int linenumber,
4830 const char *funcname)
d7a2c63c 4831{
73d1d973
JC
4832 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4833 filename, linenumber, funcname);
d7a2c63c
MHM
4834}
4835
fe4f188c
JH
4836#endif /* PERL_MEM_LOG */
4837
66610fdd 4838/*
a4eca1d4
JH
4839=for apidoc quadmath_format_single
4840
796b6530 4841C<quadmath_snprintf()> is very strict about its C<format> string and will
801caa78 4842fail, returning -1, if the format is invalid. It accepts exactly
a4eca1d4
JH
4843one format spec.
4844
796b6530 4845C<quadmath_format_single()> checks that the intended single spec looks
a4eca1d4
JH
4846sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
4847and has C<Q> before it. This is not a full "printf syntax check",
4848just the basics.
4849
4850Returns the format if it is valid, NULL if not.
4851
796b6530 4852C<quadmath_format_single()> can and will actually patch in the missing
a4eca1d4
JH
4853C<Q>, if necessary. In this case it will return the modified copy of
4854the format, B<which the caller will need to free.>
4855
4856See also L</quadmath_format_needed>.
4857
4858=cut
4859*/
4860#ifdef USE_QUADMATH
4861const char*
4862Perl_quadmath_format_single(const char* format)
4863{
4864 STRLEN len;
4865
4866 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
4867
4868 if (format[0] != '%' || strchr(format + 1, '%'))
4869 return NULL;
4870 len = strlen(format);
4871 /* minimum length three: %Qg */
4872 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
4873 return NULL;
4874 if (format[len - 2] != 'Q') {
4875 char* fixed;
4876 Newx(fixed, len + 1, char);
4877 memcpy(fixed, format, len - 1);
4878 fixed[len - 1] = 'Q';
4879 fixed[len ] = format[len - 1];
4880 fixed[len + 1] = 0;
4881 return (const char*)fixed;
4882 }
4883 return format;
4884}
4885#endif
4886
4887/*
4888=for apidoc quadmath_format_needed
4889
796b6530
KW
4890C<quadmath_format_needed()> returns true if the C<format> string seems to
4891contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
a4eca1d4
JH
4892or returns false otherwise.
4893
4894The format specifier detection is not complete printf-syntax detection,
4895but it should catch most common cases.
4896
4897If true is returned, those arguments B<should> in theory be processed
796b6530 4898with C<quadmath_snprintf()>, but in case there is more than one such
a4eca1d4
JH
4899format specifier (see L</quadmath_format_single>), and if there is
4900anything else beyond that one (even just a single byte), they
796b6530 4901B<cannot> be processed because C<quadmath_snprintf()> is very strict,
a4eca1d4
JH
4902accepting only one format spec, and nothing else.
4903In this case, the code should probably fail.
4904
4905=cut
4906*/
4907#ifdef USE_QUADMATH
4908bool
4909Perl_quadmath_format_needed(const char* format)
4910{
4911 const char *p = format;
4912 const char *q;
4913
4914 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
4915
4916 while ((q = strchr(p, '%'))) {
4917 q++;
4918 if (*q == '+') /* plus */
4919 q++;
4920 if (*q == '#') /* alt */
4921 q++;
4922 if (*q == '*') /* width */
4923 q++;
4924 else {
4925 if (isDIGIT(*q)) {
4926 while (isDIGIT(*q)) q++;
4927 }
4928 }
4929 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
4930 q++;
4931 if (*q == '*')
4932 q++;
4933 else
4934 while (isDIGIT(*q)) q++;
4935 }
4936 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
4937 return TRUE;
4938 p = q + 1;
4939 }
4940 return FALSE;
4941}
4942#endif
4943
4944/*
d9fad198
JH
4945=for apidoc my_snprintf
4946
4059ba87
AC
4947The C library C<snprintf> functionality, if available and
4948standards-compliant (uses C<vsnprintf>, actually). However, if the
4949C<vsnprintf> is not available, will unfortunately use the unsafe
4950C<vsprintf> which can overrun the buffer (there is an overrun check,
4951but that may be too late). Consider using C<sv_vcatpvf> instead, or
4952getting C<vsnprintf>.
d9fad198
JH
4953
4954=cut
4955*/
4956int
4957Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
d9fad198 4958{
a4eca1d4 4959 int retval = -1;
d9fad198 4960 va_list ap;
7918f24d 4961 PERL_ARGS_ASSERT_MY_SNPRINTF;
4059ba87
AC
4962#ifndef HAS_VSNPRINTF
4963 PERL_UNUSED_VAR(len);
4964#endif
d9fad198 4965 va_start(ap, format);
a4eca1d4
JH
4966#ifdef USE_QUADMATH
4967 {
4968 const char* qfmt = quadmath_format_single(format);
4969 bool quadmath_valid = FALSE;
4970 if (qfmt) {
4971 /* If the format looked promising, use it as quadmath. */
4972 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
fb926b48 4973 if (retval == -1) {
8b78e936
TC
4974 if (qfmt != format) {
4975 dTHX;
fb926b48 4976 SAVEFREEPV(qfmt);
8b78e936 4977 }
a4eca1d4 4978 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
fb926b48 4979 }
a4eca1d4
JH
4980 quadmath_valid = TRUE;
4981 if (qfmt != format)
4982 Safefree(qfmt);
4983 qfmt = NULL;
4984 }
4985 assert(qfmt == NULL);
4986 /* quadmath_format_single() will return false for example for
4987 * "foo = %g", or simply "%g". We could handle the %g by
4988 * using quadmath for the NV args. More complex cases of
4989 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
4990 * quadmath-valid but has stuff in front).
4991 *
4992 * Handling the "Q-less" cases right would require walking
4993 * through the va_list and rewriting the format, calling
4994 * quadmath for the NVs, building a new va_list, and then
4059ba87 4995 * letting vsnprintf/vsprintf to take care of the other
a4eca1d4
JH
4996 * arguments. This may be doable.
4997 *
4998 * We do not attempt that now. But for paranoia, we here try
4999 * to detect some common (but not all) cases where the
5000 * "Q-less" %[efgaEFGA] formats are present, and die if
5001 * detected. This doesn't fix the problem, but it stops the
4059ba87 5002 * vsnprintf/vsprintf pulling doubles off the va_list when
a4eca1d4
JH
5003 * __float128 NVs should be pulled off instead.
5004 *
5005 * If quadmath_format_needed() returns false, we are reasonably
5006 * certain that we can call vnsprintf() or vsprintf() safely. */
5007 if (!quadmath_valid && quadmath_format_needed(format))
5008 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5009
5010 }
5011#endif
5012 if (retval == -1)
4059ba87 5013#ifdef HAS_VSNPRINTF
a4eca1d4 5014 retval = vsnprintf(buffer, len, format, ap);
4059ba87
AC
5015#else
5016 retval = vsprintf(buffer, format, ap);
5017#endif
d9fad198 5018 va_end(ap);
4059ba87
AC
5019 /* vsprintf() shows failure with < 0 */
5020 if (retval < 0
5021#ifdef HAS_VSNPRINTF
7dac5c64 5022 /* vsnprintf() shows failure with >= len */
4059ba87
AC
5023 ||
5024 (len > 0 && (Size_t)retval >= len)
5025#endif
5026 )
dbf7dff6 5027 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
d9fad198
JH
5028 return retval;
5029}
5030
5031/*
5032=for apidoc my_vsnprintf
5033
4059ba87
AC
5034The C library C<vsnprintf> if available and standards-compliant.
5035However, if if the C<vsnprintf> is not available, will unfortunately
5036use the unsafe C<vsprintf> which can overrun the buffer (there is an
5037overrun check, but that may be too late). Consider using
5038C<sv_vcatpvf> instead, or getting C<vsnprintf>.
d9fad198
JH
5039
5040=cut
5041*/
5042int
5043Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
d9fad198 5044{
a4eca1d4
JH
5045#ifdef USE_QUADMATH
5046 PERL_UNUSED_ARG(buffer);
5047 PERL_UNUSED_ARG(len);
5048 PERL_UNUSED_ARG(format);
bf49eae4
DM
5049 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5050 PERL_UNUSED_ARG((void*)ap);
a4eca1d4
JH
5051 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5052 return 0;
5053#else
d9fad198 5054 int retval;
d9fad198
JH
5055#ifdef NEED_VA_COPY
5056 va_list apc;
7918f24d
NC
5057
5058 PERL_ARGS_ASSERT_MY_VSNPRINTF;
239fec62 5059 Perl_va_copy(ap, apc);
4059ba87 5060# ifdef HAS_VSNPRINTF
d9fad198 5061 retval = vsnprintf(buffer, len, format, apc);
4059ba87
AC
5062# else
5063 PERL_UNUSED_ARG(len);
5064 retval = vsprintf(buffer, format, apc);
5065# endif
d4825b27 5066 va_end(apc);
d9fad198 5067#else
4059ba87 5068# ifdef HAS_VSNPRINTF
d9fad198 5069 retval = vsnprintf(buffer, len, format, ap);
4059ba87
AC
5070# else
5071 PERL_UNUSED_ARG(len);
5072 retval = vsprintf(buffer, format, ap);
5073# endif
5b692037 5074#endif /* #ifdef NEED_VA_COPY */
4059ba87
AC
5075 /* vsprintf() shows failure with < 0 */
5076 if (retval < 0
5077#ifdef HAS_VSNPRINTF
7dac5c64 5078 /* vsnprintf() shows failure with >= len */
4059ba87
AC
5079 ||
5080 (len > 0 && (Size_t)retval >= len)
5081#endif
5082 )
dbf7dff6 5083 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
d9fad198 5084 return retval;
a4eca1d4 5085#endif
d9fad198
JH
5086}
5087
b0269e46
AB
5088void
5089Perl_my_clearenv(pTHX)
5090{
5091 dVAR;
5092#if ! defined(PERL_MICRO)
5093# if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5094 PerlEnv_clearenv();
5095# else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5096# if defined(USE_ENVIRON_ARRAY)
5097# if defined(USE_ITHREADS)
5098 /* only the parent thread can clobber the process environment */
5099 if (PL_curinterp == aTHX)
5100# endif /* USE_ITHREADS */
5101 {
5102# if ! defined(PERL_USE_SAFE_PUTENV)
5103 if ( !PL_use_safe_putenv) {
5104 I32 i;
5105 if (environ == PL_origenviron)
5106 environ = (char**)safesysmalloc(sizeof(char*));
5107 else
5108 for (i = 0; environ[i]; i++)
5109 (void)safesysfree(environ[i]);
5110 }
5111 environ[0] = NULL;
5112# else /* PERL_USE_SAFE_PUTENV */
5113# if defined(HAS_CLEARENV)
5114 (void)clearenv();
5115# elif defined(HAS_UNSETENV)
5116 int bsiz = 80; /* Most envvar names will be shorter than this. */
a96bc635 5117 char *buf = (char*)safesysmalloc(bsiz);
b0269e46
AB
5118 while (*environ != NULL) {
5119 char *e = strchr(*environ, '=');
b57a0404 5120 int l = e ? e - *environ : (int)strlen(*environ);
b0269e46
AB
5121 if (bsiz < l + 1) {
5122 (void)safesysfree(buf);
1bdfa2de 5123 bsiz = l + 1; /* + 1 for the \0. */
a96bc635 5124 buf = (char*)safesysmalloc(bsiz);
b0269e46 5125 }
82d8bb49
NC
5126 memcpy(buf, *environ, l);
5127 buf[l] = '\0';
b0269e46
AB
5128 (void)unsetenv(buf);
5129 }
5130 (void)safesysfree(buf);
5131# else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5132 /* Just null environ and accept the leakage. */
5133 *environ = NULL;
5134# endif /* HAS_CLEARENV || HAS_UNSETENV */
5135# endif /* ! PERL_USE_SAFE_PUTENV */
5136 }
5137# endif /* USE_ENVIRON_ARRAY */
5138# endif /* PERL_IMPLICIT_SYS || WIN32 */
5139#endif /* PERL_MICRO */
5140}
5141
f16dd614
DM
5142#ifdef PERL_IMPLICIT_CONTEXT
5143
53d44271 5144/* Implements the MY_CXT_INIT macro. The first time a module is loaded,
f16dd614
DM
5145the global PL_my_cxt_index is incremented, and that value is assigned to
5146that module's static my_cxt_index (who's address is passed as an arg).
5147Then, for each interpreter this function is called for, it makes sure a
5148void* slot is available to hang the static data off, by allocating or
5149extending the interpreter's PL_my_cxt_list array */
5150
53d44271 5151#ifndef PERL_GLOBAL_STRUCT_PRIVATE
f16dd614
DM
5152void *
5153Perl_my_cxt_init(pTHX_ int *index, size_t size)
5154{
97aff369 5155 dVAR;
f16dd614 5156 void *p;
7918f24d 5157 PERL_ARGS_ASSERT_MY_CXT_INIT;
f16dd614
DM
5158 if (*index == -1) {
5159 /* this module hasn't been allocated an index yet */
5160 MUTEX_LOCK(&PL_my_ctx_mutex);
5161 *index = PL_my_cxt_index++;
5162 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5163 }
5164
5165 /* make sure the array is big enough */
4c901e72
DM
5166 if (PL_my_cxt_size <= *index) {
5167 if (PL_my_cxt_size) {
00195859
HS
5168 IV new_size = PL_my_cxt_size;
5169 while (new_size <= *index)
5170 new_size *= 2;
5171 Renew(PL_my_cxt_list, new_size, void *);
5172 PL_my_cxt_size = new_size;
f16dd614
DM
5173 }
5174 else {
5175 PL_my_cxt_size = 16;
5176 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5177 }
5178 }
5179 /* newSV() allocates one more than needed */
5180 p = (void*)SvPVX(newSV(size-1));
5181 PL_my_cxt_list[*index] = p;
5182 Zero(p, size, char);
5183 return p;
5184}
53d44271
JH
5185
5186#else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5187
5188int
5189Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5190{
5191 dVAR;
5192 int index;
5193
7918f24d
NC
5194 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5195
53d44271
JH
5196 for (index = 0; index < PL_my_cxt_index; index++) {
5197 const char *key = PL_my_cxt_keys[index];
5198 /* try direct pointer compare first - there are chances to success,
5199 * and it's much faster.
5200 */
5201 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5202 return index;
5203 }
5204 return -1;
5205}
5206
5207void *
5208Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5209{
5210 dVAR;
5211 void *p;
5212 int index;
5213
7918f24d
NC
5214 PERL_ARGS_ASSERT_MY_CXT_INIT;
5215
53d44271
JH
5216 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5217 if (index == -1) {
5218 /* this module hasn't been allocated an index yet */
5219 MUTEX_LOCK(&PL_my_ctx_mutex);
5220 index = PL_my_cxt_index++;
5221 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5222 }
5223
5224 /* make sure the array is big enough */
5225 if (PL_my_cxt_size <= index) {
5226 int old_size = PL_my_cxt_size;
5227 int i;
5228 if (PL_my_cxt_size) {
00195859
HS
5229 IV new_size = PL_my_cxt_size;
5230 while (new_size <= index)
5231 new_size *= 2;
5232 Renew(PL_my_cxt_list, new_size, void *);
5233 Renew(PL_my_cxt_keys, new_size, const char *);
5234 PL_my_cxt_size = new_size;
53d44271
JH
5235 }
5236 else {
5237 PL_my_cxt_size = 16;
5238 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5239 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5240 }
5241 for (i = old_size; i < PL_my_cxt_size; i++) {
5242 PL_my_cxt_keys[i] = 0;
5243 PL_my_cxt_list[i] = 0;
5244 }
5245 }
5246 PL_my_cxt_keys[index] = my_cxt_key;
5247 /* newSV() allocates one more than needed */
5248 p = (void*)SvPVX(newSV(size-1));
5249 PL_my_cxt_list[index] = p;
5250 Zero(p, size, char);
5251 return p;
5252}
5253#endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5254#endif /* PERL_IMPLICIT_CONTEXT */
f16dd614 5255
db6e00bd 5256
5ec05c96
DM
5257/* Perl_xs_handshake():
5258 implement the various XS_*_BOOTCHECK macros, which are added to .c
5259 files by ExtUtils::ParseXS, to check that the perl the module was built
5260 with is binary compatible with the running perl.
5261
5262 usage:
5263 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5264 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5265
5266 The meaning of the varargs is determined the U32 key arg (which is not
5267 a format string). The fields of key are assembled by using HS_KEY().
5268
5269 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5270 "PerlInterpreter *" and represents the callers context; otherwise it is
5271 of type "CV *", and is the boot xsub's CV.
5272
5273 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5274 for example, and IO.dll was linked with threaded perl524.dll, and both
5275 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5276 successfully can load IO.dll into the process but simultaneously it
5277 loaded an interpreter of a different version into the process, and XS
5278 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5279 use through perl526.dll's my_perl->Istack_base.
5280
5281 v_my_perl cannot be the first arg, since then 'key' will be out of
5282 place in a threaded vs non-threaded mixup; and analyzing the key
5283 number's bitfields won't reveal the problem, since it will be a valid
5284 key (unthreaded perl) on interp side, but croak will report the XS mod's
5285 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5286 it's a threaded perl and an unthreaded XS module, threaded perl will
5287 look at an uninit C stack or an uninit register to get 'key'
5288 (remember that it assumes that the 1st arg is the interp cxt).
5289
5290 'file' is the source filename of the caller.
5291*/
5292
db6e00bd 5293I32
9a189793 5294Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
db6e00bd
DD
5295{
5296 va_list args;
5297 U32 items, ax;
9a189793
DD
5298 void * got;
5299 void * need;
db6e00bd
DD
5300#ifdef PERL_IMPLICIT_CONTEXT
5301 dTHX;
9a189793
DD
5302 tTHX xs_interp;
5303#else
5304 CV* cv;
5305 SV *** xs_spp;
db6e00bd
DD
5306#endif
5307 PERL_ARGS_ASSERT_XS_HANDSHAKE;
9a189793 5308 va_start(args, file);
db6e00bd 5309
3ef6b8e9 5310 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
9a189793 5311 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
3ef6b8e9 5312 if (UNLIKELY(got != need))
9a189793 5313 goto bad_handshake;
db6e00bd
DD
5314/* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5315 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5316 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5317 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5318 passed to the XS DLL */
db6e00bd 5319#ifdef PERL_IMPLICIT_CONTEXT
9a189793
DD
5320 xs_interp = (tTHX)v_my_perl;
5321 got = xs_interp;
5322 need = my_perl;
db6e00bd
DD
5323#else
5324/* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5325 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5326 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5327 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5328 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5329 location in the unthreaded perl binary) stored in CV * to figure out if this
5330 Perl_xs_handshake was called by the same pp_entersub */
9a189793
DD
5331 cv = (CV*)v_my_perl;
5332 xs_spp = (SV***)CvHSCXT(cv);
5333 got = xs_spp;
5334 need = &PL_stack_sp;
5335#endif
5336 if(UNLIKELY(got != need)) {
5337 bad_handshake:/* recycle branch and string from above */
5338 if(got != (void *)HSf_NOCHK)
fe60b4f6
DM
5339 noperl_die("%s: loadable library and perl binaries are mismatched"
5340 " (got handshake key %p, needed %p)\n",
9a189793
DD
5341 file, got, need);
5342 }
5343
5344 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5345 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5346 PL_xsubfilename = file; /* so the old name must be restored for
5347 additional XSUBs to register themselves */
9b669ea1
DD
5348 /* XSUBs can't be perl lang/perl5db.pl debugged
5349 if (PERLDB_LINE_OR_SAVESRC)
5350 (void)gv_fetchfile(file); */
db6e00bd
DD
5351 }
5352
5353 if(key & HSf_POPMARK) {
5354 ax = POPMARK;
5355 { SV **mark = PL_stack_base + ax++;
5356 { dSP;
5357 items = (I32)(SP - MARK);
5358 }
5359 }
5360 } else {
5361 items = va_arg(args, U32);
5362 ax = va_arg(args, U32);
5363 }
5364 {
5365 U32 apiverlen;
5366 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
ea91b243 5367 if((apiverlen = HS_GETAPIVERLEN(key))) {
db6e00bd
DD
5368 char * api_p = va_arg(args, char*);
5369 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5370 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5371 sizeof("v" PERL_API_VERSION_STRING)-1))
147e3846 5372 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
db6e00bd
DD
5373 api_p, SVfARG(PL_stack_base[ax + 0]),
5374 "v" PERL_API_VERSION_STRING);
5375 }
5376 }
5377 {
5378 U32 xsverlen;
5379 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
ea91b243 5380 if((xsverlen = HS_GETXSVERLEN(key)))
672cbd15 5381 S_xs_version_bootcheck(aTHX_
db6e00bd
DD
5382 items, ax, va_arg(args, char*), xsverlen);
5383 }
5384 va_end(args);
5385 return ax;
5386}
5387
5ec05c96 5388
672cbd15
DD
5389STATIC void
5390S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
e9b067d9
NC
5391 STRLEN xs_len)
5392{
5393 SV *sv;
5394 const char *vn = NULL;
a2f871a2 5395 SV *const module = PL_stack_base[ax];
e9b067d9
NC
5396
5397 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5398
5399 if (items >= 2) /* version supplied as bootstrap arg */
5400 sv = PL_stack_base[ax + 1];
5401 else {
5402 /* XXX GV_ADDWARN */
a2f871a2 5403 vn = "XS_VERSION";
147e3846 5404 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
a2f871a2
NC
5405 if (!sv || !SvOK(sv)) {
5406 vn = "VERSION";
147e3846 5407 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
a2f871a2 5408 }
e9b067d9
NC
5409 }
5410 if (sv) {
f9cc56fa 5411 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
573a19fb 5412 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
f9cc56fa 5413 ? sv : sv_2mortal(new_version(sv));
e9b067d9
NC
5414 xssv = upg_version(xssv, 0);
5415 if ( vcmp(pmsv,xssv) ) {
a2f871a2 5416 SV *string = vstringify(xssv);
147e3846 5417 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
c1f6cd39 5418 " does not match ", SVfARG(module), SVfARG(string));
a2f871a2
NC
5419
5420 SvREFCNT_dec(string);
5421 string = vstringify(pmsv);
5422
5423 if (vn) {
147e3846 5424 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
c1f6cd39 5425 SVfARG(string));
a2f871a2 5426 } else {
147e3846 5427 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
a2f871a2
NC
5428 }
5429 SvREFCNT_dec(string);
5430
e9b067d9 5431 Perl_sv_2mortal(aTHX_ xpt);
e9b067d9 5432 Perl_croak_sv(aTHX_ xpt);
f9cc56fa 5433 }
e9b067d9
NC
5434 }
5435}
5436
f46a3253
KW
5437/*
5438=for apidoc my_strlcat
5439
5440The C library C<strlcat> if available, or a Perl implementation of it.
6602b933 5441This operates on C C<NUL>-terminated strings.
f46a3253
KW
5442
5443C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
6602b933 5444most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
f46a3253
KW
5445unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5446practice this should not happen as it means that either C<size> is incorrect or
6602b933 5447that C<dst> is not a proper C<NUL>-terminated string).
f46a3253
KW
5448
5449Note that C<size> is the full size of the destination buffer and
6602b933
KW
5450the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5451room for the C<NUL> should be included in C<size>.
f46a3253 5452
6ade12da
KW
5453The return value is the total length that C<dst> would have if C<size> is
5454sufficiently large. Thus it is the initial length of C<dst> plus the length of
5455C<src>. If C<size> is smaller than the return, the excess was not appended.
5456
f46a3253
KW
5457=cut
5458
0baa827e 5459Description stolen from http://man.openbsd.org/strlcat.3
f46a3253 5460*/
a6cc4119
SP
5461#ifndef HAS_STRLCAT
5462Size_t
5463Perl_my_strlcat(char *dst, const char *src, Size_t size)
5464{
5465 Size_t used, length, copy;
5466
5467 used = strlen(dst);
5468 length = strlen(src);
5469 if (size > 0 && used < size - 1) {
5470 copy = (length >= size - used) ? size - used - 1 : length;
5471 memcpy(dst + used, src, copy);
5472 dst[used + copy] = '\0';
5473 }
5474 return used + length;
5475}
5476#endif
5477
f46a3253
KW
5478
5479/*
5480=for apidoc my_strlcpy
5481
5482The C library C<strlcpy> if available, or a Perl implementation of it.
6602b933 5483This operates on C C<NUL>-terminated strings.
f46a3253
KW
5484
5485C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
6602b933 5486to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
f46a3253 5487
6ade12da
KW
5488The return value is the total length C<src> would be if the copy completely
5489succeeded. If it is larger than C<size>, the excess was not copied.
5490
f46a3253
KW
5491=cut
5492
0baa827e 5493Description stolen from http://man.openbsd.org/strlcpy.3
f46a3253 5494*/
a6cc4119
SP
5495#ifndef HAS_STRLCPY
5496Size_t
5497Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5498{
5499 Size_t length, copy;
5500
5501 length = strlen(src);
5502 if (size > 0) {
5503 copy = (length >= size) ? size - 1 : length;
5504 memcpy(dst, src, copy);
5505 dst[copy] = '\0';
5506 }
5507 return length;
5508}
5509#endif
5510
aefb3fa0
DIM
5511/*
5512=for apidoc my_strnlen
5513
5514The C library C<strnlen> if available, or a Perl implementation of it.
5515
5516C<my_strnlen()> computes the length of the string, up to C<maxlen>
5517characters. It will will never attempt to address more than C<maxlen>
5518characters, making it suitable for use with strings that are not
5519guaranteed to be NUL-terminated.
5520
5521=cut
5522
5523Description stolen from http://man.openbsd.org/strnlen.3,
5524implementation stolen from PostgreSQL.
5525*/
5526#ifndef HAS_STRNLEN
5527Size_t
5528Perl_my_strnlen(const char *str, Size_t maxlen)
5529{
5530 const char *p = str;
5531
5532 PERL_ARGS_ASSERT_MY_STRNLEN;
5533
5534 while(maxlen-- && *p)
5535 p++;
5536
5537 return p - str;
5538}
5539#endif
5540
17dd9954
JH
5541#if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5542/* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5543long _ftol( double ); /* Defined by VC6 C libs. */
5544long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5545#endif
5546
a7999c08
FC
5547PERL_STATIC_INLINE bool
5548S_gv_has_usable_name(pTHX_ GV *gv)
5549{
5550 GV **gvp;
5551 return GvSTASH(gv)
5552 && HvENAME(GvSTASH(gv))
edf4dbd2
FC
5553 && (gvp = (GV **)hv_fetchhek(
5554 GvSTASH(gv), GvNAME_HEK(gv), 0
a7999c08
FC
5555 ))
5556 && *gvp == gv;
5557}
5558
c51f309c
NC
5559void
5560Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5561{
c51f309c 5562 SV * const dbsv = GvSVn(PL_DBsub);
9a9b5ec9 5563 const bool save_taint = TAINT_get;
07004ebb 5564
107c452c
FC
5565 /* When we are called from pp_goto (svp is null),
5566 * we do not care about using dbsv to call CV;
c51f309c
NC
5567 * it's for informational purposes only.
5568 */
5569
7918f24d
NC
5570 PERL_ARGS_ASSERT_GET_DB_SUB;
5571
284167a5 5572 TAINT_set(FALSE);
c51f309c
NC
5573 save_item(dbsv);
5574 if (!PERLDB_SUB_NN) {
be1cc451 5575 GV *gv = CvGV(cv);
c51f309c 5576
e0a18850 5577 if (!svp && !CvLEXICAL(cv)) {
7d8b4ed3
FC
5578 gv_efullname3(dbsv, gv, NULL);
5579 }
e0a18850 5580 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
c51f309c 5581 || strEQ(GvNAME(gv), "END")
a7999c08
FC
5582 || ( /* Could be imported, and old sub redefined. */
5583 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5584 &&
159b6efe 5585 !( (SvTYPE(*svp) == SVt_PVGV)
be1cc451 5586 && (GvCV((const GV *)*svp) == cv)
a7999c08 5587 /* Use GV from the stack as a fallback. */
4aaab439 5588 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
be1cc451
FC
5589 )
5590 )
7d8b4ed3 5591 ) {
c51f309c 5592 /* GV is potentially non-unique, or contain different CV. */
daba3364 5593 SV * const tmp = newRV(MUTABLE_SV(cv));
c51f309c
NC
5594 sv_setsv(dbsv, tmp);
5595 SvREFCNT_dec(tmp);
5596 }
5597 else {
a7999c08
FC
5598 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5599 sv_catpvs(dbsv, "::");
f34d8cdd 5600 sv_cathek(dbsv, GvNAME_HEK(gv));
c51f309c
NC
5601 }
5602 }
5603 else {
5604 const int type = SvTYPE(dbsv);
5605 if (type < SVt_PVIV && type != SVt_IV)
5606 sv_upgrade(dbsv, SVt_PVIV);
5607 (void)SvIOK_on(dbsv);
5608 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5609 }
90a04aed 5610 SvSETMAGIC(dbsv);
07004ebb 5611 TAINT_IF(save_taint);
9a9b5ec9
DM
5612#ifdef NO_TAINT_SUPPORT
5613 PERL_UNUSED_VAR(save_taint);
5614#endif
c51f309c
NC
5615}
5616
3497a01f 5617int
ddeaf645 5618Perl_my_dirfd(DIR * dir) {
3497a01f
SP
5619
5620 /* Most dirfd implementations have problems when passed NULL. */
5621 if(!dir)
5622 return -1;
5623#ifdef HAS_DIRFD
5624 return dirfd(dir);
5625#elif defined(HAS_DIR_DD_FD)
5626 return dir->dd_fd;
5627#else
ddeaf645 5628 Perl_croak_nocontext(PL_no_func, "dirfd");
661d43c4 5629 NOT_REACHED; /* NOTREACHED */
3497a01f
SP
5630 return 0;
5631#endif
5632}
5633
2517ba99 5634#if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
e48855bd
TC
5635
5636#define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5637#define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5638
2517ba99
Z
5639static int
5640S_my_mkostemp(char *templte, int flags) {
e48855bd
TC
5641 dTHX;
5642 STRLEN len = strlen(templte);
5643 int fd;
5644 int attempts = 0;
5645
e48855bd
TC
5646 if (len < 6 ||
5647 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5648 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
2517ba99 5649 SETERRNO(EINVAL, LIB_INVARG);
e48855bd
TC
5650 return -1;
5651 }
5652
5653 do {
5654 int i;
5655 for (i = 1; i <= 6; ++i) {
5656 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5657 }
2517ba99 5658 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
e48855bd
TC
5659 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5660
5661 return fd;
5662}
5663
5664#endif
5665
2517ba99
Z
5666#ifndef HAS_MKOSTEMP
5667int
5668Perl_my_mkostemp(char *templte, int flags)
5669{
5670 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5671 return S_my_mkostemp(templte, flags);
5672}
5673#endif
5674
5675#ifndef HAS_MKSTEMP
5676int
5677Perl_my_mkstemp(char *templte)
5678{
5679 PERL_ARGS_ASSERT_MY_MKSTEMP;
5680 return S_my_mkostemp(templte, 0);
5681}
5682#endif
5683
f7e71195
AB
5684REGEXP *
5685Perl_get_re_arg(pTHX_ SV *sv) {
f7e71195
AB
5686
5687 if (sv) {
5688 if (SvMAGICAL(sv))
5689 mg_get(sv);
df052ff8
BM
5690 if (SvROK(sv))
5691 sv = MUTABLE_SV(SvRV(sv));
5692 if (SvTYPE(sv) == SVt_REGEXP)
5693 return (REGEXP*) sv;
f7e71195
AB
5694 }
5695
5696 return NULL;
5697}
5698
ce582cee 5699/*
3be8f094
TC
5700 * This code is derived from drand48() implementation from FreeBSD,
5701 * found in lib/libc/gen/_rand48.c.
5702 *
5703 * The U64 implementation is original, based on the POSIX
5704 * specification for drand48().
5705 */
5706
5707/*
5708* Copyright (c) 1993 Martin Birgmeier
5709* All rights reserved.
5710*
5711* You may redistribute unmodified or modified versions of this source
5712* code provided that the above copyright notice and this and the
5713* following conditions are retained.
5714*
5715* This software is provided ``as is'', and comes with no warranties
5716* of any kind. I shall in no event be liable for anything that happens
5717* to anyone/anything when using this software.
5718*/
5719
5720#define FREEBSD_DRAND48_SEED_0 (0x330e)
5721
5722#ifdef PERL_DRAND48_QUAD
5723
f2f9e01d 5724#define DRAND48_MULT UINT64_C(0x5deece66d)
3be8f094 5725#define DRAND48_ADD 0xb
f2f9e01d 5726#define DRAND48_MASK UINT64_C(0xffffffffffff)
3be8f094
TC
5727
5728#else
5729
5730#define FREEBSD_DRAND48_SEED_1 (0xabcd)
5731#define FREEBSD_DRAND48_SEED_2 (0x1234)
5732#define FREEBSD_DRAND48_MULT_0 (0xe66d)
5733#define FREEBSD_DRAND48_MULT_1 (0xdeec)
5734#define FREEBSD_DRAND48_MULT_2 (0x0005)
5735#define FREEBSD_DRAND48_ADD (0x000b)
5736
5737const unsigned short _rand48_mult[3] = {
5738 FREEBSD_DRAND48_MULT_0,
5739 FREEBSD_DRAND48_MULT_1,
5740 FREEBSD_DRAND48_MULT_2
5741};
5742const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5743
5744#endif
5745
5746void
5747Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5748{
5749 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5750
5751#ifdef PERL_DRAND48_QUAD
702c92eb 5752 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
3be8f094
TC
5753#else
5754 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5755 random_state->seed[1] = (U16) seed;
5756 random_state->seed[2] = (U16) (seed >> 16);
5757#endif
5758}
5759
5760double
5761Perl_drand48_r(perl_drand48_t *random_state)
5762{
5763 PERL_ARGS_ASSERT_DRAND48_R;
5764
5765#ifdef PERL_DRAND48_QUAD
5766 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5767 & DRAND48_MASK;
5768
0f246720 5769 return ldexp((double)*random_state, -48);
3be8f094 5770#else
63835f79 5771 {
3be8f094
TC
5772 U32 accu;
5773 U16 temp[2];
5774
5775 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5776 + (U32) _rand48_add;
5777 temp[0] = (U16) accu; /* lower 16 bits */
5778 accu >>= sizeof(U16) * 8;
5779 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5780 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5781 temp[1] = (U16) accu; /* middle 16 bits */
5782 accu >>= sizeof(U16) * 8;
5783 accu += _rand48_mult[0] * random_state->seed[2]
5784 + _rand48_mult[1] * random_state->seed[1]
5785 + _rand48_mult[2] * random_state->seed[0];
5786 random_state->seed[0] = temp[0];
5787 random_state->seed[1] = temp[1];
5788 random_state->seed[2] = (U16) accu;
5789
5790 return ldexp((double) random_state->seed[0], -48) +
5791 ldexp((double) random_state->seed[1], -32) +
5792 ldexp((double) random_state->seed[2], -16);
63835f79 5793 }
3be8f094
TC
5794#endif
5795}
2c6ee1a7 5796
470dd224
JH
5797#ifdef USE_C_BACKTRACE
5798
5799/* Possibly move all this USE_C_BACKTRACE code into a new file. */
5800
5801#ifdef USE_BFD
5802
5803typedef struct {
0762e42f 5804 /* abfd is the BFD handle. */
470dd224 5805 bfd* abfd;
0762e42f 5806 /* bfd_syms is the BFD symbol table. */
470dd224 5807 asymbol** bfd_syms;
0762e42f 5808 /* bfd_text is handle to the the ".text" section of the object file. */
470dd224
JH
5809 asection* bfd_text;
5810 /* Since opening the executable and scanning its symbols is quite
5811 * heavy operation, we remember the filename we used the last time,
5812 * and do the opening and scanning only if the filename changes.
5813 * This removes most (but not all) open+scan cycles. */
5814 const char* fname_prev;
5815} bfd_context;
5816
5817/* Given a dl_info, update the BFD context if necessary. */
5818static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5819{
5820 /* BFD open and scan only if the filename changed. */
5821 if (ctx->fname_prev == NULL ||
5822 strNE(dl_info->dli_fname, ctx->fname_prev)) {
a1684041
JH
5823 if (ctx->abfd) {
5824 bfd_close(ctx->abfd);
5825 }
470dd224
JH
5826 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5827 if (ctx->abfd) {
5828 if (bfd_check_format(ctx->abfd, bfd_object)) {
5829 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5830 if (symbol_size > 0) {
5831 Safefree(ctx->bfd_syms);
5832 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5833 ctx->bfd_text =
5834 bfd_get_section_by_name(ctx->abfd, ".text");
5835 }
5836 else
5837 ctx->abfd = NULL;
5838 }
5839 else
5840 ctx->abfd = NULL;
5841 }
5842 ctx->fname_prev = dl_info->dli_fname;
5843 }
5844}
5845
5846/* Given a raw frame, try to symbolize it and store
5847 * symbol information (source file, line number) away. */
5848static void bfd_symbolize(bfd_context* ctx,
5849 void* raw_frame,
5850 char** symbol_name,
5851 STRLEN* symbol_name_size,
5852 char** source_name,
5853 STRLEN* source_name_size,
5854 STRLEN* source_line)
5855{
5856 *symbol_name = NULL;
5857 *symbol_name_size = 0;
5858 if (ctx->abfd) {
5859 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5860 if (offset > 0 &&
5861 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5862 const char *file;
5863 const char *func;
5864 unsigned int line = 0;
5865 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5866 ctx->bfd_syms, offset,
5867 &file, &func, &line) &&
5868 file && func && line > 0) {
5869 /* Size and copy the source file, use only
5870 * the basename of the source file.
5871 *
5872 * NOTE: the basenames are fine for the
5873 * Perl source files, but may not always
5874 * be the best idea for XS files. */
5875 const char *p, *b = NULL;
5876 /* Look for the last slash. */
5877 for (p = file; *p; p++) {
5878 if (*p == '/')
5879 b = p + 1;
5880 }
5881 if (b == NULL || *b == 0) {
5882 b = file;
5883 }
5884 *source_name_size = p - b + 1;
5885 Newx(*source_name, *source_name_size + 1, char);
5886 Copy(b, *source_name, *source_name_size + 1, char);
5887
5888 *symbol_name_size = strlen(func);
5889 Newx(*symbol_name, *symbol_name_size + 1, char);
5890 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5891
5892 *source_line = line;
5893 }
5894 }
5895 }
5896}
5897
5898#endif /* #ifdef USE_BFD */
5899
5900#ifdef PERL_DARWIN
5901
5902/* OS X has no public API for for 'symbolicating' (Apple official term)
5903 * stack addresses to {function_name, source_file, line_number}.
5904 * Good news: there is command line utility atos(1) which does that.
5905 * Bad news 1: it's a command line utility.
5906 * Bad news 2: one needs to have the Developer Tools installed.
5907 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5908 *
5909 * To recap: we need to open a pipe for reading for a utility which
5910 * might not exist, or exists in different locations, and then parse
5911 * the output. And since this is all for a low-level API, we cannot
5912 * use high-level stuff. Thanks, Apple. */
5913
5914typedef struct {
0762e42f
JH
5915 /* tool is set to the absolute pathname of the tool to use:
5916 * xcrun or atos. */
470dd224 5917 const char* tool;
0762e42f
JH
5918 /* format is set to a printf format string used for building
5919 * the external command to run. */
470dd224 5920 const char* format;
0762e42f
JH
5921 /* unavail is set if e.g. xcrun cannot be found, or something
5922 * else happens that makes getting the backtrace dubious. Note,
5923 * however, that the context isn't persistent, the next call to
5924 * get_c_backtrace() will start from scratch. */
470dd224 5925 bool unavail;
0762e42f 5926 /* fname is the current object file name. */
470dd224 5927 const char* fname;
0762e42f 5928 /* object_base_addr is the base address of the shared object. */
470dd224
JH
5929 void* object_base_addr;
5930} atos_context;
5931
5932/* Given |dl_info|, updates the context. If the context has been
5933 * marked unavailable, return immediately. If not but the tool has
5934 * not been set, set it to either "xcrun atos" or "atos" (also set the
5935 * format to use for creating commands for piping), or if neither is
5936 * unavailable (one needs the Developer Tools installed), mark the context
5937 * an unavailable. Finally, update the filename (object name),
5938 * and its base address. */
5939
5940static void atos_update(atos_context* ctx,
5941 Dl_info* dl_info)
5942{
5943 if (ctx->unavail)
5944 return;
5945 if (ctx->tool == NULL) {
5946 const char* tools[] = {
5947 "/usr/bin/xcrun",
5948 "/usr/bin/atos"
5949 };
5950 const char* formats[] = {
5951 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
5952 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
5953 };
5954 struct stat st;
5955 UV i;
5956 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
5957 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
5958 ctx->tool = tools[i];
5959 ctx->format = formats[i];
5960 break;
5961 }
5962 }
5963 if (ctx->tool == NULL) {
5964 ctx->unavail = TRUE;
5965 return;
5966 }
5967 }
5968 if (ctx->fname == NULL ||
5969 strNE(dl_info->dli_fname, ctx->fname)) {
5970 ctx->fname = dl_info->dli_fname;
5971 ctx->object_base_addr = dl_info->dli_fbase;
5972 }
5973}
5974
5975/* Given an output buffer end |p| and its |start|, matches
5976 * for the atos output, extracting the source code location
96e440d2 5977 * and returning non-NULL if possible, returning NULL otherwise. */
470dd224
JH
5978static const char* atos_parse(const char* p,
5979 const char* start,
5980 STRLEN* source_name_size,
5981 STRLEN* source_line) {
96e440d2 5982 /* atos() output is something like:
470dd224
JH
5983 * perl_parse (in miniperl) (perl.c:2314)\n\n".
5984 * We cannot use Perl regular expressions, because we need to
5985 * stay low-level. Therefore here we have a rolled-out version
5986 * of a state machine which matches _backwards_from_the_end_ and
5987 * if there's a success, returns the starts of the filename,
5988 * also setting the filename size and the source line number.
5989 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
5990 const char* source_number_start;
5991 const char* source_name_end;
96e440d2
JH
5992 const char* source_line_end;
5993 const char* close_paren;
22ff3130
HS
5994 UV uv;
5995
470dd224 5996 /* Skip trailing whitespace. */
a248e8c9 5997 while (p > start && isSPACE(*p)) p--;
470dd224
JH
5998 /* Now we should be at the close paren. */
5999 if (p == start || *p != ')')
6000 return NULL;
96e440d2 6001 close_paren = p;
470dd224
JH
6002 p--;
6003 /* Now we should be in the line number. */
a248e8c9 6004 if (p == start || !isDIGIT(*p))
470dd224
JH
6005 return NULL;
6006 /* Skip over the digits. */
a248e8c9 6007 while (p > start && isDIGIT(*p))
470dd224
JH
6008 p--;
6009 /* Now we should be at the colon. */
6010 if (p == start || *p != ':')
6011 return NULL;
6012 source_number_start = p + 1;
6013 source_name_end = p; /* Just beyond the end. */
6014 p--;
6015 /* Look for the open paren. */
6016 while (p > start && *p != '(')
6017 p--;
6018 if (p == start)
6019 return NULL;
6020 p++;
6021 *source_name_size = source_name_end - p;
22ff3130
HS
6022 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6023 && source_line_end == close_paren
99315af8 6024 && uv <= PERL_INT_MAX
22ff3130
HS
6025 ) {
6026 *source_line = (STRLEN)uv;
6027 return p;
6028 }
6029 return NULL;
470dd224
JH
6030}
6031
6032/* Given a raw frame, read a pipe from the symbolicator (that's the
6033 * technical term) atos, reads the result, and parses the source code
6034 * location. We must stay low-level, so we use snprintf(), pipe(),
6035 * and fread(), and then also parse the output ourselves. */
6036static void atos_symbolize(atos_context* ctx,
6037 void* raw_frame,
6038 char** source_name,
6039 STRLEN* source_name_size,
6040 STRLEN* source_line)
6041{
6042 char cmd[1024];
6043 const char* p;
6044 Size_t cnt;
6045
6046 if (ctx->unavail)
6047 return;
6048 /* Simple security measure: if there's any funny business with
6049 * the object name (used as "-o '%s'" ), leave since at least
6050 * partially the user controls it. */
6051 for (p = ctx->fname; *p; p++) {
a248e8c9 6052 if (*p == '\'' || isCNTRL(*p)) {
470dd224
JH
6053 ctx->unavail = TRUE;
6054 return;
6055 }
6056 }
6057 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6058 ctx->fname, ctx->object_base_addr, raw_frame);
6059 if (cnt < sizeof(cmd)) {
6060 /* Undo nostdio.h #defines that disable stdio.
6061 * This is somewhat naughty, but is used elsewhere
6062 * in the core, and affects only OS X. */
6063#undef FILE
6064#undef popen
6065#undef fread
6066#undef pclose
6067 FILE* fp = popen(cmd, "r");
6068 /* At the moment we open a new pipe for each stack frame.
6069 * This is naturally somewhat slow, but hopefully generating
6070 * stack traces is never going to in a performance critical path.
6071 *
6072 * We could play tricks with atos by batching the stack
6073 * addresses to be resolved: atos can either take multiple
6074 * addresses from the command line, or read addresses from
470dd224
JH
6075 * a file (though the mess of creating temporary files would
6076 * probably negate much of any possible speedup).
6077 *
6078 * Normally there are only two objects present in the backtrace:
6079 * perl itself, and the libdyld.dylib. (Note that the object
6080 * filenames contain the full pathname, so perl may not always
6081 * be in the same place.) Whenever the object in the
6082 * backtrace changes, the base address also changes.
6083 *
6084 * The problem with batching the addresses, though, would be
6085 * matching the results with the addresses: the parsing of
6086 * the results is already painful enough with a single address. */
6087 if (fp) {
6088 char out[1024];
6089 UV cnt = fread(out, 1, sizeof(out), fp);
6090 if (cnt < sizeof(out)) {
70ead873 6091 const char* p = atos_parse(out + cnt - 1, out,
470dd224
JH
6092 source_name_size,
6093 source_line);
6094 if (p) {
6095 Newx(*source_name,
70ead873 6096 *source_name_size, char);
470dd224 6097 Copy(p, *source_name,
70ead873 6098 *source_name_size, char);
470dd224
JH
6099 }
6100 }
6101 pclose(fp);
6102 }
6103 }
6104}
6105
6106#endif /* #ifdef PERL_DARWIN */
6107
6108/*
6109=for apidoc get_c_backtrace
6110
6111Collects the backtrace (aka "stacktrace") into a single linear
796b6530 6112malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
470dd224 6113
796b6530
KW
6114Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6115returning at most C<depth> frames.
470dd224
JH
6116
6117=cut
6118*/
6119
6120Perl_c_backtrace*
6121Perl_get_c_backtrace(pTHX_ int depth, int skip)
6122{
6123 /* Note that here we must stay as low-level as possible: Newx(),
6124 * Copy(), Safefree(); since we may be called from anywhere,
6125 * so we should avoid higher level constructs like SVs or AVs.
6126 *
6127 * Since we are using safesysmalloc() via Newx(), don't try
6128 * getting backtrace() there, unless you like deep recursion. */
6129
6130 /* Currently only implemented with backtrace() and dladdr(),
6131 * for other platforms NULL is returned. */
6132
6133#if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6134 /* backtrace() is available via <execinfo.h> in glibc and in most
6135 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6136
6137 /* We try fetching this many frames total, but then discard
6138 * the |skip| first ones. For the remaining ones we will try
6139 * retrieving more information with dladdr(). */
6140 int try_depth = skip + depth;
6141
6142 /* The addresses (program counters) returned by backtrace(). */
6143 void** raw_frames;
6144
6145 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6146 Dl_info* dl_infos;
6147
6148 /* Sizes _including_ the terminating \0 of the object name
6149 * and symbol name strings. */
6150 STRLEN* object_name_sizes;
6151 STRLEN* symbol_name_sizes;
6152
6153#ifdef USE_BFD
6154 /* The symbol names comes either from dli_sname,
6155 * or if using BFD, they can come from BFD. */
6156 char** symbol_names;
6157#endif
6158
6159 /* The source code location information. Dug out with e.g. BFD. */
6160 char** source_names;
6161 STRLEN* source_name_sizes;
6162 STRLEN* source_lines;
6163
6164 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6165 int got_depth; /* How many frames were returned from backtrace(). */
6166 UV frame_count = 0; /* How many frames we return. */
6167 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6168
6169#ifdef USE_BFD
6170 bfd_context bfd_ctx;
6171#endif
6172#ifdef PERL_DARWIN
6173 atos_context atos_ctx;
6174#endif
6175
6176 /* Here are probably possibilities for optimizing. We could for
6177 * example have a struct that contains most of these and then
6178 * allocate |try_depth| of them, saving a bunch of malloc calls.
6179 * Note, however, that |frames| could not be part of that struct
6180 * because backtrace() will want an array of just them. Also be
6181 * careful about the name strings. */
6182 Newx(raw_frames, try_depth, void*);
6183 Newx(dl_infos, try_depth, Dl_info);
6184 Newx(object_name_sizes, try_depth, STRLEN);
6185 Newx(symbol_name_sizes, try_depth, STRLEN);
6186 Newx(source_names, try_depth, char*);
6187 Newx(source_name_sizes, try_depth, STRLEN);
6188 Newx(source_lines, try_depth, STRLEN);
6189#ifdef USE_BFD
6190 Newx(symbol_names, try_depth, char*);
6191#endif
6192
6193 /* Get the raw frames. */
6194 got_depth = (int)backtrace(raw_frames, try_depth);
6195
6196 /* We use dladdr() instead of backtrace_symbols() because we want
6197 * the full details instead of opaque strings. This is useful for
6198 * two reasons: () the details are needed for further symbolic
0762e42f
JH
6199 * digging, for example in OS X (2) by having the details we fully
6200 * control the output, which in turn is useful when more platforms
6201 * are added: we can keep out output "portable". */
470dd224
JH
6202
6203 /* We want a single linear allocation, which can then be freed
6204 * with a single swoop. We will do the usual trick of first
6205 * walking over the structure and seeing how much we need to
6206 * allocate, then allocating, and then walking over the structure
6207 * the second time and populating it. */
6208
6209 /* First we must compute the total size of the buffer. */
6210 total_bytes = sizeof(Perl_c_backtrace_header);
6211 if (got_depth > skip) {
6212 int i;
6213#ifdef USE_BFD
6214 bfd_init(); /* Is this safe to call multiple times? */
6215 Zero(&bfd_ctx, 1, bfd_context);
6216#endif
6217#ifdef PERL_DARWIN
6218 Zero(&atos_ctx, 1, atos_context);
6219#endif
6220 for (i = skip; i < try_depth; i++) {
6221 Dl_info* dl_info = &dl_infos[i];
6222
4d00a319
JH
6223 object_name_sizes[i] = 0;
6224 source_names[i] = NULL;
6225 source_name_sizes[i] = 0;
6226 source_lines[i] = 0;
6227
470dd224
JH
6228 /* Yes, zero from dladdr() is failure. */
6229 if (dladdr(raw_frames[i], dl_info)) {
70ead873
VT
6230 total_bytes += sizeof(Perl_c_backtrace_frame);
6231
470dd224
JH
6232 object_name_sizes[i] =
6233 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6234 symbol_name_sizes[i] =
6235 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6236#ifdef USE_BFD
6237 bfd_update(&bfd_ctx, dl_info);
6238 bfd_symbolize(&bfd_ctx, raw_frames[i],
6239 &symbol_names[i],
6240 &symbol_name_sizes[i],
6241 &source_names[i],
6242 &source_name_sizes[i],
6243 &source_lines[i]);
6244#endif
6245#if PERL_DARWIN
6246 atos_update(&atos_ctx, dl_info);
6247 atos_symbolize(&atos_ctx,
6248 raw_frames[i],
6249 &source_names[i],
6250 &source_name_sizes[i],
6251 &source_lines[i]);
6252#endif
6253
6254 /* Plus ones for the terminating \0. */
6255 total_bytes += object_name_sizes[i] + 1;
6256 total_bytes += symbol_name_sizes[i] + 1;
6257 total_bytes += source_name_sizes[i] + 1;
6258
6259 frame_count++;
6260 } else {
6261 break;
6262 }
6263 }
6264#ifdef USE_BFD
6265 Safefree(bfd_ctx.bfd_syms);
6266#endif
6267 }
6268
6269 /* Now we can allocate and populate the result buffer. */
6270 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6271 Zero(bt, total_bytes, char);
6272 bt->header.frame_count = frame_count;
6273 bt->header.total_bytes = total_bytes;
6274 if (frame_count > 0) {
6275 Perl_c_backtrace_frame* frame = bt->frame_info;
6276 char* name_base = (char *)(frame + frame_count);
6277 char* name_curr = name_base; /* Outputting the name strings here. */
6278 UV i;
6279 for (i = skip; i < skip + frame_count; i++) {
6280 Dl_info* dl_info = &dl_infos[i];
6281
6282 frame->addr = raw_frames[i];
6283 frame->object_base_addr = dl_info->dli_fbase;
6284 frame->symbol_addr = dl_info->dli_saddr;
6285
6286 /* Copies a string, including the \0, and advances the name_curr.
6287 * Also copies the start and the size to the frame. */
6288#define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6289 if (size && src) \
6290 Copy(src, name_curr, size, char); \
6291 frame->doffset = name_curr - (char*)bt; \
6292 frame->dsize = size; \
6293 name_curr += size; \
6294 *name_curr++ = 0;
6295
6296 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6297 dl_info->dli_fname,
6298 object_name_size, object_name_sizes[i]);
6299
6300#ifdef USE_BFD
6301 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6302 symbol_names[i],
6303 symbol_name_size, symbol_name_sizes[i]);
6304 Safefree(symbol_names[i]);
6305#else
6306 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6307 dl_info->dli_sname,
6308 symbol_name_size, symbol_name_sizes[i]);
6309#endif
6310
6311 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6312 source_names[i],
6313 source_name_size, source_name_sizes[i]);
6314 Safefree(source_names[i]);
6315
6316#undef PERL_C_BACKTRACE_STRCPY
6317
6318 frame->source_line_number = source_lines[i];
6319
6320 frame++;
6321 }
6322 assert(total_bytes ==
6323 (UV)(sizeof(Perl_c_backtrace_header) +
6324 frame_count * sizeof(Perl_c_backtrace_frame) +
6325 name_curr - name_base));
6326 }
6327#ifdef USE_BFD
6328 Safefree(symbol_names);
a1684041
JH
6329 if (bfd_ctx.abfd) {
6330 bfd_close(bfd_ctx.abfd);
6331 }
470dd224
JH
6332#endif
6333 Safefree(source_lines);
6334 Safefree(source_name_sizes);
6335 Safefree(source_names);
6336 Safefree(symbol_name_sizes);
6337 Safefree(object_name_sizes);
6338 /* Assuming the strings returned by dladdr() are pointers
6339 * to read-only static memory (the object file), so that
6340 * they do not need freeing (and cannot be). */
6341 Safefree(dl_infos);
6342 Safefree(raw_frames);
6343 return bt;
6344#else
6345 PERL_UNUSED_ARGV(depth);
6346 PERL_UNUSED_ARGV(skip);
6347 return NULL;
6348#endif
6349}
6350
6351/*
6352=for apidoc free_c_backtrace
6353
6354Deallocates a backtrace received from get_c_bracktrace.
6355
6356=cut
6357*/
6358
6359/*
6360=for apidoc get_c_backtrace_dump
6361
796b6530
KW
6362Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6363the C<skip> innermost ones. C<depth> of 20 is usually enough.
470dd224
JH
6364
6365The appended output looks like:
6366
6367...
63681 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
63692 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6370...
6371
6372The fields are tab-separated. The first column is the depth (zero
6373being the innermost non-skipped frame). In the hex:offset, the hex is
796b6530
KW
6374where the program counter was in C<S_parse_body>, and the :offset (might
6375be missing) tells how much inside the C<S_parse_body> the program counter was.
470dd224 6376
796b6530 6377The C<util.c:1716> is the source code file and line number.
470dd224 6378
75af9d73 6379The F</usr/bin/perl> is obvious (hopefully).
470dd224
JH
6380
6381Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6382if the platform doesn't support retrieving the information;
6383if the binary is missing the debug information;
6384if the optimizer has transformed the code by for example inlining.
6385
6386=cut
6387*/
6388
6389SV*
6390Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6391{
6392 Perl_c_backtrace* bt;
6393
6394 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6395 if (bt) {
6396 Perl_c_backtrace_frame* frame;
6397 SV* dsv = newSVpvs("");
6398 UV i;
6399 for (i = 0, frame = bt->frame_info;
6400 i < bt->header.frame_count; i++, frame++) {
6401 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6402 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6403 /* Symbol (function) names might disappear without debug info.
6404 *
6405 * The source code location might disappear in case of the
6406 * optimizer inlining or otherwise rearranging the code. */
6407 if (frame->symbol_addr) {
6408 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6409 (int)
6410 ((char*)frame->addr - (char*)frame->symbol_addr));
6411 }
6412 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6413 frame->symbol_name_size &&
6414 frame->symbol_name_offset ?
6415 (char*)bt + frame->symbol_name_offset : "-");
6416 if (frame->source_name_size &&
6417 frame->source_name_offset &&
6418 frame->source_line_number) {
147e3846 6419 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
470dd224
JH
6420 (char*)bt + frame->source_name_offset,
6421 (UV)frame->source_line_number);
6422 } else {
6423 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6424 }
6425 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6426 frame->object_name_size &&
6427 frame->object_name_offset ?
6428 (char*)bt + frame->object_name_offset : "-");
6429 /* The frame->object_base_addr is not output,
6430 * but it is used for symbolizing/symbolicating. */
6431 sv_catpvs(dsv, "\n");
6432 }
6433
3c7dccdc 6434 Perl_free_c_backtrace(bt);
470dd224
JH
6435
6436 return dsv;
6437 }
6438
6439 return NULL;
6440}
6441
6442/*
6443=for apidoc dump_c_backtrace
6444
796b6530 6445Dumps the C backtrace to the given C<fp>.
470dd224
JH
6446
6447Returns true if a backtrace could be retrieved, false if not.
6448
6449=cut
6450*/
6451
6452bool
6453Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6454{
6455 SV* sv;
6456
6457 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6458
6459 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6460 if (sv) {
6461 sv_2mortal(sv);
6462 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6463 return TRUE;
6464 }
6465 return FALSE;
6466}
6467
6468#endif /* #ifdef USE_C_BACKTRACE */
3be8f094 6469
3baee7cc
JH
6470#ifdef PERL_TSA_ACTIVE
6471
6472/* pthread_mutex_t and perl_mutex are typedef equivalent
6473 * so casting the pointers is fine. */
6474
6475int perl_tsa_mutex_lock(perl_mutex* mutex)
6476{
6477 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6478}
6479
6480int perl_tsa_mutex_unlock(perl_mutex* mutex)
6481{
6482 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6483}
6484
6485int perl_tsa_mutex_destroy(perl_mutex* mutex)
6486{
6487 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6488}
6489
6490#endif
6491
3f6bd23a
DM
6492
6493#ifdef USE_DTRACE
6494
6495/* log a sub call or return */
6496
6497void
6498Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6499{
6500 const char *func;
6501 const char *file;
6502 const char *stash;
6503 const COP *start;
6504 line_t line;
6505
6506 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6507
6508 if (CvNAMED(cv)) {
6509 HEK *hek = CvNAME_HEK(cv);
6510 func = HEK_KEY(hek);
6511 }
6512 else {
6513 GV *gv = CvGV(cv);
6514 func = GvENAME(gv);
6515 }
6516 start = (const COP *)CvSTART(cv);
6517 file = CopFILE(start);
6518 line = CopLINE(start);
6519 stash = CopSTASHPV(start);
6520
6521 if (is_call) {
6522 PERL_SUB_ENTRY(func, file, line, stash);
6523 }
6524 else {
6525 PERL_SUB_RETURN(func, file, line, stash);
6526 }
6527}
6528
6529
6530/* log a require file loading/loaded */
6531
6532void
6533Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6534{
6535 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6536
6537 if (is_loading) {
6538 PERL_LOADING_FILE(name);
6539 }
6540 else {
6541 PERL_LOADED_FILE(name);
6542 }
6543}
6544
6545
6546/* log an op execution */
6547
6548void
6549Perl_dtrace_probe_op(pTHX_ const OP *op)
6550{
6551 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6552
6553 PERL_OP_ENTRY(OP_NAME(op));
6554}
6555
6556
6557/* log a compile/run phase change */
6558
6559void
6560Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6561{
6562 const char *ph_old = PL_phase_names[PL_phase];
6563 const char *ph_new = PL_phase_names[phase];
6564
6565 PERL_PHASE_CHANGE(ph_new, ph_old);
6566}
6567
6568#endif
6569
3be8f094 6570/*
14d04a33 6571 * ex: set ts=8 sts=4 sw=4 et:
37442d52 6572 */