fix compiler warnings, oops
[ruby_posix_mq.git] / ext / posix_mq / posix_mq.c
blob295835219d237929f9e28deb8f8f662876450fd7
1 #define _XOPEN_SOURCE 600
2 #ifdef HAVE_SYS_SELECT_H
3 # include <sys/select.h>
4 #endif
5 #ifdef HAVE_SIGNAL_H
6 # include <signal.h>
7 #endif
8 #ifdef HAVE_PTHREAD_H
9 # include <pthread.h>
10 #endif
11 #include <ruby.h>
13 #ifndef NUM2TIMET
14 # define NUM2TIMET NUM2INT
15 #endif
17 #include <time.h>
18 #include <mqueue.h>
19 #include <fcntl.h>
20 #include <sys/stat.h>
21 #include <errno.h>
22 #include <assert.h>
23 #include <unistd.h>
24 #include <float.h>
25 #include <math.h>
27 #if defined(__linux__)
28 # define MQD_TO_FD(mqd) (int)(mqd)
29 #elif defined(HAVE___MQ_OSHANDLE) /* FreeBSD */
30 # define MQD_TO_FD(mqd) __mq_oshandle(mqd)
31 #else
32 # define MQ_IO_MARK(mq) ((void)(0))
33 # define MQ_IO_SET(mq,val) ((void)(0))
34 # define MQ_IO_CLOSE(mq) ((int)(0))
35 # define MQ_IO_NIL_P(mq) ((int)(1))
36 #endif
38 struct posix_mq {
39 mqd_t des;
40 struct mq_attr attr;
41 VALUE name;
42 VALUE thread;
43 #ifdef MQD_TO_FD
44 VALUE io;
45 #endif
48 #ifdef MQD_TO_FD
49 # define MQ_IO_MARK(mq) rb_gc_mark((mq)->io)
50 # define MQ_IO_SET(mq,val) do { (mq)->io = (val); } while (0)
51 # define MQ_IO_NIL_P(mq) NIL_P((mq)->io)
52 static int MQ_IO_CLOSE(struct posix_mq *mq)
54 if (NIL_P(mq->io))
55 return 0;
57 /* not safe during GC */
58 rb_io_close(mq->io);
59 mq->io = Qnil;
61 return 1;
63 #endif
65 # define PMQ_WANTARRAY (1<<0)
66 # define PMQ_TRY (1<<1)
68 static VALUE cAttr;
69 static ID id_new, id_kill, id_fileno, id_divmod;
70 static ID id_flags, id_maxmsg, id_msgsize, id_curmsgs;
71 static VALUE sym_r, sym_w, sym_rw;
72 static const mqd_t MQD_INVALID = (mqd_t)-1;
74 /* Ruby 1.8.6+ macros (for compatibility with Ruby 1.9) */
75 #ifndef RSTRING_PTR
76 # define RSTRING_PTR(s) (RSTRING(s)->ptr)
77 #endif
78 #ifndef RSTRING_LEN
79 # define RSTRING_LEN(s) (RSTRING(s)->len)
80 #endif
81 #ifndef RFLOAT_VALUE
82 # define RFLOAT_VALUE(f) (RFLOAT(f)->value)
83 #endif
85 #ifndef HAVE_RB_STR_SET_LEN
86 /* this is taken from Ruby 1.8.7, 1.8.6 may not have it */
87 # ifdef RUBINIUS
88 # error upgrade Rubinius, rb_str_set_len should be available
89 # endif
90 static void rb_18_str_set_len(VALUE str, long len)
92 RSTRING(str)->len = len;
93 RSTRING(str)->ptr[len] = '\0';
95 #define rb_str_set_len rb_18_str_set_len
96 #endif /* !defined(HAVE_RB_STR_SET_LEN) */
98 /* partial emulation of the 1.9 rb_thread_blocking_region under 1.8 */
99 #ifndef HAVE_RB_THREAD_BLOCKING_REGION
100 # include <rubysig.h>
101 # define RUBY_UBF_IO ((rb_unblock_function_t *)-1)
102 typedef void rb_unblock_function_t(void *);
103 typedef VALUE rb_blocking_function_t(void *);
104 static VALUE
105 rb_thread_blocking_region(
106 rb_blocking_function_t *func, void *data1,
107 rb_unblock_function_t *ubf, void *data2)
109 VALUE rv;
111 assert(RUBY_UBF_IO == ubf && "RUBY_UBF_IO required for emulation");
113 TRAP_BEG;
114 rv = func(data1);
115 TRAP_END;
117 return rv;
119 #endif /* ! HAVE_RB_THREAD_BLOCKING_REGION */
121 /* used to pass arguments to mq_open inside blocking region */
122 struct open_args {
123 int argc;
124 const char *name;
125 int oflags;
126 mode_t mode;
127 struct mq_attr attr;
130 /* used to pass arguments to mq_send/mq_receive inside blocking region */
131 struct rw_args {
132 mqd_t des;
133 char *msg_ptr;
134 size_t msg_len;
135 unsigned msg_prio;
136 struct timespec *timeout;
139 #ifndef HAVE_MQ_TIMEDSEND
140 static mqd_t
141 not_timedsend(mqd_t mqdes, const char *msg_ptr,
142 size_t msg_len, unsigned msg_prio,
143 const struct timespec *abs_timeout)
145 rb_bug("mq_timedsend workaround failed");
146 return (mqd_t)-1;
148 # define mq_timedsend not_timedsend
149 #endif
150 #ifndef HAVE_MQ_TIMEDRECEIVE
151 static ssize_t
152 not_timedreceive(mqd_t mqdes, char *msg_ptr,
153 size_t msg_len, unsigned *msg_prio,
154 const struct timespec *abs_timeout)
156 rb_bug("mq_timedreceive workaround failed");
157 return (mqd_t)-1;
159 # define mq_timedreceive not_timedreceive
160 #endif
162 #if defined(HAVE_MQ_TIMEDRECEIVE) && defined(HAVE_MQ_TIMEDSEND)
163 static void num2timespec(struct timespec *ts, VALUE t)
165 switch (TYPE(t)) {
166 case T_FIXNUM:
167 case T_BIGNUM:
168 ts->tv_sec = NUM2TIMET(t);
169 ts->tv_nsec = 0;
170 break;
171 case T_FLOAT: {
172 double f, d;
173 double val = RFLOAT_VALUE(t);
175 d = modf(val, &f);
176 if (d >= 0) {
177 ts->tv_nsec = (long)(d * 1e9 + 0.5);
178 } else {
179 ts->tv_nsec = (long)(-d * 1e9 + 0.5);
180 if (ts->tv_nsec > 0) {
181 ts->tv_nsec = 1000000000 - ts->tv_nsec;
182 f -= 1;
185 ts->tv_sec = (time_t)f;
186 if (f != ts->tv_sec)
187 rb_raise(rb_eRangeError, "%f out of range", val);
189 break;
190 default: {
191 VALUE f;
192 VALUE ary = rb_funcall(t, id_divmod, 1, INT2FIX(1));
194 Check_Type(ary, T_ARRAY);
196 ts->tv_sec = NUM2TIMET(rb_ary_entry(ary, 0));
197 f = rb_ary_entry(ary, 1);
198 f = rb_funcall(f, '*', 1, INT2FIX(1000000000));
199 ts->tv_nsec = NUM2LONG(f);
203 #else
204 static void num2timespec(struct timespec *ts, VALUE t)
206 rb_raise(rb_eNotImpError,
207 "mq_timedsend and/or mq_timedreceive missing");
209 #endif
211 static struct timespec *convert_timeout(struct timespec *dest, VALUE t)
213 struct timespec ts, now;
215 if (NIL_P(t))
216 return NULL;
218 num2timespec(&ts, t);
219 clock_gettime(CLOCK_REALTIME, &now);
220 dest->tv_sec = now.tv_sec + ts.tv_sec;
221 dest->tv_nsec = now.tv_nsec + ts.tv_nsec;
223 if (dest->tv_nsec > 1000000000) {
224 dest->tv_nsec -= 1000000000;
225 ++dest->tv_sec;
228 return dest;
231 /* (may) run without GVL */
232 static VALUE xopen(void *ptr)
234 struct open_args *x = ptr;
235 mqd_t rv;
237 switch (x->argc) {
238 case 2: rv = mq_open(x->name, x->oflags); break;
239 case 3: rv = mq_open(x->name, x->oflags, x->mode, NULL); break;
240 case 4: rv = mq_open(x->name, x->oflags, x->mode, &x->attr); break;
241 default: rv = MQD_INVALID;
244 return (VALUE)rv;
247 /* runs without GVL */
248 static VALUE xsend(void *ptr)
250 struct rw_args *x = ptr;
252 if (x->timeout)
253 return (VALUE)mq_timedsend(x->des, x->msg_ptr, x->msg_len,
254 x->msg_prio, x->timeout);
256 return (VALUE)mq_send(x->des, x->msg_ptr, x->msg_len, x->msg_prio);
259 /* runs without GVL */
260 static VALUE xrecv(void *ptr)
262 struct rw_args *x = ptr;
264 if (x->timeout)
265 return (VALUE)mq_timedreceive(x->des, x->msg_ptr, x->msg_len,
266 &x->msg_prio, x->timeout);
268 return (VALUE)mq_receive(x->des, x->msg_ptr, x->msg_len, &x->msg_prio);
271 /* called by GC */
272 static void mark(void *ptr)
274 struct posix_mq *mq = ptr;
276 rb_gc_mark(mq->name);
277 rb_gc_mark(mq->thread);
278 MQ_IO_MARK(mq);
281 /* called by GC */
282 static void _free(void *ptr)
284 struct posix_mq *mq = ptr;
286 if (mq->des != MQD_INVALID && MQ_IO_NIL_P(mq)) {
287 /* we ignore errors when gc-ing */
288 mq_close(mq->des);
289 errno = 0;
291 xfree(ptr);
294 /* automatically called at creation (before initialize) */
295 static VALUE alloc(VALUE klass)
297 struct posix_mq *mq;
298 VALUE rv = Data_Make_Struct(klass, struct posix_mq, mark, _free, mq);
300 mq->des = MQD_INVALID;
301 mq->attr.mq_flags = 0;
302 mq->attr.mq_maxmsg = 0;
303 mq->attr.mq_msgsize = -1;
304 mq->attr.mq_curmsgs = 0;
305 mq->name = Qnil;
306 mq->thread = Qnil;
307 MQ_IO_SET(mq, Qnil);
309 return rv;
312 /* unwraps the posix_mq struct from self */
313 static struct posix_mq *get(VALUE self, int need_valid)
315 struct posix_mq *mq;
317 Data_Get_Struct(self, struct posix_mq, mq);
319 if (need_valid && mq->des == MQD_INVALID)
320 rb_raise(rb_eIOError, "closed queue descriptor");
322 return mq;
325 static void check_struct_type(VALUE astruct)
327 if (CLASS_OF(astruct) == cAttr)
328 return;
329 astruct = rb_inspect(astruct);
330 rb_raise(rb_eTypeError, "not a POSIX_MQ::Attr: %s",
331 StringValuePtr(astruct));
334 static void rstruct2mqattr(struct mq_attr *attr, VALUE astruct, int all)
336 VALUE tmp;
338 check_struct_type(astruct);
339 attr->mq_flags = NUM2LONG(rb_funcall(astruct, id_flags, 0));
341 tmp = rb_funcall(astruct, id_maxmsg, 0);
342 if (all || !NIL_P(tmp))
343 attr->mq_maxmsg = NUM2LONG(tmp);
345 tmp = rb_funcall(astruct, id_msgsize, 0);
346 if (all || !NIL_P(tmp))
347 attr->mq_msgsize = NUM2LONG(tmp);
349 tmp = rb_funcall(astruct, id_curmsgs, 0);
350 if (!NIL_P(tmp))
351 attr->mq_curmsgs = NUM2LONG(tmp);
355 * call-seq:
356 * POSIX_MQ.new(name [, flags [, mode [, mq_attr]]) => mq
358 * Opens a POSIX message queue given by +name+. +name+ should start
359 * with a slash ("/") for portable applications.
361 * If a Symbol is given in place of integer +flags+, then:
363 * * +:r+ is equivalent to IO::RDONLY
364 * * +:w+ is equivalent to IO::CREAT|IO::WRONLY
365 * * +:rw+ is equivalent to IO::CREAT|IO::RDWR
367 * +mode+ is an integer and only used when IO::CREAT is used.
368 * +mq_attr+ is a POSIX_MQ::Attr and only used if IO::CREAT is used.
369 * If +mq_attr+ is not specified when creating a queue, then the
370 * system defaults will be used.
372 * See the manpage for mq_open(3) for more details on this function.
374 static VALUE init(int argc, VALUE *argv, VALUE self)
376 struct posix_mq *mq = get(self, 0);
377 struct open_args x;
378 VALUE name, oflags, mode, attr;
380 rb_scan_args(argc, argv, "13", &name, &oflags, &mode, &attr);
382 switch (TYPE(oflags)) {
383 case T_NIL:
384 x.oflags = O_RDONLY;
385 break;
386 case T_SYMBOL:
387 if (oflags == sym_r)
388 x.oflags = O_RDONLY;
389 else if (oflags == sym_w)
390 x.oflags = O_CREAT|O_WRONLY;
391 else if (oflags == sym_rw)
392 x.oflags = O_CREAT|O_RDWR;
393 else {
394 oflags = rb_inspect(oflags);
395 rb_raise(rb_eArgError,
396 "symbol must be :r, :w, or :rw: %s",
397 StringValuePtr(oflags));
399 break;
400 case T_BIGNUM:
401 case T_FIXNUM:
402 x.oflags = NUM2INT(oflags);
403 break;
404 default:
405 rb_raise(rb_eArgError, "flags must be an int, :r, :w, or :wr");
408 x.name = StringValueCStr(name);
409 x.argc = 2;
411 switch (TYPE(mode)) {
412 case T_FIXNUM:
413 x.argc = 3;
414 x.mode = NUM2UINT(mode);
415 break;
416 case T_NIL:
417 if (x.oflags & O_CREAT) {
418 x.argc = 3;
419 x.mode = 0666;
421 break;
422 default:
423 rb_raise(rb_eArgError, "mode not an integer");
426 switch (TYPE(attr)) {
427 case T_STRUCT:
428 x.argc = 4;
429 rstruct2mqattr(&x.attr, attr, 1);
431 /* principle of least surprise */
432 if (x.attr.mq_flags & O_NONBLOCK)
433 x.oflags |= O_NONBLOCK;
434 break;
435 case T_NIL:
436 break;
437 default:
438 check_struct_type(attr);
441 mq->des = (mqd_t)xopen(&x);
442 if (mq->des == MQD_INVALID) {
443 switch (errno) {
444 case ENOMEM:
445 case EMFILE:
446 case ENFILE:
447 case ENOSPC:
448 rb_gc();
449 mq->des = (mqd_t)xopen(&x);
451 if (mq->des == MQD_INVALID)
452 rb_sys_fail("mq_open");
455 mq->name = rb_str_dup(name);
456 if (x.oflags & O_NONBLOCK)
457 mq->attr.mq_flags = O_NONBLOCK;
459 return self;
463 * call-seq:
464 * POSIX_MQ.unlink(name) => 1
466 * Unlinks the message queue given by +name+. The queue will be destroyed
467 * when the last process with the queue open closes its queue descriptors.
469 static VALUE s_unlink(VALUE self, VALUE name)
471 mqd_t rv = mq_unlink(StringValueCStr(name));
473 if (rv == MQD_INVALID)
474 rb_sys_fail("mq_unlink");
476 return INT2NUM(1);
480 * call-seq:
481 * mq.unlink => mq
483 * Unlinks the message queue to prevent other processes from accessing it.
484 * All existing queue descriptors to this queue including those opened by
485 * other processes are unaffected. The queue will only be destroyed
486 * when the last process with open descriptors to this queue closes
487 * the descriptors.
489 static VALUE _unlink(VALUE self)
491 struct posix_mq *mq = get(self, 0);
492 mqd_t rv;
494 assert(TYPE(mq->name) == T_STRING && "mq->name is not a string");
496 rv = mq_unlink(RSTRING_PTR(mq->name));
497 if (rv == MQD_INVALID)
498 rb_sys_fail("mq_unlink");
500 return self;
503 static void setup_send_buffer(struct rw_args *x, VALUE buffer)
505 buffer = rb_obj_as_string(buffer);
506 x->msg_ptr = RSTRING_PTR(buffer);
507 x->msg_len = (size_t)RSTRING_LEN(buffer);
510 static VALUE _send(int sflags, int argc, VALUE *argv, VALUE self);
513 * call-seq:
514 * mq.send(string [,priority[, timeout]]) => true
516 * Inserts the given +string+ into the message queue with an optional,
517 * unsigned integer +priority+. If the optional +timeout+ is specified,
518 * then Errno::ETIMEDOUT will be raised if the operation cannot complete
519 * before +timeout+ seconds has elapsed. Without +timeout+, this method
520 * may block until the queue is writable.
522 * On some older systems, the +timeout+ argument is not currently
523 * supported and may raise NotImplementedError if +timeout+ is used.
525 static VALUE my_send(int argc, VALUE *argv, VALUE self)
527 return _send(0, argc, argv, self);
530 static VALUE _send(int sflags, int argc, VALUE *argv, VALUE self)
532 struct posix_mq *mq = get(self, 1);
533 struct rw_args x;
534 VALUE buffer, prio, timeout;
535 mqd_t rv;
536 struct timespec expire;
538 rb_scan_args(argc, argv, "12", &buffer, &prio, &timeout);
540 setup_send_buffer(&x, buffer);
541 x.des = mq->des;
542 x.timeout = convert_timeout(&expire, timeout);
543 x.msg_prio = NIL_P(prio) ? 0 : NUM2UINT(prio);
545 rv = (mqd_t)rb_thread_blocking_region(xsend, &x, RUBY_UBF_IO, 0);
546 if (rv == MQD_INVALID) {
547 if (errno == EAGAIN && (sflags & PMQ_TRY))
548 return Qfalse;
549 rb_sys_fail("mq_send");
552 return Qtrue;
556 * call-seq:
557 * mq << string => mq
559 * Inserts the given +string+ into the message queue with a
560 * default priority of 0 and no timeout.
562 * Returns itself so its calls may be chained. This use is only
563 * recommended only for users who expect blocking behavior from
564 * the queue.
566 static VALUE send0(VALUE self, VALUE buffer)
568 struct posix_mq *mq = get(self, 1);
569 struct rw_args x;
570 mqd_t rv;
572 setup_send_buffer(&x, buffer);
573 x.des = mq->des;
574 x.timeout = NULL;
575 x.msg_prio = 0;
577 rv = (mqd_t)rb_thread_blocking_region(xsend, &x, RUBY_UBF_IO, 0);
578 if (rv == MQD_INVALID)
579 rb_sys_fail("mq_send");
581 return self;
584 #ifdef MQD_TO_FD
586 * call-seq:
587 * mq.to_io => IO
589 * Returns an IO.select-able +IO+ object. This method is only available
590 * under Linux and FreeBSD and is not intended to be portable.
592 static VALUE to_io(VALUE self)
594 struct posix_mq *mq = get(self, 1);
595 int fd = MQD_TO_FD(mq->des);
597 if (NIL_P(mq->io))
598 mq->io = rb_funcall(rb_cIO, id_new, 1, INT2NUM(fd));
600 return mq->io;
602 #endif
604 static VALUE _receive(int rflags, int argc, VALUE *argv, VALUE self);
607 * call-seq:
608 * mq.receive([buffer, [timeout]]) => [ message, priority ]
610 * Takes the highest priority message off the queue and returns
611 * an array containing the message as a String and the Integer
612 * priority of the message.
614 * If the optional +buffer+ is present, then it must be a String
615 * which will receive the data.
617 * If the optional +timeout+ is present, then it may be a Float
618 * or Integer specifying the timeout in seconds. Errno::ETIMEDOUT
619 * will be raised if +timeout+ has elapsed and there are no messages
620 * in the queue.
622 * On some older systems, the +timeout+ argument is not currently
623 * supported and may raise NotImplementedError if +timeout+ is used.
625 static VALUE receive(int argc, VALUE *argv, VALUE self)
627 return _receive(PMQ_WANTARRAY, argc, argv, self);
631 * call-seq:
632 * mq.shift([buffer, [timeout]]) => message
634 * Takes the highest priority message off the queue and returns
635 * the message as a String.
637 * If the optional +buffer+ is present, then it must be a String
638 * which will receive the data.
640 * If the optional +timeout+ is present, then it may be a Float
641 * or Integer specifying the timeout in seconds. Errno::ETIMEDOUT
642 * will be raised if +timeout+ has elapsed and there are no messages
643 * in the queue.
645 * On some older systems, the +timeout+ argument is not currently
646 * supported and may raise NotImplementedError if +timeout+ is used.
648 static VALUE shift(int argc, VALUE *argv, VALUE self)
650 return _receive(0, argc, argv, self);
653 static VALUE _receive(int rflags, int argc, VALUE *argv, VALUE self)
655 struct posix_mq *mq = get(self, 1);
656 struct rw_args x;
657 VALUE buffer, timeout;
658 ssize_t r;
659 struct timespec expire;
661 if (mq->attr.mq_msgsize < 0) {
662 if (mq_getattr(mq->des, &mq->attr) < 0)
663 rb_sys_fail("mq_getattr");
666 rb_scan_args(argc, argv, "02", &buffer, &timeout);
667 x.timeout = convert_timeout(&expire, timeout);
669 if (NIL_P(buffer)) {
670 buffer = rb_str_new(0, mq->attr.mq_msgsize);
671 } else {
672 StringValue(buffer);
673 rb_str_modify(buffer);
674 rb_str_resize(buffer, mq->attr.mq_msgsize);
676 OBJ_TAINT(buffer);
677 x.msg_ptr = RSTRING_PTR(buffer);
678 x.msg_len = (size_t)mq->attr.mq_msgsize;
679 x.des = mq->des;
681 r = (ssize_t)rb_thread_blocking_region(xrecv, &x, RUBY_UBF_IO, 0);
682 if (r < 0) {
683 if (errno == EAGAIN && (rflags & PMQ_TRY))
684 return Qnil;
685 rb_sys_fail("mq_receive");
688 rb_str_set_len(buffer, r);
690 if (rflags & PMQ_WANTARRAY)
691 return rb_ary_new3(2, buffer, UINT2NUM(x.msg_prio));
692 return buffer;
696 * call-seq:
697 * mq.attr => mq_attr
699 * Returns a POSIX_MQ::Attr struct containing the attributes
700 * of the message queue. See the mq_getattr(3) manpage for
701 * more details.
703 static VALUE getattr(VALUE self)
705 struct posix_mq *mq = get(self, 1);
707 if (mq_getattr(mq->des, &mq->attr) < 0)
708 rb_sys_fail("mq_getattr");
710 return rb_funcall(cAttr, id_new, 4,
711 LONG2NUM(mq->attr.mq_flags),
712 LONG2NUM(mq->attr.mq_maxmsg),
713 LONG2NUM(mq->attr.mq_msgsize),
714 LONG2NUM(mq->attr.mq_curmsgs));
718 * call-seq:
719 * mq.attr = POSIX_MQ::Attr(IO::NONBLOCK) => mq_attr
721 * Only the IO::NONBLOCK flag may be set or unset (zero) in this manner.
722 * See the mq_setattr(3) manpage for more details.
724 * Consider using the POSIX_MQ#nonblock= method as it is easier and
725 * more natural to use.
727 static VALUE setattr(VALUE self, VALUE astruct)
729 struct posix_mq *mq = get(self, 1);
730 struct mq_attr newattr;
732 rstruct2mqattr(&newattr, astruct, 0);
734 if (mq_setattr(mq->des, &newattr, NULL) < 0)
735 rb_sys_fail("mq_setattr");
737 return astruct;
741 * call-seq:
742 * mq.close => nil
744 * Closes the underlying message queue descriptor.
745 * If this descriptor had a registered notification request, the request
746 * will be removed so another descriptor or process may register a
747 * notification request. Message queue descriptors are automatically
748 * closed by garbage collection.
750 static VALUE _close(VALUE self)
752 struct posix_mq *mq = get(self, 1);
754 if (! MQ_IO_CLOSE(mq)) {
755 if (mq_close(mq->des) == -1)
756 rb_sys_fail("mq_close");
758 mq->des = MQD_INVALID;
760 return Qnil;
764 * call-seq:
765 * mq.closed? => true or false
767 * Returns +true+ if the message queue descriptor is closed and therefore
768 * unusable, otherwise +false+
770 static VALUE closed(VALUE self)
772 struct posix_mq *mq = get(self, 0);
774 return mq->des == MQD_INVALID ? Qtrue : Qfalse;
778 * call-seq:
779 * mq.name => string
781 * Returns the string name of message queue associated with +mq+
783 static VALUE name(VALUE self)
785 struct posix_mq *mq = get(self, 0);
787 return rb_str_dup(mq->name);
790 static int lookup_sig(VALUE sig)
792 static VALUE list;
793 const char *ptr;
794 long len;
796 sig = rb_obj_as_string(sig);
797 len = RSTRING_LEN(sig);
798 ptr = RSTRING_PTR(sig);
800 if (len > 3 && !memcmp("SIG", ptr, 3))
801 sig = rb_str_new(ptr + 3, len - 3);
803 if (!list) {
804 VALUE mSignal = rb_const_get(rb_cObject, rb_intern("Signal"));
806 list = rb_funcall(mSignal, rb_intern("list"), 0, 0);
807 rb_global_variable(&list);
810 sig = rb_hash_aref(list, sig);
811 if (NIL_P(sig))
812 rb_raise(rb_eArgError, "invalid signal: %s\n", ptr);
814 return NUM2INT(sig);
818 * TODO: Under Linux, we could just use netlink directly
819 * the same way glibc does...
821 /* we spawn a thread just to write ONE byte into an fd (usually a pipe) */
822 static void thread_notify_fd(union sigval sv)
824 int fd = sv.sival_int;
826 while ((write(fd, "", 1) < 0) && (errno == EINTR || errno == EAGAIN));
829 static void my_mq_notify(mqd_t des, struct sigevent *not)
831 mqd_t rv = mq_notify(des, not);
833 if (rv == MQD_INVALID) {
834 if (errno == ENOMEM) {
835 rb_gc();
836 rv = mq_notify(des, not);
838 if (rv == MQD_INVALID)
839 rb_sys_fail("mq_notify");
843 /* :nodoc: */
844 static VALUE setnotify_exec(VALUE self, VALUE io, VALUE thr)
846 int fd = NUM2INT(rb_funcall(io, id_fileno, 0, 0));
847 struct posix_mq *mq = get(self, 1);
848 struct sigevent not;
849 pthread_attr_t attr;
851 errno = pthread_attr_init(&attr);
852 if (errno) rb_sys_fail("pthread_attr_init");
854 errno = pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
855 if (errno) rb_sys_fail("pthread_attr_setdetachstate");
857 #ifdef PTHREAD_STACK_MIN
858 (void)pthread_attr_setstacksize(&attr, PTHREAD_STACK_MIN);
859 #endif
861 not.sigev_notify = SIGEV_THREAD;
862 not.sigev_notify_function = thread_notify_fd;
863 not.sigev_notify_attributes = &attr;
864 not.sigev_value.sival_int = fd;
866 if (!NIL_P(mq->thread))
867 rb_funcall(mq->thread, id_kill, 0, 0);
868 mq->thread = thr;
870 my_mq_notify(mq->des, &not);
872 return thr;
875 /* :nodoc: */
876 static VALUE notify_cleanup(VALUE self)
878 struct posix_mq *mq = get(self, 1);
880 if (!NIL_P(mq->thread)) {
881 rb_funcall(mq->thread, id_kill, 0, 0);
882 mq->thread = Qnil;
884 return Qnil;
888 * call-seq:
889 * mq.notify = signal => signal
891 * Registers the notification request to deliver a given +signal+
892 * to the current process when message is received.
893 * If +signal+ is +nil+, it will unregister and disable the notification
894 * request to allow other processes to register a request.
895 * If +signal+ is +false+, it will register a no-op notification request
896 * which will prevent other processes from registering a notification.
897 * If +signal+ is an +IO+ object, it will spawn a thread upon the
898 * arrival of the next message and write one "\\0" byte to the file
899 * descriptor belonging to that IO object.
900 * Only one process may have a notification request for a queue
901 * at a time, Errno::EBUSY will be raised if there is already
902 * a notification request registration for the queue.
904 * Notifications are only fired once and processes must reregister
905 * for subsequent notifications.
907 * For readers of the mq_notify(3) manpage, passing +false+
908 * is equivalent to SIGEV_NONE, and passing +nil+ is equivalent
909 * of passing a NULL notification pointer to mq_notify(3).
911 static VALUE setnotify(VALUE self, VALUE arg)
913 struct posix_mq *mq = get(self, 1);
914 struct sigevent not;
915 struct sigevent * notification = &not;
916 VALUE rv = arg;
918 notify_cleanup(self);
919 not.sigev_notify = SIGEV_SIGNAL;
921 switch (TYPE(arg)) {
922 case T_FALSE:
923 not.sigev_notify = SIGEV_NONE;
924 break;
925 case T_NIL:
926 notification = NULL;
927 break;
928 case T_FIXNUM:
929 not.sigev_signo = NUM2INT(arg);
930 break;
931 case T_SYMBOL:
932 case T_STRING:
933 not.sigev_signo = lookup_sig(arg);
934 rv = INT2NUM(not.sigev_signo);
935 break;
936 default:
937 rb_raise(rb_eArgError, "must be a signal or nil");
940 my_mq_notify(mq->des, notification);
942 return rv;
946 * call-seq:
947 * mq.nonblock? => true or false
949 * Returns the current non-blocking state of the message queue descriptor.
951 static VALUE nonblock_p(VALUE self)
953 struct posix_mq *mq = get(self, 1);
955 if (mq_getattr(mq->des, &mq->attr) < 0)
956 rb_sys_fail("mq_getattr");
957 return mq->attr.mq_flags & O_NONBLOCK ? Qtrue : Qfalse;
961 * call-seq:
962 * mq.nonblock = boolean => boolean
964 * Enables or disables non-blocking operation for the message queue
965 * descriptor. Errno::EAGAIN will be raised in situations where
966 * the queue would block. This is not compatible with +timeout+
967 * arguments to POSIX_MQ#send and POSIX_MQ#receive.
969 static VALUE setnonblock(VALUE self, VALUE nb)
971 struct mq_attr newattr;
972 struct posix_mq *mq = get(self, 1);
974 if (nb == Qtrue)
975 newattr.mq_flags = O_NONBLOCK;
976 else if (nb == Qfalse)
977 newattr.mq_flags = 0;
978 else
979 rb_raise(rb_eArgError, "must be true or false");
981 if (mq_setattr(mq->des, &newattr, &mq->attr) < 0)
982 rb_sys_fail("mq_setattr");
984 mq->attr.mq_flags = newattr.mq_flags;
986 return nb;
990 * call-seq:
991 * mq.trysend(string [,priority[, timeout]]) => +true+ or +false+
993 * Exactly like POSIX_MQ#send, except it returns +false+ instead of raising
994 * Errno::EAGAIN when non-blocking operation is desired and returns +true+
995 * on success instead of +nil+.
997 * This does not guarantee non-blocking behavior, the message queue must
998 * be made non-blocking before calling this method.
1000 static VALUE trysend(int argc, VALUE *argv, VALUE self)
1002 return _send(PMQ_TRY, argc, argv, self);
1006 * call-seq:
1007 * mq.tryshift([buffer [, timeout]]) => message or nil
1009 * Exactly like POSIX_MQ#shift, except it returns +nil+ instead of raising
1010 * Errno::EAGAIN when non-blocking operation is desired.
1012 * This does not guarantee non-blocking behavior, the message queue must
1013 * be made non-blocking before calling this method.
1015 static VALUE tryshift(int argc, VALUE *argv, VALUE self)
1017 return _receive(PMQ_TRY, argc, argv, self);
1021 * call-seq:
1022 * mq.tryreceive([buffer [, timeout]]) => [ message, priority ] or nil
1024 * Exactly like POSIX_MQ#receive, except it returns +nil+ instead of raising
1025 * Errno::EAGAIN when non-blocking operation is desired.
1027 * This does not guarantee non-blocking behavior, the message queue must
1028 * be made non-blocking before calling this method.
1030 static VALUE tryreceive(int argc, VALUE *argv, VALUE self)
1032 return _receive(PMQ_WANTARRAY|PMQ_TRY, argc, argv, self);
1035 void Init_posix_mq_ext(void)
1037 VALUE cPOSIX_MQ = rb_define_class("POSIX_MQ", rb_cObject);
1038 rb_define_alloc_func(cPOSIX_MQ, alloc);
1039 cAttr = rb_const_get(cPOSIX_MQ, rb_intern("Attr"));
1042 * The maximum number of open message descriptors supported
1043 * by the system. This may be -1, in which case it is dynamically
1044 * set at runtime. Consult your operating system documentation
1045 * for system-specific information about this.
1047 rb_define_const(cPOSIX_MQ, "OPEN_MAX",
1048 LONG2NUM(sysconf(_SC_MQ_OPEN_MAX)));
1051 * The maximum priority that may be specified for POSIX_MQ#send
1052 * On POSIX-compliant systems, this is at least 31, but some
1053 * systems allow higher limits.
1054 * The minimum priority is always zero.
1056 rb_define_const(cPOSIX_MQ, "PRIO_MAX",
1057 LONG2NUM(sysconf(_SC_MQ_PRIO_MAX)));
1059 rb_define_singleton_method(cPOSIX_MQ, "unlink", s_unlink, 1);
1061 rb_define_private_method(cPOSIX_MQ, "initialize", init, -1);
1062 rb_define_method(cPOSIX_MQ, "send", my_send, -1);
1063 rb_define_method(cPOSIX_MQ, "<<", send0, 1);
1064 rb_define_method(cPOSIX_MQ, "trysend", trysend, -1);
1065 rb_define_method(cPOSIX_MQ, "receive", receive, -1);
1066 rb_define_method(cPOSIX_MQ, "tryreceive", tryreceive, -1);
1067 rb_define_method(cPOSIX_MQ, "shift", shift, -1);
1068 rb_define_method(cPOSIX_MQ, "tryshift", tryshift, -1);
1069 rb_define_method(cPOSIX_MQ, "attr", getattr, 0);
1070 rb_define_method(cPOSIX_MQ, "attr=", setattr, 1);
1071 rb_define_method(cPOSIX_MQ, "close", _close, 0);
1072 rb_define_method(cPOSIX_MQ, "closed?", closed, 0);
1073 rb_define_method(cPOSIX_MQ, "unlink", _unlink, 0);
1074 rb_define_method(cPOSIX_MQ, "name", name, 0);
1075 rb_define_method(cPOSIX_MQ, "notify=", setnotify, 1);
1076 rb_define_method(cPOSIX_MQ, "nonblock=", setnonblock, 1);
1077 rb_define_private_method(cPOSIX_MQ, "notify_exec", setnotify_exec, 2);
1078 rb_define_private_method(cPOSIX_MQ, "notify_cleanup", notify_cleanup, 0);
1079 rb_define_method(cPOSIX_MQ, "nonblock?", nonblock_p, 0);
1080 #ifdef MQD_TO_FD
1081 rb_define_method(cPOSIX_MQ, "to_io", to_io, 0);
1082 #endif
1084 id_new = rb_intern("new");
1085 id_kill = rb_intern("kill");
1086 id_fileno = rb_intern("fileno");
1087 id_divmod = rb_intern("divmod");
1088 id_flags = rb_intern("flags");
1089 id_maxmsg = rb_intern("maxmsg");
1090 id_msgsize = rb_intern("msgsize");
1091 id_curmsgs = rb_intern("curmsgs");
1092 sym_r = ID2SYM(rb_intern("r"));
1093 sym_w = ID2SYM(rb_intern("w"));
1094 sym_rw = ID2SYM(rb_intern("rw"));