xref: /spdk/lib/jsonrpc/jsonrpc_internal.h (revision b961d9cc12de49251d135307eaa05ec0fc9dd2fa)
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_server_conn {
49 	struct spdk_jsonrpc_server *server;
50 	int sockfd;
51 	struct spdk_json_val values[SPDK_JSONRPC_MAX_VALUES];
52 	size_t recv_len;
53 	uint8_t recv_buf[SPDK_JSONRPC_RECV_BUF_SIZE];
54 	size_t send_len;
55 	uint8_t send_buf[SPDK_JSONRPC_SEND_BUF_SIZE];
56 	struct spdk_json_write_ctx *json_writer;
57 	bool batch;
58 };
59 
60 struct spdk_jsonrpc_server {
61 	int sockfd;
62 	spdk_jsonrpc_handle_request_fn handle_request;
63 	struct spdk_jsonrpc_server_conn conns[SPDK_JSONRPC_MAX_CONNS];
64 	struct pollfd pollfds[SPDK_JSONRPC_MAX_CONNS + 1];
65 	int num_conns;
66 };
67 
68 /* jsonrpc_server_tcp */
69 int spdk_jsonrpc_server_write_cb(void *cb_ctx, const void *data, size_t size);
70 void spdk_jsonrpc_server_handle_request(struct spdk_jsonrpc_server_conn *conn,
71 					const struct spdk_json_val *method,
72 					const struct spdk_json_val *params,
73 					const struct spdk_json_val *id);
74 void spdk_jsonrpc_server_handle_error(struct spdk_jsonrpc_server_conn *conn, int error,
75 				      const struct spdk_json_val *method,
76 				      const struct spdk_json_val *params,
77 				      const struct spdk_json_val *id);
78 
79 /* jsonrpc_server */
80 int spdk_jsonrpc_parse_request(struct spdk_jsonrpc_server_conn *conn, void *json, size_t size);
81 
82 #endif
83