1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
|
/* ref: rubinius b2811f260de16d1e972462e27852470364608de5 */
#define RSTRING_MODIFIED 1
#include "kgio.h"
#include "my_fileno.h"
#include "nonblock.h"
static VALUE sym_wait_readable;
#ifdef USE_MSG_DONTWAIT
static const int peek_flags = MSG_DONTWAIT|MSG_PEEK;
/* we don't need these variants, we call kgio_autopush_recv directly */
static inline void kgio_autopush_read(VALUE io) { }
#else
static const int peek_flags = MSG_PEEK;
static inline void kgio_autopush_read(VALUE io) { kgio_autopush_recv(io); }
#endif
struct rd_args {
VALUE io;
VALUE buf;
char *ptr;
long len;
int fd;
};
NORETURN(static void my_eof_error(void));
static void my_eof_error(void)
{
kgio_raise_empty_bt(rb_eEOFError, "end of file reached");
}
static void prepare_read(struct rd_args *a, int argc, VALUE *argv, VALUE io)
{
VALUE length;
a->io = io;
a->fd = my_fileno(io);
rb_scan_args(argc, argv, "11", &length, &a->buf);
a->len = NUM2LONG(length);
if (NIL_P(a->buf)) {
a->buf = rb_str_new(NULL, a->len);
} else {
StringValue(a->buf);
rb_str_modify(a->buf);
rb_str_resize(a->buf, a->len);
}
a->ptr = RSTRING_PTR(a->buf);
}
static int read_check(struct rd_args *a, long n, const char *msg, int io_wait)
{
if (n < 0) {
if (errno == EINTR) {
a->fd = my_fileno(a->io);
return -1;
}
rb_str_set_len(a->buf, 0);
if (errno == EAGAIN) {
if (io_wait) {
(void)kgio_call_wait_readable(a->io);
/* buf may be modified in other thread/fiber */
rb_str_modify(a->buf);
rb_str_resize(a->buf, a->len);
a->ptr = RSTRING_PTR(a->buf);
return -1;
} else {
a->buf = sym_wait_readable;
return 0;
}
}
kgio_rd_sys_fail(msg);
}
rb_str_set_len(a->buf, n);
if (n == 0)
a->buf = Qnil;
return 0;
}
static VALUE my_read(int io_wait, int argc, VALUE *argv, VALUE io)
{
struct rd_args a;
long n;
prepare_read(&a, argc, argv, io);
kgio_autopush_read(io);
if (a.len > 0) {
set_nonblocking(a.fd);
retry:
n = (long)read(a.fd, a.ptr, a.len);
if (read_check(&a, n, "read", io_wait) != 0)
goto retry;
}
return a.buf;
}
/*
* call-seq:
*
* io.kgio_read(maxlen) -> buffer
* io.kgio_read(maxlen, buffer) -> buffer
*
* Reads at most maxlen bytes from the stream socket. Returns with a
* newly allocated buffer, or may reuse an existing buffer if supplied.
*
* This may block and call any method defined to +kgio_wait_readable+
* for the class.
*
* Returns nil on EOF.
*
* This behaves like read(2) and IO#readpartial, NOT fread(3) or
* IO#read which possess read-in-full behavior.
*/
static VALUE kgio_read(int argc, VALUE *argv, VALUE io)
{
return my_read(1, argc, argv, io);
}
/*
* Same as Kgio::PipeMethods#kgio_read, except EOFError is raised
* on EOF without a backtrace. This method is intended as a
* drop-in replacement for places where IO#readpartial is used, and
* may be aliased as such.
*/
static VALUE kgio_read_bang(int argc, VALUE *argv, VALUE io)
{
VALUE rv = my_read(1, argc, argv, io);
if (NIL_P(rv)) my_eof_error();
return rv;
}
/*
* call-seq:
*
* io.kgio_tryread(maxlen) -> buffer
* io.kgio_tryread(maxlen, buffer) -> buffer
*
* Reads at most maxlen bytes from the stream socket. Returns with a
* newly allocated buffer, or may reuse an existing buffer if supplied.
*
* Returns nil on EOF.
*
* Returns :wait_readable if EAGAIN is encountered.
*/
static VALUE kgio_tryread(int argc, VALUE *argv, VALUE io)
{
return my_read(0, argc, argv, io);
}
#ifdef USE_MSG_DONTWAIT
static VALUE my_recv(int io_wait, int argc, VALUE *argv, VALUE io)
{
struct rd_args a;
long n;
prepare_read(&a, argc, argv, io);
kgio_autopush_recv(io);
if (a.len > 0) {
retry:
n = (long)recv(a.fd, a.ptr, a.len, MSG_DONTWAIT);
if (read_check(&a, n, "recv", io_wait) != 0)
goto retry;
}
return a.buf;
}
/*
* This method may be optimized on some systems (e.g. GNU/Linux) to use
* MSG_DONTWAIT to avoid explicitly setting the O_NONBLOCK flag via fcntl.
* Otherwise this is the same as Kgio::PipeMethods#kgio_read
*/
static VALUE kgio_recv(int argc, VALUE *argv, VALUE io)
{
return my_recv(1, argc, argv, io);
}
/*
* Same as Kgio::SocketMethods#kgio_read, except EOFError is raised
* on EOF without a backtrace
*/
static VALUE kgio_recv_bang(int argc, VALUE *argv, VALUE io)
{
VALUE rv = my_recv(1, argc, argv, io);
if (NIL_P(rv)) my_eof_error();
return rv;
}
/*
* This method may be optimized on some systems (e.g. GNU/Linux) to use
* MSG_DONTWAIT to avoid explicitly setting the O_NONBLOCK flag via fcntl.
* Otherwise this is the same as Kgio::PipeMethods#kgio_tryread
*/
static VALUE kgio_tryrecv(int argc, VALUE *argv, VALUE io)
{
return my_recv(0, argc, argv, io);
}
#else /* ! USE_MSG_DONTWAIT */
# define kgio_recv kgio_read
# define kgio_recv_bang kgio_read_bang
# define kgio_tryrecv kgio_tryread
#endif /* USE_MSG_DONTWAIT */
static VALUE my_peek(int io_wait, int argc, VALUE *argv, VALUE io)
{
struct rd_args a;
long n;
prepare_read(&a, argc, argv, io);
kgio_autopush_recv(io);
if (a.len > 0) {
if (peek_flags == MSG_PEEK)
set_nonblocking(a.fd);
retry:
n = (long)recv(a.fd, a.ptr, a.len, peek_flags);
if (read_check(&a, n, "recv(MSG_PEEK)", io_wait) != 0)
goto retry;
}
return a.buf;
}
/*
* call-seq:
*
* socket.kgio_trypeek(maxlen) -> buffer
* socket.kgio_trypeek(maxlen, buffer) -> buffer
*
* Like kgio_tryread, except it uses MSG_PEEK so it does not drain the
* socket buffer. A subsequent read of any type (including another peek)
* will return the same data.
*/
static VALUE kgio_trypeek(int argc, VALUE *argv, VALUE io)
{
return my_peek(0, argc, argv, io);
}
/*
* call-seq:
*
* socket.kgio_peek(maxlen) -> buffer
* socket.kgio_peek(maxlen, buffer) -> buffer
*
* Like kgio_read, except it uses MSG_PEEK so it does not drain the
* socket buffer. A subsequent read of any type (including another peek)
* will return the same data.
*/
static VALUE kgio_peek(int argc, VALUE *argv, VALUE io)
{
return my_peek(1, argc, argv, io);
}
/*
* call-seq:
*
* Kgio.trypeek(socket, maxlen) -> buffer
* Kgio.trypeek(socket, maxlen, buffer) -> buffer
*
* Like Kgio.tryread, except it uses MSG_PEEK so it does not drain the
* socket buffer. This can only be used on sockets and not pipe objects.
* Maybe used in place of SocketMethods#kgio_trypeek for non-Kgio objects
*/
static VALUE s_trypeek(int argc, VALUE *argv, VALUE mod)
{
if (argc <= 1)
rb_raise(rb_eArgError, "wrong number of arguments");
return my_peek(0, argc - 1, &argv[1], argv[0]);
}
/*
* call-seq:
*
* Kgio.tryread(io, maxlen) -> buffer
* Kgio.tryread(io, maxlen, buffer) -> buffer
*
* Returns nil on EOF.
* Returns :wait_readable if EAGAIN is encountered.
*
* Maybe used in place of PipeMethods#kgio_tryread for non-Kgio objects
*/
static VALUE s_tryread(int argc, VALUE *argv, VALUE mod)
{
if (argc <= 1)
rb_raise(rb_eArgError, "wrong number of arguments");
return my_read(0, argc - 1, &argv[1], argv[0]);
}
void init_kgio_read(void)
{
VALUE mPipeMethods, mSocketMethods;
VALUE mKgio = rb_define_module("Kgio");
sym_wait_readable = ID2SYM(rb_intern("wait_readable"));
rb_define_singleton_method(mKgio, "tryread", s_tryread, -1);
rb_define_singleton_method(mKgio, "trypeek", s_trypeek, -1);
/*
* Document-module: Kgio::PipeMethods
*
* This module may be used used to create classes that respond to
* various Kgio methods for reading and writing. This is included
* in Kgio::Pipe by default.
*/
mPipeMethods = rb_define_module_under(mKgio, "PipeMethods");
rb_define_method(mPipeMethods, "kgio_read", kgio_read, -1);
rb_define_method(mPipeMethods, "kgio_read!", kgio_read_bang, -1);
rb_define_method(mPipeMethods, "kgio_tryread", kgio_tryread, -1);
/*
* Document-module: Kgio::SocketMethods
*
* This method behaves like Kgio::PipeMethods, but contains
* optimizations for sockets on certain operating systems
* (e.g. GNU/Linux).
*/
mSocketMethods = rb_define_module_under(mKgio, "SocketMethods");
rb_define_method(mSocketMethods, "kgio_read", kgio_recv, -1);
rb_define_method(mSocketMethods, "kgio_read!", kgio_recv_bang, -1);
rb_define_method(mSocketMethods, "kgio_tryread", kgio_tryrecv, -1);
rb_define_method(mSocketMethods, "kgio_trypeek", kgio_trypeek, -1);
rb_define_method(mSocketMethods, "kgio_peek", kgio_peek, -1);
}
|