3 * Copyright (c) 1996-2000, Nick Ing-Simmons
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
17 #define PERLIO_NOT_STDIO 0
18 #if !defined(PERLIO_IS_STDIO) && !defined(USE_SFIO)
19 /* #define PerlIO FILE */
22 * This file provides those parts of PerlIO abstraction
23 * which are not #defined in iperlsys.h.
24 * Which these are depends on various Configure #ifdef's
28 #define PERL_IN_PERLIO_C
31 #if !defined(PERL_IMPLICIT_SYS)
33 #ifdef PERLIO_IS_STDIO
38 /* Does nothing (yet) except force this file to be included
39 in perl binary. That allows this file to force inclusion
40 of other functions that may be required by loadable
41 extensions e.g. for FileHandle::tmpfile
52 #else /* PERLIO_IS_STDIO */
59 /* This section is just to make sure these functions
60 get pulled in from libsfio.a
73 /* Force this file to be included in perl binary. Which allows
74 * this file to force inclusion of other functions that may be
75 * required by loadable extensions e.g. for FileHandle::tmpfile
79 * sfio does its own 'autoflush' on stdout in common cases.
80 * Flush results in a lot of lseek()s to regular files and
81 * lot of small writes to pipes.
83 sfset(sfstdout,SF_SHARE,0);
87 /*======================================================================================*/
88 /* Implement all the PerlIO interface ourselves.
91 /* We _MUST_ have <unistd.h> if we are using lseek() and may have large files */
102 void PerlIO_debug(char *fmt,...) __attribute__((format(printf,1,2)));
105 PerlIO_debug(char *fmt,...)
110 char *s = getenv("PERLIO_DEBUG");
112 dbg = open(s,O_WRONLY|O_CREAT|O_APPEND,0666);
120 SV *sv = newSVpvn("",0);
124 s = CopFILE(PL_curcop);
127 Perl_sv_catpvf(aTHX_ sv, "%s:%"IVdf" ", s, (IV)CopLINE(PL_curcop));
128 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
137 /*--------------------------------------------------------------------------------------*/
139 typedef struct _PerlIO_funcs PerlIO_funcs;
145 IV (*Fileno)(PerlIO *f);
146 PerlIO * (*Fdopen)(PerlIO_funcs *tab, int fd, const char *mode);
147 PerlIO * (*Open)(PerlIO_funcs *tab, const char *path, const char *mode);
148 int (*Reopen)(const char *path, const char *mode, PerlIO *f);
149 IV (*Pushed)(PerlIO *f,const char *mode);
150 IV (*Popped)(PerlIO *f);
151 /* Unix-like functions - cf sfio line disciplines */
152 SSize_t (*Read)(PerlIO *f, void *vbuf, Size_t count);
153 SSize_t (*Unread)(PerlIO *f, const void *vbuf, Size_t count);
154 SSize_t (*Write)(PerlIO *f, const void *vbuf, Size_t count);
155 IV (*Seek)(PerlIO *f, Off_t offset, int whence);
156 Off_t (*Tell)(PerlIO *f);
157 IV (*Close)(PerlIO *f);
158 /* Stdio-like buffered IO functions */
159 IV (*Flush)(PerlIO *f);
160 IV (*Fill)(PerlIO *f);
161 IV (*Eof)(PerlIO *f);
162 IV (*Error)(PerlIO *f);
163 void (*Clearerr)(PerlIO *f);
164 void (*Setlinebuf)(PerlIO *f);
165 /* Perl's snooping functions */
166 STDCHAR * (*Get_base)(PerlIO *f);
167 Size_t (*Get_bufsiz)(PerlIO *f);
168 STDCHAR * (*Get_ptr)(PerlIO *f);
169 SSize_t (*Get_cnt)(PerlIO *f);
170 void (*Set_ptrcnt)(PerlIO *f,STDCHAR *ptr,SSize_t cnt);
175 PerlIOl * next; /* Lower layer */
176 PerlIO_funcs * tab; /* Functions for this layer */
177 IV flags; /* Various flags for state */
180 /*--------------------------------------------------------------------------------------*/
183 #define PERLIO_F_EOF 0x00010000
184 #define PERLIO_F_CANWRITE 0x00020000
185 #define PERLIO_F_CANREAD 0x00040000
186 #define PERLIO_F_ERROR 0x00080000
187 #define PERLIO_F_TRUNCATE 0x00100000
188 #define PERLIO_F_APPEND 0x00200000
189 #define PERLIO_F_BINARY 0x00400000
190 #define PERLIO_F_UTF8 0x00800000
191 #define PERLIO_F_LINEBUF 0x01000000
192 #define PERLIO_F_WRBUF 0x02000000
193 #define PERLIO_F_RDBUF 0x04000000
194 #define PERLIO_F_TEMP 0x08000000
195 #define PERLIO_F_OPEN 0x10000000
197 #define PerlIOBase(f) (*(f))
198 #define PerlIOSelf(f,type) ((type *)PerlIOBase(f))
199 #define PerlIONext(f) (&(PerlIOBase(f)->next))
201 /*--------------------------------------------------------------------------------------*/
202 /* Inner level routines */
204 /* Table of pointers to the PerlIO structs (malloc'ed) */
205 PerlIO *_perlio = NULL;
206 #define PERLIO_TABLE_SIZE 64
209 PerlIO_allocate(void)
211 /* Find a free slot in the table, allocating new table as necessary */
212 PerlIO **last = &_perlio;
217 last = (PerlIO **)(f);
218 for (i=1; i < PERLIO_TABLE_SIZE; i++)
226 Newz('I',f,PERLIO_TABLE_SIZE,PerlIO);
234 PerlIO_cleantable(PerlIO **tablep)
236 PerlIO *table = *tablep;
240 PerlIO_cleantable((PerlIO **) &(table[0]));
241 for (i=PERLIO_TABLE_SIZE-1; i > 0; i--)
258 PerlIO_cleantable(&_perlio);
262 PerlIO_pop(PerlIO *f)
267 (*l->tab->Popped)(f);
275 PerlIO_close(PerlIO *f)
277 int code = (*PerlIOBase(f)->tab->Close)(f);
286 /*--------------------------------------------------------------------------------------*/
287 /* Given the abstraction above the public API functions */
291 PerlIO_fileno(PerlIO *f)
293 return (*PerlIOBase(f)->tab->Fileno)(f);
297 extern PerlIO_funcs PerlIO_unix;
298 extern PerlIO_funcs PerlIO_perlio;
299 extern PerlIO_funcs PerlIO_stdio;
301 extern PerlIO_funcs PerlIO_mmap;
308 char *s = GvNAME(gv);
309 STRLEN l = GvNAMELEN(gv);
310 PerlIO_debug("%.*s\n",(int) l,s);
314 XS(XS_perlio_unimport)
318 char *s = GvNAME(gv);
319 STRLEN l = GvNAMELEN(gv);
320 PerlIO_debug("%.*s\n",(int) l,s);
325 PerlIO_find_layer(char *name, STRLEN len)
332 svp = hv_fetch(PerlIO_layer_hv,name,len,0);
333 if (svp && (sv = *svp) && SvROK(sv))
339 PerlIO_define_layer(PerlIO_funcs *tab)
342 HV *stash = gv_stashpv("perlio::Layer", TRUE);
343 SV *sv = sv_bless(newRV_noinc(newSViv((IV) tab)),stash);
344 hv_store(PerlIO_layer_hv,tab->name,strlen(tab->name),sv,0);
348 PerlIO_default_layer(I32 n)
353 PerlIO_funcs *tab = &PerlIO_stdio;
355 if (!PerlIO_layer_hv)
357 char *s = getenv("PERLIO");
358 newXS("perlio::import",XS_perlio_import,__FILE__);
359 newXS("perlio::unimport",XS_perlio_unimport,__FILE__);
360 PerlIO_layer_hv = get_hv("perlio::layers",GV_ADD|GV_ADDMULTI);
361 PerlIO_layer_av = get_av("perlio::layers",GV_ADD|GV_ADDMULTI);
362 PerlIO_define_layer(&PerlIO_unix);
363 PerlIO_define_layer(&PerlIO_perlio);
364 PerlIO_define_layer(&PerlIO_stdio);
366 PerlIO_define_layer(&PerlIO_mmap);
368 av_push(PerlIO_layer_av,SvREFCNT_inc(PerlIO_find_layer(PerlIO_unix.name,0)));
373 while (*s && isspace((unsigned char)*s))
379 while (*e && !isspace((unsigned char)*e))
381 layer = PerlIO_find_layer(s,e-s);
384 PerlIO_debug("Pushing %.*s\n",(e-s),s);
385 av_push(PerlIO_layer_av,SvREFCNT_inc(layer));
388 Perl_warn(aTHX_ "Unknown layer %.*s",(e-s),s);
394 len = av_len(PerlIO_layer_av);
397 if (PerlIO_stdio.Set_ptrcnt)
399 av_push(PerlIO_layer_av,SvREFCNT_inc(PerlIO_find_layer(PerlIO_stdio.name,0)));
403 av_push(PerlIO_layer_av,SvREFCNT_inc(PerlIO_find_layer(PerlIO_perlio.name,0)));
405 len = av_len(PerlIO_layer_av);
409 svp = av_fetch(PerlIO_layer_av,n,0);
410 if (svp && (layer = *svp) && SvROK(layer) && SvIOK((layer = SvRV(layer))))
412 tab = (PerlIO_funcs *) SvIV(layer);
414 /* PerlIO_debug("Layer %d is %s\n",n,tab->name); */
418 #define PerlIO_default_top() PerlIO_default_layer(-1)
419 #define PerlIO_default_btm() PerlIO_default_layer(0)
427 PerlIO_fdopen(0,"Ir");
428 PerlIO_fdopen(1,"Iw");
429 PerlIO_fdopen(2,"Iw");
435 PerlIO_fdopen(int fd, const char *mode)
437 PerlIO_funcs *tab = PerlIO_default_top();
440 return (*tab->Fdopen)(tab,fd,mode);
445 PerlIO_open(const char *path, const char *mode)
447 PerlIO_funcs *tab = PerlIO_default_top();
450 return (*tab->Open)(tab,path,mode);
454 PerlIOBase_pushed(PerlIO *f, const char *mode)
456 PerlIOl *l = PerlIOBase(f);
457 l->flags &= ~(PERLIO_F_CANREAD|PERLIO_F_CANWRITE|
458 PERLIO_F_TRUNCATE|PERLIO_F_APPEND|PERLIO_F_BINARY);
464 l->flags = PERLIO_F_CANREAD;
467 l->flags = PERLIO_F_APPEND|PERLIO_F_CANWRITE;
470 l->flags = PERLIO_F_TRUNCATE|PERLIO_F_CANWRITE;
481 l->flags |= PERLIO_F_CANREAD|PERLIO_F_CANWRITE;
484 l->flags |= PERLIO_F_BINARY;
496 l->flags |= l->next->flags &
497 (PERLIO_F_CANREAD|PERLIO_F_CANWRITE|
498 PERLIO_F_TRUNCATE|PERLIO_F_APPEND|PERLIO_F_BINARY);
506 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
511 if ((*PerlIOBase(f)->tab->Reopen)(path,mode,f) == 0)
513 if ((*PerlIOBase(f)->tab->Pushed)(f,mode) == 0)
519 return PerlIO_open(path,mode);
524 PerlIO_read(PerlIO *f, void *vbuf, Size_t count)
526 return (*PerlIOBase(f)->tab->Read)(f,vbuf,count);
531 PerlIO_unread(PerlIO *f, const void *vbuf, Size_t count)
533 return (*PerlIOBase(f)->tab->Unread)(f,vbuf,count);
538 PerlIO_write(PerlIO *f, const void *vbuf, Size_t count)
540 return (*PerlIOBase(f)->tab->Write)(f,vbuf,count);
545 PerlIO_seek(PerlIO *f, Off_t offset, int whence)
547 return (*PerlIOBase(f)->tab->Seek)(f,offset,whence);
552 PerlIO_tell(PerlIO *f)
554 return (*PerlIOBase(f)->tab->Tell)(f);
559 PerlIO_flush(PerlIO *f)
563 return (*PerlIOBase(f)->tab->Flush)(f);
567 PerlIO **table = &_perlio;
572 table = (PerlIO **)(f++);
573 for (i=1; i < PERLIO_TABLE_SIZE; i++)
575 if (*f && PerlIO_flush(f) != 0)
586 PerlIO_fill(PerlIO *f)
588 return (*PerlIOBase(f)->tab->Fill)(f);
593 PerlIO_isutf8(PerlIO *f)
595 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
600 PerlIO_eof(PerlIO *f)
602 return (*PerlIOBase(f)->tab->Eof)(f);
607 PerlIO_error(PerlIO *f)
609 return (*PerlIOBase(f)->tab->Error)(f);
612 #undef PerlIO_clearerr
614 PerlIO_clearerr(PerlIO *f)
616 (*PerlIOBase(f)->tab->Clearerr)(f);
619 #undef PerlIO_setlinebuf
621 PerlIO_setlinebuf(PerlIO *f)
623 (*PerlIOBase(f)->tab->Setlinebuf)(f);
626 #undef PerlIO_has_base
628 PerlIO_has_base(PerlIO *f)
632 return (PerlIOBase(f)->tab->Get_base != NULL);
637 #undef PerlIO_fast_gets
639 PerlIO_fast_gets(PerlIO *f)
643 PerlIOl *l = PerlIOBase(f);
644 return (l->tab->Set_ptrcnt != NULL);
649 #undef PerlIO_has_cntptr
651 PerlIO_has_cntptr(PerlIO *f)
655 PerlIO_funcs *tab = PerlIOBase(f)->tab;
656 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
661 #undef PerlIO_canset_cnt
663 PerlIO_canset_cnt(PerlIO *f)
667 PerlIOl *l = PerlIOBase(f);
668 return (l->tab->Set_ptrcnt != NULL);
673 #undef PerlIO_get_base
675 PerlIO_get_base(PerlIO *f)
677 return (*PerlIOBase(f)->tab->Get_base)(f);
680 #undef PerlIO_get_bufsiz
682 PerlIO_get_bufsiz(PerlIO *f)
684 return (*PerlIOBase(f)->tab->Get_bufsiz)(f);
687 #undef PerlIO_get_ptr
689 PerlIO_get_ptr(PerlIO *f)
691 return (*PerlIOBase(f)->tab->Get_ptr)(f);
694 #undef PerlIO_get_cnt
696 PerlIO_get_cnt(PerlIO *f)
698 return (*PerlIOBase(f)->tab->Get_cnt)(f);
701 #undef PerlIO_set_cnt
703 PerlIO_set_cnt(PerlIO *f,int cnt)
705 (*PerlIOBase(f)->tab->Set_ptrcnt)(f,NULL,cnt);
708 #undef PerlIO_set_ptrcnt
710 PerlIO_set_ptrcnt(PerlIO *f, STDCHAR *ptr, int cnt)
712 (*PerlIOBase(f)->tab->Set_ptrcnt)(f,ptr,cnt);
715 /*--------------------------------------------------------------------------------------*/
716 /* "Methods" of the "base class" */
719 PerlIOBase_fileno(PerlIO *f)
721 return PerlIO_fileno(PerlIONext(f));
725 PerlIO_push(PerlIO *f,PerlIO_funcs *tab,const char *mode)
728 Newc('L',l,tab->size,char,PerlIOl);
731 Zero(l,tab->size,char);
735 if ((*l->tab->Pushed)(f,mode) != 0)
745 PerlIOBase_unread(PerlIO *f, const void *vbuf, Size_t count)
747 Off_t old = PerlIO_tell(f);
748 if (PerlIO_seek(f,-((Off_t)count),SEEK_CUR) == 0)
750 Off_t new = PerlIO_tell(f);
757 PerlIOBase_noop_ok(PerlIO *f)
763 PerlIOBase_noop_fail(PerlIO *f)
769 PerlIOBase_close(PerlIO *f)
772 if (PerlIO_flush(f) != 0)
774 if (PerlIO_close(PerlIONext(f)) != 0)
776 PerlIOBase(f)->flags &= ~(PERLIO_F_CANREAD|PERLIO_F_CANWRITE|PERLIO_F_OPEN);
781 PerlIOBase_eof(PerlIO *f)
785 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
791 PerlIOBase_error(PerlIO *f)
795 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
801 PerlIOBase_clearerr(PerlIO *f)
805 PerlIOBase(f)->flags &= ~PERLIO_F_ERROR;
810 PerlIOBase_setlinebuf(PerlIO *f)
817 /*--------------------------------------------------------------------------------------*/
818 /* Bottom-most level for UNIX-like case */
822 struct _PerlIO base; /* The generic part */
823 int fd; /* UNIX like file descriptor */
824 int oflags; /* open/fcntl flags */
828 PerlIOUnix_oflags(const char *mode)
843 oflags = O_CREAT|O_TRUNC;
854 oflags = O_CREAT|O_APPEND;
864 if (*mode || oflags == -1)
873 PerlIOUnix_fileno(PerlIO *f)
875 return PerlIOSelf(f,PerlIOUnix)->fd;
879 PerlIOUnix_fdopen(PerlIO_funcs *self, int fd,const char *mode)
886 int oflags = PerlIOUnix_oflags(mode);
889 PerlIOUnix *s = PerlIOSelf(PerlIO_push(f = PerlIO_allocate(),self,mode),PerlIOUnix);
892 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
899 PerlIOUnix_open(PerlIO_funcs *self, const char *path,const char *mode)
902 int oflags = PerlIOUnix_oflags(mode);
905 int fd = open(path,oflags,0666);
908 PerlIOUnix *s = PerlIOSelf(PerlIO_push(f = PerlIO_allocate(),self,mode),PerlIOUnix);
911 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
918 PerlIOUnix_reopen(const char *path, const char *mode, PerlIO *f)
920 PerlIOUnix *s = PerlIOSelf(f,PerlIOUnix);
921 int oflags = PerlIOUnix_oflags(mode);
922 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
923 (*PerlIOBase(f)->tab->Close)(f);
926 int fd = open(path,oflags,0666);
931 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
939 PerlIOUnix_read(PerlIO *f, void *vbuf, Size_t count)
941 int fd = PerlIOSelf(f,PerlIOUnix)->fd;
942 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD))
946 SSize_t len = read(fd,vbuf,count);
947 if (len >= 0 || errno != EINTR)
950 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
951 else if (len == 0 && count != 0)
952 PerlIOBase(f)->flags |= PERLIO_F_EOF;
959 PerlIOUnix_write(PerlIO *f, const void *vbuf, Size_t count)
961 int fd = PerlIOSelf(f,PerlIOUnix)->fd;
964 SSize_t len = write(fd,vbuf,count);
965 if (len >= 0 || errno != EINTR)
968 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
975 PerlIOUnix_seek(PerlIO *f, Off_t offset, int whence)
977 Off_t new = lseek(PerlIOSelf(f,PerlIOUnix)->fd,offset,whence);
978 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
979 return (new == (Off_t) -1) ? -1 : 0;
983 PerlIOUnix_tell(PerlIO *f)
985 return lseek(PerlIOSelf(f,PerlIOUnix)->fd,0,SEEK_CUR);
989 PerlIOUnix_close(PerlIO *f)
991 int fd = PerlIOSelf(f,PerlIOUnix)->fd;
993 while (close(fd) != 0)
1003 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
1008 PerlIO_funcs PerlIO_unix = {
1025 PerlIOBase_noop_fail,
1028 PerlIOBase_clearerr,
1029 PerlIOBase_setlinebuf,
1030 NULL, /* get_base */
1031 NULL, /* get_bufsiz */
1034 NULL, /* set_ptrcnt */
1037 /*--------------------------------------------------------------------------------------*/
1038 /* stdio as a layer */
1042 struct _PerlIO base;
1043 FILE * stdio; /* The stream */
1047 PerlIOStdio_fileno(PerlIO *f)
1049 return fileno(PerlIOSelf(f,PerlIOStdio)->stdio);
1054 PerlIOStdio_fdopen(PerlIO_funcs *self, int fd,const char *mode)
1082 stdio = fdopen(fd,mode);
1085 PerlIOStdio *s = PerlIOSelf(PerlIO_push(f = PerlIO_allocate(),self,mode),PerlIOStdio);
1092 #undef PerlIO_importFILE
1094 PerlIO_importFILE(FILE *stdio, int fl)
1099 PerlIOStdio *s = PerlIOSelf(PerlIO_push(f = PerlIO_allocate(),&PerlIO_stdio,"r+"),PerlIOStdio);
1106 PerlIOStdio_open(PerlIO_funcs *self, const char *path,const char *mode)
1109 FILE *stdio = fopen(path,mode);
1112 PerlIOStdio *s = PerlIOSelf(PerlIO_push(f = PerlIO_allocate(),self,mode),PerlIOStdio);
1119 PerlIOStdio_reopen(const char *path, const char *mode, PerlIO *f)
1121 PerlIOStdio *s = PerlIOSelf(f,PerlIOStdio);
1122 FILE *stdio = freopen(path,mode,s->stdio);
1130 PerlIOStdio_read(PerlIO *f, void *vbuf, Size_t count)
1132 FILE *s = PerlIOSelf(f,PerlIOStdio)->stdio;
1136 STDCHAR *buf = (STDCHAR *) vbuf;
1137 /* Perl is expecting PerlIO_getc() to fill the buffer
1138 * Linux's stdio does not do that for fread()
1148 got = fread(vbuf,1,count,s);
1153 PerlIOStdio_unread(PerlIO *f, const void *vbuf, Size_t count)
1155 FILE *s = PerlIOSelf(f,PerlIOStdio)->stdio;
1156 STDCHAR *buf = ((STDCHAR *)vbuf)+count-1;
1160 int ch = *buf-- & 0xff;
1161 if (ungetc(ch,s) != ch)
1170 PerlIOStdio_write(PerlIO *f, const void *vbuf, Size_t count)
1172 return fwrite(vbuf,1,count,PerlIOSelf(f,PerlIOStdio)->stdio);
1176 PerlIOStdio_seek(PerlIO *f, Off_t offset, int whence)
1178 FILE *stdio = PerlIOSelf(f,PerlIOStdio)->stdio;
1179 return fseek(stdio,offset,whence);
1183 PerlIOStdio_tell(PerlIO *f)
1185 FILE *stdio = PerlIOSelf(f,PerlIOStdio)->stdio;
1186 return ftell(stdio);
1190 PerlIOStdio_close(PerlIO *f)
1192 return fclose(PerlIOSelf(f,PerlIOStdio)->stdio);
1196 PerlIOStdio_flush(PerlIO *f)
1198 FILE *stdio = PerlIOSelf(f,PerlIOStdio)->stdio;
1199 return fflush(stdio);
1203 PerlIOStdio_fill(PerlIO *f)
1205 FILE *stdio = PerlIOSelf(f,PerlIOStdio)->stdio;
1207 if (fflush(stdio) != 0)
1210 if (c == EOF || ungetc(c,stdio) != c)
1216 PerlIOStdio_eof(PerlIO *f)
1218 return feof(PerlIOSelf(f,PerlIOStdio)->stdio);
1222 PerlIOStdio_error(PerlIO *f)
1224 return ferror(PerlIOSelf(f,PerlIOStdio)->stdio);
1228 PerlIOStdio_clearerr(PerlIO *f)
1230 clearerr(PerlIOSelf(f,PerlIOStdio)->stdio);
1234 PerlIOStdio_setlinebuf(PerlIO *f)
1236 #ifdef HAS_SETLINEBUF
1237 setlinebuf(PerlIOSelf(f,PerlIOStdio)->stdio);
1239 setvbuf(PerlIOSelf(f,PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
1245 PerlIOStdio_get_base(PerlIO *f)
1247 FILE *stdio = PerlIOSelf(f,PerlIOStdio)->stdio;
1248 return FILE_base(stdio);
1252 PerlIOStdio_get_bufsiz(PerlIO *f)
1254 FILE *stdio = PerlIOSelf(f,PerlIOStdio)->stdio;
1255 return FILE_bufsiz(stdio);
1259 #ifdef USE_STDIO_PTR
1261 PerlIOStdio_get_ptr(PerlIO *f)
1263 FILE *stdio = PerlIOSelf(f,PerlIOStdio)->stdio;
1264 return FILE_ptr(stdio);
1268 PerlIOStdio_get_cnt(PerlIO *f)
1270 FILE *stdio = PerlIOSelf(f,PerlIOStdio)->stdio;
1271 return FILE_cnt(stdio);
1275 PerlIOStdio_set_ptrcnt(PerlIO *f,STDCHAR *ptr,SSize_t cnt)
1277 FILE *stdio = PerlIOSelf(f,PerlIOStdio)->stdio;
1280 #ifdef STDIO_PTR_LVALUE
1281 FILE_ptr(stdio) = ptr;
1282 #ifdef STDIO_PTR_LVAL_SETS_CNT
1283 if (FILE_cnt(stdio) != (cnt))
1286 assert(FILE_cnt(stdio) == (cnt));
1289 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
1290 /* Setting ptr _does_ change cnt - we are done */
1293 #else /* STDIO_PTR_LVALUE */
1295 #endif /* STDIO_PTR_LVALUE */
1297 /* Now (or only) set cnt */
1298 #ifdef STDIO_CNT_LVALUE
1299 FILE_cnt(stdio) = cnt;
1300 #else /* STDIO_CNT_LVALUE */
1301 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
1302 FILE_ptr(stdio) = FILE_ptr(stdio)+(FILE_cnt(stdio)-cnt);
1303 #else /* STDIO_PTR_LVAL_SETS_CNT */
1305 #endif /* STDIO_PTR_LVAL_SETS_CNT */
1306 #endif /* STDIO_CNT_LVALUE */
1311 PerlIO_funcs PerlIO_stdio = {
1313 sizeof(PerlIOStdio),
1331 PerlIOStdio_clearerr,
1332 PerlIOStdio_setlinebuf,
1334 PerlIOStdio_get_base,
1335 PerlIOStdio_get_bufsiz,
1340 #ifdef USE_STDIO_PTR
1341 PerlIOStdio_get_ptr,
1342 PerlIOStdio_get_cnt,
1343 #if (defined(STDIO_PTR_LVALUE) && \
1344 (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
1345 PerlIOStdio_set_ptrcnt
1346 #else /* STDIO_PTR_LVALUE */
1348 #endif /* STDIO_PTR_LVALUE */
1349 #else /* USE_STDIO_PTR */
1353 #endif /* USE_STDIO_PTR */
1356 #undef PerlIO_exportFILE
1358 PerlIO_exportFILE(PerlIO *f, int fl)
1361 /* Should really push stdio discipline when we have them */
1362 return fdopen(PerlIO_fileno(f),"r+");
1365 #undef PerlIO_findFILE
1367 PerlIO_findFILE(PerlIO *f)
1369 return PerlIO_exportFILE(f,0);
1372 #undef PerlIO_releaseFILE
1374 PerlIO_releaseFILE(PerlIO *p, FILE *f)
1378 /*--------------------------------------------------------------------------------------*/
1379 /* perlio buffer layer */
1383 struct _PerlIO base;
1384 Off_t posn; /* Offset of buf into the file */
1385 STDCHAR * buf; /* Start of buffer */
1386 STDCHAR * end; /* End of valid part of buffer */
1387 STDCHAR * ptr; /* Current position in buffer */
1388 Size_t bufsiz; /* Size of buffer */
1389 IV oneword; /* Emergency buffer */
1394 PerlIOBuf_fdopen(PerlIO_funcs *self, int fd, const char *mode)
1396 PerlIO_funcs *tab = PerlIO_default_btm();
1404 f = (*tab->Fdopen)(tab,fd,mode);
1407 /* Initial stderr is unbuffered */
1408 if (!init || fd != 2)
1410 PerlIOBuf *b = PerlIOSelf(PerlIO_push(f,self,NULL),PerlIOBuf);
1411 b->posn = PerlIO_tell(PerlIONext(f));
1418 PerlIOBuf_open(PerlIO_funcs *self, const char *path, const char *mode)
1420 PerlIO_funcs *tab = PerlIO_default_btm();
1421 PerlIO *f = (*tab->Open)(tab,path,mode);
1424 PerlIOBuf *b = PerlIOSelf(PerlIO_push(f,self,NULL),PerlIOBuf);
1431 PerlIOBase_reopen(const char *path, const char *mode, PerlIO *f)
1433 return (*PerlIOBase(f)->tab->Reopen)(path,mode,PerlIONext(f));
1436 /* This "flush" is akin to sfio's sync in that it handles files in either
1440 PerlIOBuf_flush(PerlIO *f)
1442 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1444 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
1446 /* write() the buffer */
1447 STDCHAR *p = b->buf;
1451 count = PerlIO_write(PerlIONext(f),p,b->ptr - p);
1458 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
1463 b->posn += (p - b->buf);
1465 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
1467 /* Note position change */
1468 b->posn += (b->ptr - b->buf);
1469 if (b->ptr < b->end)
1471 /* We did not consume all of it */
1472 if (PerlIO_seek(PerlIONext(f),b->posn,SEEK_SET) == 0)
1474 b->posn = PerlIO_tell(PerlIONext(f));
1478 b->ptr = b->end = b->buf;
1479 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF|PERLIO_F_WRBUF);
1480 if (PerlIO_flush(PerlIONext(f)) != 0)
1486 PerlIOBuf_fill(PerlIO *f)
1488 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1490 if (PerlIO_flush(f) != 0)
1492 b->ptr = b->end = b->buf;
1493 avail = PerlIO_read(PerlIONext(f),b->ptr,b->bufsiz);
1497 PerlIOBase(f)->flags |= PERLIO_F_EOF;
1499 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
1502 b->end = b->buf+avail;
1503 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
1508 PerlIOBuf_read(PerlIO *f, void *vbuf, Size_t count)
1510 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1511 STDCHAR *buf = (STDCHAR *) vbuf;
1517 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD))
1521 SSize_t avail = (b->end - b->ptr);
1522 if ((SSize_t) count < avail)
1526 Copy(b->ptr,buf,avail,char);
1532 if (count && (b->ptr >= b->end))
1534 if (PerlIO_fill(f) != 0)
1544 PerlIOBuf_unread(PerlIO *f, const void *vbuf, Size_t count)
1546 const STDCHAR *buf = (const STDCHAR *) vbuf+count;
1547 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1550 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
1556 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
1558 avail = (b->ptr - b->buf);
1559 if (avail > (SSize_t) count)
1566 if (avail > (SSize_t) count)
1568 b->end = b->ptr + avail;
1575 Copy(buf,b->ptr,avail,char);
1579 PerlIOBase(f)->flags &= ~ PERLIO_F_EOF;
1586 PerlIOBuf_write(PerlIO *f, const void *vbuf, Size_t count)
1588 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1589 const STDCHAR *buf = (const STDCHAR *) vbuf;
1593 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
1597 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
1598 if ((SSize_t) count < avail)
1600 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
1601 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF)
1621 Copy(buf,b->ptr,avail,char);
1628 if (b->ptr >= (b->buf + b->bufsiz))
1635 PerlIOBuf_seek(PerlIO *f, Off_t offset, int whence)
1637 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1638 int code = PerlIO_flush(f);
1641 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
1642 code = PerlIO_seek(PerlIONext(f),offset,whence);
1645 b->posn = PerlIO_tell(PerlIONext(f));
1652 PerlIOBuf_tell(PerlIO *f)
1654 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1655 Off_t posn = b->posn;
1657 posn += (b->ptr - b->buf);
1662 PerlIOBuf_close(PerlIO *f)
1664 IV code = PerlIOBase_close(f);
1665 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1666 if (b->buf && b->buf != (STDCHAR *) &b->oneword)
1671 b->ptr = b->end = b->buf;
1672 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF|PERLIO_F_WRBUF);
1677 PerlIOBuf_setlinebuf(PerlIO *f)
1681 PerlIOBase(f)->flags &= ~PERLIO_F_LINEBUF;
1686 PerlIOBuf_set_cnt(PerlIO *f, int cnt)
1688 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1692 b->ptr = b->end - cnt;
1693 assert(b->ptr >= b->buf);
1697 PerlIOBuf_get_ptr(PerlIO *f)
1699 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1706 PerlIOBuf_get_cnt(PerlIO *f)
1708 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1711 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
1712 return (b->end - b->ptr);
1717 PerlIOBuf_get_base(PerlIO *f)
1719 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1724 New('B',b->buf,b->bufsiz,STDCHAR);
1727 b->buf = (STDCHAR *)&b->oneword;
1728 b->bufsiz = sizeof(b->oneword);
1737 PerlIOBuf_bufsiz(PerlIO *f)
1739 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1742 return (b->end - b->buf);
1746 PerlIOBuf_set_ptrcnt(PerlIO *f, STDCHAR *ptr, SSize_t cnt)
1748 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1752 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf)
1755 assert(PerlIO_get_cnt(f) == cnt);
1756 assert(b->ptr >= b->buf);
1758 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
1761 PerlIO_funcs PerlIO_perlio = {
1781 PerlIOBase_clearerr,
1782 PerlIOBuf_setlinebuf,
1787 PerlIOBuf_set_ptrcnt,
1791 /*--------------------------------------------------------------------------------------*/
1792 /* mmap as "buffer" layer */
1796 PerlIOBuf base; /* PerlIOBuf stuff */
1797 Size_t len; /* mapped length */
1798 STDCHAR *bbuf; /* malloced buffer if map fails */
1802 PerlIOMmap_map(PerlIO *f)
1804 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1805 PerlIOBuf *b = &m->base;
1806 IV flags = PerlIOBase(f)->flags;
1810 if (flags & PERLIO_F_CANREAD)
1812 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1813 int fd = PerlIO_fileno(f);
1815 code = fstat(fd,&st);
1816 if (code == 0 && S_ISREG(st.st_mode))
1818 SSize_t len = st.st_size - b->posn;
1821 b->buf = (STDCHAR *) mmap(NULL, len, PROT_READ, MAP_PRIVATE, fd, b->posn);
1822 if (b->buf && b->buf != (STDCHAR *) -1)
1824 #if defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
1825 madvise((Mmap_t) b->buf, len, MADV_SEQUENTIAL);
1827 PerlIOBase(f)->flags = flags | PERLIO_F_RDBUF;
1828 b->end = b->buf+len;
1839 PerlIOBase(f)->flags = flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
1841 b->ptr = b->end = b->ptr;
1850 PerlIOMmap_unmap(PerlIO *f)
1852 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1853 PerlIOBuf *b = &m->base;
1859 code = munmap((Mmap_t) b->buf, m->len);
1862 if (PerlIO_seek(PerlIONext(f),b->posn,SEEK_SET) != 0)
1865 b->ptr = b->end = b->buf;
1866 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF|PERLIO_F_WRBUF);
1872 PerlIOMmap_get_base(PerlIO *f)
1874 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1875 PerlIOBuf *b = &m->base;
1876 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF))
1878 /* Already have a readbuffer in progress */
1883 /* We have a write buffer or flushed PerlIOBuf read buffer */
1884 m->bbuf = b->buf; /* save it in case we need it again */
1885 b->buf = NULL; /* Clear to trigger below */
1889 PerlIOMmap_map(f); /* Try and map it */
1892 /* Map did not work - recover PerlIOBuf buffer if we have one */
1896 b->ptr = b->end = b->buf;
1899 return PerlIOBuf_get_base(f);
1903 PerlIOMmap_unread(PerlIO *f, const void *vbuf, Size_t count)
1905 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1906 PerlIOBuf *b = &m->base;
1907 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
1909 if (b->ptr && (b->ptr - count) >= b->buf && memEQ(b->ptr - count,vbuf,count))
1912 PerlIOBase(f)->flags &= ~ PERLIO_F_EOF;
1917 /* Loose the unwritable mapped buffer */
1920 return PerlIOBuf_unread(f,vbuf,count);
1924 PerlIOMmap_write(PerlIO *f, const void *vbuf, Size_t count)
1926 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1927 PerlIOBuf *b = &m->base;
1928 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF))
1930 /* No, or wrong sort of, buffer */
1933 if (PerlIOMmap_unmap(f) != 0)
1936 /* If unmap took the "buffer" see if we have one from before */
1937 if (!b->buf && m->bbuf)
1941 PerlIOBuf_get_base(f);
1945 return PerlIOBuf_write(f,vbuf,count);
1949 PerlIOMmap_flush(PerlIO *f)
1951 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1952 PerlIOBuf *b = &m->base;
1953 IV code = PerlIOBuf_flush(f);
1954 /* Now we are "synced" at PerlIOBuf level */
1959 /* Unmap the buffer */
1960 if (PerlIOMmap_unmap(f) != 0)
1965 /* We seem to have a PerlIOBuf buffer which was not mapped
1966 * remember it in case we need one later
1975 PerlIOMmap_fill(PerlIO *f)
1977 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1978 IV code = PerlIO_flush(f);
1979 if (code == 0 && !b->buf)
1981 code = PerlIOMmap_map(f);
1983 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF))
1985 code = PerlIOBuf_fill(f);
1991 PerlIOMmap_close(PerlIO *f)
1993 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1994 PerlIOBuf *b = &m->base;
1995 IV code = PerlIO_flush(f);
2000 b->ptr = b->end = b->buf;
2002 if (PerlIOBuf_close(f) != 0)
2008 PerlIO_funcs PerlIO_mmap = {
2028 PerlIOBase_clearerr,
2029 PerlIOBuf_setlinebuf,
2030 PerlIOMmap_get_base,
2034 PerlIOBuf_set_ptrcnt,
2037 #endif /* HAS_MMAP */
2046 atexit(&PerlIO_cleanup);
2055 PerlIO_stdstreams();
2059 #undef PerlIO_stdout
2064 PerlIO_stdstreams();
2068 #undef PerlIO_stderr
2073 PerlIO_stdstreams();
2077 /*--------------------------------------------------------------------------------------*/
2079 #undef PerlIO_getname
2081 PerlIO_getname(PerlIO *f, char *buf)
2084 Perl_croak(aTHX_ "Don't know how to get file name");
2089 /*--------------------------------------------------------------------------------------*/
2090 /* Functions which can be called on any kind of PerlIO implemented
2096 PerlIO_getc(PerlIO *f)
2099 SSize_t count = PerlIO_read(f,buf,1);
2102 return (unsigned char) buf[0];
2107 #undef PerlIO_ungetc
2109 PerlIO_ungetc(PerlIO *f, int ch)
2114 if (PerlIO_unread(f,&buf,1) == 1)
2122 PerlIO_putc(PerlIO *f, int ch)
2125 return PerlIO_write(f,&buf,1);
2130 PerlIO_puts(PerlIO *f, const char *s)
2132 STRLEN len = strlen(s);
2133 return PerlIO_write(f,s,len);
2136 #undef PerlIO_rewind
2138 PerlIO_rewind(PerlIO *f)
2140 PerlIO_seek(f,(Off_t)0,SEEK_SET);
2144 #undef PerlIO_vprintf
2146 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
2149 SV *sv = newSVpvn("",0);
2152 sv_vcatpvf(sv, fmt, &ap);
2154 return PerlIO_write(f,s,len);
2157 #undef PerlIO_printf
2159 PerlIO_printf(PerlIO *f,const char *fmt,...)
2164 result = PerlIO_vprintf(f,fmt,ap);
2169 #undef PerlIO_stdoutf
2171 PerlIO_stdoutf(const char *fmt,...)
2176 result = PerlIO_vprintf(PerlIO_stdout(),fmt,ap);
2181 #undef PerlIO_tmpfile
2183 PerlIO_tmpfile(void)
2186 /* I have no idea how portable mkstemp() is ... */
2187 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX",0);
2188 int fd = mkstemp(SvPVX(sv));
2192 f = PerlIO_fdopen(fd,"w+");
2195 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
2206 #endif /* USE_SFIO */
2207 #endif /* PERLIO_IS_STDIO */
2209 /*======================================================================================*/
2210 /* Now some functions in terms of above which may be needed even if
2211 we are not in true PerlIO mode
2215 #undef PerlIO_setpos
2217 PerlIO_setpos(PerlIO *f, const Fpos_t *pos)
2219 return PerlIO_seek(f,*pos,0);
2222 #ifndef PERLIO_IS_STDIO
2223 #undef PerlIO_setpos
2225 PerlIO_setpos(PerlIO *f, const Fpos_t *pos)
2227 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
2228 return fsetpos64(f, pos);
2230 return fsetpos(f, pos);
2237 #undef PerlIO_getpos
2239 PerlIO_getpos(PerlIO *f, Fpos_t *pos)
2241 *pos = PerlIO_tell(f);
2245 #ifndef PERLIO_IS_STDIO
2246 #undef PerlIO_getpos
2248 PerlIO_getpos(PerlIO *f, Fpos_t *pos)
2250 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
2251 return fgetpos64(f, pos);
2253 return fgetpos(f, pos);
2259 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
2262 vprintf(char *pat, char *args)
2264 _doprnt(pat, args, stdout);
2265 return 0; /* wrong, but perl doesn't use the return value */
2269 vfprintf(FILE *fd, char *pat, char *args)
2271 _doprnt(pat, args, fd);
2272 return 0; /* wrong, but perl doesn't use the return value */
2277 #ifndef PerlIO_vsprintf
2279 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
2281 int val = vsprintf(s, fmt, ap);
2284 if (strlen(s) >= (STRLEN)n)
2287 PerlIO_puts(Perl_error_log,"panic: sprintf overflow - memory corrupted!\n");
2295 #ifndef PerlIO_sprintf
2297 PerlIO_sprintf(char *s, int n, const char *fmt,...)
2302 result = PerlIO_vsprintf(s, n, fmt, ap);
2308 #endif /* !PERL_IMPLICIT_SYS */