Abstract out chunk_queue code.
[paraslash.git] / http_send.c
index 111c49baf82aa58e9bb9172ad0a8deb86b9ee571..65b6c5a2ebee3b518a5383acd45273ce696a629c 100644 (file)
@@ -1,19 +1,7 @@
 /*
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \file http_send.c paraslash's http sender */
  */
 
 /** \file http_send.c paraslash's http sender */
@@ -22,7 +10,7 @@
 #include "server.cmdline.h"
 #include "server.h"
 #include "http.h"
 #include "server.cmdline.h"
 #include "server.h"
 #include "http.h"
-#include "afs.h"
+#include "vss.h"
 #include "send.h"
 #include "list.h"
 #include "close_on_fork.h"
 #include "send.h"
 #include "list.h"
 #include "close_on_fork.h"
 #define HTTP_ERR_MSG "HTTP/1.0 400 Bad Request\n"
 /** \endcond */
 
 #define HTTP_ERR_MSG "HTTP/1.0 400 Bad Request\n"
 /** \endcond */
 
-/** the possible states of a client from the server's POV */
+/** The possible states of a client from the server's POV. */
 enum http_status {
 enum http_status {
+       /** We accepted the connection on the tcp socket. */
        HTTP_CONNECTED,
        HTTP_CONNECTED,
+       /** Successfully received the get request. */
        HTTP_GOT_GET_REQUEST,
        HTTP_GOT_GET_REQUEST,
+       /** We sent the OK message back to the client. */
        HTTP_SENT_OK_MSG,
        HTTP_SENT_OK_MSG,
+       /** Connection established, we might need to send the audio file header. */
        HTTP_READY_TO_STREAM,
        HTTP_READY_TO_STREAM,
+       /** Connection is ready for sending audio data. */
        HTTP_STREAMING,
        HTTP_STREAMING,
+       /** We didn't receive a valid get request. */
        HTTP_INVALID_GET_REQUEST
 };
 
        HTTP_INVALID_GET_REQUEST
 };
 
-/** clients will be kicked if there are more than that many bytes pending */
-#define MAX_BACKLOG 40000
-/** the list of connected clients **/
+/** Clients will be kicked if there are more than that many bytes pending. */
+#define MAX_BACKLOG 400000
+/** The list of connected clients. */
 static struct list_head clients;
 static struct list_head clients;
-/** the whitelist/blacklist */
+/** The whitelist/blacklist. */
 static struct list_head access_perm_list;
 
 static struct list_head access_perm_list;
 
-/** describes one client that connected the tcp port of the http sender */
+struct chunk_queue{
+       /** The list of pending chunks for this client. */
+       struct list_head q;
+       /** The number of pending bytes for this client. */
+       unsigned long num_pending;
+       unsigned long max_pending;
+};
+
+/** Describes one client that connected the tcp port of the http sender. */
 struct http_client {
 struct http_client {
-/** the file descriptor of the client */
+       /** The file descriptor of the client. */
        int fd;
        int fd;
-/** address information about the client */
+       /** Address information about the client. */
        struct sockaddr_in addr;
        struct sockaddr_in addr;
-/** the client's current status */
+       /** The client's current status. */
        enum http_status status;
        enum http_status status;
-/** non-zero if we included \a fd in the read set */
+       /** Non-zero if we included \a fd in the read set.*/
        int check_r;
        int check_r;
-/** non-zero if we included \a fd in the write set */
+       /** Non-zero if we included \a fd in the write set. */
        int check_w;
        int check_w;
-/** the position of this client in the client list */
+       /** The position of this client in the client list. */
        struct list_head node;
        struct list_head node;
-/** the list of pending packets for this client */
-       struct list_head packet_queue;
-/** the number of pending bytes for this client */
-       unsigned long pq_bytes;
+       /** The list of pending chunks for this client. */
+       struct chunk_queue cq;
 };
 
 /**
 };
 
 /**
- * describes one queued data packet for a client
+ * Describes one queued chunk of the chunk queue.
  *
  * The send function of the http sender checks each client fd for writing. If a
  *
  * The send function of the http sender checks each client fd for writing. If a
- * client fd is not ready, it tries to queue that packet for this client until
+ * client fd is not ready, it tries to queue that chunk for this client until
  * the number of queued bytes exceeds \p MAX_BACKLOG.
  */
  * the number of queued bytes exceeds \p MAX_BACKLOG.
  */
-struct queued_packet {
-/** the length of the packet in bytes */
-       unsigned int len;
-/** pointer to the packet data */
-       char *packet;
-/** position of the packet in the packet list */
+struct queued_chunk {
+       /** The number of the queued chunk, -1U means header. */
+       unsigned chunk_num;
+       /** The number of bytes already sent. */
+       unsigned sent;
+       /** Position of the chunk in the chunk queue. */
        struct list_head node;
 };
 
 /**
        struct list_head node;
 };
 
 /**
- * describes one entry in the blacklist/whitelist of the http sender
+ * Describes one entry in the blacklist/whitelist of the http sender.
  */
 struct access_info {
  */
 struct access_info {
-       /** the address to be black/whitelisted */
+       /** The address to be black/whitelisted. */
        struct in_addr addr;
        struct in_addr addr;
-       /** the netmask for this entry */
-       int netmask;
-       /** the position of this entry in the access_perm_list */
+       /** The netmask for this entry. */
+       unsigned netmask;
+       /** The position of this entry in the access_perm_list. */
        struct list_head node;
 };
 
        struct list_head node;
 };
 
@@ -107,19 +107,95 @@ static int server_fd = -1, numclients;
 static struct sender *self;
 
 
 static struct sender *self;
 
 
+static int cq_enqueue(struct chunk_queue *cq, long unsigned chunk_num,
+       size_t sent)
+{
+       struct queued_chunk *qc;
+       char *buf;
+       size_t len;
+       int ret;
+
+       if (chunk_num != -1U) {
+               ret = vss_get_chunk(chunk_num, &buf, &len);
+               if (ret < 0)
+                       return ret;
+       } else
+               buf = vss_get_header(&len);
+       if (cq->num_pending + len > cq->max_pending)
+               return -E_QUEUE;
+       qc = para_malloc(sizeof(struct queued_chunk));
+       cq->num_pending += len;
+       qc->chunk_num = chunk_num;
+       qc->sent = sent;
+       list_add_tail(&qc->node, &cq->q);
+       PARA_DEBUG_LOG("%lu bytes queued for %p\n", cq->num_pending, &cq->q);
+       return 1;
+}
+
+static struct queued_chunk *cq_peek(struct chunk_queue *cq)
+{
+       if (list_empty(&cq->q))
+               return NULL;
+       return list_entry(cq->q.next, struct queued_chunk, node);
+}
+
+int cq_dequeue(struct chunk_queue *cq)
+{
+       struct queued_chunk *qc = cq_peek(cq);
+       assert(qc);
+       list_del(&qc->node);
+       free(qc);
+       return 1;
+}
+
+void cq_update(struct chunk_queue *cq, size_t sent)
+{
+       struct queued_chunk *qc = cq_peek(cq);
+       assert(qc);
+       qc->sent += sent;
+       cq->num_pending -= sent;
+}
+
+int cq_get(struct queued_chunk *qc, char **buf, size_t *len)
+{
+       int ret;
+
+       if (qc->chunk_num != -1U) {
+               ret = vss_get_chunk(qc->chunk_num, buf, len);
+               if (ret < 0)
+                       return ret;
+       } else
+               *buf = vss_get_header(len);
+       assert(*len > qc->sent);
+       *buf += qc->sent;
+       *len -= qc->sent;
+       return 1;
+}
+
+void cq_init(struct chunk_queue *cq, size_t max_pending)
+{
+       INIT_LIST_HEAD(&cq->q);
+       cq->max_pending = max_pending;
+       cq->num_pending = 0;
+}
+
+void cq_destroy(struct chunk_queue *cq)
+{
+       struct queued_chunk *qc, *tmp;
+       list_for_each_entry_safe(qc, tmp, &cq->q, node) {
+               list_del(&qc->node);
+               free(qc);
+       }
+}
+
 static void http_shutdown_client(struct http_client *hc, const char *msg)
 {
 static void http_shutdown_client(struct http_client *hc, const char *msg)
 {
-       struct queued_packet *qp, *tmp;
        PARA_INFO_LOG("shutting down %s on fd %d (%s)\n", CLIENT_ADDR(hc),
                hc->fd, msg);
        numclients--;
        close(hc->fd);
        del_close_on_fork_list(hc->fd);
        PARA_INFO_LOG("shutting down %s on fd %d (%s)\n", CLIENT_ADDR(hc),
                hc->fd, msg);
        numclients--;
        close(hc->fd);
        del_close_on_fork_list(hc->fd);
-       list_for_each_entry_safe(qp, tmp, &hc->packet_queue, node) {
-               free(qp->packet);
-               list_del(&qp->node);
-               free(qp);
-       }
+       cq_destroy(&hc->cq);
        list_del(&hc->node);
        free(hc);
 }
        list_del(&hc->node);
        free(hc);
 }
@@ -128,7 +204,7 @@ static void http_shutdown_clients(void)
 {
        struct http_client *hc, *tmp;
        list_for_each_entry_safe(hc, tmp, &clients, node)
 {
        struct http_client *hc, *tmp;
        list_for_each_entry_safe(hc, tmp, &clients, node)
-               http_shutdown_client(hc, "afs request");
+               http_shutdown_client(hc, "vss request");
 }
 
 static int http_send_msg(struct http_client *hc, const char *msg)
 }
 
 static int http_send_msg(struct http_client *hc, const char *msg)
@@ -152,50 +228,37 @@ static int http_send_err_msg(struct http_client *hc)
        return http_send_msg(hc, HTTP_ERR_MSG);
 }
 
        return http_send_msg(hc, HTTP_ERR_MSG);
 }
 
-static int queue_packet(struct http_client *hc, const char *buf, size_t len)
-{
-       struct queued_packet *qp;
-       if (hc->pq_bytes + len > MAX_BACKLOG) {
-               http_shutdown_client(hc, "packet queue overrun");
-               return -E_QUEUE;
-       }
-       qp = para_malloc(sizeof(struct queued_packet));
-       hc->pq_bytes += len;
-       qp->packet = para_malloc(len);
-       memcpy(qp->packet, buf, len);
-       qp->len = len;
-       list_add_tail(&qp->node, &hc->packet_queue);
-       PARA_INFO_LOG("%lu bytes queued for fd %d\n", hc->pq_bytes, hc->fd);
-       return 1;
-}
 
 
-static int send_queued_packets(struct http_client *hc)
+static int send_queued_chunks(struct http_client *hc)
 {
 {
-       int ret;
-       struct queued_packet *qp, *tmp;
-
-       if (list_empty(&hc->packet_queue))
-               return 1;
-       list_for_each_entry_safe(qp, tmp, &hc->packet_queue, node) {
-               ret = write_ok(hc->fd);
+       struct queued_chunk *qc;
+       while ((qc = cq_peek(&hc->cq))) {
+               char *buf;
+               size_t len;
+               int ret = write_ok(hc->fd);
                if (ret <= 0)
                        return ret? -E_WRITE_OK : 0;
                if (ret <= 0)
                        return ret? -E_WRITE_OK : 0;
-               ret = write(hc->fd, qp->packet, qp->len);
+               cq_get(qc, &buf, &len);
+               ret = write(hc->fd, buf, len);
                if (ret < 0)
                if (ret < 0)
-                       return ret;
-               if (ret != qp->len) {
-                       qp->len -= ret;
-                       memmove(qp->packet, qp->packet + ret, qp->len);
-                       return 0;
-               }
-               hc->pq_bytes -= qp->len;
-               free(qp->packet);
-               list_del(&qp->node);
-               free(qp);
+                       return -1; /* FIXME */
+               cq_update(&hc->cq, ret);
+               if (ret != len)
+                       return 1;
+               cq_dequeue(&hc->cq);
        }
        return 1;
 }
 
        }
        return 1;
 }
 
+static int queue_chunk_or_shutdown(struct http_client *hc, long unsigned chunk_num,
+       size_t sent)
+{
+       int ret = cq_enqueue(&hc->cq, chunk_num, sent);
+       if (ret < 0)
+               http_shutdown_client(hc, "queue error");
+       return ret;
+}
+
 static void http_send( long unsigned current_chunk,
        __a_unused long unsigned chunks_sent, const char *buf, size_t len)
 {
 static void http_send( long unsigned current_chunk,
        __a_unused long unsigned chunks_sent, const char *buf, size_t len)
 {
@@ -207,39 +270,37 @@ static void http_send( long unsigned current_chunk,
                                hc->status != HTTP_READY_TO_STREAM)
                        continue;
                if (hc->status == HTTP_READY_TO_STREAM) {
                                hc->status != HTTP_READY_TO_STREAM)
                        continue;
                if (hc->status == HTTP_READY_TO_STREAM) {
-                       int hlen;
-                       char *hbuf = afs_get_header(&hlen);
+                       unsigned hlen;
+                       char *hbuf = vss_get_header(&hlen);
                        if (hbuf && hlen > 0 && current_chunk) {
                                /* need to send header */
                                PARA_INFO_LOG("queueing header: %d\n", hlen);
                        if (hbuf && hlen > 0 && current_chunk) {
                                /* need to send header */
                                PARA_INFO_LOG("queueing header: %d\n", hlen);
-                               if (queue_packet(hc, hbuf, hlen) < 0)
+                               if (queue_chunk_or_shutdown(hc, -1U, 0) < 0)
                                        continue;
                        } else
                                        continue;
                        } else
-                               PARA_INFO_LOG("%s", "no need to queue header\n");
+                               PARA_INFO_LOG("no need to queue header\n");
                        hc->status = HTTP_STREAMING;
                }
                        hc->status = HTTP_STREAMING;
                }
-               ret = send_queued_packets(hc);
+               ret = send_queued_chunks(hc);
                if (ret < 0) {
                if (ret < 0) {
-                       http_shutdown_client(hc, "send error");
+                       http_shutdown_client(hc, "queue send error");
                        continue;
                }
                if (!len)
                        continue;
                if (!ret || write_ok(hc->fd) <= 0) {
                        continue;
                }
                if (!len)
                        continue;
                if (!ret || write_ok(hc->fd) <= 0) {
-                       PARA_INFO_LOG("fd %d not ready (%lu bytes queued),"
-                               " trying to queue packet\n", hc->fd,
-                               hc->pq_bytes);
-                       queue_packet(hc, buf, len);
+                       queue_chunk_or_shutdown(hc, current_chunk, 0);
                        continue;
                }
 //             PARA_DEBUG_LOG("sending %d -> %s\n", len, CLIENT_ADDR(hc));
                ret = write(hc->fd, buf, len);
                        continue;
                }
 //             PARA_DEBUG_LOG("sending %d -> %s\n", len, CLIENT_ADDR(hc));
                ret = write(hc->fd, buf, len);
+//             PARA_DEBUG_LOG("ret: %d\n", ret);
                if (ret < 0) {
                        http_shutdown_client(hc, "send error");
                        continue;
                }
                if (ret != len)
                if (ret < 0) {
                        http_shutdown_client(hc, "send error");
                        continue;
                }
                if (ret != len)
-                       queue_packet(hc, buf + ret, len - ret);
+                       queue_chunk_or_shutdown(hc, current_chunk, ret);
        }
 }
 
        }
 }
 
@@ -247,7 +308,7 @@ static int host_in_access_perm_list(struct http_client *hc)
 {
        struct access_info *ai, *tmp;
        list_for_each_entry_safe(ai, tmp, &access_perm_list, node) {
 {
        struct access_info *ai, *tmp;
        list_for_each_entry_safe(ai, tmp, &access_perm_list, node) {
-               unsigned mask = ((~0) >> ai->netmask);
+               unsigned mask = ((~0U) >> ai->netmask);
                if ((hc->addr.sin_addr.s_addr & mask) == (ai->addr.s_addr & mask))
                        return 1;
        }
                if ((hc->addr.sin_addr.s_addr & mask) == (ai->addr.s_addr & mask))
                        return 1;
        }
@@ -319,11 +380,11 @@ static void http_post_select(fd_set *rfds, fd_set *wfds)
                goto err_out;
        }
        hc->status = HTTP_CONNECTED;
                goto err_out;
        }
        hc->status = HTTP_CONNECTED;
-       INIT_LIST_HEAD(&hc->packet_queue);
+       cq_init(&hc->cq, MAX_BACKLOG);
        PARA_INFO_LOG("accepted client #%d: %s (fd %d)\n", numclients,
                CLIENT_ADDR(hc), hc->fd);
        numclients++;
        PARA_INFO_LOG("accepted client #%d: %s (fd %d)\n", numclients,
                CLIENT_ADDR(hc), hc->fd);
        numclients++;
-       list_add(&hc->node, &clients);
+       para_list_add(&hc->node, &clients);
        add_close_on_fork_list(hc->fd);
        mark_fd_nonblock(hc->fd);
        return;
        add_close_on_fork_list(hc->fd);
        mark_fd_nonblock(hc->fd);
        return;
@@ -360,7 +421,7 @@ static void http_pre_select(int *max_fileno, fd_set *rfds, fd_set *wfds)
                        hc->check_w = 1;
                        break;
                case HTTP_SENT_OK_MSG:
                        hc->check_w = 1;
                        break;
                case HTTP_SENT_OK_MSG:
-                       if (!afs_playing())
+                       if (!vss_playing())
                                break; /* wait until server starts playing */
                        para_fd_set(hc->fd, wfds, max_fileno);
                        hc->check_w = 1;
                                break; /* wait until server starts playing */
                        para_fd_set(hc->fd, wfds, max_fileno);
                        hc->check_w = 1;
@@ -371,12 +432,19 @@ static void http_pre_select(int *max_fileno, fd_set *rfds, fd_set *wfds)
 
 static int open_tcp_port(int port)
 {
 
 static int open_tcp_port(int port)
 {
+       int ret;
+
        server_fd = init_tcp_socket(port);
        if (server_fd < 0) {
                http_shutdown_clients();
                self->status = SENDER_OFF;
                return server_fd;
        }
        server_fd = init_tcp_socket(port);
        if (server_fd < 0) {
                http_shutdown_clients();
                self->status = SENDER_OFF;
                return server_fd;
        }
+       ret = mark_fd_nonblock(server_fd);
+       if (ret < 0) {
+               PARA_EMERG_LOG("%s\n", PARA_STRERROR(-ret));
+               exit(EXIT_FAILURE);
+       }
        self->status = SENDER_ON;
        add_close_on_fork_list(server_fd);
        return 1;
        self->status = SENDER_ON;
        add_close_on_fork_list(server_fd);
        return 1;
@@ -425,7 +493,7 @@ static void add_perm_list_entry(struct sender_command_data *scd)
        ai->netmask = scd->netmask;
        PARA_INFO_LOG("adding %s/%i to access list\n", inet_ntoa(ai->addr),
                ai->netmask);
        ai->netmask = scd->netmask;
        PARA_INFO_LOG("adding %s/%i to access list\n", inet_ntoa(ai->addr),
                ai->netmask);
-       list_add(&ai->node, &access_perm_list);
+       para_list_add(&ai->node, &access_perm_list);
 }
 
 static int http_com_deny(struct sender_command_data *scd)
 }
 
 static int http_com_deny(struct sender_command_data *scd)
@@ -523,12 +591,12 @@ static char *http_help(void)
 }
 
 /**
 }
 
 /**
- * the init function of the http sender
+ * The init function of the http sender.
  *
  *
- * \param s pointer to the http sender struct
+ * \param s Pointer to the http sender struct.
  *
  *
- * It initializes all function pointers of \a s, init the client list and the
- * acess control list as well. If autostart is wanted, open the tcp port.
+ * It initializes all function pointers of \a s, the client list and the access
+ * control list. If the autostart option was given, the tcp port is opened.
  */
 void http_send_init(struct sender *s)
 {
  */
 void http_send_init(struct sender *s)
 {