[PATCH v3 07/13] lib: Simplify upgrade code using a transaction
authorAustin Clements <amdragon@MIT.EDU>
Fri, 1 Aug 2014 02:09:57 +0000 (22:09 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:04:01 +0000 (10:04 -0800)
0f/0119d8312252dd8410545835aab14cfe939469 [new file with mode: 0644]

diff --git a/0f/0119d8312252dd8410545835aab14cfe939469 b/0f/0119d8312252dd8410545835aab14cfe939469
new file mode 100644 (file)
index 0000000..7fb111f
--- /dev/null
@@ -0,0 +1,192 @@
+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 AFEB5431FAE\r
+       for <notmuch@notmuchmail.org>; Thu, 31 Jul 2014 19:10:41 -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 DBTBiPRJjygY for <notmuch@notmuchmail.org>;\r
+       Thu, 31 Jul 2014 19:10:35 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-4.mit.edu (dmz-mailsec-scanner-4.mit.edu\r
+       [18.9.25.15])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id E2879431FC7\r
+       for <notmuch@notmuchmail.org>; Thu, 31 Jul 2014 19:10:13 -0700 (PDT)\r
+X-AuditID: 1209190f-f79f86d0000061c8-52-53daf705e6da\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-4.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id C3.6F.25032.507FAD35; Thu, 31 Jul 2014 22:10:13 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id s712ABwd010410; \r
+       Thu, 31 Jul 2014 22:10:11 -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 s712A9pU030240\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Thu, 31 Jul 2014 22:10:10 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1XD2II-00033l-1t; Thu, 31 Jul 2014 22:10:06 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v3 07/13] lib: Simplify upgrade code using a transaction\r
+Date: Thu, 31 Jul 2014 22:09:57 -0400\r
+Message-Id: <1406859003-11561-8-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 2.0.0\r
+In-Reply-To: <1406859003-11561-1-git-send-email-amdragon@mit.edu>\r
+References: <1406859003-11561-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrLIsWRmVeSWpSXmKPExsUixG6nrsv6/VawQetibovVc3ksrt+cyezA\r
+       5LFz1l12j2erbjEHMEVx2aSk5mSWpRbp2yVwZez9+oe94J5sxZGPf5gbGJeLdzFyckgImEis\r
+       /tTPBmGLSVy4tx7I5uIQEpjNJNG0/BkrhLORUWLx+w2MEM4dJonPry5BOXMZJR59aAHrZxPQ\r
+       kNi2fzkjiC0iIC2x8+5sVhCbWcBR4vP+RWA1wgIeEj97pjKD2CwCqhIv5pwAs3kFHCRmflzL\r
+       BHGHnETDjU9g9ZxAvf//LQCbIwRU03p6K/MERv4FjAyrGGVTcqt0cxMzc4pTk3WLkxPz8lKL\r
+       dE30cjNL9FJTSjcxgkKJU5J/B+O3g0qHGAU4GJV4eB1CbwULsSaWFVfmHmKU5GBSEuW1+QgU\r
+       4kvKT6nMSCzOiC8qzUktPsQowcGsJML78gNQjjclsbIqtSgfJiXNwaIkzvvW2ipYSCA9sSQ1\r
+       OzW1ILUIJivDwaEkwXvmK1CjYFFqempFWmZOCUKaiYMTZDgP0PBrIDW8xQWJucWZ6RD5U4yK\r
+       UuK8e0ASAiCJjNI8uF5YrL9iFAd6RZj3IUgVDzBNwHW/AhrMBDT4+a3rIINLEhFSUg2MboHP\r
+       T10SNroyY+feXI9lZi/iLm/pqGhwfjS97fR5IaPq2ROcdhfN/1I650SS9M17kxp/yl50SlRh\r
+       fHrs5lzHCbq3/uTs6PBWD11d90OpovX+40tr2cN0V67+OXPapInbGpaLxDv+D36+JqDVhiO0\r
+       fevZ/W0b2HiUM6TPV7PutatjLH+T/VvBXYmlOCPRUIu5qDgRACnh8izQAgAA\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: Fri, 01 Aug 2014 02:10:42 -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 29a56db..faeab51 100644\r
+--- a/lib/database.cc\r
++++ b/lib/database.cc\r
+@@ -1232,6 +1232,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
+     /* Set the target features so we write out changes in the desired\r
+      * format. */\r
+     notmuch->features |= NOTMUCH_FEATURES_CURRENT;\r
+@@ -1263,6 +1266,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
+@@ -1310,6 +1314,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
+@@ -1350,67 +1356,8 @@ notmuch_database_upgrade (notmuch_database_t *notmuch,\r
\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