2000-08-29 04:54:55 +02:00
|
|
|
/* Fmemopen implementation.
|
2014-01-01 12:03:15 +01:00
|
|
|
Copyright (C) 2000-2014 Free Software Foundation, Inc.
|
2000-08-29 04:54:55 +02:00
|
|
|
This file is part of the GNU C Library.
|
2008-08-14 08:37:17 +02:00
|
|
|
Contributed by Hanno Mueller, kontakt@hanno.de, 2000.
|
2000-08-29 04:54:55 +02:00
|
|
|
|
|
|
|
The GNU C Library is free software; you can redistribute it and/or
|
2001-07-06 06:58:11 +02:00
|
|
|
modify it under the terms of the GNU Lesser General Public
|
|
|
|
License as published by the Free Software Foundation; either
|
|
|
|
version 2.1 of the License, or (at your option) any later version.
|
2000-08-29 04:54:55 +02:00
|
|
|
|
|
|
|
The GNU C Library is distributed in the hope that it will be useful,
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
2001-07-06 06:58:11 +02:00
|
|
|
Lesser General Public License for more details.
|
2000-08-29 04:54:55 +02:00
|
|
|
|
2001-07-06 06:58:11 +02:00
|
|
|
You should have received a copy of the GNU Lesser General Public
|
2012-02-10 00:18:22 +01:00
|
|
|
License along with the GNU C Library; if not, see
|
|
|
|
<http://www.gnu.org/licenses/>. */
|
2000-08-29 04:54:55 +02:00
|
|
|
|
|
|
|
/*
|
|
|
|
* fmemopen() - "my" version of a string stream
|
|
|
|
* Hanno Mueller, kontakt@hanno.de
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* I needed fmemopen() for an application that I currently work on,
|
|
|
|
* but couldn't find it in libio. The following snippet of code is an
|
|
|
|
* attempt to implement what glibc's documentation describes.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* I already see some potential problems:
|
|
|
|
*
|
|
|
|
* - I never used the "original" fmemopen(). I am sure that "my"
|
|
|
|
* fmemopen() behaves differently than the original version.
|
|
|
|
*
|
|
|
|
* - The documentation doesn't say wether a string stream allows
|
|
|
|
* seeks. I checked the old fmemopen implementation in glibc's stdio
|
|
|
|
* directory, wasn't quite able to see what is going on in that
|
|
|
|
* source, but as far as I understand there was no seek there. For
|
|
|
|
* my application, I needed fseek() and ftell(), so it's here.
|
|
|
|
*
|
|
|
|
* - "append" mode and fseek(p, SEEK_END) have two different ideas
|
|
|
|
* about the "end" of the stream.
|
|
|
|
*
|
|
|
|
* As described in the documentation, when opening the file in
|
|
|
|
* "append" mode, the position pointer will be set to the first null
|
|
|
|
* character of the string buffer (yet the buffer may already
|
|
|
|
* contain more data). For fseek(), the last byte of the buffer is
|
|
|
|
* used as the end of the stream.
|
|
|
|
*
|
|
|
|
* - It is unclear to me what the documentation tries to say when it
|
|
|
|
* explains what happens when you use fmemopen with a NULL
|
|
|
|
* buffer.
|
|
|
|
*
|
|
|
|
* Quote: "fmemopen [then] allocates an array SIZE bytes long. This
|
|
|
|
* is really only useful if you are going to write things to the
|
|
|
|
* buffer and then read them back in again."
|
|
|
|
*
|
|
|
|
* What does that mean if the original fmemopen() did not allow
|
|
|
|
* seeking? How do you read what you just wrote without seeking back
|
|
|
|
* to the beginning of the stream?
|
|
|
|
*
|
|
|
|
* - I think there should be a second version of fmemopen() that does
|
|
|
|
* not add null characters for each write. (At least in my
|
|
|
|
* application, I am not actually using strings but binary data and
|
|
|
|
* so I don't need the stream to add null characters on its own.)
|
|
|
|
*/
|
|
|
|
|
2000-10-31 06:20:53 +01:00
|
|
|
#include <errno.h>
|
2000-08-29 04:54:55 +02:00
|
|
|
#include <libio.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <stdlib.h>
|
2005-02-02 20:44:07 +01:00
|
|
|
#include <stdint.h>
|
2000-08-29 04:54:55 +02:00
|
|
|
#include <string.h>
|
|
|
|
#include <sys/types.h>
|
Update.
2002-08-04 Jakub Jelinek <jakub@redhat.com>
* manual/debug.texi: Fix spelling to programmatically.
Reported by <hayastan132@hotmail.com>.
* include/libio.h: Add libc_hidden_proto for __uflow.
* include/stdio.h: Map fopen, fdopen, fclose, fputs, fsetpos, and
fgetpos to _IO_* names.
Add libc_hidden_proto for fileno, fwrite, fseek, fflush_unlocked,
fread_unlocked, fwrite_unlocked, fgets_unlocked, fputs_unlocked.
* include/wchar.h: Add libc_hidden_proto for fputws_unlocked,
putwc_unlocked, vswscanf.
* libio/iolibio.h: Add libc_hidden_proto for _IO_fputs.
* libio/fileno.c: Use <stdio.h> and libc_hidden_def.
* libio/fseek.c: Likewise.
* libio/fmemopen.c: Include "libioP.h". Call _IO_fopencookie and
not fopencookie.
* libio/genops.c (__uflow): Add libc_hidden_def.
* libio/iofflush_u.c (fflush_unlocked): Likewise.
* libio/iofgets_u.c (fgets_unlocked): Likewise.
* libio/iofputs_u.c (fputs_unlocked): Likewise.
* libio/iofputws_u.c (fputws_unlocked): Likewise.
* libio/iofread_u.c (fread_unlocked): Likewise.
* libio/iofwrite_u.c (fwrite_unlocked): Likewise.
* libio/iovswscanf.c (vswscanf): Likewise.
* libio/putwc_u.c (putwc_unlocked): Likewise.
* libio/iofputs.c: Use libc_hidden_def instead of INTDEF.
* malloc/malloc.c: Redirect fwrite calls to _IO_fwrite.
* malloc/mtrace.c: Likewise.
* sunrpc/clnt_perr.c: Remove fputs macro.
* sunrpc/svc_simple.c: Likewise.
* sunrpc/svc_tcp.c: Likewise.
* sunrpc/svc_udp.c: Likewise.
* sunrpc/xdr_rec.c: Likewise.
* sunrpc/xdr_ref.c: Likewise.
* iconv/Makefile: Add CPPFLAGS definitions with -DNOT_in_libc for
iconv_prog, linereader, and charmap-dir.
* locale/Makefile: Likewise for locale and charmap-dir.
* malloc/Makefile: Likewise for memusagestat.
* nscd/Makefile: Likewise for nscd, nscd_conf, and dbg_log.
* sunrpc/Makefile: Likewise for rpc_main.
* sysdeps/unix/sysv/linux/Makefile: Likewise for lddlibc4.
* timezone/Makefile: Likewise for zic.
* stdio-common/perror.c: Avoid multiple calls to fileno_unlocked.
2002-08-04 22:54:20 +02:00
|
|
|
#include "libioP.h"
|
|
|
|
|
2000-08-29 04:54:55 +02:00
|
|
|
|
|
|
|
typedef struct fmemopen_cookie_struct fmemopen_cookie_t;
|
|
|
|
struct fmemopen_cookie_struct
|
|
|
|
{
|
|
|
|
char *buffer;
|
|
|
|
int mybuffer;
|
2008-08-14 08:37:17 +02:00
|
|
|
int binmode;
|
2000-08-29 04:54:55 +02:00
|
|
|
size_t size;
|
|
|
|
_IO_off64_t pos;
|
|
|
|
size_t maxpos;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2000-12-15 17:03:57 +01:00
|
|
|
static ssize_t
|
2000-08-29 04:54:55 +02:00
|
|
|
fmemopen_read (void *cookie, char *b, size_t s)
|
|
|
|
{
|
|
|
|
fmemopen_cookie_t *c;
|
|
|
|
|
|
|
|
c = (fmemopen_cookie_t *) cookie;
|
|
|
|
|
2000-09-01 23:16:28 +02:00
|
|
|
if (c->pos + s > c->size)
|
2000-08-29 04:54:55 +02:00
|
|
|
{
|
2002-08-25 06:51:08 +02:00
|
|
|
if ((size_t) c->pos == c->size)
|
2000-10-31 06:20:53 +01:00
|
|
|
return 0;
|
2000-08-29 04:54:55 +02:00
|
|
|
s = c->size - c->pos;
|
|
|
|
}
|
|
|
|
|
|
|
|
memcpy (b, &(c->buffer[c->pos]), s);
|
|
|
|
|
|
|
|
c->pos += s;
|
2002-08-25 06:51:08 +02:00
|
|
|
if ((size_t) c->pos > c->maxpos)
|
2000-08-29 04:54:55 +02:00
|
|
|
c->maxpos = c->pos;
|
|
|
|
|
|
|
|
return s;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-12-15 17:03:57 +01:00
|
|
|
static ssize_t
|
2000-08-29 04:54:55 +02:00
|
|
|
fmemopen_write (void *cookie, const char *b, size_t s)
|
|
|
|
{
|
|
|
|
fmemopen_cookie_t *c;
|
|
|
|
int addnullc;
|
|
|
|
|
|
|
|
c = (fmemopen_cookie_t *) cookie;
|
|
|
|
|
2008-08-14 08:37:17 +02:00
|
|
|
addnullc = c->binmode == 0 && (s == 0 || b[s - 1] != '\0');
|
2000-08-29 04:54:55 +02:00
|
|
|
|
2000-09-01 23:16:28 +02:00
|
|
|
if (c->pos + s + addnullc > c->size)
|
2000-08-29 04:54:55 +02:00
|
|
|
{
|
2002-08-25 06:51:08 +02:00
|
|
|
if ((size_t) (c->pos + addnullc) == c->size)
|
2000-10-31 06:20:53 +01:00
|
|
|
{
|
|
|
|
__set_errno (ENOSPC);
|
2005-09-23 18:36:09 +02:00
|
|
|
return 0;
|
2000-10-31 06:20:53 +01:00
|
|
|
}
|
2000-08-29 04:54:55 +02:00
|
|
|
s = c->size - c->pos - addnullc;
|
|
|
|
}
|
|
|
|
|
|
|
|
memcpy (&(c->buffer[c->pos]), b, s);
|
|
|
|
|
|
|
|
c->pos += s;
|
2002-08-25 06:51:08 +02:00
|
|
|
if ((size_t) c->pos > c->maxpos)
|
2000-08-29 04:54:55 +02:00
|
|
|
{
|
|
|
|
c->maxpos = c->pos;
|
|
|
|
if (addnullc)
|
|
|
|
c->buffer[c->maxpos] = '\0';
|
|
|
|
}
|
|
|
|
|
|
|
|
return s;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-12-15 17:03:57 +01:00
|
|
|
static int
|
2000-10-31 06:20:53 +01:00
|
|
|
fmemopen_seek (void *cookie, _IO_off64_t *p, int w)
|
2000-08-29 04:54:55 +02:00
|
|
|
{
|
|
|
|
_IO_off64_t np;
|
|
|
|
fmemopen_cookie_t *c;
|
|
|
|
|
|
|
|
c = (fmemopen_cookie_t *) cookie;
|
|
|
|
|
|
|
|
switch (w)
|
|
|
|
{
|
|
|
|
case SEEK_SET:
|
|
|
|
np = *p;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case SEEK_CUR:
|
|
|
|
np = c->pos + *p;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case SEEK_END:
|
2008-08-14 08:37:17 +02:00
|
|
|
np = (c->binmode ? c->size : c->maxpos) - *p;
|
2000-08-29 04:54:55 +02:00
|
|
|
break;
|
|
|
|
|
2000-09-01 23:16:28 +02:00
|
|
|
default:
|
|
|
|
return -1;
|
2000-08-29 04:54:55 +02:00
|
|
|
}
|
|
|
|
|
2002-08-25 06:51:08 +02:00
|
|
|
if (np < 0 || (size_t) np > c->size)
|
2000-08-29 04:54:55 +02:00
|
|
|
return -1;
|
|
|
|
|
2005-01-06 01:42:22 +01:00
|
|
|
*p = c->pos = np;
|
2000-08-29 04:54:55 +02:00
|
|
|
|
2005-01-06 01:42:22 +01:00
|
|
|
return 0;
|
2000-08-29 04:54:55 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-12-15 17:03:57 +01:00
|
|
|
static int
|
2000-08-29 04:54:55 +02:00
|
|
|
fmemopen_close (void *cookie)
|
|
|
|
{
|
|
|
|
fmemopen_cookie_t *c;
|
|
|
|
|
|
|
|
c = (fmemopen_cookie_t *) cookie;
|
|
|
|
|
2000-09-02 17:05:15 +02:00
|
|
|
if (c->mybuffer)
|
|
|
|
free (c->buffer);
|
2000-08-29 04:54:55 +02:00
|
|
|
free (c);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
FILE *
|
|
|
|
fmemopen (void *buf, size_t len, const char *mode)
|
|
|
|
{
|
|
|
|
cookie_io_functions_t iof;
|
|
|
|
fmemopen_cookie_t *c;
|
|
|
|
|
2006-04-07 06:29:25 +02:00
|
|
|
if (__builtin_expect (len == 0, 0))
|
2005-01-06 03:09:15 +01:00
|
|
|
{
|
|
|
|
einval:
|
|
|
|
__set_errno (EINVAL);
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2000-08-29 04:54:55 +02:00
|
|
|
c = (fmemopen_cookie_t *) malloc (sizeof (fmemopen_cookie_t));
|
|
|
|
if (c == NULL)
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
c->mybuffer = (buf == NULL);
|
|
|
|
|
|
|
|
if (c->mybuffer)
|
|
|
|
{
|
|
|
|
c->buffer = (char *) malloc (len);
|
|
|
|
if (c->buffer == NULL)
|
|
|
|
{
|
|
|
|
free (c);
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
c->buffer[0] = '\0';
|
2011-03-04 06:49:46 +01:00
|
|
|
c->maxpos = 0;
|
2000-08-29 04:54:55 +02:00
|
|
|
}
|
|
|
|
else
|
2005-01-06 03:09:15 +01:00
|
|
|
{
|
2006-04-07 06:29:25 +02:00
|
|
|
if (__builtin_expect ((uintptr_t) len > -(uintptr_t) buf, 0))
|
|
|
|
{
|
|
|
|
free (c);
|
|
|
|
goto einval;
|
|
|
|
}
|
2005-01-06 03:09:15 +01:00
|
|
|
|
|
|
|
c->buffer = buf;
|
2000-08-29 04:54:55 +02:00
|
|
|
|
2011-03-04 06:49:46 +01:00
|
|
|
if (mode[0] == 'w')
|
|
|
|
c->buffer[0] = '\0';
|
2000-08-29 04:54:55 +02:00
|
|
|
|
2011-03-04 06:49:46 +01:00
|
|
|
c->maxpos = strnlen (c->buffer, len);
|
|
|
|
}
|
2000-08-29 04:54:55 +02:00
|
|
|
|
2011-03-04 06:49:46 +01:00
|
|
|
c->size = len;
|
2000-08-29 04:54:55 +02:00
|
|
|
|
|
|
|
if (mode[0] == 'a')
|
2000-09-01 23:16:28 +02:00
|
|
|
c->pos = c->maxpos;
|
2000-08-29 04:54:55 +02:00
|
|
|
else
|
2000-09-01 23:16:28 +02:00
|
|
|
c->pos = 0;
|
2000-08-29 04:54:55 +02:00
|
|
|
|
2008-08-14 08:37:17 +02:00
|
|
|
c->binmode = mode[0] != '\0' && mode[1] == 'b';
|
|
|
|
|
2000-08-29 04:54:55 +02:00
|
|
|
iof.read = fmemopen_read;
|
|
|
|
iof.write = fmemopen_write;
|
|
|
|
iof.seek = fmemopen_seek;
|
|
|
|
iof.close = fmemopen_close;
|
|
|
|
|
Update.
2002-08-04 Jakub Jelinek <jakub@redhat.com>
* manual/debug.texi: Fix spelling to programmatically.
Reported by <hayastan132@hotmail.com>.
* include/libio.h: Add libc_hidden_proto for __uflow.
* include/stdio.h: Map fopen, fdopen, fclose, fputs, fsetpos, and
fgetpos to _IO_* names.
Add libc_hidden_proto for fileno, fwrite, fseek, fflush_unlocked,
fread_unlocked, fwrite_unlocked, fgets_unlocked, fputs_unlocked.
* include/wchar.h: Add libc_hidden_proto for fputws_unlocked,
putwc_unlocked, vswscanf.
* libio/iolibio.h: Add libc_hidden_proto for _IO_fputs.
* libio/fileno.c: Use <stdio.h> and libc_hidden_def.
* libio/fseek.c: Likewise.
* libio/fmemopen.c: Include "libioP.h". Call _IO_fopencookie and
not fopencookie.
* libio/genops.c (__uflow): Add libc_hidden_def.
* libio/iofflush_u.c (fflush_unlocked): Likewise.
* libio/iofgets_u.c (fgets_unlocked): Likewise.
* libio/iofputs_u.c (fputs_unlocked): Likewise.
* libio/iofputws_u.c (fputws_unlocked): Likewise.
* libio/iofread_u.c (fread_unlocked): Likewise.
* libio/iofwrite_u.c (fwrite_unlocked): Likewise.
* libio/iovswscanf.c (vswscanf): Likewise.
* libio/putwc_u.c (putwc_unlocked): Likewise.
* libio/iofputs.c: Use libc_hidden_def instead of INTDEF.
* malloc/malloc.c: Redirect fwrite calls to _IO_fwrite.
* malloc/mtrace.c: Likewise.
* sunrpc/clnt_perr.c: Remove fputs macro.
* sunrpc/svc_simple.c: Likewise.
* sunrpc/svc_tcp.c: Likewise.
* sunrpc/svc_udp.c: Likewise.
* sunrpc/xdr_rec.c: Likewise.
* sunrpc/xdr_ref.c: Likewise.
* iconv/Makefile: Add CPPFLAGS definitions with -DNOT_in_libc for
iconv_prog, linereader, and charmap-dir.
* locale/Makefile: Likewise for locale and charmap-dir.
* malloc/Makefile: Likewise for memusagestat.
* nscd/Makefile: Likewise for nscd, nscd_conf, and dbg_log.
* sunrpc/Makefile: Likewise for rpc_main.
* sysdeps/unix/sysv/linux/Makefile: Likewise for lddlibc4.
* timezone/Makefile: Likewise for zic.
* stdio-common/perror.c: Avoid multiple calls to fileno_unlocked.
2002-08-04 22:54:20 +02:00
|
|
|
return _IO_fopencookie (c, mode, iof);
|
2000-08-29 04:54:55 +02:00
|
|
|
}
|
2009-03-10 16:26:57 +01:00
|
|
|
libc_hidden_def (fmemopen)
|