c# - Thread.Abort causing deadlock in catch{} statement

Question

I have a set of threaded classes that print different types of documents. The classes use inheritance to share common code. The class constructor requires file name and printer name arguments. A Print() method creates a new worker thread, waits for the worker thread to complete using Thread.Join(timeout) and calls Thread.Abort() on the worker thread if the Join times out. The worker thread starts an application that can open the specified file, causes the file to be sent to printer synchronously (usually using application's Print method) and exits. The worker thread's code is wrapped in a try{} ... catch{} block to deal with any unforeseen crashes of the external application. The catch block contains minimal cleanup and logging.

    internal static FilePackage TryPrintDocumentToPdf(string Filename)
    {
                .....

                Logging.Log("Printing this file using PowerPoint.", Logging.LogLevel.Debug);
                printableFormat = true;

                fc = new FileCollector(Email2Pdf.Settings.Printer.PdfAttachmentCollectDirectoryObj, FileCollector.CollectMethods.FileCount | FileCollector.CollectMethods.FilesNotInUse | FileCollector.CollectMethods.ProcessExit);
                fc.FileCount = 1;
                fc.ProcessNames = new string[] { OfficePowerPointExe, Email2Pdf.Settings.Printer.PrinterExe };
                fc.Prepare();

                using (PowerPointPrinter printer = new PowerPointPrinter(Filename, Email2Pdf.Settings.Printer.PdfAttachmentPrinter))
                {
                    printer.KillApplicationOnClose = true;
                    printer.Print();
                    printOk = printer.PrintOk;
                }

                .....
    }

    internal abstract class ApplicationPrinter : IDisposable
    {
        protected abstract string applicationName { get; }

        protected string filename;
        protected string printer;

        protected bool workerPrintOk;
        protected bool printOk;
        public bool PrintOk { get { return printOk; } }
        public bool KillApplicationOnClose { get; set; }

        public void Print()
        {
            System.Threading.Thread worker = new System.Threading.Thread(printWorker);
            DateTime time = DateTime.Now;
            worker.Start();

            if (worker.Join(new TimeSpan(0, Email2Pdf.Settings.Printer.FileGenerateTimeOutMins, 0)))
            {
                printOk = workerPrintOk;
            }
            else
            {
                worker.Abort();
                printOk = false;
                Logging.Log("Timed out waiting for " + applicationName + " file " + filename + " to print.", Logging.LogLevel.Error);
            }
        }

        protected abstract void Close();
        protected abstract void printWorker();

        public virtual void Dispose() { Close(); }
    }
    internal class PowerPointPrinter : ApplicationPrinter
    {
        private const string appName = "PowerPoint";
        protected override string applicationName { get { return appName; } }
        private Microsoft.Office.Interop.PowerPoint.Application officePowerPoint = null;

        public PowerPointPrinter(string Filename, string Printer)
        {
            filename = Filename;
            printer = Printer;
            this.Dispose();
        }

        protected override void printWorker()
        {
            try
            {
                officePowerPoint = new Microsoft.Office.Interop.PowerPoint.Application();
                officePowerPoint.DisplayAlerts = Microsoft.Office.Interop.PowerPoint.PpAlertLevel.ppAlertsNone;

                Microsoft.Office.Interop.PowerPoint.Presentation doc = null;

                doc = officePowerPoint.Presentations.Open(
                    filename,
                    Microsoft.Office.Core.MsoTriState.msoTrue,
                    Microsoft.Office.Core.MsoTriState.msoFalse,
                    Microsoft.Office.Core.MsoTriState.msoFalse);
                doc.PrintOptions.ActivePrinter = printer;
                doc.PrintOptions.PrintInBackground = Microsoft.Office.Core.MsoTriState.msoFalse;
                doc.PrintOptions.OutputType = Microsoft.Office.Interop.PowerPoint.PpPrintOutputType.ppPrintOutputSlides;
                doc.PrintOut();

                System.Threading.Thread.Sleep(500);

                doc.Close();
                //Marshal.FinalReleaseComObject(doc);
                doc = null;

                workerPrintOk = true;
            }
            catch (System.Exception ex)
            {
                Logging.Log("Unable to print PowerPoint file " + filename + ". Exception: " + ex.Message, Logging.LogLevel.Error);
                Close();
                workerPrintOk = false;
            }
        }

        protected override void Close()
        {
            try
            {
                if (officePowerPoint != null)
                    officePowerPoint.Quit();
                Marshal.FinalReleaseComObject(officePowerPoint);
                officePowerPoint = null;
                if (KillApplicationOnClose)
                    Utility.KillProcessesByName(OfficePowerPointExe);
            }
            catch { }
        }
    }

I found my application non-responsive, with the main thread in a Sleep/Wait/Join at the Thread.Abort() line. I do not recall the status of the worker thread, but the logging that was supposed to be performed in the catch{} block did not take place. (I Attached to my process with VS2010 after I found it non-responsive).

I refer to the following Note from the Thread.Abort Method:

The thread that calls Abort might block if the thread that is being aborted is in a protected region of code, such as a catch block, finally block, or constrained execution region. If the thread that calls Abort holds a lock that the aborted thread requires, a deadlock can occur.

I believe I have a dead-locking issue because (1) it does not always happen, and (2) because of the Note on MSDN (above).

1. The Note appears to suggest that using try{} ... catch{} is NEVER safe inside a thread if the thread can be Abort()'ed. Is this true?
2. I do not see how I can avoid using Abort() in my scenario. Will using Thread.Interrupt() instead make any difference?
3. How to I fix the dead-locking issue I have?

BackgroundWorker does not work for me because I do not need progress reporting and, more importantly, it is possible that my worker thread will block indefinitely when it executes third party applications. For the same reason, I cannot ask my thread to terminate, but have one option only - to ruthlessly Abort() the worker thread.

Answer 1

あなたのメカニズムの使用Thread.Abort()は良いものではありません。実際、電話Thread.Abort()は避けるべきです。

中止されるスレッドがコードの保護された領域 (catch ブロック、finally ブロック、または制約付き実行領域など) にある場合、Abort を呼び出すスレッドはブロックされる可能性があります。Abort を呼び出すスレッドが、中止されたスレッドが必要とするロックを保持している場合、デッドロックが発生する可能性があります。 参照。

代わりに、キャンセル、進行状況レポート (および完了イベントでの UI スレッドへの自動マーシャリング) をサポートするBackgroundWorkerを使用してください。

Answer 2

次の変更を加えることで解決策を見つけたと思います。

1. ワーカースレッドがブロックを実行していることがわかっThread.Abort()ている場合は、呼び出さないでください（以下を参照）。catch{}protected volatile bool isPrinting

2. 別のスレッドを使用してThread.Abort()、コンテキストスイッチを呼び出して奨励しますSleep(0)（以下をprivate void AbortPrintWorker()参照）。

   internal abstract class ApplicationPrinter : IDisposable
   {
       protected abstract string applicationName { get; }
   
       protected string filename;
       protected string printer;
   
       protected bool workerPrintOk;
       protected bool printOk;
       public bool PrintOk { get { return printOk; } }
       public bool KillApplicationOnClose { get; set; }
   
       protected System.Threading.Thread worker;
       protected volatile bool isPrinting;
   
       public void Print()
       {
           worker = new System.Threading.Thread(printWorker);
           DateTime time = DateTime.Now;
           worker.Start();
   
           if (worker.Join(new TimeSpan(0, Email2Pdf.Settings.Printer.FileGenerateTimeOutMins, 0)))
           {
               printOk = workerPrintOk;
           }
           else
           {
               AbortPrintWorker();
               printOk = false;
               Logging.Log("Timed out waiting for " + applicationName + " file " + filename + " to print.", Logging.LogLevel.Error);
           }
       }
       protected abstract void printWorker();
   
       public abstract void Dispose();
   
       private void AbortPrintWorker()
       {
           System.Threading.Thread abortThread = new System.Threading.Thread(abortWorker);
           if (isPrinting)
           {
               abortThread.Start();
               System.Threading.Thread.Sleep(0);
               abortThread.Join();
           }
           else
           {
               worker.Join();
           }
       }
   
       private void abortWorker()
       {
           worker.Abort();
           worker.Join();
       }
   }
   
   internal class PowerPointPrinter : ApplicationPrinter
   {
       private const string appName = "PowerPoint";
       protected override string applicationName { get { return appName; } }
       private Microsoft.Office.Interop.PowerPoint.Application officePowerPoint = null;
   
       public PowerPointPrinter(string Filename, string Printer)
       {
           filename = Filename;
           printer = Printer;
           this.Dispose();
       }
   
       protected override void printWorker()
       {
           try
           {
               isPrinting = true;
   
               officePowerPoint = new Microsoft.Office.Interop.PowerPoint.Application();
               officePowerPoint.DisplayAlerts = Microsoft.Office.Interop.PowerPoint.PpAlertLevel.ppAlertsNone;
   
               Microsoft.Office.Interop.PowerPoint.Presentation doc = null;
   
               doc = officePowerPoint.Presentations.Open(
                   filename,
                   Microsoft.Office.Core.MsoTriState.msoTrue,
                   Microsoft.Office.Core.MsoTriState.msoFalse,
                   Microsoft.Office.Core.MsoTriState.msoFalse);
               doc.PrintOptions.ActivePrinter = printer;
               doc.PrintOptions.PrintInBackground = Microsoft.Office.Core.MsoTriState.msoFalse;
               doc.PrintOptions.OutputType = Microsoft.Office.Interop.PowerPoint.PpPrintOutputType.ppPrintOutputSlides;
               doc.PrintOut();
   
               System.Threading.Thread.Sleep(500);
   
               doc.Close();
               Marshal.FinalReleaseComObject(doc);
               doc = null;
   
               workerPrintOk = true;
   
               isPrinting = true;
           }
           catch (System.Exception ex)
           {
               isPrinting = false;
   
               Logging.Log("Unable to print PowerPoint file " + filename + ". Exception: " + ex.Message, Logging.LogLevel.Error);
               workerPrintOk = false;
           }
       }
   
       public override void Dispose()
       {
           try
           {
               if (officePowerPoint != null)
                   officePowerPoint.Quit();
               Marshal.FinalReleaseComObject(officePowerPoint);
               officePowerPoint = null;
               if (KillApplicationOnClose)
                   Utility.KillProcessesByName(OfficePowerPointExe);
           }
           catch { }
       }
   }
   

AbortPrintWorker()Abort()ワーカースレッドを呼び出すための別のスレッドを作成します。これは、次の注で強調表示されている問題を扱っていると思いますAbort()。

中止されるスレッドがcatchブロック、finallyブロック、制約付き実行領域などの保護されたコード領域にある場合、Abortを呼び出すスレッドがブロックする可能性があります。Abortを呼び出すスレッドが、中止されたスレッドが必要とするロックを保持している場合、デッドロックが発生する可能性があります。

これは正しいです？

Answer 3

PowerPoint ドキュメントを印刷するために、基本的に PowerPoint アプリケーションをリモート コントロールしているように見えます。したがって、アプリケーションが画面に表示する (または表示しようとした) ダイアログ ボックスが表示される可能性があります。このすべてがバックグラウンド (サーバーなど) で実行されている場合、そのようなダイアログを閉じるユーザーがいない可能性があるため、問題の一部が説明される可能性があります。私のお勧めは、PowerPoint アプリケーションに依存することなく、PPT ファイルを読み込んで印刷 (または PDF に変換して印刷) できるサードパーティのライブラリを調べることです。そうすれば、制御外の外部アプリを待つ必要がなくなり、スレッドを強制的に中止する必要がなくなります。