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 struct spdk_jsonrpc_client_request { 98 /* Total space allocated for send_buf */ 99 size_t send_buf_size; 100 101 /* Number of bytes used in send_buf (<= send_buf_size) */ 102 size_t send_len; 103 104 size_t send_offset; 105 106 uint8_t *send_buf; 107 }; 108 109 struct spdk_jsonrpc_client_response_internal { 110 struct spdk_jsonrpc_client_response jsonrpc; 111 bool ready; 112 uint8_t *buf; 113 size_t values_cnt; 114 struct spdk_json_val values[]; 115 }; 116 117 struct spdk_jsonrpc_client { 118 int sockfd; 119 120 size_t recv_buf_size; 121 size_t recv_offset; 122 char *recv_buf; 123 124 /* Parsed response */ 125 struct spdk_jsonrpc_client_response_internal *resp; 126 struct spdk_jsonrpc_client_request *request; 127 }; 128 129 /* jsonrpc_server_tcp */ 130 void spdk_jsonrpc_server_handle_request(struct spdk_jsonrpc_request *request, 131 const struct spdk_json_val *method, 132 const struct spdk_json_val *params); 133 void spdk_jsonrpc_server_handle_error(struct spdk_jsonrpc_request *request, int error); 134 135 /* Might be called from any thread */ 136 void spdk_jsonrpc_server_send_response(struct spdk_jsonrpc_request *request); 137 138 /* jsonrpc_server */ 139 int spdk_jsonrpc_parse_request(struct spdk_jsonrpc_server_conn *conn, void *json, size_t size); 140 141 /* Must be called only from server poll thread */ 142 void spdk_jsonrpc_free_request(struct spdk_jsonrpc_request *request); 143 144 /* 145 * Parse JSON data as RPC command response. 146 * 147 * \param client structure pointer of jsonrpc client 148 * 149 * \return 0 On success. Negative error code in error 150 * -EAGAIN - If the provided data is not a complete JSON value (SPDK_JSON_PARSE_INCOMPLETE) 151 * -EINVAL - If the provided data has invalid JSON syntax and can't be parsed (SPDK_JSON_PARSE_INVALID). 152 * -ENOSPC - No space left to store parsed response. 153 */ 154 int spdk_jsonrpc_parse_response(struct spdk_jsonrpc_client *client); 155 156 #endif 157