ircd/msgq.c

   1 /*
   2  * IRC - Internet Relay Chat, ircd/msgq.c
   3  * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 1, or (at your option)
   8  * any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18  *
  19  * $Id$
  20  */
  21 #include "msgq.h"
  22 #include "ircd_alloc.h"
  23 #include "ircd_defs.h"
  24 #include "ircd_snprintf.h"
  25 #include "s_debug.h"
  26
  27 #include <assert.h>
  28 #include <stdarg.h>
  29 #include <sys/types.h>
  30 #include <sys/uio.h>    /* struct iovec */
  31
  32 struct MsgBuf {
  33   struct MsgBuf *next;          /* next msg in global queue */
  34   struct MsgBuf **prev_p;       /* what points to us in linked list */
  35   unsigned int ref;             /* reference count */
  36   unsigned int length;          /* length of message */
  37   char msg[BUFSIZE + 1];        /* the message */
  38 };
  39
  40 struct Msg {
  41   struct Msg *next;             /* next msg */
  42   unsigned int sent;            /* bytes in msg that have already been sent */
  43   struct MsgBuf *msg;           /* actual message in queue */
  44 };
  45
  46 static struct {
  47   struct MsgBuf *msgs;
  48   struct MsgBuf *free_mbs;
  49   struct Msg *free_msgs;
  50 } MQData = { 0, 0, 0 };
  51
  52 struct MsgCounts msgBufCounts = { 0, 0 };
  53 struct MsgCounts msgCounts = { 0, 0 };
  54
  55 /*
  56  * This routine is used to remove a certain amount of data from a given
  57  * queue and release the Msg (and MsgBuf) structure if needed
  58  */
  59 static void
  60 msgq_delmsg(struct MsgQ *mq, struct MsgQList *qlist, unsigned int *length_p)
  61 {
  62   struct Msg *m;
  63   unsigned int msglen;
  64
  65   assert(0 != mq);
  66   assert(0 != qlist);
  67   assert(0 != qlist->head);
  68   assert(0 != length_p);
  69
  70   m = qlist->head; /* find the msg we're deleting from */
  71
  72   msglen = m->msg->length - m->sent; /* calculate how much is left */
  73
  74   if (*length_p >= msglen) { /* deleted it all? */
  75     mq->length -= msglen; /* decrement length */
  76     mq->count--; /* decrement the message count */
  77     *length_p -= msglen;
  78
  79     msgq_clean(m->msg); /* free up the struct MsgBuf */
  80     m->msg = 0; /* don't let it point anywhere nasty, please */
  81
  82     if (qlist->head == qlist->tail) /* figure out if we emptied the queue */
  83       qlist->head = qlist->tail = 0;
  84     else
  85       qlist->head = m->next; /* just shift the list down some */
  86
  87     msgCounts.used--; /* struct Msg is not in use anymore */
  88
  89     m->next = MQData.free_msgs; /* throw it onto the free list */
  90     MQData.free_msgs = m;
  91   } else {
  92     mq->length -= *length_p; /* decrement queue length */
  93     m->sent += *length_p; /* this much of the message has been sent */
  94     *length_p = 0; /* we've dealt with it all */
  95   }
  96 }
  97
  98 /*
  99  * This just initializes a struct MsgQ.
 100  */
 101 void
 102 msgq_init(struct MsgQ *mq)
 103 {
 104   assert(0 != mq);
 105
 106   mq->length = 0;
 107   mq->count = 0;
 108   mq->queue.head = 0;
 109   mq->queue.tail = 0;
 110   mq->prio.head = 0;
 111   mq->prio.tail = 0;
 112 }
 113
 114 /*
 115  * This routine is used to delete the specified number of bytes off
 116  * of the queue.  We only really need to worry about one struct Msg*,
 117  * but this allows us to retain the flexibility to deal with more,
 118  * which means we could do something fancy involving writev...
 119  */
 120 void
 121 msgq_delete(struct MsgQ *mq, unsigned int length)
 122 {
 123   assert(0 != mq);
 124
 125   while (length > 0) {
 126     if (mq->queue.head && mq->queue.head->sent > 0) /* partial msg on norm q */
 127       msgq_delmsg(mq, &mq->queue, &length);
 128     else if (mq->prio.head) /* message (partial or complete) on prio queue */
 129       msgq_delmsg(mq, &mq->prio, &length);
 130     else if (mq->queue.head) /* message on normal queue */
 131       msgq_delmsg(mq, &mq->queue, &length);
 132     else
 133       break;
 134   }
 135 }
 136
 137 /*
 138  * This is similiar to the dbuf_map() function to allow us to plug it
 139  * into the existing code more easily; we may want to have something
 140  * more fancy in the future that would allow us to make some intelligent
 141  * use of writev or similiar functions.
 142  */
 143 const char *
 144 msgq_map(const struct MsgQ *mq, unsigned int *length_p)
 145 {
 146   assert(0 != mq);
 147   assert(0 != length_p);
 148
 149   if (mq->length <= 0)
 150     return 0;
 151
 152   if (mq->queue.head && mq->queue.head->sent > 0) { /* partial msg on norm q */
 153     *length_p = mq->queue.head->msg->length - mq->queue.head->sent;
 154     return mq->queue.head->msg->msg + mq->queue.head->sent;
 155   } else if (mq->prio.head) { /* message (partial or complete) on prio queue */
 156     *length_p = mq->prio.head->msg->length - mq->prio.head->sent;
 157     return mq->prio.head->msg->msg + mq->prio.head->sent;
 158   } else if (mq->queue.head) { /* message on normal queue */
 159     *length_p = mq->queue.head->msg->length; /* partial already dealt with */
 160     return mq->queue.head->msg->msg;
 161   }
 162
 163   return 0; /* shouldn't ever happen */
 164 }
 165
 166 /*
 167  * This is the more intelligent routine that can fill in an array of
 168  * struct iovec's.
 169  */
 170 int
 171 msgq_mapiov(const struct MsgQ *mq, struct iovec *iov, int count)
 172 {
 173   struct Msg *queue;
 174   struct Msg *prio;
 175   int i = 0;
 176
 177   assert(0 != mq);
 178   assert(0 != iov);
 179   assert(0 != count);
 180
 181   if (mq->length <= 0) /* no data to map */
 182     return 0;
 183
 184   if (mq->queue.head && mq->queue.head->sent > 0) { /* partial msg on norm q */
 185     iov[i].iov_base = mq->queue.head->msg->msg + mq->queue.head->sent;
 186     iov[i].iov_len = mq->queue.head->msg->length - mq->queue.head->sent;
 187
 188     queue = mq->queue.head->next; /* where we start later... */
 189
 190     i++; /* filled an iovec... */
 191     if (!--count) /* check for space */
 192       return i;
 193   } else
 194     queue = mq->queue.head; /* start at head of queue */
 195
 196   if (mq->prio.head && mq->prio.head->sent > 0) { /* partial msg on prio q */
 197     iov[i].iov_base = mq->prio.head->msg->msg + mq->prio.head->sent;
 198     iov[i].iov_len = mq->prio.head->msg->length - mq->prio.head->sent;
 199
 200     prio = mq->prio.head->next; /* where we start later... */
 201
 202     i++; /* filled an iovec... */
 203     if (!--count) /* check for space */
 204       return i;
 205   } else
 206     prio = mq->prio.head; /* start at head of prio */
 207
 208   for (; prio; prio = prio->next) { /* go through prio queue */
 209     iov[i].iov_base = prio->msg->msg; /* store message */
 210     iov[i].iov_len = prio->msg->length;
 211
 212     i++; /* filled an iovec... */
 213     if (!--count) /* check for space */
 214       return i;
 215   }
 216
 217   for (; queue; queue = queue->next) { /* go through normal queue */
 218     iov[i].iov_base = queue->msg->msg;
 219     iov[i].iov_len = queue->msg->length;
 220
 221     i++; /* filled an iovec... */
 222     if (!--count) /* check for space */
 223       return i;
 224   }
 225
 226   return i;
 227 }
 228
 229 /*
 230  * This routine builds a struct MsgBuf with the appropriate contents
 231  * and returns it; this saves us from having to worry about the contents
 232  * of struct MsgBuf in anything other than this module
 233  */
 234 struct MsgBuf *
 235 msgq_vmake(struct Client *dest, const char *format, va_list vl)
 236 {
 237   struct MsgBuf *mb;
 238
 239   assert(0 != format);
 240
 241   if (!(mb = MQData.free_mbs)) { /* do I need to allocate one? */
 242     mb = (struct MsgBuf *)MyMalloc(sizeof(struct MsgBuf));
 243     msgBufCounts.alloc++; /* we allocated another */
 244   } else /* shift the free list */
 245     MQData.free_mbs = MQData.free_mbs->next;
 246
 247   msgBufCounts.used++; /* we're using another */
 248
 249   mb->next = MQData.msgs; /* initialize the msgbuf */
 250   mb->prev_p = &MQData.msgs;
 251   mb->ref = 1;
 252
 253   /* fill the buffer */
 254   mb->length = ircd_vsnprintf(dest, mb->msg, sizeof(mb->msg) - 2, format, vl);
 255
 256   mb->msg[mb->length++] = '\r'; /* add \r\n to buffer */
 257   mb->msg[mb->length++] = '\n';
 258   mb->msg[mb->length] = '\0'; /* not strictly necessary */
 259
 260   if (MQData.msgs) /* link it into the list */
 261     MQData.msgs->prev_p = &mb->next;
 262   MQData.msgs = mb;
 263
 264   return mb;
 265 }
 266
 267 struct MsgBuf *
 268 msgq_make(struct Client *dest, const char *format, ...)
 269 {
 270   va_list vl;
 271   struct MsgBuf *mb;
 272
 273   va_start(vl, format);
 274   mb = msgq_vmake(dest, format, vl);
 275   va_end(vl);
 276
 277   return mb;
 278 }
 279
 280 /*
 281  * This routine is used to append a formatted string to a struct MsgBuf.
 282  */
 283 void
 284 msgq_append(struct Client *dest, struct MsgBuf *mb, const char *format, ...)
 285 {
 286   va_list vl;
 287
 288   assert(0 != mb);
 289   assert(0 != format);
 290
 291   mb->length -= 2; /* back up to before \r\n */
 292
 293   va_start(vl, format); /* append to the buffer */
 294   mb->length += ircd_vsnprintf(dest, mb->msg + mb->length,
 295                                sizeof(mb->msg) - 2 - mb->length, format, vl);
 296   va_end(vl);
 297
 298   mb->msg[mb->length++] = '\r'; /* add \r\n to buffer */
 299   mb->msg[mb->length++] = '\n';
 300   mb->msg[mb->length] = '\0'; /* not strictly necessary */
 301 }
 302
 303 /*
 304  * This routine is called to decrement the reference count on a
 305  * struct MsgBuf and delete it if necessary.
 306  */
 307 void
 308 msgq_clean(struct MsgBuf *mb)
 309 {
 310   assert(0 != mb);
 311   assert(0 < mb->ref);
 312   assert(0 != mb->prev_p);
 313
 314   if (!--mb->ref) { /* deallocate the message */
 315     *mb->prev_p = mb->next; /* clip it out of active MsgBuf's list */
 316     if (mb->next)
 317       mb->next->prev_p = mb->prev_p;
 318
 319     mb->next = MQData.free_mbs; /* add it to free list */
 320     MQData.free_mbs = mb;
 321
 322     mb->prev_p = 0;
 323
 324     msgBufCounts.used--; /* decrement the usage count */
 325   }
 326 }
 327
 328 /*
 329  * This routine simply adds a struct Msg to the end of a user's MsgQ.
 330  */
 331 void
 332 msgq_add(struct MsgQ *mq, struct MsgBuf *mb, int prio)
 333 {
 334   struct MsgQList *qlist;
 335   struct Msg *msg;
 336
 337   assert(0 != mq);
 338   assert(0 != mb);
 339   assert(0 < mb->ref);
 340
 341   Debug((DEBUG_SEND, "Adding buffer %p [%.*s] to %s queue", mb,
 342          mb->length - 2, mb->msg, prio ? "priority" : "normal"));
 343
 344   qlist = prio ? &mq->prio : &mq->queue;
 345
 346   if (!(msg = MQData.free_msgs)) { /* do I need to allocate one? */
 347     msg = (struct Msg *)MyMalloc(sizeof(struct Msg));
 348     msgCounts.alloc++; /* we allocated another */
 349   } else /* shift the free list */
 350     MQData.free_msgs = MQData.free_msgs->next;
 351
 352   msgCounts.used++; /* we're using another */
 353
 354   msg->next = 0; /* initialize the msg */
 355   msg->sent = 0;
 356   msg->msg = mb;
 357
 358   mb->ref++; /* increment the ref count on the buffer */
 359
 360   if (!qlist->head) /* queue list was empty; head and tail point to msg */
 361     qlist->head = qlist->tail = msg;
 362   else {
 363     assert(0 != qlist->tail);
 364
 365     qlist->tail->next = msg; /* queue had something in it; add to end */
 366     qlist->tail = msg;
 367   }
 368
 369   mq->length += mb->length; /* update the queue length */
 370   mq->count++; /* and the queue count */
 371 }
 372
 373 /*
 374  * This is for reporting memory usage by the msgq system.
 375  */
 376 void
 377 msgq_count_memory(size_t *msg_alloc, size_t *msg_used, size_t *msgbuf_alloc,
 378                   size_t *msgbuf_used)
 379 {
 380   assert(0 != msg_alloc);
 381   assert(0 != msg_used);
 382   assert(0 != msgbuf_alloc);
 383   assert(0 != msgbuf_used);
 384
 385   *msg_alloc = msgCounts.alloc * sizeof(struct Msg);
 386   *msg_used = msgCounts.used * sizeof(struct Msg);
 387   *msgbuf_alloc = msgCounts.alloc * sizeof(struct MsgBuf);
 388   *msgbuf_used = msgCounts.used * sizeof(struct MsgBuf);
 389 }
 390
 391 /*
 392  * This routine is used simply to report how much bufferspace is left.
 393  */
 394 unsigned int
 395 msgq_bufleft(struct MsgBuf *mb)
 396 {
 397   assert(0 != mb);
 398
 399   return sizeof(mb->msg) - mb->length; /* the -2 for \r\n is in mb->length */
 400 }