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

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