posix_mq 0.1.0 → 0.2.0

data/ChangeLog

@@ -1,5 +1,59 @@
 ChangeLog from git://git.bogomips.org/ruby_posix_mq.git ()
 
+    commit fd2fcdeee6b44f7854255cb7e01c81db3cd2d99c
+    Author: Eric Wong <normalperson@yhbt.net>
+    Date:   Sun Jan 3 05:46:45 2010 +0000
+    
+        posix_mq 0.2.0
+        
+        This release fixes notification (un)registration and should be
+        fully-supported on modern FreeBSD (7.2+) releases.
+        
+        POSIX_MQ#notify=nil correctly unregister notification requests.
+        POSIX_MQ#notify=false now provids the no-op SIGEV_NONE
+        functionality.  Under FreeBSD, using IO.select on POSIX_MQ
+        objects is now possible as it has always been under Linux.
+    
+    commit 350bfc831938d84cc2d478f2cf88583863cb64fb
+    Author: Eric Wong <normalperson@yhbt.net>
+    Date:   Sun Jan 3 05:35:50 2010 +0000
+    
+        support POSIX_MQ#to_io under FreeBSD
+        
+        FreeBSD implements an __mq_oshandle(mqd_t mqd) function
+        to convert mqd_t to integer file descriptors.
+    
+    commit 26015d39e9c848a536b4ea44802f858a4e6e74f7
+    Author: Eric Wong <normalperson@yhbt.net>
+    Date:   Sun Jan 3 04:17:56 2010 +0000
+    
+        fix build under FreeBSD 7.2
+        
+        FreeBSD seems to need some files explicitly included.
+    
+    commit e7ac70686b3c09953f6c41966dbd77f77368a9ec
+    Author: Eric Wong <normalperson@yhbt.net>
+    Date:   Sat Jan 2 21:19:58 2010 -0800
+    
+        doc: FreeBSD-specific notes + example code
+    
+    commit 6f24b5626f89fbb6445c0943ba71f56c8945e18f
+    Author: Eric Wong <normalperson@yhbt.net>
+    Date:   Sat Jan 2 20:41:39 2010 -0800
+    
+        Fix mq.notify = nil to unregister notifications
+        
+        "mq.notify = false" also works now, doing what
+        "mq.notify = nil" used to do (using SIGEV_NONE).
+        
+        I was confused by SIGEV_NONE usage vs using a NULL pointer for
+        the notification passed mq_notify(3).  SIGEV_NONE does not
+        actually unregister, it registers a no-op notification which
+        prevents other processes from taking us.
+        
+        This also fixes the test case to pass under both Linux and
+        FreeBSD.
+    
     commit 522d4d1472c216bd95a16ca5b118bc14693aad64
     Author: Eric Wong <normalperson@yhbt.net>
     Date:   Sat Jan 2 02:33:23 2010 -0800

data/Documentation/posix-mq.rb.1.txt

@@ -146,8 +146,15 @@ portability.
 Exit status is normally 0.  Exit status is 2 if a timeout occurs, 1 for
 all other errors.
 
+Under FreeBSD, the mq_* system calls are not available unless you load
+the mqueuefs(5) kernel module:
+
+        kldload mqueuefs
+
 # SEE ALSO
 
 * [mq_overview(7)][1]
+* [mqueuefs(5)][2]
 
 [1]: http://kernel.org/doc/man-pages/online/pages/man7/mq_overview.7.html
+[2]: http://freebsd.org/cgi/man.cgi?query=mqueuefs

data/GIT-VERSION-FILE

@@ -1 +1 @@
-GIT_VERSION = 0.1.0
+GIT_VERSION = 0.2.0

data/NEWS

@@ -1,3 +1,13 @@
+=== 0.2.0 / 2010-01-03 05:52 UTC
+
+  This release fixes notification (un)registration and should be
+  fully-supported on modern FreeBSD (7.2+) releases.
+
+  POSIX_MQ#notify=nil correctly unregister notification requests.
+  POSIX_MQ#notify=false now provids the no-op SIGEV_NONE
+  functionality.  Under FreeBSD, using IO.select on POSIX_MQ
+  objects is now possible as it has always been under Linux.
+
 === 0.1.0 / 2010-01-02 11:01 UTC
 
   initial

data/README

@@ -13,9 +13,9 @@ network-aware message queue implementations.
 
 * Supports message notifications via signals.
 
-* Supports portable non-blocking operation.  Under Linux 2.6.6+ only,
-  POSIX_MQ objects may even be used with event notification mechanisms
-  such as IO.select.
+* Supports portable non-blocking operation.  Under Linux 2.6.6+ and
+  FreeBSD 7.2+, POSIX_MQ objects may even be used with event
+  notification mechanisms such as IO.select.
 
 * Optional timeouts may be applied to send and receive operations.
 
@@ -42,6 +42,42 @@ Unpack it, and run "ruby setup.rb"
 
 Otherwise, via RubyGems: gem install posix_mq
 
+== Usage
+
+The Linux mq_overview(7)
+{manpage}[http://kernel.org/doc/man-pages/online/pages/man7/mq_overview.7.html]
+provides a good overview of programming with POSIX message queues.
+
+Under FreeBSD, you must load the
+{mqueuefs(5)}[http://freebsd.org/cgi/man.cgi?query=mqueuefs]
+kernel module before attempting to use POSIX message queues:
+
+    kldload mqueuefs
+
+Our API matches the C api closely, see the RDoc for full API
+documentation.  Here is an example of a process communicating
+with itself.  In practice, processes that send will be different
+from processes that receive.
+
+    require 'posix_mq'
+    mq = POSIX_MQ.new("/foo", :rw)
+
+    # hello world
+    mq << "hello world"
+    puts mq.receive.first # => should print "hello world"
+
+    # non-blocking operation
+    mq.nonblock = true
+    begin
+      mq.receive
+    rescue Errno::EAGAIN
+    end
+
+    trap(:USR1) { puts mq.receive.first }
+    mq.notify = :USR1
+    mq.send "fire USR1 handler"
+    # "fire USR1 handler" should be printed now
+
 == Development
 
 You can get the latest source via git from the following locations:

data/ext/posix_mq/extconf.rb

@@ -1,6 +1,9 @@
 require "mkmf"
 
+have_header("sys/select.h")
+have_header("signal.h")
 have_header("mqueue.h") or abort "mqueue.h header missing"
+have_func("__mq_oshandle")
 have_func("rb_str_set_len")
 have_func("rb_struct_alloc_noinit")
 have_func('rb_thread_blocking_region')

data/ext/posix_mq/posix_mq.c

@@ -1,4 +1,10 @@
 #define _XOPEN_SOURCE 600
+#ifdef HAVE_SYS_SELECT_H
+#  include <sys/select.h>
+#endif
+#ifdef HAVE_SIGNAL_H
+#  include <signal.h>
+#endif
 #include <ruby.h>
 
 #include <time.h>
@@ -10,21 +16,25 @@
 #include <unistd.h>
 
 #if defined(__linux__)
-#  define MQD_IS_FD 1
-#  define MQ_IO_MARK(mq) rb_gc_mark((mq)->io)
-#  define MQ_IO_SET(mq,val) do { (mq)->io = (val); } while (0)
+#  define MQD_TO_FD(mqd) (int)(mqd)
+#elif defined(HAVE___MQ_OSHANDLE) /* FreeBSD */
+#  define MQD_TO_FD(mqd) __mq_oshandle(mqd)
 #else
 #  warning mqd_t is not select()-able on your OS
-#  define MQD_IS_FD 0
 #  define MQ_IO_MARK(mq) ((void)(0))
 #  define MQ_IO_SET(mq,val) ((void)(0))
-#endif /* non-Linux */
+#endif
+
+#ifdef MQD_TO_FD
+#  define MQ_IO_MARK(mq) rb_gc_mark((mq)->io)
+#  define MQ_IO_SET(mq,val) do { (mq)->io = (val); } while (0)
+#endif
 
 struct posix_mq {
 	mqd_t des;
 	long msgsize;
 	VALUE name;
-#if MQD_IS_FD
+#ifdef MQD_TO_FD
 	VALUE io;
 #endif
 };
@@ -463,7 +473,7 @@ static VALUE send0(VALUE self, VALUE buffer)
 	return self;
 }
 
-#if MQD_IS_FD
+#ifdef MQD_TO_FD
 /*
  * call-seq:
  *	mq.to_io	=> IO
@@ -474,9 +484,10 @@ static VALUE send0(VALUE self, VALUE buffer)
 static VALUE to_io(VALUE self)
 {
 	struct posix_mq *mq = get(self, 1);
+	int fd = MQD_TO_FD(mq->des);
 
 	if (NIL_P(mq->io))
-		mq->io = rb_funcall(rb_cIO, id_new, 1, INT2NUM(mq->des));
+		mq->io = rb_funcall(rb_cIO, id_new, 1, INT2NUM(fd));
 
 	return mq->io;
 }
@@ -680,19 +691,32 @@ static int lookup_sig(VALUE sig)
  * to the current process when message is received.
  * If +signal+ is +nil+, it will unregister and disable the notification
  * request to allow other processes to register a request.
+ * If +signal+ is +false+, it will register a no-op notification request
+ * which will prevent other processes from registering a notification.
  * Only one process may have a notification request for a queue
  * at a time, Errno::EBUSY will be raised if there is already
  * a notification request registration for the queue.
+ *
+ * For readers of the mq_notify(3) manpage, passing +false+
+ * is equivalent to SIGEV_NONE, and passing +nil+ is equivalent
+ * of passing a NULL notification pointer to mq_notify(3).
  */
 static VALUE setnotify(VALUE self, VALUE arg)
 {
 	struct posix_mq *mq = get(self, 1);
 	struct sigevent not;
+	struct sigevent * notification = &not;
 	VALUE rv = arg;
 
 	not.sigev_notify = SIGEV_SIGNAL;
 
 	switch (TYPE(arg)) {
+	case T_FALSE:
+		not.sigev_notify = SIGEV_NONE;
+		break;
+	case T_NIL:
+		notification = NULL;
+		break;
 	case T_FIXNUM:
 		not.sigev_signo = NUM2INT(arg);
 		break;
@@ -701,15 +725,12 @@ static VALUE setnotify(VALUE self, VALUE arg)
 		not.sigev_signo = lookup_sig(arg);
 		rv = INT2NUM(not.sigev_signo);
 		break;
-	case T_NIL:
-		not.sigev_notify = SIGEV_NONE;
-		break;
 	default:
 		/* maybe support Proc+thread via sigev_notify_function.. */
 		rb_raise(rb_eArgError, "must be a signal or nil");
 	}
 
-	if (mq_notify(mq->des, &not) == MQD_INVALID)
+	if (mq_notify(mq->des, notification) == MQD_INVALID)
 		rb_sys_fail("mq_notify");
 
 	return rv;
@@ -802,7 +823,7 @@ void Init_posix_mq_ext(void)
 	rb_define_method(cPOSIX_MQ, "notify=", setnotify, 1);
 	rb_define_method(cPOSIX_MQ, "nonblock=", setnonblock, 1);
 	rb_define_method(cPOSIX_MQ, "nonblock?", getnonblock, 0);
-#if MQD_IS_FD
+#ifdef MQD_TO_FD
 	rb_define_method(cPOSIX_MQ, "to_io", to_io, 0);
 #endif
 

data/lib/posix_mq.rb

@@ -2,7 +2,7 @@
 class POSIX_MQ
 
   # version of POSIX_MQ, currently 0.1.0
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 
   # An analogous Struct to "struct mq_attr" in C.
   # This may be used in arguments for POSIX_MQ.new and

data/man/man1/posix-mq.rb.1

@@ -180,8 +180,17 @@ The value of MQUEUE should always be prefixed with a slash
 .PP
 Exit status is normally 0.
 Exit status is 2 if a timeout occurs, 1 for all other errors.
+.PP
+Under FreeBSD, the mq_* system calls are not available unless you
+load the mqueuefs(5) kernel module:
+.PP
+\f[CR]
+      \ \ \ \ kldload\ mqueuefs
+\f[]
 .SH SEE ALSO
 .IP \[bu] 2
 mq_overview(7) (http://kernel.org/doc/man-pages/online/pages/man7/mq_overview.7.html)
+.IP \[bu] 2
+mqueuefs(5) (http://freebsd.org/cgi/man.cgi?query=mqueuefs)
 .SH AUTHOR
 Ruby POSIX MQ hackers <ruby.posix.mq@librelist.com>

data/test/test_posix_mq.rb

@@ -136,11 +136,27 @@ class Test_POSIX_MQ < Test::Unit::TestCase
     assert_nil(@mq.notify = nil)
     assert_nothing_raised { @mq.send("hello", 0) }
     assert_nil IO.select([rd], nil, nil, 0.1)
-    assert_raises(Errno::EBUSY) { @mq.notify = :USR1 }
     ensure
       trap(:USR1, orig)
   end
 
+  def test_notify_none
+    @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
+    assert_nothing_raised { @mq.notify = false }
+    pid = fork do
+      begin
+        @mq.notify = :USR1
+      rescue Errno::EBUSY
+        exit 0
+      rescue => e
+        p e
+      end
+      exit! 1
+    end
+    _, status = Process.waitpid2(pid)
+    assert status.success?, status.inspect
+  end
+
   def test_setattr
     @mq = POSIX_MQ.new @path, IO::CREAT|IO::WRONLY, 0666
     mq_attr = POSIX_MQ::Attr.new(IO::NONBLOCK)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: posix_mq
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ruby POSIX MQ hackers
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-02 00:00:00 -08:00
+date: 2010-01-03 00:00:00 +00:00
 default_executable: 
 dependencies: []