LCOV - code coverage report
Current view: top level - spdk/lib/jsonrpc - jsonrpc_server_tcp.c (source / functions) Hit Total Coverage
Test: Combined Lines: 161 227 70.9 %
Date: 2024-07-15 21:04:32 Functions: 13 15 86.7 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 100 182 54.9 %

           Branch data     Line data    Source code
       1                 :            : /*   SPDX-License-Identifier: BSD-3-Clause
       2                 :            :  *   Copyright (C) 2016 Intel Corporation.
       3                 :            :  *   All rights reserved.
       4                 :            :  */
       5                 :            : 
       6                 :            : #include "jsonrpc_internal.h"
       7                 :            : #include "spdk/string.h"
       8                 :            : #include "spdk/util.h"
       9                 :            : 
      10                 :            : struct spdk_jsonrpc_server *
      11                 :       3543 : spdk_jsonrpc_server_listen(int domain, int protocol,
      12                 :            :                            struct sockaddr *listen_addr, socklen_t addrlen,
      13                 :            :                            spdk_jsonrpc_handle_request_fn handle_request)
      14                 :            : {
      15                 :            :         struct spdk_jsonrpc_server *server;
      16                 :       1577 :         int rc, val, i;
      17                 :            : 
      18                 :       3543 :         server = calloc(1, sizeof(struct spdk_jsonrpc_server));
      19         [ -  + ]:       3543 :         if (server == NULL) {
      20                 :          0 :                 return NULL;
      21                 :            :         }
      22                 :            : 
      23                 :       3543 :         TAILQ_INIT(&server->free_conns);
      24                 :       3543 :         TAILQ_INIT(&server->conns);
      25                 :            : 
      26         [ +  + ]:     230295 :         for (i = 0; i < SPDK_JSONRPC_MAX_CONNS; i++) {
      27                 :     226752 :                 TAILQ_INSERT_TAIL(&server->free_conns, &server->conns_array[i], link);
      28                 :            :         }
      29                 :            : 
      30                 :       3543 :         server->handle_request = handle_request;
      31                 :            : 
      32                 :       3543 :         server->sockfd = socket(domain, SOCK_STREAM | SOCK_NONBLOCK | SOCK_CLOEXEC, protocol);
      33         [ -  + ]:       3543 :         if (server->sockfd < 0) {
      34                 :          0 :                 SPDK_ERRLOG("socket() failed\n");
      35                 :          0 :                 free(server);
      36                 :          0 :                 return NULL;
      37                 :            :         }
      38                 :            : 
      39                 :       3543 :         val = 1;
      40                 :       3543 :         rc = setsockopt(server->sockfd, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
      41         [ -  + ]:       3543 :         if (rc != 0) {
      42                 :          0 :                 SPDK_ERRLOG("could not set SO_REUSEADDR sock option: %s\n", spdk_strerror(errno));
      43                 :          0 :                 close(server->sockfd);
      44                 :          0 :                 free(server);
      45                 :          0 :                 return NULL;
      46                 :            :         }
      47                 :            : 
      48                 :       3543 :         rc = bind(server->sockfd, listen_addr, addrlen);
      49         [ -  + ]:       3543 :         if (rc != 0) {
      50                 :          0 :                 SPDK_ERRLOG("could not bind JSON-RPC server: %s\n", spdk_strerror(errno));
      51                 :          0 :                 close(server->sockfd);
      52                 :          0 :                 free(server);
      53                 :          0 :                 return NULL;
      54                 :            :         }
      55                 :            : 
      56                 :       3543 :         rc = listen(server->sockfd, 512);
      57         [ -  + ]:       3543 :         if (rc != 0) {
      58                 :          0 :                 SPDK_ERRLOG("listen() failed, errno = %d\n", errno);
      59                 :          0 :                 close(server->sockfd);
      60                 :          0 :                 free(server);
      61                 :          0 :                 return NULL;
      62                 :            :         }
      63                 :            : 
      64                 :       3543 :         return server;
      65                 :            : }
      66                 :            : 
      67                 :            : static struct spdk_jsonrpc_request *
      68                 :     533472 : jsonrpc_server_dequeue_request(struct spdk_jsonrpc_server_conn *conn)
      69                 :            : {
      70                 :     533472 :         struct spdk_jsonrpc_request *request = NULL;
      71                 :            : 
      72         [ -  + ]:     533472 :         pthread_spin_lock(&conn->queue_lock);
      73                 :     533472 :         request = STAILQ_FIRST(&conn->send_queue);
      74         [ +  + ]:     533472 :         if (request) {
      75         [ +  - ]:      50879 :                 STAILQ_REMOVE_HEAD(&conn->send_queue, link);
      76                 :            :         }
      77         [ -  + ]:     533472 :         pthread_spin_unlock(&conn->queue_lock);
      78                 :     533472 :         return request;
      79                 :            : }
      80                 :            : 
      81                 :            : static void
      82                 :      35885 : jsonrpc_server_free_conn_request(struct spdk_jsonrpc_server_conn *conn)
      83                 :            : {
      84                 :            :         struct spdk_jsonrpc_request *request;
      85                 :            : 
      86                 :      35885 :         jsonrpc_free_request(conn->send_request);
      87                 :      35885 :         conn->send_request = NULL ;
      88                 :            : 
      89         [ -  + ]:      35885 :         pthread_spin_lock(&conn->queue_lock);
      90                 :            :         /* There might still be some requests being processed.
      91                 :            :          * We need to tell them that this connection is closed. */
      92         [ +  + ]:      35891 :         STAILQ_FOREACH(request, &conn->outstanding_queue, link) {
      93                 :          6 :                 request->conn = NULL;
      94                 :            :         }
      95         [ -  + ]:      35885 :         pthread_spin_unlock(&conn->queue_lock);
      96                 :            : 
      97         [ -  + ]:      35885 :         while ((request = jsonrpc_server_dequeue_request(conn)) != NULL) {
      98                 :          0 :                 jsonrpc_free_request(request);
      99                 :            :         }
     100                 :      35885 : }
     101                 :            : 
     102                 :            : static void
     103                 :      70504 : jsonrpc_server_conn_close(struct spdk_jsonrpc_server_conn *conn)
     104                 :            : {
     105                 :      70504 :         conn->closed = true;
     106                 :            : 
     107         [ +  + ]:      70504 :         if (conn->sockfd >= 0) {
     108                 :      35885 :                 jsonrpc_server_free_conn_request(conn);
     109                 :      35885 :                 close(conn->sockfd);
     110                 :      35885 :                 conn->sockfd = -1;
     111                 :            : 
     112         [ +  + ]:      35885 :                 if (conn->close_cb) {
     113                 :         20 :                         conn->close_cb(conn, conn->close_cb_ctx);
     114                 :            :                 }
     115                 :            :         }
     116                 :      70504 : }
     117                 :            : 
     118                 :            : void
     119                 :       3543 : spdk_jsonrpc_server_shutdown(struct spdk_jsonrpc_server *server)
     120                 :            : {
     121                 :            :         struct spdk_jsonrpc_server_conn *conn;
     122                 :            : 
     123                 :       3543 :         close(server->sockfd);
     124                 :            : 
     125         [ +  + ]:       4831 :         TAILQ_FOREACH(conn, &server->conns, link) {
     126                 :       1288 :                 jsonrpc_server_conn_close(conn);
     127                 :            :         }
     128                 :            : 
     129                 :       3543 :         free(server);
     130                 :       3543 : }
     131                 :            : 
     132                 :            : static void
     133                 :      34597 : jsonrpc_server_conn_remove(struct spdk_jsonrpc_server_conn *conn)
     134                 :            : {
     135                 :      34597 :         struct spdk_jsonrpc_server *server = conn->server;
     136                 :            : 
     137                 :      34597 :         jsonrpc_server_conn_close(conn);
     138                 :            : 
     139         [ -  + ]:      34597 :         pthread_spin_destroy(&conn->queue_lock);
     140         [ -  + ]:      34597 :         assert(STAILQ_EMPTY(&conn->send_queue));
     141                 :            : 
     142         [ +  + ]:      34597 :         TAILQ_REMOVE(&server->conns, conn, link);
     143         [ +  - ]:      34597 :         TAILQ_INSERT_HEAD(&server->free_conns, conn, link);
     144                 :      34597 : }
     145                 :            : 
     146                 :            : int
     147                 :         60 : spdk_jsonrpc_conn_add_close_cb(struct spdk_jsonrpc_server_conn *conn,
     148                 :            :                                spdk_jsonrpc_conn_closed_fn cb, void *ctx)
     149                 :            : {
     150                 :         60 :         int rc = 0;
     151                 :            : 
     152         [ -  + ]:         60 :         pthread_spin_lock(&conn->queue_lock);
     153         [ +  + ]:         60 :         if (conn->close_cb == NULL) {
     154                 :         20 :                 conn->close_cb = cb;
     155                 :         20 :                 conn->close_cb_ctx = ctx;
     156                 :            :         } else {
     157   [ +  -  +  + ]:         40 :                 rc = conn->close_cb == cb && conn->close_cb_ctx == ctx ? -EEXIST : -ENOSPC;
     158                 :            :         }
     159         [ -  + ]:         60 :         pthread_spin_unlock(&conn->queue_lock);
     160                 :            : 
     161                 :         60 :         return rc;
     162                 :            : }
     163                 :            : 
     164                 :            : int
     165                 :          0 : spdk_jsonrpc_conn_del_close_cb(struct spdk_jsonrpc_server_conn *conn,
     166                 :            :                                spdk_jsonrpc_conn_closed_fn cb, void *ctx)
     167                 :            : {
     168                 :          0 :         int rc = 0;
     169                 :            : 
     170         [ #  # ]:          0 :         pthread_spin_lock(&conn->queue_lock);
     171   [ #  #  #  #  :          0 :         if (conn->close_cb == NULL || conn->close_cb != cb || conn->close_cb_ctx != ctx) {
                   #  # ]
     172                 :          0 :                 rc = -ENOENT;
     173                 :            :         } else {
     174                 :          0 :                 conn->close_cb = NULL;
     175                 :            :         }
     176         [ #  # ]:          0 :         pthread_spin_unlock(&conn->queue_lock);
     177                 :            : 
     178                 :          0 :         return rc;
     179                 :            : }
     180                 :            : 
     181                 :            : static int
     182                 :    4721998 : jsonrpc_server_accept(struct spdk_jsonrpc_server *server)
     183                 :            : {
     184                 :            :         struct spdk_jsonrpc_server_conn *conn;
     185                 :            :         int rc, flag;
     186                 :            : 
     187                 :    4721998 :         rc = accept(server->sockfd, NULL, NULL);
     188         [ +  + ]:    4721998 :         if (rc >= 0) {
     189                 :      35885 :                 conn = TAILQ_FIRST(&server->free_conns);
     190         [ -  + ]:      35885 :                 assert(conn != NULL);
     191                 :            : 
     192                 :      35885 :                 conn->server = server;
     193                 :      35885 :                 conn->sockfd = rc;
     194                 :      35885 :                 conn->closed = false;
     195                 :      35885 :                 conn->recv_len = 0;
     196                 :      35885 :                 conn->outstanding_requests = 0;
     197                 :      35885 :                 STAILQ_INIT(&conn->send_queue);
     198                 :      35885 :                 STAILQ_INIT(&conn->outstanding_queue);
     199                 :      35885 :                 conn->send_request = NULL;
     200                 :            : 
     201   [ -  +  -  + ]:      35885 :                 if (pthread_spin_init(&conn->queue_lock, PTHREAD_PROCESS_PRIVATE)) {
     202                 :          0 :                         SPDK_ERRLOG("Unable to create queue lock for socket: %d", conn->sockfd);
     203                 :          0 :                         close(conn->sockfd);
     204                 :          0 :                         return -1;
     205                 :            :                 }
     206                 :            : 
     207                 :      35885 :                 flag = fcntl(conn->sockfd, F_GETFL);
     208         [ -  + ]:      35885 :                 if (fcntl(conn->sockfd, F_SETFL, flag | O_NONBLOCK) < 0) {
     209                 :          0 :                         SPDK_ERRLOG("fcntl can't set nonblocking mode for socket, fd: %d (%s)\n",
     210                 :            :                                     conn->sockfd, spdk_strerror(errno));
     211                 :          0 :                         close(conn->sockfd);
     212         [ #  # ]:          0 :                         pthread_spin_destroy(&conn->queue_lock);
     213                 :          0 :                         return -1;
     214                 :            :                 }
     215                 :            : 
     216         [ +  - ]:      35885 :                 TAILQ_REMOVE(&server->free_conns, conn, link);
     217                 :      35885 :                 TAILQ_INSERT_TAIL(&server->conns, conn, link);
     218                 :      35885 :                 return 0;
     219                 :            :         }
     220                 :            : 
     221   [ -  +  -  -  :    4686113 :         if (errno == EAGAIN || errno == EWOULDBLOCK || errno == EINTR) {
                   -  - ]
     222                 :    4686113 :                 return 0;
     223                 :            :         }
     224                 :            : 
     225                 :          0 :         return -1;
     226                 :            : }
     227                 :            : 
     228                 :            : void
     229                 :      50885 : jsonrpc_server_handle_request(struct spdk_jsonrpc_request *request,
     230                 :            :                               const struct spdk_json_val *method, const struct spdk_json_val *params)
     231                 :            : {
     232                 :      50885 :         request->conn->server->handle_request(request, method, params);
     233                 :      50885 : }
     234                 :            : 
     235                 :            : void
     236                 :          0 : jsonrpc_server_handle_error(struct spdk_jsonrpc_request *request, int error)
     237                 :            : {
     238                 :            :         const char *msg;
     239                 :            : 
     240   [ #  #  #  #  :          0 :         switch (error) {
                   #  # ]
     241                 :          0 :         case SPDK_JSONRPC_ERROR_PARSE_ERROR:
     242                 :          0 :                 msg = "Parse error";
     243                 :          0 :                 break;
     244                 :            : 
     245                 :          0 :         case SPDK_JSONRPC_ERROR_INVALID_REQUEST:
     246                 :          0 :                 msg = "Invalid request";
     247                 :          0 :                 break;
     248                 :            : 
     249                 :          0 :         case SPDK_JSONRPC_ERROR_METHOD_NOT_FOUND:
     250                 :          0 :                 msg = "Method not found";
     251                 :          0 :                 break;
     252                 :            : 
     253                 :          0 :         case SPDK_JSONRPC_ERROR_INVALID_PARAMS:
     254                 :          0 :                 msg = "Invalid parameters";
     255                 :          0 :                 break;
     256                 :            : 
     257                 :          0 :         case SPDK_JSONRPC_ERROR_INTERNAL_ERROR:
     258                 :          0 :                 msg = "Internal error";
     259                 :          0 :                 break;
     260                 :            : 
     261                 :          0 :         default:
     262                 :          0 :                 msg = "Error";
     263                 :          0 :                 break;
     264                 :            :         }
     265                 :            : 
     266                 :          0 :         spdk_jsonrpc_send_error_response(request, error, msg);
     267                 :          0 : }
     268                 :            : 
     269                 :            : static int
     270                 :    1635075 : jsonrpc_server_conn_recv(struct spdk_jsonrpc_server_conn *conn)
     271                 :            : {
     272                 :            :         ssize_t rc, offset;
     273                 :    1635075 :         size_t recv_avail = SPDK_JSONRPC_RECV_BUF_SIZE - conn->recv_len;
     274                 :            : 
     275                 :    1635075 :         rc = recv(conn->sockfd, conn->recv_buf + conn->recv_len, recv_avail, 0);
     276         [ +  + ]:    1635075 :         if (rc == -1) {
     277   [ -  +  -  -  :    1549601 :                 if (errno == EAGAIN || errno == EWOULDBLOCK || errno == EINTR) {
                   -  - ]
     278                 :    1549601 :                         return 0;
     279                 :            :                 }
     280   [ #  #  #  # ]:          0 :                 SPDK_DEBUGLOG(rpc, "recv() failed: %s\n", spdk_strerror(errno));
     281                 :          0 :                 return -1;
     282                 :            :         }
     283                 :            : 
     284         [ +  + ]:      85474 :         if (rc == 0) {
     285   [ -  +  +  + ]:      34589 :                 SPDK_DEBUGLOG(rpc, "remote closed connection\n");
     286                 :      34589 :                 conn->closed = true;
     287                 :      34589 :                 return 0;
     288                 :            :         }
     289                 :            : 
     290                 :      50885 :         conn->recv_len += rc;
     291                 :            : 
     292                 :      50885 :         offset = 0;
     293                 :            :         do {
     294                 :     101770 :                 rc = jsonrpc_parse_request(conn, conn->recv_buf + offset, conn->recv_len - offset);
     295         [ -  + ]:     101770 :                 if (rc < 0) {
     296                 :          0 :                         SPDK_ERRLOG("jsonrpc parse request failed\n");
     297                 :          0 :                         return -1;
     298                 :            :                 }
     299                 :            : 
     300                 :     101770 :                 offset += rc;
     301         [ +  + ]:     101770 :         } while (rc > 0);
     302                 :            : 
     303         [ +  - ]:      50885 :         if (offset > 0) {
     304                 :            :                 /*
     305                 :            :                  * Successfully parsed a requests - move any data past the end of the
     306                 :            :                  * parsed requests down to the beginning.
     307                 :            :                  */
     308         [ -  + ]:      50885 :                 assert((size_t)offset <= conn->recv_len);
     309   [ -  +  -  + ]:      50885 :                 memmove(conn->recv_buf, conn->recv_buf + offset, conn->recv_len - offset);
     310                 :      50885 :                 conn->recv_len -= offset;
     311                 :            :         }
     312                 :            : 
     313                 :      50885 :         return 0;
     314                 :            : }
     315                 :            : 
     316                 :            : void
     317                 :      50879 : jsonrpc_server_send_response(struct spdk_jsonrpc_request *request)
     318                 :            : {
     319                 :      50879 :         struct spdk_jsonrpc_server_conn *conn = request->conn;
     320                 :            : 
     321         [ -  + ]:      50879 :         if (conn == NULL) {
     322                 :            :                 /* We cannot respond to the request, because the connection is closed. */
     323                 :          0 :                 SPDK_WARNLOG("Unable to send response: connection closed.\n");
     324                 :          0 :                 jsonrpc_free_request(request);
     325                 :          0 :                 return;
     326                 :            :         }
     327                 :            : 
     328                 :            :         /* Queue the response to be sent */
     329         [ -  + ]:      50879 :         pthread_spin_lock(&conn->queue_lock);
     330   [ +  -  +  -  :      50879 :         STAILQ_REMOVE(&conn->outstanding_queue, request, spdk_jsonrpc_request, link);
             -  -  -  - ]
     331                 :      50879 :         STAILQ_INSERT_TAIL(&conn->send_queue, request, link);
     332         [ -  + ]:      50879 :         pthread_spin_unlock(&conn->queue_lock);
     333                 :            : }
     334                 :            : 
     335                 :            : 
     336                 :            : static int
     337                 :    1652247 : jsonrpc_server_conn_send(struct spdk_jsonrpc_server_conn *conn)
     338                 :            : {
     339                 :            :         struct spdk_jsonrpc_request *request;
     340                 :            :         ssize_t rc;
     341                 :            : 
     342                 :    1689873 : more:
     343         [ +  + ]:    1689873 :         if (conn->outstanding_requests == 0) {
     344                 :    1192286 :                 return 0;
     345                 :            :         }
     346                 :            : 
     347         [ +  - ]:     497587 :         if (conn->send_request == NULL) {
     348                 :     497587 :                 conn->send_request = jsonrpc_server_dequeue_request(conn);
     349                 :            :         }
     350                 :            : 
     351                 :     497587 :         request = conn->send_request;
     352         [ +  + ]:     497587 :         if (request == NULL) {
     353                 :            :                 /* Nothing to send right now */
     354                 :     446708 :                 return 0;
     355                 :            :         }
     356                 :            : 
     357         [ +  - ]:      50879 :         if (request->send_offset == 0) {
     358                 :            :                 /* A byte for the null terminator is included in the send buffer. */
     359                 :      50879 :                 request->send_buf[request->send_len] = '\0';
     360                 :            :         }
     361                 :            : 
     362         [ +  - ]:      50879 :         if (request->send_len > 0) {
     363                 :      50879 :                 rc = send(conn->sockfd, request->send_buf + request->send_offset,
     364                 :            :                           request->send_len, 0);
     365         [ +  + ]:      50879 :                 if (rc < 0) {
     366   [ +  -  +  -  :         22 :                         if (errno == EAGAIN || errno == EWOULDBLOCK || errno == EINTR) {
                   -  + ]
     367                 :          0 :                                 return 0;
     368                 :            :                         }
     369                 :            : 
     370   [ -  +  -  + ]:         22 :                         SPDK_DEBUGLOG(rpc, "send() failed: %s\n", spdk_strerror(errno));
     371                 :         22 :                         return -1;
     372                 :            :                 }
     373                 :            : 
     374                 :      50857 :                 request->send_offset += rc;
     375                 :      50857 :                 request->send_len -= rc;
     376                 :            :         }
     377                 :            : 
     378         [ +  - ]:      50857 :         if (request->send_len == 0) {
     379                 :            :                 /*
     380                 :            :                  * Full response has been sent.
     381                 :            :                  * Free it and set send_request to NULL to move on to the next queued response.
     382                 :            :                  */
     383                 :      50857 :                 conn->send_request = NULL;
     384                 :      50857 :                 jsonrpc_complete_request(request);
     385                 :      50857 :                 goto more;
     386                 :            :         }
     387                 :            : 
     388                 :          0 :         return 0;
     389                 :            : }
     390                 :            : 
     391                 :            : int
     392                 :    4721998 : spdk_jsonrpc_server_poll(struct spdk_jsonrpc_server *server)
     393                 :            : {
     394                 :            :         int rc;
     395                 :            :         struct spdk_jsonrpc_server_conn *conn, *conn_tmp;
     396                 :            : 
     397         [ +  + ]:    6359726 :         TAILQ_FOREACH_SAFE(conn, &server->conns, link, conn_tmp) {
     398                 :            :                 /* If we can't receive and there are no outstanding requests close the connection. */
     399   [ +  +  +  +  :    1637728 :                 if (conn->closed == true && conn->outstanding_requests == 0) {
                   +  + ]
     400                 :      34597 :                         jsonrpc_server_conn_close(conn);
     401                 :            :                 }
     402                 :            : 
     403   [ +  +  +  - ]:    1637728 :                 if (conn->sockfd == -1 && conn->outstanding_requests == 0) {
     404                 :      34597 :                         jsonrpc_server_conn_remove(conn);
     405                 :            :                 }
     406                 :            :         }
     407                 :            : 
     408                 :            :         /* Check listen socket */
     409         [ +  - ]:    4721998 :         if (!TAILQ_EMPTY(&server->free_conns)) {
     410                 :    4721998 :                 jsonrpc_server_accept(server);
     411                 :            :         }
     412                 :            : 
     413         [ +  + ]:    6361014 :         TAILQ_FOREACH(conn, &server->conns, link) {
     414         [ -  + ]:    1639016 :                 if (conn->sockfd == -1) {
     415                 :          0 :                         continue;
     416                 :            :                 }
     417                 :            : 
     418                 :    1639016 :                 rc = jsonrpc_server_conn_send(conn);
     419         [ +  + ]:    1639016 :                 if (rc != 0) {
     420                 :         22 :                         jsonrpc_server_conn_close(conn);
     421                 :         22 :                         continue;
     422                 :            :                 }
     423                 :            : 
     424   [ +  +  +  + ]:    1638994 :                 if (!conn->closed) {
     425                 :    1635075 :                         rc = jsonrpc_server_conn_recv(conn);
     426         [ -  + ]:    1635075 :                         if (rc != 0) {
     427                 :          0 :                                 jsonrpc_server_conn_close(conn);
     428                 :            :                         }
     429                 :            :                 }
     430                 :            :         }
     431                 :            : 
     432                 :    4721998 :         return 0;
     433                 :            : }

Generated by: LCOV version 1.14