4 * Herein lies all the mangement routines for the transmit (Tx) queue.
12 #include <sys/socket.h>
16 * Allocate a new tx frame.
18 * This is more for looks than anything else.
20 * Right now, that is. If/when we implement a pool of transmit
21 * frames, this will become the request-an-unused-frame part.
23 * framing = AIM_FRAMETYPE_OFT/OSCAR
24 * chan = channel for OSCAR, hdrtype for OFT
27 faim_internal struct command_tx_struct *aim_tx_new(unsigned char framing, int chan, struct aim_conn_t *conn, int datalen)
29 struct command_tx_struct *newtx;
32 printf("aim_tx_new: ERROR: no connection specified\n");
36 newtx = (struct command_tx_struct *)malloc(sizeof(struct command_tx_struct));
39 memset(newtx, 0, sizeof(struct command_tx_struct));
44 newtx->data = (unsigned char *)malloc(datalen);
45 newtx->commandlen = datalen;
49 newtx->hdrtype = framing;
50 if (newtx->hdrtype == AIM_FRAMETYPE_OSCAR) {
51 newtx->hdr.oscar.type = chan;
52 } else if (newtx->hdrtype == AIM_FRAMETYPE_OFT) {
53 newtx->hdr.oft.type = chan;
54 newtx->hdr.oft.hdr2len = 0; /* this will get setup by caller */
56 printf("tx_new: unknown framing\n");
63 * aim_tx_enqeue__queuebased()
65 * The overall purpose here is to enqueue the passed in command struct
66 * into the outgoing (tx) queue. Basically...
67 * 1) Make a scope-irrelevent copy of the struct
69 * 3) Mark as not-sent-yet
70 * 4) Enqueue the struct into the list
71 * 5) Unlock the struct once it's linked in
74 * Note that this is only used when doing queue-based transmitting;
75 * that is, when sess->tx_enqueue is set to &aim_tx_enqueue__queuebased.
78 static int aim_tx_enqueue__queuebased(struct aim_session_t *sess, 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 static 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_export int aim_tx_setenqueue(struct aim_session_t *sess, int what, int (*func)(struct aim_session_t *, struct command_tx_struct *))
159 if (what == AIM_TX_QUEUED)
160 sess->tx_enqueue = &aim_tx_enqueue__queuebased;
161 else if (what == AIM_TX_IMMEDIATE)
162 sess->tx_enqueue = &aim_tx_enqueue__immediate;
163 else if (what == AIM_TX_USER) {
166 sess->tx_enqueue = func;
168 return -1; /* unknown action */
173 faim_internal int aim_tx_enqueue(struct aim_session_t *sess, struct command_tx_struct *command)
176 * If we want to send a connection thats inprogress, we have to force
177 * them to use the queue based version. Otherwise, use whatever they
180 if (command && command->conn && (command->conn->status & AIM_CONN_STATUS_INPROGRESS)) {
181 return aim_tx_enqueue__queuebased(sess, command);
183 return (*sess->tx_enqueue)(sess, command);
187 * aim_get_next_txseqnum()
189 * This increments the tx command count, and returns the seqnum
190 * that should be stamped on the next FLAP packet sent. This is
191 * normally called during the final step of packet preparation
192 * before enqueuement (in aim_tx_enqueue()).
195 faim_internal unsigned int aim_get_next_txseqnum(struct aim_conn_t *conn)
199 faim_mutex_lock(&conn->seqnum_lock);
200 ret = ++conn->seqnum;
201 faim_mutex_unlock(&conn->seqnum_lock);
206 * aim_tx_printqueue()
208 * This is basically for debuging purposes only. It dumps all the
209 * records in the tx queue and their current status. Very helpful
210 * if the queue isn't working quite right.
214 faim_internal int aim_tx_printqueue(struct aim_session_t *sess)
216 struct command_tx_struct *cur;
218 faimdprintf(2, "\ncurrent aim_queue_outgoing...\n");
219 faimdprintf(2, "\ttype seqnum len lock sent\n");
221 if (sess->queue_outgoing == NULL)
222 faimdprintf(2, "aim_tx_flushqueue(): queue empty");
224 for (cur = sess->queue_outgoing; cur; cur = cur->next) {
225 faimdprintf(2, "\t %2x %2x %4x %4x %1d %1d\n",
227 (cur->hdrtype==AIM_FRAMETYPE_OFT)?cur->hdr.oft.type:cur->hdr.oscar.type,
228 (cur->hdrtype==AIM_FRAMETYPE_OSCAR)?cur->hdr.oscar.seqnum:0,
229 cur->commandlen, cur->lock,
234 faimdprintf(2, "\n(done printing queue)\n");
241 * aim_tx_flushqueue()
243 * This the function is responsable for putting the queued commands
244 * onto the wire. This function is critical to the operation of
245 * the queue and therefore is the most prone to brokenness. It
246 * seems to be working quite well at this point.
249 * 1) Traverse the list, only operate on commands that are unlocked
250 * and haven't been sent yet.
252 * 3) Allocate a temporary buffer to store the finished, fully
253 * processed packet in.
254 * 4) Build the packet from the command_tx_struct data.
255 * 5) Write the packet to the socket.
256 * 6) If success, mark the packet sent, if fail report failure, do NOT
257 * mark the packet sent (so it will not get purged and therefore
258 * be attempted again on next call).
259 * 7) Unlock the struct.
260 * 8) Free the temp buffer
261 * 9) Step to next struct in list and go back to 1.
264 faim_internal int aim_tx_sendframe(struct aim_session_t *sess, struct command_tx_struct *cur)
267 unsigned char *curPacket;
270 return -1; /* fatal */
272 cur->lock = 1; /* lock the struct */
274 if (cur->hdrtype == AIM_FRAMETYPE_OSCAR)
275 buflen = cur->commandlen + 6;
276 else if (cur->hdrtype == AIM_FRAMETYPE_OFT)
277 buflen = cur->hdr.oft.hdr2len + 8;
283 /* allocate full-packet buffer */
284 if (!(curPacket = (unsigned char *) malloc(buflen))) {
289 if (cur->hdrtype == AIM_FRAMETYPE_OSCAR) {
293 /* type/family byte */
294 curPacket[1] = cur->hdr.oscar.type;
296 /* bytes 3+4: word: FLAP sequence number */
297 aimutil_put16(curPacket+2, cur->hdr.oscar.seqnum);
299 /* bytes 5+6: word: SNAC len */
300 aimutil_put16(curPacket+4, cur->commandlen);
302 /* bytes 7 and on: raw: SNAC data */ /* XXX: ye gods! get rid of this! */
303 memcpy(&(curPacket[6]), cur->data, cur->commandlen);
305 } else if (cur->hdrtype == AIM_FRAMETYPE_OFT) {
308 z += aimutil_put8(curPacket+z, cur->hdr.oft.magic[0]);
309 z += aimutil_put8(curPacket+z, cur->hdr.oft.magic[1]);
310 z += aimutil_put8(curPacket+z, cur->hdr.oft.magic[2]);
311 z += aimutil_put8(curPacket+z, cur->hdr.oft.magic[3]);
313 z += aimutil_put16(curPacket+z, cur->hdr.oft.hdr2len + 8);
314 z += aimutil_put16(curPacket+z, cur->hdr.oft.type);
316 memcpy(curPacket+z, cur->hdr.oft.hdr2, cur->hdr.oft.hdr2len);
320 * For OSCAR, a full image of the raw packet data now in curPacket.
321 * For OFT, an image of just the bloated header is in curPacket,
322 * since OFT allows us to do the data in a different write (yay!).
324 faim_mutex_lock(&cur->conn->active);
325 if (send(cur->conn->fd, curPacket, buflen, 0) != buflen) {
326 faim_mutex_unlock(&cur->conn->active);
328 aim_conn_close(cur->conn);
329 return 0; /* bail out */
332 if ((cur->hdrtype == AIM_FRAMETYPE_OFT) && cur->commandlen) {
334 for(curposi = 0; curposi < cur->commandlen; curposi++)
335 printf("%02x ", cur->data[curposi]);
337 if (send(cur->conn->fd, cur->data, cur->commandlen, 0) != (int)cur->commandlen) {
339 * Theres nothing we can do about this since we've already sent the
340 * header! The connection is unstable.
342 faim_mutex_unlock(&cur->conn->active);
344 aim_conn_close(cur->conn);
345 return 0; /* bail out */
350 cur->sent = 1; /* mark the struct as sent */
351 cur->conn->lastactivity = time(NULL);
353 faim_mutex_unlock(&cur->conn->active);
356 faimdprintf(2, "\nPacket:");
357 for (i = 0; i < (cur->commandlen + 6); i++) {
359 faimdprintf(2, "\n\t");
361 if (curPacket[i] >= ' ' && curPacket[i]<127) {
362 faimdprintf(2, "%c=%02x ", curPacket[i], curPacket[i]);
364 faimdprintf(2, "0x%2x ", curPacket[i]);
367 faimdprintf(2, "\n");
369 cur->lock = 0; /* unlock the struct */
370 free(curPacket); /* free up full-packet buffer */
372 return 1; /* success */
375 faim_export int aim_tx_flushqueue(struct aim_session_t *sess)
377 struct command_tx_struct *cur;
379 if (sess->queue_outgoing == NULL)
382 faimdprintf(2, "beginning txflush...\n");
383 for (cur = sess->queue_outgoing; cur; cur = cur->next) {
384 /* only process if its unlocked and unsent */
385 if (!cur->lock && !cur->sent) {
387 if (cur->conn && (cur->conn->status & AIM_CONN_STATUS_INPROGRESS))
391 * And now for the meager attempt to force transmit
392 * latency and avoid missed messages.
394 if ((cur->conn->lastactivity + cur->conn->forcedlatency) >= time(NULL)) {
395 /* FIXME FIXME -- should be a break! we dont want to block the upper layers */
396 sleep((cur->conn->lastactivity + cur->conn->forcedlatency) - time(NULL));
399 /* XXX XXX XXX this should call the custom "queuing" function!! */
400 if (aim_tx_sendframe(sess, cur) == -1)
405 /* purge sent commands from queue */
406 aim_tx_purgequeue(sess);
412 * aim_tx_purgequeue()
414 * This is responsable for removing sent commands from the transmit
415 * queue. This is not a required operation, but it of course helps
416 * reduce memory footprint at run time!
419 faim_export void aim_tx_purgequeue(struct aim_session_t *sess)
421 struct command_tx_struct *cur = NULL;
422 struct command_tx_struct *tmp;
424 if (sess->queue_outgoing == NULL)
427 if (sess->queue_outgoing->next == NULL) {
428 if (!sess->queue_outgoing->lock && sess->queue_outgoing->sent) {
429 tmp = sess->queue_outgoing;
430 sess->queue_outgoing = NULL;
431 if (tmp->hdrtype == AIM_FRAMETYPE_OFT)
432 free(tmp->hdr.oft.hdr2);
439 for(cur = sess->queue_outgoing; cur->next != NULL; ) {
440 if (!cur->next->lock && cur->next->sent) {
442 cur->next = tmp->next;
443 if (tmp->hdrtype == AIM_FRAMETYPE_OFT)
444 free(tmp->hdr.oft.hdr2);
451 * Be careful here. Because of the way we just
452 * manipulated the pointer, cur may be NULL and
453 * the for() will segfault doing the check unless
454 * we find this case first.