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 const struct spdk_json_val *id; 55 56 /* Total space allocated for send_buf */ 57 size_t send_buf_size; 58 59 /* Number of bytes used in send_buf (<= send_buf_size) */ 60 size_t send_len; 61 62 size_t send_offset; 63 64 uint8_t *recv_buffer; 65 struct spdk_json_val *values; 66 size_t values_cnt; 67 68 uint8_t *send_buf; 69 70 STAILQ_ENTRY(spdk_jsonrpc_request) link; 71 }; 72 73 struct spdk_jsonrpc_server_conn { 74 struct spdk_jsonrpc_server *server; 75 int sockfd; 76 bool closed; 77 size_t recv_len; 78 uint8_t recv_buf[SPDK_JSONRPC_RECV_BUF_SIZE]; 79 uint32_t outstanding_requests; 80 81 pthread_spinlock_t queue_lock; 82 STAILQ_HEAD(, spdk_jsonrpc_request) send_queue; 83 84 struct spdk_jsonrpc_request *send_request; 85 86 spdk_jsonrpc_conn_closed_fn close_cb; 87 void *close_cb_ctx; 88 89 TAILQ_ENTRY(spdk_jsonrpc_server_conn) link; 90 }; 91 92 struct spdk_jsonrpc_server { 93 int sockfd; 94 spdk_jsonrpc_handle_request_fn handle_request; 95 96 TAILQ_HEAD(, spdk_jsonrpc_server_conn) free_conns; 97 TAILQ_HEAD(, spdk_jsonrpc_server_conn) conns; 98 99 struct spdk_jsonrpc_server_conn conns_array[SPDK_JSONRPC_MAX_CONNS]; 100 }; 101 102 struct spdk_jsonrpc_client_request { 103 /* Total space allocated for send_buf */ 104 size_t send_buf_size; 105 106 /* Number of bytes used in send_buf (<= send_buf_size) */ 107 size_t send_len; 108 109 size_t send_offset; 110 111 uint8_t *send_buf; 112 }; 113 114 struct spdk_jsonrpc_client_response_internal { 115 struct spdk_jsonrpc_client_response jsonrpc; 116 bool ready; 117 uint8_t *buf; 118 size_t values_cnt; 119 struct spdk_json_val values[]; 120 }; 121 122 struct spdk_jsonrpc_client { 123 int sockfd; 124 bool connected; 125 126 size_t recv_buf_size; 127 size_t recv_offset; 128 char *recv_buf; 129 130 /* Parsed response */ 131 struct spdk_jsonrpc_client_response_internal *resp; 132 struct spdk_jsonrpc_client_request *request; 133 }; 134 135 /* jsonrpc_server_tcp */ 136 void spdk_jsonrpc_server_handle_request(struct spdk_jsonrpc_request *request, 137 const struct spdk_json_val *method, 138 const struct spdk_json_val *params); 139 void spdk_jsonrpc_server_handle_error(struct spdk_jsonrpc_request *request, int error); 140 141 /* Might be called from any thread */ 142 void spdk_jsonrpc_server_send_response(struct spdk_jsonrpc_request *request); 143 144 /* jsonrpc_server */ 145 int spdk_jsonrpc_parse_request(struct spdk_jsonrpc_server_conn *conn, const void *json, 146 size_t size); 147 148 /* Must be called only from server poll thread */ 149 void spdk_jsonrpc_free_request(struct spdk_jsonrpc_request *request); 150 151 /* 152 * Parse JSON data as RPC command response. 153 * 154 * \param client structure pointer of jsonrpc client 155 * 156 * \return 0 On success. Negative error code in error 157 * -EAGAIN - If the provided data is not a complete JSON value (SPDK_JSON_PARSE_INCOMPLETE) 158 * -EINVAL - If the provided data has invalid JSON syntax and can't be parsed (SPDK_JSON_PARSE_INVALID). 159 * -ENOSPC - No space left to store parsed response. 160 */ 161 int spdk_jsonrpc_parse_response(struct spdk_jsonrpc_client *client); 162 163 #endif 164