Changeset 5495:36aa1130091a

Timestamp:

2008-08-25 00:52:17 (3 months ago)

Author:

Brendan Cully <brendan@…>

Branch:

HEAD

Message:

Introduce $imap_pipeline_depth.
This lets users control the number of commands that mutt will queue up
before sending them to the server. Setting this to 0 disables
pipelining, which should close #2892.

Files:

• ChangeLog (modified) (2 diffs)
• UPDATING (modified) (1 diff)
• globals.h (modified) (1 diff)
• imap/command.c (modified) (4 diffs)
• imap/imap.c (modified) (1 diff)
• imap/imap_private.h (modified) (2 diffs)
• imap/util.c (modified) (2 diffs)
• init.c (modified) (1 diff)
• init.h (modified) (1 diff)

ChangeLog

@@ -1 @@
-2008-08-24 17:06 +0200  Rocco Rutte  <pdmef@gmx.net>  (fec35f9ad30f)
+2008-08-25 00:16 -0700  Brendan Cully  <brendan@kublai.com>  (53d9210aa4ee)
+
+        * imap/command.c, imap/imap.c, imap/imap_private.h, imap/message.c:
+        Rework IMAP command queueing to allow pipelining to be disabled.
+        IDLE handling has been better abstracted, and there are fewer entry
+        points to the IMAP command issuing machinery. Any commands that are
+        simply queued may be executed whenever the pipeline fills, instead
+        of requiring explicit handling in the caller.
+
+        Tested on my Cyrus server, but I wouldn't be surprise if this causes
+        new problems.
+
+2008-08-24 20:01 +0200  Rocco Rutte  <pdmef@gmx.net>  (045c5942e1ad)
+
+        * doc/manual.xml.head: Manual: Fix DTD validation error and
+        message header display section
 
         * doc/manual.xml.head: Manual: Fix typo
 
-2008-08-24 17:03 +0200  Rocco Rutte  <pdmef@gmx.net>  (a2fc5e7c77ae)
-
-        * ChangeLog, doc/manual.xml.head: Manual: Fix style and typos. Noted
-        by Vincent Lefevre, see #3109.
+        * doc/manual.xml.head: Manual: Fix style and typos. Noted by
+        Vincent Lefevre, see #3109.
 
 2008-08-23 15:25 -0700  Brendan Cully  <brendan@kublai.com>  (1f9849496bc2)
@@ -12 +25 @@
         * main.c: Whitespace cleanup
 
-2008-08-23 15:21 -0700  Brendan Cully  <brendan@kublai.com>  (63efed810906)
-
-        * ChangeLog, main.c: Fix infinite loop with "mutt -", introduced in
+        * main.c: Fix infinite loop with "mutt -", introduced in
         [31c9e9727d42]. Treats - as a non-option argument. It would be
         reasonable to treat it as an error instead.

UPDATING

@@ -7 +7 @@
 hg tip:
 
+  + $imap_pipeline_depth controls the number of commands that mutt can issue
+    to an IMAP server before it must collect the responses
   + $ssl_client_cert available with gnutls as well as openssl
   + 'mime_lookup application/octet-stream' added to system Muttrc

globals.h

@@ -210 +210 @@
 #ifdef USE_IMAP
 WHERE short ImapKeepalive;
+WHERE short ImapPipelineDepth;
 #endif
 

imap/command.c

@@ -158 +158 @@
         {
           /* first command in queue has finished - move queue pointer up */
-          idata->lastcmd = (idata->lastcmd + 1) % IMAP_PIPELINE_DEPTH;
+          idata->lastcmd = (idata->lastcmd + 1) % idata->cmdslots;
         }
         cmd->state = cmd_status (idata->buf);
@@ -169 +169 @@
     }
 
-    c = (c + 1) % IMAP_PIPELINE_DEPTH;
+    c = (c + 1) % idata->cmdslots;
   }
   while (c != idata->nextcmd);
@@ -309 +309 @@
 static int cmd_queue_full (IMAP_DATA* idata)
 {
-  if ((idata->nextcmd + 1) % IMAP_PIPELINE_DEPTH == idata->lastcmd)
+  if ((idata->nextcmd + 1) % idata->cmdslots == idata->lastcmd)
     return 1;
 
@@ -328 +328 @@
 
   cmd = idata->cmds + idata->nextcmd;
-  idata->nextcmd = (idata->nextcmd + 1) % IMAP_PIPELINE_DEPTH;
+  idata->nextcmd = (idata->nextcmd + 1) % idata->cmdslots;
 
   snprintf (cmd->seq, sizeof (cmd->seq), "a%04u", idata->seqno++);

imap/imap.c

@@ -487 +487 @@
   idata->state = IMAP_DISCONNECTED;
   idata->seqno = idata->nextcmd = idata->lastcmd = idata->status = 0;
-  memset (idata->cmds, 0, sizeof (IMAP_COMMAND) * IMAP_PIPELINE_DEPTH);
+  memset (idata->cmds, 0, sizeof (IMAP_COMMAND) * idata->cmdslots);
 }
 

imap/imap_private.h

@@ -54 +54 @@
 /* number of entries in the hash table */
 #define IMAP_CACHE_LEN 10
-
-/* number of commands that can be batched into a single request
- * ( - 1, for the easy way to detect ring buffer wrap) */
-#define IMAP_PIPELINE_DEPTH 15
 
 #define SEQLEN 5
@@ -191 +187 @@
 
   /* command queue */
-  IMAP_COMMAND cmds[IMAP_PIPELINE_DEPTH];
+  IMAP_COMMAND* cmds;
+  int cmdslots;
   int nextcmd;
   int lastcmd;

imap/util.c

@@ -355 +355 @@
     FREE (&idata);
 
+  idata->cmdslots = ImapPipelineDepth + 2;
+  if (!(idata->cmds = safe_calloc(idata->cmdslots, sizeof(*idata->cmds))))
+  {
+    mutt_buffer_free(&idata->cmdbuf);
+    FREE (&idata);
+  }
+
   return idata;
 }
@@ -370 +377 @@
   FREE (&(*idata)->buf);
   mutt_bcache_close (&(*idata)->bcache);
+  FREE (&(*idata)->cmds);
   FREE (idata);         /* __FREE_CHECKED__ */
 }

init.c

@@ -2117 +2117 @@
           *ptr = -*ptr;
       }
+#ifdef USE_IMAP
+      else if (mutt_strcmp (MuttVars[idx].option, "imap_pipeline_depth") == 0)
+      {
+        if (*ptr < 0)
+          *ptr = 0;
+      }
+#endif
     }
     else if (DTYPE (MuttVars[idx].type) == DT_QUAD)

init.h

@@ -969 +969 @@
   ** but can make closing an IMAP folder somewhat slower. This option
   ** exists to appease speed freaks.
+  */
+  { "imap_pipeline_depth", DT_NUM,  R_NONE, UL &ImapPipelineDepth, 15 },
+  /*
+  ** .pp
+  ** Controls the number of IMAP commands that may be queued up before they
+  ** are sent to the server. A deeper pipeline reduces the amount of time
+  ** mutt must wait for the server, and can make IMAP servers feel much
+  ** more responsive. But not all servers correctly handle pipelined commands,
+  ** so if you have problems you might want to try setting this variable to 0.
+  ** .pp
+  ** \fBNote:\fP Changes to this variable have no effect on open connections.
   */
   { "imap_servernoise",         DT_BOOL, R_NONE, OPTIMAPSERVERNOISE, 1 },