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