Changeset 4392 for pjproject/branches/1.x/pjlib/src/pj/ssl_sock_ossl.c

Timestamp:

Feb 27, 2013 11:42:24 AM (12 years ago)

Author:

ming

Message:

Re #1573: Backported to 1.x

Location:

pjproject/branches/1.x

Files:

• . (modified) (1 prop)
• pjlib/src/pj/ssl_sock_ossl.c (modified) (25 diffs)

pjproject/branches/1.x/pjlib/src/pj/ssl_sock_ossl.c

@@ -106 +106 @@
 
 /*
- * Structure of SSL socket write buffer.
+ * Structure of SSL socket write data.
  */
 typedef struct write_data_t {
+    PJ_DECL_LIST_MEMBER(struct write_data_t);
     pj_ioqueue_op_key_t  key;
     pj_size_t            record_len;
@@ -122 +123 @@
 
 /*
- * Structure of SSL socket write state.
- */
-typedef struct write_state_t {
+ * Structure of SSL socket write buffer (circular buffer).
+ */
+typedef struct send_buf_t {
     char                *buf;
     pj_size_t            max_len;    
     char                *start;
     pj_size_t            len;
-    write_data_t        *last_data;
-} write_state_t;
-
-/*
- * Structure of write data pending.
- */
-typedef struct write_pending_t {
-    PJ_DECL_LIST_MEMBER(struct write_pending_t);
-    write_data_t         data;
-} write_pending_t;
+} send_buf_t;
 
 /*
@@ -174 +166 @@
     read_data_t          *ssock_rbuf;
 
-    write_state_t         write_state;
-    write_pending_t       write_pending;
-    write_pending_t       write_pending_empty;
-    pj_lock_t            *write_mutex; /* protect write BIO and write_state */
+    write_data_t          write_pending;/* list of pending write to OpenSSL */
+    write_data_t          write_pending_empty; /* cache for write_pending   */
+    pj_bool_t             flushing_write_pend; /* flag of flushing is ongoing*/
+    send_buf_t            send_buf;
+    write_data_t          send_pending; /* list of pending write to network */
+    pj_lock_t            *write_mutex;  /* protect write BIO and send_buf   */
 
     SSL_CTX              *ossl_ctx;
@@ -198 +192 @@
 
 
+static write_data_t* alloc_send_data(pj_ssl_sock_t *ssock, pj_size_t len);
+static void free_send_data(pj_ssl_sock_t *ssock, write_data_t *wdata);
 static pj_status_t flush_delayed_send(pj_ssl_sock_t *ssock);
 
@@ -1055 +1051 @@
 }
 
+static write_data_t* alloc_send_data(pj_ssl_sock_t *ssock, pj_size_t len)
+{
+    send_buf_t *send_buf = &ssock->send_buf;
+    pj_size_t avail_len, skipped_len = 0;
+    char *reg1, *reg2;
+    pj_size_t reg1_len, reg2_len;
+    write_data_t *p;
+
+    /* Check buffer availability */
+    avail_len = send_buf->max_len - send_buf->len;
+    if (avail_len < len)
+        return NULL;
+
+    /* If buffer empty, reset start pointer and return it */
+    if (send_buf->len == 0) {
+        send_buf->start = send_buf->buf;
+        send_buf->len   = len;
+        p = (write_data_t*)send_buf->start;
+        goto init_send_data;
+    }
+
+    /* Free space may be wrapped/splitted into two regions, so let's
+     * analyze them if any region can hold the write data.
+     */
+    reg1 = send_buf->start + send_buf->len;
+    if (reg1 >= send_buf->buf + send_buf->max_len)
+        reg1 -= send_buf->max_len;
+    reg1_len = send_buf->max_len - send_buf->len;
+    if (reg1 + reg1_len > send_buf->buf + send_buf->max_len) {
+        reg1_len = send_buf->buf + send_buf->max_len - reg1;
+        reg2 = send_buf->buf;
+        reg2_len = send_buf->start - send_buf->buf;
+    } else {
+        reg2 = NULL;
+        reg2_len = 0;
+    }
+
+    /* More buffer availability check, note that the write data must be in
+     * a contigue buffer.
+     */
+    avail_len = PJ_MAX(reg1_len, reg2_len);
+    if (avail_len < len)
+        return NULL;
+
+    /* Get the data slot */
+    if (reg1_len >= len) {
+        p = (write_data_t*)reg1;
+    } else {
+        p = (write_data_t*)reg2;
+        skipped_len = reg1_len;
+    }
+
+    /* Update buffer length */
+    send_buf->len += len + skipped_len;
+
+init_send_data:
+    /* Init the new send data */
+    pj_bzero(p, sizeof(*p));
+    pj_list_init(p);
+    pj_list_push_back(&ssock->send_pending, p);
+
+    return p;
+}
+
+static void free_send_data(pj_ssl_sock_t *ssock, write_data_t *wdata)
+{
+    send_buf_t *buf = &ssock->send_buf;
+    write_data_t *spl = &ssock->send_pending;
+
+    pj_assert(!pj_list_empty(&ssock->send_pending));
+    
+    /* Free slot from the buffer */
+    if (spl->next == wdata && spl->prev == wdata) {
+        /* This is the only data, reset the buffer */
+        buf->start = buf->buf;
+        buf->len = 0;
+    } else if (spl->next == wdata) {
+        /* This is the first data, shift start pointer of the buffer and
+         * adjust the buffer length.
+         */
+        buf->start = (char*)wdata->next;
+        if (wdata->next > wdata) {
+            buf->len -= ((char*)wdata->next - buf->start);
+        } else {
+            /* Overlapped */
+            unsigned right_len, left_len;
+            right_len = buf->buf + buf->max_len - (char*)wdata;
+            left_len  = (char*)wdata->next - buf->buf;
+            buf->len -= (right_len + left_len);
+        }
+    } else if (spl->prev == wdata) {
+        /* This is the last data, just adjust the buffer length */
+        if (wdata->prev < wdata) {
+            unsigned jump_len;
+            jump_len = (char*)wdata -
+                       ((char*)wdata->prev + wdata->prev->record_len);
+            buf->len -= (wdata->record_len + jump_len);
+        } else {
+            /* Overlapped */
+            unsigned right_len, left_len;
+            right_len = buf->buf + buf->max_len -
+                        ((char*)wdata->prev + wdata->prev->record_len);
+            left_len  = (char*)wdata + wdata->record_len - buf->buf;
+            buf->len -= (right_len + left_len);
+        }
+    }
+    /* For data in the middle buffer, just do nothing on the buffer. The slot
+     * will be freed later when freeing the first/last data.
+     */
+    
+    /* Remove the data from send pending list */
+    pj_list_erase(wdata);
+}
+
+#if 0
+/* Just for testing send buffer alloc/free */
+#include <pj/rand.h>
+pj_status_t pj_ssl_sock_ossl_test_send_buf(pj_pool_t *pool)
+{
+    enum { MAX_CHUNK_NUM = 20 };
+    unsigned chunk_size, chunk_cnt, i;
+    write_data_t *wdata[MAX_CHUNK_NUM] = {0};
+    pj_time_val now;
+    pj_ssl_sock_t *ssock = NULL;
+    pj_ssl_sock_param param;
+    pj_status_t status;
+
+    pj_gettimeofday(&now);
+    pj_srand((unsigned)now.sec);
+
+    pj_ssl_sock_param_default(&param);
+    status = pj_ssl_sock_create(pool, &param, &ssock);
+    if (status != PJ_SUCCESS) {
+        return status;
+    }
+
+    if (ssock->send_buf.max_len == 0) {
+        ssock->send_buf.buf = (char*)
+                              pj_pool_alloc(ssock->pool, 
+                                            ssock->param.send_buffer_size);
+        ssock->send_buf.max_len = ssock->param.send_buffer_size;
+        ssock->send_buf.start = ssock->send_buf.buf;
+        ssock->send_buf.len = 0;
+    }
+
+    chunk_size = ssock->param.send_buffer_size / MAX_CHUNK_NUM / 2;
+    chunk_cnt = 0;
+    for (i = 0; i < MAX_CHUNK_NUM; i++) {
+        wdata[i] = alloc_send_data(ssock, pj_rand() % chunk_size + 321);
+        if (wdata[i])
+            chunk_cnt++;
+        else
+            break;
+    }
+
+    while (chunk_cnt) {
+        i = pj_rand() % MAX_CHUNK_NUM;
+        if (wdata[i]) {
+            free_send_data(ssock, wdata[i]);
+            wdata[i] = NULL;
+            chunk_cnt--;
+        }
+    }
+
+    if (ssock->send_buf.len != 0)
+        status = PJ_EBUG;
+
+    pj_ssl_sock_close(ssock);
+    return status;
+}
+#endif
+
+
 /* Flush write BIO to network socket. Note that any access to write BIO
  * MUST be serialized, so mutex protection must cover any call to OpenSSL
@@ -1068 +1237 @@
     char *data;
     pj_ssize_t len;
-
-    write_state_t *write_st = &ssock->write_state;
     write_data_t *wdata;
-    pj_size_t avail_len, needed_len, skipped_len = 0;
+    pj_size_t needed_len;
     pj_status_t status;
 
+    pj_lock_acquire(ssock->write_mutex);
+
     /* Check if there is data in write BIO, flush it if any */
-    if (!BIO_pending(ssock->ossl_wbio))
+    if (!BIO_pending(ssock->ossl_wbio)) {
+        pj_lock_release(ssock->write_mutex);
         return PJ_SUCCESS;
+    }
 
     /* Get data and its length */
     len = BIO_get_mem_data(ssock->ossl_wbio, &data);
-    if (len == 0)
+    if (len == 0) {
+        pj_lock_release(ssock->write_mutex);
         return PJ_SUCCESS;
+    }
 
     /* Calculate buffer size needed, and align it to 8 */
@@ -1087 +1260 @@
     needed_len = ((needed_len + 7) >> 3) << 3;
 
-    /* Check buffer availability */
-    avail_len = write_st->max_len - write_st->len;
-    if (avail_len < needed_len)
+    /* Allocate buffer for send data */
+    wdata = alloc_send_data(ssock, needed_len);
+    if (wdata == NULL) {
+        pj_lock_release(ssock->write_mutex);
         return PJ_ENOMEM;
-
-    /* More buffer availability check, note that the write data must be in
-     * a contigue buffer.
-     */
-    if (write_st->len == 0) {
-
-        write_st->start = write_st->buf;
-        wdata = (write_data_t*)write_st->start;
-
-    } else {
-
-        char *reg1, *reg2;
-        pj_size_t reg1_len, reg2_len;
-
-        /* Unused slots may be wrapped/splitted into two regions, so let's
-         * analyze them if any region can hold the write data.
-         */
-        reg1 = write_st->start + write_st->len;
-        if (reg1 >= write_st->buf + write_st->max_len)
-            reg1 -= write_st->max_len;
-        reg1_len = write_st->max_len - write_st->len;
-        if (reg1 + reg1_len > write_st->buf + write_st->max_len) {
-            reg1_len = write_st->buf + write_st->max_len - reg1;
-            reg2 = write_st->buf;
-            reg2_len = write_st->start - write_st->buf;
-        } else {
-            reg2 = NULL;
-            reg2_len = 0;
-        }
-        avail_len = PJ_MAX(reg1_len, reg2_len);
-        if (avail_len < needed_len)
-            return PJ_ENOMEM;
-
-        /* Get write data pointer and update buffer length */
-        if (reg1_len >= needed_len) {
-            wdata = (write_data_t*)reg1;
-        } else {
-            wdata = (write_data_t*)reg2;
-            /* Unused slot in region 1 is skipped as current write data
-             * doesn't fit it.
-             */
-            skipped_len = reg1_len;
-        }
-    }
-
-    /* Copy the data and set its properties into the buffer */
-    pj_bzero(wdata, sizeof(write_data_t));
+    }
+
+    /* Copy the data and set its properties into the send data */
+    pj_ioqueue_op_key_init(&wdata->key, sizeof(pj_ioqueue_op_key_t));
+    wdata->key.user_data = wdata;
     wdata->app_key = send_key;
     wdata->record_len = needed_len;
@@ -1144 +1276 @@
     wdata->flags = flags;
     pj_memcpy(&wdata->data, data, len);
+
+    /* Reset write BIO */
+    BIO_reset(ssock->ossl_wbio);
+
+    /* Ticket #1573: Don't hold mutex while calling PJLIB socket send(). */
+    pj_lock_release(ssock->write_mutex);
 
     /* Send it */
@@ -1158 +1296 @@
     }
 
-    /* Oh no, EWOULDBLOCK! */
-    if (status == PJ_STATUS_FROM_OS(OSERR_EWOULDBLOCK)) {
-        /* Just return PJ_SUCCESS here, the pending data will be sent in next
-         * call of this function since the data is still stored in write BIO.
+    if (status != PJ_EPENDING) {
+        /* When the sending is not pending, remove the wdata from send
+         * pending list.
          */
-        return PJ_SUCCESS;
-    }
-
-    /* Reset write BIO after flushed */
-    BIO_reset(ssock->ossl_wbio);
-
-    if (status == PJ_EPENDING) {
-        /* Update write state */
-        pj_assert(skipped_len==0 || write_st->last_data);
-        write_st->len += needed_len + skipped_len;
-        if (write_st->last_data)
-            write_st->last_data->record_len += skipped_len;
-        write_st->last_data = wdata;
+        pj_lock_acquire(ssock->write_mutex);
+        free_send_data(ssock, wdata);
+        pj_lock_release(ssock->write_mutex);
     }
 
@@ -1214 +1341 @@
     int err;
 
+    /* Perform SSL handshake */
     pj_lock_acquire(ssock->write_mutex);
-
-    /* Perform SSL handshake */
     err = SSL_do_handshake(ssock->ossl_ssl);
+    pj_lock_release(ssock->write_mutex);
 
     /* SSL_do_handshake() may put some pending data into SSL write BIO, 
@@ -1224 +1351 @@
     status = flush_write_bio(ssock, &ssock->handshake_op_key, 0, 0);
     if (status != PJ_SUCCESS && status != PJ_EPENDING) {
-        pj_lock_release(ssock->write_mutex);
         return status;
     }
-
-    pj_lock_release(ssock->write_mutex);
 
     if (err < 0) {
@@ -1357 +1481 @@
                     update_certs_info(ssock);
 
-                    pj_lock_acquire(ssock->write_mutex);
+                    // Ticket #1573: Don't hold mutex while calling
+                    //               PJLIB socket send(). 
+                    //pj_lock_acquire(ssock->write_mutex);
                     status = flush_delayed_send(ssock);
-                    pj_lock_release(ssock->write_mutex);
+                    //pj_lock_release(ssock->write_mutex);
+
+                    /* If flushing is ongoing, treat it as success */
+                    if (status == PJ_EBUSY)
+                        status = PJ_SUCCESS;
 
                     if (status != PJ_SUCCESS && status != PJ_EPENDING) {
@@ -1419 +1549 @@
     } else if (send_key != &ssock->handshake_op_key) {
         /* Some data has been sent, notify application */
-        write_data_t *wdata = (write_data_t*)send_key;
+        write_data_t *wdata = (write_data_t*)send_key->user_data;
         if (ssock->param.cb.on_data_sent) {
             pj_bool_t ret;
@@ -1432 +1562 @@
         /* Update write buffer state */
         pj_lock_acquire(ssock->write_mutex);
-        ssock->write_state.start += wdata->record_len;
-        ssock->write_state.len -= wdata->record_len;
-        if (ssock->write_state.last_data == wdata) {
-            pj_assert(ssock->write_state.len == 0);
-            ssock->write_state.last_data = NULL;
-        }
+        free_send_data(ssock, wdata);
         pj_lock_release(ssock->write_mutex);
 
@@ -1548 +1673 @@
 
     /* Prepare write/send state */
-    pj_assert(ssock->write_state.max_len == 0);
-    ssock->write_state.buf = (char*)
-                             pj_pool_alloc(ssock->pool, 
-                                           ssock->param.send_buffer_size);
-    ssock->write_state.max_len = ssock->param.send_buffer_size;
-    ssock->write_state.start = ssock->write_state.buf;
-    ssock->write_state.len = 0;
+    pj_assert(ssock->send_buf.max_len == 0);
+    ssock->send_buf.buf = (char*)
+                          pj_pool_alloc(ssock->pool, 
+                                        ssock->param.send_buffer_size);
+    ssock->send_buf.max_len = ssock->param.send_buffer_size;
+    ssock->send_buf.start = ssock->send_buf.buf;
+    ssock->send_buf.len = 0;
 
     /* Start handshake timer */
@@ -1627 +1752 @@
 
     /* Prepare write/send state */
-    pj_assert(ssock->write_state.max_len == 0);
-    ssock->write_state.buf = (char*)
+    pj_assert(ssock->send_buf.max_len == 0);
+    ssock->send_buf.buf = (char*)
                              pj_pool_alloc(ssock->pool, 
                                            ssock->param.send_buffer_size);
-    ssock->write_state.max_len = ssock->param.send_buffer_size;
-    ssock->write_state.start = ssock->write_state.buf;
-    ssock->write_state.len = 0;
+    ssock->send_buf.max_len = ssock->param.send_buffer_size;
+    ssock->send_buf.start = ssock->send_buf.buf;
+    ssock->send_buf.len = 0;
 
 #ifdef SSL_set_tlsext_host_name
@@ -1806 +1931 @@
     pj_list_init(&ssock->write_pending);
     pj_list_init(&ssock->write_pending_empty);
+    pj_list_init(&ssock->send_pending);
     pj_timer_entry_init(&ssock->timer, 0, ssock, &on_timer);
+    pj_ioqueue_op_key_init(&ssock->handshake_op_key,
+                           sizeof(pj_ioqueue_op_key_t));
 
     /* Create secure socket mutex */
@@ -2039 +2167 @@
 }
 
-/* Write plain data to SSL and flush write BIO. Note that accessing
- * write BIO must be serialized, so a call to this function must be
- * protected by write mutex of SSL socket.
- */
+/* Write plain data to SSL and flush write BIO. */
 static pj_status_t ssl_write(pj_ssl_sock_t *ssock, 
                              pj_ioqueue_op_key_t *send_key,
@@ -2057 +2182 @@
      * until re-negotiation is completed.
      */
+    pj_lock_acquire(ssock->write_mutex);
     nwritten = SSL_write(ssock->ossl_ssl, data, size);
+    pj_lock_release(ssock->write_mutex);
     
     if (nwritten == size) {
@@ -2088 +2215 @@
 }
 
-/* Flush delayed data sending in the write pending list. Note that accessing
- * write pending list must be serialized, so a call to this function must be
- * protected by write mutex of SSL socket.
- */
+/* Flush delayed data sending in the write pending list. */
 static pj_status_t flush_delayed_send(pj_ssl_sock_t *ssock)
 {
+    /* Check for another ongoing flush */
+    if (ssock->flushing_write_pend)
+        return PJ_EBUSY;
+
+    pj_lock_acquire(ssock->write_mutex);
+
+    /* Again, check for another ongoing flush */
+    if (ssock->flushing_write_pend) {
+        pj_lock_release(ssock->write_mutex);
+        return PJ_EBUSY;
+    }
+
+    /* Set ongoing flush flag */
+    ssock->flushing_write_pend = PJ_TRUE;
+
     while (!pj_list_empty(&ssock->write_pending)) {
-        write_pending_t *wp;
+        write_data_t *wp;
         pj_status_t status;
 
         wp = ssock->write_pending.next;
 
-        status = ssl_write(ssock, &wp->data.key, wp->data.data.ptr, 
-                           wp->data.plain_data_len, wp->data.flags);
-        if (status != PJ_SUCCESS)
+        /* Ticket #1573: Don't hold mutex while calling socket send. */
+        pj_lock_release(ssock->write_mutex);
+
+        status = ssl_write(ssock, &wp->key, wp->data.ptr, 
+                           wp->plain_data_len, wp->flags);
+        if (status != PJ_SUCCESS) {
+            /* Reset ongoing flush flag first. */
+            ssock->flushing_write_pend = PJ_FALSE;
             return status;
-
+        }
+
+        pj_lock_acquire(ssock->write_mutex);
         pj_list_erase(wp);
         pj_list_push_back(&ssock->write_pending_empty, wp);
     }
 
+    /* Reset ongoing flush flag */
+    ssock->flushing_write_pend = PJ_FALSE;
+
+    pj_lock_release(ssock->write_mutex);
+
     return PJ_SUCCESS;
 }
 
-/* Sending is delayed, push back the sending data into pending list. Note that
- * accessing write pending list must be serialized, so a call to this function
- * must be protected by write mutex of SSL socket.
- */
+/* Sending is delayed, push back the sending data into pending list. */
 static pj_status_t delay_send (pj_ssl_sock_t *ssock,
                                pj_ioqueue_op_key_t *send_key,
@@ -2122 +2270 @@
                                unsigned flags)
 {
-    write_pending_t *wp;
+    write_data_t *wp;
+
+    pj_lock_acquire(ssock->write_mutex);
 
     /* Init write pending instance */
@@ -2129 +2279 @@
         pj_list_erase(wp);
     } else {
-        wp = PJ_POOL_ZALLOC_T(ssock->pool, write_pending_t);
-    }
-
-    wp->data.app_key = send_key;
-    wp->data.plain_data_len = size;
-    wp->data.data.ptr = data;
-    wp->data.flags = flags;
+        wp = PJ_POOL_ZALLOC_T(ssock->pool, write_data_t);
+    }
+
+    wp->app_key = send_key;
+    wp->plain_data_len = size;
+    wp->data.ptr = data;
+    wp->flags = flags;
 
     pj_list_push_back(&ssock->write_pending, wp);
+    
+    pj_lock_release(ssock->write_mutex);
 
     /* Must return PJ_EPENDING */
@@ -2157 +2309 @@
     PJ_ASSERT_RETURN(ssock->ssl_state==SSL_STATE_ESTABLISHED, PJ_EINVALIDOP);
 
-    pj_lock_acquire(ssock->write_mutex);
+    // Ticket #1573: Don't hold mutex while calling PJLIB socket send().
+    //pj_lock_acquire(ssock->write_mutex);
 
     /* Flush delayed send first. Sending data might be delayed when 
@@ -2164 +2317 @@
     status = flush_delayed_send(ssock);
     if (status == PJ_EBUSY) {
-        /* Re-negotiation is on progress, delay sending */
+        /* Re-negotiation or flushing is on progress, delay sending */
         status = delay_send(ssock, send_key, data, *size, flags);
         goto on_return;
@@ -2179 +2332 @@
 
 on_return:
-    pj_lock_release(ssock->write_mutex);
+    //pj_lock_release(ssock->write_mutex);
     return status;
 }