Ruby posix_mq 2.4.1

This release fixes a problem affecting users of newer clang (5.x+)
and Ruby 2.5.0:  https://bugs.ruby-lang.org/issues/14425
There is no need to upgrade if using gcc or Ruby <= 2.4.

* drop extra args to rb_funcall

drop extra args to rb_funcall

Having extra args was harmless in Ruby 2.4, but Ruby 2.5 with
newer versions of clang are not happy about it.  Eventually this
may be fixed in Ruby 2.5.1: https://bugs.ruby-lang.org/issues/14425

Ruby posix_mq 2.4.0

Most notably there are some FreeBSD fixes.  There are also
some minor internal cleanups and doc updates.

7 changes since 2.3.0 (2016-02-02):

      doc: remove private email address
      doc: update bogomips.org URLs to HTTPS
      set correct condition for setting id_autoclose
      test_posix_mq: get tests passing under FreeBSD 10.3
      TypedData C-API conversion
      freeze internal objects
      build: remove build-time olddoc dependency

build: remove build-time olddoc dependency

This should make it easier for distros to pick this
up without picking up olddoc, too.

We will still use olddoc for generating the website since it
reduces bandwidth costs, and for generating NEWS for our own
builds.

freeze internal objects

We do not want ObjectSpace walkers to be able to mess with
our internals.

TypedData C-API conversion

This provides some extra type safety if combined with other
C extensions, as well as allowing us to account for memory usage of
the HTTP parser in ObjectSpace.

This requires Ruby 1.9.3+ and has remained a stable API since
then.  This will become officially supported when Ruby 2.3.0 is
released later this month.

This API has only been documented in doc/extension.rdoc (formerly
README.EXT) in the Ruby source tree since April 2015, r50318

test_posix_mq: get tests passing under FreeBSD 10.3

Apparently POSIX message queues adopted close-on-fork behavior
in FreeBSD at some point.  Oh well, somebody else who is more
interested in FreeBSD than can look into fixing it on their end.

Improve exception reporting a bit while we're at it.

set correct condition for setting id_autoclose

This bug was noticed under FreeBSD :x

doc: update bogomips.org URLs to HTTPS

It looks like HTTPS support provided by the Let's Encrypt
project is still going strong, and maybe we can rely on it.

doc: remove private email address

Email is not private, and we won't be able to protect your
privacy.  Anonymity (when desired) should be the sender's
responsibility, not the recipients'.

Ruby posix_mq 2.3.0 - updates for Ruby 2.3+

This release updates our POSIX_MQ#close to match the idempotent
IO#close behavior under Ruby 2.3 and later.  Previous Ruby versions
continue to be supported, but POSIX_MQ#close remains non-idempotent
when built against old Ruby versions.

4 changes since v2.2.0:

      enable frozen_string_literal for Ruby 2.3+
      support idempotent POSIX_MQ#close
      README: remove cgit and ssoma references
      build: use '--local' domain for dev gem install

build: use '--local' domain for dev gem install

This avoids unnecessary network requests for disconnected
systems.

README: remove cgit and ssoma references

We may not always be cgit, and encouraging tarball snapshot
downloads is a waste of resources

Release tarballs are not, as users aren't expected to know to
do "git clone"; but developers are.

This is also not an appropriate place for advertising ssoma.

support idempotent POSIX_MQ#close

IO#close under Ruby 2.3 is idempotent, we shall follow suit
with POSIX_MQ#close

enable frozen_string_literal for Ruby 2.3+

No changes for older Rubies, but this reduces garbage under 2.3

Ruby posix_mq 2.2.0 - support FD adoption

The major feature of this release is the POSIX_MQ.for_fd class
method thanks to Christopher Lord.  The addition of the
POSIX_MQ#autoclose? and POSIX_MQ#autoclose= round out the new
feature set.  All of the new methods are analogous to their
counterparts in the core IO class.

The mailing list is also moved to ruby-posix-mq@bogomips.org
and no longer requires subscription.  Existing librelist
subscribers will need to resubscribe manually (as I have no
way of doing so automatically):

ruby-posix-mq+subscribe@bogomips.org

HTTP archives and instructions for extracting the mail archives
via git are available at:

http://bogomips.org/ruby-posix-mq/

Christopher Lord (1):
      Ability to adopt file descriptors

Eric Wong (16):
      for_fd: delay assigning to mq->des until after mq_getattr
      test_posix_mq: rewrite test to not depend on DL or alarm
      support autoclose= and autoclose?
      pack rw_args struct
      change mailing list to ruby-posix-mq@bogomips.org
      doc: remove --sanitize-html option for pandoc
      switch documentation to olddoc
      LICENSE: allow all future versions of LGPLv3+
      favor comparisons against zero instead of -1
      pkg.mk: misc tweaks and updates
      gemspec: remove rdoc_options setting
      .gitignore: add placeholder
      gemspec: use SPDX license abbreviation
      misc doc updates
      POSIX_MQ#autoclose= propagates to IO
      GNUmakefile: ordering fix for building gem

GNUmakefile: ordering fix for building gem

POSIX_MQ#autoclose= propagates to IO

If a corresponding IO object exists or is created later, propagate
autoclose to the corresponding IO object to avoid simplify autoclose
handling for the user.  This hopefully avoids nasty surprises in case
users disable autoclose but want to keep the IO object around.

misc doc updates

* Include the email addresses for olddoc
* README: update support status of Rubies
* label link to mailing list archives

gemspec: use SPDX license abbreviation

.gitignore: add placeholder

gemspec: remove rdoc_options setting

We no longer need it for olddoc

pkg.mk: misc tweaks and updates

* We're not using isolate anymore
* support EXTCONF_ARGS env for building
* add "make check" as an alias for "make test"
  (muscle memory for GNU-autotools projects)

favor comparisons against zero instead of -1

This should allow faster instructions to be used in some cases.
Technically this may be less pedantically correct, but there is
enough existing code out there which does the same thing to
discourage kernel/libc developers from overloading negative
return values.

...And glibc even favors comparison against zero, too.

LICENSE: allow all future versions of LGPLv3+

In case I'm hit by a bus and FSF comes out with an LGPLv4,
the project will still be able to move forward.

While we're at it, update the gemspec, too.

switch documentation to olddoc

wrongdoc was difficult to maintain because of the tidy-ffi
dependency and the HTML5 changes in Darkfish could not be
handled well by Tidy.

olddoc is superior as it generates leaner HTML which loads faster,
requires less scrolling and less processing power to render.
Aesthetic comparisons are subjective of course but completely
unimportant compared to speed and accessibility.

doc: remove --sanitize-html option for pandoc

Newer versions of pandoc removed this option

change mailing list to ruby-posix-mq@bogomips.org

The public-inbox + mlmmj setup on bogomips.org allows posting
without subscription and offers downloadable archives via git.
The lack of rsyncable archives on librelist nowadays and
subscription-required nature of librelist are points against it.

Repliers are now encouraged to Cc: all recipients (using the
reply-all function of their mail client) since many readers are
not subscribed.

This project has never accepted or encouraged HTML email, but
librelist accepted it.  The bogomips.org mail server is
configured to treat HTML mail as spam, so do not send HTML mail
if you expect a response.

Users who wish to subscribe may send a message to:

ruby-posix-mq+subscribe@bogomips.org

Similarly, they may unsubscribe via:

ruby-posix-mq+unsubscribe@bogomips.org

HTTP archives are available via:

http://bogomips.org/ruby-posix-mq/

ssoma users may also use: git://bogomips.org/ruby-posix-mq
(see README change)

Old messages to the librelist addresses will continue to
get routed to the new mailing list.

ref: http://public-inbox.org/

pack rw_args struct

This saves one word of stack space, potentially improving
performance a miniscule amount.

support autoclose= and autoclose?

These are analogous to the identically-named IO methods and useful
when we're inheriting descriptors (or writing tests for inheriting
descriptors).

test_posix_mq: rewrite test to not depend on DL or alarm

DL is removed and deprecated, and we don't actually need
it or alarm to test for EINTR-safety.

for_fd: delay assigning to mq->des until after mq_getattr

We do not want to assign to mq->des before verifying we
have a valid message queue, otherwise the GC may misclose
an invalid MQ descriptor (which may be a valid FD).

Ability to adopt file descriptors

This patch adds support for adopting an existing file descriptor, together
with testcases. The need for this comes up when we use systemd with the
ListenMessageQueue directive. For socket activation, systemd opens the POSIX
message queue and expects user code to begin using the file descriptor
without opening it in-process.

To support the systemd model in the `posix_mq` gem, this patch suggests
imitating the behavior on the Socket class, which uses `#for_fd` to create a
socket class from a descriptor.

One confounding factor exists. POSIX queues have a name but it is difficult
to get access to this name in a safe manner from the file descriptor. One
option would be to `readlink(2)` on `/proc/self/fd/N` to get the name[1], but
note that if the descriptor is unlinked we wouldn't get anything usable.
Rather than risk incorrect behavior and extra complexity, I've decided to
just raise an `ArgumentError` if `#name` is called on adopted descriptors.
Typically one wouldn't need the actual name in a systemd socket-activated
situation, anyway.

[1]: http://stackoverflow.com/questions/1188757/getting-filename-from-file-descriptor-in-c

[ew: simplified type checks to be consistent with IO.for_fd,
 fixed test case]

Signed-off-by: Eric Wong <normalperson@yhbt.net>

posix_mq 2.1.0 - ensure compatibility with future Rubies

* avoid deprecated rb_thread_blocking_region in Ruby 2.0/2.1
* prepare for rb_thread_blocking_region removal

avoid deprecated rb_thread_blocking_region in Ruby 2.0/2.1

This will be removed in Ruby 2.2, so avoid the deprecation warning.

prepare for rb_thread_blocking_region removal

It'll be OK to use rb_thread_call_without_gvl when
rb_thread_blocking_region is not detectable at all.
We still use rb_thread_blocking_region for Ruby 2.0-2.1 because
rb_thread_call_without_gvl was detectable in 1.9.3, but not
usable as an internal symbol.

ref: https://bugs.ruby-lang.org/issues/9502

Rakefile: kill raa_update task

RAA is dead.

pkg.mk: update

posix_mq 2.0.0 - a minor API change + FreeBSD fixes

Blocking methods no longer raise Errno::EINTR (to match
Ruby IO semantics, making code easier to work with).

There are also many FreeBSD-related fixes thanks to
Hleb Valoshka <375gnu@gmail.com> and small code cleanups.

test: relax test timings for timed* tests

On my i386-freebsd9 VM, this takes just longer than the
maximum allowable time.

extconf: fix __mq_oshandle() detection on FreeBSD

We need to have -lrt in LDFLAGS before we can detect it.

test: disable IO.select test if #to_io is missing

ext: fix type inconsistencies for int vs mqd_t retvals

Somehow I mixed up return values for mq_* functions that
return "int".  This was noticed on FreeBSD where mqd_t
is NOT an integer.

notify: set lower bound for notify stack size

Some OSes have ridiculously low boundaries and we don't
want mysterious failures on them

blocking functions do not raise Errno::EINTR

Blocking functions should not raise Errno::EINTR to match
existing semantics of Ruby IO methods (e.g. IO.select, IO#read,
IO#write).  This makes user code easier to read/write.

Like th Ruby methods we emulate, we only reacquire the GVL on
EINTR to fire signal handlers, but otherwise emulate SA_RESTART
semantics.

This is a backwards-incompatible API change (but unlikely
to break existing code).

Add libc names for Debian GNU/kFreeBSD and FreeBSD in tests.

Signed-off-by: Eric Wong <normalperson@yhbt.net>

Fix call to DL::Function.new in tests

The 3rd argument of DL::Function.new is ABI type, not a return type.

Signed-off-by: Eric Wong <normalperson@yhbt.net>

fix compiler warnings, oops

CFLAGS=-Wall somehow got disabled in my Ruby installation...

num2timespec: remove needless double-assignment

Oops

no need to rb_intern("*")

'*' works just the same

posix_mq 1.0.0 - kinder, gentler message queues

There is one backwards-incompatible API change:

  POSIX_MQ#send returns +true+ on success instead of +nil+
  for consistency with POSIX_MQ#trysend.

This release adds the POSIX_MQ#trysend, POSIX_MQ#tryreceive and
POSIX_MQ#tryshift interfaces to avoid exceptions on common
EAGAIN errors for users of non-blocking queues.

Bugfixes: non-blocking behavior changes to a shared descriptor
in a different process are reflected immediately in the child
(this won't fix race conditions in your code, however).
Minor bugfixes for posix-mq-rb(1) and quieted warnings for
1.9.3dev.

make methods that should be private, private

So private we won't mention them in the commit message!

remove unused tryinit function

Something I considered but decided wasn't worth doing.

POSIX_MQ#send returns +true+ on success

This is to be consistent with POSIX_MQ#trysend

finalize try* interfaces

Consider them good enough for a 1.0.0 release

posix-mq-rb: always prefer write-in-full behavior

In case somebody made the receiving pipe non-blocking,
we want the command-line tool to succeed.

fix warnings and enable them for tests

Cleaner code anyways.

posix-mq-rb: use IO#binmode to get binary IOs

Avoids warnings this way

doc: note that the try* interfaces are not final

But they'll be pushed to the site for greater
visibility.

bump version to 0.8.0pre

Remove the VERSION constant, it's cruft.

doc: fix doc generation for manpage

Oops

add trysend, tryreceive, and tryshift interfaces

These are kinder and less exceptional than their
non-trying counterparts as generating exceptions
is expensive for common EAGAIN errors.

eliminate needless global (cPOSIX_MQ)

It can be local variable

run GC on ENOSPC when calling mq_open()

It could work...

Symbols are VALUEs, not IDs

Oops :x

tests: do not require Fiddle for Ruby 1.9

It's only available when compiled with libffi.

Do not trust locally cached mq_flags

These flags can be changed in the parent or child
process, so we will always have to run mq_getattr()
to check it.  This removes the GVL-keeping non-blocking
optimizations but we'll gain some soon.

cleanup DL usage for alarm() test

fix test alarm() case for Ruby 1.9

DL in Ruby 1.9 isn't the same

posix_mq 0.7.0 - cleanups + portability fixes

This release now works for systems other than Linux and FreeBSD
that support POSIX message queues.  This is usable for systems
without mq_timedsend() or mq_timedreceive() but with the
non-timed variants (timeouts wont work).

Thanks to Tadeusz Bochan for testing.

Ruby posix_mq is now dual-licensed under the GPLv2 (as well as the
preferred LGPLv3) for compatibility with existing GPLv2-only code.

doc: full rdoc coverage!

doc: add copy of GPLv2

For completeness, the LGPLv3 remains the preferred license.

doc: note that timeout is not always supported

Maybe people will just upgrade to newer systems eventually.

README: update mailing list notes

If it's not clear, we hate HTML.

added a note about em-posixmq for EventMachine users

ref: http://mid.gmane.org/AANLkTimNcWKqNSbD5GL76Z9rS3Gfi3uGusPksD2Eo+=P@mail.gmail.com

doc: discourage the use of notify

POSIX_MQ#notify(&block) mostly sucks.

unindent class methods

No need to waste indentation and make eyes wander.

test for alarm() working properly to interrupt

Some systems without mq_timedsend/mq_timedreceive need to
use alarm() or similar (setitimer()) to interrupt timed-out
mq_send/mq_receive calls, so we need to handle EINTR properly.

update URLs for git and cgit

While the old URLs still work, bogomips.org went on a URL diet

fix MQ_IO_NIL_P and MQ_IO_CLOSE macros

These cannot be cast to void since its value is
meaningful.

test: fix GC test for systems without POSIX_MQ#to_io

Not all systems can convert POSIX_MQ to IO objects.

LICENSE: dual license, adding GPLv2

This makes us explicitly compatible with GPLv2-only programs.

attempt to support systems w/o mq_timedsend/mq_timedreceive

Some ancient systems don't support mq_timedsend and
mq_timedreceive but somehow manage to support other POSIX
mq_* functions.

extconf: remove unnecessary dir_config statement

It's all standard C library stuff.

use StringValueCStr for paths

RSTRING_PTR may contain '\0' bytes which makes it unsuitable
for mq_unlink() and mq_open()

fix broken rb_str_set_len() #define for Ruby 1.8.6

This was too aggressively deleted during cleanups for Rubinius
support in commit 5339d9d693c794c0f20270d5726cb360e31dff30

Noticed-by: Tadeusz Bochan <tad.bochan@bnpparibas.com>
ref: 2a92695fc1958e0370782284c6196625@ruby-forum.com

fix for systems that can't convert mqd_t to FD

Apparently there are OSes that don't have methods to convert
mqd_t to FD.

Noticed-by: Tadeusz Bochan <tad.bochan@bnpparibas.com>
ref: <2a92695fc1958e0370782284c6196625@ruby-forum.com>

switch to pkg.mk for packaging needs

I can't stand Rake :x

publish_news target is less braindead

Run it by default on releases.

posix_mq 0.6.0 - Rubinius support

Rubinius 1.2 as well as Ruby 1.9.  Ruby 1.8 works except it will
block the entire interpreter for blocking operations.  Spurious
errors during GC for POSIX_MQ#to_io users are now avoided.

switch to wrongdoc for documentation

No more JavaScript on our site!

add Rubinius support

Cleaner code, too, no more direct RSTRUCT usage.

refactor type checks and remove unnecessary guards

StringValuePtr should already be a sufficient guard.
There are more tests while we're at it, too, and we'll
now raise TypeError instead of ArgumentError when a
POSIX_MQ::Attr is not passed properly.

remove rb_time_interval() and gettimeofday() dependency

This function isn't exported in the standard Ruby headers,
it returns an aggregate value and isn't available in Rubinius,
either, so nuke it.

While we're at it, use clock_gettime() instead of gettimeofday()
to avoid unnecessary timeval usage since mq_send/mq_receive
rely on higher-precision timespecs instead.

tests: use Class#method_defined?

I did not know about this method back in the day...

test: avoid leaving queues behind

We shouldn't unnecessarily hog system resources.

avoid double close() and EBADF

It can be dangerous to hit (and ignore) EBADF errors in
multi-threaded applications.  Users of POSIX_MQ#to_io have two
Ruby objects pointing to the same file descriptor, making
things tricky when it comes time to reap resources.

We'll always prefer to close the Ruby IO object if it exists
(because we have less control over its GC behavior) and
ignore the raw descriptor.

open/notify: invoke GC if needed

On ENOMEM, EMFILE, and ENFILE errors, it is customary to
invoke the Ruby GC and free up resources and retry the
system call.

posix_mq 0.5.1

Fix POSIX_MQ#notify(&block) usage, this regression was
introduced in 0.4.0 and our tests for it were broken, as well.

fix POSIX_MQ#notify(&block) aka SIGEV_THREAD

tests for them were stupidly broken and never executed :x