This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlclib: Use proper reference
[perl5.git] / perlio.c
... / ...
CommitLineData
1/*
2 * perlio.c
3 * Copyright (c) 1996-2006, Nick Ing-Simmons
4 * Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011 Larry Wall and others
5 *
6 * You may distribute under the terms of either the GNU General Public License
7 * or the Artistic License, as specified in the README file.
8 */
9
10/*
11 * Hour after hour for nearly three weary days he had jogged up and down,
12 * over passes, and through long dales, and across many streams.
13 *
14 * [pp.791-792 of _The Lord of the Rings_, V/iii: "The Muster of Rohan"]
15 */
16
17/* This file contains the functions needed to implement PerlIO, which
18 * is Perl's private replacement for the C stdio library. This is used
19 * by default unless you compile with -Uuseperlio or run with
20 * PERLIO=:stdio (but don't do this unless you know what you're doing)
21 */
22
23/*
24 * If we have ActivePerl-like PERL_IMPLICIT_SYS then we need a dTHX to get
25 * at the dispatch tables, even when we do not need it for other reasons.
26 * Invent a dSYS macro to abstract this out
27 */
28#ifdef PERL_IMPLICIT_SYS
29#define dSYS dTHX
30#else
31#define dSYS dNOOP
32#endif
33
34#define PERLIO_NOT_STDIO 0
35/*
36 * This file provides those parts of PerlIO abstraction
37 * which are not #defined in perlio.h.
38 * Which these are depends on various Configure #ifdef's
39 */
40
41#include "EXTERN.h"
42#define PERL_IN_PERLIO_C
43#include "perl.h"
44
45#ifdef PERL_IMPLICIT_CONTEXT
46#undef dSYS
47#define dSYS dTHX
48#endif
49
50#include "XSUB.h"
51
52#ifdef VMS
53#include <rms.h>
54#endif
55
56#define PerlIO_lockcnt(f) (((PerlIOl*)(f))->head->flags)
57
58/* Call the callback or PerlIOBase, and return failure. */
59#define Perl_PerlIO_or_Base(f, callback, base, failure, args) \
60 if (PerlIOValid(f)) { \
61 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
62 if (tab && tab->callback) \
63 return (*tab->callback) args; \
64 else \
65 return PerlIOBase_ ## base args; \
66 } \
67 else \
68 SETERRNO(EBADF, SS_IVCHAN); \
69 return failure
70
71/* Call the callback or fail, and return failure. */
72#define Perl_PerlIO_or_fail(f, callback, failure, args) \
73 if (PerlIOValid(f)) { \
74 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
75 if (tab && tab->callback) \
76 return (*tab->callback) args; \
77 SETERRNO(EINVAL, LIB_INVARG); \
78 } \
79 else \
80 SETERRNO(EBADF, SS_IVCHAN); \
81 return failure
82
83/* Call the callback or PerlIOBase, and be void. */
84#define Perl_PerlIO_or_Base_void(f, callback, base, args) \
85 if (PerlIOValid(f)) { \
86 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
87 if (tab && tab->callback) \
88 (*tab->callback) args; \
89 else \
90 PerlIOBase_ ## base args; \
91 } \
92 else \
93 SETERRNO(EBADF, SS_IVCHAN)
94
95/* Call the callback or fail, and be void. */
96#define Perl_PerlIO_or_fail_void(f, callback, args) \
97 if (PerlIOValid(f)) { \
98 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
99 if (tab && tab->callback) \
100 (*tab->callback) args; \
101 else \
102 SETERRNO(EINVAL, LIB_INVARG); \
103 } \
104 else \
105 SETERRNO(EBADF, SS_IVCHAN)
106
107#if defined(__osf__) && _XOPEN_SOURCE < 500
108extern int fseeko(FILE *, off_t, int);
109extern off_t ftello(FILE *);
110#endif
111
112#define NATIVE_0xd CR_NATIVE
113#define NATIVE_0xa LF_NATIVE
114
115EXTERN_C int perlsio_binmode(FILE *fp, int iotype, int mode);
116
117int
118perlsio_binmode(FILE *fp, int iotype, int mode)
119{
120 /*
121 * This used to be contents of do_binmode in doio.c
122 */
123#ifdef DOSISH
124 dTHX;
125 PERL_UNUSED_ARG(iotype);
126#ifdef NETWARE
127 if (PerlLIO_setmode(fp, mode) != -1) {
128#else
129 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
130#endif
131 return 1;
132 }
133 else
134 return 0;
135#else
136# if defined(USEMYBINMODE)
137 dTHX;
138# if defined(__CYGWIN__)
139 PERL_UNUSED_ARG(iotype);
140# endif
141 if (my_binmode(fp, iotype, mode) != FALSE)
142 return 1;
143 else
144 return 0;
145# else
146 PERL_UNUSED_ARG(fp);
147 PERL_UNUSED_ARG(iotype);
148 PERL_UNUSED_ARG(mode);
149 return 1;
150# endif
151#endif
152}
153
154#ifndef O_ACCMODE
155#define O_ACCMODE 3 /* Assume traditional implementation */
156#endif
157
158int
159PerlIO_intmode2str(int rawmode, char *mode, int *writing)
160{
161 const int result = rawmode & O_ACCMODE;
162 int ix = 0;
163 int ptype;
164 switch (result) {
165 case O_RDONLY:
166 ptype = IoTYPE_RDONLY;
167 break;
168 case O_WRONLY:
169 ptype = IoTYPE_WRONLY;
170 break;
171 case O_RDWR:
172 default:
173 ptype = IoTYPE_RDWR;
174 break;
175 }
176 if (writing)
177 *writing = (result != O_RDONLY);
178
179 if (result == O_RDONLY) {
180 mode[ix++] = 'r';
181 }
182#ifdef O_APPEND
183 else if (rawmode & O_APPEND) {
184 mode[ix++] = 'a';
185 if (result != O_WRONLY)
186 mode[ix++] = '+';
187 }
188#endif
189 else {
190 if (result == O_WRONLY)
191 mode[ix++] = 'w';
192 else {
193 mode[ix++] = 'r';
194 mode[ix++] = '+';
195 }
196 }
197#if O_BINARY != 0
198 /* Unless O_BINARY is different from zero, bit-and:ing
199 * with it won't do much good. */
200 if (rawmode & O_BINARY)
201 mode[ix++] = 'b';
202# endif
203 mode[ix] = '\0';
204 return ptype;
205}
206
207#ifndef PERLIO_LAYERS
208int
209PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
210{
211 if (!names || !*names
212 || strEQ(names, ":crlf")
213 || strEQ(names, ":raw")
214 || strEQ(names, ":bytes")
215 ) {
216 return 0;
217 }
218 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
219 /*
220 * NOTREACHED
221 */
222 return -1;
223}
224
225void
226PerlIO_destruct(pTHX)
227{
228}
229
230int
231PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
232{
233 return perlsio_binmode(fp, iotype, mode);
234}
235
236PerlIO *
237PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
238{
239#if defined(PERL_MICRO)
240 return NULL;
241#elif defined(PERL_IMPLICIT_SYS)
242 return PerlSIO_fdupopen(f);
243#else
244# ifdef WIN32
245 return win32_fdupopen(f);
246# else
247 if (f) {
248 const int fd = PerlLIO_dup_cloexec(PerlIO_fileno(f));
249 if (fd >= 0) {
250 char mode[8];
251# ifdef DJGPP
252 const int omode = djgpp_get_stream_mode(f);
253# else
254 const int omode = fcntl(fd, F_GETFL);
255# endif
256 PerlIO_intmode2str(omode,mode,NULL);
257 /* the r+ is a hack */
258 return PerlIO_fdopen(fd, mode);
259 }
260 return NULL;
261 }
262 else {
263 SETERRNO(EBADF, SS_IVCHAN);
264 }
265# endif
266 return NULL;
267#endif
268}
269
270
271/*
272 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
273 */
274
275PerlIO *
276PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
277 int imode, int perm, PerlIO *old, int narg, SV **args)
278{
279 if (narg) {
280 if (narg > 1) {
281 Perl_croak(aTHX_ "More than one argument to open");
282 }
283 if (*args == &PL_sv_undef)
284 return PerlIO_tmpfile();
285 else {
286 STRLEN len;
287 const char *name = SvPV_const(*args, len);
288 if (!IS_SAFE_PATHNAME(name, len, "open"))
289 return NULL;
290
291 if (*mode == IoTYPE_NUMERIC) {
292 fd = PerlLIO_open3_cloexec(name, imode, perm);
293 if (fd >= 0)
294 return PerlIO_fdopen(fd, mode + 1);
295 }
296 else if (old) {
297 return PerlIO_reopen(name, mode, old);
298 }
299 else {
300 return PerlIO_open(name, mode);
301 }
302 }
303 }
304 else {
305 return PerlIO_fdopen(fd, (char *) mode);
306 }
307 return NULL;
308}
309
310XS(XS_PerlIO__Layer__find); /* prototype to pass -Wmissing-prototypes */
311XS(XS_PerlIO__Layer__find)
312{
313 dXSARGS;
314 if (items < 2)
315 Perl_croak(aTHX_ "Usage class->find(name[,load])");
316 else {
317 const char * const name = SvPV_nolen_const(ST(1));
318 ST(0) = (strEQ(name, "crlf")
319 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
320 XSRETURN(1);
321 }
322}
323
324
325void
326Perl_boot_core_PerlIO(pTHX)
327{
328 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
329}
330
331#endif
332
333
334/*======================================================================================*/
335/*
336 * Implement all the PerlIO interface ourselves.
337 */
338
339#include "perliol.h"
340
341void
342PerlIO_debug(const char *fmt, ...)
343{
344 va_list ap;
345 dSYS;
346
347 if (!DEBUG_i_TEST)
348 return;
349
350 va_start(ap, fmt);
351
352 if (!PL_perlio_debug_fd) {
353 if (!TAINTING_get &&
354 PerlProc_getuid() == PerlProc_geteuid() &&
355 PerlProc_getgid() == PerlProc_getegid()) {
356 const char * const s = PerlEnv_getenv("PERLIO_DEBUG");
357 if (s && *s)
358 PL_perlio_debug_fd = PerlLIO_open3_cloexec(s,
359 O_WRONLY | O_CREAT | O_APPEND, 0666);
360 else
361 PL_perlio_debug_fd = PerlLIO_dup_cloexec(2); /* stderr */
362 } else {
363 /* tainting or set*id, so ignore the environment and send the
364 debug output to stderr, like other -D switches. */
365 PL_perlio_debug_fd = PerlLIO_dup_cloexec(2); /* stderr */
366 }
367 }
368 if (PL_perlio_debug_fd > 0) {
369#ifdef USE_ITHREADS
370 const char * const s = CopFILE(PL_curcop);
371 /* Use fixed buffer as sv_catpvf etc. needs SVs */
372 char buffer[1024];
373 const STRLEN len1 = my_snprintf(buffer, sizeof(buffer), "%.40s:%" IVdf " ", s ? s : "(none)", (IV) CopLINE(PL_curcop));
374# ifdef USE_QUADMATH
375# ifdef HAS_VSNPRINTF
376 /* my_vsnprintf() isn't available with quadmath, but the native vsnprintf()
377 should be, otherwise the system isn't likely to support quadmath.
378 Nothing should be calling PerlIO_debug() with floating point anyway.
379 */
380 const STRLEN len2 = vsnprintf(buffer + len1, sizeof(buffer) - len1, fmt, ap);
381# else
382 STATIC_ASSERT_STMT(0);
383# endif
384# else
385 const STRLEN len2 = my_vsnprintf(buffer + len1, sizeof(buffer) - len1, fmt, ap);
386# endif
387 PERL_UNUSED_RESULT(PerlLIO_write(PL_perlio_debug_fd, buffer, len1 + len2));
388#else
389 const char *s = CopFILE(PL_curcop);
390 STRLEN len;
391 SV * const sv = Perl_newSVpvf(aTHX_ "%s:%" IVdf " ", s ? s : "(none)",
392 (IV) CopLINE(PL_curcop));
393 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
394
395 s = SvPV_const(sv, len);
396 PERL_UNUSED_RESULT(PerlLIO_write(PL_perlio_debug_fd, s, len));
397 SvREFCNT_dec(sv);
398#endif
399 }
400 va_end(ap);
401}
402
403/*--------------------------------------------------------------------------------------*/
404
405/*
406 * Inner level routines
407 */
408
409/* check that the head field of each layer points back to the head */
410
411#ifdef DEBUGGING
412# define VERIFY_HEAD(f) PerlIO_verify_head(aTHX_ f)
413static void
414PerlIO_verify_head(pTHX_ PerlIO *f)
415{
416 PerlIOl *head, *p;
417 int seen = 0;
418#ifndef PERL_IMPLICIT_SYS
419 PERL_UNUSED_CONTEXT;
420#endif
421 if (!PerlIOValid(f))
422 return;
423 p = head = PerlIOBase(f)->head;
424 assert(p);
425 do {
426 assert(p->head == head);
427 if (p == (PerlIOl*)f)
428 seen = 1;
429 p = p->next;
430 } while (p);
431 assert(seen);
432}
433#else
434# define VERIFY_HEAD(f)
435#endif
436
437
438/*
439 * Table of pointers to the PerlIO structs (malloc'ed)
440 */
441#define PERLIO_TABLE_SIZE 64
442
443static void
444PerlIO_init_table(pTHX)
445{
446 if (PL_perlio)
447 return;
448 Newxz(PL_perlio, PERLIO_TABLE_SIZE, PerlIOl);
449}
450
451
452
453PerlIO *
454PerlIO_allocate(pTHX)
455{
456 /*
457 * Find a free slot in the table, allocating new table as necessary
458 */
459 PerlIOl **last;
460 PerlIOl *f;
461 last = &PL_perlio;
462 while ((f = *last)) {
463 int i;
464 last = (PerlIOl **) (f);
465 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
466 if (!((++f)->next)) {
467 goto good_exit;
468 }
469 }
470 }
471 Newxz(f,PERLIO_TABLE_SIZE,PerlIOl);
472 if (!f) {
473 return NULL;
474 }
475 *last = (PerlIOl*) f++;
476
477 good_exit:
478 f->flags = 0; /* lockcnt */
479 f->tab = NULL;
480 f->head = f;
481 return (PerlIO*) f;
482}
483
484#undef PerlIO_fdupopen
485PerlIO *
486PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
487{
488 if (PerlIOValid(f)) {
489 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
490 DEBUG_i( PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param) );
491 if (tab && tab->Dup)
492 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
493 else {
494 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
495 }
496 }
497 else
498 SETERRNO(EBADF, SS_IVCHAN);
499
500 return NULL;
501}
502
503void
504PerlIO_cleantable(pTHX_ PerlIOl **tablep)
505{
506 PerlIOl * const table = *tablep;
507 if (table) {
508 int i;
509 PerlIO_cleantable(aTHX_(PerlIOl **) & (table[0]));
510 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
511 PerlIOl * const f = table + i;
512 if (f->next) {
513 PerlIO_close(&(f->next));
514 }
515 }
516 Safefree(table);
517 *tablep = NULL;
518 }
519}
520
521
522PerlIO_list_t *
523PerlIO_list_alloc(pTHX)
524{
525 PerlIO_list_t *list;
526 PERL_UNUSED_CONTEXT;
527 Newxz(list, 1, PerlIO_list_t);
528 list->refcnt = 1;
529 return list;
530}
531
532void
533PerlIO_list_free(pTHX_ PerlIO_list_t *list)
534{
535 if (list) {
536 if (--list->refcnt == 0) {
537 if (list->array) {
538 IV i;
539 for (i = 0; i < list->cur; i++)
540 SvREFCNT_dec(list->array[i].arg);
541 Safefree(list->array);
542 }
543 Safefree(list);
544 }
545 }
546}
547
548void
549PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
550{
551 PerlIO_pair_t *p;
552 PERL_UNUSED_CONTEXT;
553
554 if (list->cur >= list->len) {
555 const IV new_len = list->len + 8;
556 if (list->array)
557 Renew(list->array, new_len, PerlIO_pair_t);
558 else
559 Newx(list->array, new_len, PerlIO_pair_t);
560 list->len = new_len;
561 }
562 p = &(list->array[list->cur++]);
563 p->funcs = funcs;
564 if ((p->arg = arg)) {
565 SvREFCNT_inc_simple_void_NN(arg);
566 }
567}
568
569PerlIO_list_t *
570PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
571{
572 PerlIO_list_t *list = NULL;
573 if (proto) {
574 int i;
575 list = PerlIO_list_alloc(aTHX);
576 for (i=0; i < proto->cur; i++) {
577 SV *arg = proto->array[i].arg;
578#ifdef USE_ITHREADS
579 if (arg && param)
580 arg = sv_dup(arg, param);
581#else
582 PERL_UNUSED_ARG(param);
583#endif
584 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
585 }
586 }
587 return list;
588}
589
590void
591PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
592{
593#ifdef USE_ITHREADS
594 PerlIOl **table = &proto->Iperlio;
595 PerlIOl *f;
596 PL_perlio = NULL;
597 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
598 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
599 PerlIO_init_table(aTHX);
600 DEBUG_i( PerlIO_debug("Clone %p from %p\n",(void*)aTHX,(void*)proto) );
601 while ((f = *table)) {
602 int i;
603 table = (PerlIOl **) (f++);
604 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
605 if (f->next) {
606 (void) fp_dup(&(f->next), 0, param);
607 }
608 f++;
609 }
610 }
611#else
612 PERL_UNUSED_CONTEXT;
613 PERL_UNUSED_ARG(proto);
614 PERL_UNUSED_ARG(param);
615#endif
616}
617
618void
619PerlIO_destruct(pTHX)
620{
621 PerlIOl **table = &PL_perlio;
622 PerlIOl *f;
623#ifdef USE_ITHREADS
624 DEBUG_i( PerlIO_debug("Destruct %p\n",(void*)aTHX) );
625#endif
626 while ((f = *table)) {
627 int i;
628 table = (PerlIOl **) (f++);
629 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
630 PerlIO *x = &(f->next);
631 const PerlIOl *l;
632 while ((l = *x)) {
633 if (l->tab && l->tab->kind & PERLIO_K_DESTRUCT) {
634 DEBUG_i( PerlIO_debug("Destruct popping %s\n", l->tab->name) );
635 PerlIO_flush(x);
636 PerlIO_pop(aTHX_ x);
637 }
638 else {
639 x = PerlIONext(x);
640 }
641 }
642 f++;
643 }
644 }
645}
646
647void
648PerlIO_pop(pTHX_ PerlIO *f)
649{
650 const PerlIOl *l = *f;
651 VERIFY_HEAD(f);
652 if (l) {
653 DEBUG_i( PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f,
654 l->tab ? l->tab->name : "(Null)") );
655 if (l->tab && l->tab->Popped) {
656 /*
657 * If popped returns non-zero do not free its layer structure
658 * it has either done so itself, or it is shared and still in
659 * use
660 */
661 if ((*l->tab->Popped) (aTHX_ f) != 0)
662 return;
663 }
664 if (PerlIO_lockcnt(f)) {
665 /* we're in use; defer freeing the structure */
666 PerlIOBase(f)->flags = PERLIO_F_CLEARED;
667 PerlIOBase(f)->tab = NULL;
668 }
669 else {
670 *f = l->next;
671 Safefree(l);
672 }
673
674 }
675}
676
677/* Return as an array the stack of layers on a filehandle. Note that
678 * the stack is returned top-first in the array, and there are three
679 * times as many array elements as there are layers in the stack: the
680 * first element of a layer triplet is the name, the second one is the
681 * arguments, and the third one is the flags. */
682
683AV *
684PerlIO_get_layers(pTHX_ PerlIO *f)
685{
686 AV * const av = newAV();
687
688 if (PerlIOValid(f)) {
689 PerlIOl *l = PerlIOBase(f);
690
691 while (l) {
692 /* There is some collusion in the implementation of
693 XS_PerlIO_get_layers - it knows that name and flags are
694 generated as fresh SVs here, and takes advantage of that to
695 "copy" them by taking a reference. If it changes here, it needs
696 to change there too. */
697 SV * const name = l->tab && l->tab->name ?
698 newSVpv(l->tab->name, 0) : &PL_sv_undef;
699 SV * const arg = l->tab && l->tab->Getarg ?
700 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
701 av_push(av, name);
702 av_push(av, arg);
703 av_push(av, newSViv((IV)l->flags));
704 l = l->next;
705 }
706 }
707
708 return av;
709}
710
711/*--------------------------------------------------------------------------------------*/
712/*
713 * XS Interface for perl code
714 */
715
716PerlIO_funcs *
717PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
718{
719
720 IV i;
721 if ((SSize_t) len <= 0)
722 len = strlen(name);
723 for (i = 0; i < PL_known_layers->cur; i++) {
724 PerlIO_funcs * const f = PL_known_layers->array[i].funcs;
725 const STRLEN this_len = strlen(f->name);
726 if (this_len == len && memEQ(f->name, name, len)) {
727 DEBUG_i( PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f) );
728 return f;
729 }
730 }
731 if (load && PL_subname && PL_def_layerlist
732 && PL_def_layerlist->cur >= 2) {
733 if (PL_in_load_module) {
734 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
735 return NULL;
736 } else {
737 SV * const pkgsv = newSVpvs("PerlIO");
738 SV * const layer = newSVpvn(name, len);
739 CV * const cv = get_cvs("PerlIO::Layer::NoWarnings", 0);
740 ENTER;
741 SAVEBOOL(PL_in_load_module);
742 if (cv) {
743 SAVEGENERICSV(PL_warnhook);
744 PL_warnhook = MUTABLE_SV((SvREFCNT_inc_simple_NN(cv)));
745 }
746 PL_in_load_module = TRUE;
747 /*
748 * The two SVs are magically freed by load_module
749 */
750 Perl_load_module(aTHX_ 0, pkgsv, NULL, layer, NULL);
751 LEAVE;
752 return PerlIO_find_layer(aTHX_ name, len, 0);
753 }
754 }
755 DEBUG_i( PerlIO_debug("Cannot find %.*s\n", (int) len, name) );
756 return NULL;
757}
758
759#ifdef USE_ATTRIBUTES_FOR_PERLIO
760
761static int
762perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
763{
764 if (SvROK(sv)) {
765 IO * const io = GvIOn(MUTABLE_GV(SvRV(sv)));
766 PerlIO * const ifp = IoIFP(io);
767 PerlIO * const ofp = IoOFP(io);
768 Perl_warn(aTHX_ "set %" SVf " %p %p %p",
769 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
770 }
771 return 0;
772}
773
774static int
775perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
776{
777 if (SvROK(sv)) {
778 IO * const io = GvIOn(MUTABLE_GV(SvRV(sv)));
779 PerlIO * const ifp = IoIFP(io);
780 PerlIO * const ofp = IoOFP(io);
781 Perl_warn(aTHX_ "get %" SVf " %p %p %p",
782 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
783 }
784 return 0;
785}
786
787static int
788perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
789{
790 Perl_warn(aTHX_ "clear %" SVf, SVfARG(sv));
791 return 0;
792}
793
794static int
795perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
796{
797 Perl_warn(aTHX_ "free %" SVf, SVfARG(sv));
798 return 0;
799}
800
801MGVTBL perlio_vtab = {
802 perlio_mg_get,
803 perlio_mg_set,
804 NULL, /* len */
805 perlio_mg_clear,
806 perlio_mg_free
807};
808
809XS(XS_io_MODIFY_SCALAR_ATTRIBUTES); /* prototype to pass -Wmissing-prototypes */
810XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
811{
812 dXSARGS;
813 SV * const sv = SvRV(ST(1));
814 AV * const av = newAV();
815 MAGIC *mg;
816 int count = 0;
817 int i;
818 sv_magic(sv, MUTABLE_SV(av), PERL_MAGIC_ext, NULL, 0);
819 SvRMAGICAL_off(sv);
820 mg = mg_find(sv, PERL_MAGIC_ext);
821 mg->mg_virtual = &perlio_vtab;
822 mg_magical(sv);
823 Perl_warn(aTHX_ "attrib %" SVf, SVfARG(sv));
824 for (i = 2; i < items; i++) {
825 STRLEN len;
826 const char * const name = SvPV_const(ST(i), len);
827 SV * const layer = PerlIO_find_layer(aTHX_ name, len, 1);
828 if (layer) {
829 av_push(av, SvREFCNT_inc_simple_NN(layer));
830 }
831 else {
832 ST(count) = ST(i);
833 count++;
834 }
835 }
836 SvREFCNT_dec(av);
837 XSRETURN(count);
838}
839
840#endif /* USE_ATTRIBUTES_FOR_PERLIO */
841
842SV *
843PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
844{
845 HV * const stash = gv_stashpvs("PerlIO::Layer", GV_ADD);
846 SV * const sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
847 return sv;
848}
849
850XS(XS_PerlIO__Layer__NoWarnings); /* prototype to pass -Wmissing-prototypes */
851XS(XS_PerlIO__Layer__NoWarnings)
852{
853 /* This is used as a %SIG{__WARN__} handler to suppress warnings
854 during loading of layers.
855 */
856 dXSARGS;
857 PERL_UNUSED_VAR(items);
858 DEBUG_i(
859 if (items)
860 PerlIO_debug("warning:%s\n",SvPV_nolen_const(ST(0))) );
861 XSRETURN(0);
862}
863
864XS(XS_PerlIO__Layer__find); /* prototype to pass -Wmissing-prototypes */
865XS(XS_PerlIO__Layer__find)
866{
867 dXSARGS;
868 if (items < 2)
869 Perl_croak(aTHX_ "Usage class->find(name[,load])");
870 else {
871 STRLEN len;
872 const char * const name = SvPV_const(ST(1), len);
873 const bool load = (items > 2) ? SvTRUE_NN(ST(2)) : 0;
874 PerlIO_funcs * const layer = PerlIO_find_layer(aTHX_ name, len, load);
875 ST(0) =
876 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
877 &PL_sv_undef;
878 XSRETURN(1);
879 }
880}
881
882void
883PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
884{
885 if (!PL_known_layers)
886 PL_known_layers = PerlIO_list_alloc(aTHX);
887 PerlIO_list_push(aTHX_ PL_known_layers, tab, NULL);
888 DEBUG_i( PerlIO_debug("define %s %p\n", tab->name, (void*)tab) );
889}
890
891int
892PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
893{
894 if (names) {
895 const char *s = names;
896 while (*s) {
897 while (isSPACE(*s) || *s == ':')
898 s++;
899 if (*s) {
900 STRLEN llen = 0;
901 const char *e = s;
902 const char *as = NULL;
903 STRLEN alen = 0;
904 if (!isIDFIRST(*s)) {
905 /*
906 * Message is consistent with how attribute lists are
907 * passed. Even though this means "foo : : bar" is
908 * seen as an invalid separator character.
909 */
910 const char q = ((*s == '\'') ? '"' : '\'');
911 Perl_ck_warner(aTHX_ packWARN(WARN_LAYER),
912 "Invalid separator character %c%c%c in PerlIO layer specification %s",
913 q, *s, q, s);
914 SETERRNO(EINVAL, LIB_INVARG);
915 return -1;
916 }
917 do {
918 e++;
919 } while (isWORDCHAR(*e));
920 llen = e - s;
921 if (*e == '(') {
922 int nesting = 1;
923 as = ++e;
924 while (nesting) {
925 switch (*e++) {
926 case ')':
927 if (--nesting == 0)
928 alen = (e - 1) - as;
929 break;
930 case '(':
931 ++nesting;
932 break;
933 case '\\':
934 /*
935 * It's a nul terminated string, not allowed
936 * to \ the terminating null. Anything other
937 * character is passed over.
938 */
939 if (*e++) {
940 break;
941 }
942 /* Fall through */
943 case '\0':
944 e--;
945 Perl_ck_warner(aTHX_ packWARN(WARN_LAYER),
946 "Argument list not closed for PerlIO layer \"%.*s\"",
947 (int) (e - s), s);
948 return -1;
949 default:
950 /*
951 * boring.
952 */
953 break;
954 }
955 }
956 }
957 if (e > s) {
958 PerlIO_funcs * const layer =
959 PerlIO_find_layer(aTHX_ s, llen, 1);
960 if (layer) {
961 SV *arg = NULL;
962 if (as)
963 arg = newSVpvn(as, alen);
964 PerlIO_list_push(aTHX_ av, layer,
965 (arg) ? arg : &PL_sv_undef);
966 SvREFCNT_dec(arg);
967 }
968 else {
969 Perl_ck_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
970 (int) llen, s);
971 return -1;
972 }
973 }
974 s = e;
975 }
976 }
977 }
978 return 0;
979}
980
981void
982PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
983{
984 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
985#ifdef PERLIO_USING_CRLF
986 tab = &PerlIO_crlf;
987#else
988 if (PerlIO_stdio.Set_ptrcnt)
989 tab = &PerlIO_stdio;
990#endif
991 DEBUG_i( PerlIO_debug("Pushing %s\n", tab->name) );
992 PerlIO_list_push(aTHX_ av, (PerlIO_funcs *)tab, &PL_sv_undef);
993}
994
995SV *
996PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
997{
998 return av->array[n].arg;
999}
1000
1001PerlIO_funcs *
1002PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1003{
1004 if (n >= 0 && n < av->cur) {
1005 DEBUG_i( PerlIO_debug("Layer %" IVdf " is %s\n", n,
1006 av->array[n].funcs->name) );
1007 return av->array[n].funcs;
1008 }
1009 if (!def)
1010 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1011 return def;
1012}
1013
1014IV
1015PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1016{
1017 PERL_UNUSED_ARG(mode);
1018 PERL_UNUSED_ARG(arg);
1019 PERL_UNUSED_ARG(tab);
1020 if (PerlIOValid(f)) {
1021 PerlIO_flush(f);
1022 PerlIO_pop(aTHX_ f);
1023 return 0;
1024 }
1025 return -1;
1026}
1027
1028PERLIO_FUNCS_DECL(PerlIO_remove) = {
1029 sizeof(PerlIO_funcs),
1030 "pop",
1031 0,
1032 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1033 PerlIOPop_pushed,
1034 NULL,
1035 PerlIOBase_open,
1036 NULL,
1037 NULL,
1038 NULL,
1039 NULL,
1040 NULL,
1041 NULL,
1042 NULL,
1043 NULL,
1044 NULL,
1045 NULL,
1046 NULL, /* flush */
1047 NULL, /* fill */
1048 NULL,
1049 NULL,
1050 NULL,
1051 NULL,
1052 NULL, /* get_base */
1053 NULL, /* get_bufsiz */
1054 NULL, /* get_ptr */
1055 NULL, /* get_cnt */
1056 NULL, /* set_ptrcnt */
1057};
1058
1059PerlIO_list_t *
1060PerlIO_default_layers(pTHX)
1061{
1062 if (!PL_def_layerlist) {
1063 const char * const s = TAINTING_get ? NULL : PerlEnv_getenv("PERLIO");
1064 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1065 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1066 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1067#if defined(WIN32)
1068 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1069#if 0
1070 osLayer = &PerlIO_win32;
1071#endif
1072#endif
1073 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1074 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1075 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1076 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1077 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1078 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1079 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1080 PerlIO_list_push(aTHX_ PL_def_layerlist, (PerlIO_funcs *)osLayer,
1081 &PL_sv_undef);
1082 if (s) {
1083 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1084 }
1085 else {
1086 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1087 }
1088 }
1089 if (PL_def_layerlist->cur < 2) {
1090 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1091 }
1092 return PL_def_layerlist;
1093}
1094
1095void
1096Perl_boot_core_PerlIO(pTHX)
1097{
1098#ifdef USE_ATTRIBUTES_FOR_PERLIO
1099 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1100 __FILE__);
1101#endif
1102 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1103 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1104}
1105
1106PerlIO_funcs *
1107PerlIO_default_layer(pTHX_ I32 n)
1108{
1109 PerlIO_list_t * const av = PerlIO_default_layers(aTHX);
1110 if (n < 0)
1111 n += av->cur;
1112 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1113}
1114
1115#define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1116#define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1117
1118void
1119PerlIO_stdstreams(pTHX)
1120{
1121 if (!PL_perlio) {
1122 PerlIO_init_table(aTHX);
1123 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1124 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1125 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1126 }
1127}
1128
1129PerlIO *
1130PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1131{
1132 VERIFY_HEAD(f);
1133 if (tab->fsize != sizeof(PerlIO_funcs)) {
1134 Perl_croak( aTHX_
1135 "%s (%" UVuf ") does not match %s (%" UVuf ")",
1136 "PerlIO layer function table size", (UV)tab->fsize,
1137 "size expected by this perl", (UV)sizeof(PerlIO_funcs) );
1138 }
1139 if (tab->size) {
1140 PerlIOl *l;
1141 if (tab->size < sizeof(PerlIOl)) {
1142 Perl_croak( aTHX_
1143 "%s (%" UVuf ") smaller than %s (%" UVuf ")",
1144 "PerlIO layer instance size", (UV)tab->size,
1145 "size expected by this perl", (UV)sizeof(PerlIOl) );
1146 }
1147 /* Real layer with a data area */
1148 if (f) {
1149 char *temp;
1150 Newxz(temp, tab->size, char);
1151 l = (PerlIOl*)temp;
1152 if (l) {
1153 l->next = *f;
1154 l->tab = (PerlIO_funcs*) tab;
1155 l->head = ((PerlIOl*)f)->head;
1156 *f = l;
1157 DEBUG_i( PerlIO_debug("PerlIO_push f=%p %s %s %p\n",
1158 (void*)f, tab->name,
1159 (mode) ? mode : "(Null)", (void*)arg) );
1160 if (*l->tab->Pushed &&
1161 (*l->tab->Pushed)
1162 (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1163 PerlIO_pop(aTHX_ f);
1164 return NULL;
1165 }
1166 }
1167 else
1168 return NULL;
1169 }
1170 }
1171 else if (f) {
1172 /* Pseudo-layer where push does its own stack adjust */
1173 DEBUG_i( PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1174 (mode) ? mode : "(Null)", (void*)arg) );
1175 if (tab->Pushed &&
1176 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1177 return NULL;
1178 }
1179 }
1180 return f;
1181}
1182
1183PerlIO *
1184PerlIOBase_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1185 IV n, const char *mode, int fd, int imode, int perm,
1186 PerlIO *old, int narg, SV **args)
1187{
1188 PerlIO_funcs * const tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_layer(aTHX_ 0));
1189 if (tab && tab->Open) {
1190 PerlIO* ret = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm, old, narg, args);
1191 if (ret && PerlIO_push(aTHX_ ret, self, mode, PerlIOArg) == NULL) {
1192 PerlIO_close(ret);
1193 return NULL;
1194 }
1195 return ret;
1196 }
1197 SETERRNO(EINVAL, LIB_INVARG);
1198 return NULL;
1199}
1200
1201IV
1202PerlIOBase_binmode(pTHX_ PerlIO *f)
1203{
1204 if (PerlIOValid(f)) {
1205 /* Is layer suitable for raw stream ? */
1206 if (PerlIOBase(f)->tab && PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1207 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1208 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1209 }
1210 else {
1211 /* Not suitable - pop it */
1212 PerlIO_pop(aTHX_ f);
1213 }
1214 return 0;
1215 }
1216 return -1;
1217}
1218
1219IV
1220PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1221{
1222 PERL_UNUSED_ARG(mode);
1223 PERL_UNUSED_ARG(arg);
1224 PERL_UNUSED_ARG(tab);
1225
1226 if (PerlIOValid(f)) {
1227 PerlIO *t;
1228 const PerlIOl *l;
1229 PerlIO_flush(f);
1230 /*
1231 * Strip all layers that are not suitable for a raw stream
1232 */
1233 t = f;
1234 while (t && (l = *t)) {
1235 if (l->tab && l->tab->Binmode) {
1236 /* Has a handler - normal case */
1237 if ((*l->tab->Binmode)(aTHX_ t) == 0) {
1238 if (*t == l) {
1239 /* Layer still there - move down a layer */
1240 t = PerlIONext(t);
1241 }
1242 }
1243 else {
1244 return -1;
1245 }
1246 }
1247 else {
1248 /* No handler - pop it */
1249 PerlIO_pop(aTHX_ t);
1250 }
1251 }
1252 if (PerlIOValid(f)) {
1253 DEBUG_i( PerlIO_debug(":raw f=%p :%s\n", (void*)f,
1254 PerlIOBase(f)->tab ? PerlIOBase(f)->tab->name : "(Null)") );
1255 return 0;
1256 }
1257 }
1258 return -1;
1259}
1260
1261int
1262PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1263 PerlIO_list_t *layers, IV n, IV max)
1264{
1265 int code = 0;
1266 while (n < max) {
1267 PerlIO_funcs * const tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1268 if (tab) {
1269 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1270 code = -1;
1271 break;
1272 }
1273 }
1274 n++;
1275 }
1276 return code;
1277}
1278
1279int
1280PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1281{
1282 int code = 0;
1283 ENTER;
1284 save_scalar(PL_errgv);
1285 if (f && names) {
1286 PerlIO_list_t * const layers = PerlIO_list_alloc(aTHX);
1287 code = PerlIO_parse_layers(aTHX_ layers, names);
1288 if (code == 0) {
1289 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1290 }
1291 PerlIO_list_free(aTHX_ layers);
1292 }
1293 LEAVE;
1294 return code;
1295}
1296
1297
1298/*--------------------------------------------------------------------------------------*/
1299/*
1300 * Given the abstraction above the public API functions
1301 */
1302
1303int
1304PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1305{
1306 PERL_UNUSED_ARG(iotype);
1307 PERL_UNUSED_ARG(mode);
1308
1309 DEBUG_i(
1310 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n", (void*)f,
1311 (PerlIOBase(f) && PerlIOBase(f)->tab) ?
1312 PerlIOBase(f)->tab->name : "(Null)",
1313 iotype, mode, (names) ? names : "(Null)") );
1314
1315 if (names) {
1316 /* Do not flush etc. if (e.g.) switching encodings.
1317 if a pushed layer knows it needs to flush lower layers
1318 (for example :unix which is never going to call them)
1319 it can do the flush when it is pushed.
1320 */
1321 return cBOOL(PerlIO_apply_layers(aTHX_ f, NULL, names) == 0);
1322 }
1323 else {
1324 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1325#ifdef PERLIO_USING_CRLF
1326 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1327 O_BINARY so we can look for it in mode.
1328 */
1329 if (!(mode & O_BINARY)) {
1330 /* Text mode */
1331 /* FIXME?: Looking down the layer stack seems wrong,
1332 but is a way of reaching past (say) an encoding layer
1333 to flip CRLF-ness of the layer(s) below
1334 */
1335 while (*f) {
1336 /* Perhaps we should turn on bottom-most aware layer
1337 e.g. Ilya's idea that UNIX TTY could serve
1338 */
1339 if (PerlIOBase(f)->tab &&
1340 PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF)
1341 {
1342 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1343 /* Not in text mode - flush any pending stuff and flip it */
1344 PerlIO_flush(f);
1345 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1346 }
1347 /* Only need to turn it on in one layer so we are done */
1348 return TRUE;
1349 }
1350 f = PerlIONext(f);
1351 }
1352 /* Not finding a CRLF aware layer presumably means we are binary
1353 which is not what was requested - so we failed
1354 We _could_ push :crlf layer but so could caller
1355 */
1356 return FALSE;
1357 }
1358#endif
1359 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1360 So code that used to be here is now in PerlIORaw_pushed().
1361 */
1362 return cBOOL(PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), NULL, NULL));
1363 }
1364}
1365
1366int
1367PerlIO__close(pTHX_ PerlIO *f)
1368{
1369 if (PerlIOValid(f)) {
1370 PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1371 if (tab && tab->Close)
1372 return (*tab->Close)(aTHX_ f);
1373 else
1374 return PerlIOBase_close(aTHX_ f);
1375 }
1376 else {
1377 SETERRNO(EBADF, SS_IVCHAN);
1378 return -1;
1379 }
1380}
1381
1382int
1383Perl_PerlIO_close(pTHX_ PerlIO *f)
1384{
1385 const int code = PerlIO__close(aTHX_ f);
1386 while (PerlIOValid(f)) {
1387 PerlIO_pop(aTHX_ f);
1388 if (PerlIO_lockcnt(f))
1389 /* we're in use; the 'pop' deferred freeing the structure */
1390 f = PerlIONext(f);
1391 }
1392 return code;
1393}
1394
1395int
1396Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1397{
1398 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1399}
1400
1401
1402static PerlIO_funcs *
1403PerlIO_layer_from_ref(pTHX_ SV *sv)
1404{
1405 /*
1406 * For any scalar type load the handler which is bundled with perl
1407 */
1408 if (SvTYPE(sv) < SVt_PVAV && (!isGV_with_GP(sv) || SvFAKE(sv))) {
1409 PerlIO_funcs *f = PerlIO_find_layer(aTHX_ STR_WITH_LEN("scalar"), 1);
1410 /* This isn't supposed to happen, since PerlIO::scalar is core,
1411 * but could happen anyway in smaller installs or with PAR */
1412 if (!f)
1413 /* diag_listed_as: Unknown PerlIO layer "%s" */
1414 Perl_ck_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"scalar\"");
1415 return f;
1416 }
1417
1418 /*
1419 * For other types allow if layer is known but don't try and load it
1420 */
1421 switch (SvTYPE(sv)) {
1422 case SVt_PVAV:
1423 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Array"), 0);
1424 case SVt_PVHV:
1425 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Hash"), 0);
1426 case SVt_PVCV:
1427 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Code"), 0);
1428 case SVt_PVGV:
1429 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Glob"), 0);
1430 default:
1431 return NULL;
1432 }
1433}
1434
1435PerlIO_list_t *
1436PerlIO_resolve_layers(pTHX_ const char *layers,
1437 const char *mode, int narg, SV **args)
1438{
1439 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1440 int incdef = 1;
1441 if (!PL_perlio)
1442 PerlIO_stdstreams(aTHX);
1443 if (narg) {
1444 SV * const arg = *args;
1445 /*
1446 * If it is a reference but not an object see if we have a handler
1447 * for it
1448 */
1449 if (SvROK(arg) && !SvOBJECT(SvRV(arg))) {
1450 PerlIO_funcs * const handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1451 if (handler) {
1452 def = PerlIO_list_alloc(aTHX);
1453 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1454 incdef = 0;
1455 }
1456 /*
1457 * Don't fail if handler cannot be found :via(...) etc. may do
1458 * something sensible else we will just stringfy and open
1459 * resulting string.
1460 */
1461 }
1462 }
1463 if (!layers || !*layers)
1464 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1465 if (layers && *layers) {
1466 PerlIO_list_t *av;
1467 if (incdef) {
1468 av = PerlIO_clone_list(aTHX_ def, NULL);
1469 }
1470 else {
1471 av = def;
1472 }
1473 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1474 return av;
1475 }
1476 else {
1477 PerlIO_list_free(aTHX_ av);
1478 return NULL;
1479 }
1480 }
1481 else {
1482 if (incdef)
1483 def->refcnt++;
1484 return def;
1485 }
1486}
1487
1488PerlIO *
1489PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1490 int imode, int perm, PerlIO *f, int narg, SV **args)
1491{
1492 if (!f && narg == 1 && *args == &PL_sv_undef) {
1493 imode = PerlIOUnix_oflags(mode);
1494
1495 if (imode != -1 && (f = PerlIO_tmpfile_flags(imode))) {
1496 if (!layers || !*layers)
1497 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1498 if (layers && *layers)
1499 PerlIO_apply_layers(aTHX_ f, mode, layers);
1500 }
1501 }
1502 else {
1503 PerlIO_list_t *layera;
1504 IV n;
1505 PerlIO_funcs *tab = NULL;
1506 if (PerlIOValid(f)) {
1507 /*
1508 * This is "reopen" - it is not tested as perl does not use it
1509 * yet
1510 */
1511 PerlIOl *l = *f;
1512 layera = PerlIO_list_alloc(aTHX);
1513 while (l) {
1514 SV *arg = NULL;
1515 if (l->tab && l->tab->Getarg)
1516 arg = (*l->tab->Getarg) (aTHX_ &l, NULL, 0);
1517 PerlIO_list_push(aTHX_ layera, l->tab,
1518 (arg) ? arg : &PL_sv_undef);
1519 SvREFCNT_dec(arg);
1520 l = *PerlIONext(&l);
1521 }
1522 }
1523 else {
1524 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1525 if (!layera) {
1526 return NULL;
1527 }
1528 }
1529 /*
1530 * Start at "top" of layer stack
1531 */
1532 n = layera->cur - 1;
1533 while (n >= 0) {
1534 PerlIO_funcs * const t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1535 if (t && t->Open) {
1536 tab = t;
1537 break;
1538 }
1539 n--;
1540 }
1541 if (tab) {
1542 /*
1543 * Found that layer 'n' can do opens - call it
1544 */
1545 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1546 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1547 }
1548 DEBUG_i( PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1549 tab->name, layers ? layers : "(Null)", mode, fd,
1550 imode, perm, (void*)f, narg, (void*)args) );
1551 if (tab->Open)
1552 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1553 f, narg, args);
1554 else {
1555 SETERRNO(EINVAL, LIB_INVARG);
1556 f = NULL;
1557 }
1558 if (f) {
1559 if (n + 1 < layera->cur) {
1560 /*
1561 * More layers above the one that we used to open -
1562 * apply them now
1563 */
1564 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1565 /* If pushing layers fails close the file */
1566 PerlIO_close(f);
1567 f = NULL;
1568 }
1569 }
1570 }
1571 }
1572 PerlIO_list_free(aTHX_ layera);
1573 }
1574 return f;
1575}
1576
1577
1578SSize_t
1579Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1580{
1581 PERL_ARGS_ASSERT_PERLIO_READ;
1582
1583 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1584}
1585
1586SSize_t
1587Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1588{
1589 PERL_ARGS_ASSERT_PERLIO_UNREAD;
1590
1591 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1592}
1593
1594SSize_t
1595Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1596{
1597 PERL_ARGS_ASSERT_PERLIO_WRITE;
1598
1599 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1600}
1601
1602int
1603Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1604{
1605 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1606}
1607
1608Off_t
1609Perl_PerlIO_tell(pTHX_ PerlIO *f)
1610{
1611 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1612}
1613
1614int
1615Perl_PerlIO_flush(pTHX_ PerlIO *f)
1616{
1617 if (f) {
1618 if (*f) {
1619 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1620
1621 if (tab && tab->Flush)
1622 return (*tab->Flush) (aTHX_ f);
1623 else
1624 return 0; /* If no Flush defined, silently succeed. */
1625 }
1626 else {
1627 DEBUG_i( PerlIO_debug("Cannot flush f=%p\n", (void*)f) );
1628 SETERRNO(EBADF, SS_IVCHAN);
1629 return -1;
1630 }
1631 }
1632 else {
1633 /*
1634 * Is it good API design to do flush-all on NULL, a potentially
1635 * erroneous input? Maybe some magical value (PerlIO*
1636 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1637 * things on fflush(NULL), but should we be bound by their design
1638 * decisions? --jhi
1639 */
1640 PerlIOl **table = &PL_perlio;
1641 PerlIOl *ff;
1642 int code = 0;
1643 while ((ff = *table)) {
1644 int i;
1645 table = (PerlIOl **) (ff++);
1646 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1647 if (ff->next && PerlIO_flush(&(ff->next)) != 0)
1648 code = -1;
1649 ff++;
1650 }
1651 }
1652 return code;
1653 }
1654}
1655
1656void
1657PerlIOBase_flush_linebuf(pTHX)
1658{
1659 PerlIOl **table = &PL_perlio;
1660 PerlIOl *f;
1661 while ((f = *table)) {
1662 int i;
1663 table = (PerlIOl **) (f++);
1664 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1665 if (f->next
1666 && (PerlIOBase(&(f->next))->
1667 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1668 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1669 PerlIO_flush(&(f->next));
1670 f++;
1671 }
1672 }
1673}
1674
1675int
1676Perl_PerlIO_fill(pTHX_ PerlIO *f)
1677{
1678 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1679}
1680
1681int
1682PerlIO_isutf8(PerlIO *f)
1683{
1684 if (PerlIOValid(f))
1685 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1686 else
1687 SETERRNO(EBADF, SS_IVCHAN);
1688
1689 return -1;
1690}
1691
1692int
1693Perl_PerlIO_eof(pTHX_ PerlIO *f)
1694{
1695 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1696}
1697
1698int
1699Perl_PerlIO_error(pTHX_ PerlIO *f)
1700{
1701 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1702}
1703
1704void
1705Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1706{
1707 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1708}
1709
1710void
1711Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1712{
1713 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1714}
1715
1716int
1717PerlIO_has_base(PerlIO *f)
1718{
1719 if (PerlIOValid(f)) {
1720 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1721
1722 if (tab)
1723 return (tab->Get_base != NULL);
1724 }
1725
1726 return 0;
1727}
1728
1729int
1730PerlIO_fast_gets(PerlIO *f)
1731{
1732 if (PerlIOValid(f)) {
1733 if (PerlIOBase(f)->flags & PERLIO_F_FASTGETS) {
1734 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1735
1736 if (tab)
1737 return (tab->Set_ptrcnt != NULL);
1738 }
1739 }
1740
1741 return 0;
1742}
1743
1744int
1745PerlIO_has_cntptr(PerlIO *f)
1746{
1747 if (PerlIOValid(f)) {
1748 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1749
1750 if (tab)
1751 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1752 }
1753
1754 return 0;
1755}
1756
1757int
1758PerlIO_canset_cnt(PerlIO *f)
1759{
1760 if (PerlIOValid(f)) {
1761 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1762
1763 if (tab)
1764 return (tab->Set_ptrcnt != NULL);
1765 }
1766
1767 return 0;
1768}
1769
1770STDCHAR *
1771Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1772{
1773 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1774}
1775
1776SSize_t
1777Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1778{
1779 /* Note that Get_bufsiz returns a Size_t */
1780 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1781}
1782
1783STDCHAR *
1784Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1785{
1786 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1787}
1788
1789SSize_t
1790Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1791{
1792 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1793}
1794
1795void
1796Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, SSize_t cnt)
1797{
1798 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1799}
1800
1801void
1802Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
1803{
1804 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1805}
1806
1807
1808/*--------------------------------------------------------------------------------------*/
1809/*
1810 * utf8 and raw dummy layers
1811 */
1812
1813IV
1814PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1815{
1816 PERL_UNUSED_CONTEXT;
1817 PERL_UNUSED_ARG(mode);
1818 PERL_UNUSED_ARG(arg);
1819 if (PerlIOValid(f)) {
1820 if (tab && tab->kind & PERLIO_K_UTF8)
1821 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1822 else
1823 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1824 return 0;
1825 }
1826 return -1;
1827}
1828
1829PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1830 sizeof(PerlIO_funcs),
1831 "utf8",
1832 0,
1833 PERLIO_K_DUMMY | PERLIO_K_UTF8 | PERLIO_K_MULTIARG,
1834 PerlIOUtf8_pushed,
1835 NULL,
1836 PerlIOBase_open,
1837 NULL,
1838 NULL,
1839 NULL,
1840 NULL,
1841 NULL,
1842 NULL,
1843 NULL,
1844 NULL,
1845 NULL,
1846 NULL,
1847 NULL, /* flush */
1848 NULL, /* fill */
1849 NULL,
1850 NULL,
1851 NULL,
1852 NULL,
1853 NULL, /* get_base */
1854 NULL, /* get_bufsiz */
1855 NULL, /* get_ptr */
1856 NULL, /* get_cnt */
1857 NULL, /* set_ptrcnt */
1858};
1859
1860PERLIO_FUNCS_DECL(PerlIO_byte) = {
1861 sizeof(PerlIO_funcs),
1862 "bytes",
1863 0,
1864 PERLIO_K_DUMMY | PERLIO_K_MULTIARG,
1865 PerlIOUtf8_pushed,
1866 NULL,
1867 PerlIOBase_open,
1868 NULL,
1869 NULL,
1870 NULL,
1871 NULL,
1872 NULL,
1873 NULL,
1874 NULL,
1875 NULL,
1876 NULL,
1877 NULL,
1878 NULL, /* flush */
1879 NULL, /* fill */
1880 NULL,
1881 NULL,
1882 NULL,
1883 NULL,
1884 NULL, /* get_base */
1885 NULL, /* get_bufsiz */
1886 NULL, /* get_ptr */
1887 NULL, /* get_cnt */
1888 NULL, /* set_ptrcnt */
1889};
1890
1891PERLIO_FUNCS_DECL(PerlIO_raw) = {
1892 sizeof(PerlIO_funcs),
1893 "raw",
1894 0,
1895 PERLIO_K_DUMMY,
1896 PerlIORaw_pushed,
1897 PerlIOBase_popped,
1898 PerlIOBase_open,
1899 NULL,
1900 NULL,
1901 NULL,
1902 NULL,
1903 NULL,
1904 NULL,
1905 NULL,
1906 NULL,
1907 NULL,
1908 NULL,
1909 NULL, /* flush */
1910 NULL, /* fill */
1911 NULL,
1912 NULL,
1913 NULL,
1914 NULL,
1915 NULL, /* get_base */
1916 NULL, /* get_bufsiz */
1917 NULL, /* get_ptr */
1918 NULL, /* get_cnt */
1919 NULL, /* set_ptrcnt */
1920};
1921/*--------------------------------------------------------------------------------------*/
1922/*--------------------------------------------------------------------------------------*/
1923/*
1924 * "Methods" of the "base class"
1925 */
1926
1927IV
1928PerlIOBase_fileno(pTHX_ PerlIO *f)
1929{
1930 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1931}
1932
1933char *
1934PerlIO_modestr(PerlIO * f, char *buf)
1935{
1936 char *s = buf;
1937 if (PerlIOValid(f)) {
1938 const IV flags = PerlIOBase(f)->flags;
1939 if (flags & PERLIO_F_APPEND) {
1940 *s++ = 'a';
1941 if (flags & PERLIO_F_CANREAD) {
1942 *s++ = '+';
1943 }
1944 }
1945 else if (flags & PERLIO_F_CANREAD) {
1946 *s++ = 'r';
1947 if (flags & PERLIO_F_CANWRITE)
1948 *s++ = '+';
1949 }
1950 else if (flags & PERLIO_F_CANWRITE) {
1951 *s++ = 'w';
1952 if (flags & PERLIO_F_CANREAD) {
1953 *s++ = '+';
1954 }
1955 }
1956#ifdef PERLIO_USING_CRLF
1957 if (!(flags & PERLIO_F_CRLF))
1958 *s++ = 'b';
1959#endif
1960 }
1961 *s = '\0';
1962 return buf;
1963}
1964
1965
1966IV
1967PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1968{
1969 PerlIOl * const l = PerlIOBase(f);
1970 PERL_UNUSED_CONTEXT;
1971 PERL_UNUSED_ARG(arg);
1972
1973 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1974 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1975 if (tab && tab->Set_ptrcnt != NULL)
1976 l->flags |= PERLIO_F_FASTGETS;
1977 if (mode) {
1978 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
1979 mode++;
1980 switch (*mode++) {
1981 case 'r':
1982 l->flags |= PERLIO_F_CANREAD;
1983 break;
1984 case 'a':
1985 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
1986 break;
1987 case 'w':
1988 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
1989 break;
1990 default:
1991 SETERRNO(EINVAL, LIB_INVARG);
1992 return -1;
1993 }
1994#ifdef EBCDIC
1995 {
1996 /* The mode variable contains one positional parameter followed by
1997 * optional keyword parameters. The positional parameters must be
1998 * passed as lowercase characters. The keyword parameters can be
1999 * passed in mixed case. They must be separated by commas. Only one
2000 * instance of a keyword can be specified. */
2001 int comma = 0;
2002 while (*mode) {
2003 switch (*mode++) {
2004 case '+':
2005 if(!comma)
2006 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2007 break;
2008 case 'b':
2009 if(!comma)
2010 l->flags &= ~PERLIO_F_CRLF;
2011 break;
2012 case 't':
2013 if(!comma)
2014 l->flags |= PERLIO_F_CRLF;
2015 break;
2016 case ',':
2017 comma = 1;
2018 break;
2019 default:
2020 break;
2021 }
2022 }
2023 }
2024#else
2025 while (*mode) {
2026 switch (*mode++) {
2027 case '+':
2028 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2029 break;
2030 case 'b':
2031 l->flags &= ~PERLIO_F_CRLF;
2032 break;
2033 case 't':
2034 l->flags |= PERLIO_F_CRLF;
2035 break;
2036 default:
2037 SETERRNO(EINVAL, LIB_INVARG);
2038 return -1;
2039 }
2040 }
2041#endif
2042 }
2043 else {
2044 if (l->next) {
2045 l->flags |= l->next->flags &
2046 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2047 PERLIO_F_APPEND);
2048 }
2049 }
2050#if 0
2051 DEBUG_i(
2052 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2053 (void*)f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2054 l->flags, PerlIO_modestr(f, temp));
2055 );
2056#endif
2057 return 0;
2058}
2059
2060IV
2061PerlIOBase_popped(pTHX_ PerlIO *f)
2062{
2063 PERL_UNUSED_CONTEXT;
2064 PERL_UNUSED_ARG(f);
2065 return 0;
2066}
2067
2068SSize_t
2069PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2070{
2071 /*
2072 * Save the position as current head considers it
2073 */
2074 const Off_t old = PerlIO_tell(f);
2075 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", NULL);
2076 PerlIOSelf(f, PerlIOBuf)->posn = old;
2077 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
2078}
2079
2080SSize_t
2081PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2082{
2083 STDCHAR *buf = (STDCHAR *) vbuf;
2084 if (f) {
2085 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2086 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2087 SETERRNO(EBADF, SS_IVCHAN);
2088 PerlIO_save_errno(f);
2089 return 0;
2090 }
2091 while (count > 0) {
2092 get_cnt:
2093 {
2094 SSize_t avail = PerlIO_get_cnt(f);
2095 SSize_t take = 0;
2096 if (avail > 0)
2097 take = (((SSize_t) count >= 0) && ((SSize_t)count < avail)) ? (SSize_t)count : avail;
2098 if (take > 0) {
2099 STDCHAR *ptr = PerlIO_get_ptr(f);
2100 Copy(ptr, buf, take, STDCHAR);
2101 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2102 count -= take;
2103 buf += take;
2104 if (avail == 0) /* set_ptrcnt could have reset avail */
2105 goto get_cnt;
2106 }
2107 if (count > 0 && avail <= 0) {
2108 if (PerlIO_fill(f) != 0)
2109 break;
2110 }
2111 }
2112 }
2113 return (buf - (STDCHAR *) vbuf);
2114 }
2115 return 0;
2116}
2117
2118IV
2119PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2120{
2121 PERL_UNUSED_CONTEXT;
2122 PERL_UNUSED_ARG(f);
2123 return 0;
2124}
2125
2126IV
2127PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2128{
2129 PERL_UNUSED_CONTEXT;
2130 PERL_UNUSED_ARG(f);
2131 return -1;
2132}
2133
2134IV
2135PerlIOBase_close(pTHX_ PerlIO *f)
2136{
2137 IV code = -1;
2138 if (PerlIOValid(f)) {
2139 PerlIO *n = PerlIONext(f);
2140 code = PerlIO_flush(f);
2141 PerlIOBase(f)->flags &=
2142 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2143 while (PerlIOValid(n)) {
2144 const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2145 if (tab && tab->Close) {
2146 if ((*tab->Close)(aTHX_ n) != 0)
2147 code = -1;
2148 break;
2149 }
2150 else {
2151 PerlIOBase(n)->flags &=
2152 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2153 }
2154 n = PerlIONext(n);
2155 }
2156 }
2157 else {
2158 SETERRNO(EBADF, SS_IVCHAN);
2159 }
2160 return code;
2161}
2162
2163IV
2164PerlIOBase_eof(pTHX_ PerlIO *f)
2165{
2166 PERL_UNUSED_CONTEXT;
2167 if (PerlIOValid(f)) {
2168 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2169 }
2170 return 1;
2171}
2172
2173IV
2174PerlIOBase_error(pTHX_ PerlIO *f)
2175{
2176 PERL_UNUSED_CONTEXT;
2177 if (PerlIOValid(f)) {
2178 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2179 }
2180 return 1;
2181}
2182
2183void
2184PerlIOBase_clearerr(pTHX_ PerlIO *f)
2185{
2186 if (PerlIOValid(f)) {
2187 PerlIO * const n = PerlIONext(f);
2188 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2189 if (PerlIOValid(n))
2190 PerlIO_clearerr(n);
2191 }
2192}
2193
2194void
2195PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2196{
2197 PERL_UNUSED_CONTEXT;
2198 if (PerlIOValid(f)) {
2199 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2200 }
2201}
2202
2203SV *
2204PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2205{
2206 if (!arg)
2207 return NULL;
2208#ifdef USE_ITHREADS
2209 if (param) {
2210 arg = sv_dup(arg, param);
2211 SvREFCNT_inc_simple_void_NN(arg);
2212 return arg;
2213 }
2214 else {
2215 return newSVsv(arg);
2216 }
2217#else
2218 PERL_UNUSED_ARG(param);
2219 return newSVsv(arg);
2220#endif
2221}
2222
2223PerlIO *
2224PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2225{
2226 PerlIO * const nexto = PerlIONext(o);
2227 if (PerlIOValid(nexto)) {
2228 const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2229 if (tab && tab->Dup)
2230 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2231 else
2232 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2233 }
2234 if (f) {
2235 PerlIO_funcs * const self = PerlIOBase(o)->tab;
2236 SV *arg = NULL;
2237 char buf[8];
2238 assert(self);
2239 DEBUG_i(PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2240 self->name,
2241 (void*)f, (void*)o, (void*)param) );
2242 if (self->Getarg)
2243 arg = (*self->Getarg)(aTHX_ o, param, flags);
2244 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2245 if (f && PerlIOBase(o)->flags & PERLIO_F_UTF8)
2246 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
2247 SvREFCNT_dec(arg);
2248 }
2249 return f;
2250}
2251
2252/* PL_perlio_fd_refcnt[] is in intrpvar.h */
2253
2254/* Must be called with PL_perlio_mutex locked. */
2255static void
2256S_more_refcounted_fds(pTHX_ const int new_fd)
2257 PERL_TSA_REQUIRES(PL_perlio_mutex)
2258{
2259 const int old_max = PL_perlio_fd_refcnt_size;
2260 const int new_max = 16 + (new_fd & ~15);
2261 int *new_array;
2262
2263#ifndef PERL_IMPLICIT_SYS
2264 PERL_UNUSED_CONTEXT;
2265#endif
2266
2267 DEBUG_i( PerlIO_debug("More fds - old=%d, need %d, new=%d\n",
2268 old_max, new_fd, new_max) );
2269
2270 if (new_fd < old_max) {
2271 return;
2272 }
2273
2274 assert (new_max > new_fd);
2275
2276 /* Use plain realloc() since we need this memory to be really
2277 * global and visible to all the interpreters and/or threads. */
2278 new_array = (int*) realloc(PL_perlio_fd_refcnt, new_max * sizeof(int));
2279
2280 if (!new_array) {
2281 MUTEX_UNLOCK(&PL_perlio_mutex);
2282 croak_no_mem();
2283 }
2284
2285 PL_perlio_fd_refcnt_size = new_max;
2286 PL_perlio_fd_refcnt = new_array;
2287
2288 DEBUG_i( PerlIO_debug("Zeroing %p, %d\n",
2289 (void*)(new_array + old_max),
2290 new_max - old_max) );
2291
2292 Zero(new_array + old_max, new_max - old_max, int);
2293}
2294
2295
2296void
2297PerlIO_init(pTHX)
2298{
2299 /* MUTEX_INIT(&PL_perlio_mutex) is done in PERL_SYS_INIT3(). */
2300 PERL_UNUSED_CONTEXT;
2301}
2302
2303void
2304PerlIOUnix_refcnt_inc(int fd)
2305{
2306 dTHX;
2307 if (fd >= 0) {
2308
2309 MUTEX_LOCK(&PL_perlio_mutex);
2310 if (fd >= PL_perlio_fd_refcnt_size)
2311 S_more_refcounted_fds(aTHX_ fd);
2312
2313 PL_perlio_fd_refcnt[fd]++;
2314 if (PL_perlio_fd_refcnt[fd] <= 0) {
2315 /* diag_listed_as: refcnt_inc: fd %d%s */
2316 Perl_croak(aTHX_ "refcnt_inc: fd %d: %d <= 0\n",
2317 fd, PL_perlio_fd_refcnt[fd]);
2318 }
2319 DEBUG_i( PerlIO_debug("refcnt_inc: fd %d refcnt=%d\n",
2320 fd, PL_perlio_fd_refcnt[fd]) );
2321
2322 MUTEX_UNLOCK(&PL_perlio_mutex);
2323 } else {
2324 /* diag_listed_as: refcnt_inc: fd %d%s */
2325 Perl_croak(aTHX_ "refcnt_inc: fd %d < 0\n", fd);
2326 }
2327}
2328
2329int
2330PerlIOUnix_refcnt_dec(int fd)
2331{
2332 int cnt = 0;
2333 if (fd >= 0) {
2334#ifdef DEBUGGING
2335 dTHX;
2336#else
2337#endif
2338 MUTEX_LOCK(&PL_perlio_mutex);
2339 if (fd >= PL_perlio_fd_refcnt_size) {
2340 /* diag_listed_as: refcnt_dec: fd %d%s */
2341 Perl_croak_nocontext("refcnt_dec: fd %d >= refcnt_size %d\n",
2342 fd, PL_perlio_fd_refcnt_size);
2343 }
2344 if (PL_perlio_fd_refcnt[fd] <= 0) {
2345 /* diag_listed_as: refcnt_dec: fd %d%s */
2346 Perl_croak_nocontext("refcnt_dec: fd %d: %d <= 0\n",
2347 fd, PL_perlio_fd_refcnt[fd]);
2348 }
2349 cnt = --PL_perlio_fd_refcnt[fd];
2350 DEBUG_i( PerlIO_debug("refcnt_dec: fd %d refcnt=%d\n", fd, cnt) );
2351 MUTEX_UNLOCK(&PL_perlio_mutex);
2352 } else {
2353 /* diag_listed_as: refcnt_dec: fd %d%s */
2354 Perl_croak_nocontext("refcnt_dec: fd %d < 0\n", fd);
2355 }
2356 return cnt;
2357}
2358
2359int
2360PerlIOUnix_refcnt(int fd)
2361{
2362 dTHX;
2363 int cnt = 0;
2364 if (fd >= 0) {
2365 MUTEX_LOCK(&PL_perlio_mutex);
2366 if (fd >= PL_perlio_fd_refcnt_size) {
2367 /* diag_listed_as: refcnt: fd %d%s */
2368 Perl_croak(aTHX_ "refcnt: fd %d >= refcnt_size %d\n",
2369 fd, PL_perlio_fd_refcnt_size);
2370 }
2371 if (PL_perlio_fd_refcnt[fd] <= 0) {
2372 /* diag_listed_as: refcnt: fd %d%s */
2373 Perl_croak(aTHX_ "refcnt: fd %d: %d <= 0\n",
2374 fd, PL_perlio_fd_refcnt[fd]);
2375 }
2376 cnt = PL_perlio_fd_refcnt[fd];
2377 MUTEX_UNLOCK(&PL_perlio_mutex);
2378 } else {
2379 /* diag_listed_as: refcnt: fd %d%s */
2380 Perl_croak(aTHX_ "refcnt: fd %d < 0\n", fd);
2381 }
2382 return cnt;
2383}
2384
2385void
2386PerlIO_cleanup(pTHX)
2387{
2388 int i;
2389#ifdef USE_ITHREADS
2390 DEBUG_i( PerlIO_debug("Cleanup layers for %p\n",(void*)aTHX) );
2391#else
2392 DEBUG_i( PerlIO_debug("Cleanup layers\n") );
2393#endif
2394
2395 /* Raise STDIN..STDERR refcount so we don't close them */
2396 for (i=0; i < 3; i++)
2397 PerlIOUnix_refcnt_inc(i);
2398 PerlIO_cleantable(aTHX_ &PL_perlio);
2399 /* Restore STDIN..STDERR refcount */
2400 for (i=0; i < 3; i++)
2401 PerlIOUnix_refcnt_dec(i);
2402
2403 if (PL_known_layers) {
2404 PerlIO_list_free(aTHX_ PL_known_layers);
2405 PL_known_layers = NULL;
2406 }
2407 if (PL_def_layerlist) {
2408 PerlIO_list_free(aTHX_ PL_def_layerlist);
2409 PL_def_layerlist = NULL;
2410 }
2411}
2412
2413void PerlIO_teardown(void) /* Call only from PERL_SYS_TERM(). */
2414{
2415#if 0
2416/* XXX we can't rely on an interpreter being present at this late stage,
2417 XXX so we can't use a function like PerlLIO_write that relies on one
2418 being present (at least in win32) :-(.
2419 Disable for now.
2420*/
2421#ifdef DEBUGGING
2422 {
2423 /* By now all filehandles should have been closed, so any
2424 * stray (non-STD-)filehandles indicate *possible* (PerlIO)
2425 * errors. */
2426#define PERLIO_TEARDOWN_MESSAGE_BUF_SIZE 64
2427#define PERLIO_TEARDOWN_MESSAGE_FD 2
2428 char buf[PERLIO_TEARDOWN_MESSAGE_BUF_SIZE];
2429 int i;
2430 for (i = 3; i < PL_perlio_fd_refcnt_size; i++) {
2431 if (PL_perlio_fd_refcnt[i]) {
2432 const STRLEN len =
2433 my_snprintf(buf, sizeof(buf),
2434 "PerlIO_teardown: fd %d refcnt=%d\n",
2435 i, PL_perlio_fd_refcnt[i]);
2436 PerlLIO_write(PERLIO_TEARDOWN_MESSAGE_FD, buf, len);
2437 }
2438 }
2439 }
2440#endif
2441#endif
2442 /* Not bothering with PL_perlio_mutex since by now
2443 * all the interpreters are gone. */
2444 if (PL_perlio_fd_refcnt_size /* Assuming initial size of zero. */
2445 && PL_perlio_fd_refcnt) {
2446 free(PL_perlio_fd_refcnt); /* To match realloc() in S_more_refcounted_fds(). */
2447 PL_perlio_fd_refcnt = NULL;
2448 PL_perlio_fd_refcnt_size = 0;
2449 }
2450}
2451
2452/*--------------------------------------------------------------------------------------*/
2453/*
2454 * Bottom-most level for UNIX-like case
2455 */
2456
2457typedef struct {
2458 struct _PerlIO base; /* The generic part */
2459 int fd; /* UNIX like file descriptor */
2460 int oflags; /* open/fcntl flags */
2461} PerlIOUnix;
2462
2463static void
2464S_lockcnt_dec(pTHX_ const void* f)
2465{
2466#ifndef PERL_IMPLICIT_SYS
2467 PERL_UNUSED_CONTEXT;
2468#endif
2469 PerlIO_lockcnt((PerlIO*)f)--;
2470}
2471
2472
2473/* call the signal handler, and if that handler happens to clear
2474 * this handle, free what we can and return true */
2475
2476static bool
2477S_perlio_async_run(pTHX_ PerlIO* f) {
2478 ENTER;
2479 SAVEDESTRUCTOR_X(S_lockcnt_dec, (void*)f);
2480 PerlIO_lockcnt(f)++;
2481 PERL_ASYNC_CHECK();
2482 if ( !(PerlIOBase(f)->flags & PERLIO_F_CLEARED) ) {
2483 LEAVE;
2484 return 0;
2485 }
2486 /* we've just run some perl-level code that could have done
2487 * anything, including closing the file or clearing this layer.
2488 * If so, free any lower layers that have already been
2489 * cleared, then return an error. */
2490 while (PerlIOValid(f) &&
2491 (PerlIOBase(f)->flags & PERLIO_F_CLEARED))
2492 {
2493 const PerlIOl *l = *f;
2494 *f = l->next;
2495 Safefree(l);
2496 }
2497 LEAVE;
2498 return 1;
2499}
2500
2501int
2502PerlIOUnix_oflags(const char *mode)
2503{
2504 int oflags = -1;
2505 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2506 mode++;
2507 switch (*mode) {
2508 case 'r':
2509 oflags = O_RDONLY;
2510 if (*++mode == '+') {
2511 oflags = O_RDWR;
2512 mode++;
2513 }
2514 break;
2515
2516 case 'w':
2517 oflags = O_CREAT | O_TRUNC;
2518 if (*++mode == '+') {
2519 oflags |= O_RDWR;
2520 mode++;
2521 }
2522 else
2523 oflags |= O_WRONLY;
2524 break;
2525
2526 case 'a':
2527 oflags = O_CREAT | O_APPEND;
2528 if (*++mode == '+') {
2529 oflags |= O_RDWR;
2530 mode++;
2531 }
2532 else
2533 oflags |= O_WRONLY;
2534 break;
2535 }
2536
2537 /* XXX TODO: PerlIO_open() test that exercises 'rb' and 'rt'. */
2538
2539 /* Unless O_BINARY is different from O_TEXT, first bit-or:ing one
2540 * of them in, and then bit-and-masking the other them away, won't
2541 * have much of an effect. */
2542 switch (*mode) {
2543 case 'b':
2544#if O_TEXT != O_BINARY
2545 oflags |= O_BINARY;
2546 oflags &= ~O_TEXT;
2547#endif
2548 mode++;
2549 break;
2550 case 't':
2551#if O_TEXT != O_BINARY
2552 oflags |= O_TEXT;
2553 oflags &= ~O_BINARY;
2554#endif
2555 mode++;
2556 break;
2557 default:
2558# if O_BINARY != 0
2559 /* bit-or:ing with zero O_BINARY would be useless. */
2560 /*
2561 * If neither "t" nor "b" was specified, open the file
2562 * in O_BINARY mode.
2563 *
2564 * Note that if something else than the zero byte was seen
2565 * here (e.g. bogus mode "rx"), just few lines later we will
2566 * set the errno and invalidate the flags.
2567 */
2568 oflags |= O_BINARY;
2569# endif
2570 break;
2571 }
2572 if (*mode || oflags == -1) {
2573 SETERRNO(EINVAL, LIB_INVARG);
2574 oflags = -1;
2575 }
2576 return oflags;
2577}
2578
2579IV
2580PerlIOUnix_fileno(pTHX_ PerlIO *f)
2581{
2582 PERL_UNUSED_CONTEXT;
2583 return PerlIOSelf(f, PerlIOUnix)->fd;
2584}
2585
2586static void
2587PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2588{
2589 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2590#if defined(WIN32)
2591 Stat_t st;
2592 if (PerlLIO_fstat(fd, &st) == 0) {
2593 if (!S_ISREG(st.st_mode)) {
2594 DEBUG_i( PerlIO_debug("%d is not regular file\n",fd) );
2595 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2596 }
2597 else {
2598 DEBUG_i( PerlIO_debug("%d _is_ a regular file\n",fd) );
2599 }
2600 }
2601#endif
2602 s->fd = fd;
2603 s->oflags = imode;
2604 PerlIOUnix_refcnt_inc(fd);
2605 PERL_UNUSED_CONTEXT;
2606}
2607
2608IV
2609PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2610{
2611 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2612 if (*PerlIONext(f)) {
2613 /* We never call down so do any pending stuff now */
2614 PerlIO_flush(PerlIONext(f));
2615 /*
2616 * XXX could (or should) we retrieve the oflags from the open file
2617 * handle rather than believing the "mode" we are passed in? XXX
2618 * Should the value on NULL mode be 0 or -1?
2619 */
2620 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2621 mode ? PerlIOUnix_oflags(mode) : -1);
2622 }
2623 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2624
2625 return code;
2626}
2627
2628IV
2629PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2630{
2631 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2632 Off_t new_loc;
2633 PERL_UNUSED_CONTEXT;
2634 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2635#ifdef ESPIPE
2636 SETERRNO(ESPIPE, LIB_INVARG);
2637#else
2638 SETERRNO(EINVAL, LIB_INVARG);
2639#endif
2640 return -1;
2641 }
2642 new_loc = PerlLIO_lseek(fd, offset, whence);
2643 if (new_loc == (Off_t) - 1)
2644 return -1;
2645 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2646 return 0;
2647}
2648
2649PerlIO *
2650PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2651 IV n, const char *mode, int fd, int imode,
2652 int perm, PerlIO *f, int narg, SV **args)
2653{
2654 bool known_cloexec = 0;
2655 if (PerlIOValid(f)) {
2656 if (PerlIOBase(f)->tab && PerlIOBase(f)->flags & PERLIO_F_OPEN)
2657 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2658 }
2659 if (narg > 0) {
2660 if (*mode == IoTYPE_NUMERIC)
2661 mode++;
2662 else {
2663 imode = PerlIOUnix_oflags(mode);
2664#ifdef VMS
2665 perm = 0777; /* preserve RMS defaults, ACL inheritance, etc. */
2666#else
2667 perm = 0666;
2668#endif
2669 }
2670 if (imode != -1) {
2671 STRLEN len;
2672 const char *path = SvPV_const(*args, len);
2673 if (!IS_SAFE_PATHNAME(path, len, "open"))
2674 return NULL;
2675 fd = PerlLIO_open3_cloexec(path, imode, perm);
2676 known_cloexec = 1;
2677 }
2678 }
2679 if (fd >= 0) {
2680 if (known_cloexec)
2681 setfd_inhexec_for_sysfd(fd);
2682 else
2683 setfd_cloexec_or_inhexec_by_sysfdness(fd);
2684 if (*mode == IoTYPE_IMPLICIT)
2685 mode++;
2686 if (!f) {
2687 f = PerlIO_allocate(aTHX);
2688 }
2689 if (!PerlIOValid(f)) {
2690 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2691 PerlLIO_close(fd);
2692 return NULL;
2693 }
2694 }
2695 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2696 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2697 if (*mode == IoTYPE_APPEND)
2698 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2699 return f;
2700 }
2701 else {
2702 if (f) {
2703 NOOP;
2704 /*
2705 * FIXME: pop layers ???
2706 */
2707 }
2708 return NULL;
2709 }
2710}
2711
2712PerlIO *
2713PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2714{
2715 const PerlIOUnix * const os = PerlIOSelf(o, PerlIOUnix);
2716 int fd = os->fd;
2717 if (flags & PERLIO_DUP_FD) {
2718 fd = PerlLIO_dup_cloexec(fd);
2719 if (fd >= 0)
2720 setfd_inhexec_for_sysfd(fd);
2721 }
2722 if (fd >= 0) {
2723 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2724 if (f) {
2725 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2726 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2727 return f;
2728 }
2729 PerlLIO_close(fd);
2730 }
2731 return NULL;
2732}
2733
2734
2735SSize_t
2736PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2737{
2738 int fd;
2739 if (PerlIO_lockcnt(f)) /* in use: abort ungracefully */
2740 return -1;
2741 fd = PerlIOSelf(f, PerlIOUnix)->fd;
2742 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2743 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2744 return 0;
2745 }
2746 while (1) {
2747 const SSize_t len = PerlLIO_read(fd, vbuf, count);
2748 if (len >= 0 || errno != EINTR) {
2749 if (len < 0) {
2750 if (errno != EAGAIN) {
2751 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2752 PerlIO_save_errno(f);
2753 }
2754 }
2755 else if (len == 0 && count != 0) {
2756 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2757 SETERRNO(0,0);
2758 }
2759 return len;
2760 }
2761 /* EINTR */
2762 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
2763 return -1;
2764 }
2765 NOT_REACHED; /*NOTREACHED*/
2766}
2767
2768SSize_t
2769PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2770{
2771 int fd;
2772 if (PerlIO_lockcnt(f)) /* in use: abort ungracefully */
2773 return -1;
2774 fd = PerlIOSelf(f, PerlIOUnix)->fd;
2775 while (1) {
2776 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2777 if (len >= 0 || errno != EINTR) {
2778 if (len < 0) {
2779 if (errno != EAGAIN) {
2780 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2781 PerlIO_save_errno(f);
2782 }
2783 }
2784 return len;
2785 }
2786 /* EINTR */
2787 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
2788 return -1;
2789 }
2790 NOT_REACHED; /*NOTREACHED*/
2791}
2792
2793Off_t
2794PerlIOUnix_tell(pTHX_ PerlIO *f)
2795{
2796 PERL_UNUSED_CONTEXT;
2797
2798 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2799}
2800
2801
2802IV
2803PerlIOUnix_close(pTHX_ PerlIO *f)
2804{
2805 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2806 int code = 0;
2807 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2808 code = PerlIOBase_close(aTHX_ f);
2809 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2810 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2811 return 0;
2812 }
2813 }
2814 else {
2815 SETERRNO(EBADF,SS_IVCHAN);
2816 return -1;
2817 }
2818 while (PerlLIO_close(fd) != 0) {
2819 if (errno != EINTR) {
2820 code = -1;
2821 break;
2822 }
2823 /* EINTR */
2824 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
2825 return -1;
2826 }
2827 if (code == 0) {
2828 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2829 }
2830 return code;
2831}
2832
2833PERLIO_FUNCS_DECL(PerlIO_unix) = {
2834 sizeof(PerlIO_funcs),
2835 "unix",
2836 sizeof(PerlIOUnix),
2837 PERLIO_K_RAW,
2838 PerlIOUnix_pushed,
2839 PerlIOBase_popped,
2840 PerlIOUnix_open,
2841 PerlIOBase_binmode, /* binmode */
2842 NULL,
2843 PerlIOUnix_fileno,
2844 PerlIOUnix_dup,
2845 PerlIOUnix_read,
2846 PerlIOBase_unread,
2847 PerlIOUnix_write,
2848 PerlIOUnix_seek,
2849 PerlIOUnix_tell,
2850 PerlIOUnix_close,
2851 PerlIOBase_noop_ok, /* flush */
2852 PerlIOBase_noop_fail, /* fill */
2853 PerlIOBase_eof,
2854 PerlIOBase_error,
2855 PerlIOBase_clearerr,
2856 PerlIOBase_setlinebuf,
2857 NULL, /* get_base */
2858 NULL, /* get_bufsiz */
2859 NULL, /* get_ptr */
2860 NULL, /* get_cnt */
2861 NULL, /* set_ptrcnt */
2862};
2863
2864/*--------------------------------------------------------------------------------------*/
2865/*
2866 * stdio as a layer
2867 */
2868
2869#if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2870/* perl5.8 - This ensures the last minute VMS ungetc fix is not
2871 broken by the last second glibc 2.3 fix
2872 */
2873#define STDIO_BUFFER_WRITABLE
2874#endif
2875
2876
2877typedef struct {
2878 struct _PerlIO base;
2879 FILE *stdio; /* The stream */
2880} PerlIOStdio;
2881
2882IV
2883PerlIOStdio_fileno(pTHX_ PerlIO *f)
2884{
2885 PERL_UNUSED_CONTEXT;
2886
2887 if (PerlIOValid(f)) {
2888 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
2889 if (s)
2890 return PerlSIO_fileno(s);
2891 }
2892 errno = EBADF;
2893 return -1;
2894}
2895
2896char *
2897PerlIOStdio_mode(const char *mode, char *tmode)
2898{
2899 char * const ret = tmode;
2900 if (mode) {
2901 while (*mode) {
2902 *tmode++ = *mode++;
2903 }
2904 }
2905#if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2906 *tmode++ = 'b';
2907#endif
2908 *tmode = '\0';
2909 return ret;
2910}
2911
2912IV
2913PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2914{
2915 PerlIO *n;
2916 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2917 PerlIO_funcs * const toptab = PerlIOBase(n)->tab;
2918 if (toptab == tab) {
2919 /* Top is already stdio - pop self (duplicate) and use original */
2920 PerlIO_pop(aTHX_ f);
2921 return 0;
2922 } else {
2923 const int fd = PerlIO_fileno(n);
2924 char tmode[8];
2925 FILE *stdio;
2926 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2927 mode = PerlIOStdio_mode(mode, tmode)))) {
2928 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2929 /* We never call down so do any pending stuff now */
2930 PerlIO_flush(PerlIONext(f));
2931 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2932 }
2933 else {
2934 return -1;
2935 }
2936 }
2937 }
2938 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2939}
2940
2941
2942PerlIO *
2943PerlIO_importFILE(FILE *stdio, const char *mode)
2944{
2945 dTHX;
2946 PerlIO *f = NULL;
2947#ifdef EBCDIC
2948 int rc;
2949 char filename[FILENAME_MAX];
2950 fldata_t fileinfo;
2951#endif
2952 if (stdio) {
2953 PerlIOStdio *s;
2954 int fd0 = fileno(stdio);
2955 if (fd0 < 0) {
2956#ifdef EBCDIC
2957 rc = fldata(stdio,filename,&fileinfo);
2958 if(rc != 0){
2959 return NULL;
2960 }
2961 if(fileinfo.__dsorgHFS){
2962 return NULL;
2963 }
2964 /*This MVS dataset , OK!*/
2965#else
2966 return NULL;
2967#endif
2968 }
2969 if (!mode || !*mode) {
2970 /* We need to probe to see how we can open the stream
2971 so start with read/write and then try write and read
2972 we dup() so that we can fclose without loosing the fd.
2973
2974 Note that the errno value set by a failing fdopen
2975 varies between stdio implementations.
2976 */
2977 const int fd = PerlLIO_dup_cloexec(fd0);
2978 FILE *f2;
2979 if (fd < 0) {
2980 return f;
2981 }
2982 f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2983 if (!f2) {
2984 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2985 }
2986 if (!f2) {
2987 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2988 }
2989 if (!f2) {
2990 /* Don't seem to be able to open */
2991 PerlLIO_close(fd);
2992 return f;
2993 }
2994 fclose(f2);
2995 }
2996 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, NULL))) {
2997 s = PerlIOSelf(f, PerlIOStdio);
2998 s->stdio = stdio;
2999 fd0 = fileno(stdio);
3000 if(fd0 != -1){
3001 PerlIOUnix_refcnt_inc(fd0);
3002 setfd_cloexec_or_inhexec_by_sysfdness(fd0);
3003 }
3004#ifdef EBCDIC
3005 else{
3006 rc = fldata(stdio,filename,&fileinfo);
3007 if(rc != 0){
3008 PerlIOUnix_refcnt_inc(fd0);
3009 }
3010 if(fileinfo.__dsorgHFS){
3011 PerlIOUnix_refcnt_inc(fd0);
3012 }
3013 /*This MVS dataset , OK!*/
3014 }
3015#endif
3016 }
3017 }
3018 return f;
3019}
3020
3021PerlIO *
3022PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3023 IV n, const char *mode, int fd, int imode,
3024 int perm, PerlIO *f, int narg, SV **args)
3025{
3026 char tmode[8];
3027 if (PerlIOValid(f)) {
3028 STRLEN len;
3029 const char * const path = SvPV_const(*args, len);
3030 PerlIOStdio * const s = PerlIOSelf(f, PerlIOStdio);
3031 FILE *stdio;
3032 if (!IS_SAFE_PATHNAME(path, len, "open"))
3033 return NULL;
3034 PerlIOUnix_refcnt_dec(fileno(s->stdio));
3035 stdio = PerlSIO_freopen(path, PerlIOStdio_mode(mode, tmode),
3036 s->stdio);
3037 if (!s->stdio)
3038 return NULL;
3039 s->stdio = stdio;
3040 fd = fileno(stdio);
3041 PerlIOUnix_refcnt_inc(fd);
3042 setfd_cloexec_or_inhexec_by_sysfdness(fd);
3043 return f;
3044 }
3045 else {
3046 if (narg > 0) {
3047 STRLEN len;
3048 const char * const path = SvPV_const(*args, len);
3049 if (!IS_SAFE_PATHNAME(path, len, "open"))
3050 return NULL;
3051 if (*mode == IoTYPE_NUMERIC) {
3052 mode++;
3053 fd = PerlLIO_open3_cloexec(path, imode, perm);
3054 }
3055 else {
3056 FILE *stdio;
3057 bool appended = FALSE;
3058#ifdef __CYGWIN__
3059 /* Cygwin wants its 'b' early. */
3060 appended = TRUE;
3061 mode = PerlIOStdio_mode(mode, tmode);
3062#endif
3063 stdio = PerlSIO_fopen(path, mode);
3064 if (stdio) {
3065 if (!f) {
3066 f = PerlIO_allocate(aTHX);
3067 }
3068 if (!appended)
3069 mode = PerlIOStdio_mode(mode, tmode);
3070 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
3071 if (f) {
3072 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3073 fd = fileno(stdio);
3074 PerlIOUnix_refcnt_inc(fd);
3075 setfd_cloexec_or_inhexec_by_sysfdness(fd);
3076 } else {
3077 PerlSIO_fclose(stdio);
3078 }
3079 return f;
3080 }
3081 else {
3082 return NULL;
3083 }
3084 }
3085 }
3086 if (fd >= 0) {
3087 FILE *stdio = NULL;
3088 int init = 0;
3089 if (*mode == IoTYPE_IMPLICIT) {
3090 init = 1;
3091 mode++;
3092 }
3093 if (init) {
3094 switch (fd) {
3095 case 0:
3096 stdio = PerlSIO_stdin;
3097 break;
3098 case 1:
3099 stdio = PerlSIO_stdout;
3100 break;
3101 case 2:
3102 stdio = PerlSIO_stderr;
3103 break;
3104 }
3105 }
3106 else {
3107 stdio = PerlSIO_fdopen(fd, mode =
3108 PerlIOStdio_mode(mode, tmode));
3109 }
3110 if (stdio) {
3111 if (!f) {
3112 f = PerlIO_allocate(aTHX);
3113 }
3114 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
3115 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3116 fd = fileno(stdio);
3117 PerlIOUnix_refcnt_inc(fd);
3118 setfd_cloexec_or_inhexec_by_sysfdness(fd);
3119 }
3120 return f;
3121 }
3122 PerlLIO_close(fd);
3123 }
3124 }
3125 return NULL;
3126}
3127
3128PerlIO *
3129PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3130{
3131 /* This assumes no layers underneath - which is what
3132 happens, but is not how I remember it. NI-S 2001/10/16
3133 */
3134 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
3135 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
3136 const int fd = fileno(stdio);
3137 char mode[8];
3138 if (flags & PERLIO_DUP_FD) {
3139 const int dfd = PerlLIO_dup_cloexec(fileno(stdio));
3140 if (dfd >= 0) {
3141 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
3142 goto set_this;
3143 }
3144 else {
3145 NOOP;
3146 /* FIXME: To avoid messy error recovery if dup fails
3147 re-use the existing stdio as though flag was not set
3148 */
3149 }
3150 }
3151 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
3152 set_this:
3153 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3154 if(stdio) {
3155 int fd = fileno(stdio);
3156 PerlIOUnix_refcnt_inc(fd);
3157 setfd_cloexec_or_inhexec_by_sysfdness(fd);
3158 }
3159 }
3160 return f;
3161}
3162
3163static int
3164PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
3165{
3166 PERL_UNUSED_CONTEXT;
3167
3168 /* XXX this could use PerlIO_canset_fileno() and
3169 * PerlIO_set_fileno() support from Configure
3170 */
3171# if defined(HAS_FDCLOSE)
3172 return fdclose(f, NULL) == 0 ? 1 : 0;
3173# elif defined(__UCLIBC__)
3174 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
3175 f->__filedes = -1;
3176 return 1;
3177# elif defined(__GLIBC__)
3178 /* There may be a better way for GLIBC:
3179 - libio.h defines a flag to not close() on cleanup
3180 */
3181 f->_fileno = -1;
3182 return 1;
3183# elif defined(__sun)
3184 PERL_UNUSED_ARG(f);
3185 return 0;
3186# elif defined(__hpux)
3187 f->__fileH = 0xff;
3188 f->__fileL = 0xff;
3189 return 1;
3190 /* Next one ->_file seems to be a reasonable fallback, i.e. if
3191 your platform does not have special entry try this one.
3192 [For OSF only have confirmation for Tru64 (alpha)
3193 but assume other OSFs will be similar.]
3194 */
3195# elif defined(_AIX) || defined(__osf__) || defined(__irix__)
3196 f->_file = -1;
3197 return 1;
3198# elif defined(__FreeBSD__)
3199 /* There may be a better way on FreeBSD:
3200 - we could insert a dummy func in the _close function entry
3201 f->_close = (int (*)(void *)) dummy_close;
3202 */
3203 f->_file = -1;
3204 return 1;
3205# elif defined(__OpenBSD__)
3206 /* There may be a better way on OpenBSD:
3207 - we could insert a dummy func in the _close function entry
3208 f->_close = (int (*)(void *)) dummy_close;
3209 */
3210 f->_file = -1;
3211 return 1;
3212# elif defined(__EMX__)
3213 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
3214 f->_handle = -1;
3215 return 1;
3216# elif defined(__CYGWIN__)
3217 /* There may be a better way on CYGWIN:
3218 - we could insert a dummy func in the _close function entry
3219 f->_close = (int (*)(void *)) dummy_close;
3220 */
3221 f->_file = -1;
3222 return 1;
3223# elif defined(WIN32)
3224 PERLIO_FILE_file(f) = -1;
3225 return 1;
3226# else
3227#if 0
3228 /* Sarathy's code did this - we fall back to a dup/dup2 hack
3229 (which isn't thread safe) instead
3230 */
3231# error "Don't know how to set FILE.fileno on your platform"
3232#endif
3233 PERL_UNUSED_ARG(f);
3234 return 0;
3235# endif
3236}
3237
3238IV
3239PerlIOStdio_close(pTHX_ PerlIO *f)
3240{
3241 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3242 if (!stdio) {
3243 errno = EBADF;
3244 return -1;
3245 }
3246 else {
3247 const int fd = fileno(stdio);
3248 int invalidate = 0;
3249 IV result = 0;
3250 int dupfd = -1;
3251 dSAVEDERRNO;
3252#ifdef USE_ITHREADS
3253#endif
3254#ifdef SOCKS5_VERSION_NAME
3255 /* Socks lib overrides close() but stdio isn't linked to
3256 that library (though we are) - so we must call close()
3257 on sockets on stdio's behalf.
3258 */
3259 int optval;
3260 Sock_size_t optlen = sizeof(int);
3261 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0)
3262 invalidate = 1;
3263#endif
3264 /* Test for -1, as *BSD stdio (at least) on fclose sets the FILE* such
3265 that a subsequent fileno() on it returns -1. Don't want to croak()
3266 from within PerlIOUnix_refcnt_dec() if some buggy caller code is
3267 trying to close an already closed handle which somehow it still has
3268 a reference to. (via.xs, I'm looking at you). */
3269 if (fd != -1 && PerlIOUnix_refcnt_dec(fd) > 0) {
3270 /* File descriptor still in use */
3271 invalidate = 1;
3272 }
3273 if (invalidate) {
3274 /* For STD* handles, don't close stdio, since we shared the FILE *, too. */
3275 if (stdio == stdin) /* Some stdios are buggy fflush-ing inputs */
3276 return 0;
3277 if (stdio == stdout || stdio == stderr)
3278 return PerlIO_flush(f);
3279 }
3280 MUTEX_LOCK(&PL_perlio_mutex);
3281 /* Right. We need a mutex here because for a brief while we
3282 will have the situation that fd is actually closed. Hence if
3283 a second thread were to get into this block, its dup() would
3284 likely return our fd as its dupfd. (after all, it is closed)
3285 Then if we get to the dup2() first, we blat the fd back
3286 (messing up its temporary as a side effect) only for it to
3287 then close its dupfd (== our fd) in its close(dupfd) */
3288
3289 /* There is, of course, a race condition, that any other thread
3290 trying to input/output/whatever on this fd will be stuffed
3291 for the duration of this little manoeuvrer. Perhaps we
3292 should hold an IO mutex for the duration of every IO
3293 operation if we know that invalidate doesn't work on this
3294 platform, but that would suck, and could kill performance.
3295
3296 Except that correctness trumps speed.
3297 Advice from klortho #11912. */
3298 if (invalidate) {
3299 /* Tricky - must fclose(stdio) to free memory but not close(fd)
3300 Use Sarathy's trick from maint-5.6 to invalidate the
3301 fileno slot of the FILE *
3302 */
3303 result = PerlIO_flush(f);
3304 SAVE_ERRNO;
3305 invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio);
3306 if (!invalidate) {
3307 dupfd = PerlLIO_dup_cloexec(fd);
3308#ifdef USE_ITHREADS
3309 if (dupfd < 0) {
3310 /* Oh cXap. This isn't going to go well. Not sure if we can
3311 recover from here, or if closing this particular FILE *
3312 is a good idea now. */
3313 }
3314#endif
3315 }
3316 } else {
3317 SAVE_ERRNO; /* This is here only to silence compiler warnings */
3318 }
3319 result = PerlSIO_fclose(stdio);
3320 /* We treat error from stdio as success if we invalidated
3321 errno may NOT be expected EBADF
3322 */
3323 if (invalidate && result != 0) {
3324 RESTORE_ERRNO;
3325 result = 0;
3326 }
3327#ifdef SOCKS5_VERSION_NAME
3328 /* in SOCKS' case, let close() determine return value */
3329 result = close(fd);
3330#endif
3331 if (dupfd >= 0) {
3332 PerlLIO_dup2_cloexec(dupfd, fd);
3333 setfd_inhexec_for_sysfd(fd);
3334 PerlLIO_close(dupfd);
3335 }
3336 MUTEX_UNLOCK(&PL_perlio_mutex);
3337 return result;
3338 }
3339}
3340
3341SSize_t
3342PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3343{
3344 FILE * s;
3345 SSize_t got = 0;
3346 if (PerlIO_lockcnt(f)) /* in use: abort ungracefully */
3347 return -1;
3348 s = PerlIOSelf(f, PerlIOStdio)->stdio;
3349 for (;;) {
3350 if (count == 1) {
3351 STDCHAR *buf = (STDCHAR *) vbuf;
3352 /*
3353 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3354 * stdio does not do that for fread()
3355 */
3356 const int ch = PerlSIO_fgetc(s);
3357 if (ch != EOF) {
3358 *buf = ch;
3359 got = 1;
3360 }
3361 }
3362 else
3363 got = PerlSIO_fread(vbuf, 1, count, s);
3364 if (got == 0 && PerlSIO_ferror(s))
3365 got = -1;
3366 if (got >= 0 || errno != EINTR)
3367 break;
3368 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
3369 return -1;
3370 SETERRNO(0,0); /* just in case */
3371 }
3372#ifdef __sgi
3373 /* Under some circumstances IRIX stdio fgetc() and fread()
3374 * set the errno to ENOENT, which makes no sense according
3375 * to either IRIX or POSIX. [rt.perl.org #123977] */
3376 if (errno == ENOENT) SETERRNO(0,0);
3377#endif
3378 return got;
3379}
3380
3381SSize_t
3382PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3383{
3384 SSize_t unread = 0;
3385 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3386
3387#ifdef STDIO_BUFFER_WRITABLE
3388 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3389 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3390 STDCHAR *base = PerlIO_get_base(f);
3391 SSize_t cnt = PerlIO_get_cnt(f);
3392 STDCHAR *ptr = PerlIO_get_ptr(f);
3393 SSize_t avail = ptr - base;
3394 if (avail > 0) {
3395 if (avail > count) {
3396 avail = count;
3397 }
3398 ptr -= avail;
3399 Move(buf-avail,ptr,avail,STDCHAR);
3400 count -= avail;
3401 unread += avail;
3402 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3403 if (PerlSIO_feof(s) && unread >= 0)
3404 PerlSIO_clearerr(s);
3405 }
3406 }
3407 else
3408#endif
3409 if (PerlIO_has_cntptr(f)) {
3410 /* We can get pointer to buffer but not its base
3411 Do ungetc() but check chars are ending up in the
3412 buffer
3413 */
3414 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3415 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3416 while (count > 0) {
3417 const int ch = *--buf & 0xFF;
3418 if (ungetc(ch,s) != ch) {
3419 /* ungetc did not work */
3420 break;
3421 }
3422 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3423 /* Did not change pointer as expected */
3424 if (fgetc(s) != EOF) /* get char back again */
3425 break;
3426 }
3427 /* It worked ! */
3428 count--;
3429 unread++;
3430 }
3431 }
3432
3433 if (count > 0) {
3434 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3435 }
3436 return unread;
3437}
3438
3439SSize_t
3440PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3441{
3442 SSize_t got;
3443 if (PerlIO_lockcnt(f)) /* in use: abort ungracefully */
3444 return -1;
3445 for (;;) {
3446 got = PerlSIO_fwrite(vbuf, 1, count,
3447 PerlIOSelf(f, PerlIOStdio)->stdio);
3448 if (got >= 0 || errno != EINTR)
3449 break;
3450 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
3451 return -1;
3452 SETERRNO(0,0); /* just in case */
3453 }
3454 return got;
3455}
3456
3457IV
3458PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3459{
3460 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3461 PERL_UNUSED_CONTEXT;
3462
3463 return PerlSIO_fseek(stdio, offset, whence);
3464}
3465
3466Off_t
3467PerlIOStdio_tell(pTHX_ PerlIO *f)
3468{
3469 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3470 PERL_UNUSED_CONTEXT;
3471
3472 return PerlSIO_ftell(stdio);
3473}
3474
3475IV
3476PerlIOStdio_flush(pTHX_ PerlIO *f)
3477{
3478 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3479 PERL_UNUSED_CONTEXT;
3480
3481 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3482 return PerlSIO_fflush(stdio);
3483 }
3484 else {
3485 NOOP;
3486#if 0
3487 /*
3488 * FIXME: This discards ungetc() and pre-read stuff which is not
3489 * right if this is just a "sync" from a layer above Suspect right
3490 * design is to do _this_ but not have layer above flush this
3491 * layer read-to-read
3492 */
3493 /*
3494 * Not writeable - sync by attempting a seek
3495 */
3496 dSAVE_ERRNO;
3497 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3498 RESTORE_ERRNO;
3499#endif
3500 }
3501 return 0;
3502}
3503
3504IV
3505PerlIOStdio_eof(pTHX_ PerlIO *f)
3506{
3507 PERL_UNUSED_CONTEXT;
3508
3509 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3510}
3511
3512IV
3513PerlIOStdio_error(pTHX_ PerlIO *f)
3514{
3515 PERL_UNUSED_CONTEXT;
3516
3517 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3518}
3519
3520void
3521PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3522{
3523 PERL_UNUSED_CONTEXT;
3524
3525 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3526}
3527
3528void
3529PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3530{
3531 PERL_UNUSED_CONTEXT;
3532
3533#ifdef HAS_SETLINEBUF
3534 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3535#else
3536 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, NULL, _IOLBF, 0);
3537#endif
3538}
3539
3540#ifdef FILE_base
3541STDCHAR *
3542PerlIOStdio_get_base(pTHX_ PerlIO *f)
3543{
3544 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3545 PERL_UNUSED_CONTEXT;
3546 return (STDCHAR*)PerlSIO_get_base(stdio);
3547}
3548
3549Size_t
3550PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3551{
3552 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3553 PERL_UNUSED_CONTEXT;
3554 return PerlSIO_get_bufsiz(stdio);
3555}
3556#endif
3557
3558#ifdef USE_STDIO_PTR
3559STDCHAR *
3560PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3561{
3562 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3563 PERL_UNUSED_CONTEXT;
3564 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3565}
3566
3567SSize_t
3568PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3569{
3570 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3571 PERL_UNUSED_CONTEXT;
3572 return PerlSIO_get_cnt(stdio);
3573}
3574
3575void
3576PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3577{
3578 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3579 PERL_UNUSED_CONTEXT;
3580 if (ptr != NULL) {
3581#ifdef STDIO_PTR_LVALUE
3582 /* This is a long-standing infamous mess. The root of the
3583 * problem is that one cannot know the signedness of char, and
3584 * more precisely the signedness of FILE._ptr. The following
3585 * things have been tried, and they have all failed (across
3586 * different compilers (remember that core needs to to build
3587 * also with c++) and compiler options:
3588 *
3589 * - casting the RHS to (void*) -- works in *some* places
3590 * - casting the LHS to (void*) -- totally unportable
3591 *
3592 * So let's try silencing the warning at least for gcc. */
3593 GCC_DIAG_IGNORE_STMT(-Wpointer-sign);
3594 PerlSIO_set_ptr(stdio, ptr); /* LHS STDCHAR* cast non-portable */
3595 GCC_DIAG_RESTORE_STMT;
3596#ifdef STDIO_PTR_LVAL_SETS_CNT
3597 assert(PerlSIO_get_cnt(stdio) == (cnt));
3598#endif
3599#if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3600 /*
3601 * Setting ptr _does_ change cnt - we are done
3602 */
3603 return;
3604#endif
3605#else /* STDIO_PTR_LVALUE */
3606 PerlProc_abort();
3607#endif /* STDIO_PTR_LVALUE */
3608 }
3609 /*
3610 * Now (or only) set cnt
3611 */
3612#ifdef STDIO_CNT_LVALUE
3613 PerlSIO_set_cnt(stdio, cnt);
3614#elif (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3615 PerlSIO_set_ptr(stdio,
3616 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3617 cnt));
3618#else /* STDIO_PTR_LVAL_SETS_CNT */
3619 PerlProc_abort();
3620#endif /* STDIO_CNT_LVALUE */
3621}
3622
3623
3624#endif
3625
3626IV
3627PerlIOStdio_fill(pTHX_ PerlIO *f)
3628{
3629 FILE * stdio;
3630 int c;
3631 PERL_UNUSED_CONTEXT;
3632 if (PerlIO_lockcnt(f)) /* in use: abort ungracefully */
3633 return -1;
3634 stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3635
3636 /*
3637 * fflush()ing read-only streams can cause trouble on some stdio-s
3638 */
3639 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3640 if (PerlSIO_fflush(stdio) != 0)
3641 return EOF;
3642 }
3643 for (;;) {
3644 c = PerlSIO_fgetc(stdio);
3645 if (c != EOF)
3646 break;
3647 if (! PerlSIO_ferror(stdio) || errno != EINTR)
3648 return EOF;
3649 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
3650 return -1;
3651 SETERRNO(0,0);
3652 }
3653
3654#if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3655
3656#ifdef STDIO_BUFFER_WRITABLE
3657 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3658 /* Fake ungetc() to the real buffer in case system's ungetc
3659 goes elsewhere
3660 */
3661 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3662 SSize_t cnt = PerlSIO_get_cnt(stdio);
3663 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3664 if (ptr == base+1) {
3665 *--ptr = (STDCHAR) c;
3666 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3667 if (PerlSIO_feof(stdio))
3668 PerlSIO_clearerr(stdio);
3669 return 0;
3670 }
3671 }
3672 else
3673#endif
3674 if (PerlIO_has_cntptr(f)) {
3675 STDCHAR ch = c;
3676 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3677 return 0;
3678 }
3679 }
3680#endif
3681
3682 /* If buffer snoop scheme above fails fall back to
3683 using ungetc().
3684 */
3685 if (PerlSIO_ungetc(c, stdio) != c)
3686 return EOF;
3687
3688 return 0;
3689}
3690
3691
3692
3693PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3694 sizeof(PerlIO_funcs),
3695 "stdio",
3696 sizeof(PerlIOStdio),
3697 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3698 PerlIOStdio_pushed,
3699 PerlIOBase_popped,
3700 PerlIOStdio_open,
3701 PerlIOBase_binmode, /* binmode */
3702 NULL,
3703 PerlIOStdio_fileno,
3704 PerlIOStdio_dup,
3705 PerlIOStdio_read,
3706 PerlIOStdio_unread,
3707 PerlIOStdio_write,
3708 PerlIOStdio_seek,
3709 PerlIOStdio_tell,
3710 PerlIOStdio_close,
3711 PerlIOStdio_flush,
3712 PerlIOStdio_fill,
3713 PerlIOStdio_eof,
3714 PerlIOStdio_error,
3715 PerlIOStdio_clearerr,
3716 PerlIOStdio_setlinebuf,
3717#ifdef FILE_base
3718 PerlIOStdio_get_base,
3719 PerlIOStdio_get_bufsiz,
3720#else
3721 NULL,
3722 NULL,
3723#endif
3724#ifdef USE_STDIO_PTR
3725 PerlIOStdio_get_ptr,
3726 PerlIOStdio_get_cnt,
3727# if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3728 PerlIOStdio_set_ptrcnt,
3729# else
3730 NULL,
3731# endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3732#else
3733 NULL,
3734 NULL,
3735 NULL,
3736#endif /* USE_STDIO_PTR */
3737};
3738
3739/* Note that calls to PerlIO_exportFILE() are reversed using
3740 * PerlIO_releaseFILE(), not importFILE. */
3741FILE *
3742PerlIO_exportFILE(PerlIO * f, const char *mode)
3743{
3744 dTHX;
3745 FILE *stdio = NULL;
3746 if (PerlIOValid(f)) {
3747 char buf[8];
3748 int fd = PerlIO_fileno(f);
3749 if (fd < 0) {
3750 return NULL;
3751 }
3752 PerlIO_flush(f);
3753 if (!mode || !*mode) {
3754 mode = PerlIO_modestr(f, buf);
3755 }
3756 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3757 if (stdio) {
3758 PerlIOl *l = *f;
3759 PerlIO *f2;
3760 /* De-link any lower layers so new :stdio sticks */
3761 *f = NULL;
3762 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, NULL))) {
3763 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3764 s->stdio = stdio;
3765 PerlIOUnix_refcnt_inc(fileno(stdio));
3766 /* Link previous lower layers under new one */
3767 *PerlIONext(f) = l;
3768 }
3769 else {
3770 /* restore layers list */
3771 *f = l;
3772 }
3773 }
3774 }
3775 return stdio;
3776}
3777
3778
3779FILE *
3780PerlIO_findFILE(PerlIO *f)
3781{
3782 PerlIOl *l = *f;
3783 FILE *stdio;
3784 while (l) {
3785 if (l->tab == &PerlIO_stdio) {
3786 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3787 return s->stdio;
3788 }
3789 l = *PerlIONext(&l);
3790 }
3791 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3792 /* However, we're not really exporting a FILE * to someone else (who
3793 becomes responsible for closing it, or calling PerlIO_releaseFILE())
3794 So we need to undo its reference count increase on the underlying file
3795 descriptor. We have to do this, because if the loop above returns you
3796 the FILE *, then *it* didn't increase any reference count. So there's
3797 only one way to be consistent. */
3798 stdio = PerlIO_exportFILE(f, NULL);
3799 if (stdio) {
3800 const int fd = fileno(stdio);
3801 if (fd >= 0)
3802 PerlIOUnix_refcnt_dec(fd);
3803 }
3804 return stdio;
3805}
3806
3807/* Use this to reverse PerlIO_exportFILE calls. */
3808void
3809PerlIO_releaseFILE(PerlIO *p, FILE *f)
3810{
3811 PerlIOl *l;
3812 while ((l = *p)) {
3813 if (l->tab == &PerlIO_stdio) {
3814 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3815 if (s->stdio == f) { /* not in a loop */
3816 const int fd = fileno(f);
3817 if (fd >= 0)
3818 PerlIOUnix_refcnt_dec(fd);
3819 {
3820 dTHX;
3821 PerlIO_pop(aTHX_ p);
3822 }
3823 return;
3824 }
3825 }
3826 p = PerlIONext(p);
3827 }
3828 return;
3829}
3830
3831/*--------------------------------------------------------------------------------------*/
3832/*
3833 * perlio buffer layer
3834 */
3835
3836IV
3837PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3838{
3839 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3840 const int fd = PerlIO_fileno(f);
3841 if (fd >= 0 && PerlLIO_isatty(fd)) {
3842 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3843 }
3844 if (*PerlIONext(f)) {
3845 const Off_t posn = PerlIO_tell(PerlIONext(f));
3846 if (posn != (Off_t) - 1) {
3847 b->posn = posn;
3848 }
3849 }
3850 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3851}
3852
3853PerlIO *
3854PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3855 IV n, const char *mode, int fd, int imode, int perm,
3856 PerlIO *f, int narg, SV **args)
3857{
3858 if (PerlIOValid(f)) {
3859 PerlIO *next = PerlIONext(f);
3860 PerlIO_funcs *tab =
3861 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3862 if (tab && tab->Open)
3863 next =
3864 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3865 next, narg, args);
3866 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3867 return NULL;
3868 }
3869 }
3870 else {
3871 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3872 int init = 0;
3873 if (*mode == IoTYPE_IMPLICIT) {
3874 init = 1;
3875 /*
3876 * mode++;
3877 */
3878 }
3879 if (tab && tab->Open)
3880 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3881 f, narg, args);
3882 else
3883 SETERRNO(EINVAL, LIB_INVARG);
3884 if (f) {
3885 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3886 /*
3887 * if push fails during open, open fails. close will pop us.
3888 */
3889 PerlIO_close (f);
3890 return NULL;
3891 } else {
3892 fd = PerlIO_fileno(f);
3893 if (init && fd == 2) {
3894 /*
3895 * Initial stderr is unbuffered
3896 */
3897 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3898 }
3899#ifdef PERLIO_USING_CRLF
3900# ifdef PERLIO_IS_BINMODE_FD
3901 if (PERLIO_IS_BINMODE_FD(fd))
3902 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, NULL);
3903 else
3904# endif
3905 /*
3906 * do something about failing setmode()? --jhi
3907 */
3908 PerlLIO_setmode(fd, O_BINARY);
3909#endif
3910#ifdef VMS
3911 /* Enable line buffering with record-oriented regular files
3912 * so we don't introduce an extraneous record boundary when
3913 * the buffer fills up.
3914 */
3915 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3916 Stat_t st;
3917 if (PerlLIO_fstat(fd, &st) == 0
3918 && S_ISREG(st.st_mode)
3919 && (st.st_fab_rfm == FAB$C_VAR
3920 || st.st_fab_rfm == FAB$C_VFC)) {
3921 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
3922 }
3923 }
3924#endif
3925 }
3926 }
3927 }
3928 return f;
3929}
3930
3931/*
3932 * This "flush" is akin to sfio's sync in that it handles files in either
3933 * read or write state. For write state, we put the postponed data through
3934 * the next layers. For read state, we seek() the next layers to the
3935 * offset given by current position in the buffer, and discard the buffer
3936 * state (XXXX supposed to be for seek()able buffers only, but now it is done
3937 * in any case?). Then the pass the stick further in chain.
3938 */
3939IV
3940PerlIOBuf_flush(pTHX_ PerlIO *f)
3941{
3942 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3943 int code = 0;
3944 PerlIO *n = PerlIONext(f);
3945 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3946 /*
3947 * write() the buffer
3948 */
3949 const STDCHAR *buf = b->buf;
3950 const STDCHAR *p = buf;
3951 while (p < b->ptr) {
3952 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3953 if (count > 0) {
3954 p += count;
3955 }
3956 else if (count < 0 || PerlIO_error(n)) {
3957 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3958 PerlIO_save_errno(f);
3959 code = -1;
3960 break;
3961 }
3962 }
3963 b->posn += (p - buf);
3964 }
3965 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3966 STDCHAR *buf = PerlIO_get_base(f);
3967 /*
3968 * Note position change
3969 */
3970 b->posn += (b->ptr - buf);
3971 if (b->ptr < b->end) {
3972 /* We did not consume all of it - try and seek downstream to
3973 our logical position
3974 */
3975 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3976 /* Reload n as some layers may pop themselves on seek */
3977 b->posn = PerlIO_tell(n = PerlIONext(f));
3978 }
3979 else {
3980 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3981 data is lost for good - so return saying "ok" having undone
3982 the position adjust
3983 */
3984 b->posn -= (b->ptr - buf);
3985 return code;
3986 }
3987 }
3988 }
3989 b->ptr = b->end = b->buf;
3990 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3991 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3992 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3993 code = -1;
3994 return code;
3995}
3996
3997/* This discards the content of the buffer after b->ptr, and rereads
3998 * the buffer from the position off in the layer downstream; here off
3999 * is at offset corresponding to b->ptr - b->buf.
4000 */
4001IV
4002PerlIOBuf_fill(pTHX_ PerlIO *f)
4003{
4004 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4005 PerlIO *n = PerlIONext(f);
4006 SSize_t avail;
4007 /*
4008 * Down-stream flush is defined not to loose read data so is harmless.
4009 * we would not normally be fill'ing if there was data left in anycase.
4010 */
4011 if (PerlIO_flush(f) != 0) /* XXXX Check that its seek() succeeded?! */
4012 return -1;
4013 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
4014 PerlIOBase_flush_linebuf(aTHX);
4015
4016 if (!b->buf)
4017 PerlIO_get_base(f); /* allocate via vtable */
4018
4019 assert(b->buf); /* The b->buf does get allocated via the vtable system. */
4020
4021 b->ptr = b->end = b->buf;
4022
4023 if (!PerlIOValid(n)) {
4024 PerlIOBase(f)->flags |= PERLIO_F_EOF;
4025 return -1;
4026 }
4027
4028 if (PerlIO_fast_gets(n)) {
4029 /*
4030 * Layer below is also buffered. We do _NOT_ want to call its
4031 * ->Read() because that will loop till it gets what we asked for
4032 * which may hang on a pipe etc. Instead take anything it has to
4033 * hand, or ask it to fill _once_.
4034 */
4035 avail = PerlIO_get_cnt(n);
4036 if (avail <= 0) {
4037 avail = PerlIO_fill(n);
4038 if (avail == 0)
4039 avail = PerlIO_get_cnt(n);
4040 else {
4041 if (!PerlIO_error(n) && PerlIO_eof(n))
4042 avail = 0;
4043 }
4044 }
4045 if (avail > 0) {
4046 STDCHAR *ptr = PerlIO_get_ptr(n);
4047 const SSize_t cnt = avail;
4048 if (avail > (SSize_t)b->bufsiz)
4049 avail = b->bufsiz;
4050 Copy(ptr, b->buf, avail, STDCHAR);
4051 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
4052 }
4053 }
4054 else {
4055 avail = PerlIO_read(n, b->ptr, b->bufsiz);
4056 }
4057 if (avail <= 0) {
4058 if (avail == 0)
4059 PerlIOBase(f)->flags |= PERLIO_F_EOF;
4060 else
4061 {
4062 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
4063 PerlIO_save_errno(f);
4064 }
4065 return -1;
4066 }
4067 b->end = b->buf + avail;
4068 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4069 return 0;
4070}
4071
4072SSize_t
4073PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4074{
4075 if (PerlIOValid(f)) {
4076 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4077 if (!b->ptr)
4078 PerlIO_get_base(f);
4079 return PerlIOBase_read(aTHX_ f, vbuf, count);
4080 }
4081 return 0;
4082}
4083
4084SSize_t
4085PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4086{
4087 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4088 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4089 SSize_t unread = 0;
4090 SSize_t avail;
4091 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4092 PerlIO_flush(f);
4093 if (!b->buf)
4094 PerlIO_get_base(f);
4095 if (b->buf) {
4096 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4097 /*
4098 * Buffer is already a read buffer, we can overwrite any chars
4099 * which have been read back to buffer start
4100 */
4101 avail = (b->ptr - b->buf);
4102 }
4103 else {
4104 /*
4105 * Buffer is idle, set it up so whole buffer is available for
4106 * unread
4107 */
4108 avail = b->bufsiz;
4109 b->end = b->buf + avail;
4110 b->ptr = b->end;
4111 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4112 /*
4113 * Buffer extends _back_ from where we are now
4114 */
4115 b->posn -= b->bufsiz;
4116 }
4117 if ((SSize_t) count >= 0 && avail > (SSize_t) count) {
4118 /*
4119 * If we have space for more than count, just move count
4120 */
4121 avail = count;
4122 }
4123 if (avail > 0) {
4124 b->ptr -= avail;
4125 buf -= avail;
4126 /*
4127 * In simple stdio-like ungetc() case chars will be already
4128 * there
4129 */
4130 if (buf != b->ptr) {
4131 Copy(buf, b->ptr, avail, STDCHAR);
4132 }
4133 count -= avail;
4134 unread += avail;
4135 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4136 }
4137 }
4138 if (count > 0) {
4139 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
4140 }
4141 return unread;
4142}
4143
4144SSize_t
4145PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4146{
4147 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4148 const STDCHAR *buf = (const STDCHAR *) vbuf;
4149 const STDCHAR *flushptr = buf;
4150 Size_t written = 0;
4151 if (!b->buf)
4152 PerlIO_get_base(f);
4153 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4154 return 0;
4155 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4156 if (PerlIO_flush(f) != 0) {
4157 return 0;
4158 }
4159 }
4160 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4161 flushptr = buf + count;
4162 while (flushptr > buf && *(flushptr - 1) != '\n')
4163 --flushptr;
4164 }
4165 while (count > 0) {
4166 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
4167 if ((SSize_t) count >= 0 && (SSize_t) count < avail)
4168 avail = count;
4169 if (flushptr > buf && flushptr <= buf + avail)
4170 avail = flushptr - buf;
4171 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4172 if (avail) {
4173 Copy(buf, b->ptr, avail, STDCHAR);
4174 count -= avail;
4175 buf += avail;
4176 written += avail;
4177 b->ptr += avail;
4178 if (buf == flushptr)
4179 PerlIO_flush(f);
4180 }
4181 if (b->ptr >= (b->buf + b->bufsiz))
4182 if (PerlIO_flush(f) == -1)
4183 return -1;
4184 }
4185 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4186 PerlIO_flush(f);
4187 return written;
4188}
4189
4190IV
4191PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4192{
4193 IV code;
4194 if ((code = PerlIO_flush(f)) == 0) {
4195 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4196 code = PerlIO_seek(PerlIONext(f), offset, whence);
4197 if (code == 0) {
4198 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4199 b->posn = PerlIO_tell(PerlIONext(f));
4200 }
4201 }
4202 return code;
4203}
4204
4205Off_t
4206PerlIOBuf_tell(pTHX_ PerlIO *f)
4207{
4208 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4209 /*
4210 * b->posn is file position where b->buf was read, or will be written
4211 */
4212 Off_t posn = b->posn;
4213 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
4214 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4215#if 1
4216 /* As O_APPEND files are normally shared in some sense it is better
4217 to flush :
4218 */
4219 PerlIO_flush(f);
4220#else
4221 /* when file is NOT shared then this is sufficient */
4222 PerlIO_seek(PerlIONext(f),0, SEEK_END);
4223#endif
4224 posn = b->posn = PerlIO_tell(PerlIONext(f));
4225 }
4226 if (b->buf) {
4227 /*
4228 * If buffer is valid adjust position by amount in buffer
4229 */
4230 posn += (b->ptr - b->buf);
4231 }
4232 return posn;
4233}
4234
4235IV
4236PerlIOBuf_popped(pTHX_ PerlIO *f)
4237{
4238 const IV code = PerlIOBase_popped(aTHX_ f);
4239 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4240 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4241 Safefree(b->buf);
4242 }
4243 b->ptr = b->end = b->buf = NULL;
4244 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4245 return code;
4246}
4247
4248IV
4249PerlIOBuf_close(pTHX_ PerlIO *f)
4250{
4251 const IV code = PerlIOBase_close(aTHX_ f);
4252 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4253 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4254 Safefree(b->buf);
4255 }
4256 b->ptr = b->end = b->buf = NULL;
4257 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4258 return code;
4259}
4260
4261STDCHAR *
4262PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
4263{
4264 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4265 if (!b->buf)
4266 PerlIO_get_base(f);
4267 return b->ptr;
4268}
4269
4270SSize_t
4271PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
4272{
4273 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4274 if (!b->buf)
4275 PerlIO_get_base(f);
4276 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
4277 return (b->end - b->ptr);
4278 return 0;
4279}
4280
4281STDCHAR *
4282PerlIOBuf_get_base(pTHX_ PerlIO *f)
4283{
4284 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4285 PERL_UNUSED_CONTEXT;
4286
4287 if (!b->buf) {
4288 if (!b->bufsiz)
4289 b->bufsiz = PERLIOBUF_DEFAULT_BUFSIZ;
4290 Newx(b->buf,b->bufsiz, STDCHAR);
4291 if (!b->buf) {
4292 b->buf = (STDCHAR *) & b->oneword;
4293 b->bufsiz = sizeof(b->oneword);
4294 }
4295 b->end = b->ptr = b->buf;
4296 }
4297 return b->buf;
4298}
4299
4300Size_t
4301PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
4302{
4303 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4304 if (!b->buf)
4305 PerlIO_get_base(f);
4306 return (b->end - b->buf);
4307}
4308
4309void
4310PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4311{
4312 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4313#ifndef DEBUGGING
4314 PERL_UNUSED_ARG(cnt);
4315#endif
4316 if (!b->buf)
4317 PerlIO_get_base(f);
4318 b->ptr = ptr;
4319 assert(PerlIO_get_cnt(f) == cnt);
4320 assert(b->ptr >= b->buf);
4321 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4322}
4323
4324PerlIO *
4325PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4326{
4327 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4328}
4329
4330
4331
4332PERLIO_FUNCS_DECL(PerlIO_perlio) = {
4333 sizeof(PerlIO_funcs),
4334 "perlio",
4335 sizeof(PerlIOBuf),
4336 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4337 PerlIOBuf_pushed,
4338 PerlIOBuf_popped,
4339 PerlIOBuf_open,
4340 PerlIOBase_binmode, /* binmode */
4341 NULL,
4342 PerlIOBase_fileno,
4343 PerlIOBuf_dup,
4344 PerlIOBuf_read,
4345 PerlIOBuf_unread,
4346 PerlIOBuf_write,
4347 PerlIOBuf_seek,
4348 PerlIOBuf_tell,
4349 PerlIOBuf_close,
4350 PerlIOBuf_flush,
4351 PerlIOBuf_fill,
4352 PerlIOBase_eof,
4353 PerlIOBase_error,
4354 PerlIOBase_clearerr,
4355 PerlIOBase_setlinebuf,
4356 PerlIOBuf_get_base,
4357 PerlIOBuf_bufsiz,
4358 PerlIOBuf_get_ptr,
4359 PerlIOBuf_get_cnt,
4360 PerlIOBuf_set_ptrcnt,
4361};
4362
4363/*--------------------------------------------------------------------------------------*/
4364/*
4365 * Temp layer to hold unread chars when cannot do it any other way
4366 */
4367
4368IV
4369PerlIOPending_fill(pTHX_ PerlIO *f)
4370{
4371 /*
4372 * Should never happen
4373 */
4374 PerlIO_flush(f);
4375 return 0;
4376}
4377
4378IV
4379PerlIOPending_close(pTHX_ PerlIO *f)
4380{
4381 /*
4382 * A tad tricky - flush pops us, then we close new top
4383 */
4384 PerlIO_flush(f);
4385 return PerlIO_close(f);
4386}
4387
4388IV
4389PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4390{
4391 /*
4392 * A tad tricky - flush pops us, then we seek new top
4393 */
4394 PerlIO_flush(f);
4395 return PerlIO_seek(f, offset, whence);
4396}
4397
4398
4399IV
4400PerlIOPending_flush(pTHX_ PerlIO *f)
4401{
4402 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4403 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4404 Safefree(b->buf);
4405 b->buf = NULL;
4406 }
4407 PerlIO_pop(aTHX_ f);
4408 return 0;
4409}
4410
4411void
4412PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4413{
4414 if (cnt <= 0) {
4415 PerlIO_flush(f);
4416 }
4417 else {
4418 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4419 }
4420}
4421
4422IV
4423PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4424{
4425 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4426 PerlIOl * const l = PerlIOBase(f);
4427 /*
4428 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4429 * etc. get muddled when it changes mid-string when we auto-pop.
4430 */
4431 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4432 (PerlIOBase(PerlIONext(f))->
4433 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4434 return code;
4435}
4436
4437SSize_t
4438PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4439{
4440 SSize_t avail = PerlIO_get_cnt(f);
4441 SSize_t got = 0;
4442 if ((SSize_t) count >= 0 && (SSize_t)count < avail)
4443 avail = count;
4444 if (avail > 0)
4445 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4446 if (got >= 0 && got < (SSize_t)count) {
4447 const SSize_t more =
4448 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4449 if (more >= 0 || got == 0)
4450 got += more;
4451 }
4452 return got;
4453}
4454
4455PERLIO_FUNCS_DECL(PerlIO_pending) = {
4456 sizeof(PerlIO_funcs),
4457 "pending",
4458 sizeof(PerlIOBuf),
4459 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4460 PerlIOPending_pushed,
4461 PerlIOBuf_popped,
4462 NULL,
4463 PerlIOBase_binmode, /* binmode */
4464 NULL,
4465 PerlIOBase_fileno,
4466 PerlIOBuf_dup,
4467 PerlIOPending_read,
4468 PerlIOBuf_unread,
4469 PerlIOBuf_write,
4470 PerlIOPending_seek,
4471 PerlIOBuf_tell,
4472 PerlIOPending_close,
4473 PerlIOPending_flush,
4474 PerlIOPending_fill,
4475 PerlIOBase_eof,
4476 PerlIOBase_error,
4477 PerlIOBase_clearerr,
4478 PerlIOBase_setlinebuf,
4479 PerlIOBuf_get_base,
4480 PerlIOBuf_bufsiz,
4481 PerlIOBuf_get_ptr,
4482 PerlIOBuf_get_cnt,
4483 PerlIOPending_set_ptrcnt,
4484};
4485
4486
4487
4488/*--------------------------------------------------------------------------------------*/
4489/*
4490 * crlf - translation On read translate CR,LF to "\n" we do this by
4491 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4492 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4493 *
4494 * c->nl points on the first byte of CR LF pair when it is temporarily
4495 * replaced by LF, or to the last CR of the buffer. In the former case
4496 * the caller thinks that the buffer ends at c->nl + 1, in the latter
4497 * that it ends at c->nl; these two cases can be distinguished by
4498 * *c->nl. c->nl is set during _getcnt() call, and unset during
4499 * _unread() and _flush() calls.
4500 * It only matters for read operations.
4501 */
4502
4503typedef struct {
4504 PerlIOBuf base; /* PerlIOBuf stuff */
4505 STDCHAR *nl; /* Position of crlf we "lied" about in the
4506 * buffer */
4507} PerlIOCrlf;
4508
4509/* Inherit the PERLIO_F_UTF8 flag from previous layer.
4510 * Otherwise the :crlf layer would always revert back to
4511 * raw mode.
4512 */
4513static void
4514S_inherit_utf8_flag(PerlIO *f)
4515{
4516 PerlIO *g = PerlIONext(f);
4517 if (PerlIOValid(g)) {
4518 if (PerlIOBase(g)->flags & PERLIO_F_UTF8) {
4519 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
4520 }
4521 }
4522}
4523
4524IV
4525PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4526{
4527 IV code;
4528 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4529 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4530#if 0
4531 DEBUG_i(
4532 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4533 (void*)f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4534 PerlIOBase(f)->flags);
4535 );
4536#endif
4537 {
4538 /* If the old top layer is a CRLF layer, reactivate it (if
4539 * necessary) and remove this new layer from the stack */
4540 PerlIO *g = PerlIONext(f);
4541 if (PerlIOValid(g)) {
4542 PerlIOl *b = PerlIOBase(g);
4543 if (b && b->tab == &PerlIO_crlf) {
4544 if (!(b->flags & PERLIO_F_CRLF))
4545 b->flags |= PERLIO_F_CRLF;
4546 S_inherit_utf8_flag(g);
4547 PerlIO_pop(aTHX_ f);
4548 return code;
4549 }
4550 }
4551 }
4552 S_inherit_utf8_flag(f);
4553 return code;
4554}
4555
4556
4557SSize_t
4558PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4559{
4560 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4561 if (c->nl) { /* XXXX Shouldn't it be done only if b->ptr > c->nl? */
4562 *(c->nl) = NATIVE_0xd;
4563 c->nl = NULL;
4564 }
4565 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4566 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4567 else {
4568 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4569 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4570 SSize_t unread = 0;
4571 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4572 PerlIO_flush(f);
4573 if (!b->buf)
4574 PerlIO_get_base(f);
4575 if (b->buf) {
4576 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4577 b->end = b->ptr = b->buf + b->bufsiz;
4578 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4579 b->posn -= b->bufsiz;
4580 }
4581 while (count > 0 && b->ptr > b->buf) {
4582 const int ch = *--buf;
4583 if (ch == '\n') {
4584 if (b->ptr - 2 >= b->buf) {
4585 *--(b->ptr) = NATIVE_0xa;
4586 *--(b->ptr) = NATIVE_0xd;
4587 unread++;
4588 count--;
4589 }
4590 else {
4591 /* If b->ptr - 1 == b->buf, we are undoing reading 0xa */
4592 *--(b->ptr) = NATIVE_0xa; /* Works even if 0xa ==
4593 '\r' */
4594 unread++;
4595 count--;
4596 }
4597 }
4598 else {
4599 *--(b->ptr) = ch;
4600 unread++;
4601 count--;
4602 }
4603 }
4604 }
4605 if (count > 0)
4606 unread += PerlIOBase_unread(aTHX_ f, (const STDCHAR *) vbuf + unread, count);
4607 return unread;
4608 }
4609}
4610
4611/* XXXX This code assumes that buffer size >=2, but does not check it... */
4612SSize_t
4613PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4614{
4615 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4616 if (!b->buf)
4617 PerlIO_get_base(f);
4618 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4619 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4620 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == NATIVE_0xd)) {
4621 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4622 scan:
4623 while (nl < b->end && *nl != NATIVE_0xd)
4624 nl++;
4625 if (nl < b->end && *nl == NATIVE_0xd) {
4626 test:
4627 if (nl + 1 < b->end) {
4628 if (nl[1] == NATIVE_0xa) {
4629 *nl = '\n';
4630 c->nl = nl;
4631 }
4632 else {
4633 /*
4634 * Not CR,LF but just CR
4635 */
4636 nl++;
4637 goto scan;
4638 }
4639 }
4640 else {
4641 /*
4642 * Blast - found CR as last char in buffer
4643 */
4644
4645 if (b->ptr < nl) {
4646 /*
4647 * They may not care, defer work as long as
4648 * possible
4649 */
4650 c->nl = nl;
4651 return (nl - b->ptr);
4652 }
4653 else {
4654 int code;
4655 b->ptr++; /* say we have read it as far as
4656 * flush() is concerned */
4657 b->buf++; /* Leave space in front of buffer */
4658 /* Note as we have moved buf up flush's
4659 posn += ptr-buf
4660 will naturally make posn point at CR
4661 */
4662 b->bufsiz--; /* Buffer is thus smaller */
4663 code = PerlIO_fill(f); /* Fetch some more */
4664 b->bufsiz++; /* Restore size for next time */
4665 b->buf--; /* Point at space */
4666 b->ptr = nl = b->buf; /* Which is what we hand
4667 * off */
4668 *nl = NATIVE_0xd; /* Fill in the CR */
4669 if (code == 0)
4670 goto test; /* fill() call worked */
4671 /*
4672 * CR at EOF - just fall through
4673 */
4674 /* Should we clear EOF though ??? */
4675 }
4676 }
4677 }
4678 }
4679 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4680 }
4681 return 0;
4682}
4683
4684void
4685PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4686{
4687 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4688 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4689 if (!b->buf)
4690 PerlIO_get_base(f);
4691 if (!ptr) {
4692 if (c->nl) {
4693 ptr = c->nl + 1;
4694 if (ptr == b->end && *c->nl == NATIVE_0xd) {
4695 /* Deferred CR at end of buffer case - we lied about count */
4696 ptr--;
4697 }
4698 }
4699 else {
4700 ptr = b->end;
4701 }
4702 ptr -= cnt;
4703 }
4704 else {
4705 NOOP;
4706#if 0
4707 /*
4708 * Test code - delete when it works ...
4709 */
4710 IV flags = PerlIOBase(f)->flags;
4711 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4712 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == NATIVE_0xd) {
4713 /* Deferred CR at end of buffer case - we lied about count */
4714 chk--;
4715 }
4716 chk -= cnt;
4717
4718 if (ptr != chk ) {
4719 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4720 " nl=%p e=%p for %d", (void*)ptr, (void*)chk,
4721 flags, c->nl, b->end, cnt);
4722 }
4723#endif
4724 }
4725 if (c->nl) {
4726 if (ptr > c->nl) {
4727 /*
4728 * They have taken what we lied about
4729 */
4730 *(c->nl) = NATIVE_0xd;
4731 c->nl = NULL;
4732 ptr++;
4733 }
4734 }
4735 b->ptr = ptr;
4736 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4737}
4738
4739SSize_t
4740PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4741{
4742 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4743 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4744 else {
4745 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4746 const STDCHAR *buf = (const STDCHAR *) vbuf;
4747 const STDCHAR * const ebuf = buf + count;
4748 if (!b->buf)
4749 PerlIO_get_base(f);
4750 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4751 return 0;
4752 while (buf < ebuf) {
4753 const STDCHAR * const eptr = b->buf + b->bufsiz;
4754 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4755 while (buf < ebuf && b->ptr < eptr) {
4756 if (*buf == '\n') {
4757 if ((b->ptr + 2) > eptr) {
4758 /*
4759 * Not room for both
4760 */
4761 PerlIO_flush(f);
4762 break;
4763 }
4764 else {
4765 *(b->ptr)++ = NATIVE_0xd; /* CR */
4766 *(b->ptr)++ = NATIVE_0xa; /* LF */
4767 buf++;
4768 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4769 PerlIO_flush(f);
4770 break;
4771 }
4772 }
4773 }
4774 else {
4775 *(b->ptr)++ = *buf++;
4776 }
4777 if (b->ptr >= eptr) {
4778 PerlIO_flush(f);
4779 break;
4780 }
4781 }
4782 }
4783 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4784 PerlIO_flush(f);
4785 return (buf - (STDCHAR *) vbuf);
4786 }
4787}
4788
4789IV
4790PerlIOCrlf_flush(pTHX_ PerlIO *f)
4791{
4792 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4793 if (c->nl) {
4794 *(c->nl) = NATIVE_0xd;
4795 c->nl = NULL;
4796 }
4797 return PerlIOBuf_flush(aTHX_ f);
4798}
4799
4800IV
4801PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4802{
4803 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4804 /* In text mode - flush any pending stuff and flip it */
4805 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4806#ifndef PERLIO_USING_CRLF
4807 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4808 PerlIO_pop(aTHX_ f);
4809#endif
4810 }
4811 return PerlIOBase_binmode(aTHX_ f);
4812}
4813
4814PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4815 sizeof(PerlIO_funcs),
4816 "crlf",
4817 sizeof(PerlIOCrlf),
4818 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4819 PerlIOCrlf_pushed,
4820 PerlIOBuf_popped, /* popped */
4821 PerlIOBuf_open,
4822 PerlIOCrlf_binmode, /* binmode */
4823 NULL,
4824 PerlIOBase_fileno,
4825 PerlIOBuf_dup,
4826 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4827 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4828 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4829 PerlIOBuf_seek,
4830 PerlIOBuf_tell,
4831 PerlIOBuf_close,
4832 PerlIOCrlf_flush,
4833 PerlIOBuf_fill,
4834 PerlIOBase_eof,
4835 PerlIOBase_error,
4836 PerlIOBase_clearerr,
4837 PerlIOBase_setlinebuf,
4838 PerlIOBuf_get_base,
4839 PerlIOBuf_bufsiz,
4840 PerlIOBuf_get_ptr,
4841 PerlIOCrlf_get_cnt,
4842 PerlIOCrlf_set_ptrcnt,
4843};
4844
4845PerlIO *
4846Perl_PerlIO_stdin(pTHX)
4847{
4848 if (!PL_perlio) {
4849 PerlIO_stdstreams(aTHX);
4850 }
4851 return (PerlIO*)&PL_perlio[1];
4852}
4853
4854PerlIO *
4855Perl_PerlIO_stdout(pTHX)
4856{
4857 if (!PL_perlio) {
4858 PerlIO_stdstreams(aTHX);
4859 }
4860 return (PerlIO*)&PL_perlio[2];
4861}
4862
4863PerlIO *
4864Perl_PerlIO_stderr(pTHX)
4865{
4866 if (!PL_perlio) {
4867 PerlIO_stdstreams(aTHX);
4868 }
4869 return (PerlIO*)&PL_perlio[3];
4870}
4871
4872/*--------------------------------------------------------------------------------------*/
4873
4874char *
4875PerlIO_getname(PerlIO *f, char *buf)
4876{
4877#ifdef VMS
4878 dTHX;
4879 char *name = NULL;
4880 bool exported = FALSE;
4881 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4882 if (!stdio) {
4883 stdio = PerlIO_exportFILE(f,0);
4884 exported = TRUE;
4885 }
4886 if (stdio) {
4887 name = fgetname(stdio, buf);
4888 if (exported) PerlIO_releaseFILE(f,stdio);
4889 }
4890 return name;
4891#else
4892 PERL_UNUSED_ARG(f);
4893 PERL_UNUSED_ARG(buf);
4894 Perl_croak_nocontext("Don't know how to get file name");
4895 return NULL;
4896#endif
4897}
4898
4899
4900/*--------------------------------------------------------------------------------------*/
4901/*
4902 * Functions which can be called on any kind of PerlIO implemented in
4903 * terms of above
4904 */
4905
4906#undef PerlIO_fdopen
4907PerlIO *
4908PerlIO_fdopen(int fd, const char *mode)
4909{
4910 dTHX;
4911 return PerlIO_openn(aTHX_ NULL, mode, fd, 0, 0, NULL, 0, NULL);
4912}
4913
4914#undef PerlIO_open
4915PerlIO *
4916PerlIO_open(const char *path, const char *mode)
4917{
4918 dTHX;
4919 SV *name = sv_2mortal(newSVpv(path, 0));
4920 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, NULL, 1, &name);
4921}
4922
4923#undef Perlio_reopen
4924PerlIO *
4925PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4926{
4927 dTHX;
4928 SV *name = sv_2mortal(newSVpv(path,0));
4929 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, f, 1, &name);
4930}
4931
4932#undef PerlIO_getc
4933int
4934PerlIO_getc(PerlIO *f)
4935{
4936 dTHX;
4937 STDCHAR buf[1];
4938 if ( 1 == PerlIO_read(f, buf, 1) ) {
4939 return (unsigned char) buf[0];
4940 }
4941 return EOF;
4942}
4943
4944#undef PerlIO_ungetc
4945int
4946PerlIO_ungetc(PerlIO *f, int ch)
4947{
4948 dTHX;
4949 if (ch != EOF) {
4950 STDCHAR buf = ch;
4951 if (PerlIO_unread(f, &buf, 1) == 1)
4952 return ch;
4953 }
4954 return EOF;
4955}
4956
4957#undef PerlIO_putc
4958int
4959PerlIO_putc(PerlIO *f, int ch)
4960{
4961 dTHX;
4962 STDCHAR buf = ch;
4963 return PerlIO_write(f, &buf, 1);
4964}
4965
4966#undef PerlIO_puts
4967int
4968PerlIO_puts(PerlIO *f, const char *s)
4969{
4970 dTHX;
4971 return PerlIO_write(f, s, strlen(s));
4972}
4973
4974#undef PerlIO_rewind
4975void
4976PerlIO_rewind(PerlIO *f)
4977{
4978 dTHX;
4979 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4980 PerlIO_clearerr(f);
4981}
4982
4983#undef PerlIO_vprintf
4984int
4985PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4986{
4987 dTHX;
4988 SV * sv;
4989 const char *s;
4990 STRLEN len;
4991 SSize_t wrote;
4992#ifdef NEED_VA_COPY
4993 va_list apc;
4994 Perl_va_copy(ap, apc);
4995 sv = vnewSVpvf(fmt, &apc);
4996 va_end(apc);
4997#else
4998 sv = vnewSVpvf(fmt, &ap);
4999#endif
5000 s = SvPV_const(sv, len);
5001 wrote = PerlIO_write(f, s, len);
5002 SvREFCNT_dec(sv);
5003 return wrote;
5004}
5005
5006#undef PerlIO_printf
5007int
5008PerlIO_printf(PerlIO *f, const char *fmt, ...)
5009{
5010 va_list ap;
5011 int result;
5012 va_start(ap, fmt);
5013 result = PerlIO_vprintf(f, fmt, ap);
5014 va_end(ap);
5015 return result;
5016}
5017
5018#undef PerlIO_stdoutf
5019int
5020PerlIO_stdoutf(const char *fmt, ...)
5021{
5022 dTHX;
5023 va_list ap;
5024 int result;
5025 va_start(ap, fmt);
5026 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
5027 va_end(ap);
5028 return result;
5029}
5030
5031#undef PerlIO_tmpfile
5032PerlIO *
5033PerlIO_tmpfile(void)
5034{
5035 return PerlIO_tmpfile_flags(0);
5036}
5037
5038#define MKOSTEMP_MODES ( O_RDWR | O_CREAT | O_EXCL )
5039#define MKOSTEMP_MODE_MASK ( O_ACCMODE | O_CREAT | O_EXCL | O_TRUNC )
5040
5041PerlIO *
5042PerlIO_tmpfile_flags(int imode)
5043{
5044#ifndef WIN32
5045 dTHX;
5046#endif
5047 PerlIO *f = NULL;
5048#ifdef WIN32
5049 const int fd = win32_tmpfd_mode(imode);
5050 if (fd >= 0)
5051 f = PerlIO_fdopen(fd, "w+b");
5052#elif ! defined(OS2)
5053 int fd = -1;
5054 char tempname[] = "/tmp/PerlIO_XXXXXX";
5055 const char * const tmpdir = TAINTING_get ? NULL : PerlEnv_getenv("TMPDIR");
5056 SV * sv = NULL;
5057 int old_umask = umask(0177);
5058 imode &= ~MKOSTEMP_MODE_MASK;
5059 if (tmpdir && *tmpdir) {
5060 /* if TMPDIR is set and not empty, we try that first */
5061 sv = newSVpv(tmpdir, 0);
5062 sv_catpv(sv, tempname + 4);
5063 fd = Perl_my_mkostemp_cloexec(SvPVX(sv), imode | O_VMS_DELETEONCLOSE);
5064 }
5065 if (fd < 0) {
5066 SvREFCNT_dec(sv);
5067 sv = NULL;
5068 /* else we try /tmp */
5069 fd = Perl_my_mkostemp_cloexec(tempname, imode | O_VMS_DELETEONCLOSE);
5070 }
5071 if (fd < 0) {
5072 /* Try cwd */
5073 sv = newSVpvs(".");
5074 sv_catpv(sv, tempname + 4);
5075 fd = Perl_my_mkostemp_cloexec(SvPVX(sv), imode | O_VMS_DELETEONCLOSE);
5076 }
5077 umask(old_umask);
5078 if (fd >= 0) {
5079 /* fdopen() with a numeric mode */
5080 char mode[8];
5081 int writing = 1;
5082 (void)PerlIO_intmode2str(imode | MKOSTEMP_MODES, mode, &writing);
5083 f = PerlIO_fdopen(fd, mode);
5084 if (f)
5085 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
5086# ifndef VMS
5087 PerlLIO_unlink(sv ? SvPVX_const(sv) : tempname);
5088# endif
5089 }
5090 SvREFCNT_dec(sv);
5091#else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
5092 FILE * const stdio = PerlSIO_tmpfile();
5093
5094 if (stdio)
5095 f = PerlIO_fdopen(fileno(stdio), "w+");
5096
5097#endif /* else WIN32 */
5098 return f;
5099}
5100
5101void
5102Perl_PerlIO_save_errno(pTHX_ PerlIO *f)
5103{
5104 PERL_UNUSED_CONTEXT;
5105 if (!PerlIOValid(f))
5106 return;
5107 PerlIOBase(f)->err = errno;
5108#ifdef VMS
5109 PerlIOBase(f)->os_err = vaxc$errno;
5110#elif defined(OS2)
5111 PerlIOBase(f)->os_err = Perl_rc;
5112#elif defined(WIN32)
5113 PerlIOBase(f)->os_err = GetLastError();
5114#endif
5115}
5116
5117void
5118Perl_PerlIO_restore_errno(pTHX_ PerlIO *f)
5119{
5120 PERL_UNUSED_CONTEXT;
5121 if (!PerlIOValid(f))
5122 return;
5123 SETERRNO(PerlIOBase(f)->err, PerlIOBase(f)->os_err);
5124#ifdef OS2
5125 Perl_rc = PerlIOBase(f)->os_err);
5126#elif defined(WIN32)
5127 SetLastError(PerlIOBase(f)->os_err);
5128#endif
5129}
5130
5131#undef HAS_FSETPOS
5132#undef HAS_FGETPOS
5133
5134
5135/*======================================================================================*/
5136/*
5137 * Now some functions in terms of above which may be needed even if we are
5138 * not in true PerlIO mode
5139 */
5140const char *
5141Perl_PerlIO_context_layers(pTHX_ const char *mode)
5142{
5143 const char *direction = NULL;
5144 SV *layers;
5145 /*
5146 * Need to supply default layer info from open.pm
5147 */
5148
5149 if (!PL_curcop)
5150 return NULL;
5151
5152 if (mode && mode[0] != 'r') {
5153 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_OUT)
5154 direction = "open>";
5155 } else {
5156 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_IN)
5157 direction = "open<";
5158 }
5159 if (!direction)
5160 return NULL;
5161
5162 layers = cop_hints_fetch_pvn(PL_curcop, direction, 5, 0, 0);
5163
5164 assert(layers);
5165 return SvOK(layers) ? SvPV_nolen_const(layers) : NULL;
5166}
5167
5168
5169#ifndef HAS_FSETPOS
5170#undef PerlIO_setpos
5171int
5172PerlIO_setpos(PerlIO *f, SV *pos)
5173{
5174 if (SvOK(pos)) {
5175 if (f) {
5176 dTHX;
5177 STRLEN len;
5178 const Off_t * const posn = (Off_t *) SvPV(pos, len);
5179 if(len == sizeof(Off_t))
5180 return PerlIO_seek(f, *posn, SEEK_SET);
5181 }
5182 }
5183 SETERRNO(EINVAL, SS_IVCHAN);
5184 return -1;
5185}
5186#else
5187#undef PerlIO_setpos
5188int
5189PerlIO_setpos(PerlIO *f, SV *pos)
5190{
5191 if (SvOK(pos)) {
5192 if (f) {
5193 dTHX;
5194 STRLEN len;
5195 Fpos_t * const fpos = (Fpos_t *) SvPV(pos, len);
5196 if(len == sizeof(Fpos_t))
5197#if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5198 return fsetpos64(f, fpos);
5199#else
5200 return fsetpos(f, fpos);
5201#endif
5202 }
5203 }
5204 SETERRNO(EINVAL, SS_IVCHAN);
5205 return -1;
5206}
5207#endif
5208
5209#ifndef HAS_FGETPOS
5210#undef PerlIO_getpos
5211int
5212PerlIO_getpos(PerlIO *f, SV *pos)
5213{
5214 dTHX;
5215 Off_t posn = PerlIO_tell(f);
5216 sv_setpvn(pos, (char *) &posn, sizeof(posn));
5217 return (posn == (Off_t) - 1) ? -1 : 0;
5218}
5219#else
5220#undef PerlIO_getpos
5221int
5222PerlIO_getpos(PerlIO *f, SV *pos)
5223{
5224 dTHX;
5225 Fpos_t fpos;
5226 int code;
5227#if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5228 code = fgetpos64(f, &fpos);
5229#else
5230 code = fgetpos(f, &fpos);
5231#endif
5232 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5233 return code;
5234}
5235#endif
5236
5237/* print a failure format string message to stderr and fail exit the process
5238 using only libc without depending on any perl data structures being
5239 initialized.
5240*/
5241
5242void
5243Perl_noperl_die(const char* pat, ...)
5244{
5245 va_list arglist;
5246 PERL_ARGS_ASSERT_NOPERL_DIE;
5247 va_start(arglist, pat);
5248 vfprintf(stderr, pat, arglist);
5249 va_end(arglist);
5250 exit(1);
5251}
5252
5253/*
5254 * ex: set ts=8 sts=4 sw=4 et:
5255 */