1 #define _XOPEN_SOURCE 600
2 #ifdef HAVE_SYS_SELECT_H
3 # include <sys/select.h>
18 #if defined(__linux__)
19 # define MQD_TO_FD(mqd) (int)(mqd)
20 #elif defined(HAVE___MQ_OSHANDLE) /* FreeBSD */
21 # define MQD_TO_FD(mqd) __mq_oshandle(mqd)
23 # warning mqd_t is not select()-able on your OS
24 # define MQ_IO_MARK(mq) ((void)(0))
25 # define MQ_IO_SET(mq,val) ((void)(0))
29 # define MQ_IO_MARK(mq) rb_gc_mark((mq)->io)
30 # define MQ_IO_SET(mq,val) do { (mq)->io = (val); } while (0)
42 static VALUE cPOSIX_MQ
, cAttr
;
44 static ID sym_r
, sym_w
, sym_rw
;
45 static const mqd_t MQD_INVALID
= (mqd_t
)-1;
47 /* Ruby 1.8.6+ macros (for compatibility with Ruby 1.9) */
49 # define RSTRING_PTR(s) (RSTRING(s)->ptr)
52 # define RSTRING_LEN(s) (RSTRING(s)->len)
55 # define RSTRUCT_PTR(s) (RSTRUCT(s)->ptr)
58 # define RSTRUCT_LEN(s) (RSTRUCT(s)->len)
61 #ifndef HAVE_RB_STR_SET_LEN
63 # define rb_str_set_len(str,len) rb_str_resize(str,len)
64 # else /* 1.8.6 optimized version */
65 /* this is taken from Ruby 1.8.7, 1.8.6 may not have it */
66 static void rb_18_str_set_len(VALUE str
, long len
)
68 RSTRING(str
)->len
= len
;
69 RSTRING(str
)->ptr
[len
] = '\0';
72 # define rb_str_set_len(str,len) rb_18_str_set_len(str,len)
73 # endif /* ! RUBINIUS */
74 #endif /* !defined(HAVE_RB_STR_SET_LEN) */
76 #ifndef HAVE_RB_STRUCT_ALLOC_NOINIT
77 static VALUE
rb_struct_alloc_noinit(VALUE
class)
79 return rb_funcall(class, id_new
, 0, 0);
81 #endif /* !defined(HAVE_RB_STRUCT_ALLOC_NOINIT) */
83 /* partial emulation of the 1.9 rb_thread_blocking_region under 1.8 */
84 #ifndef HAVE_RB_THREAD_BLOCKING_REGION
86 # define RUBY_UBF_IO ((rb_unblock_function_t *)-1)
87 typedef void rb_unblock_function_t(void *);
88 typedef VALUE
rb_blocking_function_t(void *);
90 rb_thread_blocking_region(
91 rb_blocking_function_t
*func
, void *data1
,
92 rb_unblock_function_t
*ubf
, void *data2
)
96 assert(RUBY_UBF_IO
== ubf
&& "RUBY_UBF_IO required for emulation");
104 #endif /* ! HAVE_RB_THREAD_BLOCKING_REGION */
106 /* used to pass arguments to mq_open inside blocking region */
115 /* used to pass arguments to mq_send/mq_receive inside blocking region */
121 struct timespec
*timeout
;
124 /* hope it's there..., TODO: a better version that works in rbx */
125 struct timeval
rb_time_interval(VALUE
);
127 static struct timespec
*convert_timeout(struct timespec
*dest
, VALUE time
)
129 struct timeval tv
, now
;
134 tv
= rb_time_interval(time
); /* aggregate return :( */
135 gettimeofday(&now
, NULL
);
136 dest
->tv_sec
= now
.tv_sec
+ tv
.tv_sec
;
137 dest
->tv_nsec
= (now
.tv_usec
+ tv
.tv_usec
) * 1000;
139 if (dest
->tv_nsec
> 1000000000) {
140 dest
->tv_nsec
-= 1000000000;
147 /* runs without GVL */
148 static VALUE
xopen(void *ptr
)
150 struct open_args
*x
= ptr
;
154 case 2: rv
= mq_open(x
->name
, x
->oflags
); break;
155 case 3: rv
= mq_open(x
->name
, x
->oflags
, x
->mode
, NULL
); break;
156 case 4: rv
= mq_open(x
->name
, x
->oflags
, x
->mode
, &x
->attr
); break;
157 default: rv
= MQD_INVALID
;
163 /* runs without GVL */
164 static VALUE
xsend(void *ptr
)
166 struct rw_args
*x
= ptr
;
169 return (VALUE
)mq_timedsend(x
->des
, x
->msg_ptr
, x
->msg_len
,
170 x
->msg_prio
, x
->timeout
);
172 return (VALUE
)mq_send(x
->des
, x
->msg_ptr
, x
->msg_len
, x
->msg_prio
);
175 /* runs without GVL */
176 static VALUE
xrecv(void *ptr
)
178 struct rw_args
*x
= ptr
;
181 return (VALUE
)mq_timedreceive(x
->des
, x
->msg_ptr
, x
->msg_len
,
182 &x
->msg_prio
, x
->timeout
);
184 return (VALUE
)mq_receive(x
->des
, x
->msg_ptr
, x
->msg_len
, &x
->msg_prio
);
187 /* runs without GVL, path resolution may be slow */
188 static VALUE
xunlink(void *ptr
)
190 VALUE name
= (VALUE
)ptr
;
192 return (VALUE
)mq_unlink(RSTRING_PTR(name
));
196 static void mark(void *ptr
)
198 struct posix_mq
*mq
= ptr
;
200 rb_gc_mark(mq
->name
);
205 static void _free(void *ptr
)
207 struct posix_mq
*mq
= ptr
;
209 if (mq
->des
!= MQD_INVALID
) {
210 /* we ignore errors when gc-ing */
211 int saved_errno
= errno
;
215 mq
->des
= MQD_INVALID
;
219 /* automatically called at creation (before initialize) */
220 static VALUE
alloc(VALUE klass
)
223 VALUE rv
= Data_Make_Struct(klass
, struct posix_mq
, mark
, _free
, mq
);
225 mq
->des
= MQD_INVALID
;
233 /* unwraps the posix_mq struct from self */
234 static struct posix_mq
*get(VALUE self
, int need_valid
)
238 Data_Get_Struct(self
, struct posix_mq
, mq
);
240 if (need_valid
&& mq
->des
== MQD_INVALID
)
241 rb_raise(rb_eIOError
, "closed queue descriptor");
246 /* converts the POSIX_MQ::Attr astruct into a struct mq_attr attr */
247 static void attr_from_struct(struct mq_attr
*attr
, VALUE astruct
, int all
)
251 if (CLASS_OF(astruct
) != cAttr
)
252 rb_raise(rb_eArgError
, "not a POSIX_MQ::Attr: %s",
253 RSTRING_PTR(rb_inspect(astruct
)));
255 ptr
= RSTRUCT_PTR(astruct
);
257 attr
->mq_flags
= NUM2LONG(ptr
[0]);
259 if (all
|| !NIL_P(ptr
[1]))
260 attr
->mq_maxmsg
= NUM2LONG(ptr
[1]);
261 if (all
|| !NIL_P(ptr
[2]))
262 attr
->mq_msgsize
= NUM2LONG(ptr
[2]);
264 attr
->mq_curmsgs
= NUM2LONG(ptr
[3]);
269 * POSIX_MQ.new(name [, flags [, mode [, mq_attr]]) => mq
271 * Opens a POSIX message queue given by +name+. +name+ should start
272 * with a slash ("/") for portable applications.
274 * If a Symbol is given in place of integer +flags+, then:
276 * * +:r+ is equivalent to IO::RDONLY
277 * * +:w+ is equivalent to IO::CREAT|IO::WRONLY
278 * * +:rw+ is equivalent to IO::CREAT|IO::RDWR
280 * +mode+ is an integer and only used when IO::CREAT is used.
281 * +mq_attr+ is a POSIX_MQ::Attr and only used if IO::CREAT is used.
282 * If +mq_attr+ is not specified when creating a queue, then the
283 * system defaults will be used.
285 * See the manpage for mq_open(3) for more details on this function.
287 static VALUE
init(int argc
, VALUE
*argv
, VALUE self
)
289 struct posix_mq
*mq
= get(self
, 0);
291 VALUE name
, oflags
, mode
, attr
;
293 rb_scan_args(argc
, argv
, "13", &name
, &oflags
, &mode
, &attr
);
295 if (TYPE(name
) != T_STRING
)
296 rb_raise(rb_eArgError
, "name must be a string");
298 switch (TYPE(oflags
)) {
305 else if (oflags
== sym_w
)
306 x
.oflags
= O_CREAT
|O_WRONLY
;
307 else if (oflags
== sym_rw
)
308 x
.oflags
= O_CREAT
|O_RDWR
;
310 rb_raise(rb_eArgError
,
311 "symbol must be :r, :w, or :rw: %s",
312 RSTRING_PTR(rb_inspect(oflags
)));
316 x
.oflags
= NUM2INT(oflags
);
319 rb_raise(rb_eArgError
, "flags must be an int, :r, :w, or :wr");
322 x
.name
= RSTRING_PTR(name
);
325 switch (TYPE(mode
)) {
328 x
.mode
= NUM2INT(mode
);
331 if (x
.oflags
& O_CREAT
) {
337 rb_raise(rb_eArgError
, "mode not an integer");
340 switch (TYPE(attr
)) {
343 attr_from_struct(&x
.attr
, attr
, 1);
345 /* principle of least surprise */
346 if (x
.attr
.mq_flags
& O_NONBLOCK
)
347 x
.oflags
|= O_NONBLOCK
;
352 rb_raise(rb_eArgError
, "attr must be a POSIX_MQ::Attr: %s",
353 RSTRING_PTR(rb_inspect(attr
)));
356 mq
->des
= (mqd_t
)rb_thread_blocking_region(xopen
, &x
, RUBY_UBF_IO
, 0);
357 if (mq
->des
== MQD_INVALID
)
358 rb_sys_fail("mq_open");
360 mq
->name
= rb_str_dup(name
);
367 * POSIX_MQ.unlink(name) => 1
369 * Unlinks the message queue given by +name+. The queue will be destroyed
370 * when the last process with the queue open closes its queue descriptors.
372 static VALUE
s_unlink(VALUE self
, VALUE name
)
375 void *ptr
= (void *)name
;
377 if (TYPE(name
) != T_STRING
)
378 rb_raise(rb_eArgError
, "argument must be a string");
380 rv
= (mqd_t
)rb_thread_blocking_region(xunlink
, ptr
, RUBY_UBF_IO
, 0);
381 if (rv
== MQD_INVALID
)
382 rb_sys_fail("mq_unlink");
391 * Unlinks the message queue to prevent other processes from accessing it.
392 * All existing queue descriptors to this queue including those opened by
393 * other processes are unaffected. The queue will only be destroyed
394 * when the last process with open descriptors to this queue closes
397 static VALUE
_unlink(VALUE self
)
399 struct posix_mq
*mq
= get(self
, 0);
401 void *ptr
= (void *)mq
->name
;
403 assert(TYPE(mq
->name
) == T_STRING
&& "mq->name is not a string");
405 rv
= (mqd_t
)rb_thread_blocking_region(xunlink
, ptr
, RUBY_UBF_IO
, 0);
406 if (rv
== MQD_INVALID
)
407 rb_sys_fail("mq_unlink");
412 static void setup_send_buffer(struct rw_args
*x
, VALUE buffer
)
414 buffer
= rb_obj_as_string(buffer
);
415 x
->msg_ptr
= RSTRING_PTR(buffer
);
416 x
->msg_len
= (size_t)RSTRING_LEN(buffer
);
421 * mq.send(string [,priority[, timeout]]) => nil
423 * Inserts the given +string+ into the message queue with an optional,
424 * unsigned integer +priority+. If the optional +timeout+ is specified,
425 * then Errno::ETIMEDOUT will be raised if the operation cannot complete
426 * before +timeout+ seconds has elapsed. Without +timeout+, this method
427 * may block until the queue is writable.
429 static VALUE
_send(int argc
, VALUE
*argv
, VALUE self
)
431 struct posix_mq
*mq
= get(self
, 1);
433 VALUE buffer
, prio
, timeout
;
435 struct timespec expire
;
437 rb_scan_args(argc
, argv
, "12", &buffer
, &prio
, &timeout
);
439 setup_send_buffer(&x
, buffer
);
441 x
.timeout
= convert_timeout(&expire
, timeout
);
442 x
.msg_prio
= NIL_P(prio
) ? 0 : NUM2UINT(prio
);
444 rv
= (mqd_t
)rb_thread_blocking_region(xsend
, &x
, RUBY_UBF_IO
, 0);
445 if (rv
== MQD_INVALID
)
446 rb_sys_fail("mq_send");
455 * Inserts the given +string+ into the message queue with a
456 * default priority of 0 and no timeout.
458 static VALUE
send0(VALUE self
, VALUE buffer
)
460 struct posix_mq
*mq
= get(self
, 1);
464 setup_send_buffer(&x
, buffer
);
469 rv
= (mqd_t
)rb_thread_blocking_region(xsend
, &x
, RUBY_UBF_IO
, 0);
470 if (rv
== MQD_INVALID
)
471 rb_sys_fail("mq_send");
481 * Returns an IO.select-able +IO+ object. This method is only available
482 * under Linux and is not intended to be portable.
484 static VALUE
to_io(VALUE self
)
486 struct posix_mq
*mq
= get(self
, 1);
487 int fd
= MQD_TO_FD(mq
->des
);
490 mq
->io
= rb_funcall(rb_cIO
, id_new
, 1, INT2NUM(fd
));
496 static void get_msgsize(struct posix_mq
*mq
)
500 if (mq_getattr(mq
->des
, &attr
) == MQD_INVALID
)
501 rb_sys_fail("mq_getattr");
503 mq
->msgsize
= attr
.mq_msgsize
;
508 * mq.receive([buffer, [timeout]]) => [ message, priority ]
510 * Takes the highest priority message off the queue and returns
511 * an array containing the message as a String and the Integer
512 * priority of the message.
514 * If the optional +buffer+ is present, then it must be a String
515 * which will receive the data.
517 * If the optional +timeout+ is present, then it may be a Float
518 * or Integer specifying the timeout in seconds. Errno::ETIMEDOUT
519 * will be raised if +timeout+ has elapsed and there are no messages
522 static VALUE
receive(int argc
, VALUE
*argv
, VALUE self
)
524 struct posix_mq
*mq
= get(self
, 1);
526 VALUE buffer
, timeout
;
528 struct timespec expire
;
533 rb_scan_args(argc
, argv
, "02", &buffer
, &timeout
);
534 x
.timeout
= convert_timeout(&expire
, timeout
);
537 buffer
= rb_str_new(0, mq
->msgsize
);
540 rb_str_modify(buffer
);
541 rb_str_resize(buffer
, mq
->msgsize
);
544 x
.msg_ptr
= RSTRING_PTR(buffer
);
545 x
.msg_len
= (size_t)mq
->msgsize
;
548 r
= (ssize_t
)rb_thread_blocking_region(xrecv
, &x
, RUBY_UBF_IO
, 0);
550 rb_sys_fail("mq_receive");
552 rb_str_set_len(buffer
, r
);
554 return rb_ary_new3(2, buffer
, UINT2NUM(x
.msg_prio
));
561 * Returns a POSIX_MQ::Attr struct containing the attributes
562 * of the message queue. See the mq_getattr(3) manpage for
565 static VALUE
getattr(VALUE self
)
567 struct posix_mq
*mq
= get(self
, 1);
572 if (mq_getattr(mq
->des
, &attr
) == MQD_INVALID
)
573 rb_sys_fail("mq_getattr");
575 astruct
= rb_struct_alloc_noinit(cAttr
);
576 ptr
= RSTRUCT_PTR(astruct
);
577 ptr
[0] = LONG2NUM(attr
.mq_flags
);
578 ptr
[1] = LONG2NUM(attr
.mq_maxmsg
);
579 ptr
[2] = LONG2NUM(attr
.mq_msgsize
);
580 ptr
[3] = LONG2NUM(attr
.mq_curmsgs
);
587 * mq.attr = POSIX_MQ::Attr(IO::NONBLOCK) => mq_attr
589 * Only the IO::NONBLOCK flag may be set or unset (zero) in this manner.
590 * See the mq_setattr(3) manpage for more details.
592 * Consider using the POSIX_MQ#nonblock= method as it is easier and
593 * more natural to use.
595 static VALUE
setattr(VALUE self
, VALUE astruct
)
597 struct posix_mq
*mq
= get(self
, 1);
598 struct mq_attr newattr
;
600 attr_from_struct(&newattr
, astruct
, 0);
602 if (mq_setattr(mq
->des
, &newattr
, NULL
) == MQD_INVALID
)
603 rb_sys_fail("mq_setattr");
612 * Closes the underlying message queue descriptor.
613 * If this descriptor had a registered notification request, the request
614 * will be removed so another descriptor or process may register a
615 * notification request. Message queue descriptors are automatically
616 * closed by garbage collection.
618 static VALUE
_close(VALUE self
)
620 struct posix_mq
*mq
= get(self
, 1);
622 if (mq_close(mq
->des
) == MQD_INVALID
)
623 rb_sys_fail("mq_close");
625 mq
->des
= MQD_INVALID
;
633 * mq.closed? => true or false
635 * Returns +true+ if the message queue descriptor is closed and therefore
636 * unusable, otherwise +false+
638 static VALUE
closed(VALUE self
)
640 struct posix_mq
*mq
= get(self
, 0);
642 return mq
->des
== MQD_INVALID
? Qtrue
: Qfalse
;
649 * Returns the string name of message queue associated with +mq+
651 static VALUE
name(VALUE self
)
653 struct posix_mq
*mq
= get(self
, 0);
658 static int lookup_sig(VALUE sig
)
664 sig
= rb_obj_as_string(sig
);
665 len
= RSTRING_LEN(sig
);
666 ptr
= RSTRING_PTR(sig
);
668 if (len
> 3 && !memcmp("SIG", ptr
, 3))
669 sig
= rb_str_new(ptr
+ 3, len
- 3);
672 VALUE mSignal
= rb_define_module("Signal"""); /* avoid RDoc */
674 list
= rb_funcall(mSignal
, rb_intern("list"), 0, 0);
675 rb_global_variable(&list
);
678 sig
= rb_hash_aref(list
, sig
);
680 rb_raise(rb_eArgError
, "invalid signal: %s\n",
681 RSTRING_PTR(rb_inspect(sig
)));
688 * mq.notify = signal => signal
690 * Registers the notification request to deliver a given +signal+
691 * to the current process when message is received.
692 * If +signal+ is +nil+, it will unregister and disable the notification
693 * request to allow other processes to register a request.
694 * If +signal+ is +false+, it will register a no-op notification request
695 * which will prevent other processes from registering a notification.
696 * Only one process may have a notification request for a queue
697 * at a time, Errno::EBUSY will be raised if there is already
698 * a notification request registration for the queue.
700 * For readers of the mq_notify(3) manpage, passing +false+
701 * is equivalent to SIGEV_NONE, and passing +nil+ is equivalent
702 * of passing a NULL notification pointer to mq_notify(3).
704 static VALUE
setnotify(VALUE self
, VALUE arg
)
706 struct posix_mq
*mq
= get(self
, 1);
708 struct sigevent
* notification
= ¬
711 not.sigev_notify
= SIGEV_SIGNAL
;
715 not.sigev_notify
= SIGEV_NONE
;
721 not.sigev_signo
= NUM2INT(arg
);
725 not.sigev_signo
= lookup_sig(arg
);
726 rv
= INT2NUM(not.sigev_signo
);
729 /* maybe support Proc+thread via sigev_notify_function.. */
730 rb_raise(rb_eArgError
, "must be a signal or nil");
733 if (mq_notify(mq
->des
, notification
) == MQD_INVALID
)
734 rb_sys_fail("mq_notify");
741 * mq.nonblock? => true or false
743 * Returns the current non-blocking state of the message queue descriptor.
745 static VALUE
getnonblock(VALUE self
)
748 struct posix_mq
*mq
= get(self
, 1);
750 if (mq_getattr(mq
->des
, &attr
) == MQD_INVALID
)
751 rb_sys_fail("mq_getattr");
753 mq
->msgsize
= attr
.mq_msgsize
; /* optimization */
755 return attr
.mq_flags
& O_NONBLOCK
? Qtrue
: Qfalse
;
760 * mq.nonblock = boolean => boolean
762 * Enables or disables non-blocking operation for the message queue
763 * descriptor. Errno::EAGAIN will be raised in situations where
764 * the queue would block. This is not compatible with +timeout+
765 * arguments to POSIX_MQ#send and POSIX_MQ#receive.
767 static VALUE
setnonblock(VALUE self
, VALUE nb
)
769 struct mq_attr newattr
, oldattr
;
770 struct posix_mq
*mq
= get(self
, 1);
773 newattr
.mq_flags
= O_NONBLOCK
;
774 else if (nb
== Qfalse
)
775 newattr
.mq_flags
= 0;
777 rb_raise(rb_eArgError
, "must be true or false");
779 if (mq_setattr(mq
->des
, &newattr
, &oldattr
) == MQD_INVALID
)
780 rb_sys_fail("mq_setattr");
782 mq
->msgsize
= oldattr
.mq_msgsize
; /* optimization */
787 void Init_posix_mq_ext(void)
789 cPOSIX_MQ
= rb_define_class("POSIX_MQ", rb_cObject
);
790 rb_define_alloc_func(cPOSIX_MQ
, alloc
);
791 cAttr
= rb_const_get(cPOSIX_MQ
, rb_intern("Attr"));
794 * The maximum number of open message descriptors supported
795 * by the system. This may be -1, in which case it is dynamically
796 * set at runtime. Consult your operating system documentation
797 * for system-specific information about this.
799 rb_define_const(cPOSIX_MQ
, "OPEN_MAX",
800 LONG2NUM(sysconf(_SC_MQ_OPEN_MAX
)));
803 * The maximum priority that may be specified for POSIX_MQ#send
804 * On POSIX-compliant systems, this is at least 31, but some
805 * systems allow higher limits.
806 * The minimum priority is always zero.
808 rb_define_const(cPOSIX_MQ
, "PRIO_MAX",
809 LONG2NUM(sysconf(_SC_MQ_PRIO_MAX
)));
811 rb_define_singleton_method(cPOSIX_MQ
, "unlink", s_unlink
, 1);
813 rb_define_method(cPOSIX_MQ
, "initialize", init
, -1);
814 rb_define_method(cPOSIX_MQ
, "send", _send
, -1);
815 rb_define_method(cPOSIX_MQ
, "<<", send0
, 1);
816 rb_define_method(cPOSIX_MQ
, "receive", receive
, -1);
817 rb_define_method(cPOSIX_MQ
, "attr", getattr
, 0);
818 rb_define_method(cPOSIX_MQ
, "attr=", setattr
, 1);
819 rb_define_method(cPOSIX_MQ
, "close", _close
, 0);
820 rb_define_method(cPOSIX_MQ
, "closed?", closed
, 0);
821 rb_define_method(cPOSIX_MQ
, "unlink", _unlink
, 0);
822 rb_define_method(cPOSIX_MQ
, "name", name
, 0);
823 rb_define_method(cPOSIX_MQ
, "notify=", setnotify
, 1);
824 rb_define_method(cPOSIX_MQ
, "nonblock=", setnonblock
, 1);
825 rb_define_method(cPOSIX_MQ
, "nonblock?", getnonblock
, 0);
827 rb_define_method(cPOSIX_MQ
, "to_io", to_io
, 0);
830 id_new
= rb_intern("new");
831 sym_r
= ID2SYM(rb_intern("r"));
832 sym_w
= ID2SYM(rb_intern("w"));
833 sym_rw
= ID2SYM(rb_intern("rw"));