blob: eaabccc0e78d09922791a4ea5c847759f34e56fc [file] [log] [blame]
/*
Copyright (c) 2012-2013 250bpm s.r.o.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
*/
#include "../protocol.h"
#include "../transport.h"
#include "sock.h"
#include "ep.h"
#include "../utils/err.h"
#include "../utils/cont.h"
#define SP_SOCK_EVENT_IN 1
#define SP_SOCK_EVENT_OUT 2
void sp_sockbase_init (struct sp_sockbase *self,
const struct sp_sockbase_vfptr *vfptr, int fd)
{
self->vfptr = vfptr;
self->flags = 0;
sp_cp_init (&self->cp);
sp_cond_init (&self->cond);
sp_clock_init (&self->clock);
self->fd = fd;
sp_list_init (&self->eps);
self->eid = 1;
/* Default values for SP_SOL_SOCKET options. */
self->linger = 1000;
self->sndbuf = 128 * 1024;
self->rcvbuf = 128 * 1024;
self->sndtimeo = -1;
self->rcvtimeo = -1;
self->reconnect_ivl = 100;
self->reconnect_ivl_max = 0;
}
void sp_sock_zombify (struct sp_sock *self)
{
struct sp_sockbase *sockbase;
sockbase = (struct sp_sockbase*) self;
sp_cp_lock (&sockbase->cp);
sockbase->flags |= SP_SOCK_FLAG_ZOMBIE;
sp_cond_post (&sockbase->cond);
sp_cp_unlock (&sockbase->cp);
}
void sp_sock_term (struct sp_sock *self)
{
int rc;
struct sp_sockbase *sockbase;
struct sp_list_item *it;
struct sp_epbase *ep;
sockbase = (struct sp_sockbase*) self;
sp_cp_lock (&sockbase->cp);
/* Ask all the associated endpoints to terminate. Call to sp_ep_close can
actually deallocate the endpoint, so take care to get pointer to the
next endpoint before the call. */
it = sp_list_begin (&sockbase->eps);
while (it != sp_list_end (&sockbase->eps)) {
ep = sp_cont (it, struct sp_epbase, item);
it = sp_list_next (&sockbase->eps, it);
sp_ep_close ((void*) ep);
}
while (1) {
/* If there are no active endpoints we can deallocate the socket
straight away. */
if (sp_list_empty (&sockbase->eps)) {
/* Terminate the sp_sockbase itself. */
sp_cp_unlock (&sockbase->cp);
sp_list_term (&sockbase->eps);
sp_clock_term (&sockbase->clock);
sp_cond_term (&sockbase->cond);
sp_cp_term (&sockbase->cp);
/* Deallocate the derived class. */
sockbase->vfptr->destroy (sockbase);
return;
}
/* Wait till all the endpoints are closed. */
sp_cond_set_timeout (&sockbase->cond, -1);
rc = sp_cond_wait (&sockbase->cond, &sockbase->cp.sync);
errnum_assert (rc == 0, rc);
}
}
void sp_sockbase_unblock_recv (struct sp_sockbase *self)
{
sp_cond_post (&self->cond);
}
void sp_sockbase_unblock_send (struct sp_sockbase *self)
{
sp_cond_post (&self->cond);
}
struct sp_cp *sp_sockbase_getcp (struct sp_sockbase *self)
{
return &self->cp;
}
struct sp_cp *sp_sock_getcp (struct sp_sock *self)
{
return &((struct sp_sockbase*) self)->cp;
}
int sp_sock_setopt (struct sp_sock *self, int level, int option,
const void *optval, size_t optvallen)
{
int rc;
struct sp_sockbase *sockbase;
int *dst;
sockbase = (struct sp_sockbase*) self;
sp_cp_lock (&sockbase->cp);
/* If sp_term() was already called, return ETERM. */
if (sp_slow (sockbase->flags & SP_SOCK_FLAG_ZOMBIE)) {
sp_cp_unlock (&sockbase->cp);
return -ETERM;
}
/* Generic socket-level options. */
if (level == SP_SOL_SOCKET) {
switch (option) {
case SP_LINGER:
dst = &sockbase->linger;
break;
case SP_SNDBUF:
dst = &sockbase->sndbuf;
break;
case SP_RCVBUF:
dst = &sockbase->rcvbuf;
break;
case SP_SNDTIMEO:
dst = &sockbase->sndtimeo;
break;
case SP_RCVTIMEO:
dst = &sockbase->rcvtimeo;
break;
case SP_RECONNECT_IVL:
dst = &sockbase->reconnect_ivl;
break;
case SP_RECONNECT_IVL_MAX:
dst = &sockbase->reconnect_ivl_max;
break;
default:
sp_cp_unlock (&sockbase->cp);
return -ENOPROTOOPT;
}
if (optvallen != sizeof (int)) {
sp_cp_unlock (&sockbase->cp);
return -EINVAL;
}
*dst = *(int*) optval;
sp_cp_unlock (&sockbase->cp);
return 0;
}
/* Protocol-specific socket options. */
if (level > SP_SOL_SOCKET) {
rc = sockbase->vfptr->setopt (sockbase, level, option,
optval, optvallen);
sp_cp_unlock (&sockbase->cp);
return rc;
}
/* Transport-specific options. */
if (level < SP_SOL_SOCKET) {
sp_cp_unlock (&sockbase->cp);
return -ENOPROTOOPT;
}
sp_assert (0);
}
int sp_sock_getopt (struct sp_sock *self, int level, int option,
void *optval, size_t *optvallen, int internal)
{
int rc;
struct sp_sockbase *sockbase;
int *src;
sockbase = (struct sp_sockbase*) self;
if (!internal)
sp_cp_lock (&sockbase->cp);
/* If sp_term() was already called, return ETERM. */
if (!internal && sp_slow (sockbase->flags & SP_SOCK_FLAG_ZOMBIE)) {
sp_cp_unlock (&sockbase->cp);
return -ETERM;
}
/* Generic socket-level options. */
if (level == SP_SOL_SOCKET) {
switch (option) {
case SP_LINGER:
src = &sockbase->linger;
break;
case SP_SNDBUF:
src = &sockbase->sndbuf;
break;
case SP_RCVBUF:
src = &sockbase->rcvbuf;
break;
case SP_SNDTIMEO:
src = &sockbase->sndtimeo;
break;
case SP_RCVTIMEO:
src = &sockbase->rcvtimeo;
break;
case SP_RECONNECT_IVL:
src = &sockbase->reconnect_ivl;
break;
case SP_RECONNECT_IVL_MAX:
src = &sockbase->reconnect_ivl_max;
break;
default:
if (!internal)
sp_cp_unlock (&sockbase->cp);
return -ENOPROTOOPT;
}
memcpy (optval, src,
*optvallen < sizeof (int) ? *optvallen : sizeof (int));
*optvallen = sizeof (int);
if (!internal)
sp_cp_unlock (&sockbase->cp);
return 0;
}
/* Protocol-specific socket options. */
if (level > SP_SOL_SOCKET) {
rc = sockbase->vfptr->getopt (sockbase, level, option,
optval, optvallen);
if (!internal)
sp_cp_unlock (&sockbase->cp);
return rc;
}
/* Transport-specific options. */
if (level < SP_SOL_SOCKET) {
if (!internal)
sp_cp_unlock (&sockbase->cp);
return -ENOPROTOOPT;
}
sp_assert (0);
}
int sp_sock_create_ep (struct sp_sock *self, const char *addr,
int (*factory) (const char *addr, void *hint, struct sp_epbase **ep))
{
int rc;
struct sp_sockbase *sockbase;
struct sp_epbase *ep;
int eid;
sockbase = (struct sp_sockbase*) self;
sp_cp_lock (&sockbase->cp);
/* Create the transport-specific endpoint. */
rc = factory (addr, (void*) self, &ep);
if (sp_slow (rc < 0)) {
sp_cp_unlock (&sockbase->cp);
return rc;
}
/* Provide it with an unique endpoint ID. */
eid = ep->eid = sockbase->eid;
++sockbase->eid;
/* Add it to the list of active endpoints. */
sp_list_insert (&sockbase->eps, &ep->item, sp_list_end (&sockbase->eps));
sp_cp_unlock (&sockbase->cp);
return eid;
}
int sp_sock_shutdown (struct sp_sock *self, int eid)
{
struct sp_sockbase *sockbase;
struct sp_list_item *it;
struct sp_epbase *ep;
sockbase = (struct sp_sockbase*) self;
sp_cp_lock (&sockbase->cp);
/* Find the specified enpoint. */
ep = NULL;
for (it = sp_list_begin (&sockbase->eps);
it != sp_list_end (&sockbase->eps);
it = sp_list_next (&sockbase->eps, it)) {
ep = sp_cont (it, struct sp_epbase, item);
if (ep->eid == eid)
break;
ep = NULL;
}
/* The endpoint doesn't exist. */
if (!ep) {
sp_cp_unlock (&sockbase->cp);
return -EINVAL;
}
/* Ask the endpoint to shutdown. Actual terminatation may be delayed
by the transport. */
sp_ep_close ((void*) ep);
sp_cp_unlock (&sockbase->cp);
return 0;
}
void sp_sock_ep_closed (struct sp_sock *self, struct sp_epbase *ep)
{
struct sp_sockbase *sockbase;
sockbase = (struct sp_sockbase*) self;
/* Remove the endpoint from the list of active endpoints. */
sp_list_erase (&sockbase->eps, &ep->item);
/* sp_close() may be waiting for termination of this endpoint.
Send it a signal. */
if (sp_list_empty (&sockbase->eps))
sp_cond_post (&sockbase->cond);
}
int sp_sock_send (struct sp_sock *self, const void *buf, size_t len, int flags)
{
int rc;
struct sp_sockbase *sockbase;
sockbase = (struct sp_sockbase*) self;
sp_cp_lock (&sockbase->cp);
/* Set the SNDTIMEO timer. */
sp_cond_set_timeout (&sockbase->cond, sockbase->sndtimeo);
while (1) {
/* If sp_term() was already called, return ETERM. */
if (sp_slow (sockbase->flags & SP_SOCK_FLAG_ZOMBIE)) {
sp_cp_unlock (&sockbase->cp);
return -ETERM;
}
/* Try to send the message in a non-blocking way. */
rc = sockbase->vfptr->send (sockbase, buf, len);
if (sp_fast (rc == 0)) {
sp_cp_unlock (&sockbase->cp);
return 0;
}
/* Any unexpected error is forwarded to the caller. */
if (sp_slow (rc != -EAGAIN)) {
sp_cp_unlock (&sockbase->cp);
return rc;
}
/* If the message cannot be sent at the moment and the send call
is non-blocking, return immediately. */
if (sp_fast (flags & SP_DONTWAIT)) {
sp_cp_unlock (&sockbase->cp);
return -EAGAIN;
}
/* With blocking send, wait while there are new pipes available
for sending. */
rc = sp_cond_wait (&sockbase->cond, &sockbase->cp.sync);
if (sp_slow (rc == -ETIMEDOUT)) {
sp_cp_unlock (&sockbase->cp);
return -EAGAIN;
}
errnum_assert (rc == 0, rc);
}
}
int sp_sock_recv (struct sp_sock *self, void *buf, size_t *len, int flags)
{
int rc;
struct sp_sockbase *sockbase;
sockbase = (struct sp_sockbase*) self;
sp_cp_lock (&sockbase->cp);
/* Set the RCVTIMEO timer. */
sp_cond_set_timeout (&sockbase->cond, sockbase->rcvtimeo);
while (1) {
/* If sp_term() was already called, return ETERM. */
if (sp_slow (sockbase->flags & SP_SOCK_FLAG_ZOMBIE)) {
sp_cp_unlock (&sockbase->cp);
return -ETERM;
}
/* Try to receive the message in a non-blocking way. */
rc = sockbase->vfptr->recv (sockbase, buf, len);
if (sp_fast (rc == 0)) {
sp_cp_unlock (&sockbase->cp);
return 0;
}
/* Any unexpected error is forwarded to the caller. */
if (sp_slow (rc != -EAGAIN)) {
sp_cp_unlock (&sockbase->cp);
return rc;
}
/* If the message cannot be received at the moment and the recv call
is non-blocking, return immediately. */
if (sp_fast (flags & SP_DONTWAIT)) {
sp_cp_unlock (&sockbase->cp);
return -EAGAIN;
}
/* With blocking recv, wait while there are new pipes available
for receiving. */
rc = sp_cond_wait (&sockbase->cond, &sockbase->cp.sync);
if (sp_slow (rc == -ETIMEDOUT)) {
sp_cp_unlock (&sockbase->cp);
return -EAGAIN;
}
errnum_assert (rc == 0, rc);
}
}
int sp_sock_fd (struct sp_sock *self)
{
struct sp_sockbase *sockbase;
sockbase = (struct sp_sockbase*) self;
return sockbase->fd;
}
int sp_sock_add (struct sp_sock *self, struct sp_pipe *pipe)
{
struct sp_sockbase *sockbase;
/* Forward the call to the specific socket type. */
sockbase = (struct sp_sockbase*) self;
return sockbase->vfptr->add (sockbase, pipe);
}
void sp_sock_rm (struct sp_sock *self, struct sp_pipe *pipe)
{
struct sp_sockbase *sockbase;
/* Forward the call to the specific socket type. */
sockbase = (struct sp_sockbase*) self;
sockbase->vfptr->rm (sockbase, pipe);
}
void sp_sock_in (struct sp_sock *self, struct sp_pipe *pipe)
{
int rc;
struct sp_sockbase *sockbase;
/* Forward the call to the specific socket type. */
sockbase = (struct sp_sockbase*) self;
rc = sockbase->vfptr->in (sockbase, pipe);
errnum_assert (rc >= 0, -rc);
if (rc == 1)
sp_cond_post (&sockbase->cond);
}
void sp_sock_out (struct sp_sock *self, struct sp_pipe *pipe)
{
int rc;
struct sp_sockbase *sockbase;
/* Forward the call to the specific socket type. */
sockbase = (struct sp_sockbase*) self;
rc = sockbase->vfptr->out (sockbase, pipe);
errnum_assert (rc >= 0, -rc);
if (rc == 1)
sp_cond_post (&sockbase->cond);
}