[PATCH 08/14] lib: Simplify upgrade code using a transaction
authorAustin Clements <amdragon@MIT.EDU>
Sun, 27 Jul 2014 03:52:47 +0000 (23:52 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:03:52 +0000 (10:03 -0800)
14/5d9534280d7336a99fbb91392f5f9f8bda473d [new file with mode: 0644]

diff --git a/14/5d9534280d7336a99fbb91392f5f9f8bda473d b/14/5d9534280d7336a99fbb91392f5f9f8bda473d
new file mode 100644 (file)
index 0000000..dee51da
--- /dev/null
@@ -0,0 +1,190 @@
+Return-Path: <amdragon@mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 11196431FCB\r
+       for <notmuch@notmuchmail.org>; Sat, 26 Jul 2014 20:53:38 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -2.3\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id unXTh991hghl for <notmuch@notmuchmail.org>;\r
+       Sat, 26 Jul 2014 20:53:32 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-5.mit.edu (dmz-mailsec-scanner-5.mit.edu\r
+       [18.7.68.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id 344CD431FD2\r
+       for <notmuch@notmuchmail.org>; Sat, 26 Jul 2014 20:53:09 -0700 (PDT)\r
+X-AuditID: 12074422-f79be6d000007518-4f-53d477a2a55b\r
+Received: from mailhub-auth-2.mit.edu ( [18.7.62.36])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id DD.39.29976.2A774D35; Sat, 26 Jul 2014 23:53:07 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-2.mit.edu (8.13.8/8.9.2) with ESMTP id s6R3r4xh014368; \r
+       Sat, 26 Jul 2014 23:53:05 -0400\r
+Received: from drake.dyndns.org\r
+       (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
+       [216.15.114.40]) (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s6R3r0xt016402\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Sat, 26 Jul 2014 23:53:04 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1XBFW8-00051R-CS; Sat, 26 Jul 2014 23:53:00 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 08/14] lib: Simplify upgrade code using a transaction\r
+Date: Sat, 26 Jul 2014 23:52:47 -0400\r
+Message-Id: <1406433173-19169-9-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 2.0.0\r
+In-Reply-To: <1406433173-19169-1-git-send-email-amdragon@mit.edu>\r
+References: <1406433173-19169-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFlrHIsWRmVeSWpSXmKPExsUixG6noru4/EqwwbFJjBbXb85kdmD0eLbq\r
+       FnMAYxSXTUpqTmZZapG+XQJXxovn0QVr5Sr6unrYGhhfincxcnBICJhIbJ3t1MXICWSKSVy4\r
+       t54NxBYSmM0kcfxkRBcjF5C9kVHi8/FbTBDOHSaJbasesUI4cxkljm/+yQTSwiagIbFt/3JG\r
+       EFtEQFpi593ZrCAbmAXUJP50qYCEhQVcJSbefw+2gUVAVWLml72MICW8Ag4SV45XQxwhJ9Fw\r
+       4xNYCaeAo8TxZyfYQEqEgEpuXUqcwMi/gJFhFaNsSm6Vbm5iZk5xarJucXJiXl5qka6pXm5m\r
+       iV5qSukmRnCwuCjtYPx5UOkQowAHoxIPbwbblWAh1sSy4srcQ4ySHExKorz7zYBCfEn5KZUZ\r
+       icUZ8UWlOanFhxglOJiVRHiFioFyvCmJlVWpRfkwKWkOFiVx3rfWVsFCAumJJanZqakFqUUw\r
+       WRkODiUJXilgVAgJFqWmp1akZeaUIKSZODhBhvMADd9QCjK8uCAxtzgzHSJ/ilFRSpz3F0hC\r
+       ACSRUZoH1wuL5leM4kCvCPOylgFV8QATAVz3K6DBTECDWfwvgwwuSURISTUwxvznOXvj9+yW\r
+       mOyZWR/3/61+PWu+U5zVv+M/Zhtbt7rw1UjMe+OtKhU6LWnPYYdVaaEvXz7qsPi86NJXM8sN\r
+       TSaV5ytUFY7K996Rnn/3xGYzdgMLaeUDtxhnn4lPl3n1zs3bdlfElKKTE0WvLH5z8BBX/N8N\r
+       r8qaLG7xX13j1npKk+lx39JVbEosxRmJhlrMRcWJAHRQWqLBAgAA\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 27 Jul 2014 03:53:38 -0000\r
+\r
+Previously, the upgrade was organized as two passes -- an upgrade\r
+pass, and a separate cleanup pass -- so the database was always in a\r
+valid state.  This change substantially simplifies this code by\r
+performing the upgrade in a transaction and combining both passes in\r
+to one.  This 1) eliminates a lot of duplicate code between the\r
+passes, 2) speeds up the upgrade process, 3) makes progress reporting\r
+more accurate, 4) eliminates the potential for stale data if the\r
+upgrade is interrupted during the cleanup pass, and 5) makes it easier\r
+to reason about the safety of the upgrade code.\r
+---\r
+ lib/database.cc | 67 ++++++---------------------------------------------------\r
+ 1 file changed, 7 insertions(+), 60 deletions(-)\r
+\r
+diff --git a/lib/database.cc b/lib/database.cc\r
+index 03eef3e..0be7180 100644\r
+--- a/lib/database.cc\r
++++ b/lib/database.cc\r
+@@ -1238,6 +1238,9 @@ notmuch_database_upgrade (notmuch_database_t *notmuch,\r
+       timer_is_active = TRUE;\r
+     }\r
\r
++    /* Perform the upgrade in a transaction. */\r
++    db->begin_transaction (true);\r
++\r
+     /* Before version 1, each message document had its filename in the\r
+      * data field. Copy that into the new format by calling\r
+      * notmuch_message_add_filename.\r
+@@ -1265,6 +1268,7 @@ notmuch_database_upgrade (notmuch_database_t *notmuch,\r
+           filename = _notmuch_message_talloc_copy_data (message);\r
+           if (filename && *filename != '\0') {\r
+               _notmuch_message_add_filename (message, filename);\r
++              _notmuch_message_clear_data (message);\r
+               _notmuch_message_sync (message);\r
+           }\r
+           talloc_free (filename);\r
+@@ -1312,6 +1316,8 @@ notmuch_database_upgrade (notmuch_database_t *notmuch,\r
+                                                      NOTMUCH_FIND_CREATE, &status);\r
+               notmuch_directory_set_mtime (directory, mtime);\r
+               notmuch_directory_destroy (directory);\r
++\r
++              db->delete_document (*p);\r
+           }\r
+       }\r
+     }\r
+@@ -1353,67 +1359,8 @@ notmuch_database_upgrade (notmuch_database_t *notmuch,\r
+     notmuch->features |= NOTMUCH_FEATURES_CURRENT;\r
+     db->set_metadata ("features", _print_features (local, notmuch->features));\r
+     db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));\r
+-    db->flush ();\r
+-\r
+-    /* Now that the upgrade is complete we can remove the old data\r
+-     * and documents that are no longer needed. */\r
+-    if (version < 1) {\r
+-      notmuch_query_t *query = notmuch_query_create (notmuch, "");\r
+-      notmuch_messages_t *messages;\r
+-      notmuch_message_t *message;\r
+-      char *filename;\r
+-\r
+-      for (messages = notmuch_query_search_messages (query);\r
+-           notmuch_messages_valid (messages);\r
+-           notmuch_messages_move_to_next (messages))\r
+-      {\r
+-          if (do_progress_notify) {\r
+-              progress_notify (closure, (double) count / total);\r
+-              do_progress_notify = 0;\r
+-          }\r
+-\r
+-          message = notmuch_messages_get (messages);\r
+-\r
+-          filename = _notmuch_message_talloc_copy_data (message);\r
+-          if (filename && *filename != '\0') {\r
+-              _notmuch_message_clear_data (message);\r
+-              _notmuch_message_sync (message);\r
+-          }\r
+-          talloc_free (filename);\r
+-\r
+-          notmuch_message_destroy (message);\r
+-      }\r
\r
+-      notmuch_query_destroy (query);\r
+-    }\r
+-\r
+-    if (version < 1) {\r
+-      Xapian::TermIterator t, t_end;\r
+-\r
+-      t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");\r
+-\r
+-      for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");\r
+-           t != t_end;\r
+-           t++)\r
+-      {\r
+-          Xapian::PostingIterator p, p_end;\r
+-          std::string term = *t;\r
+-\r
+-          p_end = notmuch->xapian_db->postlist_end (term);\r
+-\r
+-          for (p = notmuch->xapian_db->postlist_begin (term);\r
+-               p != p_end;\r
+-               p++)\r
+-          {\r
+-              if (do_progress_notify) {\r
+-                  progress_notify (closure, (double) count / total);\r
+-                  do_progress_notify = 0;\r
+-              }\r
+-\r
+-              db->delete_document (*p);\r
+-          }\r
+-      }\r
+-    }\r
++    db->commit_transaction ();\r
\r
+     if (timer_is_active) {\r
+       /* Now stop the timer. */\r
+-- \r
+2.0.0\r
+\r