14#include "ruby/internal/config.h"
25# if defined(__linux__)
28# if defined(__FreeBSD_version) && __FreeBSD_version >= 1100000
38#define free(x) xfree(x)
40#if defined(DOSISH) || defined(__CYGWIN__)
45#if defined HAVE_NET_SOCKET_H
46# include <net/socket.h>
47#elif defined HAVE_SYS_SOCKET_H
48# include <sys/socket.h>
51#if defined(__BOW__) || defined(__CYGWIN__) || defined(_WIN32)
52# define NO_SAFE_RENAME
55#if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) || defined(__sun) || defined(_nec_ews)
64#if defined(HAVE_SYS_IOCTL_H) && !defined(_WIN32)
67#if defined(HAVE_FCNTL_H) || defined(_WIN32)
69#elif defined(HAVE_SYS_FCNTL_H)
79#if defined(HAVE_SYS_PARAM_H) || defined(__HIUX_MPP__)
80# include <sys/param.h>
93#elif defined HAVE_SYS_SYSCALL_H
94#include <sys/syscall.h>
101#ifdef HAVE_SYS_WAIT_H
102# include <sys/wait.h>
105#ifdef HAVE_COPYFILE_H
106# include <copyfile.h>
108# ifndef COPYFILE_STATE_COPIED
114# undef HAVE_FCOPYFILE
120#include "ccan/list/list.h"
125#include "internal/class.h"
126#include "internal/encoding.h"
127#include "internal/error.h"
128#include "internal/inits.h"
129#include "internal/io.h"
130#include "internal/numeric.h"
131#include "internal/object.h"
132#include "internal/process.h"
133#include "internal/thread.h"
134#include "internal/transcode.h"
135#include "internal/variable.h"
138#include "ruby/missing.h"
141#include "ruby_atomic.h"
151#define O_ACCMODE (O_RDONLY | O_WRONLY | O_RDWR)
155# ifdef _POSIX_PIPE_BUF
156# define PIPE_BUF _POSIX_PIPE_BUF
163# define EWOULDBLOCK EAGAIN
166#if defined(HAVE___SYSCALL) && (defined(__APPLE__) || defined(__OpenBSD__))
168off_t __syscall(quad_t number, ...);
171#define IO_RBUF_CAPA_MIN 8192
172#define IO_CBUF_CAPA_MIN (128*1024)
173#define IO_RBUF_CAPA_FOR(fptr) (NEED_READCONV(fptr) ? IO_CBUF_CAPA_MIN : IO_RBUF_CAPA_MIN)
174#define IO_WBUF_CAPA_MIN 8192
176#define IO_MAX_BUFFER_GROWTH 8 * 1024 * 1024
181#define open rb_w32_uopen
183#define rename(f, t) rb_w32_urename((f), (t))
184#include "win32/file.h"
194static VALUE rb_eEAGAINWaitReadable;
195static VALUE rb_eEAGAINWaitWritable;
196static VALUE rb_eEWOULDBLOCKWaitReadable;
197static VALUE rb_eEWOULDBLOCKWaitWritable;
198static VALUE rb_eEINPROGRESSWaitWritable;
199static VALUE rb_eEINPROGRESSWaitReadable;
202static VALUE orig_stdout, orig_stderr;
211static ID id_write, id_read, id_getc, id_flush, id_readpartial, id_set_encoding, id_fileno;
212static VALUE sym_mode, sym_perm, sym_flags, sym_extenc, sym_intenc, sym_encoding, sym_open_args;
213static VALUE sym_textmode, sym_binmode, sym_autoclose;
214static VALUE sym_SET, sym_CUR, sym_END;
215static VALUE sym_wait_readable, sym_wait_writable;
217static VALUE sym_DATA;
220static VALUE sym_HOLE;
223static VALUE prep_io(
int fd,
enum rb_io_mode fmode,
VALUE klass,
const char *path);
226rb_io_blocking_region_wait(
struct rb_io *io, rb_blocking_function_t *function,
void *argument,
enum rb_io_event events)
228 return rb_thread_io_blocking_call(io, function, argument, events);
231VALUE rb_io_blocking_region(
struct rb_io *io, rb_blocking_function_t *function,
void *argument)
233 return rb_io_blocking_region_wait(io, function, argument, 0);
237 VALUE filename, current_file;
243 int8_t init_p, next_p, binmode;
254 if (fd < 0 || afd <= max_fd)
257#if defined(HAVE_FCNTL) && defined(F_GETFL)
258 err = fcntl(fd, F_GETFL) == -1;
262 err = fstat(fd, &buf) != 0;
265 if (err &&
errno == EBADF) {
266 rb_bug(
"rb_update_max_fd: invalid fd (%d) given.", fd);
269 while (max_fd < afd) {
270 max_fd = ATOMIC_CAS(max_file_descriptor, max_fd, afd);
275rb_maygvl_fd_fix_cloexec(
int fd)
278#if defined(HAVE_FCNTL) && defined(F_GETFD) && defined(F_SETFD) && defined(FD_CLOEXEC)
279 int flags, flags2, ret;
280 flags = fcntl(fd, F_GETFD);
282 rb_bug(
"rb_maygvl_fd_fix_cloexec: fcntl(%d, F_GETFD) failed: %s", fd, strerror(
errno));
285 flags2 = flags & ~FD_CLOEXEC;
287 flags2 = flags | FD_CLOEXEC;
288 if (flags != flags2) {
289 ret = fcntl(fd, F_SETFD, flags2);
291 rb_bug(
"rb_maygvl_fd_fix_cloexec: fcntl(%d, F_SETFD, %d) failed: %s", fd, flags2, strerror(
errno));
300 rb_maygvl_fd_fix_cloexec(fd);
306rb_fix_detect_o_cloexec(
int fd)
308#if defined(O_CLOEXEC) && defined(F_GETFD)
309 int flags = fcntl(fd, F_GETFD);
312 rb_bug(
"rb_fix_detect_o_cloexec: fcntl(%d, F_GETFD) failed: %s", fd, strerror(
errno));
314 if (flags & FD_CLOEXEC)
317 rb_maygvl_fd_fix_cloexec(fd);
324 return (e == EWOULDBLOCK) || (e == EAGAIN);
331 static int o_cloexec_state = -1;
333 static const int retry_interval = 0;
334 static const int retry_max_count = 10000;
341#elif defined O_NOINHERIT
342 flags |= O_NOINHERIT;
345 while ((ret = open(pathname, flags, mode)) == -1) {
347 if (!io_again_p(e))
break;
348 if (retry_count++ >= retry_max_count)
break;
350 sleep(retry_interval);
353 if (ret < 0)
return ret;
354 if (ret <= 2 || o_cloexec_state == 0) {
355 rb_maygvl_fd_fix_cloexec(ret);
357 else if (o_cloexec_state > 0) {
361 o_cloexec_state = rb_fix_detect_o_cloexec(ret);
380 if (oldfd == newfd) {
384#if defined(HAVE_DUP3) && defined(O_CLOEXEC)
385 static int try_dup3 = 1;
386 if (2 < newfd && try_dup3) {
387 ret = dup3(oldfd, newfd, O_CLOEXEC);
391 if (
errno == ENOSYS) {
393 ret = dup2(oldfd, newfd);
397 ret = dup2(oldfd, newfd);
400 ret = dup2(oldfd, newfd);
402 if (ret < 0)
return ret;
404 rb_maygvl_fd_fix_cloexec(ret);
409rb_fd_set_nonblock(
int fd)
412 return rb_w32_set_nonblock(fd);
413#elif defined(F_GETFL)
414 int oflags = fcntl(fd, F_GETFL);
418 if (oflags & O_NONBLOCK)
420 oflags |= O_NONBLOCK;
421 return fcntl(fd, F_SETFL, oflags);
430 int result = pipe2(descriptors, O_CLOEXEC | O_NONBLOCK);
432 int result = pipe(descriptors);
439 if (result == 0 && descriptors[1] == -1) {
440 close(descriptors[0]);
448 rb_maygvl_fd_fix_cloexec(descriptors[0]);
449 rb_maygvl_fd_fix_cloexec(descriptors[1]);
452 rb_fd_set_nonblock(descriptors[0]);
453 rb_fd_set_nonblock(descriptors[1]);
465#if defined(HAVE_FCNTL) && defined(F_DUPFD_CLOEXEC) && defined(F_DUPFD)
466 static int try_dupfd_cloexec = 1;
467 if (try_dupfd_cloexec) {
468 ret = fcntl(fd, F_DUPFD_CLOEXEC, minfd);
471 rb_maygvl_fd_fix_cloexec(ret);
475 if (
errno == EINVAL) {
476 ret = fcntl(fd, F_DUPFD, minfd);
478 try_dupfd_cloexec = 0;
483 ret = fcntl(fd, F_DUPFD, minfd);
485#elif defined(HAVE_FCNTL) && defined(F_DUPFD)
486 ret = fcntl(fd, F_DUPFD, minfd);
489 if (ret >= 0 && ret < minfd) {
490 const int prev_fd = ret;
496 if (ret < 0)
return ret;
497 rb_maygvl_fd_fix_cloexec(ret);
501#define argf_of(obj) (*(struct argf *)DATA_PTR(obj))
502#define ARGF argf_of(argf)
504#define GetWriteIO(io) rb_io_get_write_io(io)
506#define READ_DATA_PENDING(fptr) ((fptr)->rbuf.len)
507#define READ_DATA_PENDING_COUNT(fptr) ((fptr)->rbuf.len)
508#define READ_DATA_PENDING_PTR(fptr) ((fptr)->rbuf.ptr+(fptr)->rbuf.off)
509#define READ_DATA_BUFFERED(fptr) READ_DATA_PENDING(fptr)
511#define READ_CHAR_PENDING(fptr) ((fptr)->cbuf.len)
512#define READ_CHAR_PENDING_COUNT(fptr) ((fptr)->cbuf.len)
513#define READ_CHAR_PENDING_PTR(fptr) ((fptr)->cbuf.ptr+(fptr)->cbuf.off)
516#define WAIT_FD_IN_WIN32(fptr) \
517 (rb_w32_io_cancelable_p((fptr)->fd) ? Qnil : rb_io_wait(fptr->self, RB_INT2NUM(RUBY_IO_READABLE), RUBY_IO_TIMEOUT_DEFAULT))
519#define WAIT_FD_IN_WIN32(fptr)
522#define READ_CHECK(fptr) do {\
523 if (!READ_DATA_PENDING(fptr)) {\
524 WAIT_FD_IN_WIN32(fptr);\
525 rb_io_check_closed(fptr);\
531# define S_ISSOCK(m) _S_ISSOCK(m)
534# define S_ISSOCK(m) (((m) & S_IFMT) == _S_IFSOCK)
537# define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
543static int io_fflush(
rb_io_t *);
544static rb_io_t *flush_before_seek(
rb_io_t *fptr,
bool discard_rbuf);
545static void clear_codeconv(
rb_io_t *fptr);
547#define FMODE_SIGNAL_ON_EPIPE (1<<17)
549#define fptr_signal_on_epipe(fptr) \
550 (((fptr)->mode & FMODE_SIGNAL_ON_EPIPE) != 0)
552#define fptr_set_signal_on_epipe(fptr, flag) \
554 (fptr)->mode |= FMODE_SIGNAL_ON_EPIPE : \
555 (fptr)->mode &= ~FMODE_SIGNAL_ON_EPIPE)
557extern ID ruby_static_id_signo;
559NORETURN(
static void rb_sys_fail_on_write(
rb_io_t *fptr));
561rb_sys_fail_on_write(
rb_io_t *fptr)
564 VALUE errinfo = rb_syserr_new_path(e, (fptr)->pathv);
566 if (fptr_signal_on_epipe(fptr) && (e == EPIPE)) {
578#define NEED_NEWLINE_DECORATOR_ON_READ(fptr) ((fptr)->mode & FMODE_TEXTMODE)
579#define NEED_NEWLINE_DECORATOR_ON_WRITE(fptr) ((fptr)->mode & FMODE_TEXTMODE)
580#if defined(RUBY_TEST_CRLF_ENVIRONMENT) || defined(_WIN32)
581# define RUBY_CRLF_ENVIRONMENT 1
583# define RUBY_CRLF_ENVIRONMENT 0
586#if RUBY_CRLF_ENVIRONMENT
588# define DEFAULT_TEXTMODE FMODE_TEXTMODE
589# define TEXTMODE_NEWLINE_DECORATOR_ON_WRITE ECONV_CRLF_NEWLINE_DECORATOR
597#define NEED_READCONV(fptr) ((fptr)->encs.enc2 != NULL || (fptr)->encs.ecflags & ~ECONV_CRLF_NEWLINE_DECORATOR)
598#define WRITECONV_MASK ( \
599 (ECONV_DECORATOR_MASK & ~ECONV_CRLF_NEWLINE_DECORATOR)|\
600 ECONV_STATEFUL_DECORATOR_MASK|\
602#define NEED_WRITECONV(fptr) ( \
603 ((fptr)->encs.enc != NULL && (fptr)->encs.enc != rb_ascii8bit_encoding()) || \
604 ((fptr)->encs.ecflags & WRITECONV_MASK) || \
606#define SET_BINARY_MODE(fptr) setmode((fptr)->fd, O_BINARY)
608#define NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr) do {\
609 if (NEED_NEWLINE_DECORATOR_ON_READ(fptr)) {\
610 if (((fptr)->mode & FMODE_READABLE) &&\
611 !((fptr)->encs.ecflags & ECONV_NEWLINE_DECORATOR_MASK)) {\
612 setmode((fptr)->fd, O_BINARY);\
615 setmode((fptr)->fd, O_TEXT);\
620#define SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags) do {\
621 if ((enc2) && ((ecflags) & ECONV_DEFAULT_NEWLINE_DECORATOR)) {\
622 (ecflags) |= ECONV_UNIVERSAL_NEWLINE_DECORATOR;\
630io_unread(
rb_io_t *fptr,
bool discard_rbuf)
646 if (!rb_w32_fd_is_text(fptr->
fd)) {
647 r = lseek(fptr->
fd, -fptr->
rbuf.
len, SEEK_CUR);
648 if (r < 0 &&
errno) {
651 if (!discard_rbuf)
return;
657 pos = lseek(fptr->
fd, 0, SEEK_CUR);
658 if (pos < 0 &&
errno) {
661 if (!discard_rbuf)
goto end;
665 extra_max = (long)(pos - fptr->
rbuf.
len);
673 for (i = 0; i < fptr->
rbuf.
len; i++) {
674 if (*p ==
'\n') newlines++;
675 if (extra_max == newlines)
break;
680 while (newlines >= 0) {
681 r = lseek(fptr->
fd, pos - fptr->
rbuf.
len - newlines, SEEK_SET);
682 if (newlines == 0)
break;
687 read_size = _read(fptr->
fd, buf, fptr->
rbuf.
len + newlines);
691 rb_syserr_fail_path(e, fptr->
pathv);
693 if (read_size == fptr->
rbuf.
len) {
694 lseek(fptr->
fd, r, SEEK_SET);
705 clear_codeconv(fptr);
717set_binary_mode_with_seek_cur(
rb_io_t *fptr)
719 if (!rb_w32_fd_is_text(fptr->
fd))
return O_BINARY;
722 return setmode(fptr->
fd, O_BINARY);
724 flush_before_seek(fptr,
false);
725 return setmode(fptr->
fd, O_BINARY);
727#define SET_BINARY_MODE_WITH_SEEK_CUR(fptr) set_binary_mode_with_seek_cur(fptr)
731# define DEFAULT_TEXTMODE 0
732#define NEED_READCONV(fptr) ((fptr)->encs.enc2 != NULL || NEED_NEWLINE_DECORATOR_ON_READ(fptr))
733#define NEED_WRITECONV(fptr) ( \
734 ((fptr)->encs.enc != NULL && (fptr)->encs.enc != rb_ascii8bit_encoding()) || \
735 NEED_NEWLINE_DECORATOR_ON_WRITE(fptr) || \
736 ((fptr)->encs.ecflags & (ECONV_DECORATOR_MASK|ECONV_STATEFUL_DECORATOR_MASK)) || \
738#define SET_BINARY_MODE(fptr) (void)(fptr)
739#define NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr) (void)(fptr)
740#define SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags) ((void)(enc2), (void)(ecflags))
741#define SET_BINARY_MODE_WITH_SEEK_CUR(fptr) (void)(fptr)
744#if !defined HAVE_SHUTDOWN && !defined shutdown
745#define shutdown(a,b) 0
749#define is_socket(fd, path) rb_w32_is_socket(fd)
750#elif !defined(S_ISSOCK)
751#define is_socket(fd, path) 0
754is_socket(
int fd,
VALUE path)
757 if (fstat(fd, &sbuf) < 0)
758 rb_sys_fail_path(path);
759 return S_ISSOCK(sbuf.st_mode);
763static const char closed_stream[] =
"closed stream";
766io_fd_check_closed(
int fd)
799 io_fd_check_closed(fptr->
fd);
803rb_io_get_fptr(
VALUE io)
813 return rb_convert_type_with_id(io,
T_FILE,
"IO", idTo_io);
819 return rb_check_convert_type_with_id(io,
T_FILE,
"IO", idTo_io);
837 rb_io_t *fptr = rb_io_get_fptr(io);
846 return write_io ? write_io :
Qnil;
859 rb_io_t *fptr = rb_io_get_fptr(self);
889 if (
RTEST(timeout)) {
893 rb_io_t *fptr = rb_io_get_fptr(self);
918#if !RUBY_CRLF_ENVIRONMENT
920io_unread(
rb_io_t *fptr,
bool discard_rbuf)
928 r = lseek(fptr->
fd, -fptr->
rbuf.
len, SEEK_CUR);
929 if (r < 0 &&
errno) {
932 if (!discard_rbuf)
return;
936 clear_codeconv(fptr);
946 long len = RSTRING_LEN(str);
949 const int min_capa = IO_RBUF_CAPA_FOR(fptr);
952#if SIZEOF_LONG > SIZEOF_INT
977flush_before_seek(
rb_io_t *fptr,
bool discard_rbuf)
979 if (io_fflush(fptr) < 0)
980 rb_sys_fail_on_write(fptr);
981 io_unread(fptr, discard_rbuf);
986#define io_seek(fptr, ofs, whence) (errno = 0, lseek(flush_before_seek(fptr, true)->fd, (ofs), (whence)))
987#define io_tell(fptr) lseek(flush_before_seek(fptr, false)->fd, 0, SEEK_CUR)
1003 if (io_fflush(fptr) < 0)
1004 rb_sys_fail_on_write(fptr);
1009 if (io_fflush(wfptr) < 0)
1010 rb_sys_fail_on_write(wfptr);
1018 if (READ_CHAR_PENDING(fptr)) {
1019 rb_raise(
rb_eIOError,
"byte oriented read for character buffered IO");
1030io_read_encoding(
rb_io_t *fptr)
1035 return rb_default_external_encoding();
1039io_input_encoding(
rb_io_t *fptr)
1044 return io_read_encoding(fptr);
1055 io_unread(fptr,
true);
1060rb_io_read_pending(
rb_io_t *fptr)
1063 if (READ_CHAR_PENDING(fptr))
1065 return READ_DATA_PENDING(fptr);
1071 if (!READ_DATA_PENDING(fptr)) {
1078rb_gc_for_fd(
int err)
1080 if (err == EMFILE || err == ENFILE || err == ENOMEM) {
1090#define TRY_WITH_GC(expr) \
1091 for (int first_errno, retried_errno = 0, retried = 0; \
1094 (!rb_gc_for_fd(first_errno = errno) || !(expr)) && \
1095 (retried_errno = errno, 1)); \
1096 (void)retried_errno, retried = 1)
1111io_alloc(
VALUE klass)
1121# define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
1147struct io_internal_writev_struct {
1154 const struct iovec *iov;
1167io_internal_wait(
VALUE thread,
rb_io_t *fptr,
int error,
int events,
struct timeval *timeout)
1169 if (!timeout && rb_thread_mn_schedulable(thread)) {
1174 int ready = nogvl_wait_for(thread, fptr, events, timeout);
1179 else if (ready == 0) {
1196internal_read_func(
void *ptr)
1201 if (iis->timeout && !iis->nonblock) {
1202 if (io_internal_wait(iis->th, iis->fptr, 0, RB_WAITFD_IN, iis->timeout) == -1) {
1208 result = read(iis->fd, iis->buf, iis->capa);
1210 if (result < 0 && !iis->nonblock) {
1211 if (io_again_p(
errno)) {
1212 if (io_internal_wait(iis->th, iis->fptr,
errno, RB_WAITFD_IN, iis->timeout) == -1) {
1224#if defined __APPLE__
1225# define do_write_retry(code) do {result = code;} while (result == -1 && errno == EPROTOTYPE)
1227# define do_write_retry(code) result = code
1231internal_write_func(
void *ptr)
1236 if (iis->timeout && !iis->nonblock) {
1237 if (io_internal_wait(iis->th, iis->fptr, 0, RB_WAITFD_OUT, iis->timeout) == -1) {
1243 do_write_retry(write(iis->fd, iis->buf, iis->capa));
1245 if (result < 0 && !iis->nonblock) {
1247 if (io_again_p(e)) {
1248 if (io_internal_wait(iis->th, iis->fptr,
errno, RB_WAITFD_OUT, iis->timeout) == -1) {
1262internal_writev_func(
void *ptr)
1264 struct io_internal_writev_struct *iis = ptr;
1267 if (iis->timeout && !iis->nonblock) {
1268 if (io_internal_wait(iis->th, iis->fptr, 0, RB_WAITFD_OUT, iis->timeout) == -1) {
1274 do_write_retry(writev(iis->fd, iis->iov, iis->iovcnt));
1276 if (result < 0 && !iis->nonblock) {
1277 if (io_again_p(
errno)) {
1278 if (io_internal_wait(iis->th, iis->fptr,
errno, RB_WAITFD_OUT, iis->timeout) == -1) {
1292rb_io_read_memory(
rb_io_t *fptr,
void *buf,
size_t count)
1296 if (scheduler !=
Qnil) {
1299 if (!UNDEF_P(result)) {
1315 struct timeval timeout_storage;
1319 iis.timeout = &timeout_storage;
1322 return (ssize_t)rb_io_blocking_region_wait(fptr, internal_read_func, &iis,
RUBY_IO_READABLE);
1326rb_io_write_memory(
rb_io_t *fptr,
const void *buf,
size_t count)
1330 if (scheduler !=
Qnil) {
1333 if (!UNDEF_P(result)) {
1349 struct timeval timeout_storage;
1353 iis.timeout = &timeout_storage;
1356 return (ssize_t)rb_io_blocking_region_wait(fptr, internal_write_func, &iis,
RUBY_IO_WRITABLE);
1361rb_writev_internal(
rb_io_t *fptr,
const struct iovec *iov,
int iovcnt)
1363 if (!iovcnt)
return 0;
1368 if (scheduler !=
Qnil) {
1372 if (!UNDEF_P(result)) {
1377 struct io_internal_writev_struct iis = {
1388 struct timeval timeout_storage;
1392 iis.timeout = &timeout_storage;
1395 return (ssize_t)rb_io_blocking_region_wait(fptr, internal_writev_func, &iis,
RUBY_IO_WRITABLE);
1400io_flush_buffer_sync(
void *arg)
1422io_flush_buffer_fiber_scheduler(
VALUE scheduler,
rb_io_t *fptr)
1425 if (!UNDEF_P(ret)) {
1437io_flush_buffer_async(
VALUE arg)
1442 if (scheduler !=
Qnil) {
1443 VALUE result = io_flush_buffer_fiber_scheduler(scheduler, fptr);
1444 if (!UNDEF_P(result)) {
1449 return rb_io_blocking_region_wait(fptr, io_flush_buffer_sync, fptr,
RUBY_IO_WRITABLE);
1456 return (
int)io_flush_buffer_async((
VALUE)fptr);
1471 while (fptr->
wbuf.
len > 0 && io_flush_buffer(fptr) != 0) {
1487 if (scheduler !=
Qnil) {
1497 if (NIL_OR_UNDEF_P(timeout)) {
1501 if (timeout !=
Qnil) {
1506 int ready = rb_thread_io_wait(th, fptr,
RB_NUM2INT(events), tv);
1532 if (scheduler !=
Qnil) {
1538 return rb_thread_wait_for_single_fd(th, fd, events, timeout);
1544 io_fd_check_closed(f);
1551#if defined(ERESTART)
1558#if EWOULDBLOCK != EAGAIN
1561 if (scheduler !=
Qnil) {
1579 io_fd_check_closed(f);
1586#if defined(ERESTART)
1602#if EWOULDBLOCK != EAGAIN
1605 if (scheduler !=
Qnil) {
1625 return io_wait_for_single_fd(fd, events, timeout, th, scheduler);
1659#if defined(ERESTART)
1669#if EWOULDBLOCK != EAGAIN
1686 if (
RTEST(result)) {
1701 if (
RTEST(result)) {
1715 const char *senc, *denc;
1722 ecflags = fptr->
encs.
ecflags & ~ECONV_NEWLINE_DECORATOR_READ_MASK;
1749 denc = rb_enc_name(enc);
1781io_binwrite_string_internal(
rb_io_t *fptr,
const char *ptr,
long length)
1784 struct iovec iov[2];
1787 iov[0].iov_len = fptr->
wbuf.
len;
1788 iov[1].iov_base = (
void*)ptr;
1789 iov[1].iov_len = length;
1791 ssize_t result = rb_writev_internal(fptr, iov, 2);
1796 if (result >= fptr->
wbuf.
len) {
1804 fptr->
wbuf.
off += (int)result;
1805 fptr->
wbuf.
len -= (int)result;
1813 return rb_io_write_memory(fptr, ptr, length);
1818io_binwrite_string_internal(
rb_io_t *fptr,
const char *ptr,
long length)
1820 long remaining = length;
1823 if (fptr->
wbuf.
len+length <= fptr->wbuf.capa) {
1830 fptr->
wbuf.
len += (int)length;
1837 if (io_fflush(fptr) < 0) {
1842 if (remaining == 0) {
1848 return rb_io_write_memory(fptr, ptr, length);
1853io_binwrite_string(
VALUE arg)
1857 const char *ptr = p->ptr;
1858 size_t remaining = p->length;
1862 ssize_t result = io_binwrite_string_internal(p->fptr, ptr, remaining);
1868 else if (result > 0) {
1869 if ((
size_t)result == remaining)
break;
1871 remaining -= result;
1887io_allocate_write_buffer(
rb_io_t *fptr,
int sync)
1892 fptr->
wbuf.
capa = IO_WBUF_CAPA_MIN;
1903io_binwrite_requires_flush_write(
rb_io_t *fptr,
long len,
int nosync)
1918io_binwrite(
const char *ptr,
long len,
rb_io_t *fptr,
int nosync)
1920 if (
len <= 0)
return len;
1925 io_allocate_write_buffer(fptr, !nosync);
1927 if (io_binwrite_requires_flush_write(fptr,
len, nosync)) {
1938 return io_binwrite_string((
VALUE)&arg);
1955# define MODE_BTMODE(a,b,c) ((fmode & FMODE_BINMODE) ? (b) : \
1956 (fmode & FMODE_TEXTMODE) ? (c) : (a))
1958#define MODE_BTXMODE(a, b, c, d, e, f) ((fmode & FMODE_EXCL) ? \
1959 MODE_BTMODE(d, e, f) : \
1960 MODE_BTMODE(a, b, c))
1965 if (NEED_WRITECONV(fptr)) {
1967 SET_BINARY_MODE(fptr);
1969 make_writeconv(fptr);
1972#define fmode (fptr->mode)
1975 else if (MODE_BTMODE(DEFAULT_TEXTMODE,0,1) && !rb_enc_asciicompat(rb_enc_get(str))) {
1976 rb_raise(rb_eArgError,
"ASCII incompatible string written for text mode IO without encoding conversion: %s",
1977 rb_enc_name(rb_enc_get(str)));
1983 common_encoding = rb_enc_from_encoding(fptr->
encs.
enc2);
1984 else if (fptr->
encs.
enc != rb_ascii8bit_encoding())
1985 common_encoding = rb_enc_from_encoding(fptr->
encs.
enc);
1988 if (!
NIL_P(common_encoding)) {
1999#if RUBY_CRLF_ENVIRONMENT
2000#define fmode (fptr->mode)
2001 else if (MODE_BTMODE(DEFAULT_TEXTMODE,0,1)) {
2004 setmode(fptr->
fd, O_BINARY);
2007 setmode(fptr->
fd, O_TEXT);
2009 if (!rb_enc_asciicompat(rb_enc_get(str))) {
2010 rb_raise(rb_eArgError,
"ASCII incompatible string written for text mode IO without encoding conversion: %s",
2011 rb_enc_name(rb_enc_get(str)));
2029 long len = rb_w32_write_console(str, fptr->
fd);
2034 str = do_writeconv(str, fptr, &converted);
2038 tmp = rb_str_tmp_frozen_no_embed_acquire(str);
2040 n = io_binwrite(ptr,
len, fptr, nosync);
2041 rb_str_tmp_frozen_release(str, tmp);
2053 return (ssize_t)io_binwrite(buf, (
long)size, fptr, 0);
2063 io = GetWriteIO(io);
2073 if (RSTRING_LEN(str) == 0)
return INT2FIX(0);
2078 n = io_fwrite(str, fptr, nosync);
2079 if (n < 0L) rb_sys_fail_on_write(fptr);
2085struct binwritev_arg {
2093io_binwritev_internal(
VALUE arg)
2095 struct binwritev_arg *p = (
struct binwritev_arg *)arg;
2097 size_t remaining = p->total;
2101 struct iovec *iov = p->iov;
2102 int iovcnt = p->iovcnt;
2105 long result = rb_writev_internal(fptr, iov, iovcnt);
2110 if (offset < (
size_t)fptr->
wbuf.
len) {
2115 offset -= (size_t)fptr->
wbuf.
len;
2121 if (offset == p->total) {
2125 while (result >= (ssize_t)iov->iov_len) {
2127 result -= iov->iov_len;
2137 iov->iov_base = (
char *)iov->iov_base + result;
2138 iov->iov_len -= result;
2152io_binwritev(
struct iovec *iov,
int iovcnt,
rb_io_t *fptr)
2157 if (iovcnt == 0)
return 0;
2160 for (
int i = 1; i < iovcnt; i++) total += iov[i].iov_len;
2162 io_allocate_write_buffer(fptr, 1);
2168 if (offset + total <= (
size_t)fptr->
wbuf.
capa) {
2169 for (
int i = 1; i < iovcnt; i++) {
2170 memcpy(fptr->
wbuf.
ptr+offset, iov[i].iov_base, iov[i].iov_len);
2171 offset += iov[i].iov_len;
2180 iov[0].iov_len = fptr->
wbuf.
len;
2193 struct binwritev_arg arg;
2196 arg.iovcnt = iovcnt;
2203 return io_binwritev_internal((
VALUE)&arg);
2210 int i, converted, iovcnt = argc + 1;
2212 VALUE v1, v2, str, tmp, *tmp_array;
2218 for (i = 0; i < argc; i++) {
2221 str = do_writeconv(str, fptr, &converted);
2226 tmp = rb_str_tmp_frozen_acquire(str);
2230 iov[i+1].iov_base = RSTRING_PTR(tmp);
2231 iov[i+1].iov_len = RSTRING_LEN(tmp);
2234 n = io_binwritev(iov, iovcnt, fptr);
2237 for (i = 0; i < argc; i++) {
2238 rb_str_tmp_frozen_release(argv[i], tmp_array[i]);
2247iovcnt_ok(
int iovcnt)
2250 return iovcnt < IOV_MAX;
2258io_writev(
int argc,
const VALUE *argv,
VALUE io)
2265 io = GetWriteIO(io);
2270 return rb_funcallv(io, id_write, argc, argv);
2278 for (i = 0; i < argc; i += cnt) {
2281 n = io_fwritev(cnt, &argv[i], fptr);
2292 rb_sys_fail_on_write(fptr);
2294 total = rb_fix_plus(
LONG2FIX(n), total);
2325 return io_writev(argc, argv, io);
2328 VALUE str = argv[0];
2329 return io_write(io, str, 0);
2336 return rb_funcallv(io, id_write, 1, &str);
2340rb_io_writev(
VALUE io,
int argc,
const VALUE *argv)
2345 char sep = RCLASS_SINGLETON_P(klass) ? (klass = io,
'.') :
'#';
2348 " which accepts just one argument",
2353 do rb_io_write(io, *argv++);
while (--argc);
2358 return rb_funcallv(io, id_write, argc, argv);
2384 rb_io_write(io, str);
2390nogvl_fsync(
void *ptr)
2395 if (GetFileType((HANDLE)rb_w32_get_osfhandle(fptr->
fd)) != FILE_TYPE_DISK)
2398 return (
VALUE)fsync(fptr->
fd);
2403rb_io_flush_raw(
VALUE io,
int sync)
2411 io = GetWriteIO(io);
2415 if (io_fflush(fptr) < 0)
2416 rb_sys_fail_on_write(fptr);
2419 io_unread(fptr,
true);
2440 return rb_io_flush_raw(io, 1);
2466 pos = io_tell(fptr);
2467 if (pos < 0 &&
errno) rb_sys_fail_path(fptr->
pathv);
2473rb_io_seek(
VALUE io,
VALUE offset,
int whence)
2480 pos = io_seek(fptr, pos, whence);
2481 if (pos < 0 &&
errno) rb_sys_fail_path(fptr->
pathv);
2487interpret_seek_whence(
VALUE vwhence)
2489 if (vwhence == sym_SET)
2491 if (vwhence == sym_CUR)
2493 if (vwhence == sym_END)
2496 if (vwhence == sym_DATA)
2500 if (vwhence == sym_HOLE)
2556 VALUE offset, ptrname;
2557 int whence = SEEK_SET;
2559 if (
rb_scan_args(argc, argv,
"11", &offset, &ptrname) == 2) {
2560 whence = interpret_seek_whence(ptrname);
2563 return rb_io_seek(io, offset, whence);
2591 pos = io_seek(fptr, pos, SEEK_SET);
2592 if (pos < 0 &&
errno) rb_sys_fail_path(fptr->
pathv);
2597static void clear_readconv(
rb_io_t *fptr);
2624rb_io_rewind(
VALUE io)
2629 if (io_seek(fptr, 0L, 0) < 0 &&
errno) rb_sys_fail_path(fptr->
pathv);
2630 if (io == ARGF.current_file) {
2631 ARGF.lineno -= fptr->
lineno;
2635 clear_readconv(fptr);
2642fptr_wait_readable(
rb_io_t *fptr)
2660 fptr->
rbuf.
capa = IO_RBUF_CAPA_FOR(fptr);
2668 if (fptr_wait_readable(fptr))
2672 VALUE path = rb_sprintf(
"fd:%d ", fptr->
fd);
2677 rb_syserr_fail_path(e, path);
2731 if (READ_CHAR_PENDING(fptr))
return Qfalse;
2732 if (READ_DATA_PENDING(fptr))
return Qfalse;
2734#if RUBY_CRLF_ENVIRONMENT
2735 if (!NEED_READCONV(fptr) && NEED_NEWLINE_DECORATOR_ON_READ(fptr)) {
2736 return RBOOL(eof(fptr->
fd));
2739 return RBOOL(io_fillbuf(fptr) < 0);
2763 io = GetWriteIO(io);
2800 io = GetWriteIO(io);
2806 fptr->
mode &= ~FMODE_SYNC;
2830rb_io_fsync(
VALUE io)
2834 io = GetWriteIO(io);
2837 if (io_fflush(fptr) < 0)
2838 rb_sys_fail_on_write(fptr);
2840 if ((
int)rb_io_blocking_region(fptr, nogvl_fsync, fptr))
2841 rb_sys_fail_path(fptr->
pathv);
2846# define rb_io_fsync rb_f_notimplement
2847# define rb_io_sync rb_f_notimplement
2856#ifdef HAVE_FDATASYNC
2858nogvl_fdatasync(
void *ptr)
2863 if (GetFileType((HANDLE)rb_w32_get_osfhandle(fptr->
fd)) != FILE_TYPE_DISK)
2866 return (
VALUE)fdatasync(fptr->
fd);
2881rb_io_fdatasync(
VALUE io)
2885 io = GetWriteIO(io);
2888 if (io_fflush(fptr) < 0)
2889 rb_sys_fail_on_write(fptr);
2891 if ((
int)rb_io_blocking_region(fptr, nogvl_fdatasync, fptr) == 0)
2895 return rb_io_fsync(io);
2898#define rb_io_fdatasync rb_io_fsync
2916rb_io_fileno(
VALUE io)
2936 if (!UNDEF_P(fileno)) {
3024rb_io_inspect(
VALUE obj)
3028 static const char closed[] =
" (closed)";
3030 fptr =
RFILE(obj)->fptr;
3037 rb_str_cat(result, closed+1, strlen(closed)-1);
3040 rb_str_catf(result,
"fd %d", fptr->
fd);
3061rb_io_to_io(
VALUE io)
3068read_buffered_data(
char *ptr,
long len,
rb_io_t *fptr)
3072 n = READ_DATA_PENDING_COUNT(fptr);
3073 if (n <= 0)
return 0;
3074 if (n >
len) n = (int)
len;
3082io_bufread(
char *ptr,
long len,
rb_io_t *fptr)
3088 if (READ_DATA_PENDING(fptr) == 0) {
3092 c = rb_io_read_memory(fptr, ptr+offset, n);
3095 if (fptr_wait_readable(fptr))
3100 if ((n -= c) <= 0)
break;
3106 c = read_buffered_data(ptr+offset, n, fptr);
3109 if ((n -= c) <= 0)
break;
3112 if (io_fillbuf(fptr) < 0) {
3119static int io_setstrbuf(
VALUE *str,
long len);
3128bufread_call(
VALUE arg)
3131 p->len = io_bufread(p->str_ptr, p->len, p->fptr);
3136io_fread(
VALUE str,
long offset,
long size,
rb_io_t *fptr)
3141 io_setstrbuf(&str, offset + size);
3142 arg.str_ptr = RSTRING_PTR(str) + offset;
3145 rb_str_locktmp_ensure(str, bufread_call, (
VALUE)&arg);
3147 if (
len < 0) rb_sys_fail_path(fptr->
pathv);
3155 rb_off_t siz = READ_DATA_PENDING_COUNT(fptr);
3158 if (fstat(fptr->
fd, &st) == 0 && S_ISREG(st.st_mode)
3159#
if defined(__HAIKU__)
3164 if (io_fflush(fptr) < 0)
3165 rb_sys_fail_on_write(fptr);
3166 pos = lseek(fptr->
fd, 0, SEEK_CUR);
3167 if (st.st_size >= pos && pos >= 0) {
3168 siz += st.st_size - pos;
3169 if (siz > LONG_MAX) {
3170 rb_raise(
rb_eIOError,
"file too big for single read");
3183 rb_enc_associate(str, io_read_encoding(fptr));
3188make_readconv(
rb_io_t *fptr,
int size)
3193 const char *sname, *dname;
3194 ecflags = fptr->
encs.
ecflags & ~ECONV_NEWLINE_DECORATOR_WRITE_MASK;
3197 sname = rb_enc_name(fptr->
encs.
enc2);
3198 dname = rb_enc_name(io_read_encoding(fptr));
3208 if (size < IO_CBUF_CAPA_MIN) size = IO_CBUF_CAPA_MIN;
3214#define MORE_CHAR_SUSPENDED Qtrue
3215#define MORE_CHAR_FINISHED Qnil
3217fill_cbuf(
rb_io_t *fptr,
int ec_flags)
3219 const unsigned char *ss, *sp, *se;
3220 unsigned char *ds, *dp, *de;
3229 return MORE_CHAR_SUSPENDED;
3240 ss = sp = (
const unsigned char *)fptr->
rbuf.
ptr + fptr->
rbuf.
off;
3245 fptr->
rbuf.
off += (int)(sp - ss);
3246 fptr->
rbuf.
len -= (int)(sp - ss);
3247 fptr->
cbuf.
len += (int)(dp - ds);
3252 fptr->
rbuf.
off -= putbackable;
3253 fptr->
rbuf.
len += putbackable;
3260 if (cbuf_len0 != fptr->
cbuf.
len)
3261 return MORE_CHAR_SUSPENDED;
3264 return MORE_CHAR_FINISHED;
3270 if (io_fillbuf(fptr) < 0) {
3272 return MORE_CHAR_FINISHED;
3277 fptr->
cbuf.
len += (int)(dp - ds);
3284 if (cbuf_len0 != fptr->
cbuf.
len)
3285 return MORE_CHAR_SUSPENDED;
3287 return MORE_CHAR_FINISHED;
3295 if (v != MORE_CHAR_SUSPENDED && v != MORE_CHAR_FINISHED)
3312 rb_enc_associate(str, fptr->
encs.
enc);
3337 long clen = RSTRING_LEN(s);
3349#define MAX_REALLOC_GAP 4096
3351io_shrink_read_string(
VALUE str,
long n)
3354 rb_str_resize(str, n);
3359io_set_read_length(
VALUE str,
long n,
int shrinkable)
3361 if (RSTRING_LEN(str) != n) {
3364 if (shrinkable) io_shrink_read_string(str, n);
3378 if (NEED_READCONV(fptr)) {
3379 int first = !
NIL_P(str);
3380 SET_BINARY_MODE(fptr);
3381 shrinkable = io_setstrbuf(&str,0);
3382 make_readconv(fptr, 0);
3387 io_shift_cbuf(fptr, fptr->
cbuf.
len, &str);
3389 v = fill_cbuf(fptr, 0);
3390 if (v != MORE_CHAR_SUSPENDED && v != MORE_CHAR_FINISHED) {
3393 io_shift_cbuf(fptr, fptr->
cbuf.
len, &str);
3397 if (v == MORE_CHAR_FINISHED) {
3398 clear_readconv(fptr);
3400 if (shrinkable) io_shrink_read_string(str, RSTRING_LEN(str));
3401 return io_enc_str(str, fptr);
3406 NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr);
3410 enc = io_read_encoding(fptr);
3413 if (siz == 0) siz = BUFSIZ;
3414 shrinkable = io_setstrbuf(&str, siz);
3417 n = io_fread(str, bytes, siz - bytes, fptr);
3418 if (n == 0 && bytes == 0) {
3426 if (bytes < siz)
break;
3430 if (
capa < (
size_t)RSTRING_LEN(str) + BUFSIZ) {
3431 if (
capa < BUFSIZ) {
3434 else if (
capa > IO_MAX_BUFFER_GROWTH) {
3435 capa = IO_MAX_BUFFER_GROWTH;
3440 if (shrinkable) io_shrink_read_string(str, RSTRING_LEN(str));
3441 str = io_enc_str(str, fptr);
3449 if (rb_fd_set_nonblock(fptr->
fd) != 0) {
3450 rb_sys_fail_path(fptr->
pathv);
3455io_read_memory_call(
VALUE arg)
3460 if (scheduler !=
Qnil) {
3463 if (!UNDEF_P(result)) {
3469 if (iis->nonblock) {
3470 return rb_io_blocking_region(iis->fptr, internal_read_func, iis);
3473 return rb_io_blocking_region_wait(iis->fptr, internal_read_func, iis,
RUBY_IO_READABLE);
3480 return (
long)rb_str_locktmp_ensure(str, io_read_memory_call, (
VALUE)iis);
3483#define no_exception_p(opts) !rb_opts_exception_p((opts), TRUE)
3486io_getpartial(
int argc,
VALUE *argv,
VALUE io,
int no_exception,
int nonblock)
3497 rb_raise(rb_eArgError,
"negative length %ld given",
len);
3500 shrinkable = io_setstrbuf(&str,
len);
3506 io_set_read_length(str, 0, shrinkable);
3512 n = read_buffered_data(RSTRING_PTR(str),
len, fptr);
3518 io_setstrbuf(&str,
len);
3521 iis.nonblock = nonblock;
3523 iis.buf = RSTRING_PTR(str);
3526 n = io_read_memory_locktmp(str, &iis);
3529 if (!nonblock && fptr_wait_readable(fptr))
3531 if (nonblock && (io_again_p(e))) {
3533 return sym_wait_readable;
3536 e,
"read would block");
3538 rb_syserr_fail_path(e, fptr->
pathv);
3541 io_set_read_length(str, n, shrinkable);
3642io_readpartial(
int argc,
VALUE *argv,
VALUE io)
3646 ret = io_getpartial(argc, argv, io,
Qnil, 0);
3653io_nonblock_eof(
int no_exception)
3655 if (!no_exception) {
3671 rb_raise(rb_eArgError,
"negative length %ld given",
len);
3674 shrinkable = io_setstrbuf(&str,
len);
3675 rb_bool_expected(ex,
"exception", TRUE);
3681 io_set_read_length(str, 0, shrinkable);
3685 n = read_buffered_data(RSTRING_PTR(str),
len, fptr);
3687 rb_fd_set_nonblock(fptr->
fd);
3688 shrinkable |= io_setstrbuf(&str,
len);
3692 iis.buf = RSTRING_PTR(str);
3695 n = io_read_memory_locktmp(str, &iis);
3698 if (io_again_p(e)) {
3699 if (!ex)
return sym_wait_readable;
3701 e,
"read would block");
3703 rb_syserr_fail_path(e, fptr->
pathv);
3706 io_set_read_length(str, n, shrinkable);
3709 if (!ex)
return Qnil;
3725 rb_bool_expected(ex,
"exception", TRUE);
3727 io = GetWriteIO(io);
3731 if (io_fflush(fptr) < 0)
3732 rb_sys_fail_on_write(fptr);
3734 rb_fd_set_nonblock(fptr->
fd);
3735 n = write(fptr->
fd, RSTRING_PTR(str), RSTRING_LEN(str));
3740 if (io_again_p(e)) {
3742 return sym_wait_writable;
3748 rb_syserr_fail_path(e, fptr->
pathv);
3832#if RUBY_CRLF_ENVIRONMENT
3838 if (
NIL_P(length)) {
3841 return read_all(fptr, remain_size(fptr), str);
3845 rb_raise(rb_eArgError,
"negative length %ld given",
len);
3848 shrinkable = io_setstrbuf(&str,
len);
3853 io_set_read_length(str, 0, shrinkable);
3858#if RUBY_CRLF_ENVIRONMENT
3859 previous_mode = set_binary_mode_with_seek_cur(fptr);
3861 n = io_fread(str, 0,
len, fptr);
3862 io_set_read_length(str, n, shrinkable);
3863#if RUBY_CRLF_ENVIRONMENT
3864 if (previous_mode == O_TEXT) {
3865 setmode(fptr->
fd, O_TEXT);
3868 if (n == 0)
return Qnil;
3874rscheck(
const char *rsptr,
long rslen,
VALUE rs)
3877 if (RSTRING_PTR(rs) != rsptr && RSTRING_LEN(rs) != rslen)
3882search_delim(
const char *p,
long len,
int delim,
rb_encoding *enc)
3884 if (rb_enc_mbminlen(enc) == 1) {
3885 p = memchr(p, delim,
len);
3886 if (p)
return p + 1;
3889 const char *end = p +
len;
3891 int r = rb_enc_precise_mbclen(p, end, enc);
3893 p += rb_enc_mbminlen(enc);
3897 if (rb_enc_mbc_to_codepoint(p, end, enc) == (
unsigned int)delim) {
3912 if (NEED_READCONV(fptr)) {
3913 SET_BINARY_MODE(fptr);
3914 make_readconv(fptr, 0);
3917 int searchlen = READ_CHAR_PENDING_COUNT(fptr);
3919 p = READ_CHAR_PENDING_PTR(fptr);
3920 if (0 < limit && limit < searchlen)
3921 searchlen = (int)limit;
3922 e = search_delim(p, searchlen, delim, enc);
3924 int len = (int)(e-p);
3946 return (
unsigned char)RSTRING_PTR(str)[RSTRING_LEN(str)-1];
3949 }
while (more_char(fptr) != MORE_CHAR_FINISHED);
3950 clear_readconv(fptr);
3955 NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr);
3957 long pending = READ_DATA_PENDING_COUNT(fptr);
3959 const char *p = READ_DATA_PENDING_PTR(fptr);
3963 if (limit > 0 && pending > limit) pending = limit;
3964 e = search_delim(p, pending, delim, enc);
3965 if (e) pending = e - p;
3967 last = RSTRING_LEN(str);
3968 rb_str_resize(str, last + pending);
3975 read_buffered_data(RSTRING_PTR(str) + last, pending, fptr);
3978 if (e)
return delim;
3980 return (
unsigned char)RSTRING_PTR(str)[RSTRING_LEN(str)-1];
3983 }
while (io_fillbuf(fptr) >= 0);
3989swallow(
rb_io_t *fptr,
int term)
3991 if (NEED_READCONV(fptr)) {
3993 int needconv = rb_enc_mbminlen(enc) != 1;
3994 SET_BINARY_MODE(fptr);
3995 make_readconv(fptr, 0);
3998 while ((cnt = READ_CHAR_PENDING_COUNT(fptr)) > 0) {
3999 const char *p = READ_CHAR_PENDING_PTR(fptr);
4002 if (*p != term)
return TRUE;
4004 while (--i && *++p == term);
4007 const char *e = p + cnt;
4008 if (rb_enc_ascget(p, e, &i, enc) != term)
return TRUE;
4009 while ((p += i) < e && rb_enc_ascget(p, e, &i, enc) == term);
4012 io_shift_cbuf(fptr, (
int)cnt - i, NULL);
4014 }
while (more_char(fptr) != MORE_CHAR_FINISHED);
4018 NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr);
4021 while ((cnt = READ_DATA_PENDING_COUNT(fptr)) > 0) {
4023 const char *p = READ_DATA_PENDING_PTR(fptr);
4025 if (cnt >
sizeof buf) cnt =
sizeof buf;
4026 if (*p != term)
return TRUE;
4028 while (--i && *++p == term);
4029 if (!read_buffered_data(buf, cnt - i, fptr))
4030 rb_sys_fail_path(fptr->
pathv);
4033 }
while (io_fillbuf(fptr) == 0);
4046 int pending = READ_DATA_PENDING_COUNT(fptr);
4049 const char *p = READ_DATA_PENDING_PTR(fptr);
4053 e = memchr(p,
'\n', pending);
4055 pending = (int)(e - p + 1);
4057 chomplen = (pending > 1 && *(e-1) ==
'\r') + 1;
4066 rb_str_resize(str,
len + pending - chomplen);
4067 read_buffered_data(RSTRING_PTR(str)+
len, pending - chomplen, fptr);
4070 if (pending == 1 && chomplen == 1 &&
len > 0) {
4071 if (RSTRING_PTR(str)[
len-1] ==
'\r') {
4072 rb_str_resize(str, --
len);
4077 len += pending - chomplen;
4083 }
while (io_fillbuf(fptr) >= 0);
4086 str = io_enc_str(str, fptr);
4097 unsigned int chomp: 1;
4111 chomp = (!UNDEF_P(vchomp)) &&
RTEST(vchomp);
4113 args->chomp = chomp;
4131 else if (2 <= argc) {
4132 rs = argv[0], lim = argv[1];
4141check_getline_args(
VALUE *rsp,
long *limit,
VALUE io)
4150 enc_rs = rb_enc_get(rs);
4151 enc_io = io_read_encoding(fptr);
4152 if (enc_io != enc_rs &&
4153 (!is_ascii_string(rs) ||
4154 (RSTRING_LEN(rs) > 0 && !rb_enc_asciicompat(enc_io)))) {
4155 if (rs == rb_default_rs) {
4156 rs = rb_enc_str_new(0, 0, enc_io);
4161 rb_raise(rb_eArgError,
"encoding mismatch: %s IO with %s RS",
4162 rb_enc_name(enc_io),
4163 rb_enc_name(enc_rs));
4173 argc =
rb_scan_args(argc, argv,
"02:", NULL, NULL, &opts);
4174 extract_getline_args(argc, argv, args);
4175 extract_getline_opts(opts, args);
4176 check_getline_args(&args->rs, &args->limit, io);
4180rb_io_getline_0(
VALUE rs,
long limit,
int chomp,
rb_io_t *fptr)
4187 if (
NIL_P(rs) && limit < 0) {
4188 str = read_all(fptr, 0,
Qnil);
4189 if (RSTRING_LEN(str) == 0)
return Qnil;
4191 else if (limit == 0) {
4192 return rb_enc_str_new(0, 0, io_read_encoding(fptr));
4194 else if (rs == rb_default_rs && limit < 0 && !NEED_READCONV(fptr) &&
4195 rb_enc_asciicompat(enc = io_read_encoding(fptr))) {
4196 NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr);
4197 return rb_io_getline_fast(fptr, enc, chomp);
4200 int c, newline = -1;
4201 const char *rsptr = 0;
4204 int extra_limit = 16;
4205 int chomp_cr = chomp;
4207 SET_BINARY_MODE(fptr);
4208 enc = io_read_encoding(fptr);
4211 rslen = RSTRING_LEN(rs);
4216 swallow(fptr,
'\n');
4218 if (!rb_enc_asciicompat(enc)) {
4222 rsptr = RSTRING_PTR(rs);
4223 rslen = RSTRING_LEN(rs);
4227 else if (rb_enc_mbminlen(enc) == 1) {
4228 rsptr = RSTRING_PTR(rs);
4229 newline = (
unsigned char)rsptr[rslen - 1];
4233 rsptr = RSTRING_PTR(rs);
4234 const char *e = rsptr + rslen;
4235 const char *last = rb_enc_prev_char(rsptr, e, e, enc);
4237 newline = rb_enc_codepoint_len(last, e, &n, enc);
4238 if (last + n != e) rb_raise(rb_eArgError,
"broken separator");
4240 chomp_cr = chomp && newline ==
'\n' && rslen == rb_enc_mbminlen(enc);
4244 while ((c = appendline(fptr, newline, &str, &limit, enc)) != EOF) {
4245 const char *s, *p, *pp, *e;
4248 if (RSTRING_LEN(str) < rslen)
continue;
4249 s = RSTRING_PTR(str);
4252 if (!at_char_boundary(s, p, e, enc))
continue;
4253 if (!rspara) rscheck(rsptr, rslen, rs);
4254 if (memcmp(p, rsptr, rslen) == 0) {
4256 if (chomp_cr && p > s && *(p-1) ==
'\r') --p;
4263 s = RSTRING_PTR(str);
4265 pp = rb_enc_prev_char(s, p, p, enc);
4266 if (extra_limit && pp &&
4280 if (rspara && c != EOF)
4281 swallow(fptr,
'\n');
4283 str = io_enc_str(str, fptr);
4286 if (!
NIL_P(str) && !nolimit) {
4294rb_io_getline_1(
VALUE rs,
long limit,
int chomp,
VALUE io)
4297 int old_lineno, new_lineno;
4301 old_lineno = fptr->
lineno;
4302 str = rb_io_getline_0(rs, limit, chomp, fptr);
4303 if (!
NIL_P(str) && (new_lineno = fptr->
lineno) != old_lineno) {
4304 if (io == ARGF.current_file) {
4305 ARGF.lineno += new_lineno - old_lineno;
4306 ARGF.last_lineno = ARGF.lineno;
4309 ARGF.last_lineno = new_lineno;
4317rb_io_getline(
int argc,
VALUE *argv,
VALUE io)
4321 prepare_getline_args(argc, argv, &args, io);
4322 return rb_io_getline_1(args.rs, args.limit, args.chomp, io);
4332rb_io_gets_limit_internal(
VALUE io,
long limit)
4336 return rb_io_getline_0(rb_default_rs, limit, FALSE, fptr);
4340rb_io_gets_internal(
VALUE io)
4342 return rb_io_gets_limit_internal(io, -1);
4422 str = rb_io_getline(argc, argv, io);
4438rb_io_lineno(
VALUE io)
4493 check_getline_args(&sep, &limit, io);
4495 VALUE line = rb_io_getline_1(sep, limit,
RTEST(chomp), io);
4496 rb_lastline_set_up(line, 1);
4571rb_io_readlines(
int argc,
VALUE *argv,
VALUE io)
4575 prepare_getline_args(argc, argv, &args, io);
4576 return io_readlines(&args, io);
4584 if (arg->limit == 0)
4585 rb_raise(rb_eArgError,
"invalid limit: 0 for readlines");
4587 while (!
NIL_P(line = rb_io_getline_1(arg->rs, arg->limit, arg->chomp, io))) {
4700rb_io_each_line(
int argc,
VALUE *argv,
VALUE io)
4706 prepare_getline_args(argc, argv, &args, io);
4707 if (args.limit == 0)
4708 rb_raise(rb_eArgError,
"invalid limit: 0 for each_line");
4709 while (!
NIL_P(str = rb_io_getline_1(args.rs, args.limit, args.chomp, io))) {
4737rb_io_each_byte(
VALUE io)
4753 }
while (io_fillbuf(fptr) >= 0);
4763 if (NEED_READCONV(fptr)) {
4767 SET_BINARY_MODE(fptr);
4768 make_readconv(fptr, 0);
4782 if (more_char(fptr) == MORE_CHAR_FINISHED) {
4784 clear_readconv(fptr);
4788 str = rb_enc_str_new(fptr->
cbuf.
ptr+fptr->
cbuf.
off, 1, read_enc);
4791 if (fptr->
cbuf.
len == 0) clear_readconv(fptr);
4800 io_shift_cbuf(fptr, r, &str);
4807 ISASCII(RSTRING_PTR(str)[0])) {
4811 str = io_enc_str(str, fptr);
4816 NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr);
4817 if (io_fillbuf(fptr) < 0) {
4839 if (io_fillbuf(fptr) != -1) {
4843 r = rb_enc_precise_mbclen(RSTRING_PTR(str), RSTRING_PTR(str)+RSTRING_LEN(str), enc);
4859 str = io_enc_str(str, fptr);
4886rb_io_each_char(
VALUE io)
4896 enc = io_input_encoding(fptr);
4898 while (!
NIL_P(c = io_getc(fptr, enc))) {
4925rb_io_each_codepoint(
VALUE io)
4937 enc = io_read_encoding(fptr);
4938 if (NEED_READCONV(fptr)) {
4939 SET_BINARY_MODE(fptr);
4942 make_readconv(fptr, 0);
4954 if (more_char(fptr) == MORE_CHAR_FINISHED) {
4955 clear_readconv(fptr);
4975 NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr);
4976 while (io_fillbuf(fptr) >= 0) {
4991 char cbuf[8], *p = cbuf;
4993 if (more > numberof(cbuf))
goto invalid;
4995 if (more > numberof(cbuf))
goto invalid;
4996 while ((n = (
int)read_buffered_data(p, more, fptr)) > 0 &&
4997 (p += n, (more -= n) > 0)) {
4998 if (io_fillbuf(fptr) < 0)
goto invalid;
4999 if ((n = fptr->
rbuf.
len) > more) n = more;
5001 r = rb_enc_precise_mbclen(cbuf, p, enc);
5014 rb_raise(rb_eArgError,
"invalid byte sequence in %s", rb_enc_name(enc));
5047 enc = io_input_encoding(fptr);
5049 return io_getc(fptr, enc);
5073rb_io_readchar(
VALUE io)
5075 VALUE c = rb_io_getc(io);
5111 VALUE r_stdout = rb_ractor_stdout();
5116 rb_io_flush(r_stdout);
5119 if (io_fillbuf(fptr) < 0) {
5149rb_io_readbyte(
VALUE io)
5210 unsigned char c =
NUM2INT(v) & 0xFF;
5216 io_ungetbyte(b, fptr);
5272 else if (RB_BIGNUM_TYPE_P(c)) {
5278 if (NEED_READCONV(fptr)) {
5279 SET_BINARY_MODE(fptr);
5280 len = RSTRING_LEN(c);
5281#if SIZEOF_LONG > SIZEOF_INT
5285 make_readconv(fptr, (
int)
len);
5299 NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr);
5300 io_ungetbyte(c, fptr);
5320rb_io_isatty(
VALUE io)
5325 return RBOOL(isatty(fptr->
fd) != 0);
5328#if defined(HAVE_FCNTL) && defined(F_GETFD) && defined(F_SETFD) && defined(FD_CLOEXEC)
5344rb_io_close_on_exec_p(
VALUE io)
5350 write_io = GetWriteIO(io);
5351 if (io != write_io) {
5353 if (fptr && 0 <= (fd = fptr->
fd)) {
5354 if ((ret = fcntl(fd, F_GETFD)) == -1) rb_sys_fail_path(fptr->
pathv);
5355 if (!(ret & FD_CLOEXEC))
return Qfalse;
5360 if (fptr && 0 <= (fd = fptr->
fd)) {
5361 if ((ret = fcntl(fd, F_GETFD)) == -1) rb_sys_fail_path(fptr->
pathv);
5362 if (!(ret & FD_CLOEXEC))
return Qfalse;
5367#define rb_io_close_on_exec_p rb_f_notimplement
5370#if defined(HAVE_FCNTL) && defined(F_GETFD) && defined(F_SETFD) && defined(FD_CLOEXEC)
5394 int flag =
RTEST(arg) ? FD_CLOEXEC : 0;
5399 write_io = GetWriteIO(io);
5400 if (io != write_io) {
5402 if (fptr && 0 <= (fd = fptr->
fd)) {
5403 if ((ret = fcntl(fptr->
fd, F_GETFD)) == -1) rb_sys_fail_path(fptr->
pathv);
5404 if ((ret & FD_CLOEXEC) != flag) {
5405 ret = (ret & ~FD_CLOEXEC) | flag;
5406 ret = fcntl(fd, F_SETFD, ret);
5407 if (ret != 0) rb_sys_fail_path(fptr->
pathv);
5414 if (fptr && 0 <= (fd = fptr->
fd)) {
5415 if ((ret = fcntl(fd, F_GETFD)) == -1) rb_sys_fail_path(fptr->
pathv);
5416 if ((ret & FD_CLOEXEC) != flag) {
5417 ret = (ret & ~FD_CLOEXEC) | flag;
5418 ret = fcntl(fd, F_SETFD, ret);
5419 if (ret != 0) rb_sys_fail_path(fptr->
pathv);
5425#define rb_io_set_close_on_exec rb_f_notimplement
5428#define RUBY_IO_EXTERNAL_P(f) ((f)->mode & FMODE_EXTERNAL)
5429#define PREP_STDIO_NAME(f) (RSTRING_PTR((f)->pathv))
5432finish_writeconv(
rb_io_t *fptr,
int noalloc)
5434 unsigned char *ds, *dp, *de;
5438 unsigned char buf[1024];
5443 de = buf +
sizeof(buf);
5446 size_t remaining = dp-ds;
5447 long result = rb_io_write_memory(fptr, ds, remaining);
5451 if ((
size_t)result == remaining)
break;
5474 if (io_fflush(fptr) < 0) {
5482 fptr->
wbuf.
len += (int)(dp - ds);
5498finish_writeconv_sync(
VALUE arg)
5501 return finish_writeconv(p->fptr, p->noalloc);
5505nogvl_close(
void *ptr)
5509 return (
void*)(intptr_t)close(*fd);
5513maygvl_close(
int fd,
int keepgvl)
5522 return IO_WITHOUT_GVL_INT(nogvl_close, &fd);
5526nogvl_fclose(
void *ptr)
5530 return (
void*)(intptr_t)fclose(file);
5534maygvl_fclose(
FILE *file,
int keepgvl)
5537 return fclose(file);
5539 return IO_WITHOUT_GVL_INT(nogvl_fclose, file);
5545fptr_finalize_flush(
rb_io_t *fptr,
int noraise,
int keepgvl)
5550 int mode = fptr->
mode;
5556 arg.noalloc = noraise;
5560 error = finish_writeconv(fptr, noraise);
5565 io_flush_buffer_sync(fptr);
5568 if (io_fflush(fptr) < 0 &&
NIL_P(error)) {
5576 if (RUBY_IO_EXTERNAL_P(fptr) || fd <= 2) {
5586 rb_thread_io_close_wait(fptr);
5588 if (!done && stdio_file) {
5590 if ((maygvl_fclose(stdio_file, noraise) < 0) &&
NIL_P(error)) {
5600 if (!done && fd >= 0 && scheduler !=
Qnil) {
5603 if (!UNDEF_P(result)) {
5604 done =
RTEST(result);
5608 if (!done && fd >= 0) {
5614 if ((maygvl_close(fd, keepgvl) < 0) &&
NIL_P(error)) {
5623 if (!
NIL_P(error) && !noraise) {
5632fptr_finalize(
rb_io_t *fptr,
int noraise)
5634 fptr_finalize_flush(fptr, noraise, FALSE);
5635 free_io_buffer(&fptr->
rbuf);
5636 free_io_buffer(&fptr->
wbuf);
5637 clear_codeconv(fptr);
5641rb_io_fptr_cleanup(
rb_io_t *fptr,
int noraise)
5647 fptr_finalize(fptr, noraise);
5655 ruby_sized_xfree(buf->
ptr, (
size_t)buf->
capa);
5667 free_io_buffer(&fptr->
cbuf);
5683 clear_readconv(fptr);
5684 clear_writeconv(fptr);
5688rb_io_fptr_cleanup_all(
rb_io_t *fptr)
5692 rb_io_fptr_cleanup(fptr, TRUE);
5694 free_io_buffer(&fptr->
rbuf);
5695 free_io_buffer(&fptr->
wbuf);
5696 clear_codeconv(fptr);
5703 rb_io_fptr_cleanup_all(io);
5710rb_io_memsize(
const rb_io_t *io)
5712 size_t size =
sizeof(
rb_io_t);
5722 rb_serial_t fork_generation = GET_VM()->fork_gen;
5723 if (io->fork_generation == fork_generation) {
5734# define KEEPGVL TRUE
5736# define KEEPGVL FALSE
5740io_close_fptr(
VALUE io)
5746 write_io = GetWriteIO(io);
5747 if (io != write_io) {
5748 write_fptr =
RFILE(write_io)->fptr;
5749 if (write_fptr && 0 <= write_fptr->
fd) {
5750 rb_io_fptr_cleanup(write_fptr, TRUE);
5754 fptr =
RFILE(io)->fptr;
5755 if (!fptr)
return 0;
5756 if (fptr->
fd < 0)
return 0;
5759 if (rb_thread_io_close_interrupt(fptr)) {
5761 fptr_finalize_flush(fptr, FALSE, KEEPGVL);
5764 rb_io_fptr_cleanup(fptr, FALSE);
5769fptr_waitpid(
rb_io_t *fptr,
int nohang)
5773 rb_last_status_clear();
5782 rb_io_t *fptr = io_close_fptr(io);
5783 if (fptr) fptr_waitpid(fptr, 0);
5823rb_io_close_m(
VALUE io)
5825 rb_io_t *fptr = rb_io_get_fptr(io);
5834io_call_close(
VALUE io)
5843 enum {mesg_len =
sizeof(closed_stream)-1};
5844 VALUE mesg = rb_attr_get(exc, idMesg);
5846 RSTRING_LEN(mesg) != mesg_len ||
5847 memcmp(RSTRING_PTR(mesg), closed_stream, mesg_len)) {
5857 if (!UNDEF_P(closed) &&
RTEST(closed))
return io;
5858 rb_rescue2(io_call_close, io, ignore_closed_stream, io,
5894 write_io = GetWriteIO(io);
5895 if (io != write_io) {
5896 write_fptr =
RFILE(write_io)->fptr;
5897 if (write_fptr && 0 <= write_fptr->
fd) {
5902 fptr = rb_io_get_fptr(io);
5903 return RBOOL(0 > fptr->
fd);
5939rb_io_close_read(
VALUE io)
5945 if (fptr->
fd < 0)
return Qnil;
5946 if (is_socket(fptr->
fd, fptr->
pathv)) {
5950 if (shutdown(fptr->
fd, SHUT_RD) < 0)
5951 rb_sys_fail_path(fptr->
pathv);
5952 fptr->
mode &= ~FMODE_READABLE;
5958 write_io = GetWriteIO(io);
5959 if (io != write_io) {
5964 RFILE(io)->fptr = wfptr;
5967 RFILE(write_io)->fptr = fptr;
5968 rb_io_fptr_cleanup(fptr, FALSE);
5974 rb_raise(
rb_eIOError,
"closing non-duplex IO for reading");
6012rb_io_close_write(
VALUE io)
6017 write_io = GetWriteIO(io);
6019 if (fptr->
fd < 0)
return Qnil;
6020 if (is_socket(fptr->
fd, fptr->
pathv)) {
6024 if (shutdown(fptr->
fd, SHUT_WR) < 0)
6025 rb_sys_fail_path(fptr->
pathv);
6026 fptr->
mode &= ~FMODE_WRITABLE;
6033 rb_raise(
rb_eIOError,
"closing non-duplex IO for writing");
6036 if (io != write_io) {
6056rb_io_sysseek(
int argc,
VALUE *argv,
VALUE io)
6058 VALUE offset, ptrname;
6059 int whence = SEEK_SET;
6063 if (
rb_scan_args(argc, argv,
"11", &offset, &ptrname) == 2) {
6064 whence = interpret_seek_whence(ptrname);
6069 (READ_DATA_BUFFERED(fptr) || READ_CHAR_PENDING(fptr))) {
6073 rb_warn(
"sysseek for buffered IO");
6076 pos = lseek(fptr->
fd, pos, whence);
6077 if (pos < 0 &&
errno) rb_sys_fail_path(fptr->
pathv);
6111 io = GetWriteIO(io);
6116 rb_warn(
"syswrite for buffered IO");
6119 tmp = rb_str_tmp_frozen_acquire(str);
6121 n = rb_io_write_memory(fptr, ptr,
len);
6122 if (n < 0) rb_sys_fail_path(fptr->
pathv);
6123 rb_str_tmp_frozen_release(str, tmp);
6140rb_io_sysread(
int argc,
VALUE *argv,
VALUE io)
6151 shrinkable = io_setstrbuf(&str, ilen);
6152 if (ilen == 0)
return str;
6157 if (READ_DATA_BUFFERED(fptr)) {
6163 io_setstrbuf(&str, ilen);
6168 iis.buf = RSTRING_PTR(str);
6171 n = io_read_memory_locktmp(str, &iis);
6174 rb_sys_fail_path(fptr->
pathv);
6177 io_set_read_length(str, n, shrinkable);
6179 if (n == 0 && ilen > 0) {
6195internal_pread_func(
void *_arg)
6199 return (
VALUE)pread(arg->fd, arg->buf, arg->count, arg->offset);
6203pread_internal_call(
VALUE _arg)
6208 if (scheduler !=
Qnil) {
6211 if (!UNDEF_P(result)) {
6216 return rb_io_blocking_region_wait(arg->io, internal_pread_func, arg,
RUBY_IO_READABLE);
6260 shrinkable = io_setstrbuf(&str, (
long)arg.count);
6261 if (arg.count == 0)
return str;
6262 arg.buf = RSTRING_PTR(str);
6275 rb_sys_fail_path(fptr->
pathv);
6277 io_set_read_length(str, n, shrinkable);
6278 if (n == 0 && arg.count > 0) {
6286internal_pwrite_func(
void *_arg)
6290 return (
VALUE)pwrite(arg->fd, arg->buf, arg->count, arg->offset);
6294pwrite_internal_call(
VALUE _arg)
6299 if (scheduler !=
Qnil) {
6302 if (!UNDEF_P(result)) {
6307 return rb_io_blocking_region_wait(arg->io, internal_pwrite_func, arg,
RUBY_IO_WRITABLE);
6348 io = GetWriteIO(io);
6355 tmp = rb_str_tmp_frozen_acquire(str);
6356 arg.buf = RSTRING_PTR(tmp);
6357 arg.count = (size_t)RSTRING_LEN(tmp);
6359 n = (ssize_t)pwrite_internal_call((
VALUE)&arg);
6360 if (n < 0) rb_sys_fail_path(fptr->
pathv);
6361 rb_str_tmp_frozen_release(str, tmp);
6377 fptr->
mode &= ~FMODE_TEXTMODE;
6381 SET_BINARY_MODE_WITH_SEEK_CUR(fptr);
6384 setmode(fptr->
fd, O_BINARY);
6391io_ascii8bit_binmode(
rb_io_t *fptr)
6402 fptr->
mode &= ~FMODE_TEXTMODE;
6403 SET_BINARY_MODE_WITH_SEEK_CUR(fptr);
6405 fptr->
encs.
enc = rb_ascii8bit_encoding();
6409 clear_codeconv(fptr);
6418 io_ascii8bit_binmode(fptr);
6435rb_io_binmode_m(
VALUE io)
6441 write_io = GetWriteIO(io);
6456rb_io_binmode_p(
VALUE io)
6464rb_io_fmode_modestr(
enum rb_io_mode fmode)
6468 return MODE_BTMODE(
"a+",
"ab+",
"at+");
6470 return MODE_BTMODE(
"a",
"ab",
"at");
6474 rb_raise(rb_eArgError,
"invalid access fmode 0x%x", fmode);
6476 return MODE_BTMODE(
"r",
"rb",
"rt");
6478 return MODE_BTXMODE(
"w",
"wb",
"wt",
"wx",
"wbx",
"wtx");
6481 return MODE_BTXMODE(
"w+",
"wb+",
"wt+",
"w+x",
"wb+x",
"wt+x");
6483 return MODE_BTMODE(
"r+",
"rb+",
"rt+");
6487static const char bom_prefix[] =
"bom|";
6488static const char utf_prefix[] =
"utf-";
6489enum {bom_prefix_len = (int)
sizeof(bom_prefix) - 1};
6490enum {utf_prefix_len = (int)
sizeof(utf_prefix) - 1};
6493io_encname_bom_p(
const char *name,
long len)
6495 return len > bom_prefix_len &&
STRNCASECMP(name, bom_prefix, bom_prefix_len) == 0;
6501 enum rb_io_mode fmode = 0;
6502 const char *m = modestr, *p = NULL;
6530 if (modestr[0] !=
'w')
6538 if (io_encname_bom_p(m, p ? (
long)(p - m) : (long)strlen(m)))
6551 rb_raise(rb_eArgError,
"invalid access mode %s", modestr);
6556rb_io_oflags_fmode(
int oflags)
6558 enum rb_io_mode fmode = 0;
6560 switch (oflags & O_ACCMODE) {
6572 if (oflags & O_APPEND) {
6575 if (oflags & O_TRUNC) {
6578 if (oflags & O_CREAT) {
6581 if (oflags & O_EXCL) {
6585 if (oflags & O_BINARY) {
6594rb_io_fmode_oflags(
enum rb_io_mode fmode)
6638rb_io_oflags_modestr(
int oflags)
6641# define MODE_BINARY(a,b) ((oflags & O_BINARY) ? (b) : (a))
6643# define MODE_BINARY(a,b) (a)
6646 if (oflags & O_EXCL) {
6647 rb_raise(rb_eArgError,
"exclusive access mode is not supported");
6649 accmode = oflags & (O_RDONLY|O_WRONLY|O_RDWR);
6650 if (oflags & O_APPEND) {
6651 if (accmode == O_WRONLY) {
6652 return MODE_BINARY(
"a",
"ab");
6654 if (accmode == O_RDWR) {
6655 return MODE_BINARY(
"a+",
"ab+");
6660 rb_raise(rb_eArgError,
"invalid access oflags 0x%x", oflags);
6662 return MODE_BINARY(
"r",
"rb");
6664 return MODE_BINARY(
"w",
"wb");
6666 if (oflags & O_TRUNC) {
6667 return MODE_BINARY(
"w+",
"wb+");
6669 return MODE_BINARY(
"r+",
"rb+");
6681 int default_ext = 0;
6684 ext = rb_default_external_encoding();
6687 if (rb_is_ascii8bit_enc(ext)) {
6691 else if (intern == NULL) {
6692 intern = rb_default_internal_encoding();
6697 *enc = (default_ext && intern != ext) ? NULL : ext;
6707unsupported_encoding(
const char *name,
rb_encoding *enc)
6709 rb_enc_warn(enc,
"Unsupported encoding %s ignored", name);
6713parse_mode_enc(
const char *estr,
rb_encoding *estr_enc,
6719 enum rb_io_mode fmode = fmode_p ? *fmode_p : 0;
6725 p = strrchr(estr,
':');
6726 len = p ? (p++ - estr) : (long)strlen(estr);
6728 estr += bom_prefix_len;
6729 len -= bom_prefix_len;
6730 if (!
STRNCASECMP(estr, utf_prefix, utf_prefix_len)) {
6734 rb_enc_warn(estr_enc,
"BOM with non-UTF encoding %s is nonsense", estr);
6735 fmode &= ~FMODE_SETENC_BY_BOM;
6743 memcpy(encname, estr,
len);
6744 encname[
len] =
'\0';
6747 idx = rb_enc_find_index(estr);
6749 if (fmode_p) *fmode_p = fmode;
6752 ext_enc = rb_enc_from_index(idx);
6755 unsupported_encoding(estr, estr_enc);
6761 if (*p ==
'-' && *(p+1) ==
'\0') {
6766 idx2 = rb_enc_find_index(p);
6768 unsupported_encoding(p, estr_enc);
6773 int_enc = rb_enc_from_index(idx2);
6777 rb_io_ext_int_to_encs(ext_enc, int_enc, enc_p, enc2_p, fmode);
6790 v = rb_hash_lookup2(opt, sym_encoding,
Qnil);
6791 if (v !=
Qnil) encoding = v;
6792 v = rb_hash_lookup2(opt, sym_extenc,
Qundef);
6793 if (v !=
Qnil) extenc = v;
6794 v = rb_hash_lookup2(opt, sym_intenc,
Qundef);
6795 if (!UNDEF_P(v)) intenc = v;
6797 if ((!UNDEF_P(extenc) || !UNDEF_P(intenc)) && !
NIL_P(encoding)) {
6799 int idx = rb_to_encoding_index(encoding);
6800 if (idx >= 0) encoding = rb_enc_from_encoding(rb_enc_from_index(idx));
6801 rb_warn(
"Ignoring encoding parameter '%"PRIsVALUE
"': %s_encoding is used",
6802 encoding, UNDEF_P(extenc) ?
"internal" :
"external");
6806 if (!UNDEF_P(extenc) && !
NIL_P(extenc)) {
6807 extencoding = rb_to_encoding(extenc);
6809 if (!UNDEF_P(intenc)) {
6810 if (
NIL_P(intenc)) {
6817 if (*p ==
'-' && *(p+1) ==
'\0') {
6822 intencoding = rb_to_encoding(intenc);
6826 intencoding = rb_to_encoding(intenc);
6828 if (extencoding == intencoding) {
6832 if (!
NIL_P(encoding)) {
6836 enc_p, enc2_p, fmode_p);
6839 rb_io_ext_int_to_encs(rb_to_encoding(encoding), NULL, enc_p, enc2_p, 0);
6842 else if (!UNDEF_P(extenc) || !UNDEF_P(intenc)) {
6844 rb_io_ext_int_to_encs(extencoding, intencoding, enc_p, enc2_p, 0);
6852 enum rb_io_mode fmode = *fmode_p;
6857 !rb_enc_asciicompat(enc ? enc : rb_default_external_encoding()))
6858 rb_raise(rb_eArgError,
"ASCII incompatible encoding needs binmode");
6861 rb_raise(rb_eArgError,
"newline decorator with binary mode");
6868#if !DEFAULT_TEXTMODE
6870 fmode &= ~FMODE_TEXTMODE;
6877extract_binmode(
VALUE opthash,
enum rb_io_mode *fmode)
6879 if (!
NIL_P(opthash)) {
6881 v = rb_hash_aref(opthash, sym_textmode);
6884 rb_raise(rb_eArgError,
"textmode specified twice");
6886 rb_raise(rb_eArgError,
"both textmode and binmode specified");
6890 v = rb_hash_aref(opthash, sym_binmode);
6893 rb_raise(rb_eArgError,
"binmode specified twice");
6895 rb_raise(rb_eArgError,
"both textmode and binmode specified");
6901 rb_raise(rb_eArgError,
"both textmode and binmode specified");
6907 int *oflags_p,
enum rb_io_mode *fmode_p,
struct rb_io_encoding *convconfig_p)
6911 enum rb_io_mode fmode;
6915 int has_enc = 0, has_vmode = 0;
6921 rb_io_ext_int_to_encs(NULL, NULL, &enc, &enc2, 0);
6931 fmode = rb_io_oflags_fmode(oflags);
6939 oflags = rb_io_fmode_oflags(fmode);
6943 parse_mode_enc(p+1, rb_enc_get(vmode), &enc, &enc2, &fmode);
6948 e = (fmode &
FMODE_BINMODE) ? rb_ascii8bit_encoding() : NULL;
6949 rb_io_ext_int_to_encs(e, NULL, &enc, &enc2, fmode);
6953 if (
NIL_P(opthash)) {
6957#ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE
6959 MODE_BTMODE(TEXTMODE_NEWLINE_DECORATOR_ON_WRITE,
6960 0, TEXTMODE_NEWLINE_DECORATOR_ON_WRITE) : 0;
6962 SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags);
6969 rb_io_ext_int_to_encs(rb_ascii8bit_encoding(), NULL, &enc, &enc2, fmode);
6972 else if (
NIL_P(vmode)) {
6973 fmode |= DEFAULT_TEXTMODE;
6980 v = rb_hash_aref(opthash, sym_mode);
6982 if (!
NIL_P(vmode)) {
6983 rb_raise(rb_eArgError,
"mode specified twice");
6990 v = rb_hash_aref(opthash, sym_flags);
6995 fmode = rb_io_oflags_fmode(oflags);
6997 extract_binmode(opthash, &fmode);
7003 rb_io_ext_int_to_encs(rb_ascii8bit_encoding(), NULL, &enc, &enc2, fmode);
7006 else if (
NIL_P(vmode)) {
7007 fmode |= DEFAULT_TEXTMODE;
7010 v = rb_hash_aref(opthash, sym_perm);
7013 if (!
NIL_P(*vperm_p)) {
7014 rb_raise(rb_eArgError,
"perm specified twice");
7025#ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE
7027 MODE_BTMODE(TEXTMODE_NEWLINE_DECORATOR_ON_WRITE,
7028 0, TEXTMODE_NEWLINE_DECORATOR_ON_WRITE) : 0;
7033 rb_raise(rb_eArgError,
"encoding specified twice");
7036 SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags);
7040 validate_enc_binmode(&fmode, ecflags, enc, enc2);
7046 convconfig_p->
enc = enc;
7047 convconfig_p->
enc2 = enc2;
7048 convconfig_p->
ecflags = ecflags;
7049 convconfig_p->
ecopts = ecopts;
7059sysopen_func(
void *ptr)
7062 const char *fname = RSTRING_PTR(data->fname);
7071 fd = IO_WITHOUT_GVL_INT(sysopen_func, data);
7072 }
while (fd < 0 &&
errno == EINTR);
7079rb_sysopen(
VALUE fname,
int oflags, mode_t perm)
7084 data.fname = rb_str_encode_ospath(fname);
7086 data.oflags = oflags;
7089 TRY_WITH_GC((fd = rb_sysopen_internal(&data)) >= 0) {
7090 rb_syserr_fail_path(first_errno, fname);
7096fdopen_internal(
int fd,
const char *modestr)
7103 file = fdopen(fd, modestr);
7119 TRY_WITH_GC((file = fdopen_internal(fd, modestr)) != 0) {
7125 if (setvbuf(file, NULL, _IOFBF, 0) != 0)
7126 rb_warn(
"setvbuf() can't be honoured (fd=%d)", fd);
7134 int t = isatty(fptr->
fd);
7144io_strip_bom(
VALUE io)
7146 VALUE b1, b2, b3, b4;
7157 return rb_utf8_encindex();
7167 return ENCINDEX_UTF_16BE;
7178 return ENCINDEX_UTF_32LE;
7183 return ENCINDEX_UTF_16LE;
7193 return ENCINDEX_UTF_32BE;
7207io_set_encoding_by_bom(
VALUE io)
7209 int idx = io_strip_bom(io);
7215 extenc = rb_enc_from_index(idx);
7216 io_encoding_set(fptr, rb_enc_from_encoding(extenc),
7217 rb_io_internal_encoding(io),
Qnil);
7226rb_file_open_generic(
VALUE io,
VALUE filename,
int oflags,
enum rb_io_mode fmode,
7234 rb_io_ext_int_to_encs(NULL, NULL, &cc.enc, &cc.enc2, fmode);
7239 validate_enc_binmode(&fmode, convconfig->
ecflags,
7240 convconfig->
enc, convconfig->
enc2);
7244 fptr->
encs = *convconfig;
7247 if (!(oflags & O_TMPFILE)) {
7248 fptr->
pathv = pathv;
7251 fptr->
pathv = pathv;
7253 fptr->
fd = rb_sysopen(pathv, oflags, perm);
7261rb_file_open_internal(
VALUE io,
VALUE filename,
const char *modestr)
7264 const char *p = strchr(modestr,
':');
7268 parse_mode_enc(p+1, rb_usascii_encoding(),
7269 &convconfig.
enc, &convconfig.
enc2, &fmode);
7275 e = (fmode &
FMODE_BINMODE) ? rb_ascii8bit_encoding() : NULL;
7276 rb_io_ext_int_to_encs(e, NULL, &convconfig.
enc, &convconfig.
enc2, fmode);
7282#ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE
7284 MODE_BTMODE(TEXTMODE_NEWLINE_DECORATOR_ON_WRITE,
7285 0, TEXTMODE_NEWLINE_DECORATOR_ON_WRITE) : 0;
7287 SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(convconfig.
enc2, convconfig.
ecflags);
7290 return rb_file_open_generic(io, filename,
7291 rb_io_fmode_oflags(fmode),
7301 return rb_file_open_internal(io_alloc(
rb_cFile), fname, modestr);
7310#if defined(__CYGWIN__) || !defined(HAVE_WORKING_FORK)
7333 while ((tmp = *prev) != 0) {
7334 if (tmp->fptr == fptr) {
7343#if defined (_WIN32) || defined(__CYGWIN__)
7359pipe_finalize(
rb_io_t *fptr,
int noraise)
7361#if !defined(HAVE_WORKING_FORK) && !defined(_WIN32)
7370 fptr_finalize(fptr, noraise);
7372 pipe_del_fptr(fptr);
7379#if defined(__CYGWIN__) || !defined(HAVE_WORKING_FORK)
7380 void (*
const old_finalize)(
struct rb_io*,int) = fptr->
finalize;
7382 if (old_finalize == orig->finalize)
return;
7387#if defined(__CYGWIN__) || !defined(HAVE_WORKING_FORK)
7388 if (old_finalize != pipe_finalize) {
7390 for (list =
pipe_list; list; list = list->next) {
7391 if (list->fptr == fptr)
break;
7393 if (!list) pipe_add_fptr(fptr);
7396 pipe_del_fptr(fptr);
7409rb_io_unbuffered(
rb_io_t *fptr)
7427#define HAVE_SPAWNV 1
7428#define spawnv(mode, cmd, args) rb_w32_uaspawn((mode), (cmd), (args))
7429#define spawn(mode, cmd) rb_w32_uspawn((mode), (cmd), 0)
7432#if defined(HAVE_WORKING_FORK) || defined(HAVE_SPAWNV)
7442#ifdef HAVE_WORKING_FORK
7443# ifndef __EMSCRIPTEN__
7445popen_redirect(
struct popen_arg *p)
7448 close(p->write_pair[1]);
7449 if (p->write_pair[0] != 0) {
7450 dup2(p->write_pair[0], 0);
7451 close(p->write_pair[0]);
7454 if (p->pair[1] != 1) {
7455 dup2(p->pair[1], 1);
7461 if (p->pair[1] != 1) {
7462 dup2(p->pair[1], 1);
7468 if (p->pair[0] != 0) {
7469 dup2(p->pair[0], 0);
7476#if defined(__linux__)
7487linux_get_maxfd(
void)
7490 char buf[4096], *p, *np, *e;
7493 if (fd < 0)
return fd;
7494 ss = read(fd, buf,
sizeof(buf));
7495 if (ss < 0)
goto err;
7498 while ((
int)
sizeof(
"FDSize:\t0\n")-1 <= e-p &&
7499 (np = memchr(p,
'\n', e-p)) != NULL) {
7500 if (memcmp(p,
"FDSize:",
sizeof(
"FDSize:")-1) == 0) {
7502 p +=
sizeof(
"FDSize:")-1;
7522#if defined(HAVE_FCNTL) && defined(F_GETFD) && defined(F_SETFD) && defined(FD_CLOEXEC)
7524 int max = (int)max_file_descriptor;
7527 ret = fcntl(0, F_MAXFD);
7529 maxhint = max = ret;
7530# elif defined(__linux__)
7531 ret = linux_get_maxfd();
7538 for (fd = lowfd; fd <= max; fd++) {
7539 if (!
NIL_P(noclose_fds) &&
7542 ret = fcntl(fd, F_GETFD);
7543 if (ret != -1 && !(ret & FD_CLOEXEC)) {
7544 fcntl(fd, F_SETFD, ret|FD_CLOEXEC);
7546# define CONTIGUOUS_CLOSED_FDS 20
7548 if (max < fd + CONTIGUOUS_CLOSED_FDS)
7549 max = fd + CONTIGUOUS_CLOSED_FDS;
7555# ifndef __EMSCRIPTEN__
7557popen_exec(
void *pp,
char *errmsg,
size_t errmsg_len)
7559 struct popen_arg *p = (
struct popen_arg*)pp;
7561 return rb_exec_async_signal_safe(p->eargp, errmsg, errmsg_len);
7566#if (defined(HAVE_WORKING_FORK) || defined(HAVE_SPAWNV)) && !defined __EMSCRIPTEN__
7568rb_execarg_fixup_v(
VALUE execarg_obj)
7570 rb_execarg_parent_start(execarg_obj);
7574char *rb_execarg_commandline(
const struct rb_execarg *eargp,
VALUE *prog);
7577#ifndef __EMSCRIPTEN__
7579pipe_open(
VALUE execarg_obj,
const char *modestr,
enum rb_io_mode fmode,
7582 struct rb_execarg *eargp =
NIL_P(execarg_obj) ? NULL : rb_execarg_get(execarg_obj);
7583 VALUE prog = eargp ? (eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name) :
Qfalse ;
7589#if defined(HAVE_WORKING_FORK)
7591 char errmsg[80] = {
'\0' };
7593#if defined(HAVE_WORKING_FORK) || defined(HAVE_SPAWNV)
7595 struct popen_arg arg;
7598#if defined(HAVE_SPAWNV)
7599# if defined(HAVE_SPAWNVE)
7600# define DO_SPAWN(cmd, args, envp) ((args) ? \
7601 spawnve(P_NOWAIT, (cmd), (args), (envp)) : \
7602 spawne(P_NOWAIT, (cmd), (envp)))
7604# define DO_SPAWN(cmd, args, envp) ((args) ? \
7605 spawnv(P_NOWAIT, (cmd), (args)) : \
7606 spawn(P_NOWAIT, (cmd)))
7608# if !defined(HAVE_WORKING_FORK)
7610# if defined(HAVE_SPAWNVE)
7615#if !defined(HAVE_WORKING_FORK)
7621#if !defined(HAVE_WORKING_FORK)
7622 const char *cmd = 0;
7628#if defined(HAVE_WORKING_FORK) || defined(HAVE_SPAWNV)
7629 arg.execarg_obj = execarg_obj;
7632 arg.pair[0] = arg.pair[1] = -1;
7633 arg.write_pair[0] = arg.write_pair[1] = -1;
7634# if !defined(HAVE_WORKING_FORK)
7635 if (eargp && !eargp->use_shell) {
7636 args = ARGVSTR2ARGV(eargp->invoke.cmd.argv_str);
7641 if (
rb_pipe(arg.write_pair) < 0)
7642 rb_sys_fail_str(prog);
7645 close(arg.write_pair[0]);
7646 close(arg.write_pair[1]);
7650 rb_execarg_addopt(execarg_obj,
INT2FIX(0),
INT2FIX(arg.write_pair[0]));
7651 rb_execarg_addopt(execarg_obj,
INT2FIX(1),
INT2FIX(arg.pair[1]));
7656 rb_sys_fail_str(prog);
7658 rb_execarg_addopt(execarg_obj,
INT2FIX(1),
INT2FIX(arg.pair[1]));
7662 rb_sys_fail_str(prog);
7664 rb_execarg_addopt(execarg_obj,
INT2FIX(0),
INT2FIX(arg.pair[0]));
7667 rb_sys_fail_str(prog);
7669 if (!
NIL_P(execarg_obj)) {
7670 rb_protect(rb_execarg_fixup_v, execarg_obj, &state);
7672 if (0 <= arg.write_pair[0]) close(arg.write_pair[0]);
7673 if (0 <= arg.write_pair[1]) close(arg.write_pair[1]);
7674 if (0 <= arg.pair[0]) close(arg.pair[0]);
7675 if (0 <= arg.pair[1]) close(arg.pair[1]);
7676 rb_execarg_parent_end(execarg_obj);
7680# if defined(HAVE_WORKING_FORK)
7681 pid = rb_fork_async_signal_safe(&status, popen_exec, &arg, arg.eargp->redirect_fds, errmsg,
sizeof(errmsg));
7683 rb_execarg_run_options(eargp, sargp, NULL, 0);
7684# if defined(HAVE_SPAWNVE)
7685 if (eargp->envp_str) envp = (
char **)RSTRING_PTR(eargp->envp_str);
7687 while ((pid = DO_SPAWN(cmd, args, envp)) < 0) {
7689 switch (e =
errno) {
7691# if EWOULDBLOCK != EAGAIN
7700 rb_execarg_run_options(sargp, NULL, NULL, 0);
7702 rb_execarg_parent_end(execarg_obj);
7705# if defined(HAVE_WORKING_FORK)
7706 pid = rb_call_proc__fork();
7708 popen_redirect(&arg);
7720# if defined(HAVE_WORKING_FORK)
7726 close(arg.write_pair[0]);
7727 close(arg.write_pair[1]);
7729# if defined(HAVE_WORKING_FORK)
7738 close(arg.write_pair[0]);
7739 write_fd = arg.write_pair[1];
7750 cmd = rb_execarg_commandline(eargp, &prog);
7751 if (!
NIL_P(execarg_obj)) {
7752 rb_execarg_parent_start(execarg_obj);
7753 rb_execarg_run_options(eargp, sargp, NULL, 0);
7755 fp = popen(cmd, modestr);
7758 rb_execarg_parent_end(execarg_obj);
7759 rb_execarg_run_options(sargp, NULL, NULL, 0);
7761 if (!fp) rb_syserr_fail_path(e, prog);
7771 fptr->
encs = *convconfig;
7772#if RUBY_CRLF_ENVIRONMENT
7779 if (NEED_NEWLINE_DECORATOR_ON_READ(fptr)) {
7782#ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE
7783 if (NEED_NEWLINE_DECORATOR_ON_WRITE(fptr)) {
7784 fptr->
encs.
ecflags |= TEXTMODE_NEWLINE_DECORATOR_ON_WRITE;
7790 if (0 <= write_fd) {
7791 write_port = io_alloc(
rb_cIO);
7793 write_fptr->
fd = write_fd;
7795 fptr->
mode &= ~FMODE_WRITABLE;
7797 rb_ivar_set(port, rb_intern(
"@tied_io_for_writing"), write_port);
7800#if defined (__CYGWIN__) || !defined(HAVE_WORKING_FORK)
7802 pipe_add_fptr(fptr);
7808pipe_open(
VALUE execarg_obj,
const char *modestr,
enum rb_io_mode fmode,
7816is_popen_fork(
VALUE prog)
7818 if (RSTRING_LEN(prog) == 1 && RSTRING_PTR(prog)[0] ==
'-') {
7819#if !defined(HAVE_WORKING_FORK)
7821 "fork() function is unimplemented on this machine");
7830pipe_open_s(
VALUE prog,
const char *modestr,
enum rb_io_mode fmode,
7834 VALUE *argv = &prog;
7837 if (!is_popen_fork(prog))
7838 execarg_obj = rb_execarg_new(argc, argv, TRUE, FALSE);
7839 return pipe_open(execarg_obj, modestr, fmode, convconfig);
7845 rb_io_t *fptr = io_close_fptr(io);
8014rb_io_s_popen(
int argc,
VALUE *argv,
VALUE klass)
8018 if (argc > 1 && !
NIL_P(opt = rb_check_hash_type(argv[argc-1]))) --argc;
8019 if (argc > 1 && !
NIL_P(env = rb_check_hash_type(argv[0]))) --argc, ++argv;
8028 int ex = !
NIL_P(opt);
8029 rb_error_arity(argc + ex, 1 + ex, 2 + ex);
8032 return popen_finish(rb_io_popen(pname, pmode, env, opt), klass);
8038 const char *modestr;
8041 enum rb_io_mode fmode;
8047#if SIZEOF_LONG > SIZEOF_INT
8048 if (
len > INT_MAX) {
8049 rb_raise(rb_eArgError,
"too many arguments");
8058 if (!is_popen_fork(pname))
8059 execarg_obj = rb_execarg_new(1, &pname, TRUE, FALSE);
8061 if (!
NIL_P(execarg_obj)) {
8063 opt = rb_execarg_extract_options(execarg_obj, opt);
8065 rb_execarg_setenv(execarg_obj, env);
8068 modestr = rb_io_oflags_modestr(oflags);
8070 return pipe_open(execarg_obj, modestr, fmode, &convconfig);
8080 rb_io_flush(rb_ractor_stdout());
8081 rb_io_flush(rb_ractor_stderr());
8086 RBASIC_SET_CLASS(port, klass);
8093#if defined(HAVE_WORKING_FORK) && !defined(__EMSCRIPTEN__)
8094struct popen_writer_arg {
8096 struct popen_arg popen;
8100exec_popen_writer(
void *arg,
char *errmsg,
size_t buflen)
8102 struct popen_writer_arg *pw = arg;
8104 popen_redirect(&pw->popen);
8105 execv(pw->argv[0], pw->argv);
8106 strlcpy(errmsg, strerror(
errno), buflen);
8112ruby_popen_writer(
char *
const *argv, rb_pid_t *pid)
8114#if (defined(HAVE_WORKING_FORK) && !defined(__EMSCRIPTEN__)) || defined(_WIN32)
8115# ifdef HAVE_WORKING_FORK
8116 struct popen_writer_arg pw;
8117 int *
const write_pair = pw.popen.pair;
8123 int result = pipe2(write_pair, O_CLOEXEC);
8125 int result = pipe(write_pair);
8130# ifdef HAVE_WORKING_FORK
8133 char errmsg[80] = {
'\0'};
8134 *pid = rb_fork_async_signal_safe(&status, exec_popen_writer, &pw,
Qnil, errmsg,
sizeof(errmsg));
8136 *pid = rb_w32_uspawn_process(P_NOWAIT, argv[0], argv, write_pair[0], -1, -1, 0);
8137 const char *errmsg = (*pid < 0) ? strerror(
errno) : NULL;
8139 close(write_pair[0]);
8141 close(write_pair[1]);
8142 fprintf(stderr,
"ruby_popen_writer(%s): %s\n", argv[0], errmsg);
8145 return fdopen(write_pair[1],
"w");
8156 enum rb_io_mode fmode;
8165 rb_file_open_generic(io, fname, oflags, fmode, &convconfig, perm);
8203rb_io_s_open(
int argc,
VALUE *argv,
VALUE klass)
8235 VALUE fname, vmode, vperm;
8240 rb_scan_args(argc, argv,
"12", &fname, &vmode, &vperm);
8251 if (
NIL_P(vperm)) perm = 0666;
8255 fd = rb_sysopen(fname, oflags, perm);
8287 int redirect = FALSE;
8295 VALUE tmp = argv[0];
8313 return rb_io_s_open(argc, argv,
rb_cFile);
8317rb_io_open_generic(
VALUE klass,
VALUE filename,
int oflags,
enum rb_io_mode fmode,
8320 return rb_file_open_generic(io_alloc(klass), filename,
8321 oflags, fmode, convconfig, perm);
8328 enum rb_io_mode fmode;
8334 return rb_io_open_generic(io, filename, oflags, fmode, &convconfig, perm);
8348 if (fptr == orig)
return io;
8349 if (RUBY_IO_EXTERNAL_P(fptr)) {
8353 rb_raise(rb_eArgError,
8354 "%s can't change access mode from \"%s\" to \"%s\"",
8355 PREP_STDIO_NAME(fptr), rb_io_fmode_modestr(fptr->
mode),
8356 rb_io_fmode_modestr(orig->
mode));
8360 if (io_fflush(fptr) < 0)
8361 rb_sys_fail_on_write(fptr);
8364 flush_before_seek(fptr,
true);
8367 pos = io_tell(orig);
8370 if (io_fflush(orig) < 0)
8371 rb_sys_fail_on_write(fptr);
8380 else if (!RUBY_IO_EXTERNAL_P(fptr)) fptr->
pathv =
Qnil;
8381 fptr_copy_finalizer(fptr, orig);
8387 rb_thread_io_close_interrupt(fptr);
8388 rb_thread_io_close_wait(fptr);
8390 if (RUBY_IO_EXTERNAL_P(fptr) || fd <= 2 || !fptr->stdio_file) {
8393 rb_sys_fail_path(orig->
pathv);
8401 rb_sys_fail_path(orig->
pathv);
8407 if (io_seek(fptr, pos, SEEK_SET) < 0 &&
errno) {
8408 rb_sys_fail_path(fptr->
pathv);
8410 if (io_seek(orig, pos, SEEK_SET) < 0 &&
errno) {
8411 rb_sys_fail_path(orig->
pathv);
8425int rb_freopen(
VALUE fname,
const char *mode,
FILE *fp);
8428rb_freopen(
VALUE fname,
const char *mode,
FILE *fp)
8430 if (!freopen(RSTRING_PTR(fname), mode, fp)) {
8473rb_io_reopen(
int argc,
VALUE *argv,
VALUE file)
8475 VALUE fname, nmode, opt;
8479 if (
rb_scan_args(argc, argv,
"11:", &fname, &nmode, &opt) == 1) {
8482 return io_reopen(file, tmp);
8488 fptr =
RFILE(file)->fptr;
8494 enum rb_io_mode fmode;
8498 if (RUBY_IO_EXTERNAL_P(fptr) &&
8501 rb_raise(rb_eArgError,
8502 "%s can't change access mode from \"%s\" to \"%s\"",
8503 PREP_STDIO_NAME(fptr), rb_io_fmode_modestr(fptr->
mode),
8504 rb_io_fmode_modestr(fmode));
8507 fptr->
encs = convconfig;
8510 oflags = rb_io_fmode_oflags(fptr->
mode);
8513 fptr->
pathv = fname;
8515 fptr->
fd = rb_sysopen(fptr->
pathv, oflags, 0666);
8521 if (io_fflush(fptr) < 0)
8522 rb_sys_fail_on_write(fptr);
8527 int e = rb_freopen(rb_str_encode_ospath(fptr->
pathv),
8528 rb_io_oflags_modestr(oflags),
8530 if (e) rb_syserr_fail_path(e, fptr->
pathv);
8534 if (setvbuf(fptr->
stdio_file, NULL, _IOFBF, 0) != 0)
8535 rb_warn(
"setvbuf() can't be honoured for %"PRIsVALUE, fptr->
pathv);
8538 if (setvbuf(fptr->
stdio_file, NULL, _IONBF, BUFSIZ) != 0)
8539 rb_warn(
"setvbuf() can't be honoured for %"PRIsVALUE, fptr->
pathv);
8541 else if (fptr->
stdio_file == stdout && isatty(fptr->
fd)) {
8542 if (setvbuf(fptr->
stdio_file, NULL, _IOLBF, BUFSIZ) != 0)
8543 rb_warn(
"setvbuf() can't be honoured for %"PRIsVALUE, fptr->
pathv);
8547 int tmpfd = rb_sysopen(fptr->
pathv, oflags, 0666);
8553 rb_syserr_fail_path(err, fptr->
pathv);
8577 fptr->
mode = orig->
mode & ~FMODE_EXTERNAL;
8584 fptr->closing_ec = NULL;
8585 fptr->wakeup_mutex =
Qnil;
8586 fptr->fork_generation = GET_VM()->fork_gen;
8589 fptr_copy_finalizer(fptr, orig);
8591 fd = ruby_dup(orig->
fd);
8593 pos = io_tell(orig);
8595 io_seek(fptr, pos, SEEK_SET);
8600 write_io = GetWriteIO(io);
8601 if (io != write_io) {
8604 rb_ivar_set(dest, rb_intern(
"@tied_io_for_writing"), write_io);
8667 if (argc == 0)
return Qnil;
8669 out = rb_ractor_stdout();
8681extern void rb_deprecated_str_setter(
VALUE val,
ID id,
VALUE *var);
8686 rb_deprecated_str_setter(val,
id, &val);
8692 val = rb_str_frozen_bare_string(val);
8769 for (i=0; i<argc; i++) {
8773 rb_io_write(out, argv[i]);
8870 rb_io_write(io, str);
8874#define forward(obj, id, argc, argv) \
8875 rb_funcallv_kw(obj, id, argc, argv, RB_PASS_CALLED_KEYWORDS)
8876#define forward_public(obj, id, argc, argv) \
8877 rb_funcallv_public_kw(obj, id, argc, argv, RB_PASS_CALLED_KEYWORDS)
8878#define forward_current(id, argc, argv) \
8879 forward_public(ARGF.current_file, id, argc, argv)
8896 VALUE r_stdout = rb_ractor_stdout();
8897 if (recv == r_stdout) {
8898 return rb_io_putc(recv, ch);
8900 return forward(r_stdout, rb_intern(
"putc"), 1, &ch);
8905rb_str_end_with_asciichar(
VALUE str,
int c)
8907 long len = RSTRING_LEN(str);
8908 const char *
ptr = RSTRING_PTR(str);
8912 if (
len == 0)
return 0;
8913 if ((n = rb_enc_mbminlen(
enc)) == 1) {
8914 return ptr[
len - 1] == c;
8916 return rb_enc_ascget(
ptr + ((
len - 1) / n) * n,
ptr +
len, &n,
enc) == c;
8927 rb_io_puts(1, &tmp, out);
8934 rb_io_puts(1, &tmp, out);
8989 VALUE line, args[2];
8996 for (
int i = 0; i < argc; i++) {
9010 if (RSTRING_LEN(line) == 0) {
9015 if (!rb_str_end_with_asciichar(line,
'\n')) {
9020 rb_io_writev(out, n, args);
9038 VALUE r_stdout = rb_ractor_stdout();
9039 if (recv == r_stdout) {
9040 return rb_io_puts(argc, argv, recv);
9042 return forward(r_stdout, rb_intern(
"puts"), argc, argv);
9046rb_p_write(
VALUE str)
9051 VALUE r_stdout = rb_ractor_stdout();
9053 rb_method_basic_definition_p(
CLASS_OF(r_stdout), id_write)) {
9054 io_writev(2, args, r_stdout);
9057 rb_io_writev(r_stdout, 2, args);
9069rb_p_result(
int argc,
const VALUE *argv)
9076 else if (argc > 1) {
9079 VALUE r_stdout = rb_ractor_stdout();
9081 rb_uninterruptible(rb_io_flush, r_stdout);
9122 for (i=0; i<argc; i++) {
9124 rb_uninterruptible(rb_p_write, inspected);
9126 return rb_p_result(argc, argv);
9147rb_obj_display(
int argc,
VALUE *argv,
VALUE self)
9151 out = (!
rb_check_arity(argc, 0, 1) ? rb_ractor_stdout() : argv[0]);
9152 rb_io_write(out, self);
9158rb_stderr_to_original_p(
VALUE err)
9160 return (err == orig_stderr ||
RFILE(orig_stderr)->fptr->
fd < 0);
9166 VALUE out = rb_ractor_stderr();
9167 if (rb_stderr_to_original_p(out)) {
9169 if (isatty(fileno(stderr))) {
9170 if (rb_w32_write_console(
rb_str_new(mesg,
len), fileno(stderr)) > 0)
return;
9173 if (fwrite(mesg,
sizeof(
char), (
size_t)
len, stderr) < (
size_t)
len) {
9190rb_write_error_str(
VALUE mesg)
9192 VALUE out = rb_ractor_stderr();
9194 if (rb_stderr_to_original_p(out)) {
9195 size_t len = (size_t)RSTRING_LEN(mesg);
9197 if (isatty(fileno(stderr))) {
9198 if (rb_w32_write_console(mesg, fileno(stderr)) > 0)
return;
9201 if (fwrite(RSTRING_PTR(mesg),
sizeof(
char),
len, stderr) <
len) {
9208 rb_io_write(out, mesg);
9213rb_stderr_tty_p(
void)
9215 if (rb_stderr_to_original_p(rb_ractor_stderr()))
9216 return isatty(fileno(stderr));
9221must_respond_to(
ID mid,
VALUE val,
ID id)
9224 rb_raise(
rb_eTypeError,
"%"PRIsVALUE
" must have %"PRIsVALUE
" method, %"PRIsVALUE
" given",
9225 rb_id2str(
id), rb_id2str(mid),
9245 must_respond_to(id_write, val,
id);
9252 return rb_ractor_stdout();
9258 must_respond_to(id_write, val,
id);
9265 return rb_ractor_stderr();
9269allocate_and_open_new_file(
VALUE klass)
9271 VALUE self = io_alloc(klass);
9272 rb_io_make_open_file(self);
9280 VALUE self = rb_protect(allocate_and_open_new_file, klass, &state);
9288 maygvl_close(descriptor, 0);
9296 io->
fd = descriptor;
9314 io->closing_ec = NULL;
9315 io->wakeup_mutex =
Qnil;
9316 io->fork_generation = GET_VM()->fork_gen;
9319 io->
encs = *encoding;
9328prep_io(
int fd,
enum rb_io_mode fmode,
VALUE klass,
const char *path)
9338 e = (fmode &
FMODE_BINMODE) ? rb_ascii8bit_encoding() : NULL;
9339 rb_io_ext_int_to_encs(e, NULL, &convconfig.
enc, &convconfig.
enc2, fmode);
9343#ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE
9345 MODE_BTMODE(TEXTMODE_NEWLINE_DECORATOR_ON_WRITE,
9346 0, TEXTMODE_NEWLINE_DECORATOR_ON_WRITE) : 0;
9348 SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(convconfig.
enc2, convconfig.
ecflags);
9354 if (!io_check_tty(io)) {
9357 setmode(fd, O_BINARY);
9369 if (path && strcmp(path,
"-")) klass =
rb_cFile;
9370 return prep_io(fd, rb_io_oflags_fmode(oflags), klass, path);
9374prep_stdio(
FILE *f,
enum rb_io_mode fmode,
VALUE klass,
const char *path)
9381#ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE
9382 fptr->
encs.
ecflags |= TEXTMODE_NEWLINE_DECORATOR_ON_WRITE;
9393rb_io_prep_stdin(
void)
9399rb_io_prep_stdout(
void)
9405rb_io_prep_stderr(
void)
9414 int oflags = rb_io_fmode_oflags(fptr->
mode) & ~O_EXCL;
9441 rb_io_buffer_init(&fp->
wbuf);
9442 rb_io_buffer_init(&fp->
rbuf);
9443 rb_io_buffer_init(&fp->
cbuf);
9458 fp->closing_ec = NULL;
9459 fp->wakeup_mutex =
Qnil;
9460 fp->fork_generation = GET_VM()->fork_gen;
9465rb_io_make_open_file(
VALUE obj)
9470 if (
RFILE(obj)->fptr) {
9473 RFILE(obj)->fptr = 0;
9475 fp = rb_io_fptr_new();
9477 RFILE(obj)->fptr = fp;
9526rb_io_initialize(
int argc,
VALUE *argv,
VALUE io)
9532 return io_initialize(io, fnum, vmode, opt);
9539 int fd, oflags = O_RDONLY;
9540 enum rb_io_mode fmode;
9542#if defined(HAVE_FCNTL) && defined(F_GETFL)
9552 rb_raise(rb_eArgError,
"The given fd is not accessible because RubyVM reserves it");
9554#if defined(HAVE_FCNTL) && defined(F_GETFL)
9555 oflags = fcntl(fd, F_GETFL);
9556 if (oflags == -1) rb_sys_fail(0);
9558 if (fstat(fd, &st) < 0) rb_sys_fail(0);
9561#if defined(HAVE_FCNTL) && defined(F_GETFL)
9562 ofmode = rb_io_oflags_fmode(oflags);
9574 if (rb_hash_aref(opt, sym_autoclose) ==
Qfalse) {
9578 path = rb_hash_aref(opt,
RB_ID2SYM(idPath));
9589 fp->
encs = convconfig;
9593 fp->closing_ec = NULL;
9594 fp->wakeup_mutex =
Qnil;
9595 fp->fork_generation = GET_VM()->fork_gen;
9598 if (fileno(stdin) == fd)
9600 else if (fileno(stdout) == fd)
9602 else if (fileno(stderr) == fd)
9634rb_io_set_encoding_by_bom(
VALUE io)
9640 rb_raise(rb_eArgError,
"ASCII incompatible encoding needs binmode");
9643 rb_raise(rb_eArgError,
"encoding conversion is set");
9645 else if (fptr->
encs.
enc && fptr->
encs.
enc != rb_ascii8bit_encoding()) {
9646 rb_raise(rb_eArgError,
"encoding is set to %s already",
9649 if (!io_set_encoding_by_bom(io))
return Qnil;
9650 return rb_enc_from_encoding(fptr->
encs.
enc);
9695rb_file_initialize(
int argc,
VALUE *argv,
VALUE io)
9697 if (
RFILE(io)->fptr) {
9700 VALUE fname, vmode, vperm, opt;
9701 int posargc =
rb_scan_args(argc, argv,
"12:", &fname, &vmode, &vperm, &opt);
9706 return io_initialize(io, fd, vmode, opt);
9709 return rb_open_file(io, fname, vmode, vperm, opt);
9714rb_io_s_new(
int argc,
VALUE *argv,
VALUE klass)
9719 rb_warn(
"%"PRIsVALUE
"::new() does not take block; use %"PRIsVALUE
"::open() instead",
9735rb_io_s_for_fd(
int argc,
VALUE *argv,
VALUE klass)
9738 rb_io_initialize(argc, argv, io);
9751rb_io_autoclose_p(
VALUE io)
9776rb_io_set_autoclose(
VALUE io,
VALUE autoclose)
9780 if (!
RTEST(autoclose))
9783 fptr->
mode &= ~FMODE_EXTERNAL;
9788io_wait_event(
VALUE io,
int event,
VALUE timeout,
int return_io)
9820io_wait_readable(
int argc,
VALUE *argv,
VALUE io)
9827 if (rb_io_read_pending(fptr))
return Qtrue;
9830 VALUE timeout = (argc == 1 ? argv[0] :
Qnil);
9844io_wait_writable(
int argc,
VALUE *argv,
VALUE io)
9852 VALUE timeout = (argc == 1 ? argv[0] :
Qnil);
9867io_wait_priority(
int argc,
VALUE *argv,
VALUE io)
9874 if (rb_io_read_pending(fptr))
return Qtrue;
9877 VALUE timeout = argc == 1 ? argv[0] :
Qnil;
9883wait_mode_sym(
VALUE mode)
9885 if (mode ==
ID2SYM(rb_intern(
"r"))) {
9886 return RB_WAITFD_IN;
9888 if (mode ==
ID2SYM(rb_intern(
"read"))) {
9889 return RB_WAITFD_IN;
9891 if (mode ==
ID2SYM(rb_intern(
"readable"))) {
9892 return RB_WAITFD_IN;
9894 if (mode ==
ID2SYM(rb_intern(
"w"))) {
9895 return RB_WAITFD_OUT;
9897 if (mode ==
ID2SYM(rb_intern(
"write"))) {
9898 return RB_WAITFD_OUT;
9900 if (mode ==
ID2SYM(rb_intern(
"writable"))) {
9901 return RB_WAITFD_OUT;
9903 if (mode ==
ID2SYM(rb_intern(
"rw"))) {
9904 return RB_WAITFD_IN|RB_WAITFD_OUT;
9906 if (mode ==
ID2SYM(rb_intern(
"read_write"))) {
9907 return RB_WAITFD_IN|RB_WAITFD_OUT;
9909 if (mode ==
ID2SYM(rb_intern(
"readable_writable"))) {
9910 return RB_WAITFD_IN|RB_WAITFD_OUT;
9913 rb_raise(rb_eArgError,
"unsupported mode: %"PRIsVALUE, mode);
9917io_event_from_value(
VALUE value)
9921 if (events <= 0) rb_raise(rb_eArgError,
"Events must be positive integer!");
9959 for (
int i = 0; i < argc; i += 1) {
9961 events |= wait_mode_sym(argv[i]);
9963 else if (UNDEF_P(timeout)) {
9967 rb_raise(rb_eArgError,
"timeout given more than once");
9971 if (UNDEF_P(timeout)) timeout =
Qnil;
9979 events = io_event_from_value(argv[0]);
9987 if (rb_io_read_pending(fptr)) {
9989 if (return_io)
return Qtrue;
9995 return io_wait_event(io, events, timeout, return_io);
9999argf_mark_and_move(
void *ptr)
10001 struct argf *p = ptr;
10002 rb_gc_mark_and_move(&p->filename);
10003 rb_gc_mark_and_move(&p->current_file);
10004 rb_gc_mark_and_move(&p->argv);
10005 rb_gc_mark_and_move(&p->inplace);
10006 rb_gc_mark_and_move(&p->encs.
ecopts);
10010argf_memsize(
const void *ptr)
10012 const struct argf *p = ptr;
10013 size_t size =
sizeof(*p);
10020 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
10026 p->filename =
Qnil;
10027 p->current_file =
Qnil;
10033argf_alloc(
VALUE klass)
10038 argf_init(p,
Qnil);
10048 memset(&ARGF, 0,
sizeof(ARGF));
10049 argf_init(&ARGF, argv);
10059 ARGF = argf_of(orig);
10086 ARGF.last_lineno = ARGF.lineno;
10112 return forward_current(rb_frame_this_func(), argc, argv);
10115#define next_argv() argf_next_argv(argf)
10116#define ARGF_GENERIC_INPUT_P() \
10117 (ARGF.current_file == rb_stdin && !RB_TYPE_P(ARGF.current_file, T_FILE))
10118#define ARGF_FORWARD(argc, argv) do {\
10119 if (ARGF_GENERIC_INPUT_P())\
10120 return argf_forward((argc), (argv), argf);\
10122#define NEXT_ARGF_FORWARD(argc, argv) do {\
10123 if (!next_argv()) return Qnil;\
10124 ARGF_FORWARD((argc), (argv));\
10130 VALUE file = ARGF.current_file;
10144 int stdout_binmode = 0;
10145 enum rb_io_mode fmode;
10147 VALUE r_stdout = rb_ractor_stdout();
10152 stdout_binmode = 1;
10155 if (ARGF.init_p == 0) {
10165 if (
NIL_P(ARGF.argv)) {
10168 else if (ARGF.next_p == -1 &&
RARRAY_LEN(ARGF.argv) > 0) {
10173 if (ARGF.next_p == 1) {
10174 if (ARGF.init_p == 1) argf_close(
argf);
10179 ARGF.filename = filename;
10180 filename = rb_str_encode_ospath(filename);
10182 if (RSTRING_LEN(filename) == 1 && fn[0] ==
'-') {
10184 if (ARGF.inplace) {
10185 rb_warn(
"Can't do inplace edit for stdio; skipping");
10191 int fr = rb_sysopen(filename, O_RDONLY, 0);
10193 if (ARGF.inplace) {
10195#ifndef NO_SAFE_RENAME
10206 if (!
NIL_P(ARGF.inplace)) {
10207 VALUE suffix = ARGF.inplace;
10209 if (
NIL_P(rb_str_cat_conv_enc_opts(str, RSTRING_LEN(str),
10210 RSTRING_PTR(suffix), RSTRING_LEN(suffix),
10211 rb_enc_get(suffix), 0,
Qnil))) {
10214#ifdef NO_SAFE_RENAME
10216 (void)unlink(RSTRING_PTR(str));
10217 if (rename(fn, RSTRING_PTR(str)) < 0) {
10218 rb_warn(
"Can't rename %"PRIsVALUE
" to %"PRIsVALUE
": %s, skipping file",
10219 filename, str, strerror(
errno));
10222 fr = rb_sysopen(str, O_RDONLY, 0);
10224 if (rename(fn, RSTRING_PTR(str)) < 0) {
10225 rb_warn(
"Can't rename %"PRIsVALUE
" to %"PRIsVALUE
": %s, skipping file",
10226 filename, str, strerror(
errno));
10233#ifdef NO_SAFE_RENAME
10234 rb_fatal(
"Can't do inplace edit without backup");
10236 if (unlink(fn) < 0) {
10237 rb_warn(
"Can't remove %"PRIsVALUE
": %s, skipping file",
10238 filename, strerror(
errno));
10244 fw = rb_sysopen(filename, O_WRONLY|O_CREAT|O_TRUNC, 0666);
10245#ifndef NO_SAFE_RENAME
10248 fchmod(fw, st.st_mode);
10250 chmod(fn, st.st_mode);
10252 if (st.st_uid!=st2.st_uid || st.st_gid!=st2.st_gid) {
10255 err = fchown(fw, st.st_uid, st.st_gid);
10257 err = chown(fn, st.st_uid, st.st_gid);
10259 if (err && getuid() == 0 && st2.st_uid == 0) {
10260 const char *wkfn = RSTRING_PTR(filename);
10261 rb_warn(
"Can't set owner/group of %"PRIsVALUE
" to same as %"PRIsVALUE
": %s, skipping file",
10262 filename, str, strerror(
errno));
10265 (void)unlink(wkfn);
10275 if (!ARGF.binmode) {
10276 fmode |= DEFAULT_TEXTMODE;
10278 ARGF.current_file = prep_io(fr, fmode,
rb_cFile, fn);
10279 if (!
NIL_P(write_io)) {
10286 if (ARGF.encs.enc) {
10287 fptr->
encs = ARGF.encs;
10288 clear_codeconv(fptr);
10291 fptr->
encs.
ecflags &= ~ECONV_NEWLINE_DECORATOR_MASK;
10292 if (!ARGF.binmode) {
10294#ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE
10295 fptr->
encs.
ecflags |= TEXTMODE_NEWLINE_DECORATOR_ON_WRITE;
10306 else if (ARGF.next_p == -1) {
10309 if (ARGF.inplace) {
10310 rb_warn(
"Can't do inplace edit for stdio");
10314 if (ARGF.init_p == -1) ARGF.init_p = 1;
10322 long lineno = ARGF.lineno;
10325 if (!next_argv())
return Qnil;
10326 if (ARGF_GENERIC_INPUT_P()) {
10327 line = forward_current(idGets, argc, argv);
10334 line = rb_io_getline(argc, argv, ARGF.current_file);
10336 if (
NIL_P(line) && ARGF.next_p != -1) {
10342 if (!
NIL_P(line)) {
10343 ARGF.lineno = ++lineno;
10344 ARGF.last_lineno = ARGF.lineno;
10350argf_lineno_getter(
ID id,
VALUE *var)
10353 return INT2FIX(ARGF.last_lineno);
10361 ARGF.last_lineno = ARGF.lineno = n;
10365rb_reset_argf_lineno(
long n)
10367 ARGF.last_lineno = ARGF.lineno = n;
10408 if (recv ==
argf) {
10409 return argf_gets(argc, argv,
argf);
10411 return forward(
argf, idGets, argc, argv);
10437 line = argf_getline(argc, argv,
argf);
10449 return rb_f_gets(0, 0,
argf);
10453 if (!next_argv())
return Qnil;
10455 if (
NIL_P(line) && ARGF.next_p != -1) {
10461 if (!
NIL_P(line)) {
10463 ARGF.last_lineno = ARGF.lineno;
10489rb_f_readline(
int argc,
VALUE *argv,
VALUE recv)
10491 if (recv ==
argf) {
10492 return argf_readline(argc, argv,
argf);
10494 return forward(
argf, rb_intern(
"readline"), argc, argv);
10520 if (!next_argv()) rb_eof_error();
10521 ARGF_FORWARD(argc, argv);
10522 line = argf_gets(argc, argv,
argf);
10592rb_f_readlines(
int argc,
VALUE *argv,
VALUE recv)
10594 if (recv ==
argf) {
10595 return argf_readlines(argc, argv,
argf);
10597 return forward(
argf, rb_intern(
"readlines"), argc, argv);
10621 long lineno = ARGF.lineno;
10625 while (next_argv()) {
10626 if (ARGF_GENERIC_INPUT_P()) {
10627 lines = forward_current(rb_intern(
"readlines"), argc, argv);
10630 lines = rb_io_readlines(argc, argv, ARGF.current_file);
10636 ARGF.last_lineno = ARGF.lineno;
10671 rb_last_status_clear();
10672 port = pipe_open_s(str,
"r",
FMODE_READABLE|DEFAULT_TEXTMODE, NULL);
10676 result = read_all(fptr, remain_size(fptr),
Qnil);
10678 rb_io_fptr_cleanup_all(fptr);
10684#ifdef HAVE_SYS_SELECT_H
10685#include <sys/select.h>
10699 if (!
NIL_P(read)) {
10704 if (READ_DATA_PENDING(fptr) || READ_CHAR_PENDING(fptr)) {
10708 if (max < fptr->fd) max = fptr->
fd;
10711 timerec.tv_sec = timerec.tv_usec = 0;
10719 if (!
NIL_P(write)) {
10725 if (max < fptr->fd) max = fptr->
fd;
10732 if (!
NIL_P(except)) {
10736 VALUE write_io = GetWriteIO(io);
10739 if (max < fptr->fd) max = fptr->
fd;
10740 if (io != write_io) {
10743 if (max < fptr->fd) max = fptr->
fd;
10758 if (!pending && n == 0)
return Qnil;
10783 VALUE write_io = GetWriteIO(io);
10796 VALUE write_io = GetWriteIO(io);
10801 else if (io != write_io) {
10814 VALUE read, write, except;
10820select_call(
VALUE arg)
10824 return select_internal(p->read, p->write, p->except, p->timeout, p->fdsets);
10828select_end(
VALUE arg)
10833 for (i = 0; i < numberof(p->fdsets); ++i)
10838static VALUE sym_normal, sym_sequential, sym_random,
10839 sym_willneed, sym_dontneed, sym_noreuse;
10841#ifdef HAVE_POSIX_FADVISE
10842struct io_advise_struct {
10850io_advise_internal(
void *arg)
10852 struct io_advise_struct *ptr = arg;
10853 return posix_fadvise(ptr->fd, ptr->offset, ptr->len, ptr->advice);
10857io_advise_sym_to_const(
VALUE sym)
10859#ifdef POSIX_FADV_NORMAL
10860 if (sym == sym_normal)
10861 return INT2NUM(POSIX_FADV_NORMAL);
10864#ifdef POSIX_FADV_RANDOM
10865 if (sym == sym_random)
10866 return INT2NUM(POSIX_FADV_RANDOM);
10869#ifdef POSIX_FADV_SEQUENTIAL
10870 if (sym == sym_sequential)
10871 return INT2NUM(POSIX_FADV_SEQUENTIAL);
10874#ifdef POSIX_FADV_WILLNEED
10875 if (sym == sym_willneed)
10876 return INT2NUM(POSIX_FADV_WILLNEED);
10879#ifdef POSIX_FADV_DONTNEED
10880 if (sym == sym_dontneed)
10881 return INT2NUM(POSIX_FADV_DONTNEED);
10884#ifdef POSIX_FADV_NOREUSE
10885 if (sym == sym_noreuse)
10886 return INT2NUM(POSIX_FADV_NOREUSE);
10893do_io_advise(
rb_io_t *fptr,
VALUE advice, rb_off_t offset, rb_off_t
len)
10896 struct io_advise_struct ias;
10899 num_adv = io_advise_sym_to_const(advice);
10905 if (
NIL_P(num_adv))
10909 ias.advice =
NUM2INT(num_adv);
10910 ias.offset = offset;
10913 rv = (int)rb_io_blocking_region(fptr, io_advise_internal, &ias);
10914 if (rv && rv != ENOSYS) {
10917 VALUE message = rb_sprintf(
"%"PRIsVALUE
" "
10921 fptr->
pathv, offset,
len, advice);
10931advice_arg_check(
VALUE advice)
10936 if (advice != sym_normal &&
10937 advice != sym_sequential &&
10938 advice != sym_random &&
10939 advice != sym_willneed &&
10940 advice != sym_dontneed &&
10941 advice != sym_noreuse) {
10942 rb_raise(
rb_eNotImpError,
"Unsupported advice: %+"PRIsVALUE, advice);
10980rb_io_advise(
int argc,
VALUE *argv,
VALUE io)
10987 advice_arg_check(advice);
10989 io = GetWriteIO(io);
10995#ifdef HAVE_POSIX_FADVISE
10996 return do_io_advise(fptr, advice,
off, l);
10998 ((void)
off, (
void)l);
11010 return isinf(f) && 0 < f;
11166rb_f_select(
int argc,
VALUE *argv,
VALUE obj)
11169 if (scheduler !=
Qnil) {
11172 if (!UNDEF_P(result))
return result;
11180 rb_scan_args(argc, argv,
"13", &args.read, &args.write, &args.except, &timeout);
11181 if (
NIL_P(timeout) || is_pos_inf(timeout)) {
11186 args.timeout = &timerec;
11189 for (i = 0; i < numberof(args.fdsets); ++i)
11195#ifdef IOCTL_REQ_TYPE
11196 typedef IOCTL_REQ_TYPE ioctl_req_t;
11198 typedef int ioctl_req_t;
11199# define NUM2IOCTLREQ(num) ((int)NUM2LONG(num))
11210nogvl_ioctl(
void *ptr)
11212 struct ioctl_arg *arg = ptr;
11214 return (
VALUE)ioctl(arg->fd, arg->cmd, arg->narg);
11218do_ioctl(
struct rb_io *io, ioctl_req_t cmd,
long narg)
11221 struct ioctl_arg arg;
11227 retval = (int)rb_io_blocking_region(io, nogvl_ioctl, &arg);
11233#define DEFAULT_IOCTL_NARG_LEN (256)
11235#if defined(__linux__) && defined(_IOC_SIZE)
11237linux_iocparm_len(ioctl_req_t cmd)
11241 if ((cmd & 0xFFFF0000) == 0) {
11243 return DEFAULT_IOCTL_NARG_LEN;
11246 len = _IOC_SIZE(cmd);
11249 if (
len < DEFAULT_IOCTL_NARG_LEN)
11250 len = DEFAULT_IOCTL_NARG_LEN;
11258ioctl_narg_len(ioctl_req_t cmd)
11264#define IOCPARM_LEN(x) (((x) >> 16) & IOCPARM_MASK)
11268 len = IOCPARM_LEN(cmd);
11269#elif defined(__linux__) && defined(_IOC_SIZE)
11270 len = linux_iocparm_len(cmd);
11273 len = DEFAULT_IOCTL_NARG_LEN;
11282typedef long fcntl_arg_t;
11285typedef int fcntl_arg_t;
11289fcntl_narg_len(ioctl_req_t cmd)
11296 len =
sizeof(fcntl_arg_t);
11304#ifdef F_DUPFD_CLOEXEC
11305 case F_DUPFD_CLOEXEC:
11306 len =
sizeof(fcntl_arg_t);
11316 len =
sizeof(fcntl_arg_t);
11326 len =
sizeof(fcntl_arg_t);
11336 len =
sizeof(fcntl_arg_t);
11341 len =
sizeof(
struct f_owner_ex);
11346 len =
sizeof(
struct f_owner_ex);
11351 len =
sizeof(
struct flock);
11356 len =
sizeof(
struct flock);
11361 len =
sizeof(
struct flock);
11381 len =
sizeof(fcntl_arg_t);
11391 len =
sizeof(fcntl_arg_t);
11396 len =
sizeof(fcntl_arg_t);
11409fcntl_narg_len(ioctl_req_t cmd)
11415#define NARG_SENTINEL 17
11418setup_narg(ioctl_req_t cmd,
VALUE *argp,
long (*narg_len)(ioctl_req_t))
11429 else if (arg ==
Qtrue) {
11443 len = narg_len(cmd);
11444 rb_str_modify(arg);
11446 slen = RSTRING_LEN(arg);
11448 if (slen <
len+1) {
11449 rb_str_resize(arg,
len+1);
11450 MEMZERO(RSTRING_PTR(arg)+slen,
char,
len-slen);
11454 ptr = RSTRING_PTR(arg);
11455 ptr[slen - 1] = NARG_SENTINEL;
11464finish_narg(
int retval,
VALUE arg,
const rb_io_t *fptr)
11466 if (retval < 0) rb_sys_fail_path(fptr->
pathv);
11471 if (ptr[slen-1] != NARG_SENTINEL)
11472 rb_raise(rb_eArgError,
"return value overflowed string");
11473 ptr[slen-1] =
'\0';
11483 ioctl_req_t cmd = NUM2IOCTLREQ(req);
11488 narg = setup_narg(cmd, &arg, ioctl_narg_len);
11490 retval = do_ioctl(fptr, cmd, narg);
11491 return finish_narg(retval, arg, fptr);
11518 return rb_ioctl(io, req, arg);
11521#define rb_io_ioctl rb_f_notimplement
11532nogvl_fcntl(
void *ptr)
11534 struct fcntl_arg *arg = ptr;
11536#if defined(F_DUPFD)
11537 if (arg->cmd == F_DUPFD)
11540 return (
VALUE)fcntl(arg->fd, arg->cmd, arg->narg);
11544do_fcntl(
struct rb_io *io,
int cmd,
long narg)
11547 struct fcntl_arg arg;
11553 retval = (int)rb_io_blocking_region(io, nogvl_fcntl, &arg);
11554 if (retval != -1) {
11556#if defined(F_DUPFD)
11559#if defined(F_DUPFD_CLOEXEC)
11560 case F_DUPFD_CLOEXEC:
11577 narg = setup_narg(cmd, &arg, fcntl_narg_len);
11579 retval = do_fcntl(fptr, cmd, narg);
11580 return finish_narg(retval, arg, fptr);
11606 return rb_fcntl(io, req, arg);
11609#define rb_io_fcntl rb_f_notimplement
11612#if defined(HAVE_SYSCALL) || defined(HAVE___SYSCALL)
11644#if SIZEOF_VOIDP == 8 && defined(HAVE___SYSCALL) && SIZEOF_INT != 8
11645# define SYSCALL __syscall
11646# define NUM2SYSCALLID(x) NUM2LONG(x)
11647# define RETVAL2NUM(x) LONG2NUM(x)
11648# if SIZEOF_LONG == 8
11649 long num, retval = -1;
11650# elif SIZEOF_LONG_LONG == 8
11651 long long num, retval = -1;
11653# error ---->> it is asserted that __syscall takes the first argument and returns retval in 64bit signed integer. <<----
11655#elif defined(__linux__)
11656# define SYSCALL syscall
11657# define NUM2SYSCALLID(x) NUM2LONG(x)
11658# define RETVAL2NUM(x) LONG2NUM(x)
11666 long num, retval = -1;
11668# define SYSCALL syscall
11669# define NUM2SYSCALLID(x) NUM2INT(x)
11670# define RETVAL2NUM(x) INT2NUM(x)
11671 int num, retval = -1;
11677 "We plan to remove a syscall function at future release. DL(Fiddle) provides safer alternative.");
11681 rb_raise(rb_eArgError,
"too few arguments for syscall");
11682 if (argc > numberof(arg))
11683 rb_raise(rb_eArgError,
"too many arguments for syscall");
11684 num = NUM2SYSCALLID(argv[0]); ++argv;
11685 for (i = argc - 1; i--; ) {
11700 retval = SYSCALL(num);
11703 retval = SYSCALL(num, arg[0]);
11706 retval = SYSCALL(num, arg[0],arg[1]);
11709 retval = SYSCALL(num, arg[0],arg[1],arg[2]);
11712 retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3]);
11715 retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4]);
11718 retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5]);
11721 retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5],arg[6]);
11727 return RETVAL2NUM(retval);
11729#undef NUM2SYSCALLID
11733#define rb_f_syscall rb_f_notimplement
11737io_new_instance(
VALUE args)
11743find_encoding(
VALUE v)
11746 if (!enc)
rb_warn(
"Unsupported encoding %"PRIsVALUE
" ignored", v);
11758 enc2 = find_encoding(v1);
11761 if (RSTRING_LEN(tmp) == 1 && RSTRING_PTR(tmp)[0] ==
'-') {
11767 enc = find_encoding(v2);
11774 enc = find_encoding(v2);
11780 if (enc2 == rb_ascii8bit_encoding()) {
11785 SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags);
11791 rb_io_ext_int_to_encs(NULL, NULL, &enc, &enc2, 0);
11792 SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags);
11797 if (!
NIL_P(tmp) && rb_enc_asciicompat(enc = rb_enc_get(tmp))) {
11798 parse_mode_enc(RSTRING_PTR(tmp), enc, &enc, &enc2, NULL);
11799 SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags);
11803 rb_io_ext_int_to_encs(find_encoding(v1), NULL, &enc, &enc2, 0);
11804 SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags);
11809 validate_enc_binmode(&fptr->
mode, ecflags, enc, enc2);
11814 clear_codeconv(fptr);
11826io_encoding_set_v(
VALUE v)
11829 io_encoding_set(arg->fptr, arg->v1, arg->v2, arg->opt);
11834pipe_pair_close(
VALUE rw)
11837 return rb_ensure(io_close, rwp[0], io_close, rwp[1]);
11920rb_io_s_pipe(
int argc,
VALUE *argv,
VALUE klass)
11922 int pipes[2], state;
11923 VALUE r, w, args[3], v1, v2;
11927 enum rb_io_mode fmode = 0;
11930 argc =
rb_scan_args(argc, argv,
"02:", &v1, &v2, &opt);
11937 r = rb_protect(io_new_instance, (
VALUE)args, &state);
11941 rb_jump_tag(state);
11945 ies_args.fptr = fptr;
11948 ies_args.opt = opt;
11949 rb_protect(io_encoding_set_v, (
VALUE)&ies_args, &state);
11953 rb_jump_tag(state);
11958 w = rb_protect(io_new_instance, (
VALUE)args, &state);
11962 rb_jump_tag(state);
11967 extract_binmode(opt, &fmode);
11974#if DEFAULT_TEXTMODE
11976 fptr->
mode &= ~FMODE_TEXTMODE;
11977 setmode(fptr->
fd, O_BINARY);
11979#if RUBY_CRLF_ENVIRONMENT
11985 fptr->
mode |= fmode;
11986#if DEFAULT_TEXTMODE
11988 fptr2->
mode &= ~FMODE_TEXTMODE;
11989 setmode(fptr2->
fd, O_BINARY);
11992 fptr2->
mode |= fmode;
12026 else if (!
NIL_P(v = rb_hash_aref(opt, sym_open_args))) {
12029 v = rb_to_array_type(v);
12034 arg->io = rb_io_open(klass, path, vmode, vperm, opt);
12038io_s_foreach(
VALUE v)
12043 if (arg->limit == 0)
12044 rb_raise(rb_eArgError,
"invalid limit: 0 for foreach");
12045 while (!
NIL_P(str = rb_io_getline_1(arg->rs, arg->limit, arg->chomp, arg->io))) {
12129rb_io_s_foreach(
int argc,
VALUE *argv,
VALUE self)
12132 int orig_argc = argc;
12136 argc =
rb_scan_args(argc, argv,
"12:", NULL, NULL, NULL, &opt);
12138 extract_getline_args(argc-1, argv+1, &garg);
12139 open_key_args(self, argc, argv, opt, &arg);
12141 extract_getline_opts(opt, &garg);
12142 check_getline_args(&garg.rs, &garg.limit, garg.io = arg.io);
12143 return rb_ensure(io_s_foreach, (
VALUE)&garg, rb_io_close, arg.io);
12147io_s_readlines(
VALUE v)
12150 return io_readlines(arg, arg->io);
12203rb_io_s_readlines(
int argc,
VALUE *argv,
VALUE io)
12209 argc =
rb_scan_args(argc, argv,
"12:", NULL, NULL, NULL, &opt);
12210 extract_getline_args(argc-1, argv+1, &garg);
12211 open_key_args(io, argc, argv, opt, &arg);
12213 extract_getline_opts(opt, &garg);
12214 check_getline_args(&garg.rs, &garg.limit, garg.io = arg.io);
12215 return rb_ensure(io_s_readlines, (
VALUE)&garg, rb_io_close, arg.io);
12222 return io_read(arg->argc, arg->argv, arg->io);
12232seek_before_access(
VALUE argp)
12236 return rb_io_seek(arg->io, arg->offset, arg->mode);
12278rb_io_s_read(
int argc,
VALUE *argv,
VALUE io)
12284 argc =
rb_scan_args(argc, argv,
"13:", NULL, NULL, &offset, NULL, &opt);
12286 rb_raise(rb_eArgError,
"negative offset %ld given",
off);
12288 open_key_args(io, argc, argv, opt, &arg);
12290 if (!
NIL_P(offset)) {
12294 sarg.offset = offset;
12295 sarg.mode = SEEK_SET;
12296 rb_protect(seek_before_access, (
VALUE)&sarg, &state);
12299 rb_jump_tag(state);
12301 if (arg.argc == 2) arg.argc = 1;
12316rb_io_s_binread(
int argc,
VALUE *argv,
VALUE io)
12331 convconfig.
enc = rb_ascii8bit_encoding();
12332 arg.io = rb_io_open_generic(io, argv[0], oflags, fmode, &convconfig, 0);
12335 arg.argc = (argc > 1) ? 1 : 0;
12336 if (!
NIL_P(offset)) {
12340 sarg.offset = offset;
12341 sarg.mode = SEEK_SET;
12342 rb_protect(seek_before_access, (
VALUE)&sarg, &state);
12345 rb_jump_tag(state);
12352io_s_write0(
VALUE v)
12355 return io_write(arg->io,arg->str,arg->nosync);
12359io_s_write(
int argc,
VALUE *argv,
VALUE klass,
int binary)
12361 VALUE string, offset, opt;
12365 rb_scan_args(argc, argv,
"21:", NULL, &
string, &offset, &opt);
12367 if (
NIL_P(opt)) opt = rb_hash_new();
12368 else opt = rb_hash_dup(opt);
12371 if (
NIL_P(rb_hash_aref(opt,sym_mode))) {
12372 int mode = O_WRONLY|O_CREAT;
12374 if (binary) mode |= O_BINARY;
12376 if (
NIL_P(offset)) mode |= O_TRUNC;
12377 rb_hash_aset(opt,sym_mode,
INT2NUM(mode));
12379 open_key_args(klass, argc, argv, opt, &arg);
12382 if (binary) rb_io_binmode_m(arg.io);
12386 if (!
NIL_P(offset)) {
12390 sarg.offset = offset;
12391 sarg.mode = SEEK_SET;
12392 rb_protect(seek_before_access, (
VALUE)&sarg, &state);
12395 rb_jump_tag(state);
12403 return rb_ensure(io_s_write0, (
VALUE)&warg, rb_io_close, arg.io);
12447rb_io_s_write(
int argc,
VALUE *argv,
VALUE io)
12449 return io_s_write(argc, argv, io, 0);
12462rb_io_s_binwrite(
int argc,
VALUE *argv,
VALUE io)
12464 return io_s_write(argc, argv, io, 1);
12470 rb_off_t copy_length;
12471 rb_off_t src_offset;
12475 unsigned close_src : 1;
12476 unsigned close_dst : 1;
12479 const char *syserr;
12480 const char *notimp;
12482 struct stat src_stat;
12483 struct stat dst_stat;
12484#ifdef HAVE_FCOPYFILE
12485 copyfile_state_t copyfile_state;
12490exec_interrupts(
void *arg)
12493 rb_thread_execute_interrupts(th);
12507#if defined(ERESTART)
12512 rb_thread_execute_interrupts(stp->th);
12531fiber_scheduler_wait_for(
void * _arguments)
12541# define IOWAIT_SYSCALL "poll"
12542STATIC_ASSERT(pollin_expected, POLLIN == RB_WAITFD_IN);
12543STATIC_ASSERT(pollout_expected, POLLOUT == RB_WAITFD_OUT);
12548 if (scheduler !=
Qnil) {
12551 return RTEST(args.result);
12555 if (fd == -1)
return 0;
12560 fds.events = events;
12562 int timeout_milliseconds = -1;
12565 timeout_milliseconds = (int)(timeout->tv_sec * 1000) + (int)(timeout->tv_usec / 1000);
12568 return poll(&fds, 1, timeout_milliseconds);
12571# define IOWAIT_SYSCALL "select"
12576 if (scheduler !=
Qnil) {
12579 return RTEST(args.result);
12599 case RB_WAITFD_OUT:
12603 VM_UNREACHABLE(nogvl_wait_for);
12623 ret = nogvl_wait_for(stp->th, stp->src_fptr, RB_WAITFD_IN, NULL);
12625 }
while (ret < 0 && maygvl_copy_stream_continue_p(has_gvl, stp));
12628 stp->syserr = IOWAIT_SYSCALL;
12629 stp->error_no =
errno;
12641 ret = nogvl_wait_for(stp->th, stp->dst_fptr, RB_WAITFD_OUT, NULL);
12642 }
while (ret < 0 && maygvl_copy_stream_continue_p(0, stp));
12645 stp->syserr = IOWAIT_SYSCALL;
12646 stp->error_no =
errno;
12652#ifdef USE_COPY_FILE_RANGE
12655simple_copy_file_range(
int in_fd, rb_off_t *in_offset,
int out_fd, rb_off_t *out_offset,
size_t count,
unsigned int flags)
12657#ifdef HAVE_COPY_FILE_RANGE
12658 return copy_file_range(in_fd, in_offset, out_fd, out_offset, count, flags);
12660 return syscall(__NR_copy_file_range, in_fd, in_offset, out_fd, out_offset, count, flags);
12669 rb_off_t copy_length, src_offset, *src_offset_ptr;
12671 if (!S_ISREG(stp->src_stat.st_mode))
12674 src_size = stp->src_stat.st_size;
12675 src_offset = stp->src_offset;
12676 if (src_offset >= (rb_off_t)0) {
12677 src_offset_ptr = &src_offset;
12680 src_offset_ptr = NULL;
12683 copy_length = stp->copy_length;
12684 if (copy_length < (rb_off_t)0) {
12685 if (src_offset < (rb_off_t)0) {
12686 rb_off_t current_offset;
12688 current_offset = lseek(stp->src_fptr->
fd, 0, SEEK_CUR);
12689 if (current_offset < (rb_off_t)0 &&
errno) {
12690 stp->syserr =
"lseek";
12691 stp->error_no =
errno;
12692 return (
int)current_offset;
12694 copy_length = src_size - current_offset;
12697 copy_length = src_size - src_offset;
12701 retry_copy_file_range:
12702# if SIZEOF_OFF_T > SIZEOF_SIZE_T
12704 ss = (copy_length > (rb_off_t)SSIZE_MAX) ? SSIZE_MAX : (ssize_t)copy_length;
12706 ss = (ssize_t)copy_length;
12708 ss = simple_copy_file_range(stp->src_fptr->
fd, src_offset_ptr, stp->dst_fptr->
fd, NULL, ss, 0);
12712 if (0 < copy_length) {
12713 goto retry_copy_file_range;
12717 if (maygvl_copy_stream_continue_p(0, stp)) {
12718 goto retry_copy_file_range;
12732#if EWOULDBLOCK != EAGAIN
12736 int ret = nogvl_copy_stream_wait_write(stp);
12737 if (ret < 0)
return ret;
12739 goto retry_copy_file_range;
12743 int flags = fcntl(stp->dst_fptr->
fd, F_GETFL);
12745 if (flags != -1 && flags & O_APPEND) {
12751 stp->syserr =
"copy_file_range";
12752 stp->error_no =
errno;
12759#ifdef HAVE_FCOPYFILE
12763 rb_off_t cur, ss = 0;
12764 const rb_off_t src_offset = stp->src_offset;
12767 if (stp->copy_length >= (rb_off_t)0) {
12772 if (!S_ISREG(stp->src_stat.st_mode))
12775 if (!S_ISREG(stp->dst_stat.st_mode))
12777 if (lseek(stp->dst_fptr->
fd, 0, SEEK_CUR) > (rb_off_t)0)
12779 if (fcntl(stp->dst_fptr->
fd, F_GETFL) & O_APPEND) {
12782 rb_off_t end = lseek(stp->dst_fptr->
fd, 0, SEEK_END);
12783 lseek(stp->dst_fptr->
fd, 0, SEEK_SET);
12784 if (end > (rb_off_t)0)
return 0;
12787 if (src_offset > (rb_off_t)0) {
12792 cur = lseek(stp->src_fptr->
fd, 0, SEEK_CUR);
12793 if (cur < (rb_off_t)0 &&
errno) {
12794 stp->error_no =
errno;
12799 r = lseek(stp->src_fptr->
fd, src_offset, SEEK_SET);
12800 if (r < (rb_off_t)0 &&
errno) {
12801 stp->error_no =
errno;
12806 stp->copyfile_state = copyfile_state_alloc();
12807 ret = fcopyfile(stp->src_fptr->
fd, stp->dst_fptr->
fd, stp->copyfile_state, COPYFILE_DATA);
12808 copyfile_state_get(stp->copyfile_state, COPYFILE_STATE_COPIED, &ss);
12812 if (src_offset > (rb_off_t)0) {
12816 r = lseek(stp->src_fptr->
fd, cur, SEEK_SET);
12817 if (r < (rb_off_t)0 &&
errno) {
12818 stp->error_no =
errno;
12830 stp->syserr =
"fcopyfile";
12831 stp->error_no =
errno;
12838#ifdef HAVE_SENDFILE
12841# define USE_SENDFILE
12843# ifdef HAVE_SYS_SENDFILE_H
12844# include <sys/sendfile.h>
12848simple_sendfile(
int out_fd,
int in_fd, rb_off_t *offset, rb_off_t count)
12850 return sendfile(out_fd, in_fd, offset, (
size_t)count);
12853# elif 0 || defined(__APPLE__)
12857# define USE_SENDFILE
12860simple_sendfile(
int out_fd,
int in_fd, rb_off_t *offset, rb_off_t count)
12863 rb_off_t pos = offset ? *offset : lseek(in_fd, 0, SEEK_CUR);
12866 r = sendfile(in_fd, out_fd, pos, &count, NULL, 0);
12869 r = sendfile(in_fd, out_fd, pos, (
size_t)count, NULL, &sbytes, 0);
12871 if (r != 0 && sbytes == 0)
return r;
12876 lseek(in_fd, sbytes, SEEK_CUR);
12878 return (ssize_t)sbytes;
12891 rb_off_t copy_length;
12892 rb_off_t src_offset;
12895 if (!S_ISREG(stp->src_stat.st_mode))
12898 src_size = stp->src_stat.st_size;
12900 if ((stp->dst_stat.st_mode & S_IFMT) != S_IFSOCK)
12904 src_offset = stp->src_offset;
12905 use_pread = src_offset >= (rb_off_t)0;
12907 copy_length = stp->copy_length;
12908 if (copy_length < (rb_off_t)0) {
12910 copy_length = src_size - src_offset;
12914 cur = lseek(stp->src_fptr->
fd, 0, SEEK_CUR);
12915 if (cur < (rb_off_t)0 &&
errno) {
12916 stp->syserr =
"lseek";
12917 stp->error_no =
errno;
12920 copy_length = src_size - cur;
12925# if SIZEOF_OFF_T > SIZEOF_SIZE_T
12927 ss = (copy_length > (rb_off_t)SSIZE_MAX) ? SSIZE_MAX : (ssize_t)copy_length;
12929 ss = (ssize_t)copy_length;
12932 ss = simple_sendfile(stp->dst_fptr->
fd, stp->src_fptr->
fd, &src_offset, ss);
12935 ss = simple_sendfile(stp->dst_fptr->
fd, stp->src_fptr->
fd, NULL, ss);
12940 if (0 < copy_length) {
12941 goto retry_sendfile;
12945 if (maygvl_copy_stream_continue_p(0, stp))
12946 goto retry_sendfile;
12959#if EWOULDBLOCK != EAGAIN
12972 ret = maygvl_copy_stream_wait_read(0, stp);
12973 if (ret < 0)
return ret;
12975 ret = nogvl_copy_stream_wait_write(stp);
12976 if (ret < 0)
return ret;
12978 goto retry_sendfile;
12980 stp->syserr =
"sendfile";
12981 stp->error_no =
errno;
12989maygvl_read(
int has_gvl,
rb_io_t *fptr,
void *buf,
size_t count)
12992 return rb_io_read_memory(fptr, buf, count);
12994 return read(fptr->
fd, buf, count);
12998maygvl_copy_stream_read(
int has_gvl,
struct copy_stream_struct *stp,
char *buf,
size_t len, rb_off_t offset)
13002 if (offset < (rb_off_t)0) {
13003 ss = maygvl_read(has_gvl, stp->src_fptr, buf,
len);
13006 ss = pread(stp->src_fptr->
fd, buf,
len, offset);
13012 if (maygvl_copy_stream_continue_p(has_gvl, stp))
13016#if EWOULDBLOCK != EAGAIN
13020 int ret = maygvl_copy_stream_wait_read(has_gvl, stp);
13021 if (ret < 0)
return ret;
13026 stp->notimp =
"pread";
13030 stp->syserr = offset < (rb_off_t)0 ?
"read" :
"pread";
13031 stp->error_no =
errno;
13042 ss = write(stp->dst_fptr->
fd, buf+
off,
len);
13044 if (maygvl_copy_stream_continue_p(0, stp))
13046 if (io_again_p(
errno)) {
13047 int ret = nogvl_copy_stream_wait_write(stp);
13048 if (ret < 0)
return ret;
13051 stp->syserr =
"write";
13052 stp->error_no =
errno;
13069 rb_off_t copy_length;
13070 rb_off_t src_offset;
13074 copy_length = stp->copy_length;
13075 use_eof = copy_length < (rb_off_t)0;
13076 src_offset = stp->src_offset;
13077 use_pread = src_offset >= (rb_off_t)0;
13079 if (use_pread && stp->close_src) {
13082 r = lseek(stp->src_fptr->
fd, src_offset, SEEK_SET);
13083 if (r < (rb_off_t)0 &&
errno) {
13084 stp->syserr =
"lseek";
13085 stp->error_no =
errno;
13088 src_offset = (rb_off_t)-1;
13092 while (use_eof || 0 < copy_length) {
13093 if (!use_eof && copy_length < (rb_off_t)
sizeof(buf)) {
13094 len = (size_t)copy_length;
13100 ss = maygvl_copy_stream_read(0, stp, buf,
len, src_offset);
13105 ss = maygvl_copy_stream_read(0, stp, buf,
len, (rb_off_t)-1);
13110 ret = nogvl_copy_stream_write(stp, buf, ss);
13120nogvl_copy_stream_func(
void *arg)
13123#if defined(USE_SENDFILE) || defined(USE_COPY_FILE_RANGE) || defined(HAVE_FCOPYFILE)
13127#ifdef USE_COPY_FILE_RANGE
13128 ret = nogvl_copy_file_range(stp);
13133#ifdef HAVE_FCOPYFILE
13134 ret = nogvl_fcopyfile(stp);
13140 ret = nogvl_copy_stream_sendfile(stp);
13145 nogvl_copy_stream_read_write(stp);
13147#if defined(USE_SENDFILE) || defined(USE_COPY_FILE_RANGE) || defined(HAVE_FCOPYFILE)
13154copy_stream_fallback_body(
VALUE arg)
13157 const int buflen = 16*1024;
13160 rb_off_t rest = stp->copy_length;
13161 rb_off_t
off = stp->src_offset;
13162 ID read_method = id_readpartial;
13164 if (!stp->src_fptr) {
13166 read_method = id_read;
13173 rb_str_make_independent(buf);
13174 if (stp->copy_length < (rb_off_t)0) {
13179 rb_str_resize(buf, 0);
13182 l = buflen < rest ? buflen : (long)rest;
13184 if (!stp->src_fptr) {
13187 if (read_method == id_read &&
NIL_P(rc))
13192 rb_str_resize(buf, buflen);
13193 ss = maygvl_copy_stream_read(1, stp, RSTRING_PTR(buf), l,
off);
13194 rb_str_resize(buf, ss > 0 ? ss : 0);
13199 if (
off >= (rb_off_t)0)
13202 n = rb_io_write(stp->dst, buf);
13204 stp->total += numwrote;
13206 if (read_method == id_read && RSTRING_LEN(buf) == 0) {
13217 if (!stp->src_fptr && stp->src_offset >= (rb_off_t)0) {
13218 rb_raise(rb_eArgError,
"cannot specify src_offset for non-IO");
13227copy_stream_body(
VALUE arg)
13230 VALUE src_io = stp->src, dst_io = stp->dst;
13231 const int common_oflags = 0
13241 if (src_io ==
argf ||
13245 stp->src_fptr = NULL;
13250 if (!
NIL_P(tmp_io)) {
13257 args[1] =
INT2NUM(O_RDONLY|common_oflags);
13260 stp->close_src = 1;
13265 stat_ret = fstat(stp->src_fptr->
fd, &stp->src_stat);
13266 if (stat_ret < 0) {
13267 stp->syserr =
"fstat";
13268 stp->error_no =
errno;
13273 if (dst_io ==
argf ||
13277 stp->dst_fptr = NULL;
13282 if (!
NIL_P(tmp_io)) {
13283 dst_io = GetWriteIO(tmp_io);
13289 args[1] =
INT2NUM(O_WRONLY|O_CREAT|O_TRUNC|common_oflags);
13293 stp->close_dst = 1;
13296 dst_io = GetWriteIO(dst_io);
13302 stat_ret = fstat(stp->dst_fptr->
fd, &stp->dst_stat);
13303 if (stat_ret < 0) {
13304 stp->syserr =
"fstat";
13305 stp->error_no =
errno;
13312 SET_BINARY_MODE_WITH_SEEK_CUR(stp->src_fptr);
13315 io_ascii8bit_binmode(stp->dst_fptr);
13317 if (stp->src_offset < (rb_off_t)0 && stp->src_fptr && stp->src_fptr->
rbuf.
len) {
13320 if (stp->copy_length >= (rb_off_t)0 && stp->copy_length < (rb_off_t)
len) {
13321 len = (size_t)stp->copy_length;
13324 rb_str_resize(str,
len);
13325 read_buffered_data(RSTRING_PTR(str),
len, stp->src_fptr);
13326 if (stp->dst_fptr) {
13327 if (io_binwrite(RSTRING_PTR(str), RSTRING_LEN(str), stp->dst_fptr, 0) < 0)
13328 rb_sys_fail_on_write(stp->dst_fptr);
13331 rb_io_write(dst_io, str);
13332 rb_str_resize(str, 0);
13334 if (stp->copy_length >= (rb_off_t)0)
13335 stp->copy_length -=
len;
13338 if (stp->dst_fptr && io_fflush(stp->dst_fptr) < 0) {
13342 if (stp->copy_length == 0)
13345 if (stp->src_fptr == NULL || stp->dst_fptr == NULL) {
13346 return copy_stream_fallback(stp);
13349 IO_WITHOUT_GVL(nogvl_copy_stream_func, stp);
13354copy_stream_finalize(
VALUE arg)
13358#ifdef HAVE_FCOPYFILE
13359 if (stp->copyfile_state) {
13360 copyfile_state_free(stp->copyfile_state);
13364 if (stp->close_src) {
13365 rb_io_close_m(stp->src);
13367 if (stp->close_dst) {
13368 rb_io_close_m(stp->dst);
13431rb_io_s_copy_stream(
int argc,
VALUE *argv,
VALUE io)
13433 VALUE src, dst, length, src_offset;
13438 rb_scan_args(argc, argv,
"22", &src, &dst, &length, &src_offset);
13443 st.src_fptr = NULL;
13444 st.dst_fptr = NULL;
13447 st.copy_length = (rb_off_t)-1;
13449 st.copy_length =
NUM2OFFT(length);
13451 if (
NIL_P(src_offset))
13452 st.src_offset = (rb_off_t)-1;
13454 st.src_offset =
NUM2OFFT(src_offset);
13473rb_io_external_encoding(
VALUE io)
13478 return rb_enc_from_encoding(fptr->
encs.
enc2);
13482 return rb_enc_from_encoding(fptr->
encs.
enc);
13485 return rb_enc_from_encoding(io_read_encoding(fptr));
13501rb_io_internal_encoding(
VALUE io)
13506 return rb_enc_from_encoding(io_read_encoding(fptr));
13540rb_io_set_encoding(
int argc,
VALUE *argv,
VALUE io)
13546 return forward(io, id_set_encoding, argc, argv);
13549 argc =
rb_scan_args(argc, argv,
"11:", &v1, &v2, &opt);
13551 io_encoding_set(fptr, v1, v2, opt);
13556rb_stdio_set_default_encoding(
void)
13561 if (isatty(fileno(stdin))) {
13563 rb_encoding *internal = rb_default_internal_encoding();
13564 if (!internal) internal = rb_default_external_encoding();
13566 rb_enc_from_encoding(external),
13567 rb_enc_from_encoding(internal),
13572 rb_io_set_encoding(1, &val,
rb_stdin);
13573 rb_io_set_encoding(1, &val,
rb_stdout);
13574 rb_io_set_encoding(1, &val,
rb_stderr);
13578global_argf_p(
VALUE arg)
13580 return arg ==
argf;
13583typedef VALUE (*argf_encoding_func)(
VALUE io);
13586argf_encoding(
VALUE argf, argf_encoding_func func)
13588 if (!
RTEST(ARGF.current_file)) {
13589 return rb_enc_default_external();
13613 return argf_encoding(
argf, rb_io_external_encoding);
13632 return argf_encoding(
argf, rb_io_internal_encoding);
13671 if (!next_argv()) {
13672 rb_raise(rb_eArgError,
"no stream to set encoding");
13674 rb_io_set_encoding(argc, argv, ARGF.current_file);
13676 ARGF.encs = fptr->
encs;
13695 if (!next_argv()) {
13696 rb_raise(rb_eArgError,
"no stream to tell");
13698 ARGF_FORWARD(0, 0);
13699 return rb_io_tell(ARGF.current_file);
13712 if (!next_argv()) {
13713 rb_raise(rb_eArgError,
"no stream to seek");
13715 ARGF_FORWARD(argc, argv);
13716 return rb_io_seek_m(argc, argv, ARGF.current_file);
13733 if (!next_argv()) {
13734 rb_raise(rb_eArgError,
"no stream to set position");
13736 ARGF_FORWARD(1, &offset);
13737 return rb_io_set_pos(ARGF.current_file, offset);
13758 if (!next_argv()) {
13759 rb_raise(rb_eArgError,
"no stream to rewind");
13761 ARGF_FORWARD(0, 0);
13762 old_lineno =
RFILE(ARGF.current_file)->fptr->lineno;
13763 ret = rb_io_rewind(ARGF.current_file);
13764 if (!global_argf_p(
argf)) {
13765 ARGF.last_lineno = ARGF.lineno -= old_lineno;
13783 if (!next_argv()) {
13784 rb_raise(rb_eArgError,
"no stream");
13786 ARGF_FORWARD(0, 0);
13787 return rb_io_fileno(ARGF.current_file);
13806 ARGF_FORWARD(0, 0);
13807 return ARGF.current_file;
13832 if (
RTEST(ARGF.current_file)) {
13833 if (ARGF.init_p == 0)
return Qtrue;
13835 ARGF_FORWARD(0, 0);
13894 VALUE tmp, str, length;
13898 if (!
NIL_P(length)) {
13903 rb_str_resize(str,0);
13908 if (!next_argv()) {
13911 if (ARGF_GENERIC_INPUT_P()) {
13912 tmp = argf_forward(argc, argv,
argf);
13915 tmp = io_read(argc, argv, ARGF.current_file);
13917 if (
NIL_P(str)) str = tmp;
13920 if (ARGF.next_p != -1) {
13926 else if (argc >= 1) {
13927 long slen = RSTRING_LEN(str);
13943argf_forward_call(
VALUE arg)
13946 argf_forward(p->argc, p->argv, p->argf);
13976 return argf_getpartial(argc, argv,
argf,
Qnil, 0);
13997 return argf_getpartial(argc, argv,
argf, opts, 1);
14003 VALUE tmp, str, length;
14011 no_exception = no_exception_p(opts);
14013 if (!next_argv()) {
14015 rb_str_resize(str, 0);
14019 if (ARGF_GENERIC_INPUT_P()) {
14029 tmp = io_getpartial(argc, argv, ARGF.current_file, no_exception, nonblock);
14032 if (ARGF.next_p == -1) {
14033 return io_nonblock_eof(no_exception);
14038 return io_nonblock_eof(no_exception);
14076 if (!next_argv())
return Qnil;
14077 if (ARGF_GENERIC_INPUT_P()) {
14078 ch = forward_current(rb_intern(
"getc"), 0, 0);
14081 ch = rb_io_getc(ARGF.current_file);
14083 if (
NIL_P(ch) && ARGF.next_p != -1) {
14116 if (!next_argv())
return Qnil;
14118 ch = forward_current(rb_intern(
"getbyte"), 0, 0);
14123 if (
NIL_P(ch) && ARGF.next_p != -1) {
14156 if (!next_argv()) rb_eof_error();
14158 ch = forward_current(rb_intern(
"getc"), 0, 0);
14161 ch = rb_io_getc(ARGF.current_file);
14163 if (
NIL_P(ch) && ARGF.next_p != -1) {
14195 NEXT_ARGF_FORWARD(0, 0);
14196 c = argf_getbyte(
argf);
14203#define FOREACH_ARGF() while (next_argv())
14208 const VALUE current = ARGF.current_file;
14210 if (ARGF.init_p == -1 || current != ARGF.current_file) {
14216#define ARGF_block_call(mid, argc, argv, func, argf) \
14217 rb_block_call_kw(ARGF.current_file, mid, argc, argv, \
14218 func, argf, rb_keyword_given_p())
14223 VALUE ret = ARGF_block_call(mid, argc, argv, argf_block_call_i,
argf);
14224 if (!UNDEF_P(ret)) ARGF.next_p = 1;
14230 if (!global_argf_p(
argf)) {
14231 ARGF.last_lineno = ++ARGF.lineno;
14233 return argf_block_call_i(i,
argf, argc, argv, blockarg);
14239 VALUE ret = ARGF_block_call(mid, argc, argv, argf_block_call_line_i,
argf);
14240 if (!UNDEF_P(ret)) ARGF.next_p = 1;
14288 argf_block_call_line(rb_intern(
"each_line"), argc, argv,
argf);
14319 argf_block_call(rb_intern(
"each_byte"), 0, 0,
argf);
14345 argf_block_call(rb_intern(
"each_char"), 0, 0,
argf);
14371 argf_block_call(rb_intern(
"each_codepoint"), 0, 0,
argf);
14402 return ARGF.filename;
14406argf_filename_getter(
ID id,
VALUE *var)
14408 return argf_filename(*var);
14433 return ARGF.current_file;
14452 ARGF_FORWARD(0, 0);
14473 return RBOOL(ARGF.binmode);
14493 if (ARGF.init_p && ARGF.next_p == 0) {
14522 if (ARGF.next_p != -1) {
14540 ARGF_FORWARD(0, 0);
14567 if (!ARGF.inplace)
return Qnil;
14575 return argf_inplace_mode_get(*var);
14606 ARGF.inplace =
Qnil;
14617 argf_inplace_mode_set(*var, val);
14621ruby_set_inplace_mode(
const char *suffix)
14647argf_argv_getter(
ID id,
VALUE *var)
14649 return argf_argv(*var);
14668 if (!
RTEST(ARGF.current_file)) {
14671 return GetWriteIO(ARGF.current_file);
14683 return rb_io_writev(argf_write_io(
argf), argc, argv);
14698 case RB_IO_WAIT_WRITABLE:
14701 c = rb_eEAGAINWaitWritable;
14703#if EAGAIN != EWOULDBLOCK
14705 c = rb_eEWOULDBLOCKWaitWritable;
14709 c = rb_eEINPROGRESSWaitWritable;
14715 case RB_IO_WAIT_READABLE:
14718 c = rb_eEAGAINWaitReadable;
14720#if EAGAIN != EWOULDBLOCK
14722 c = rb_eEWOULDBLOCKWaitReadable;
14726 c = rb_eEINPROGRESSWaitReadable;
14733 rb_bug(
"invalid read/write type passed to rb_readwrite_sys_fail: %d", waiting);
14739get_LAST_READ_LINE(
ID _x,
VALUE *_y)
15626#include <sys/cygwin.h>
15627 static struct __cygwin_perfile pf[] =
15629 {
"", O_RDONLY | O_BINARY},
15630 {
"", O_WRONLY | O_BINARY},
15631 {
"", O_RDWR | O_BINARY},
15632 {
"", O_APPEND | O_BINARY},
15635 cygwin_internal(CW_PERFILE, pf);
15690#if EAGAIN == EWOULDBLOCK
15691 rb_eEWOULDBLOCKWaitReadable = rb_eEAGAINWaitReadable;
15693 rb_define_const(
rb_cIO,
"EWOULDBLOCKWaitReadable", rb_eEAGAINWaitReadable);
15694 rb_eEWOULDBLOCKWaitWritable = rb_eEAGAINWaitWritable;
15696 rb_define_const(
rb_cIO,
"EWOULDBLOCKWaitWritable", rb_eEAGAINWaitWritable);
15744 rb_gvar_ractor_local(
"$/");
15746 rb_gvar_ractor_local(
"$-0");
15750 rb_gvar_ractor_local(
"$_");
15866 rb_gvar_ractor_local(
"$stdin");
15867 rb_gvar_ractor_local(
"$stdout");
15868 rb_gvar_ractor_local(
"$>");
15869 rb_gvar_ractor_local(
"$stderr");
15955 rb_define_method(rb_cARGF,
"external_encoding", argf_external_encoding, 0);
15956 rb_define_method(rb_cARGF,
"internal_encoding", argf_internal_encoding, 0);
15975 rb_gvar_ractor_local(
"$-i");
15979#if defined (_WIN32) || defined(__CYGWIN__)
15980 atexit(pipe_atexit);
15992 sym_encoding =
ID2SYM(rb_id_encoding());
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
unsigned long ruby_strtoul(const char *str, char **endptr, int base)
Our own locale-insensitive version of strtoul(3).
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
#define rb_define_global_function(mid, func, arity)
Defines rb_mKernel #mid.
void rb_include_module(VALUE klass, VALUE module)
Includes a module to a class.
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
VALUE rb_class_new(VALUE super)
Creates a new, anonymous class.
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
VALUE rb_define_module_under(VALUE outer, const char *name)
Defines a module under the namespace of outer.
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
int rb_scan_args_kw(int kw_flag, int argc, const VALUE *argv, const char *fmt,...)
Identical to rb_scan_args(), except it also accepts kw_splat.
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Retrieves argument from argc and argv to given VALUE references according to the format string.
int rb_block_given_p(void)
Determines if the current method is given a block.
int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
Keyword argument deconstructor.
#define ECONV_AFTER_OUTPUT
Old name of RUBY_ECONV_AFTER_OUTPUT.
#define rb_str_new2
Old name of rb_str_new_cstr.
#define TYPE(_)
Old name of rb_type.
#define RB_INTEGER_TYPE_P
Old name of rb_integer_type_p.
#define ENC_CODERANGE_7BIT
Old name of RUBY_ENC_CODERANGE_7BIT.
#define T_FILE
Old name of RUBY_T_FILE.
#define ENC_CODERANGE_VALID
Old name of RUBY_ENC_CODERANGE_VALID.
#define ECONV_UNIVERSAL_NEWLINE_DECORATOR
Old name of RUBY_ECONV_UNIVERSAL_NEWLINE_DECORATOR.
#define OBJ_INIT_COPY(obj, orig)
Old name of RB_OBJ_INIT_COPY.
#define ALLOC
Old name of RB_ALLOC.
#define RFLOAT_VALUE
Old name of rb_float_value.
#define T_STRING
Old name of RUBY_T_STRING.
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
#define rb_str_cat2
Old name of rb_str_cat_cstr.
#define T_NIL
Old name of RUBY_T_NIL.
#define UNREACHABLE
Old name of RBIMPL_UNREACHABLE.
#define ID2SYM
Old name of RB_ID2SYM.
#define T_BIGNUM
Old name of RUBY_T_BIGNUM.
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
#define T_FIXNUM
Old name of RUBY_T_FIXNUM.
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
#define FIX2UINT
Old name of RB_FIX2UINT.
#define SSIZET2NUM
Old name of RB_SSIZE2NUM.
#define ZALLOC
Old name of RB_ZALLOC.
#define CLASS_OF
Old name of rb_class_of.
#define rb_ary_new4
Old name of rb_ary_new_from_values.
#define ENCODING_MAXNAMELEN
Old name of RUBY_ENCODING_MAXNAMELEN.
#define MBCLEN_NEEDMORE_LEN(ret)
Old name of ONIGENC_MBCLEN_NEEDMORE_LEN.
#define ENCODING_GET(obj)
Old name of RB_ENCODING_GET.
#define LONG2FIX
Old name of RB_INT2FIX.
#define NUM2UINT
Old name of RB_NUM2UINT.
#define ALLOC_N
Old name of RB_ALLOC_N.
#define MBCLEN_CHARFOUND_LEN(ret)
Old name of ONIGENC_MBCLEN_CHARFOUND_LEN.
#define LONG2NUM
Old name of RB_LONG2NUM.
#define rb_exc_new3
Old name of rb_exc_new_str.
#define STRNCASECMP
Old name of st_locale_insensitive_strncasecmp.
#define MBCLEN_INVALID_P(ret)
Old name of ONIGENC_MBCLEN_INVALID_P.
#define ISASCII
Old name of rb_isascii.
#define ECONV_STATEFUL_DECORATOR_MASK
Old name of RUBY_ECONV_STATEFUL_DECORATOR_MASK.
#define Qtrue
Old name of RUBY_Qtrue.
#define MBCLEN_NEEDMORE_P(ret)
Old name of ONIGENC_MBCLEN_NEEDMORE_P.
#define ECONV_PARTIAL_INPUT
Old name of RUBY_ECONV_PARTIAL_INPUT.
#define NUM2INT
Old name of RB_NUM2INT.
#define ECONV_ERROR_HANDLER_MASK
Old name of RUBY_ECONV_ERROR_HANDLER_MASK.
#define INT2NUM
Old name of RB_INT2NUM.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define FIX2LONG
Old name of RB_FIX2LONG.
#define ENC_CODERANGE_BROKEN
Old name of RUBY_ENC_CODERANGE_BROKEN.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
#define NIL_P
Old name of RB_NIL_P.
#define ALLOCV_N
Old name of RB_ALLOCV_N.
#define MBCLEN_CHARFOUND_P(ret)
Old name of ONIGENC_MBCLEN_CHARFOUND_P.
#define NUM2CHR
Old name of RB_NUM2CHR.
#define NUM2LONG
Old name of RB_NUM2LONG.
#define UINT2NUM
Old name of RB_UINT2NUM.
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define ECONV_NEWLINE_DECORATOR_MASK
Old name of RUBY_ECONV_NEWLINE_DECORATOR_MASK.
#define CONST_ID
Old name of RUBY_CONST_ID.
#define rb_ary_new2
Old name of rb_ary_new_capa.
#define NUM2SIZET
Old name of RB_NUM2SIZE.
#define ENC_CODERANGE_SET(obj, cr)
Old name of RB_ENC_CODERANGE_SET.
#define rb_str_new4
Old name of rb_str_new_frozen.
#define ALLOCV_END
Old name of RB_ALLOCV_END.
#define SYMBOL_P
Old name of RB_SYMBOL_P.
#define ECONV_DEFAULT_NEWLINE_DECORATOR
Old name of RUBY_ECONV_DEFAULT_NEWLINE_DECORATOR.
void rb_notimplement(void)
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
void rb_category_warning(rb_warning_category_t category, const char *fmt,...)
Identical to rb_warning(), except it takes additional "category" parameter.
VALUE rb_eNotImpError
NotImplementedError exception.
void rb_exc_raise(VALUE mesg)
Raises an exception in the current thread.
void rb_syserr_fail(int e, const char *mesg)
Raises appropriate exception that represents a C errno.
void rb_readwrite_syserr_fail(enum rb_io_wait_readwrite waiting, int n, const char *mesg)
Identical to rb_readwrite_sys_fail(), except it does not depend on C global variable errno.
VALUE rb_eIOError
IOError exception.
VALUE rb_eStandardError
StandardError exception.
void rb_mod_syserr_fail_str(VALUE mod, int e, VALUE mesg)
Identical to rb_mod_syserr_fail(), except it takes the message in Ruby's String instead of C's.
void rb_syserr_fail_str(int e, VALUE mesg)
Identical to rb_syserr_fail(), except it takes the message in Ruby's String instead of C's.
#define ruby_verbose
This variable controls whether the interpreter is in debug mode.
VALUE rb_eTypeError
TypeError exception.
VALUE rb_eEOFError
EOFError exception.
void rb_readwrite_sys_fail(enum rb_io_wait_readwrite waiting, const char *mesg)
Raises appropriate exception using the parameters.
void rb_iter_break_value(VALUE val)
Identical to rb_iter_break(), except it additionally takes the "value" of this breakage.
rb_io_wait_readwrite
for rb_readwrite_sys_fail first argument
VALUE rb_eRuntimeError
RuntimeError exception.
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
VALUE rb_eSystemCallError
SystemCallError exception.
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
VALUE rb_mKernel
Kernel module.
VALUE rb_check_to_int(VALUE val)
Identical to rb_check_to_integer(), except it uses #to_int for conversion.
VALUE rb_any_to_s(VALUE obj)
Generates a textual representation of the given object.
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
VALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
Allocates, then initialises an instance of the given class.
VALUE rb_class_new_instance_kw(int argc, const VALUE *argv, VALUE klass, int kw_splat)
Identical to rb_class_new_instance(), except you can specify how to handle the last element of the gi...
VALUE rb_mEnumerable
Enumerable module.
VALUE rb_stdin
STDIN constant.
VALUE rb_stderr
STDERR constant.
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
VALUE rb_obj_dup(VALUE obj)
Duplicates the given object.
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
VALUE rb_mWaitReadable
IO::WaitReadable module.
VALUE rb_mWaitWritable
IO::WaitReadable module.
VALUE rb_obj_freeze(VALUE obj)
Just calls rb_obj_freeze_inline() inside.
VALUE rb_check_to_integer(VALUE val, const char *mid)
Identical to rb_check_convert_type(), except the return value type is fixed to rb_cInteger.
VALUE rb_cFile
File class.
VALUE rb_stdout
STDOUT constant.
VALUE rb_to_int(VALUE val)
Identical to rb_check_to_int(), except it raises in case of conversion mismatch.
static unsigned int rb_enc_codepoint(const char *p, const char *e, rb_encoding *enc)
Queries the code point of character pointed by the passed pointer.
VALUE rb_str_conv_enc(VALUE str, rb_encoding *from, rb_encoding *to)
Encoding conversion main routine.
VALUE rb_enc_uint_chr(unsigned int code, rb_encoding *enc)
Encodes the passed code point into a series of bytes.
long rb_str_coderange_scan_restartable(const char *str, const char *end, rb_encoding *enc, int *cr)
Scans the passed string until it finds something odd.
int rb_econv_prepare_options(VALUE opthash, VALUE *ecopts, int ecflags)
Identical to rb_econv_prepare_opts(), except it additionally takes the initial value of flags.
VALUE rb_econv_open_exc(const char *senc, const char *denc, int ecflags)
Creates a rb_eConverterNotFoundError exception object (but does not raise).
rb_econv_result_t rb_econv_convert(rb_econv_t *ec, const unsigned char **source_buffer_ptr, const unsigned char *source_buffer_end, unsigned char **destination_buffer_ptr, unsigned char *destination_buffer_end, int flags)
Converts a string from an encoding to another.
rb_econv_result_t
return value of rb_econv_convert()
@ econv_incomplete_input
The conversion stopped in middle of reading a character, possibly due to a partial read of a socket e...
@ econv_finished
The conversion stopped after converting everything.
@ econv_undefined_conversion
The conversion stopped when it found a character in the input which cannot be representable in the ou...
@ econv_source_buffer_empty
The conversion stopped because there is no input.
@ econv_destination_buffer_full
The conversion stopped because there is no destination.
@ econv_invalid_byte_sequence
The conversion stopped when it found an invalid sequence.
int rb_econv_putbackable(rb_econv_t *ec)
Queries if rb_econv_putback() makes sense, i.e.
const char * rb_econv_asciicompat_encoding(const char *encname)
Queries the passed encoding's corresponding ASCII compatible encoding.
VALUE rb_econv_str_convert(rb_econv_t *ec, VALUE src, int flags)
Identical to rb_econv_convert(), except it takes Ruby's string instead of C's pointer.
rb_econv_t * rb_econv_open_opts(const char *source_encoding, const char *destination_encoding, int ecflags, VALUE ecopts)
Identical to rb_econv_open(), except it additionally takes a hash of optional strings.
void rb_econv_binmode(rb_econv_t *ec)
This badly named function does not set the destination encoding to binary, but instead just nullifies...
VALUE rb_str_encode(VALUE str, VALUE to, int ecflags, VALUE ecopts)
Converts the contents of the passed string from its encoding to the passed one.
VALUE rb_econv_make_exception(rb_econv_t *ec)
This function makes sense right after rb_econv_convert() returns.
void rb_econv_check_error(rb_econv_t *ec)
This is a rb_econv_make_exception() + rb_exc_raise() combo.
void rb_econv_close(rb_econv_t *ec)
Destructs a converter.
void rb_econv_putback(rb_econv_t *ec, unsigned char *p, int n)
Puts back the bytes.
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
VALUE rb_funcallv_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
Identical to rb_funcallv(), except you can specify how to handle the last element of the given array.
Defines RBIMPL_HAS_BUILTIN.
VALUE rb_ary_concat(VALUE lhs, VALUE rhs)
Destructively appends the contents of latter into the end of former.
VALUE rb_ary_shift(VALUE ary)
Destructively deletes an element from the beginning of the passed array and returns what was deleted.
VALUE rb_check_array_type(VALUE obj)
Try converting an object to its array representation using its to_ary method, if any.
VALUE rb_ary_new(void)
Allocates a new, empty array.
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
VALUE rb_ary_entry(VALUE ary, long off)
Queries an element of an array.
VALUE rb_assoc_new(VALUE car, VALUE cdr)
Identical to rb_ary_new_from_values(), except it expects exactly two parameters.
#define RETURN_ENUMERATOR(obj, argc, argv)
Identical to RETURN_SIZED_ENUMERATOR(), except its size is unknown.
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
VALUE rb_io_printf(int argc, const VALUE *argv, VALUE io)
This is a rb_f_sprintf() + rb_io_write() combo.
VALUE rb_io_gets(VALUE io)
Reads a "line" from the given IO.
int rb_cloexec_pipe(int fildes[2])
Opens a pipe with closing on exec.
VALUE rb_io_print(int argc, const VALUE *argv, VALUE io)
Iterates over the passed array to apply rb_io_write() individually.
VALUE rb_io_addstr(VALUE io, VALUE str)
Identical to rb_io_write(), except it always returns the passed IO.
void rb_write_error(const char *str)
Writes the given error message to somewhere applicable.
VALUE rb_io_ungetbyte(VALUE io, VALUE b)
Identical to rb_io_ungetc(), except it doesn't take the encoding of the passed IO into account.
VALUE rb_io_getbyte(VALUE io)
Reads a byte from the given IO.
int rb_cloexec_dup2(int oldfd, int newfd)
Identical to rb_cloexec_dup(), except you can specify the destination file descriptor.
VALUE rb_io_fdopen(int fd, int flags, const char *path)
Creates an IO instance whose backend is the given file descriptor.
void rb_update_max_fd(int fd)
Informs the interpreter that the passed fd can be the max.
int rb_cloexec_open(const char *pathname, int flags, mode_t mode)
Opens a file that closes on exec.
VALUE rb_output_rs
The record separator character for outputs, or the $\.
VALUE rb_io_eof(VALUE io)
Queries if the passed IO is at the end of file.
void rb_write_error2(const char *str, long len)
Identical to rb_write_error(), except it additionally takes the message's length.
void rb_close_before_exec(int lowfd, int maxhint, VALUE noclose_fds)
Closes everything.
int rb_reserved_fd_p(int fd)
Queries if the given FD is reserved or not.
void rb_fd_fix_cloexec(int fd)
Sets or clears the close-on-exec flag of the passed file descriptor to the desired state.
VALUE rb_io_ascii8bit_binmode(VALUE io)
Forces no conversions be applied to the passed IO.
VALUE rb_io_binmode(VALUE io)
Sets the binmode.
VALUE rb_io_ungetc(VALUE io, VALUE c)
"Unget"s a string.
int rb_pipe(int *pipes)
This is an rb_cloexec_pipe() + rb_update_max_fd() combo.
VALUE rb_gets(void)
Much like rb_io_gets(), but it reads from the mysterious ARGF object.
int rb_cloexec_fcntl_dupfd(int fd, int minfd)
Duplicates a file descriptor with closing on exec.
VALUE rb_output_fs
The field separator character for outputs, or the $,.
VALUE rb_file_open_str(VALUE fname, const char *fmode)
Identical to rb_file_open(), except it takes the pathname as a Ruby's string instead of C's.
int rb_cloexec_dup(int oldfd)
Identical to rb_cloexec_fcntl_dupfd(), except it implies minfd is 3.
VALUE rb_file_open(const char *fname, const char *fmode)
Opens a file located at the given path.
VALUE rb_io_close(VALUE io)
Closes the IO.
VALUE rb_default_rs
This is the default value of rb_rs, i.e.
void rb_lastline_set(VALUE str)
Updates $_.
VALUE rb_lastline_get(void)
Queries the last line, or the $_.
int rb_obj_method_arity(VALUE obj, ID mid)
Identical to rb_mod_method_arity(), except it searches for singleton methods rather than instance met...
rb_pid_t rb_waitpid(rb_pid_t pid, int *status, int flags)
Waits for a process, with releasing GVL.
void rb_last_status_set(int status, rb_pid_t pid)
Sets the "last status", or the $?.
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
#define rb_str_new(str, len)
Allocates an instance of rb_cString.
#define rb_str_buf_cat
Just another name of rb_str_cat.
#define rb_usascii_str_new(str, len)
Identical to rb_str_new, except it generates a string of "US ASCII" encoding.
size_t rb_str_capacity(VALUE str)
Queries the capacity of the given string.
VALUE rb_str_new_frozen(VALUE str)
Creates a frozen copy of the string, if necessary.
VALUE rb_str_dup(VALUE str)
Duplicates a string.
VALUE rb_str_cat(VALUE dst, const char *src, long srclen)
Destructively appends the passed contents to the string.
VALUE rb_str_locktmp(VALUE str)
Obtains a "temporary lock" of the string.
VALUE rb_str_equal(VALUE str1, VALUE str2)
Equality of two strings.
void rb_str_set_len(VALUE str, long len)
Overwrites the length of the string.
VALUE rb_str_buf_cat_ascii(VALUE dst, const char *src)
Identical to rb_str_cat_cstr(), except it additionally assumes the source string be a NUL terminated ...
VALUE rb_check_string_type(VALUE obj)
Try converting an object to its stringised representation using its to_str method,...
VALUE rb_str_substr(VALUE str, long beg, long len)
This is the implementation of two-argumented String#slice.
VALUE rb_str_unlocktmp(VALUE str)
Releases a lock formerly obtained by rb_str_locktmp().
void rb_str_modify_expand(VALUE str, long capa)
Identical to rb_str_modify(), except it additionally expands the capacity of the receiver.
VALUE rb_str_buf_new(long capa)
Allocates a "string buffer".
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
VALUE rb_obj_as_string(VALUE obj)
Try converting an object to its stringised representation using its to_s method, if any.
int rb_thread_interrupted(VALUE thval)
Checks if the thread's execution was recently interrupted.
VALUE rb_mutex_new(void)
Creates a mutex.
int rb_thread_fd_writable(int fd)
Identical to rb_thread_wait_fd(), except it blocks the current thread until the given file descriptor...
VALUE rb_exec_recursive(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE h)
"Recursion" API entry point.
VALUE rb_mutex_synchronize(VALUE mutex, VALUE(*func)(VALUE arg), VALUE arg)
Obtains the lock, runs the passed function, and releases the lock when it completes.
void rb_thread_check_ints(void)
Checks for interrupts.
VALUE rb_thread_current(void)
Obtains the "current" thread.
int rb_thread_wait_fd(int fd)
Blocks the current thread until the given file descriptor is ready to be read.
void rb_thread_sleep(int sec)
Blocks for the given period of time.
struct timeval rb_time_interval(VALUE num)
Creates a "time interval".
void rb_set_class_path(VALUE klass, VALUE space, const char *name)
Names a class.
VALUE rb_ivar_set(VALUE obj, ID name, VALUE val)
Identical to rb_iv_set(), except it accepts the name as an ID instead of a C string.
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
int rb_respond_to(VALUE obj, ID mid)
Queries if the object responds to the method.
VALUE rb_check_funcall(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcallv(), except it returns RUBY_Qundef instead of raising rb_eNoMethodError.
void rb_define_alloc_func(VALUE klass, rb_alloc_func_t func)
Sets the allocator function of a class.
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
#define RB_ID2SYM
Just another name of rb_id2sym.
void rb_define_global_const(const char *name, VALUE val)
Identical to rb_define_const(), except it defines that of "global", i.e.
void rb_define_readonly_variable(const char *name, const VALUE *var)
Identical to rb_define_variable(), except it does not allow Ruby programs to assign values to such gl...
rb_gvar_setter_t rb_gvar_readonly_setter
This function just raises rb_eNameError.
#define FMODE_READABLE
The IO is opened for reading.
enum rb_io_mode rb_io_modestr_fmode(const char *modestr)
Maps a file mode string (that rb_file_open() takes) into a mixture of FMODE_ flags.
VALUE rb_io_get_io(VALUE io)
Identical to rb_io_check_io(), except it raises exceptions on conversion failures.
VALUE rb_io_timeout(VALUE io)
Get the timeout associated with the specified io object.
VALUE rb_io_taint_check(VALUE obj)
void rb_io_read_check(rb_io_t *fptr)
Blocks until there is a pending read in the passed IO.
int rb_io_modestr_oflags(const char *modestr)
Identical to rb_io_modestr_fmode(), except it returns a mixture of O_ flags.
#define FMODE_SETENC_BY_BOM
This flag amends the encoding of the IO so that the BOM of the contents of the IO takes effect.
rb_io_event
Type of events that an IO can wait.
@ RUBY_IO_READABLE
IO::READABLE
@ RUBY_IO_PRIORITY
IO::PRIORITY
@ RUBY_IO_WRITABLE
IO::WRITABLE
#define FMODE_READWRITE
The IO is opened for both read/write.
#define FMODE_EXTERNAL
This flag means that an IO object is wrapping an "external" file descriptor, which is owned by someth...
#define GetOpenFile
This is an old name of RB_IO_POINTER.
void rb_io_check_byte_readable(rb_io_t *fptr)
Asserts that an IO is opened for byte-based reading.
#define FMODE_TTY
The IO is a TTY.
#define FMODE_CREATE
The IO is opened for creating.
void rb_io_check_readable(rb_io_t *fptr)
Just another name of rb_io_check_byte_readable.
int rb_wait_for_single_fd(int fd, int events, struct timeval *tv)
Blocks until the passed file descriptor is ready for the passed events.
FILE * rb_fdopen(int fd, const char *modestr)
Identical to rb_io_stdio_file(), except it takes file descriptors instead of Ruby's IO.
int rb_io_extract_encoding_option(VALUE opt, rb_encoding **enc_p, rb_encoding **enc2_p, enum rb_io_mode *fmode_p)
This function breaks down the option hash that IO#initialize takes into components.
int rb_io_descriptor(VALUE io)
Returns an integer representing the numeric file descriptor for io.
#define FMODE_WRITABLE
The IO is opened for writing.
FILE * rb_io_stdio_file(rb_io_t *fptr)
Finds or creates a stdio's file structure from a Ruby's one.
#define FMODE_APPEND
The IO is opened for appending.
#define MakeOpenFile
This is an old name of RB_IO_OPEN.
#define FMODE_DUPLEX
Ruby eventually detects that the IO is bidirectional.
#define FMODE_BINMODE
The IO is in "binary mode".
int rb_io_maybe_wait_readable(int error, VALUE io, VALUE timeout)
Blocks until the passed IO is ready for reading, if that makes sense for the passed errno.
int capa
Designed capacity of the buffer.
#define RB_IO_POINTER(obj, fp)
Queries the underlying IO pointer.
VALUE rb_io_maybe_wait(int error, VALUE io, VALUE events, VALUE timeout)
Identical to rb_io_wait() except it additionally takes previous errno.
VALUE rb_eIOTimeoutError
Indicates that a timeout has occurred while performing an IO operation.
char * ptr
Pointer to the underlying memory region, of at least capa bytes.
#define FMODE_SYNC
The IO is in "sync mode".
int off
Offset inside of ptr.
VALUE rb_io_path(VALUE io)
Returns the path for the given IO.
void rb_io_extract_modeenc(VALUE *vmode_p, VALUE *vperm_p, VALUE opthash, int *oflags_p, enum rb_io_mode *fmode_p, rb_io_enc_t *convconfig_p)
This function can be seen as an extended version of rb_io_extract_encoding_option() that not only con...
void rb_io_check_initialized(rb_io_t *fptr)
Asserts that the passed IO is initialised.
#define FMODE_EXCL
This flag amends the effect of FMODE_CREATE, so that if there already is a file at the given path the...
#define FMODE_TEXTMODE
The IO is in "text mode".
int rb_io_fptr_finalize(rb_io_t *fptr)
Destroys the given IO.
VALUE rb_io_check_io(VALUE io)
Try converting an object to its IO representation using its to_io method, if any.
VALUE rb_io_closed_p(VALUE io)
Returns whether or not the underlying IO is closed.
VALUE rb_io_set_timeout(VALUE io, VALUE timeout)
Set the timeout associated with the specified io object.
ssize_t rb_io_bufwrite(VALUE io, const void *buf, size_t size)
Buffered write to the passed IO.
void rb_io_check_char_readable(rb_io_t *fptr)
Asserts that an IO is opened for character-based reading.
#define FMODE_TRUNC
This flag amends the effect of FMODE_CREATE, so that if there already is a file at the given path it ...
VALUE rb_io_get_write_io(VALUE io)
Queries the tied IO for writing.
void rb_io_set_nonblock(rb_io_t *fptr)
Instructs the OS to put its internal file structure into "nonblocking mode".
int rb_io_wait_writable(int fd)
Blocks until the passed file descriptor gets writable.
VALUE rb_io_open_descriptor(VALUE klass, int descriptor, int mode, VALUE path, VALUE timeout, struct rb_io_encoding *encoding)
Allocate a new IO object, with the given file descriptor.
VALUE rb_io_set_write_io(VALUE io, VALUE w)
Assigns the tied IO for writing.
void rb_io_check_writable(rb_io_t *fptr)
Asserts that an IO is opened for writing.
int rb_io_maybe_wait_writable(int error, VALUE io, VALUE timeout)
Blocks until the passed IO is ready for writing, if that makes sense for the passed errno.
void rb_io_check_closed(rb_io_t *fptr)
This badly named function asserts that the passed IO is open.
int rb_io_wait_readable(int fd)
Blocks until the passed file descriptor gets readable.
void rb_io_synchronized(rb_io_t *fptr)
Sets FMODE_SYNC.
VALUE rb_io_wait(VALUE io, VALUE events, VALUE timeout)
Blocks until the passed IO is ready for the passed events.
int len
Length of the buffer.
VALUE rb_ractor_stdin(void)
Queries the standard input of the current Ractor that is calling this function.
void rb_ractor_stderr_set(VALUE io)
Assigns an IO to the standard error of the Ractor that is calling this function.
void rb_ractor_stdout_set(VALUE io)
Assigns an IO to the standard output of the Ractor that is calling this function.
void rb_ractor_stdin_set(VALUE io)
Assigns an IO to the standard input of the Ractor that is calling this function.
void * rb_thread_call_with_gvl(void *(*func)(void *), void *data1)
(Re-)acquires the GVL.
#define RB_NUM2INT
Just another name of rb_num2int_inline.
#define RB_INT2NUM
Just another name of rb_int2num_inline.
VALUE rb_f_sprintf(int argc, const VALUE *argv)
Identical to rb_str_format(), except how the arguments are arranged.
#define RB_BLOCK_CALL_FUNC_ARGLIST(yielded_arg, callback_arg)
Shim for block function parameters.
VALUE rb_yield_values2(int n, const VALUE *argv)
Identical to rb_yield_values(), except it takes the parameters as a C array instead of variadic argum...
VALUE rb_yield(VALUE val)
Yields the block.
void rb_fd_term(rb_fdset_t *f)
Destroys the rb_fdset_t, releasing any memory and resources it used.
#define MEMZERO(p, type, n)
Handy macro to erase a region of memory.
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
#define MEMMOVE(p1, p2, type, n)
Handy macro to call memmove.
#define NUM2MODET
Converts a C's mode_t into an instance of rb_cInteger.
void rb_define_hooked_variable(const char *q, VALUE *w, type *e, void_type *r)
Define a function-backended global variable.
void rb_define_virtual_variable(const char *q, type *w, void_type *e)
Define a function-backended global variable.
VALUE rb_rescue2(type *q, VALUE w, type *e, VALUE r,...)
An equivalent of rescue clause.
VALUE rb_ensure(type *q, VALUE w, type *e, VALUE r)
An equivalent of ensure clause.
#define PRI_OFFT_PREFIX
A rb_sprintf() format prefix to be used for an off_t parameter.
#define OFFT2NUM
Converts a C's off_t into an instance of rb_cInteger.
#define NUM2OFFT
Converts an instance of rb_cNumeric into C's off_t.
#define PIDT2NUM
Converts a C's pid_t into an instance of rb_cInteger.
#define rb_fd_isset
Queries if the given fd is in the rb_fdset_t.
#define rb_fd_select
Waits for multiple file descriptors at once.
#define rb_fd_init
Initialises the :given :rb_fdset_t.
#define rb_fd_set
Sets the given fd to the rb_fdset_t.
#define RARRAY_LEN
Just another name of rb_array_len.
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
#define RARRAY_AREF(a, i)
#define RARRAY_CONST_PTR
Just another name of rb_array_const_ptr.
#define RFILE(obj)
Convenient casting macro.
#define StringValue(v)
Ensures that the parameter object is a String.
static char * RSTRING_END(VALUE str)
Queries the end of the contents pointer of the string.
#define RSTRING_GETMEM(str, ptrvar, lenvar)
Convenient macro to obtain the contents and length at once.
#define StringValueCStr(v)
Identical to StringValuePtr, except it additionally checks for the contents for viability as a C stri...
#define RUBY_TYPED_DEFAULT_FREE
This is a value you can set to rb_data_type_struct::dfree.
#define TypedData_Make_Struct(klass, type, data_type, sval)
Identical to TypedData_Wrap_Struct, except it allocates a new data region internally instead of takin...
VALUE rb_get_argv(void)
Queries the arguments passed to the current process that you can access from Ruby as ARGV.
void rb_p(VALUE obj)
Inspects an object.
#define FilePathValue(v)
Ensures that the parameter object is a path.
#define errno
Ractor-aware version of errno.
#define RB_SCAN_ARGS_LAST_HASH_KEYWORDS
Treat a final argument as keywords if it is a hash, and not as keywords otherwise.
#define RB_PASS_CALLED_KEYWORDS
Pass keywords if current method is called with keywords, useful for argument delegation.
VALUE rb_fiber_scheduler_current(void)
Identical to rb_fiber_scheduler_get(), except it also returns RUBY_Qnil in case of a blocking fiber.
VALUE rb_fiber_scheduler_io_pread_memory(VALUE scheduler, VALUE io, rb_off_t from, void *base, size_t size, size_t length)
Non-blocking pread from the passed IO using a native buffer.
VALUE rb_fiber_scheduler_make_timeout(struct timeval *timeout)
Converts the passed timeout to an expression that rb_fiber_scheduler_block() etc.
VALUE rb_fiber_scheduler_io_wait_readable(VALUE scheduler, VALUE io)
Non-blocking wait until the passed IO is ready for reading.
VALUE rb_fiber_scheduler_io_read_memory(VALUE scheduler, VALUE io, void *base, size_t size, size_t length)
Non-blocking read from the passed IO using a native buffer.
VALUE rb_fiber_scheduler_io_wait(VALUE scheduler, VALUE io, VALUE events, VALUE timeout)
Non-blocking version of rb_io_wait().
static ssize_t rb_fiber_scheduler_io_result_apply(VALUE result)
Apply an io result to the local thread, returning the value of the original system call that created ...
VALUE rb_fiber_scheduler_io_selectv(VALUE scheduler, int argc, VALUE *argv)
Non-blocking version of IO.select, argv variant.
VALUE rb_fiber_scheduler_io_pwrite_memory(VALUE scheduler, VALUE io, rb_off_t from, const void *base, size_t size, size_t length)
Non-blocking pwrite to the passed IO using a native buffer.
VALUE rb_fiber_scheduler_current_for_thread(VALUE thread)
Identical to rb_fiber_scheduler_current(), except it queries for that of the passed thread value inst...
VALUE rb_fiber_scheduler_io_write_memory(VALUE scheduler, VALUE io, const void *base, size_t size, size_t length)
Non-blocking write to the passed IO using a native buffer.
VALUE rb_fiber_scheduler_current_for_threadptr(struct rb_thread_struct *thread)
Identical to rb_fiber_scheduler_current_for_thread(), except it expects a threadptr instead of a thre...
VALUE rb_fiber_scheduler_io_wait_writable(VALUE scheduler, VALUE io)
Non-blocking wait until the passed IO is ready for writing.
VALUE rb_fiber_scheduler_io_close(VALUE scheduler, VALUE io)
Non-blocking close the given IO.
int rb_thread_fd_select(int nfds, rb_fdset_t *rfds, rb_fdset_t *wfds, rb_fdset_t *efds, struct timeval *timeout)
Waits for multiple file descriptors at once.
static bool RB_TEST(VALUE obj)
Emulates Ruby's "if" statement.
#define RTEST
This is an old name of RB_TEST.
#define _(args)
This was a transition path from K&R to ANSI.
This is the struct that holds necessary info for a struct.
The data structure which wraps the fd_set bitmap used by select(2).
Decomposed encoding flags (e.g.
VALUE ecopts
Flags as Ruby hash.
rb_encoding * enc2
External encoding.
rb_encoding * enc
Internal encoding.
char * ptr
Pointer to the underlying memory region, of at least capa bytes.
int off
Offset inside of ptr.
int len
Length of the buffer.
int capa
Designed capacity of the buffer.
Ruby's IO, metadata and buffers.
rb_io_buffer_t wbuf
Write buffer.
enum rb_io_mode mode
mode flags: FMODE_XXXs
void(* finalize)(struct rb_io *, int)
finalize proc
rb_econv_t * readconv
Encoding converter used when reading from this IO.
rb_econv_t * writeconv
Encoding converter used when writing to this IO.
struct rb_io_encoding encs
Decomposed encoding flags.
VALUE self
The IO's Ruby level counterpart.
VALUE write_lock
This is a Ruby level mutex.
VALUE timeout
The timeout associated with this IO when performing blocking operations.
FILE * stdio_file
stdio ptr for read/write, if available.
VALUE writeconv_pre_ecopts
Value of ::rb_io_t::rb_io_enc_t::ecopts stored right before initialising rb_io_t::writeconv.
VALUE tied_io_for_writing
Duplex IO object, if set.
int writeconv_initialized
Whether rb_io_t::writeconv is already set up.
rb_io_buffer_t rbuf
(Byte) read buffer.
int lineno
number of lines read
struct ccan_list_head blocking_operations
Threads that are performing a blocking operation without the GVL using this IO.
VALUE writeconv_asciicompat
This is, when set, an instance of rb_cString which holds the "common" encoding.
rb_io_buffer_t cbuf
rb_io_ungetc() destination.
rb_pid_t pid
child's pid (for pipes)
int writeconv_pre_ecflags
Value of ::rb_io_t::rb_io_enc_t::ecflags stored right before initialising rb_io_t::writeconv.
VALUE pathv
pathname for file
intptr_t SIGNED_VALUE
A signed integer type that has the same width with VALUE.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static bool RB_FLOAT_TYPE_P(VALUE obj)
Queries if the object is an instance of rb_cFloat.
static bool RB_SYMBOL_P(VALUE obj)
Queries if the object is an instance of rb_cSymbol.
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.