xref: /spdk/lib/jsonrpc/jsonrpc_internal.h (revision 2bdec64fbfb636f60c0fc6deb704f43a24c3a1eb)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef SPDK_JSONRPC_INTERNAL_H_
35 #define SPDK_JSONRPC_INTERNAL_H_
36 
37 #include "spdk/stdinc.h"
38 
39 #include "spdk/jsonrpc.h"
40 
41 #include "spdk_internal/log.h"
42 
43 #define SPDK_JSONRPC_RECV_BUF_SIZE	(32 * 1024)
44 #define SPDK_JSONRPC_SEND_BUF_SIZE	(32 * 1024)
45 #define SPDK_JSONRPC_MAX_CONNS		64
46 #define SPDK_JSONRPC_MAX_VALUES		1024
47 
48 struct spdk_jsonrpc_request {
49 	struct spdk_jsonrpc_server_conn *conn;
50 	const struct spdk_json_val *id;
51 };
52 
53 struct spdk_jsonrpc_server_conn {
54 	struct spdk_jsonrpc_server *server;
55 	int sockfd;
56 	struct spdk_json_val values[SPDK_JSONRPC_MAX_VALUES];
57 	size_t recv_len;
58 	uint8_t recv_buf[SPDK_JSONRPC_RECV_BUF_SIZE];
59 	size_t send_len;
60 	uint8_t send_buf[SPDK_JSONRPC_SEND_BUF_SIZE];
61 	struct spdk_json_write_ctx *json_writer;
62 	bool batch;
63 };
64 
65 struct spdk_jsonrpc_server {
66 	int sockfd;
67 	spdk_jsonrpc_handle_request_fn handle_request;
68 	struct spdk_jsonrpc_server_conn conns[SPDK_JSONRPC_MAX_CONNS];
69 	struct pollfd pollfds[SPDK_JSONRPC_MAX_CONNS + 1];
70 	int num_conns;
71 };
72 
73 /* jsonrpc_server_tcp */
74 int spdk_jsonrpc_server_write_cb(void *cb_ctx, const void *data, size_t size);
75 void spdk_jsonrpc_server_handle_request(struct spdk_jsonrpc_request *request,
76 					const struct spdk_json_val *method,
77 					const struct spdk_json_val *params);
78 void spdk_jsonrpc_server_handle_error(struct spdk_jsonrpc_request *request, int error);
79 
80 /* jsonrpc_server */
81 int spdk_jsonrpc_parse_request(struct spdk_jsonrpc_server_conn *conn, void *json, size_t size);
82 
83 #endif
84