SERVER-33690 Transaction abort and commit should kill any associated client cursors

1 files changed, 34 insertions, 4 deletions

diff --git a/src/mongo/db/cursor_manager.h b/src/mongo/db/cursor_manager.h
index 90895407f53..2104a558bae 100644
--- a/src/mongo/db/cursor_manager.h
+++ b/src/mongo/db/cursor_manager.h
@@ -100,6 +100,20 @@ public:
     static std::pair<Status, int> killCursorsWithMatchingSessions(
         OperationContext* opCtx, const SessionKiller::Matcher& matcher);
 
+    /**
+     * Kills all cursors with matching logical session and transaction number. Returns the number of
+     * cursors successfully killed.
+     */
+    static size_t killAllCursorsForTransaction(OperationContext* opCtx,
+                                               LogicalSessionId lsid,
+                                               TxnNumber txnNumber);
+
+    /**
+     * Returns true if the CursorManager has cursor references for the given session ID and
+     * transaction number.
+     */
+    static bool hasTransactionCursorReference(LogicalSessionId lsid, TxnNumber txnNumber);
+
     CursorManager(NamespaceString nss);
 
     /**
@@ -110,7 +124,8 @@ public:
 
     /**
      * Kills all managed query executors and ClientCursors. Callers must have exclusive access to
-     * the collection (i.e. must have the collection, databse, or global resource locked in MODE_X).
+     * the collection (i.e. must have the collection, database, or global resource locked in
+     * MODE_X).
      *
      * 'collectionGoingAway' indicates whether the Collection instance is being deleted.  This could
      * be because the db is being closed, or the collection/db is being dropped.
@@ -182,9 +197,14 @@ public:
      * Returns ErrorCodes::CursorNotFound if the cursor id is not owned by this manager. Returns
      * ErrorCodes::OperationFailed if attempting to erase a pinned cursor.
      *
-     * If 'shouldAudit' is true, will perform audit logging.
+     * If 'shouldAudit' is true, will perform audit logging. If 'lsid' or 'txnNumber' are provided
+     * we will confirm that the cursor is owned by the given session or transaction.
      */
-    Status killCursor(OperationContext* opCtx, CursorId id, bool shouldAudit);
+    Status killCursor(OperationContext* opCtx,
+                      CursorId id,
+                      bool shouldAudit,
+                      boost::optional<LogicalSessionId> lsid = boost::none,
+                      boost::optional<TxnNumber> txnNumber = boost::none);
 
     /**
      * Returns an OK status if we're authorized to erase the cursor. Otherwise, returns
@@ -256,12 +276,22 @@ private:
     struct PlanExecutorPartitioner {
         std::size_t operator()(const PlanExecutor* exec, std::size_t nPartitions);
     };
+
+    // Adds a CursorId to structure that allows for lookup by LogicalSessionId and TxnNumber.
+    void addTransactionCursorReference(LogicalSessionId lsid,
+                                       TxnNumber txnNumber,
+                                       NamespaceString nss,
+                                       CursorId cursorId);
+
+    // Removes a CursorId from the LogicalSessionId / TxnNumber lookup structure.
+    void removeTransactionCursorReference(const ClientCursor* cursor);
+
     CursorId allocateCursorId_inlock();
 
     ClientCursorPin _registerCursor(
         OperationContext* opCtx, std::unique_ptr<ClientCursor, ClientCursor::Deleter> clientCursor);
 
-    void deregisterCursor(ClientCursor* cc);
+    void deregisterCursor(ClientCursor* cursor);
 
     void unpin(OperationContext* opCtx, ClientCursor* cursor);