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