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--)
255 PerlIO_cleantable(&_perlio);
259 PerlIO_pop(PerlIO *f)
264 (*l->tab->Popped)(f);
272 PerlIO_close(PerlIO *f)
274 int code = (*PerlIOBase(f)->tab->Close)(f);
283 /*--------------------------------------------------------------------------------------*/
284 /* Given the abstraction above the public API functions */
288 PerlIO_fileno(PerlIO *f)
290 return (*PerlIOBase(f)->tab->Fileno)(f);
294 extern PerlIO_funcs PerlIO_unix;
295 extern PerlIO_funcs PerlIO_perlio;
296 extern PerlIO_funcs PerlIO_stdio;
298 extern PerlIO_funcs PerlIO_mmap;
305 char *s = GvNAME(gv);
306 STRLEN l = GvNAMELEN(gv);
307 PerlIO_debug("%.*s\n",(int) l,s);
311 XS(XS_perlio_unimport)
315 char *s = GvNAME(gv);
316 STRLEN l = GvNAMELEN(gv);
317 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) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
1344 PerlIOStdio_set_ptrcnt
1345 #else /* STDIO_PTR_LVALUE */
1347 #endif /* STDIO_PTR_LVALUE */
1348 #else /* USE_STDIO_PTR */
1352 #endif /* USE_STDIO_PTR */
1355 #undef PerlIO_exportFILE
1357 PerlIO_exportFILE(PerlIO *f, int fl)
1360 /* Should really push stdio discipline when we have them */
1361 return fdopen(PerlIO_fileno(f),"r+");
1364 #undef PerlIO_findFILE
1366 PerlIO_findFILE(PerlIO *f)
1368 return PerlIO_exportFILE(f,0);
1371 #undef PerlIO_releaseFILE
1373 PerlIO_releaseFILE(PerlIO *p, FILE *f)
1377 /*--------------------------------------------------------------------------------------*/
1378 /* perlio buffer layer */
1382 struct _PerlIO base;
1383 Off_t posn; /* Offset of buf into the file */
1384 STDCHAR * buf; /* Start of buffer */
1385 STDCHAR * end; /* End of valid part of buffer */
1386 STDCHAR * ptr; /* Current position in buffer */
1387 Size_t bufsiz; /* Size of buffer */
1388 IV oneword; /* Emergency buffer */
1393 PerlIOBuf_fdopen(PerlIO_funcs *self, int fd, const char *mode)
1395 PerlIO_funcs *tab = PerlIO_default_btm();
1403 f = (*tab->Fdopen)(tab,fd,mode);
1406 /* Initial stderr is unbuffered */
1407 if (!init || fd != 2)
1409 PerlIOBuf *b = PerlIOSelf(PerlIO_push(f,self,NULL),PerlIOBuf);
1410 b->posn = PerlIO_tell(PerlIONext(f));
1417 PerlIOBuf_open(PerlIO_funcs *self, const char *path, const char *mode)
1419 PerlIO_funcs *tab = PerlIO_default_btm();
1420 PerlIO *f = (*tab->Open)(tab,path,mode);
1423 PerlIOBuf *b = PerlIOSelf(PerlIO_push(f,self,NULL),PerlIOBuf);
1430 PerlIOBase_reopen(const char *path, const char *mode, PerlIO *f)
1432 return (*PerlIOBase(f)->tab->Reopen)(path,mode,PerlIONext(f));
1435 /* This "flush" is akin to sfio's sync in that it handles files in either
1439 PerlIOBuf_flush(PerlIO *f)
1441 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1443 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
1445 /* write() the buffer */
1446 STDCHAR *p = b->buf;
1450 count = PerlIO_write(PerlIONext(f),p,b->ptr - p);
1457 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
1462 b->posn += (p - b->buf);
1464 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
1466 /* Note position change */
1467 b->posn += (b->ptr - b->buf);
1468 if (b->ptr < b->end)
1470 /* We did not consume all of it */
1471 if (PerlIO_seek(PerlIONext(f),b->posn,SEEK_SET) == 0)
1473 b->posn = PerlIO_tell(PerlIONext(f));
1477 b->ptr = b->end = b->buf;
1478 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF|PERLIO_F_WRBUF);
1479 if (PerlIO_flush(PerlIONext(f)) != 0)
1485 PerlIOBuf_fill(PerlIO *f)
1487 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1489 if (PerlIO_flush(f) != 0)
1491 b->ptr = b->end = b->buf;
1492 avail = PerlIO_read(PerlIONext(f),b->ptr,b->bufsiz);
1496 PerlIOBase(f)->flags |= PERLIO_F_EOF;
1498 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
1501 b->end = b->buf+avail;
1502 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
1507 PerlIOBuf_read(PerlIO *f, void *vbuf, Size_t count)
1509 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1510 STDCHAR *buf = (STDCHAR *) vbuf;
1516 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD))
1520 SSize_t avail = (b->end - b->ptr);
1521 if ((SSize_t) count < avail)
1525 Copy(b->ptr,buf,avail,char);
1531 if (count && (b->ptr >= b->end))
1533 if (PerlIO_fill(f) != 0)
1543 PerlIOBuf_unread(PerlIO *f, const void *vbuf, Size_t count)
1545 const STDCHAR *buf = (const STDCHAR *) vbuf+count;
1546 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1549 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
1555 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
1557 avail = (b->ptr - b->buf);
1558 if (avail > (SSize_t) count)
1565 if (avail > (SSize_t) count)
1567 b->end = b->ptr + avail;
1574 Copy(buf,b->ptr,avail,char);
1578 PerlIOBase(f)->flags &= ~ PERLIO_F_EOF;
1585 PerlIOBuf_write(PerlIO *f, const void *vbuf, Size_t count)
1587 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1588 const STDCHAR *buf = (const STDCHAR *) vbuf;
1592 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
1596 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
1597 if ((SSize_t) count < avail)
1599 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
1600 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF)
1620 Copy(buf,b->ptr,avail,char);
1627 if (b->ptr >= (b->buf + b->bufsiz))
1634 PerlIOBuf_seek(PerlIO *f, Off_t offset, int whence)
1636 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1637 int code = PerlIO_flush(f);
1640 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
1641 code = PerlIO_seek(PerlIONext(f),offset,whence);
1644 b->posn = PerlIO_tell(PerlIONext(f));
1645 PerlIO_debug(__FUNCTION__ " f=%p posn=%ld\n",f,(long) b->posn);
1649 PerlIO_debug(__FUNCTION__ " f=%p code%d\n",f,code);
1654 PerlIOBuf_tell(PerlIO *f)
1656 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1657 Off_t posn = b->posn;
1659 posn += (b->ptr - b->buf);
1660 PerlIO_debug(__FUNCTION__ " f=%p posn=%ld\n",f,(long) posn);
1665 PerlIOBuf_close(PerlIO *f)
1667 IV code = PerlIOBase_close(f);
1668 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1669 if (b->buf && b->buf != (STDCHAR *) &b->oneword)
1674 b->ptr = b->end = b->buf;
1675 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF|PERLIO_F_WRBUF);
1680 PerlIOBuf_setlinebuf(PerlIO *f)
1684 PerlIOBase(f)->flags &= ~PERLIO_F_LINEBUF;
1689 PerlIOBuf_set_cnt(PerlIO *f, int cnt)
1691 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1695 b->ptr = b->end - cnt;
1696 assert(b->ptr >= b->buf);
1700 PerlIOBuf_get_ptr(PerlIO *f)
1702 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1709 PerlIOBuf_get_cnt(PerlIO *f)
1711 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1714 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
1715 return (b->end - b->ptr);
1720 PerlIOBuf_get_base(PerlIO *f)
1722 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1727 New('B',b->buf,b->bufsiz,STDCHAR);
1730 b->buf = (STDCHAR *)&b->oneword;
1731 b->bufsiz = sizeof(b->oneword);
1740 PerlIOBuf_bufsiz(PerlIO *f)
1742 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1745 return (b->end - b->buf);
1749 PerlIOBuf_set_ptrcnt(PerlIO *f, STDCHAR *ptr, SSize_t cnt)
1751 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1755 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf)
1758 assert(PerlIO_get_cnt(f) == cnt);
1759 assert(b->ptr >= b->buf);
1761 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
1764 PerlIO_funcs PerlIO_perlio = {
1784 PerlIOBase_clearerr,
1785 PerlIOBuf_setlinebuf,
1790 PerlIOBuf_set_ptrcnt,
1794 /*--------------------------------------------------------------------------------------*/
1795 /* mmap as "buffer" layer */
1799 PerlIOBuf base; /* PerlIOBuf stuff */
1800 Size_t len; /* mapped length */
1801 STDCHAR *bbuf; /* malloced buffer if map fails */
1805 PerlIOMmap_map(PerlIO *f)
1807 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1808 PerlIOBuf *b = &m->base;
1809 IV flags = PerlIOBase(f)->flags;
1813 if (flags & PERLIO_F_CANREAD)
1815 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1816 int fd = PerlIO_fileno(f);
1818 code = fstat(fd,&st);
1819 if (code == 0 && S_ISREG(st.st_mode))
1821 SSize_t len = st.st_size - b->posn;
1824 b->buf = (STDCHAR *) mmap(NULL, len, PROT_READ, MAP_PRIVATE, fd, b->posn);
1825 PerlIO_debug(__FUNCTION__ " f=%p b=%p for %ld @ %ld\n",
1826 f, b->buf, (long) len, (long) b->posn);
1827 if (b->buf && b->buf != (STDCHAR *) -1)
1829 #if defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
1830 madvise(b->buf, len, MADV_SEQUENTIAL);
1832 PerlIOBase(f)->flags = flags | PERLIO_F_RDBUF;
1833 b->end = b->buf+len;
1844 PerlIOBase(f)->flags = flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
1846 b->ptr = b->end = b->ptr;
1855 PerlIOMmap_unmap(PerlIO *f)
1857 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1858 PerlIOBuf *b = &m->base;
1864 code = munmap((Mmap_t) b->buf, m->len);
1867 if (PerlIO_seek(PerlIONext(f),b->posn,SEEK_SET) != 0)
1869 PerlIO_debug(__FUNCTION__ " f=%p b=%p c=%ld posn=%ld\n",
1870 f,b->buf,(long)m->len,(long) b->posn);
1872 b->ptr = b->end = b->buf;
1873 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF|PERLIO_F_WRBUF);
1879 PerlIOMmap_get_base(PerlIO *f)
1881 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1882 PerlIOBuf *b = &m->base;
1883 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF))
1885 /* Already have a readbuffer in progress */
1890 /* We have a write buffer or flushed PerlIOBuf read buffer */
1891 m->bbuf = b->buf; /* save it in case we need it again */
1892 b->buf = NULL; /* Clear to trigger below */
1896 PerlIOMmap_map(f); /* Try and map it */
1899 /* Map did not work - recover PerlIOBuf buffer if we have one */
1903 b->ptr = b->end = b->buf;
1906 return PerlIOBuf_get_base(f);
1910 PerlIOMmap_unread(PerlIO *f, const void *vbuf, Size_t count)
1912 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1913 PerlIOBuf *b = &m->base;
1914 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
1916 if (b->ptr && (b->ptr - count) >= b->buf && memEQ(b->ptr - count,vbuf,count))
1919 PerlIOBase(f)->flags &= ~ PERLIO_F_EOF;
1924 PerlIO_debug(__FUNCTION__ " f=%p %d '%.*s'\n",f,count,count,(char *)vbuf);
1927 return PerlIOBuf_unread(f,vbuf,count);
1931 PerlIOMmap_write(PerlIO *f, const void *vbuf, Size_t count)
1933 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1934 PerlIOBuf *b = &m->base;
1935 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF))
1937 /* No, or wrong sort of, buffer */
1940 if (PerlIOMmap_unmap(f) != 0)
1943 /* If unmap took the "buffer" see if we have one from before */
1944 if (!b->buf && m->bbuf)
1948 PerlIOBuf_get_base(f);
1952 return PerlIOBuf_write(f,vbuf,count);
1956 PerlIOMmap_flush(PerlIO *f)
1958 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
1959 PerlIOBuf *b = &m->base;
1960 IV code = PerlIOBuf_flush(f);
1961 /* Now we are "synced" at PerlIOBuf level */
1966 /* Unmap the buffer */
1967 if (PerlIOMmap_unmap(f) != 0)
1972 /* We seem to have a PerlIOBuf buffer which was not mapped
1973 * remember it in case we need one later
1979 PerlIO_debug(__FUNCTION__ " f=%p %d\n",f,code);
1984 PerlIOMmap_fill(PerlIO *f)
1986 PerlIOBuf *b = PerlIOSelf(f,PerlIOBuf);
1987 IV code = PerlIO_flush(f);
1988 PerlIO_debug(__FUNCTION__ " f=%p flush posn=%ld\n",f,(long)b->posn);
1989 if (code == 0 && !b->buf)
1991 code = PerlIOMmap_map(f);
1992 PerlIO_debug(__FUNCTION__ " f=%p mmap code=%d posn=%ld\n",f,code,(long)b->posn);
1994 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF))
1996 code = PerlIOBuf_fill(f);
1997 PerlIO_debug(__FUNCTION__ " f=%p fill code=%d posn=%ld\n",f,code,(long)b->posn);
2003 PerlIOMmap_close(PerlIO *f)
2005 PerlIOMmap *m = PerlIOSelf(f,PerlIOMmap);
2006 PerlIOBuf *b = &m->base;
2007 IV code = PerlIO_flush(f);
2012 b->ptr = b->end = b->buf;
2014 if (PerlIOBuf_close(f) != 0)
2016 PerlIO_debug(__FUNCTION__ " f=%p %d\n",f,code);
2021 PerlIO_funcs PerlIO_mmap = {
2041 PerlIOBase_clearerr,
2042 PerlIOBuf_setlinebuf,
2043 PerlIOMmap_get_base,
2047 PerlIOBuf_set_ptrcnt,
2050 #endif /* HAS_MMAP */
2059 atexit(&PerlIO_cleanup);
2068 PerlIO_stdstreams();
2072 #undef PerlIO_stdout
2077 PerlIO_stdstreams();
2081 #undef PerlIO_stderr
2086 PerlIO_stdstreams();
2090 /*--------------------------------------------------------------------------------------*/
2092 #undef PerlIO_getname
2094 PerlIO_getname(PerlIO *f, char *buf)
2097 Perl_croak(aTHX_ "Don't know how to get file name");
2102 /*--------------------------------------------------------------------------------------*/
2103 /* Functions which can be called on any kind of PerlIO implemented
2109 PerlIO_getc(PerlIO *f)
2112 SSize_t count = PerlIO_read(f,buf,1);
2115 return (unsigned char) buf[0];
2120 #undef PerlIO_ungetc
2122 PerlIO_ungetc(PerlIO *f, int ch)
2127 if (PerlIO_unread(f,&buf,1) == 1)
2135 PerlIO_putc(PerlIO *f, int ch)
2138 return PerlIO_write(f,&buf,1);
2143 PerlIO_puts(PerlIO *f, const char *s)
2145 STRLEN len = strlen(s);
2146 return PerlIO_write(f,s,len);
2149 #undef PerlIO_rewind
2151 PerlIO_rewind(PerlIO *f)
2153 PerlIO_seek(f,(Off_t)0,SEEK_SET);
2157 #undef PerlIO_vprintf
2159 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
2162 SV *sv = newSVpvn("",0);
2165 sv_vcatpvf(sv, fmt, &ap);
2167 return PerlIO_write(f,s,len);
2170 #undef PerlIO_printf
2172 PerlIO_printf(PerlIO *f,const char *fmt,...)
2177 result = PerlIO_vprintf(f,fmt,ap);
2182 #undef PerlIO_stdoutf
2184 PerlIO_stdoutf(const char *fmt,...)
2189 result = PerlIO_vprintf(PerlIO_stdout(),fmt,ap);
2194 #undef PerlIO_tmpfile
2196 PerlIO_tmpfile(void)
2199 /* I have no idea how portable mkstemp() is ... */
2200 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX",0);
2201 int fd = mkstemp(SvPVX(sv));
2205 f = PerlIO_fdopen(fd,"w+");
2208 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
2219 #endif /* USE_SFIO */
2220 #endif /* PERLIO_IS_STDIO */
2222 /*======================================================================================*/
2223 /* Now some functions in terms of above which may be needed even if
2224 we are not in true PerlIO mode
2228 #undef PerlIO_setpos
2230 PerlIO_setpos(PerlIO *f, const Fpos_t *pos)
2232 return PerlIO_seek(f,*pos,0);
2235 #ifndef PERLIO_IS_STDIO
2236 #undef PerlIO_setpos
2238 PerlIO_setpos(PerlIO *f, const Fpos_t *pos)
2240 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
2241 return fsetpos64(f, pos);
2243 return fsetpos(f, pos);
2250 #undef PerlIO_getpos
2252 PerlIO_getpos(PerlIO *f, Fpos_t *pos)
2254 *pos = PerlIO_tell(f);
2258 #ifndef PERLIO_IS_STDIO
2259 #undef PerlIO_getpos
2261 PerlIO_getpos(PerlIO *f, Fpos_t *pos)
2263 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
2264 return fgetpos64(f, pos);
2266 return fgetpos(f, pos);
2272 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
2275 vprintf(char *pat, char *args)
2277 _doprnt(pat, args, stdout);
2278 return 0; /* wrong, but perl doesn't use the return value */
2282 vfprintf(FILE *fd, char *pat, char *args)
2284 _doprnt(pat, args, fd);
2285 return 0; /* wrong, but perl doesn't use the return value */
2290 #ifndef PerlIO_vsprintf
2292 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
2294 int val = vsprintf(s, fmt, ap);
2297 if (strlen(s) >= (STRLEN)n)
2300 PerlIO_puts(Perl_error_log,"panic: sprintf overflow - memory corrupted!\n");
2308 #ifndef PerlIO_sprintf
2310 PerlIO_sprintf(char *s, int n, const char *fmt,...)
2315 result = PerlIO_vsprintf(s, n, fmt, ap);
2321 #endif /* !PERL_IMPLICIT_SYS */