4 * Herein lies all the mangement routines for the transmit (Tx) queue.
11 #include <sys/socket.h>
15 * Allocate a new tx frame.
17 * This is more for looks than anything else.
19 * Right now, that is. If/when we implement a pool of transmit
20 * frames, this will become the request-an-unused-frame part.
22 * framing = AIM_FRAMETYPE_OFT/OSCAR
23 * chan = channel for OSCAR, hdrtype for OFT
26 faim_internal struct command_tx_struct *aim_tx_new(unsigned char framing, int chan, struct aim_conn_t *conn, int datalen)
28 struct command_tx_struct *newtx;
31 printf("aim_tx_new: ERROR: no connection specified\n");
35 newtx = (struct command_tx_struct *)malloc(sizeof(struct command_tx_struct));
38 memset(newtx, 0, sizeof(struct command_tx_struct));
43 newtx->data = (unsigned char *)malloc(datalen);
44 newtx->commandlen = datalen;
48 newtx->hdrtype = framing;
49 if (newtx->hdrtype == AIM_FRAMETYPE_OSCAR) {
50 newtx->hdr.oscar.type = chan;
51 } else if (newtx->hdrtype == AIM_FRAMETYPE_OFT) {
52 newtx->hdr.oft.type = chan;
53 newtx->hdr.oft.hdr2len = 0; /* this will get setup by caller */
55 printf("tx_new: unknown framing\n");
62 * aim_tx_enqeue__queuebased()
64 * The overall purpose here is to enqueue the passed in command struct
65 * into the outgoing (tx) queue. Basically...
66 * 1) Make a scope-irrelevent copy of the struct
68 * 3) Mark as not-sent-yet
69 * 4) Enqueue the struct into the list
70 * 5) Unlock the struct once it's linked in
73 * Note that this is only used when doing queue-based transmitting;
74 * that is, when sess->tx_enqueue is set to &aim_tx_enqueue__queuebased.
77 faim_internal int aim_tx_enqueue__queuebased(struct aim_session_t *sess,
78 struct command_tx_struct *newpacket)
80 struct command_tx_struct *cur;
82 if (newpacket->conn == NULL) {
83 faimdprintf(1, "aim_tx_enqueue: WARNING: enqueueing packet with no connecetion\n");
84 newpacket->conn = aim_getconn_type(sess, AIM_CONN_TYPE_BOS);
87 if (newpacket->hdrtype == AIM_FRAMETYPE_OSCAR) {
89 newpacket->hdr.oscar.seqnum = aim_get_next_txseqnum(newpacket->conn);
91 /* set some more fields */
92 newpacket->lock = 1; /* lock */
93 newpacket->sent = 0; /* not sent yet */
94 newpacket->next = NULL; /* always last */
96 /* see overhead note in aim_rxqueue counterpart */
97 if (sess->queue_outgoing == NULL) {
98 sess->queue_outgoing = newpacket;
100 for (cur = sess->queue_outgoing;
104 cur->next = newpacket;
107 newpacket->lock = 0; /* unlock so it can be sent */
110 faimdprintf(2, "calling aim_tx_printqueue()\n");
111 aim_tx_printqueue(sess);
112 faimdprintf(2, "back from aim_tx_printqueue()\n");
119 * aim_tx_enqueue__immediate()
121 * Parallel to aim_tx_enqueue__queuebased, however, this bypasses
122 * the whole queue mess when you want immediate writes to happen.
124 * Basically the same as its __queuebased couterpart, however
125 * instead of doing a list append, it just calls aim_tx_sendframe()
129 faim_internal int aim_tx_enqueue__immediate(struct aim_session_t *sess, struct command_tx_struct *newpacket)
131 if (newpacket->conn == NULL) {
132 faimdprintf(1, "aim_tx_enqueue: ERROR: packet has no connection\n");
134 free(newpacket->data);
139 if (newpacket->hdrtype == AIM_FRAMETYPE_OSCAR)
140 newpacket->hdr.oscar.seqnum = aim_get_next_txseqnum(newpacket->conn);
142 newpacket->lock = 1; /* lock */
143 newpacket->sent = 0; /* not sent yet */
145 aim_tx_sendframe(sess, newpacket);
148 free(newpacket->data);
154 faim_internal int aim_tx_enqueue(struct aim_session_t *sess, struct command_tx_struct *command)
157 * If we want to send a connection thats inprogress, we have to force
158 * them to use the queue based version. Otherwise, use whatever they
161 if (command && command->conn && (command->conn->status & AIM_CONN_STATUS_INPROGRESS)) {
162 return aim_tx_enqueue__queuebased(sess, command);
164 return (*sess->tx_enqueue)(sess, command);
168 * aim_get_next_txseqnum()
170 * This increments the tx command count, and returns the seqnum
171 * that should be stamped on the next FLAP packet sent. This is
172 * normally called during the final step of packet preparation
173 * before enqueuement (in aim_tx_enqueue()).
176 faim_internal unsigned int aim_get_next_txseqnum(struct aim_conn_t *conn)
180 faim_mutex_lock(&conn->seqnum_lock);
181 ret = ++conn->seqnum;
182 faim_mutex_unlock(&conn->seqnum_lock);
187 * aim_tx_printqueue()
189 * This is basically for debuging purposes only. It dumps all the
190 * records in the tx queue and their current status. Very helpful
191 * if the queue isn't working quite right.
195 faim_internal int aim_tx_printqueue(struct aim_session_t *sess)
197 struct command_tx_struct *cur;
199 faimdprintf(2, "\ncurrent aim_queue_outgoing...\n");
200 faimdprintf(2, "\ttype seqnum len lock sent\n");
202 if (sess->queue_outgoing == NULL)
203 faimdprintf(2, "aim_tx_flushqueue(): queue empty");
205 for (cur = sess->queue_outgoing; cur; cur = cur->next) {
206 faimdprintf(2, "\t %2x %2x %4x %4x %1d %1d\n",
208 (cur->hdrtype==AIM_FRAMETYPE_OFT)?cur->hdr.oft.type:cur->hdr.oscar.type,
209 (cur->hdrtype==AIM_FRAMETYPE_OSCAR)?cur->seqnum:0,
210 cur->commandlen, cur->lock,
215 faimdprintf(2, "\n(done printing queue)\n");
222 * aim_tx_flushqueue()
224 * This the function is responsable for putting the queued commands
225 * onto the wire. This function is critical to the operation of
226 * the queue and therefore is the most prone to brokenness. It
227 * seems to be working quite well at this point.
230 * 1) Traverse the list, only operate on commands that are unlocked
231 * and haven't been sent yet.
233 * 3) Allocate a temporary buffer to store the finished, fully
234 * processed packet in.
235 * 4) Build the packet from the command_tx_struct data.
236 * 5) Write the packet to the socket.
237 * 6) If success, mark the packet sent, if fail report failure, do NOT
238 * mark the packet sent (so it will not get purged and therefore
239 * be attempted again on next call).
240 * 7) Unlock the struct.
241 * 8) Free the temp buffer
242 * 9) Step to next struct in list and go back to 1.
245 faim_internal int aim_tx_sendframe(struct aim_session_t *sess, struct command_tx_struct *cur)
248 unsigned char *curPacket;
251 return -1; /* fatal */
253 cur->lock = 1; /* lock the struct */
255 if (cur->hdrtype == AIM_FRAMETYPE_OSCAR)
256 buflen = cur->commandlen + 6;
257 else if (cur->hdrtype == AIM_FRAMETYPE_OFT)
258 buflen = cur->hdr.oft.hdr2len + 8;
264 /* allocate full-packet buffer */
265 if (!(curPacket = (unsigned char *) malloc(buflen))) {
270 if (cur->hdrtype == AIM_FRAMETYPE_OSCAR) {
274 /* type/family byte */
275 curPacket[1] = cur->hdr.oscar.type;
277 /* bytes 3+4: word: FLAP sequence number */
278 aimutil_put16(curPacket+2, cur->hdr.oscar.seqnum);
280 /* bytes 5+6: word: SNAC len */
281 aimutil_put16(curPacket+4, cur->commandlen);
283 /* bytes 7 and on: raw: SNAC data */ /* XXX: ye gods! get rid of this! */
284 memcpy(&(curPacket[6]), cur->data, cur->commandlen);
286 } else if (cur->hdrtype == AIM_FRAMETYPE_OFT) {
289 z += aimutil_put8(curPacket+z, cur->hdr.oft.magic[0]);
290 z += aimutil_put8(curPacket+z, cur->hdr.oft.magic[1]);
291 z += aimutil_put8(curPacket+z, cur->hdr.oft.magic[2]);
292 z += aimutil_put8(curPacket+z, cur->hdr.oft.magic[3]);
294 z += aimutil_put16(curPacket+z, cur->hdr.oft.hdr2len + 8);
295 z += aimutil_put16(curPacket+z, cur->hdr.oft.type);
297 memcpy(curPacket+z, cur->hdr.oft.hdr2, cur->hdr.oft.hdr2len);
301 * For OSCAR, a full image of the raw packet data now in curPacket.
302 * For OFT, an image of just the bloated header is in curPacket,
303 * since OFT allows us to do the data in a different write (yay!).
305 faim_mutex_lock(&cur->conn->active);
306 if (send(cur->conn->fd, curPacket, buflen, 0) != buflen) {
307 faim_mutex_unlock(&cur->conn->active);
309 aim_conn_close(cur->conn);
310 return 0; /* bail out */
313 if ((cur->hdrtype == AIM_FRAMETYPE_OFT) && cur->commandlen) {
314 if (send(cur->conn->fd, cur->data, cur->commandlen, 0) != (int)cur->commandlen) {
316 * Theres nothing we can do about this since we've already sent the
317 * header! The connection is unstable.
322 cur->sent = 1; /* mark the struct as sent */
323 cur->conn->lastactivity = time(NULL);
325 faim_mutex_unlock(&cur->conn->active);
328 faimdprintf(2, "\nPacket:");
329 for (i = 0; i < (cur->commandlen + 6); i++) {
331 faimdprintf(2, "\n\t");
333 if (curPacket[i] >= ' ' && curPacket[i]<127) {
334 faimdprintf(2, "%c=%02x ", curPacket[i], curPacket[i]);
336 faimdprintf(2, "0x%2x ", curPacket[i]);
339 faimdprintf(2, "\n");
341 cur->lock = 0; /* unlock the struct */
342 free(curPacket); /* free up full-packet buffer */
344 return 1; /* success */
347 faim_export int aim_tx_flushqueue(struct aim_session_t *sess)
349 struct command_tx_struct *cur;
355 if (sess->queue_outgoing == NULL)
358 faimdprintf(2, "beginning txflush...\n");
359 for (cur = sess->queue_outgoing; cur; cur = cur->next) {
360 /* only process if its unlocked and unsent */
361 if (!cur->lock && !cur->sent) {
363 if (cur->conn && (cur->conn->status & AIM_CONN_STATUS_INPROGRESS))
367 * And now for the meager attempt to force transmit
368 * latency and avoid missed messages.
370 if ((cur->conn->lastactivity + cur->conn->forcedlatency) >= time(NULL)) {
371 /* FIXME FIXME -- should be a break! we dont want to block the upper layers */
372 sleep((cur->conn->lastactivity + cur->conn->forcedlatency) - time(NULL));
375 if (aim_tx_sendframe(sess, cur) == -1)
380 /* purge sent commands from queue */
381 aim_tx_purgequeue(sess);
387 * aim_tx_purgequeue()
389 * This is responsable for removing sent commands from the transmit
390 * queue. This is not a required operation, but it of course helps
391 * reduce memory footprint at run time!
394 faim_export void aim_tx_purgequeue(struct aim_session_t *sess)
396 struct command_tx_struct *cur = NULL;
397 struct command_tx_struct *tmp;
399 if (sess->queue_outgoing == NULL)
402 if (sess->queue_outgoing->next == NULL) {
403 if (!sess->queue_outgoing->lock && sess->queue_outgoing->sent) {
404 tmp = sess->queue_outgoing;
405 sess->queue_outgoing = NULL;
406 if (tmp->hdrtype == AIM_FRAMETYPE_OFT)
407 free(tmp->hdr.oft.hdr2);
414 for(cur = sess->queue_outgoing; cur->next != NULL; ) {
415 if (!cur->next->lock && cur->next->sent) {
417 cur->next = tmp->next;
418 if (tmp->hdrtype == AIM_FRAMETYPE_OFT)
419 free(tmp->hdr.oft.hdr2);
426 * Be careful here. Because of the way we just
427 * manipulated the pointer, cur may be NULL and
428 * the for() will segfault doing the check unless
429 * we find this case first.