This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
doop.c: Change out-of-bounds value
[perl5.git] / doop.c
1 /*    doop.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
5  *
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.
8  *
9  */
10
11 /*
12  *  'So that was the job I felt I had to do when I started,' thought Sam.
13  *
14  *     [p.934 of _The Lord of the Rings_, VI/iii: "Mount Doom"]
15  */
16
17 /* This file contains some common functions needed to carry out certain
18  * ops. For example, both pp_sprintf() and pp_prtf() call the function
19  * do_sprintf() found in this file.
20  */
21
22 #include "EXTERN.h"
23 #define PERL_IN_DOOP_C
24 #include "perl.h"
25
26 #ifndef PERL_MICRO
27 #include <signal.h>
28 #endif
29
30
31 /* Helper function for do_trans().
32  * Handles cases where the search and replacement charlists aren't UTF-8,
33  * aren't identical, and neither the /d nor /s flag is present.
34  *
35  * sv may or may not be utf8.  Note that no code point above 255 can possibly
36  * be in the to-translate set
37  */
38
39 STATIC Size_t
40 S_do_trans_simple(pTHX_ SV * const sv, const OPtrans_map * const tbl)
41 {
42     Size_t matches = 0;
43     STRLEN len;
44     U8 *s = (U8*)SvPV_nomg(sv,len);
45     U8 * const send = s+len;
46
47     PERL_ARGS_ASSERT_DO_TRANS_SIMPLE;
48
49     /* First, take care of non-UTF-8 input strings, because they're easy */
50     if (!SvUTF8(sv)) {
51         while (s < send) {
52             const short ch = tbl->map[*s];
53             if (ch >= 0) {
54                 matches++;
55                 *s = (U8)ch;
56             }
57             s++;
58         }
59         SvSETMAGIC(sv);
60     }
61     else {
62         const bool grows = cBOOL(PL_op->op_private & OPpTRANS_GROWS);
63         U8 *d;
64         U8 *dstart;
65
66         /* Allow for worst-case expansion: Each input byte can become 2.  For a
67          * given input character, this happens when it occupies a single byte
68          * under UTF-8, but is to be translated to something that occupies two:
69          * $_="a".chr(400); tr/a/\xFE/, FE needs encoding. */
70         if (grows)
71             Newx(d, len*2+1, U8);
72         else
73             d = s;
74         dstart = d;
75         while (s < send) {
76             STRLEN ulen;
77             short ch;
78
79             /* Need to check this, otherwise 128..255 won't match */
80             const UV c = utf8n_to_uvchr(s, send - s, &ulen, UTF8_ALLOW_DEFAULT);
81             if (c < 0x100 && (ch = tbl->map[c]) >= 0) {
82                 matches++;
83                 d = uvchr_to_utf8(d, (UV)ch);
84                 s += ulen;
85             }
86             else { /* No match -> copy */
87                 Move(s, d, ulen, U8);
88                 d += ulen;
89                 s += ulen;
90             }
91         }
92         if (grows) {
93             sv_setpvn(sv, (char*)dstart, d - dstart);
94             Safefree(dstart);
95         }
96         else {
97             *d = '\0';
98             SvCUR_set(sv, d - dstart);
99         }
100         SvUTF8_on(sv);
101         SvSETMAGIC(sv);
102     }
103     return matches;
104 }
105
106
107 /* Helper function for do_trans().
108  * Handles cases where the search and replacement charlists are identical and
109  * non-utf8: so the string isn't modified, and only a count of modifiable
110  * chars is needed.
111  *
112  * Note that it doesn't handle /d or /s, since these modify the string even if
113  * the replacement list is empty.
114  *
115  * sv may or may not be utf8.  Note that no code point above 255 can possibly
116  * be in the to-translate set
117  */
118
119 STATIC Size_t
120 S_do_trans_count(pTHX_ SV * const sv, const OPtrans_map * const tbl)
121 {
122     STRLEN len;
123     const U8 *s = (const U8*)SvPV_nomg_const(sv, len);
124     const U8 * const send = s + len;
125     Size_t matches = 0;
126
127     PERL_ARGS_ASSERT_DO_TRANS_COUNT;
128
129     if (!SvUTF8(sv)) {
130         while (s < send) {
131             if (tbl->map[*s++] >= 0)
132                 matches++;
133         }
134     }
135     else {
136         const bool complement = cBOOL(PL_op->op_private & OPpTRANS_COMPLEMENT);
137         while (s < send) {
138             STRLEN ulen;
139             const UV c = utf8n_to_uvchr(s, send - s, &ulen, UTF8_ALLOW_DEFAULT);
140             if (c < 0x100) {
141                 if (tbl->map[c] >= 0)
142                     matches++;
143             } else if (complement)
144                 matches++;
145             s += ulen;
146         }
147     }
148
149     return matches;
150 }
151
152
153 /* Helper function for do_trans().
154  * Handles cases where the search and replacement charlists aren't identical
155  * and both are non-utf8, and one or both of /d, /s is specified.
156  *
157  * sv may or may not be utf8.  Note that no code point above 255 can possibly
158  * be in the to-translate set
159  */
160
161 STATIC Size_t
162 S_do_trans_complex(pTHX_ SV * const sv, const OPtrans_map * const tbl)
163 {
164     STRLEN len;
165     U8 *s = (U8*)SvPV_nomg(sv, len);
166     U8 * const send = s+len;
167     Size_t matches = 0;
168
169     PERL_ARGS_ASSERT_DO_TRANS_COMPLEX;
170
171     if (!SvUTF8(sv)) {
172         U8 *d = s;
173         U8 * const dstart = d;
174
175         if (PL_op->op_private & OPpTRANS_SQUASH) {
176             const U8* p = send;
177             while (s < send) {
178                 const short ch = tbl->map[*s];
179                 if (ch >= 0) {
180                     *d = (U8)ch;
181                     matches++;
182                     if (p != d - 1 || *p != *d)
183                         p = d++;
184                 }
185                 else if (ch == (short) TR_UNMAPPED)
186                     *d++ = *s;
187                 else if (ch == (short) TR_DELETE)
188                     matches++;
189                 s++;
190             }
191         }
192         else {  /* Not to squash */
193             while (s < send) {
194                 const short ch = tbl->map[*s];
195                 if (ch >= 0) {
196                     matches++;
197                     *d++ = (U8)ch;
198                 }
199                 else if (ch == (short) TR_UNMAPPED)
200                     *d++ = *s;
201                 else if (ch == (short) TR_DELETE)
202                     matches++;
203                 s++;
204             }
205         }
206         *d = '\0';
207         SvCUR_set(sv, d - dstart);
208     }
209     else { /* is utf8 */
210         const bool squash = cBOOL(PL_op->op_private & OPpTRANS_SQUASH);
211         const bool grows  = cBOOL(PL_op->op_private & OPpTRANS_GROWS);
212         U8 *d;
213         U8 *dstart;
214         Size_t size = tbl->size;
215
216         /* What the mapping of the previous character was to.  If the new
217          * character has the same mapping, it is squashed from the output (but
218          * still is included in the count) */
219         UV pch = TR_OOB;
220
221         if (grows)
222             /* Allow for worst-case expansion: Each input byte can become 2.
223              * For a given input character, this happens when it occupies a
224              * single byte under UTF-8, but is to be translated to something
225              * that occupies two: */
226             Newx(d, len*2+1, U8);
227         else
228             d = s;
229         dstart = d;
230
231         while (s < send) {
232             STRLEN len;
233             const UV comp = utf8n_to_uvchr(s, send - s, &len,
234                                            UTF8_ALLOW_DEFAULT);
235             UV     ch;
236             short sch;
237
238             sch = tbl->map[comp >= size ? size : comp];
239
240             if (sch >= 0) {
241                 ch = (UV)sch;
242               replace:
243                 matches++;
244                 if (LIKELY(!squash || ch != pch)) {
245                     d = uvchr_to_utf8(d, ch);
246                     pch = ch;
247                 }
248                 s += len;
249                 continue;
250             }
251             else if (sch == (short) TR_UNMAPPED) {
252                 Move(s, d, len, U8);
253                 d += len;
254             }
255             else if (sch == (short) TR_DELETE)
256                 matches++;
257             else {
258                 assert(sch == (short) TR_R_EMPTY);  /* empty replacement */
259                 ch = comp;
260                 goto replace;
261             }
262
263             s += len;
264             pch = TR_OOB;
265         }
266
267         if (grows) {
268             sv_setpvn(sv, (char*)dstart, d - dstart);
269             Safefree(dstart);
270         }
271         else {
272             *d = '\0';
273             SvCUR_set(sv, d - dstart);
274         }
275         SvUTF8_on(sv);
276     }
277     SvSETMAGIC(sv);
278     return matches;
279 }
280
281
282 /* Helper function for do_trans().
283  * Handles utf8 cases(*) not involving the /c, /d, /s flags,
284  * and where search and replacement charlists aren't identical.
285  * (*) i.e. where the search or replacement charlists are utf8. sv may
286  * or may not be utf8.
287  */
288
289 STATIC Size_t
290 S_do_trans_simple_utf8(pTHX_ SV * const sv)
291 {
292     U8 *s;
293     U8 *send;
294     U8 *d;
295     U8 *start;
296     U8 *dstart, *dend;
297     Size_t matches = 0;
298     const bool grows = cBOOL(PL_op->op_private & OPpTRANS_GROWS);
299     STRLEN len;
300     SV* const  rv =
301 #ifdef USE_ITHREADS
302                     PAD_SVl(cPADOP->op_padix);
303 #else
304                     MUTABLE_SV(cSVOP->op_sv);
305 #endif
306     HV* const  hv = MUTABLE_HV(SvRV(rv));
307     SV* const * svp = hv_fetchs(hv, "NONE", FALSE);
308     const UV none = svp ? SvUV(*svp) : 0x7fffffff;
309     const UV extra = none + 1;
310     UV final = 0;
311     U8 hibit = 0;
312
313     PERL_ARGS_ASSERT_DO_TRANS_SIMPLE_UTF8;
314
315     s = (U8*)SvPV_nomg(sv, len);
316     if (!SvUTF8(sv)) {
317         hibit = ! is_utf8_invariant_string(s, len);
318         if (hibit) {
319             s = bytes_to_utf8(s, &len);
320         }
321     }
322     send = s + len;
323     start = s;
324
325     svp = hv_fetchs(hv, "FINAL", FALSE);
326     if (svp)
327         final = SvUV(*svp);
328
329     if (grows) {
330         /* d needs to be bigger than s, in case e.g. upgrading is required */
331         Newx(d, len * 3 + UTF8_MAXBYTES, U8);
332         dend = d + len * 3;
333         dstart = d;
334     }
335     else {
336         dstart = d = s;
337         dend = d + len;
338     }
339
340     while (s < send) {
341         const UV uv = swash_fetch(rv, s, TRUE);
342         if (uv < none) {
343             s += UTF8SKIP(s);
344             matches++;
345             d = uvchr_to_utf8(d, uv);
346         }
347         else if (uv == none) {
348             const int i = UTF8SKIP(s);
349             Move(s, d, i, U8);
350             d += i;
351             s += i;
352         }
353         else if (uv == extra) {
354             s += UTF8SKIP(s);
355             matches++;
356             d = uvchr_to_utf8(d, final);
357         }
358         else
359             s += UTF8SKIP(s);
360
361         if (d > dend) {
362             const STRLEN clen = d - dstart;
363             const STRLEN nlen = dend - dstart + len + UTF8_MAXBYTES;
364             if (!grows)
365                 Perl_croak(aTHX_ "panic: do_trans_simple_utf8 line %d",__LINE__);
366             Renew(dstart, nlen + UTF8_MAXBYTES, U8);
367             d = dstart + clen;
368             dend = dstart + nlen;
369         }
370     }
371     if (grows || hibit) {
372         sv_setpvn(sv, (char*)dstart, d - dstart);
373         Safefree(dstart);
374         if (grows && hibit)
375             Safefree(start);
376     }
377     else {
378         *d = '\0';
379         SvCUR_set(sv, d - dstart);
380     }
381     SvSETMAGIC(sv);
382     SvUTF8_on(sv);
383
384     return matches;
385 }
386
387
388 /* Helper function for do_trans().
389  * Handles utf8 cases(*) where search and replacement charlists are
390  * identical: so the string isn't modified, and only a count of modifiable
391  * chars is needed.
392  * Note that it doesn't handle /d or /s, since these modify the string
393  * even if the replacement charlist is empty.
394  * (*) i.e. where the search or replacement charlists are utf8. sv may
395  * or may not be utf8.
396  */
397
398 STATIC Size_t
399 S_do_trans_count_utf8(pTHX_ SV * const sv)
400 {
401     const U8 *s;
402     const U8 *start = NULL;
403     const U8 *send;
404     Size_t matches = 0;
405     STRLEN len;
406     SV* const  rv =
407 #ifdef USE_ITHREADS
408                     PAD_SVl(cPADOP->op_padix);
409 #else
410                     MUTABLE_SV(cSVOP->op_sv);
411 #endif
412     HV* const hv = MUTABLE_HV(SvRV(rv));
413     SV* const * const svp = hv_fetchs(hv, "NONE", FALSE);
414     const UV none = svp ? SvUV(*svp) : 0x7fffffff;
415     const UV extra = none + 1;
416     U8 hibit = 0;
417
418     PERL_ARGS_ASSERT_DO_TRANS_COUNT_UTF8;
419
420     s = (const U8*)SvPV_nomg_const(sv, len);
421     if (!SvUTF8(sv)) {
422         hibit = ! is_utf8_invariant_string(s, len);
423         if (hibit) {
424             start = s = bytes_to_utf8(s, &len);
425         }
426     }
427     send = s + len;
428
429     while (s < send) {
430         const UV uv = swash_fetch(rv, s, TRUE);
431         if (uv < none || uv == extra)
432             matches++;
433         s += UTF8SKIP(s);
434     }
435     if (hibit)
436         Safefree(start);
437
438     return matches;
439 }
440
441
442 /* Helper function for do_trans().
443  * Handles utf8 cases(*) involving the /c, /d, /s flags,
444  * and where search and replacement charlists aren't identical.
445  * (*) i.e. where the search or replacement charlists are utf8. sv may
446  * or may not be utf8.
447  */
448
449 STATIC Size_t
450 S_do_trans_complex_utf8(pTHX_ SV * const sv)
451 {
452     U8 *start, *send;
453     U8 *d;
454     Size_t matches = 0;
455     const bool squash   = cBOOL(PL_op->op_private & OPpTRANS_SQUASH);
456     const bool del      = cBOOL(PL_op->op_private & OPpTRANS_DELETE);
457     const bool grows    = cBOOL(PL_op->op_private & OPpTRANS_GROWS);
458     SV* const  rv =
459 #ifdef USE_ITHREADS
460                     PAD_SVl(cPADOP->op_padix);
461 #else
462                     MUTABLE_SV(cSVOP->op_sv);
463 #endif
464     HV * const hv = MUTABLE_HV(SvRV(rv));
465     SV * const *svp = hv_fetchs(hv, "NONE", FALSE);
466     const UV none = svp ? SvUV(*svp) : 0x7fffffff;
467     const UV extra = none + 1;
468     UV final = 0;
469     bool havefinal = FALSE;
470     STRLEN len;
471     U8 *dstart, *dend;
472     U8 hibit = 0;
473     U8 *s = (U8*)SvPV_nomg(sv, len);
474
475     PERL_ARGS_ASSERT_DO_TRANS_COMPLEX_UTF8;
476
477     if (!SvUTF8(sv)) {
478         hibit = ! is_utf8_invariant_string(s, len);
479         if (hibit) {
480             s = bytes_to_utf8(s, &len);
481         }
482     }
483     send = s + len;
484     start = s;
485
486     svp = hv_fetchs(hv, "FINAL", FALSE);
487     if (svp) {
488         final = SvUV(*svp);
489         havefinal = TRUE;
490     }
491
492     if (grows) {
493         /* d needs to be bigger than s, in case e.g. upgrading is required */
494         Newx(d, len * 3 + UTF8_MAXBYTES, U8);
495         dend = d + len * 3;
496         dstart = d;
497     }
498     else {
499         dstart = d = s;
500         dend = d + len;
501     }
502
503     if (squash) {
504         UV puv = 0xfeedface;
505         while (s < send) {
506             UV uv = swash_fetch(rv, s, TRUE);
507
508             if (d > dend) {
509                 const STRLEN clen = d - dstart;
510                 const STRLEN nlen = dend - dstart + len + UTF8_MAXBYTES;
511                 if (!grows)
512                     Perl_croak(aTHX_ "panic: do_trans_complex_utf8 line %d",__LINE__);
513                 Renew(dstart, nlen + UTF8_MAXBYTES, U8);
514                 d = dstart + clen;
515                 dend = dstart + nlen;
516             }
517             if (uv < none) {
518                 matches++;
519                 s += UTF8SKIP(s);
520                 if (uv != puv) {
521                     d = uvchr_to_utf8(d, uv);
522                     puv = uv;
523                 }
524                 continue;
525             }
526             else if (uv == none) {      /* "none" is unmapped character */
527                 const int i = UTF8SKIP(s);
528                 Move(s, d, i, U8);
529                 d += i;
530                 s += i;
531                 puv = 0xfeedface;
532                 continue;
533             }
534             else if (uv == extra && !del) {
535                 matches++;
536                 if (havefinal) {
537                     s += UTF8SKIP(s);
538                     if (puv != final) {
539                         d = uvchr_to_utf8(d, final);
540                         puv = final;
541                     }
542                 }
543                 else {
544                     STRLEN len;
545                     uv = utf8n_to_uvchr(s, send - s, &len, UTF8_ALLOW_DEFAULT);
546                     if (uv != puv) {
547                         Move(s, d, len, U8);
548                         d += len;
549                         puv = uv;
550                     }
551                     s += len;
552                 }
553                 continue;
554             }
555             matches++;                  /* "none+1" is delete character */
556             s += UTF8SKIP(s);
557         }
558     }
559     else {
560         while (s < send) {
561             const UV uv = swash_fetch(rv, s, TRUE);
562             if (d > dend) {
563                 const STRLEN clen = d - dstart;
564                 const STRLEN nlen = dend - dstart + len + UTF8_MAXBYTES;
565                 if (!grows)
566                     Perl_croak(aTHX_ "panic: do_trans_complex_utf8 line %d",__LINE__);
567                 Renew(dstart, nlen + UTF8_MAXBYTES, U8);
568                 d = dstart + clen;
569                 dend = dstart + nlen;
570             }
571             if (uv < none) {
572                 matches++;
573                 s += UTF8SKIP(s);
574                 d = uvchr_to_utf8(d, uv);
575                 continue;
576             }
577             else if (uv == none) {      /* "none" is unmapped character */
578                 const int i = UTF8SKIP(s);
579                 Move(s, d, i, U8);
580                 d += i;
581                 s += i;
582                 continue;
583             }
584             else if (uv == extra && !del) {
585                 matches++;
586                 s += UTF8SKIP(s);
587                 d = uvchr_to_utf8(d, final);
588                 continue;
589             }
590             matches++;                  /* "none+1" is delete character */
591             s += UTF8SKIP(s);
592         }
593     }
594     if (grows || hibit) {
595         sv_setpvn(sv, (char*)dstart, d - dstart);
596         Safefree(dstart);
597         if (grows && hibit)
598             Safefree(start);
599     }
600     else {
601         *d = '\0';
602         SvCUR_set(sv, d - dstart);
603     }
604     SvUTF8_on(sv);
605     SvSETMAGIC(sv);
606
607     return matches;
608 }
609
610
611 /* Execute a tr//. sv is the value to be translated, while PL_op
612  * should be an OP_TRANS or OP_TRANSR op, whose op_pv field contains a
613  * translation table or whose op_sv field contains a swash.
614  * Returns a count of number of characters translated
615  */
616
617 Size_t
618 Perl_do_trans(pTHX_ SV *sv)
619 {
620     STRLEN len;
621     const U8 flags = PL_op->op_private;
622     const U8 hasutf = flags & (OPpTRANS_FROM_UTF | OPpTRANS_TO_UTF);
623
624     PERL_ARGS_ASSERT_DO_TRANS;
625
626     if (SvREADONLY(sv) && !(flags & OPpTRANS_IDENTICAL)) {
627         Perl_croak_no_modify();
628     }
629     (void)SvPV_const(sv, len);
630     if (!len)
631         return 0;
632     if (!(flags & OPpTRANS_IDENTICAL)) {
633         if (!SvPOKp(sv) || SvTHINKFIRST(sv))
634             (void)SvPV_force_nomg(sv, len);
635         (void)SvPOK_only_UTF8(sv);
636     }
637
638     /* If we use only OPpTRANS_IDENTICAL to bypass the READONLY check,
639      * we must also rely on it to choose the readonly strategy.
640      */
641     if (flags & OPpTRANS_IDENTICAL) {
642         return hasutf ? do_trans_count_utf8(sv) : do_trans_count(sv, (OPtrans_map*)cPVOP->op_pv);
643     } else if (flags & (OPpTRANS_SQUASH|OPpTRANS_DELETE|OPpTRANS_COMPLEMENT)) {
644         return hasutf ? do_trans_complex_utf8(sv) : do_trans_complex(sv, (OPtrans_map*)cPVOP->op_pv);
645     } else {
646         return hasutf ? do_trans_simple_utf8(sv) : do_trans_simple(sv, (OPtrans_map*)cPVOP->op_pv);
647     }
648 }
649
650 void
651 Perl_do_join(pTHX_ SV *sv, SV *delim, SV **mark, SV **sp)
652 {
653     SV ** const oldmark = mark;
654     I32 items = sp - mark;
655     STRLEN len;
656     STRLEN delimlen;
657     const char * const delims = SvPV_const(delim, delimlen);
658
659     PERL_ARGS_ASSERT_DO_JOIN;
660
661     mark++;
662     len = (items > 0 ? (delimlen * (items - 1) ) : 0);
663     SvUPGRADE(sv, SVt_PV);
664     if (SvLEN(sv) < len + items) {      /* current length is way too short */
665         while (items-- > 0) {
666             if (*mark && !SvGAMAGIC(*mark) && SvOK(*mark)) {
667                 STRLEN tmplen;
668                 SvPV_const(*mark, tmplen);
669                 len += tmplen;
670             }
671             mark++;
672         }
673         SvGROW(sv, len + 1);            /* so try to pre-extend */
674
675         mark = oldmark;
676         items = sp - mark;
677         ++mark;
678     }
679
680     SvPVCLEAR(sv);
681     /* sv_setpv retains old UTF8ness [perl #24846] */
682     SvUTF8_off(sv);
683
684     if (TAINTING_get && SvMAGICAL(sv))
685         SvTAINTED_off(sv);
686
687     if (items-- > 0) {
688         if (*mark)
689             sv_catsv(sv, *mark);
690         mark++;
691     }
692
693     if (delimlen) {
694         const U32 delimflag = DO_UTF8(delim) ? SV_CATUTF8 : SV_CATBYTES;
695         for (; items > 0; items--,mark++) {
696             STRLEN len;
697             const char *s;
698             sv_catpvn_flags(sv,delims,delimlen,delimflag);
699             s = SvPV_const(*mark,len);
700             sv_catpvn_flags(sv,s,len,
701                             DO_UTF8(*mark) ? SV_CATUTF8 : SV_CATBYTES);
702         }
703     }
704     else {
705         for (; items > 0; items--,mark++)
706         {
707             STRLEN len;
708             const char *s = SvPV_const(*mark,len);
709             sv_catpvn_flags(sv,s,len,
710                             DO_UTF8(*mark) ? SV_CATUTF8 : SV_CATBYTES);
711         }
712     }
713     SvSETMAGIC(sv);
714 }
715
716 void
717 Perl_do_sprintf(pTHX_ SV *sv, SSize_t len, SV **sarg)
718 {
719     STRLEN patlen;
720     const char * const pat = SvPV_const(*sarg, patlen);
721     bool do_taint = FALSE;
722
723     PERL_ARGS_ASSERT_DO_SPRINTF;
724     assert(len >= 1);
725
726     if (SvTAINTED(*sarg))
727         TAINT_PROPER(
728                 (PL_op && PL_op->op_type < OP_max)
729                     ? (PL_op->op_type == OP_PRTF)
730                         ? "printf"
731                         : PL_op_name[PL_op->op_type]
732                     : "(unknown)"
733         );
734     SvUTF8_off(sv);
735     if (DO_UTF8(*sarg))
736         SvUTF8_on(sv);
737     sv_vsetpvfn(sv, pat, patlen, NULL, sarg + 1, (Size_t)(len - 1), &do_taint);
738     SvSETMAGIC(sv);
739     if (do_taint)
740         SvTAINTED_on(sv);
741 }
742
743 /* currently converts input to bytes if possible, but doesn't sweat failure */
744 UV
745 Perl_do_vecget(pTHX_ SV *sv, STRLEN offset, int size)
746 {
747     STRLEN srclen, len, avail, uoffset, bitoffs = 0;
748     const I32 svpv_flags = ((PL_op->op_flags & OPf_MOD || LVRET)
749                                           ? SV_UNDEF_RETURNS_NULL : 0);
750     unsigned char *s = (unsigned char *)
751                             SvPV_flags(sv, srclen, (svpv_flags|SV_GMAGIC));
752     UV retnum = 0;
753
754     if (!s) {
755       s = (unsigned char *)"";
756     }
757
758     PERL_ARGS_ASSERT_DO_VECGET;
759
760     if (size < 1 || (size & (size-1))) /* size < 1 or not a power of two */
761         Perl_croak(aTHX_ "Illegal number of bits in vec");
762
763     if (SvUTF8(sv)) {
764         if (Perl_sv_utf8_downgrade_flags(aTHX_ sv, TRUE, 0)) {
765             /* PVX may have changed */
766             s = (unsigned char *) SvPV_flags(sv, srclen, svpv_flags);
767         }
768         else {
769                 Perl_croak(aTHX_ "Use of strings with code points over 0xFF as arguments to vec is forbidden");
770         }
771     }
772
773     if (size < 8) {
774         bitoffs = ((offset%8)*size)%8;
775         uoffset = offset/(8/size);
776     }
777     else if (size > 8) {
778         int n = size/8;
779         if (offset > Size_t_MAX / n - 1) /* would overflow */
780             return 0;
781         uoffset = offset*n;
782     }
783     else
784         uoffset = offset;
785
786     if (uoffset >= srclen)
787         return 0;
788
789     len   = (bitoffs + size + 7)/8; /* required number of bytes */
790     avail = srclen - uoffset;       /* available number of bytes */
791
792     /* Does the byte range overlap the end of the string? If so,
793      * handle specially. */
794     if (avail < len) {
795         if (size <= 8)
796             retnum = 0;
797         else {
798             if (size == 16) {
799                 assert(avail == 1);
800                 retnum = (UV) s[uoffset] <<  8;
801             }
802             else if (size == 32) {
803                 assert(avail >= 1 && avail <= 3);
804                 if (avail == 1)
805                     retnum =
806                         ((UV) s[uoffset    ] << 24);
807                 else if (avail == 2)
808                     retnum =
809                         ((UV) s[uoffset    ] << 24) +
810                         ((UV) s[uoffset + 1] << 16);
811                 else
812                     retnum =
813                         ((UV) s[uoffset    ] << 24) +
814                         ((UV) s[uoffset + 1] << 16) +
815                         (     s[uoffset + 2] <<  8);
816             }
817 #ifdef UV_IS_QUAD
818             else if (size == 64) {
819                 Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
820                                "Bit vector size > 32 non-portable");
821                 assert(avail >= 1 && avail <= 7);
822                 if (avail == 1)
823                     retnum =
824                         (UV) s[uoffset     ] << 56;
825                 else if (avail == 2)
826                     retnum =
827                         ((UV) s[uoffset    ] << 56) +
828                         ((UV) s[uoffset + 1] << 48);
829                 else if (avail == 3)
830                     retnum =
831                         ((UV) s[uoffset    ] << 56) +
832                         ((UV) s[uoffset + 1] << 48) +
833                         ((UV) s[uoffset + 2] << 40);
834                 else if (avail == 4)
835                     retnum =
836                         ((UV) s[uoffset    ] << 56) +
837                         ((UV) s[uoffset + 1] << 48) +
838                         ((UV) s[uoffset + 2] << 40) +
839                         ((UV) s[uoffset + 3] << 32);
840                 else if (avail == 5)
841                     retnum =
842                         ((UV) s[uoffset    ] << 56) +
843                         ((UV) s[uoffset + 1] << 48) +
844                         ((UV) s[uoffset + 2] << 40) +
845                         ((UV) s[uoffset + 3] << 32) +
846                         ((UV) s[uoffset + 4] << 24);
847                 else if (avail == 6)
848                     retnum =
849                         ((UV) s[uoffset    ] << 56) +
850                         ((UV) s[uoffset + 1] << 48) +
851                         ((UV) s[uoffset + 2] << 40) +
852                         ((UV) s[uoffset + 3] << 32) +
853                         ((UV) s[uoffset + 4] << 24) +
854                         ((UV) s[uoffset + 5] << 16);
855                 else
856                     retnum =
857                         ((UV) s[uoffset    ] << 56) +
858                         ((UV) s[uoffset + 1] << 48) +
859                         ((UV) s[uoffset + 2] << 40) +
860                         ((UV) s[uoffset + 3] << 32) +
861                         ((UV) s[uoffset + 4] << 24) +
862                         ((UV) s[uoffset + 5] << 16) +
863                         ((UV) s[uoffset + 6] <<  8);
864             }
865 #endif
866         }
867     }
868     else if (size < 8)
869         retnum = (s[uoffset] >> bitoffs) & ((1 << size) - 1);
870     else {
871         if (size == 8)
872             retnum = s[uoffset];
873         else if (size == 16)
874             retnum =
875                 ((UV) s[uoffset] <<      8) +
876                       s[uoffset + 1];
877         else if (size == 32)
878             retnum =
879                 ((UV) s[uoffset    ] << 24) +
880                 ((UV) s[uoffset + 1] << 16) +
881                 (     s[uoffset + 2] <<  8) +
882                       s[uoffset + 3];
883 #ifdef UV_IS_QUAD
884         else if (size == 64) {
885             Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
886                            "Bit vector size > 32 non-portable");
887             retnum =
888                 ((UV) s[uoffset    ] << 56) +
889                 ((UV) s[uoffset + 1] << 48) +
890                 ((UV) s[uoffset + 2] << 40) +
891                 ((UV) s[uoffset + 3] << 32) +
892                 ((UV) s[uoffset + 4] << 24) +
893                 ((UV) s[uoffset + 5] << 16) +
894                 (     s[uoffset + 6] <<  8) +
895                       s[uoffset + 7];
896         }
897 #endif
898     }
899
900     return retnum;
901 }
902
903 /* currently converts input to bytes if possible but doesn't sweat failures,
904  * although it does ensure that the string it clobbers is not marked as
905  * utf8-valid any more
906  */
907 void
908 Perl_do_vecset(pTHX_ SV *sv)
909 {
910     STRLEN offset, bitoffs = 0;
911     int size;
912     unsigned char *s;
913     UV lval;
914     I32 mask;
915     STRLEN targlen;
916     STRLEN len;
917     SV * const targ = LvTARG(sv);
918     char errflags = LvFLAGS(sv);
919
920     PERL_ARGS_ASSERT_DO_VECSET;
921
922     /* some out-of-range errors have been deferred if/until the LV is
923      * actually written to: f(vec($s,-1,8)) is not always fatal */
924     if (errflags) {
925         assert(!(errflags & ~(LVf_NEG_OFF|LVf_OUT_OF_RANGE)));
926         if (errflags & LVf_NEG_OFF)
927             Perl_croak_nocontext("Negative offset to vec in lvalue context");
928         Perl_croak_nocontext("Out of memory!");
929     }
930
931     if (!targ)
932         return;
933     s = (unsigned char*)SvPV_force_flags(targ, targlen,
934                                          SV_GMAGIC | SV_UNDEF_RETURNS_NULL);
935     if (SvUTF8(targ)) {
936         /* This is handled by the SvPOK_only below...
937         if (!Perl_sv_utf8_downgrade_flags(aTHX_ targ, TRUE, 0))
938             SvUTF8_off(targ);
939          */
940         (void) Perl_sv_utf8_downgrade_flags(aTHX_ targ, TRUE, 0);
941     }
942
943     (void)SvPOK_only(targ);
944     lval = SvUV(sv);
945     offset = LvTARGOFF(sv);
946     size = LvTARGLEN(sv);
947
948     if (size < 1 || (size & (size-1))) /* size < 1 or not a power of two */
949         Perl_croak(aTHX_ "Illegal number of bits in vec");
950
951     if (size < 8) {
952         bitoffs = ((offset%8)*size)%8;
953         offset /= 8/size;
954     }
955     else if (size > 8) {
956         int n = size/8;
957         if (offset > Size_t_MAX / n - 1) /* would overflow */
958             Perl_croak_nocontext("Out of memory!");
959         offset *= n;
960     }
961
962     len = (bitoffs + size + 7)/8;       /* required number of bytes */
963     if (targlen < offset || targlen - offset < len) {
964         STRLEN newlen = offset > Size_t_MAX - len - 1 ? /* avoid overflow */
965                                         Size_t_MAX : offset + len + 1;
966         s = (unsigned char*)SvGROW(targ, newlen);
967         (void)memzero((char *)(s + targlen), newlen - targlen);
968         SvCUR_set(targ, newlen - 1);
969     }
970
971     if (size < 8) {
972         mask = (1 << size) - 1;
973         lval &= mask;
974         s[offset] &= ~(mask << bitoffs);
975         s[offset] |= lval << bitoffs;
976     }
977     else {
978         if (size == 8)
979             s[offset  ] = (U8)( lval        & 0xff);
980         else if (size == 16) {
981             s[offset  ] = (U8)((lval >>  8) & 0xff);
982             s[offset+1] = (U8)( lval        & 0xff);
983         }
984         else if (size == 32) {
985             s[offset  ] = (U8)((lval >> 24) & 0xff);
986             s[offset+1] = (U8)((lval >> 16) & 0xff);
987             s[offset+2] = (U8)((lval >>  8) & 0xff);
988             s[offset+3] = (U8)( lval        & 0xff);
989         }
990 #ifdef UV_IS_QUAD
991         else if (size == 64) {
992             Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
993                            "Bit vector size > 32 non-portable");
994             s[offset  ] = (U8)((lval >> 56) & 0xff);
995             s[offset+1] = (U8)((lval >> 48) & 0xff);
996             s[offset+2] = (U8)((lval >> 40) & 0xff);
997             s[offset+3] = (U8)((lval >> 32) & 0xff);
998             s[offset+4] = (U8)((lval >> 24) & 0xff);
999             s[offset+5] = (U8)((lval >> 16) & 0xff);
1000             s[offset+6] = (U8)((lval >>  8) & 0xff);
1001             s[offset+7] = (U8)( lval        & 0xff);
1002         }
1003 #endif
1004     }
1005     SvSETMAGIC(targ);
1006 }
1007
1008 void
1009 Perl_do_vop(pTHX_ I32 optype, SV *sv, SV *left, SV *right)
1010 {
1011     long *dl;
1012     long *ll;
1013     long *rl;
1014     char *dc;
1015     STRLEN leftlen;
1016     STRLEN rightlen;
1017     const char *lc;
1018     const char *rc;
1019     STRLEN len = 0;
1020     STRLEN lensave;
1021     const char *lsave;
1022     const char *rsave;
1023     STRLEN needlen = 0;
1024     bool result_needs_to_be_utf8 = FALSE;
1025     bool left_utf8 = FALSE;
1026     bool right_utf8 = FALSE;
1027     U8 * left_non_downgraded = NULL;
1028     U8 * right_non_downgraded = NULL;
1029     Size_t left_non_downgraded_len = 0;
1030     Size_t right_non_downgraded_len = 0;
1031     char * non_downgraded = NULL;
1032     Size_t non_downgraded_len = 0;
1033
1034     PERL_ARGS_ASSERT_DO_VOP;
1035
1036     if (sv != left || (optype != OP_BIT_AND && !SvOK(sv)))
1037         SvPVCLEAR(sv);        /* avoid undef warning on |= and ^= */
1038     if (sv == left) {
1039         lc = SvPV_force_nomg(left, leftlen);
1040     }
1041     else {
1042         lc = SvPV_nomg_const(left, leftlen);
1043         SvPV_force_nomg_nolen(sv);
1044     }
1045     rc = SvPV_nomg_const(right, rightlen);
1046
1047     /* This needs to come after SvPV to ensure that string overloading has
1048        fired off.  */
1049
1050     /* Create downgraded temporaries of any UTF-8 encoded operands */
1051     if (DO_UTF8(left)) {
1052         const U8 * save_lc = (U8 *) lc;
1053
1054         left_utf8 = TRUE;
1055         result_needs_to_be_utf8 = TRUE;
1056
1057         left_non_downgraded_len = leftlen;
1058         lc = (char *) bytes_from_utf8_loc((const U8 *) lc, &leftlen,
1059                                           &left_utf8,
1060                                           (const U8 **) &left_non_downgraded);
1061         /* Calculate the number of trailing unconvertible bytes.  This quantity
1062          * is the original length minus the length of the converted portion. */
1063         left_non_downgraded_len -= left_non_downgraded - save_lc;
1064         SAVEFREEPV(lc);
1065     }
1066     if (DO_UTF8(right)) {
1067         const U8 * save_rc = (U8 *) rc;
1068
1069         right_utf8 = TRUE;
1070         result_needs_to_be_utf8 = TRUE;
1071
1072         right_non_downgraded_len = rightlen;
1073         rc = (char *) bytes_from_utf8_loc((const U8 *) rc, &rightlen,
1074                                           &right_utf8,
1075                                           (const U8 **) &right_non_downgraded);
1076         right_non_downgraded_len -= right_non_downgraded - save_rc;
1077         SAVEFREEPV(rc);
1078     }
1079
1080     /* We set 'len' to the length that the operation actually operates on.  The
1081      * dangling part of the longer operand doesn't actually participate in the
1082      * operation.  What happens is that we pretend that the shorter operand has
1083      * been extended to the right by enough imaginary zeros to match the length
1084      * of the longer one.  But we know in advance the result of the operation
1085      * on zeros without having to do it.  In the case of '&', the result is
1086      * zero, and the dangling portion is simply discarded.  For '|' and '^', the
1087      * result is the same as the other operand, so the dangling part is just
1088      * appended to the final result, unchanged.  As of perl-5.32, we no longer
1089      * accept above-FF code points in the dangling portion.
1090      */
1091     if (left_utf8 || right_utf8) {
1092         Perl_croak(aTHX_ FATAL_ABOVE_FF_MSG, PL_op_desc[optype]);
1093     }
1094     else {  /* Neither is UTF-8 */
1095         len = MIN(leftlen, rightlen);
1096     }
1097
1098     lensave = len;
1099     lsave = lc;
1100     rsave = rc;
1101
1102     SvCUR_set(sv, len);
1103     (void)SvPOK_only(sv);
1104     if (SvOK(sv) || SvTYPE(sv) > SVt_PVMG) {
1105         dc = SvPV_force_nomg_nolen(sv);
1106         if (SvLEN(sv) < len + 1) {
1107             dc = SvGROW(sv, len + 1);
1108             (void)memzero(dc + SvCUR(sv), len - SvCUR(sv) + 1);
1109         }
1110     }
1111     else {
1112         needlen = optype == OP_BIT_AND
1113                     ? len : (leftlen > rightlen ? leftlen : rightlen);
1114         Newxz(dc, needlen + 1, char);
1115         sv_usepvn_flags(sv, dc, needlen, SV_HAS_TRAILING_NUL);
1116         dc = SvPVX(sv);         /* sv_usepvn() calls Renew() */
1117     }
1118
1119     if (len >= sizeof(long)*4 &&
1120         !(PTR2nat(dc) % sizeof(long)) &&
1121         !(PTR2nat(lc) % sizeof(long)) &&
1122         !(PTR2nat(rc) % sizeof(long)))  /* It's almost always aligned... */
1123     {
1124         const STRLEN remainder = len % (sizeof(long)*4);
1125         len /= (sizeof(long)*4);
1126
1127         dl = (long*)dc;
1128         ll = (long*)lc;
1129         rl = (long*)rc;
1130
1131         switch (optype) {
1132         case OP_BIT_AND:
1133             while (len--) {
1134                 *dl++ = *ll++ & *rl++;
1135                 *dl++ = *ll++ & *rl++;
1136                 *dl++ = *ll++ & *rl++;
1137                 *dl++ = *ll++ & *rl++;
1138             }
1139             break;
1140         case OP_BIT_XOR:
1141             while (len--) {
1142                 *dl++ = *ll++ ^ *rl++;
1143                 *dl++ = *ll++ ^ *rl++;
1144                 *dl++ = *ll++ ^ *rl++;
1145                 *dl++ = *ll++ ^ *rl++;
1146             }
1147             break;
1148         case OP_BIT_OR:
1149             while (len--) {
1150                 *dl++ = *ll++ | *rl++;
1151                 *dl++ = *ll++ | *rl++;
1152                 *dl++ = *ll++ | *rl++;
1153                 *dl++ = *ll++ | *rl++;
1154             }
1155         }
1156
1157         dc = (char*)dl;
1158         lc = (char*)ll;
1159         rc = (char*)rl;
1160
1161         len = remainder;
1162     }
1163
1164     switch (optype) {
1165     case OP_BIT_AND:
1166         while (len--)
1167             *dc++ = *lc++ & *rc++;
1168         *dc = '\0';
1169         break;
1170     case OP_BIT_XOR:
1171         while (len--)
1172             *dc++ = *lc++ ^ *rc++;
1173         goto mop_up;
1174     case OP_BIT_OR:
1175         while (len--)
1176             *dc++ = *lc++ | *rc++;
1177       mop_up:
1178         len = lensave;
1179         if (rightlen > len) {
1180             if (dc == rc)
1181                 SvCUR_set(sv, rightlen);
1182             else
1183                 sv_catpvn_nomg(sv, rsave + len, rightlen - len);
1184         }
1185         else if (leftlen > len) {
1186             if (dc == lc)
1187                 SvCUR_set(sv, leftlen);
1188             else
1189                 sv_catpvn_nomg(sv, lsave + len, leftlen - len);
1190         }
1191         *SvEND(sv) = '\0';
1192
1193         /* If there is trailing stuff that couldn't be converted from UTF-8, it
1194          * is appended as-is for the ^ and | operators.  This preserves
1195          * backwards compatibility */
1196         if (right_non_downgraded) {
1197             non_downgraded = (char *) right_non_downgraded;
1198             non_downgraded_len = right_non_downgraded_len;
1199         }
1200         else if (left_non_downgraded) {
1201             non_downgraded = (char *) left_non_downgraded;
1202             non_downgraded_len = left_non_downgraded_len;
1203         }
1204
1205         break;
1206     }
1207
1208     if (result_needs_to_be_utf8) {
1209         sv_utf8_upgrade_nomg(sv);
1210
1211         /* Append any trailing UTF-8 as-is. */
1212         if (non_downgraded) {
1213             sv_catpvn_nomg(sv, non_downgraded, non_downgraded_len);
1214         }
1215     }
1216
1217     SvTAINT(sv);
1218 }
1219
1220
1221 /* Perl_do_kv() may be:
1222  *  * called directly as the pp function for pp_keys() and pp_values();
1223  *  * It may also be called directly when the op is OP_AVHVSWITCH, to
1224  *       implement CORE::keys(), CORE::values().
1225  *
1226  * In all cases it expects an HV on the stack and returns a list of keys,
1227  * values, or key-value pairs, depending on PL_op.
1228  */
1229
1230 OP *
1231 Perl_do_kv(pTHX)
1232 {
1233     dSP;
1234     HV * const keys = MUTABLE_HV(POPs);
1235     const U8 gimme = GIMME_V;
1236
1237     const I32 dokeys   =     (PL_op->op_type == OP_KEYS)
1238                           || (    PL_op->op_type == OP_AVHVSWITCH
1239                               && (PL_op->op_private & OPpAVHVSWITCH_MASK)
1240                                     + OP_EACH == OP_KEYS);
1241
1242     const I32 dovalues =     (PL_op->op_type == OP_VALUES)
1243                           || (    PL_op->op_type == OP_AVHVSWITCH
1244                               && (PL_op->op_private & OPpAVHVSWITCH_MASK)
1245                                      + OP_EACH == OP_VALUES);
1246
1247     assert(   PL_op->op_type == OP_KEYS
1248            || PL_op->op_type == OP_VALUES
1249            || PL_op->op_type == OP_AVHVSWITCH);
1250
1251     assert(!(    PL_op->op_type == OP_VALUES
1252              && (PL_op->op_private & OPpMAYBE_LVSUB)));
1253
1254     (void)hv_iterinit(keys);    /* always reset iterator regardless */
1255
1256     if (gimme == G_VOID)
1257         RETURN;
1258
1259     if (gimme == G_SCALAR) {
1260         if (PL_op->op_flags & OPf_MOD || LVRET) {       /* lvalue */
1261             SV * const ret = sv_2mortal(newSV_type(SVt_PVLV));  /* Not TARG RT#67838 */
1262             sv_magic(ret, NULL, PERL_MAGIC_nkeys, NULL, 0);
1263             LvTYPE(ret) = 'k';
1264             LvTARG(ret) = SvREFCNT_inc_simple(keys);
1265             PUSHs(ret);
1266         }
1267         else {
1268             IV i;
1269             dTARGET;
1270
1271             /* note that in 'scalar(keys %h)' the OP_KEYS is usually
1272              * optimised away and the action is performed directly by the
1273              * padhv or rv2hv op. We now only get here via OP_AVHVSWITCH
1274              * and \&CORE::keys
1275              */
1276             if (! SvTIED_mg((const SV *)keys, PERL_MAGIC_tied) ) {
1277                 i = HvUSEDKEYS(keys);
1278             }
1279             else {
1280                 i = 0;
1281                 while (hv_iternext(keys)) i++;
1282             }
1283             PUSHi( i );
1284         }
1285         RETURN;
1286     }
1287
1288     if (UNLIKELY(PL_op->op_private & OPpMAYBE_LVSUB)) {
1289         const I32 flags = is_lvalue_sub();
1290         if (flags && !(flags & OPpENTERSUB_INARGS))
1291             /* diag_listed_as: Can't modify %s in %s */
1292             Perl_croak(aTHX_ "Can't modify keys in list assignment");
1293     }
1294
1295     PUTBACK;
1296     hv_pushkv(keys, (dokeys | (dovalues << 1)));
1297     return NORMAL;
1298 }
1299
1300 /*
1301  * ex: set ts=8 sts=4 sw=4 et:
1302  */