You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
423 lines
14 KiB
423 lines
14 KiB
/*
|
|
Copyright (c) 2013 Martin Sustrik All rights reserved.
|
|
|
|
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 "sipc.h"
|
|
|
|
#include "../../utils/err.h"
|
|
#include "../../utils/cont.h"
|
|
#include "../../utils/fast.h"
|
|
#include "../../utils/wire.h"
|
|
#include "../../utils/int.h"
|
|
#include "../../utils/attr.h"
|
|
|
|
/* Types of messages passed via IPC transport. */
|
|
#define NN_SIPC_MSG_NORMAL 1
|
|
#define NN_SIPC_MSG_SHMEM 2
|
|
|
|
/* States of the object as a whole. */
|
|
#define NN_SIPC_STATE_IDLE 1
|
|
#define NN_SIPC_STATE_PROTOHDR 2
|
|
#define NN_SIPC_STATE_STOPPING_STREAMHDR 3
|
|
#define NN_SIPC_STATE_ACTIVE 4
|
|
#define NN_SIPC_STATE_SHUTTING_DOWN 5
|
|
#define NN_SIPC_STATE_DONE 6
|
|
#define NN_SIPC_STATE_STOPPING 7
|
|
|
|
/* Subordinated srcptr objects. */
|
|
#define NN_SIPC_SRC_USOCK 1
|
|
#define NN_SIPC_SRC_STREAMHDR 2
|
|
|
|
/* Possible states of the inbound part of the object. */
|
|
#define NN_SIPC_INSTATE_HDR 1
|
|
#define NN_SIPC_INSTATE_BODY 2
|
|
#define NN_SIPC_INSTATE_HASMSG 3
|
|
|
|
/* Possible states of the outbound part of the object. */
|
|
#define NN_SIPC_OUTSTATE_IDLE 1
|
|
#define NN_SIPC_OUTSTATE_SENDING 2
|
|
|
|
/* Stream is a special type of pipe. Implementation of the virtual pipe API. */
|
|
static int nn_sipc_send (struct nn_pipebase *self, struct nn_msg *msg);
|
|
static int nn_sipc_recv (struct nn_pipebase *self, struct nn_msg *msg);
|
|
const struct nn_pipebase_vfptr nn_sipc_pipebase_vfptr = {
|
|
nn_sipc_send,
|
|
nn_sipc_recv
|
|
};
|
|
|
|
/* Private functions. */
|
|
static void nn_sipc_handler (struct nn_fsm *self, int src, int type,
|
|
void *srcptr);
|
|
static void nn_sipc_shutdown (struct nn_fsm *self, int src, int type,
|
|
void *srcptr);
|
|
|
|
void nn_sipc_init (struct nn_sipc *self, int src,
|
|
struct nn_epbase *epbase, struct nn_fsm *owner)
|
|
{
|
|
nn_fsm_init (&self->fsm, nn_sipc_handler, nn_sipc_shutdown,
|
|
src, self, owner);
|
|
self->state = NN_SIPC_STATE_IDLE;
|
|
nn_streamhdr_init (&self->streamhdr, NN_SIPC_SRC_STREAMHDR, &self->fsm);
|
|
self->usock = NULL;
|
|
self->usock_owner.src = -1;
|
|
self->usock_owner.fsm = NULL;
|
|
nn_pipebase_init (&self->pipebase, &nn_sipc_pipebase_vfptr, epbase);
|
|
self->instate = -1;
|
|
nn_msg_init (&self->inmsg, 0);
|
|
self->outstate = -1;
|
|
nn_msg_init (&self->outmsg, 0);
|
|
nn_fsm_event_init (&self->done);
|
|
}
|
|
|
|
void nn_sipc_term (struct nn_sipc *self)
|
|
{
|
|
nn_assert_state (self, NN_SIPC_STATE_IDLE);
|
|
|
|
nn_fsm_event_term (&self->done);
|
|
nn_msg_term (&self->outmsg);
|
|
nn_msg_term (&self->inmsg);
|
|
nn_pipebase_term (&self->pipebase);
|
|
nn_streamhdr_term (&self->streamhdr);
|
|
nn_fsm_term (&self->fsm);
|
|
}
|
|
|
|
int nn_sipc_isidle (struct nn_sipc *self)
|
|
{
|
|
return nn_fsm_isidle (&self->fsm);
|
|
}
|
|
|
|
void nn_sipc_start (struct nn_sipc *self, struct nn_usock *usock)
|
|
{
|
|
/* Take ownership of the underlying socket. */
|
|
nn_assert (self->usock == NULL && self->usock_owner.fsm == NULL);
|
|
self->usock_owner.src = NN_SIPC_SRC_USOCK;
|
|
self->usock_owner.fsm = &self->fsm;
|
|
nn_usock_swap_owner (usock, &self->usock_owner);
|
|
self->usock = usock;
|
|
|
|
/* Launch the state machine. */
|
|
nn_fsm_start (&self->fsm);
|
|
}
|
|
|
|
void nn_sipc_stop (struct nn_sipc *self)
|
|
{
|
|
nn_fsm_stop (&self->fsm);
|
|
}
|
|
|
|
static int nn_sipc_send (struct nn_pipebase *self, struct nn_msg *msg)
|
|
{
|
|
struct nn_sipc *sipc;
|
|
struct nn_iovec iov [3];
|
|
|
|
sipc = nn_cont (self, struct nn_sipc, pipebase);
|
|
|
|
nn_assert_state (sipc, NN_SIPC_STATE_ACTIVE);
|
|
nn_assert (sipc->outstate == NN_SIPC_OUTSTATE_IDLE);
|
|
|
|
/* Move the message to the local storage. */
|
|
nn_msg_term (&sipc->outmsg);
|
|
nn_msg_mv (&sipc->outmsg, msg);
|
|
|
|
/* Serialise the message header. */
|
|
sipc->outhdr [0] = NN_SIPC_MSG_NORMAL;
|
|
nn_putll (sipc->outhdr + 1, nn_chunkref_size (&sipc->outmsg.sphdr) +
|
|
nn_chunkref_size (&sipc->outmsg.body));
|
|
|
|
/* Start async sending. */
|
|
iov [0].iov_base = sipc->outhdr;
|
|
iov [0].iov_len = sizeof (sipc->outhdr);
|
|
iov [1].iov_base = nn_chunkref_data (&sipc->outmsg.sphdr);
|
|
iov [1].iov_len = nn_chunkref_size (&sipc->outmsg.sphdr);
|
|
iov [2].iov_base = nn_chunkref_data (&sipc->outmsg.body);
|
|
iov [2].iov_len = nn_chunkref_size (&sipc->outmsg.body);
|
|
nn_usock_send (sipc->usock, iov, 3);
|
|
|
|
sipc->outstate = NN_SIPC_OUTSTATE_SENDING;
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int nn_sipc_recv (struct nn_pipebase *self, struct nn_msg *msg)
|
|
{
|
|
struct nn_sipc *sipc;
|
|
|
|
sipc = nn_cont (self, struct nn_sipc, pipebase);
|
|
|
|
nn_assert_state (sipc, NN_SIPC_STATE_ACTIVE);
|
|
nn_assert (sipc->instate == NN_SIPC_INSTATE_HASMSG);
|
|
|
|
/* Move received message to the user. */
|
|
nn_msg_mv (msg, &sipc->inmsg);
|
|
nn_msg_init (&sipc->inmsg, 0);
|
|
|
|
/* Start receiving new message. */
|
|
sipc->instate = NN_SIPC_INSTATE_HDR;
|
|
nn_usock_recv (sipc->usock, sipc->inhdr, sizeof (sipc->inhdr), NULL);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static void nn_sipc_shutdown (struct nn_fsm *self, int src, int type,
|
|
NN_UNUSED void *srcptr)
|
|
{
|
|
struct nn_sipc *sipc;
|
|
|
|
sipc = nn_cont (self, struct nn_sipc, fsm);
|
|
|
|
if (nn_slow (src == NN_FSM_ACTION && type == NN_FSM_STOP)) {
|
|
nn_pipebase_stop (&sipc->pipebase);
|
|
nn_streamhdr_stop (&sipc->streamhdr);
|
|
sipc->state = NN_SIPC_STATE_STOPPING;
|
|
}
|
|
if (nn_slow (sipc->state == NN_SIPC_STATE_STOPPING)) {
|
|
if (nn_streamhdr_isidle (&sipc->streamhdr)) {
|
|
nn_usock_swap_owner (sipc->usock, &sipc->usock_owner);
|
|
sipc->usock = NULL;
|
|
sipc->usock_owner.src = -1;
|
|
sipc->usock_owner.fsm = NULL;
|
|
sipc->state = NN_SIPC_STATE_IDLE;
|
|
nn_fsm_stopped (&sipc->fsm, NN_SIPC_STOPPED);
|
|
return;
|
|
}
|
|
return;
|
|
}
|
|
|
|
nn_fsm_bad_state(sipc->state, src, type);
|
|
}
|
|
|
|
static void nn_sipc_handler (struct nn_fsm *self, int src, int type,
|
|
NN_UNUSED void *srcptr)
|
|
{
|
|
int rc;
|
|
struct nn_sipc *sipc;
|
|
uint64_t size;
|
|
|
|
sipc = nn_cont (self, struct nn_sipc, fsm);
|
|
|
|
|
|
switch (sipc->state) {
|
|
|
|
/******************************************************************************/
|
|
/* IDLE state. */
|
|
/******************************************************************************/
|
|
case NN_SIPC_STATE_IDLE:
|
|
switch (src) {
|
|
|
|
case NN_FSM_ACTION:
|
|
switch (type) {
|
|
case NN_FSM_START:
|
|
nn_streamhdr_start (&sipc->streamhdr, sipc->usock,
|
|
&sipc->pipebase);
|
|
sipc->state = NN_SIPC_STATE_PROTOHDR;
|
|
return;
|
|
default:
|
|
nn_fsm_bad_action (sipc->state, src, type);
|
|
}
|
|
|
|
default:
|
|
nn_fsm_bad_source (sipc->state, src, type);
|
|
}
|
|
|
|
/******************************************************************************/
|
|
/* PROTOHDR state. */
|
|
/******************************************************************************/
|
|
case NN_SIPC_STATE_PROTOHDR:
|
|
switch (src) {
|
|
|
|
case NN_SIPC_SRC_STREAMHDR:
|
|
switch (type) {
|
|
case NN_STREAMHDR_OK:
|
|
|
|
/* Before moving to the active state stop the streamhdr
|
|
state machine. */
|
|
nn_streamhdr_stop (&sipc->streamhdr);
|
|
sipc->state = NN_SIPC_STATE_STOPPING_STREAMHDR;
|
|
return;
|
|
|
|
case NN_STREAMHDR_ERROR:
|
|
|
|
/* Raise the error and move directly to the DONE state.
|
|
streamhdr object will be stopped later on. */
|
|
sipc->state = NN_SIPC_STATE_DONE;
|
|
nn_fsm_raise (&sipc->fsm, &sipc->done, NN_SIPC_ERROR);
|
|
return;
|
|
|
|
default:
|
|
nn_fsm_bad_action (sipc->state, src, type);
|
|
}
|
|
|
|
default:
|
|
nn_fsm_bad_source (sipc->state, src, type);
|
|
}
|
|
|
|
/******************************************************************************/
|
|
/* STOPPING_STREAMHDR state. */
|
|
/******************************************************************************/
|
|
case NN_SIPC_STATE_STOPPING_STREAMHDR:
|
|
switch (src) {
|
|
|
|
case NN_SIPC_SRC_STREAMHDR:
|
|
switch (type) {
|
|
case NN_STREAMHDR_STOPPED:
|
|
|
|
/* Start the pipe. */
|
|
rc = nn_pipebase_start (&sipc->pipebase);
|
|
if (nn_slow (rc < 0)) {
|
|
sipc->state = NN_SIPC_STATE_DONE;
|
|
nn_fsm_raise (&sipc->fsm, &sipc->done, NN_SIPC_ERROR);
|
|
return;
|
|
}
|
|
|
|
/* Start receiving a message in asynchronous manner. */
|
|
sipc->instate = NN_SIPC_INSTATE_HDR;
|
|
nn_usock_recv (sipc->usock, &sipc->inhdr,
|
|
sizeof (sipc->inhdr), NULL);
|
|
|
|
/* Mark the pipe as available for sending. */
|
|
sipc->outstate = NN_SIPC_OUTSTATE_IDLE;
|
|
|
|
sipc->state = NN_SIPC_STATE_ACTIVE;
|
|
return;
|
|
|
|
default:
|
|
nn_fsm_bad_action (sipc->state, src, type);
|
|
}
|
|
|
|
default:
|
|
nn_fsm_bad_source (sipc->state, src, type);
|
|
}
|
|
|
|
/******************************************************************************/
|
|
/* ACTIVE state. */
|
|
/******************************************************************************/
|
|
case NN_SIPC_STATE_ACTIVE:
|
|
switch (src) {
|
|
|
|
case NN_SIPC_SRC_USOCK:
|
|
switch (type) {
|
|
case NN_USOCK_SENT:
|
|
|
|
/* The message is now fully sent. */
|
|
nn_assert (sipc->outstate == NN_SIPC_OUTSTATE_SENDING);
|
|
sipc->outstate = NN_SIPC_OUTSTATE_IDLE;
|
|
nn_msg_term (&sipc->outmsg);
|
|
nn_msg_init (&sipc->outmsg, 0);
|
|
nn_pipebase_sent (&sipc->pipebase);
|
|
return;
|
|
|
|
case NN_USOCK_RECEIVED:
|
|
|
|
switch (sipc->instate) {
|
|
case NN_SIPC_INSTATE_HDR:
|
|
|
|
/* Message header was received. Allocate memory for the
|
|
message. */
|
|
nn_assert (sipc->inhdr [0] == NN_SIPC_MSG_NORMAL);
|
|
size = nn_getll (sipc->inhdr + 1);
|
|
nn_msg_term (&sipc->inmsg);
|
|
nn_msg_init (&sipc->inmsg, (size_t) size);
|
|
|
|
/* Special case when size of the message body is 0. */
|
|
if (!size) {
|
|
sipc->instate = NN_SIPC_INSTATE_HASMSG;
|
|
nn_pipebase_received (&sipc->pipebase);
|
|
return;
|
|
}
|
|
|
|
/* Start receiving the message body. */
|
|
sipc->instate = NN_SIPC_INSTATE_BODY;
|
|
nn_usock_recv (sipc->usock,
|
|
nn_chunkref_data (&sipc->inmsg.body),
|
|
(size_t) size, NULL);
|
|
|
|
return;
|
|
|
|
case NN_SIPC_INSTATE_BODY:
|
|
|
|
/* Message body was received. Notify the owner that it
|
|
can receive it. */
|
|
sipc->instate = NN_SIPC_INSTATE_HASMSG;
|
|
nn_pipebase_received (&sipc->pipebase);
|
|
|
|
return;
|
|
|
|
default:
|
|
nn_assert (0);
|
|
}
|
|
|
|
case NN_USOCK_SHUTDOWN:
|
|
nn_pipebase_stop (&sipc->pipebase);
|
|
sipc->state = NN_SIPC_STATE_SHUTTING_DOWN;
|
|
return;
|
|
|
|
case NN_USOCK_ERROR:
|
|
nn_pipebase_stop (&sipc->pipebase);
|
|
sipc->state = NN_SIPC_STATE_DONE;
|
|
nn_fsm_raise (&sipc->fsm, &sipc->done, NN_SIPC_ERROR);
|
|
return;
|
|
|
|
|
|
default:
|
|
nn_fsm_bad_action (sipc->state, src, type);
|
|
}
|
|
|
|
default:
|
|
nn_fsm_bad_source (sipc->state, src, type);
|
|
}
|
|
|
|
/******************************************************************************/
|
|
/* SHUTTING_DOWN state. */
|
|
/* The underlying connection is closed. We are just waiting that underlying */
|
|
/* usock being closed */
|
|
/******************************************************************************/
|
|
case NN_SIPC_STATE_SHUTTING_DOWN:
|
|
switch (src) {
|
|
|
|
case NN_SIPC_SRC_USOCK:
|
|
switch (type) {
|
|
case NN_USOCK_ERROR:
|
|
sipc->state = NN_SIPC_STATE_DONE;
|
|
nn_fsm_raise (&sipc->fsm, &sipc->done, NN_SIPC_ERROR);
|
|
return;
|
|
default:
|
|
nn_fsm_bad_action (sipc->state, src, type);
|
|
}
|
|
|
|
default:
|
|
nn_fsm_bad_source (sipc->state, src, type);
|
|
}
|
|
|
|
/******************************************************************************/
|
|
/* DONE state. */
|
|
/* The underlying connection is closed. There's nothing that can be done in */
|
|
/* this state except stopping the object. */
|
|
/******************************************************************************/
|
|
case NN_SIPC_STATE_DONE:
|
|
nn_fsm_bad_source (sipc->state, src, type);
|
|
|
|
|
|
/******************************************************************************/
|
|
/* Invalid state. */
|
|
/******************************************************************************/
|
|
default:
|
|
nn_fsm_bad_state (sipc->state, src, type);
|
|
}
|
|
}
|
|
|