Annotation of libaitrpc/src/lists.c, revision 1.7

1.2       misho       1: /*************************************************************************
                      2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
                      3: *  by Michael Pounov <misho@openbsd-bg.org>
                      4: *
                      5: * $Author: misho $
1.7     ! misho       6: * $Id: lists.c,v 1.6.2.4 2012/03/15 00:44:24 misho Exp $
1.2       misho       7: *
                      8: **************************************************************************
                      9: The ELWIX and AITNET software is distributed under the following
                     10: terms:
                     11: 
                     12: All of the documentation and software included in the ELWIX and AITNET
                     13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
                     14: 
1.7     ! misho      15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
1.2       misho      16:        by Michael Pounov <misho@elwix.org>.  All rights reserved.
                     17: 
                     18: Redistribution and use in source and binary forms, with or without
                     19: modification, are permitted provided that the following conditions
                     20: are met:
                     21: 1. Redistributions of source code must retain the above copyright
                     22:    notice, this list of conditions and the following disclaimer.
                     23: 2. Redistributions in binary form must reproduce the above copyright
                     24:    notice, this list of conditions and the following disclaimer in the
                     25:    documentation and/or other materials provided with the distribution.
                     26: 3. All advertising materials mentioning features or use of this software
                     27:    must display the following acknowledgement:
                     28: This product includes software developed by Michael Pounov <misho@elwix.org>
                     29: ELWIX - Embedded LightWeight unIX and its contributors.
                     30: 4. Neither the name of AITNET nor the names of its contributors
                     31:    may be used to endorse or promote products derived from this software
                     32:    without specific prior written permission.
                     33: 
                     34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
                     35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     44: SUCH DAMAGE.
                     45: */
                     46: #include "global.h"
                     47: 
                     48: 
                     49: /*
1.7     ! misho      50:  * rpc_srv_allocVars() - Allocate array for call variables
        !            51:  *
1.2       misho      52:  * @call = RPC function call
1.6       misho      53:  * @varnum = Number of variables, if ==0 return already allocated variables number
1.4       misho      54:  * return: -1 error, !=-1 return varnum value
1.2       misho      55:  */
1.6       misho      56: static inline int
1.4       misho      57: rpc_srv_allocVars(rpc_func_t * __restrict call, int varnum)
1.2       misho      58: {
1.4       misho      59:        if (!call || varnum < 0) {
1.7     ! misho      60:                rpc_SetErr(EINVAL, "Invalid parameter can`t allocate variables for RPC call");
1.2       misho      61:                return -1;
1.5       misho      62:        }
                     63: 
                     64:        if (varnum) {
1.6       misho      65:                call->func_vars = io_allocVars(varnum);
1.5       misho      66:                if (!call->func_vars)
                     67:                        return -1;
                     68:        }
                     69: 
                     70:        return io_arraySize(call->func_vars);
1.2       misho      71: }
                     72: 
                     73: /*
1.7     ! misho      74:  * rpc_srv_getVars() - Get variables array for RPC call
        !            75:  *
1.2       misho      76:  * @call = RPC function call
1.4       misho      77:  * @vars = Returned variables array, may be NULL
1.2       misho      78:  * return: -1 error, !=-1 Number of returned variables
                     79:  */
                     80: inline int
1.5       misho      81: rpc_srv_getVars(rpc_func_t * __restrict call, array_t ** __restrict vars)
1.2       misho      82: {
                     83:        if (!call) {
1.7     ! misho      84:                rpc_SetErr(EINVAL, "Invalid parameter can`t get variables");
1.2       misho      85:                return -1;
                     86:        }
                     87: 
1.4       misho      88:        if (vars)
                     89:                *vars = call->func_vars;
1.5       misho      90:        return io_arraySize(call->func_vars);
1.2       misho      91: }
                     92: 
1.7     ! misho      93: /* --------------------------------------------------------- */
1.2       misho      94: 
                     95: /*
1.7     ! misho      96:  * rpc_srv_registerCall() - Register call to RPC server
        !            97:  *
1.2       misho      98:  * @srv = RPC Server instance
                     99:  * @csModule = Module name, if NULL self binary
                    100:  * @csFunc = Function name
                    101:  * @args = Number of return function arguments, use for restriction case!
                    102:  * return: -1 error or 0 register ok
                    103:  */
                    104: int
1.7     ! misho     105: rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, 
        !           106:                const char *csFunc, u_short args)
1.2       misho     107: {
                    108:        rpc_func_t *func;
                    109: 
                    110:        if (!srv || !csFunc) {
1.7     ! misho     111:                rpc_SetErr(EINVAL, "Invalid parameter can`t register function");
1.2       misho     112:                return -1;
                    113:        }
                    114:        if (!(func = malloc(sizeof(rpc_func_t)))) {
                    115:                LOGERR;
                    116:                return -1;
1.7     ! misho     117:        } else
1.2       misho     118:                memset(func, 0, sizeof(rpc_func_t));
1.7     ! misho     119: 
        !           120:        /* calculate hashes */
        !           121:        if (rpc_calcHashes(func, csModule, csFunc) == -1) {
        !           122:                AIT_FREE_VAL(&func->func_name);
        !           123:                AIT_FREE_VAL(&func->func_file);
        !           124:                free(func);
        !           125:                return -1;
1.2       misho     126:        }
                    127: 
                    128:        func->func_parent = srv;
                    129: 
1.7     ! misho     130:        /* allocate return variables */
1.4       misho     131:        if (args > 0 && rpc_srv_allocVars(func, args) == -1) {
1.7     ! misho     132:                AIT_FREE_VAL(&func->func_name);
        !           133:                AIT_FREE_VAL(&func->func_file);
1.2       misho     134:                free(func);
                    135:                return -1;
                    136:        }
                    137: 
1.7     ! misho     138:        /* add to list of functions */
1.2       misho     139:        pthread_mutex_lock(&srv->srv_mtx);
                    140:        func->func_next = srv->srv_funcs;
                    141:        srv->srv_funcs = func;
                    142:        pthread_mutex_unlock(&srv->srv_mtx);
                    143:        return 0;
                    144: }
                    145: 
                    146: /*
1.7     ! misho     147:  * rpc_srv_unregisterCall() - Unregister call from RPC server
        !           148:  *
1.2       misho     149:  * @srv = RPC Server instance
                    150:  * @csModule = Module name, if NULL self binary
                    151:  * @csFunc = Function name
                    152:  * return: -1 error, 0 not found call, 1 unregister ok
                    153:  */
                    154: int
                    155: rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc)
                    156: {
                    157:        rpc_func_t func, *f, *curr;
                    158: 
                    159:        if (!srv || !csFunc) {
1.7     ! misho     160:                rpc_SetErr(EINVAL, "Invalid parameter can`t unregister function");
1.2       misho     161:                return -1;
                    162:        } else
1.7     ! misho     163:                memset(&func, 0, sizeof func);
1.2       misho     164: 
1.7     ! misho     165:        /* calculate hashes */
        !           166:        if (rpc_calcHashes(&func, csModule, csFunc) == -1)
        !           167:                return -1;
1.2       misho     168: 
                    169:        f = rpc_srv_getCall(srv, func.func_tag, func.func_hash);
1.7     ! misho     170:        AIT_FREE_VAL(&func.func_name);
        !           171:        AIT_FREE_VAL(&func.func_file);
1.3       misho     172:        if (!f)                         /* not found element for unregister */
1.2       misho     173:                return 0;
                    174: 
1.7     ! misho     175:        pthread_mutex_lock(&srv->srv_mtx);
        !           176:        /* remove from list of functions */
1.5       misho     177:        if (srv->srv_funcs == f)        /* if is 1st element */
1.2       misho     178:                srv->srv_funcs = srv->srv_funcs->func_next;
1.5       misho     179:        else {
1.2       misho     180:                for (curr = srv->srv_funcs; curr->func_next != f; curr = curr->func_next);
                    181:                curr->func_next = curr->func_next->func_next;
                    182:        }
1.6       misho     183:        io_freeVars(&f->func_vars);
1.7     ! misho     184:        AIT_FREE_VAL(&f->func_name);
        !           185:        AIT_FREE_VAL(&f->func_file);
1.5       misho     186:        free(f);
1.2       misho     187:        pthread_mutex_unlock(&srv->srv_mtx);
                    188: 
                    189:        return 1;
                    190: }
                    191: 
                    192: /*
1.7     ! misho     193:  * rpc_srv_getCall()  - Get registered call from RPC server
        !           194:  *
1.2       misho     195:  * @srv = RPC Server instance
                    196:  * @tag = tag for function
                    197:  * @hash = hash for function
                    198:  * return: NULL not found call, !=NULL return call
                    199:  */
                    200: inline rpc_func_t *
                    201: rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash)
                    202: {
                    203:        rpc_func_t *f;
                    204: 
                    205:        if (!srv) {
1.7     ! misho     206:                rpc_SetErr(EINVAL, "Invalid parameter can`t get function");
1.2       misho     207:                return NULL;
                    208:        }
                    209: 
                    210:        for (f = srv->srv_funcs; f; f = f->func_next)
                    211:                if (f->func_tag == tag && f->func_hash == hash)
                    212:                        break;
                    213: 
                    214:        return f;
                    215: }
                    216: 
                    217: /*
1.7     ! misho     218:  * rpc_srv_getFunc() - Get registered call from RPC server by Name
        !           219:  *
1.2       misho     220:  * @srv = RPC Server instance
                    221:  * @csModule = Module name, if NULL self binary
                    222:  * @csFunc = Function name
                    223:  * return: NULL not found call, !=NULL return call
                    224:  */
                    225: rpc_func_t *
                    226: rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc)
                    227: {
1.7     ! misho     228:        rpc_func_t func, *f = NULL;
1.2       misho     229: 
                    230:        if (!srv || !csFunc) {
1.7     ! misho     231:                rpc_SetErr(EINVAL, "Invalid parameter can`t get function");
1.2       misho     232:                return NULL;
                    233:        } else
1.7     ! misho     234:                memset(&func, 0, sizeof(rpc_func_t));
1.2       misho     235: 
1.7     ! misho     236:        /* calculate hashes */
        !           237:        if (rpc_calcHashes(&func, csModule, csFunc) == -1)
        !           238:                return NULL;
1.2       misho     239: 
1.7     ! misho     240:        f = rpc_srv_getCall(srv, func.func_tag, func.func_hash);
        !           241: 
        !           242:        AIT_FREE_VAL(&func.func_name);
        !           243:        AIT_FREE_VAL(&func.func_file);
        !           244:        return f;
1.2       misho     245: }
                    246: 
                    247: // ---------------------------------------------------------
                    248: 
                    249: /*
1.7     ! misho     250:  * rpc_srv_getBLOB() - Get registered BLOB 
        !           251:  *
1.2       misho     252:  * @srv = RPC Server instance
                    253:  * @var = hash for variable
                    254:  * return: NULL not found, !=NULL return blob var
                    255:  */
                    256: inline rpc_blob_t *
                    257: rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var)
                    258: {
                    259:        rpc_blob_t *b;
                    260: 
                    261:        if (!srv) {
1.7     ! misho     262:                rpc_SetErr(EINVAL, "Invalid parameter can`t get BLOB variable");
1.2       misho     263:                return NULL;
                    264:        }
                    265: 
                    266:        for (b = srv->srv_blob.blobs; b; b = b->blob_next) {
                    267:                if (b->blob_var == var)
                    268:                        break;
                    269:        }
                    270: 
                    271:        return b;
                    272: }
                    273: 
                    274: /*
1.7     ! misho     275:  * rpc_srv_registerBLOB() - Register new BLOB to server
        !           276:  *
1.2       misho     277:  * @srv = RPC Server instance
                    278:  * @len = BLOB length
                    279:  * return: NULL error or new registered BLOB
                    280:  */
                    281: rpc_blob_t *
                    282: rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len)
                    283: {
                    284:        rpc_blob_t *blob = NULL;
                    285: 
                    286:        if (!srv || !len) {
1.7     ! misho     287:                rpc_SetErr(EINVAL, "Invalid parameter can`t register BLOB variable");
1.2       misho     288:                return blob;
                    289:        }
                    290: 
                    291:        blob = rpc_srv_blobCreate(srv, len);
                    292:        if (blob) {
                    293:                pthread_mutex_lock(&srv->srv_blob.mtx);
                    294:                blob->blob_next = srv->srv_blob.blobs;
                    295:                srv->srv_blob.blobs = blob;
                    296:                pthread_mutex_unlock(&srv->srv_blob.mtx);
                    297:        }
                    298: 
                    299:        return blob;
                    300: }
                    301: 
                    302: /*
1.7     ! misho     303:  * rpc_srv_unregisterBLOB() - Unregister BLOB from server
        !           304:  *
1.2       misho     305:  * @srv = RPC Server instance
                    306:  * @var = BLOB Variable for unregister
                    307:  * return: -1 error, 0 not found call, 1 unregister ok
                    308:  */
                    309: int
                    310: rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var)
                    311: {
                    312:        rpc_blob_t *b, *curr;
                    313: 
                    314:        if (!srv) {
1.7     ! misho     315:                rpc_SetErr(EINVAL, "Invalid parameter can`t unregister BLOB variable");
1.2       misho     316:                return -1;
                    317:        }
                    318: 
                    319:        b = rpc_srv_getBLOB(srv, var);
1.3       misho     320:        if (!b)                         /* not found element for unregister */
1.2       misho     321:                return 0;
1.5       misho     322:        /* if BLOB is unmapped force to unmap object */
                    323:        if (b->blob_data)
                    324:                rpc_srv_blobUnmap(b);
1.2       misho     325: 
                    326:        pthread_mutex_lock(&srv->srv_blob.mtx);
1.3       misho     327:        if (srv->srv_blob.blobs == b) { /* if is 1st element */
1.2       misho     328:                srv->srv_blob.blobs = srv->srv_blob.blobs->blob_next;
                    329:        } else {
                    330:                for (curr = srv->srv_blob.blobs; curr->blob_next != b; curr = curr->blob_next);
                    331:                curr->blob_next = curr->blob_next->blob_next;
                    332:        }
1.5       misho     333:        pthread_mutex_unlock(&srv->srv_blob.mtx);
1.2       misho     334:        rpc_srv_blobFree(srv, b);
                    335:        free(b);
                    336: 
                    337:        return 1;
                    338: }
1.7     ! misho     339: 
        !           340: /*
        !           341:  * rpc_calcHashes() - Calculate hashes for RPC call
        !           342:  *
        !           343:  * @func = function
        !           344:  * @csModule = Module name, if NULL self binary
        !           345:  * @csFunc = Function name
        !           346:  * return: -1 error or 0 ok
        !           347:  */
        !           348: int
        !           349: rpc_calcHashes(rpc_func_t * __restrict func, const char *csModule, const char *csFunc)
        !           350: {
        !           351:        char *str = NULL;
        !           352:        int len = 0;
        !           353: 
        !           354:        assert(func && csFunc);
        !           355: 
        !           356:        /* set function name */
        !           357:        AIT_SET_STR(&func->func_name, csFunc);
        !           358:        len = strlen(csFunc) + 3;       /* extra 3 bytes, because add string "__" and 0 */
        !           359:        /* set module name if exists */
        !           360:        if (csModule) {
        !           361:                AIT_SET_STR(&func->func_file, csModule);
        !           362:                len += strlen(csModule);
        !           363:        }
        !           364:        /* align len to 2 */
        !           365:        len = io_align(len, 1);
        !           366: 
        !           367:        /* prepare hash source string */
        !           368:        str = malloc(len);
        !           369:        if (!str) {
        !           370:                LOGERR;
        !           371:                return -1;
        !           372:        } else {
        !           373:                memset(str, 0, len);
        !           374:                if (csModule)
        !           375:                        strlcpy((char*) str, csModule, len);
        !           376:                strlcat((char*) str, "__", len);
        !           377:                strlcat((char*) str, csFunc, len);
        !           378:        }
        !           379: 
        !           380:        func->func_tag = crcFletcher16((u_short*) str, len / 2);
        !           381:        func->func_hash = hash_fnv((char*) str, len);
        !           382: 
        !           383:        free(str);
        !           384:        return len;
        !           385: }
        !           386: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>