xref: /spdk/lib/jsonrpc/jsonrpc_internal.h (revision 8a0a98d35e21f282088edf28b9e8da66ec390e3a)
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_INIT	(32 * 1024)
45 #define SPDK_JSONRPC_SEND_BUF_SIZE_MAX	(32 * 1024 * 1024)
46 #define SPDK_JSONRPC_ID_MAX_LEN		128
47 #define SPDK_JSONRPC_MAX_CONNS		64
48 #define SPDK_JSONRPC_MAX_VALUES		1024
49 
50 struct spdk_jsonrpc_request {
51 	struct spdk_jsonrpc_server_conn *conn;
52 
53 	/* Copy of request id value */
54 	struct spdk_json_val id;
55 	uint8_t id_data[SPDK_JSONRPC_ID_MAX_LEN];
56 
57 	/* Total space allocated for send_buf */
58 	size_t send_buf_size;
59 
60 	/* Number of bytes used in send_buf (<= send_buf_size) */
61 	size_t send_len;
62 
63 	size_t send_offset;
64 
65 	uint8_t *send_buf;
66 
67 	STAILQ_ENTRY(spdk_jsonrpc_request) link;
68 };
69 
70 struct spdk_jsonrpc_server_conn {
71 	struct spdk_jsonrpc_server *server;
72 	int sockfd;
73 	bool closed;
74 	struct spdk_json_val values[SPDK_JSONRPC_MAX_VALUES];
75 	size_t recv_len;
76 	uint8_t recv_buf[SPDK_JSONRPC_RECV_BUF_SIZE];
77 	uint32_t outstanding_requests;
78 
79 	pthread_spinlock_t queue_lock;
80 	STAILQ_HEAD(, spdk_jsonrpc_request) send_queue;
81 
82 	struct spdk_jsonrpc_request *send_request;
83 
84 	TAILQ_ENTRY(spdk_jsonrpc_server_conn) link;
85 };
86 
87 struct spdk_jsonrpc_server {
88 	int sockfd;
89 	spdk_jsonrpc_handle_request_fn handle_request;
90 
91 	TAILQ_HEAD(, spdk_jsonrpc_server_conn) free_conns;
92 	TAILQ_HEAD(, spdk_jsonrpc_server_conn) conns;
93 
94 	struct spdk_jsonrpc_server_conn conns_array[SPDK_JSONRPC_MAX_CONNS];
95 };
96 
97 /* jsonrpc_server_tcp */
98 void spdk_jsonrpc_server_handle_request(struct spdk_jsonrpc_request *request,
99 					const struct spdk_json_val *method,
100 					const struct spdk_json_val *params);
101 void spdk_jsonrpc_server_handle_error(struct spdk_jsonrpc_request *request, int error);
102 void spdk_jsonrpc_server_send_response(struct spdk_jsonrpc_server_conn *conn,
103 				       struct spdk_jsonrpc_request *request);
104 
105 /* jsonrpc_server */
106 int spdk_jsonrpc_parse_request(struct spdk_jsonrpc_server_conn *conn, void *json, size_t size);
107 void spdk_jsonrpc_free_request(struct spdk_jsonrpc_request *request);
108 
109 #endif
110