Return to lists.c CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libaitrpc / src

release version 3.0

/*************************************************************************
* (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
*  by Michael Pounov <misho@openbsd-bg.org>
*
* $Author: misho $
* $Id: lists.c,v 1.7 2012/03/15 01:55:33 misho Exp $
*
**************************************************************************
The ELWIX and AITNET software is distributed under the following
terms:

All of the documentation and software included in the ELWIX and AITNET
Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>

Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
	by Michael Pounov <misho@elwix.org>.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
   must display the following acknowledgement:
This product includes software developed by Michael Pounov <misho@elwix.org>
ELWIX - Embedded LightWeight unIX and its contributors.
4. Neither the name of AITNET nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
*/
#include "global.h"


/*
 * rpc_srv_allocVars() - Allocate array for call variables
 *
 * @call = RPC function call
 * @varnum = Number of variables, if ==0 return already allocated variables number
 * return: -1 error, !=-1 return varnum value
 */
static inline int
rpc_srv_allocVars(rpc_func_t * __restrict call, int varnum)
{
	if (!call || varnum < 0) {
		rpc_SetErr(EINVAL, "Invalid parameter can`t allocate variables for RPC call");
		return -1;
	}

	if (varnum) {
		call->func_vars = io_allocVars(varnum);
		if (!call->func_vars)
			return -1;
	}

	return io_arraySize(call->func_vars);
}

/*
 * rpc_srv_getVars() - Get variables array for RPC call
 *
 * @call = RPC function call
 * @vars = Returned variables array, may be NULL
 * return: -1 error, !=-1 Number of returned variables
 */
inline int
rpc_srv_getVars(rpc_func_t * __restrict call, array_t ** __restrict vars)
{
	if (!call) {
		rpc_SetErr(EINVAL, "Invalid parameter can`t get variables");
		return -1;
	}

	if (vars)
		*vars = call->func_vars;
	return io_arraySize(call->func_vars);
}

/* --------------------------------------------------------- */

/*
 * rpc_srv_registerCall() - Register call to RPC server
 *
 * @srv = RPC Server instance
 * @csModule = Module name, if NULL self binary
 * @csFunc = Function name
 * @args = Number of return function arguments, use for restriction case!
 * return: -1 error or 0 register ok
 */
int
rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, 
		const char *csFunc, u_short args)
{
	rpc_func_t *func;

	if (!srv || !csFunc) {
		rpc_SetErr(EINVAL, "Invalid parameter can`t register function");
		return -1;
	}
	if (!(func = malloc(sizeof(rpc_func_t)))) {
		LOGERR;
		return -1;
	} else
		memset(func, 0, sizeof(rpc_func_t));

	/* calculate hashes */
	if (rpc_calcHashes(func, csModule, csFunc) == -1) {
		AIT_FREE_VAL(&func->func_name);
		AIT_FREE_VAL(&func->func_file);
		free(func);
		return -1;
	}

	func->func_parent = srv;

	/* allocate return variables */
	if (args > 0 && rpc_srv_allocVars(func, args) == -1) {
		AIT_FREE_VAL(&func->func_name);
		AIT_FREE_VAL(&func->func_file);
		free(func);
		return -1;
	}

	/* add to list of functions */
	pthread_mutex_lock(&srv->srv_mtx);
	func->func_next = srv->srv_funcs;
	srv->srv_funcs = func;
	pthread_mutex_unlock(&srv->srv_mtx);
	return 0;
}

/*
 * rpc_srv_unregisterCall() - Unregister call from RPC server
 *
 * @srv = RPC Server instance
 * @csModule = Module name, if NULL self binary
 * @csFunc = Function name
 * return: -1 error, 0 not found call, 1 unregister ok
 */
int
rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc)
{
	rpc_func_t func, *f, *curr;

	if (!srv || !csFunc) {
		rpc_SetErr(EINVAL, "Invalid parameter can`t unregister function");
		return -1;
	} else
		memset(&func, 0, sizeof func);

	/* calculate hashes */
	if (rpc_calcHashes(&func, csModule, csFunc) == -1)
		return -1;

	f = rpc_srv_getCall(srv, func.func_tag, func.func_hash);
	AIT_FREE_VAL(&func.func_name);
	AIT_FREE_VAL(&func.func_file);
	if (!f)				/* not found element for unregister */
		return 0;

	pthread_mutex_lock(&srv->srv_mtx);
	/* remove from list of functions */
	if (srv->srv_funcs == f)	/* if is 1st element */
		srv->srv_funcs = srv->srv_funcs->func_next;
	else {
		for (curr = srv->srv_funcs; curr->func_next != f; curr = curr->func_next);
		curr->func_next = curr->func_next->func_next;
	}
	io_freeVars(&f->func_vars);
	AIT_FREE_VAL(&f->func_name);
	AIT_FREE_VAL(&f->func_file);
	free(f);
	pthread_mutex_unlock(&srv->srv_mtx);

	return 1;
}

/*
 * rpc_srv_getCall()  - Get registered call from RPC server
 *
 * @srv = RPC Server instance
 * @tag = tag for function
 * @hash = hash for function
 * return: NULL not found call, !=NULL return call
 */
inline rpc_func_t *
rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash)
{
	rpc_func_t *f;

	if (!srv) {
		rpc_SetErr(EINVAL, "Invalid parameter can`t get function");
		return NULL;
	}

	for (f = srv->srv_funcs; f; f = f->func_next)
		if (f->func_tag == tag && f->func_hash == hash)
			break;

	return f;
}

/*
 * rpc_srv_getFunc() - Get registered call from RPC server by Name
 *
 * @srv = RPC Server instance
 * @csModule = Module name, if NULL self binary
 * @csFunc = Function name
 * return: NULL not found call, !=NULL return call
 */
rpc_func_t *
rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc)
{
	rpc_func_t func, *f = NULL;

	if (!srv || !csFunc) {
		rpc_SetErr(EINVAL, "Invalid parameter can`t get function");
		return NULL;
	} else
		memset(&func, 0, sizeof(rpc_func_t));

	/* calculate hashes */
	if (rpc_calcHashes(&func, csModule, csFunc) == -1)
		return NULL;

	f = rpc_srv_getCall(srv, func.func_tag, func.func_hash);

	AIT_FREE_VAL(&func.func_name);
	AIT_FREE_VAL(&func.func_file);
	return f;
}

// ---------------------------------------------------------

/*
 * rpc_srv_getBLOB() - Get registered BLOB 
 *
 * @srv = RPC Server instance
 * @var = hash for variable
 * return: NULL not found, !=NULL return blob var
 */
inline rpc_blob_t *
rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var)
{
	rpc_blob_t *b;

	if (!srv) {
		rpc_SetErr(EINVAL, "Invalid parameter can`t get BLOB variable");
		return NULL;
	}

	for (b = srv->srv_blob.blobs; b; b = b->blob_next) {
		if (b->blob_var == var)
			break;
	}

	return b;
}

/*
 * rpc_srv_registerBLOB() - Register new BLOB to server
 *
 * @srv = RPC Server instance
 * @len = BLOB length
 * return: NULL error or new registered BLOB
 */
rpc_blob_t *
rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len)
{
	rpc_blob_t *blob = NULL;

	if (!srv || !len) {
		rpc_SetErr(EINVAL, "Invalid parameter can`t register BLOB variable");
		return blob;
	}

	blob = rpc_srv_blobCreate(srv, len);
	if (blob) {
		pthread_mutex_lock(&srv->srv_blob.mtx);
		blob->blob_next = srv->srv_blob.blobs;
		srv->srv_blob.blobs = blob;
		pthread_mutex_unlock(&srv->srv_blob.mtx);
	}

	return blob;
}

/*
 * rpc_srv_unregisterBLOB() - Unregister BLOB from server
 *
 * @srv = RPC Server instance
 * @var = BLOB Variable for unregister
 * return: -1 error, 0 not found call, 1 unregister ok
 */
int
rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var)
{
	rpc_blob_t *b, *curr;

	if (!srv) {
		rpc_SetErr(EINVAL, "Invalid parameter can`t unregister BLOB variable");
		return -1;
	}

	b = rpc_srv_getBLOB(srv, var);
	if (!b)				/* not found element for unregister */
		return 0;
	/* if BLOB is unmapped force to unmap object */
	if (b->blob_data)
		rpc_srv_blobUnmap(b);

	pthread_mutex_lock(&srv->srv_blob.mtx);
	if (srv->srv_blob.blobs == b) {	/* if is 1st element */
		srv->srv_blob.blobs = srv->srv_blob.blobs->blob_next;
	} else {
		for (curr = srv->srv_blob.blobs; curr->blob_next != b; curr = curr->blob_next);
		curr->blob_next = curr->blob_next->blob_next;
	}
	pthread_mutex_unlock(&srv->srv_blob.mtx);
	rpc_srv_blobFree(srv, b);
	free(b);

	return 1;
}

/*
 * rpc_calcHashes() - Calculate hashes for RPC call
 *
 * @func = function
 * @csModule = Module name, if NULL self binary
 * @csFunc = Function name
 * return: -1 error or 0 ok
 */
int
rpc_calcHashes(rpc_func_t * __restrict func, const char *csModule, const char *csFunc)
{
	char *str = NULL;
	int len = 0;

	assert(func && csFunc);

	/* set function name */
	AIT_SET_STR(&func->func_name, csFunc);
	len = strlen(csFunc) + 3;	/* extra 3 bytes, because add string "__" and 0 */
	/* set module name if exists */
	if (csModule) {
		AIT_SET_STR(&func->func_file, csModule);
		len += strlen(csModule);
	}
	/* align len to 2 */
	len = io_align(len, 1);

	/* prepare hash source string */
	str = malloc(len);
	if (!str) {
		LOGERR;
		return -1;
	} else {
		memset(str, 0, len);
		if (csModule)
			strlcpy((char*) str, csModule, len);
		strlcat((char*) str, "__", len);
		strlcat((char*) str, csFunc, len);
	}

	func->func_tag = crcFletcher16((u_short*) str, len / 2);
	func->func_hash = hash_fnv((char*) str, len);

	free(str);
	return len;
}