Annotation of libaitrpc/inc/aitrpc.h, revision 1.25.2.1

1.1       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.25.2.1! misho       6: * $Id: aitrpc.h,v 1.25 2015/01/15 01:42:37 misho Exp $
1.1       misho       7: *
1.2       misho       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.23      misho      15: Copyright 2004 - 2014
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: */
1.1       misho      46: #ifndef __AITRPC_H
                     47: #define __AITRPC_H
                     48: 
                     49: 
                     50: #include <assert.h>
                     51: #include <stdlib.h>
                     52: #include <string.h>
1.6       misho      53: #include <errno.h>
1.1       misho      54: #include <sys/types.h>
                     55: #include <sys/param.h>
1.2       misho      56: #if !defined(__NetBSD__)
1.1       misho      57: #include <sys/limits.h>
1.2       misho      58: #endif
1.1       misho      59: #include <sys/socket.h>
1.9       misho      60: #include <sys/queue.h>
1.13      misho      61: #include <elwix.h>
1.6       misho      62: #include <aitsched.h>
1.1       misho      63: 
                     64: 
1.18      misho      65: #define RPC_VERSION            7
1.1       misho      66: #define RPC_DEFPORT            2611
                     67: 
1.25.2.1! misho      68: /* Additional ELWIX RPC supporting protocols */
        !            69: #ifndef SOCK_STREAM
        !            70: #define SOCK_STREAM            1       /* stream socket */
        !            71: #endif
        !            72: #ifndef SOCK_DGRAM
        !            73: #define SOCK_DGRAM             2       /* datagram socket */
        !            74: #endif
        !            75: #ifndef SOCK_RAW
        !            76: #define SOCK_RAW               3       /* raw-protocol interface */
        !            77: #endif
        !            78: #define SOCK_BPF               4       /* ethernet interface */
        !            79: #define SOCK_PIPE              5       /* bi-directional pipe interface */
        !            80: 
1.6       misho      81: /* RPC call request flags */
                     82: 
                     83: #define RPC_REPLY              0x0
                     84: #define RPC_NOREPLY            0x1
1.1       misho      85: 
                     86: /* RPC builtin registed calls */
                     87: 
1.9       misho      88: #define CALL_TAG_MAX           65535
                     89: 
                     90: #define CALL_SRVPING           65534
                     91: 
                     92: #define CALL_SRVSHUTDOWN       65533
                     93: #define CALL_SRVCLIENTS                65532
                     94: #define CALL_SRVCALLS          65531
                     95: #define CALL_SRVSESSIONS       65530
                     96: 
                     97: #define CALL_BLOBSHUTDOWN      65529
                     98: #define CALL_BLOBCLIENTS       65528
                     99: #define CALL_BLOBVARS          65527
1.1       misho     100: 
1.16      misho     101: /* RPC signals */
                    102: #define SIGFBLOB               54
1.1       misho     103: 
                    104: /* RPC types */
                    105: 
                    106: typedef enum {
1.6       misho     107:        ok, error, no,                          /* for blob reply */
1.4       misho     108:        get, set, unset                         /* for blob request */
1.14      misho     109: } blob_cmd_type_t;
1.2       misho     110: 
1.1       misho     111: 
1.9       misho     112: #define RPC_CALLBACK_CHECK_INPUT(x)    do { \
                    113:                                                assert((x)); \
                    114:                                                if (!(x)) { \
1.6       misho     115:                                                        rpc_SetErr(EINVAL, \
                    116:                                                                        "Invalid callback parameters ..."); \
1.2       misho     117:                                                        return -1; \
                    118:                                                } \
                    119:                                        } while (0)
1.1       misho     120: 
                    121: 
                    122: /* RPC session identification */
                    123: 
                    124: typedef struct {
1.14      misho     125: #if BYTE_ORDER == LITTLE_ENDIAN
                    126:        uint16_t        sess_instance:8;
                    127:        uint16_t        sess_version:8;
                    128: #endif
                    129: #if BYTE_ORDER == BIG_ENDIAN
                    130:        uint16_t        sess_version:8;
                    131:        uint16_t        sess_instance:8;
                    132: #endif
                    133: } __packed rpc_sess_t; /* size == 2 bytes */
1.1       misho     134: 
                    135: 
                    136: /* Server managment RPC functions ... */
                    137: 
                    138: /* Network RPC packet - Client request */
                    139: 
                    140: struct tagRPCCall {
                    141:        rpc_sess_t      call_session;
1.6       misho     142: 
1.18      misho     143:        uint32_t        call_len;
1.9       misho     144:        uint16_t        call_crc;
1.1       misho     145: 
1.6       misho     146:        union {
                    147:                struct {
                    148:                        uint64_t        flags;
                    149:                }       call_req;
                    150:                struct {
                    151:                        int32_t         ret;
                    152:                        int32_t         eno;
                    153:                }       call_rep;
                    154:        };
1.1       misho     155: 
1.9       misho     156:        uint16_t        call_tag;
                    157:        uint16_t        call_argc;
                    158:        ait_val_t       call_argv[0];
1.14      misho     159: } __packed;                    /* size == 20 bytes */
1.20      misho     160: #define RPC_CHK_NOREPLY(x)     (ntohl((u_long) (x)->call_req.flags) & RPC_NOREPLY)
                    161: #define RPC_SET_ERRNO(x, _v)   ((x)->call_rep.eno = htonl((_v)))
1.1       misho     162: 
1.2       misho     163: /* Network BLOB packet - Header */
                    164: 
                    165: struct tagBLOBHdr {
                    166:        rpc_sess_t      hdr_session;
                    167:        uint8_t         hdr_cmd;
                    168:        uint32_t        hdr_var;
                    169:        uint32_t        hdr_len;
                    170:        uint32_t        hdr_ret;
1.6       misho     171:        uint8_t         hdr_pad;
1.14      misho     172: } __packed;                    /* size == 16 bytes */
1.2       misho     173: 
1.1       misho     174: /* Network RPC client & server elements */
                    175: 
1.9       misho     176: /* RPC function registration element! */
                    177: typedef struct tagRPCFunc {
                    178:        ait_val_t               func_name;
1.1       misho     179: 
1.9       misho     180:        void                    *func_parent;
1.11      misho     181: 
                    182:        SLIST_ENTRY(tagRPCFunc) func_next;
                    183:        AVL_ENTRY(tagRPCFunc)   func_node;
1.9       misho     184: } rpc_func_t;
                    185: #define RPC_FUNC_SERVER(x)     ((rpc_srv_t*) (x)->func_parent)
1.8       misho     186: 
1.11      misho     187: /* Tree root node */
                    188: typedef struct tagRPCFuncs {
                    189:        pthread_mutex_t         mtx;
                    190: 
                    191:        struct tagRPCFunc       *slh_first;
                    192:        struct tagRPCFunc       *avlh_root;
                    193: } rpc_funcs_t;
                    194: #define RPC_FUNCS_LOCK(x)      pthread_mutex_lock(&(x)->mtx)
                    195: #define RPC_FUNCS_UNLOCK(x)    pthread_mutex_unlock(&(x)->mtx)
                    196: #define RPC_FUNCS_ISEMPTY(x)   AVL_EMPTY((x))
                    197: 
1.1       misho     198: 
1.9       misho     199: /* BLOB register element */
1.2       misho     200: typedef struct tagBLOB {
1.9       misho     201:        uint32_t                blob_var;       /* BLOB id */
1.2       misho     202: 
1.9       misho     203:        size_t                  blob_len;       /* size of allocated BLOB data */
                    204:        void                    *blob_data;     /* mapped BLOB data */
1.2       misho     205: 
1.9       misho     206:        TAILQ_ENTRY(tagBLOB)    blob_node;
1.2       misho     207: } rpc_blob_t;
                    208: 
1.9       misho     209: 
1.1       misho     210: typedef struct {
1.9       misho     211:        int             cli_id;         /* slot id */
                    212:        int             cli_sock;       /* socket fd */
1.13      misho     213:        sockaddr_t      cli_sa;         /* host address */
1.9       misho     214:        ait_val_t       cli_buf;        /* network buffer */
1.1       misho     215: 
1.9       misho     216:        array_t         *cli_vars;      /* function return variables */
1.2       misho     217: 
1.9       misho     218:        void            *cli_parent;    /* pointer to parent rpc_srv_t for server or to rpc_sess_t for client */
                    219: } rpc_cli_t;
                    220: #define RPC_RETVARS(x)         ((x)->cli_vars)
                    221: #define RPC_SRV_SERVER(x)      ((rpc_srv_t*) (x)->cli_parent)
                    222: #define RPC_CLI_SESSION(x)     ((rpc_sess_t*) (x)->cli_parent)
                    223: 
                    224: typedef struct {
                    225:        rpc_sess_t                      srv_session;    /* RPC session registration info */
                    226:        int                             srv_netbuf;     /* size of network buffer */
1.12      misho     227:        int                             srv_proto;      /* Server protocol */
1.2       misho     228: 
1.9       misho     229:        pthread_t                       srv_tid;        /* RPC exec pthread */
                    230:        sched_root_task_t               *srv_root;      /* RPC server scheduler */
                    231:        intptr_t                        srv_kill;       /* Scheduler condition variable */
                    232: 
                    233:        rpc_cli_t                       srv_server;     /* RPC server socket */
                    234:        array_t                         *srv_clients;   /* connected rpc client sockets */
                    235: 
1.11      misho     236:        rpc_funcs_t                     srv_funcs;      /* RPC functions */
1.2       misho     237: 
                    238:        struct {
1.9       misho     239:                pthread_t                       tid;            /* BLOB exec pthread */
                    240:                sched_root_task_t               *root;          /* BLOB server scheduler */
                    241:                intptr_t                        kill;           /* BLOB server state: ==0 disable | !=0 enable */
1.2       misho     242: 
1.9       misho     243:                ait_val_t                       dir;            /* BLOB states directory */
1.1       misho     244: 
1.9       misho     245:                rpc_cli_t                       server;         /* BLOB server socket */
                    246:                array_t                         *clients;       /* connected blob client sockets */
                    247: 
                    248:                TAILQ_HEAD(, tagBLOB)           blobs;          /* registered blob variables list */
                    249:        }                               srv_blob;
1.1       misho     250: } rpc_srv_t;
                    251: 
                    252: 
1.2       misho     253: /* 
1.6       misho     254:  * (*rpc_callback_t)() - Callback type definition for RPC call in server process
                    255:  *
1.9       misho     256:  * @arg1 = RPC client
                    257:  * @arg2 = RPC packet header
1.2       misho     258:  * @arg3 = input array with values from RPC call execution request
                    259:  * return: -1 error or >-1 success execution
                    260:  */
1.9       misho     261: typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *);
1.1       misho     262: 
1.24      misho     263: #define RPC_CALL_DEFINE(x)     int (x)(rpc_cli_t*, struct tagRPCCall*, array_t*)
                    264: #define RPC_CALL_ARGS(arg1, arg2, arg3)        rpc_cli_t* arg1, struct tagRPCCall* arg2, array_t* arg3
                    265: #define RPC_CALL_STDARGS       RPC_CALL_ARGS(cli, rpc, iv)
                    266: 
1.1       misho     267: 
1.9       misho     268: /* ----------------------------------------------------------------------- */
1.1       misho     269: 
                    270: /* Error support functions */
                    271: 
1.3       misho     272: // rpc_GetErrno() Get error code of last operation
1.15      misho     273: int rpc_GetErrno();
1.3       misho     274: // rpc_GetError() Get error text of last operation
1.15      misho     275: const char *rpc_GetError();
1.17      misho     276: // rpc_SetErr() Set error to variables for internal use!!!
                    277: void rpc_SetErr(int eno, char *estr, ...);
                    278: 
1.1       misho     279: 
                    280: 
1.5       misho     281: /*
1.19      misho     282:  * rpc_Read() - RPC read operation
                    283:  *
                    284:  * @sock = socket
                    285:  * @type = type of socket
                    286:  * @flags = receive flags
                    287:  * @sa = check client address, if you use udp protocol
                    288:  * @buf = buffer
                    289:  * @blen = buffer length
1.22      misho     290:  * return: -1 error, 0 EOF or or >0 readed bytes into buffer
1.19      misho     291:  */
                    292: ssize_t rpc_Read(int sock, int type, int flags, sockaddr_t * __restrict sa, 
                    293:                unsigned char * __restrict buf, size_t blen);
                    294: /*
                    295:  * rpc_Write() - RPC write operation
                    296:  *
                    297:  * @sock = socket
                    298:  * @type = type of socket
                    299:  * @flags = send flags
                    300:  * @sa = send to client address, if you use udp protocol
                    301:  * @buf = buffer
                    302:  * @blen = buffer length
1.22      misho     303:  * return: -1 error, 0 EOF or >0 written bytes into buffer
1.19      misho     304:  */
                    305: ssize_t rpc_Write(int sock, int type, int flags, sockaddr_t * __restrict sa, 
                    306:                unsigned char * __restrict buf, size_t blen);
                    307: 
                    308: /*
1.9       misho     309:  * rpc_chkPktSession() - Check RPC session
1.6       misho     310:  *
1.5       misho     311:  * @p = packet session
                    312:  * @s = active session
1.9       misho     313:  * return: -1, 1, 2, 3 are errors or 0 ok
1.5       misho     314:  */
1.15      misho     315: int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
1.5       misho     316: /*
1.9       misho     317:  * rpc_addPktSession() - Prepare session into network format
1.6       misho     318:  *
1.5       misho     319:  * @p = packet session
1.9       misho     320:  * @s = host session
1.5       misho     321:  * return: -1 error or 0 ok
                    322:  */
1.15      misho     323: int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
1.9       misho     324: /*
                    325:  * rpc_register_srvPing() - Register ping service function
                    326:  *
                    327:  * @srv = RPC server instance
                    328:  * return: -1 error or 0 ok
                    329:  */
1.15      misho     330: int rpc_register_srvPing(rpc_srv_t * __restrict srv);
1.9       misho     331: /*
                    332:  * rpc_register_srvServices() - Register internal service functions
                    333:  *
                    334:  * @srv = RPC server instance
                    335:  * return: -1 error or 0 ok
                    336:  */
                    337: int rpc_register_srvServices(rpc_srv_t * __restrict srv);
                    338: /*
                    339:  * rpc_register_blobServices() - Register internal service functions
                    340:  *
                    341:  * @srv = RPC server instance
                    342:  * return: -1 error or 0 ok
                    343:  */
                    344: int rpc_register_blobServices(rpc_srv_t * __restrict srv);
1.5       misho     345: 
                    346: 
1.1       misho     347: /* RPC Server side functions */
                    348: 
                    349: /*
1.6       misho     350:  * rpc_srv_initServer() - Init & create RPC Server
                    351:  *
1.14      misho     352:  * @InstID = Instance for authentication & recognition
1.1       misho     353:  * @concurentClients = Concurent clients at same time to this server
1.9       misho     354:  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
1.3       misho     355:  * @csHost = Host name or address for bind server, if NULL any address
1.1       misho     356:  * @Port = Port for bind server, if Port == 0 default port is selected
1.12      misho     357:  * @proto = Protocol, if == 0 choose SOCK_STREAM
1.1       misho     358:  * return: NULL == error or !=NULL bind and created RPC server instance
                    359:  */
1.14      misho     360: rpc_srv_t *rpc_srv_initServer(unsigned char InstID, int concurentClients, int netBuf, 
1.12      misho     361:                const char *csHost, unsigned short Port, int proto);
1.1       misho     362: /*
1.6       misho     363:  * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
                    364:  *
1.5       misho     365:  * @psrv = RPC Server instance
1.1       misho     366:  * return: none
                    367:  */
1.15      misho     368: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
1.1       misho     369: /*
1.6       misho     370:  * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
                    371:  *
1.1       misho     372:  * @srv = RPC Server instance
                    373:  * return: -1 error or 0 ok, infinite loop ...
                    374:  */
1.4       misho     375: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
1.25      misho     376: #define rpc_srv_execServer(_srv, _sync) \
                    377:        do { assert((_srv)); \
                    378:                if (!(_srv)->srv_kill) { \
                    379:                        pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \
                    380:                                        rpc_srv_loopServer, (_srv)); \
                    381:                        if ((_sync)) \
                    382:                                pthread_join((_srv)->srv_tid, (void**) (_sync)); \
                    383:                        else \
                    384:                                pthread_detach((_srv)->srv_tid); \
                    385:        } } while (0)
                    386: #define rpc_srv_killServer(_srv) \
                    387:        (assert((_srv)), (_srv)->srv_blob.kill = 1, (_srv)->srv_kill = 1)
1.1       misho     388: 
                    389: /*
1.6       misho     390:  * rpc_srv_initBLOBServer() - Init & create BLOB Server
                    391:  *
1.3       misho     392:  * @srv = RPC server instance
1.2       misho     393:  * @Port = Port for bind server, if Port == 0 default port is selected
                    394:  * @diskDir = Disk place for BLOB file objects
                    395:  * return: -1 == error or 0 bind and created BLOB server instance
                    396:  */
1.9       misho     397: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, unsigned short Port, const char *diskDir);
1.2       misho     398: /*
1.6       misho     399:  * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
                    400:  *
1.2       misho     401:  * @srv = RPC Server instance
                    402:  * return: none
                    403:  */
1.15      misho     404: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
1.2       misho     405: /*
1.6       misho     406:  * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
                    407:  *
1.2       misho     408:  * @srv = RPC Server instance
                    409:  * return: -1 error or 0 ok, infinite loop ...
                    410:  */
1.9       misho     411: int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
1.25      misho     412: #define rpc_srv_execBLOBServer(_srv) \
                    413:        do { assert((_srv)); \
                    414:                if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
                    415:                        pthread_create(&(_srv)->srv_blob.tid, NULL, \
                    416:                                        (void*(*)(void*)) rpc_srv_loopBLOBServer, (_srv)); \
                    417:                        pthread_detach((_srv)->srv_blob.tid); \
                    418:                } \
                    419:        } while (0)
                    420: 
                    421: /*
                    422:  * rpc_srv_initServer2() - Init & create layer2 RPC Server
                    423:  *
                    424:  * @InstID = Instance for authentication & recognition
                    425:  * @concurentClients = Concurent clients at same time to this server
                    426:  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
                    427:  * @csIface = Interface name for bind server, if NULL first interface on host
                    428:  * return: NULL == error or !=NULL bind and created RPC server instance
                    429:  */
                    430: rpc_srv_t *rpc_srv_initServer2(u_char InstID, int concurentClients, int netBuf, 
                    431:                const char *csIface);
1.2       misho     432: 
                    433: /*
1.6       misho     434:  * rpc_srv_registerCall() - Register call to RPC server
                    435:  *
1.1       misho     436:  * @srv = RPC Server instance
1.9       misho     437:  * @tag = Function tag
                    438:  * @funcaddr = Function address
                    439:  * return: -1 error, 0 already registered tag or 1 register ok
1.1       misho     440:  */
1.9       misho     441: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, void *funcaddr);
1.1       misho     442: /*
1.6       misho     443:  * rpc_srv_unregisterCall() - Unregister call from RPC server
                    444:  *
1.1       misho     445:  * @srv = RPC Server instance
1.9       misho     446:  * @tag = Function tag
1.1       misho     447:  * return: -1 error, 0 not found call, 1 unregister ok
                    448:  */
1.9       misho     449: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
1.1       misho     450: /*
1.9       misho     451:  * rpc_srv_getCall()  - Get registered call from RPC server
1.6       misho     452:  *
1.1       misho     453:  * @srv = RPC Server instance
                    454:  * @tag = tag for function
                    455:  * return: NULL not found call, !=NULL return call
                    456:  */
1.15      misho     457: rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
1.1       misho     458: /*
1.9       misho     459:  * rpc_srv_execCall() Execute registered call from RPC server
1.6       misho     460:  *
1.9       misho     461:  * @cli = RPC client
1.1       misho     462:  * @rpc = IN RPC call structure
1.9       misho     463:  * @funcname = Execute RPC function
1.4       misho     464:  * @args = IN RPC calling arguments from RPC client
1.1       misho     465:  * return: -1 error, !=-1 ok
                    466:  */
1.9       misho     467: int rpc_srv_execCall(rpc_cli_t * __restrict cli, struct tagRPCCall * __restrict rpc, 
                    468:                ait_val_t funcname, array_t * __restrict args);
1.1       misho     469: 
                    470: 
1.2       misho     471: /*
1.9       misho     472:  * rpc_srv_blobCreate() - Create and map blob to memory region and return object
1.6       misho     473:  *
1.2       misho     474:  * @srv = RPC Server instance
                    475:  * @len = BLOB length object
1.16      misho     476:  * @tout = BLOB live timeout in seconds
1.2       misho     477:  * return: NULL error or !=NULL allocated BLOB object
                    478:  */
1.16      misho     479: rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len, int tout);
1.2       misho     480: /*
1.6       misho     481:  * rpc_srv_blobMap() - Map blob to memory region 
                    482:  *
1.2       misho     483:  * @srv = RPC Server instance
                    484:  * @blob = Map to this BLOB element
                    485:  * return: -1 error or 0 ok
                    486:  */
1.15      misho     487: int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
1.2       misho     488: /*
1.6       misho     489:  * rpc_srv_blobUnmap() - Unmap blob memory region 
                    490:  *
1.2       misho     491:  * @blob = Mapped BLOB element
                    492:  * return: none
                    493:  */
1.15      misho     494: void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
1.2       misho     495: /*
1.6       misho     496:  * rpc_srv_blobFree() - Free blob from disk & memory
                    497:  *
1.2       misho     498:  * @srv = RPC Server instance
                    499:  * @blob = Mapped BLOB element
                    500:  * return: -1 error or 0 ok
                    501:  */
1.15      misho     502: int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
1.2       misho     503: 
                    504: /*
1.6       misho     505:  * rpc_srv_registerBLOB() - Register new BLOB to server
                    506:  *
1.2       misho     507:  * @srv = RPC Server instance
                    508:  * @len = BLOB length
1.16      misho     509:  * @tout = BLOB live timeout in seconds
1.2       misho     510:  * return: NULL error or new registered BLOB
                    511:  */
1.16      misho     512: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len, int tout);
1.2       misho     513: /*
1.6       misho     514:  * rpc_srv_unregisterBLOB() - Unregister BLOB from server
                    515:  *
1.2       misho     516:  * @srv = RPC Server instance
                    517:  * @var = BLOB Variable for unregister
                    518:  * return: -1 error, 0 not found call, 1 unregister ok
                    519:  */
                    520: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
                    521: /*
1.6       misho     522:  * rpc_srv_getBLOB() - Get registered BLOB 
                    523:  *
1.2       misho     524:  * @srv = RPC Server instance
                    525:  * @var = hash for variable
                    526:  * return: NULL not found, !=NULL return blob var
                    527:  */
1.15      misho     528: rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
1.2       misho     529: 
                    530: /*
1.6       misho     531:  * rpc_srv_sendBLOB() - Send mapped BLOB to client
                    532:  *
1.2       misho     533:  * @cli = Client instance
                    534:  * @blob = Mapped BLOB element
                    535:  * return: -1 error, 0 ok
                    536:  */
                    537: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    538: /*
1.6       misho     539:  * rpc_srv_recvBLOB() - Receive BLOB from client
                    540:  *
1.2       misho     541:  * @cli = Client instance
                    542:  * @blob = Mapped BLOB element
                    543:  * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
                    544:  */
                    545: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    546: 
1.4       misho     547: /* CLIENT part of functions */
                    548: 
1.2       misho     549: /*
1.6       misho     550:  * rpc_cli_sendBLOB() - Send BLOB to server
                    551:  *
1.2       misho     552:  * @cli = Client instance
                    553:  * @var = BLOB variable
                    554:  * @data = BLOB data
1.16      misho     555:  * @tout = BLOB live on server timeout in seconds, if =0 default timeout
1.2       misho     556:  * return: -1 error, 0 ok, 1 remote error
                    557:  */
1.16      misho     558: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
                    559:                void * __restrict data, int tout);
1.2       misho     560: /*
1.6       misho     561:  * rpc_cli_recvBLOB() - Receive BLOB from server
                    562:  *
1.2       misho     563:  * @cli = Client instance
                    564:  * @var = BLOB variable
1.13      misho     565:  * @data = BLOB data, must be e_free after use!
1.2       misho     566:  * return: -1 error, 0 ok, 1 remote error
                    567:  */
1.4       misho     568: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
1.2       misho     569: /*
1.6       misho     570:  * rpc_cli_delBLOB() - Delete BLOB from server
                    571:  *
1.2       misho     572:  * @cli = Client instance
                    573:  * @var = BLOB variable
                    574:  * return: -1 error, 0 ok, 1 remote error
                    575:  */
1.4       misho     576: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
1.2       misho     577: /*
1.6       misho     578:  * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
                    579:  *
1.2       misho     580:  * @cli = Client instance
                    581:  * @var = BLOB variable
1.13      misho     582:  * @data = BLOB data, must be e_free after use!
1.2       misho     583:  * return: -1 error, 0 ok, >0 remote error
                    584:  */
1.15      misho     585: int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
1.6       misho     586:                void ** __restrict data);
1.2       misho     587: 
                    588: 
1.1       misho     589: /* RPC Client side functions */
                    590: 
                    591: /*
1.6       misho     592:  * rpc_cli_openClient() - Connect to RPC Server
                    593:  *
1.14      misho     594:  * @InstID = InstID for RPC session request
1.9       misho     595:  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
1.1       misho     596:  * @csHost = Host name or IP address for bind server
                    597:  * @Port = Port for bind server, if Port == 0 default port is selected
1.12      misho     598:  * @proto = Protocol, if == 0 choose SOCK_STREAM
1.1       misho     599:  * return: NULL == error or !=NULL connection to RPC server established
                    600:  */
1.14      misho     601: rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf, 
1.12      misho     602:                const char *csHost, unsigned short Port, int proto);
1.1       misho     603: /*
1.22      misho     604:  * rpc_cli_reconnectClient() - Reconnecting client to RPC server
                    605:  *
                    606:  * @cli = RPC Client session
                    607:  * return: -1 error or 0 ok
                    608:  */
                    609: int rpc_cli_reconnectClient(rpc_cli_t * __restrict cli);
                    610: /*
1.6       misho     611:  * rpc_cli_closeClient() - Close connection to RPC server and free resources
                    612:  *
1.1       misho     613:  * @cli = RPC Client session
                    614:  * return: none
                    615:  */
1.9       misho     616: void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
1.1       misho     617: /*
1.13      misho     618:  * rpc_pkt_Send() - Send RPC packet
                    619:  *
                    620:  * @sock = Socket
                    621:  * @type = Type of socket
                    622:  * @sa = Server address
                    623:  * @pkt = RPC packet
                    624:  * @len = Length of packet
1.22      misho     625:  * return: -1 error, 0  EOF or >0 sended bytes
1.13      misho     626:  */
                    627: int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa, 
                    628:                ait_val_t * __restrict pkt, int len);
                    629: /*
                    630:  * rpc_pkt_Receive() - Receive RPC packet
                    631:  *
                    632:  * @sock = Socket
                    633:  * @type = Type of socket
                    634:  * @sa = Server address
                    635:  * @pkt = RPC packet
1.22      misho     636:  * return: -1 error, 0 EOF or >0 received bytes
1.13      misho     637:  */
                    638: int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa, 
                    639:                ait_val_t * __restrict pkt);
                    640: /*
                    641:  * rpc_pkt_Request() - Build RPC Request packet
                    642:  *
                    643:  * @pkt = Packet buffer
                    644:  * @sess = RPC session info
                    645:  * @tag = Function tag for execution
                    646:  * @vars = Function argument array of values, may be NULL
                    647:  * @noreply = We not want RPC reply
1.14      misho     648:  * @nocrc = Without CRC calculation
1.13      misho     649:  * return: -1 error or != -1 prepared bytes into packet
                    650:  */
                    651: int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, 
1.14      misho     652:                unsigned short tag, array_t * __restrict vars, int noreply, int nocrc);
1.13      misho     653: /*
                    654:  * rpc_pkt_Replay() - Decode RPC Replay packet
                    655:  *
                    656:  * @pkt = Packet buffer
1.25      misho     657:  * @sess = RPC session info, if =NULL don't check session
1.13      misho     658:  * @tag = Function tag
                    659:  * @vars = Function argument array of values, may be NULL
1.14      misho     660:  * @nocrc = Without CRC calculation
1.13      misho     661:  * return: -1 error or != -1 return value from function
                    662:  */
                    663: int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, 
1.14      misho     664:                unsigned short tag, array_t ** __restrict vars, int nocrc);
1.13      misho     665: /*
1.6       misho     666:  * rpc_cli_execCall() - Execute RPC call
                    667:  *
1.1       misho     668:  * @cli = RPC Client session
1.7       misho     669:  * @noreply = We not want RPC reply
1.9       misho     670:  * @tag = Function tag for execution
1.13      misho     671:  * @in_vars = IN function argument array of values, may be NULL
                    672:  * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
1.22      misho     673:  * return: -1 error, 0 ok result or 1 closed rpc connection
1.1       misho     674:  */
1.9       misho     675: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag, 
1.4       misho     676:                array_t * __restrict in_vars, array_t ** __restrict out_vars);
1.9       misho     677: /*
1.11      misho     678:  * rpc_cli_freeCall() - Free resouce allocated by RPC call
                    679:  *
                    680:  * @out_vars = Returned array with variables from RPC call
                    681:  * return: none
                    682:  */
1.15      misho     683: void rpc_cli_freeCall(array_t ** __restrict out_vars);
1.11      misho     684: /*
1.9       misho     685:  * rpc_cli_ping() - Ping RPC server
                    686:  *
                    687:  * @cli = connected client
                    688:  * return: -1 error or !=-1 ping seq id
                    689:  */
1.15      misho     690: int rpc_cli_ping(rpc_cli_t *cli);
1.1       misho     691: 
                    692: 
1.2       misho     693: /*
1.6       misho     694:  * rpc_cli_openBLOBClient() - Connect to BLOB Server
                    695:  *
1.2       misho     696:  * @rpccli = RPC Client session
                    697:  * @Port = Port for bind server, if Port == 0 default port is selected
                    698:  * return: NULL == error or !=NULL connection to BLOB server established
                    699:  */
1.9       misho     700: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, unsigned short Port);
1.2       misho     701: /*
1.6       misho     702:  * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
                    703:  *
1.2       misho     704:  * @cli = BLOB Client session
                    705:  * return: none
                    706:  */
1.9       misho     707: void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);
1.2       misho     708: 
                    709: 
1.25      misho     710: /*
                    711:  * rpc_cli_openClient2() - Connect to layer2 RPC Server
                    712:  *
                    713:  * @InstID = InstID for RPC session request
                    714:  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
                    715:  * @csIface = Interface name for bind client, if NULL first interface on host
                    716:  * @csHost = Host ethernet address
                    717:  * return: NULL == error or !=NULL connection to RPC server established
                    718:  */
                    719: rpc_cli_t *rpc_cli_openClient2(u_char InstID, int netBuf, 
                    720:                const char *csIface, const char *csHost);
                    721: /*
                    722:  * rpc_cli_closeClient2() - Close layer2 connection to RPC server and free resources
                    723:  *
                    724:  * @cli = RPC Client session
                    725:  * return: none
                    726:  */
                    727: void rpc_cli_closeClient2(rpc_cli_t ** __restrict cli);
                    728: 
                    729: 
1.1       misho     730: #endif

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