src/ppapi/native_client/src/trusted/plugin/pnacl_translate_thread.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef NATIVE_CLIENT_SRC_TRUSTED_PLUGIN_PNACL_TRANSLATE_THREAD_H_
   6 #define NATIVE_CLIENT_SRC_TRUSTED_PLUGIN_PNACL_TRANSLATE_THREAD_H_
   7
   8 #include <deque>
   9 #include <vector>
  10
  11 #include "native_client/src/include/nacl_macros.h"
  12 #include "native_client/src/include/nacl_scoped_ptr.h"
  13 #include "native_client/src/include/nacl_string.h"
  14 #include "native_client/src/shared/platform/nacl_threads.h"
  15 #include "native_client/src/shared/platform/nacl_sync_checked.h"
  16
  17 #include "ppapi/cpp/completion_callback.h"
  18
  19 #include "ppapi/native_client/src/trusted/plugin/plugin_error.h"
  20 #include "ppapi/native_client/src/trusted/plugin/service_runtime.h"
  21
  22 struct PP_PNaClOptions;
  23
  24 namespace nacl {
  25 class DescWrapper;
  26 }
  27
  28
  29 namespace plugin {
  30
  31 class NaClSubprocess;
  32 class Plugin;
  33 class PnaclCoordinator;
  34 class PnaclResources;
  35 class TempFile;
  36
  37 class PnaclTranslateThread {
  38  public:
  39   PnaclTranslateThread();
  40   ~PnaclTranslateThread();
  41
  42   // Start the translation process. It will continue to run and consume data
  43   // as it is passed in with PutBytes.
  44   void RunTranslate(const pp::CompletionCallback& finish_callback,
  45                     int32_t manifest_id,
  46                     const std::vector<TempFile*>* obj_files,
  47                     TempFile* nexe_file,
  48                     nacl::DescWrapper* invalid_desc_wrapper,
  49                     ErrorInfo* error_info,
  50                     PnaclResources* resources,
  51                     PP_PNaClOptions* pnacl_options,
  52                     const nacl::string &architecture_attributes,
  53                     PnaclCoordinator* coordinator,
  54                     Plugin* plugin);
  55
  56   // Kill the llc and/or ld subprocesses. This happens by closing the command
  57   // channel on the plugin side, which causes the trusted code in the nexe to
  58   // exit, which will cause any pending SRPCs to error. Because this is called
  59   // on the main thread, the translation thread must not use the subprocess
  60   // objects without the lock, other than InvokeSrpcMethod, which does not
  61   // race with service runtime shutdown.
  62   void AbortSubprocesses();
  63
  64   // Send bitcode bytes to the translator. Called from the main thread.
  65   void PutBytes(std::vector<char>* data, int count);
  66
  67   int64_t GetCompileTime() const { return compile_time_; }
  68
  69  private:
  70   // Starts an individual llc or ld subprocess used for translation.
  71   NaClSubprocess* StartSubprocess(const nacl::string& url,
  72                                   int32_t manifest_id,
  73                                   ErrorInfo* error_info);
  74   // Helper thread entry point for translation. Takes a pointer to
  75   // PnaclTranslateThread and calls DoTranslate().
  76   static void WINAPI DoTranslateThread(void* arg);
  77   // Runs the streaming translation. Called from the helper thread.
  78   void DoTranslate() ;
  79   // Signal that Pnacl translation failed, from the translation thread only.
  80   void TranslateFailed(PP_NaClError err_code,
  81                        const nacl::string& error_string);
  82   // Run the LD subprocess, returning true on success.
  83   // On failure, it returns false and runs the callback.
  84   bool RunLdSubprocess();
  85
  86
  87   // Callback to run when tasks are completed or an error has occurred.
  88   pp::CompletionCallback report_translate_finished_;
  89
  90   nacl::scoped_ptr<NaClThread> translate_thread_;
  91
  92   // Used to guard llc_subprocess and ld_subprocess
  93   struct NaClMutex subprocess_mu_;
  94   nacl::scoped_ptr<NaClSubprocess> llc_subprocess_;
  95   nacl::scoped_ptr<NaClSubprocess> ld_subprocess_;
  96   // Used to ensure the subprocesses don't get shutdown more than once.
  97   bool llc_subprocess_active_;
  98   bool ld_subprocess_active_;
  99
 100   // Condition variable to synchronize communication with the SRPC thread.
 101   // SRPC thread waits on this condvar if data_buffers_ is empty (meaning
 102   // there is no bitcode to send to the translator), and the main thread
 103   // appends to data_buffers_ and signals it when it receives bitcode.
 104   struct NaClCondVar buffer_cond_;
 105   // Mutex for buffer_cond_.
 106   struct NaClMutex cond_mu_;
 107   // Data buffers from FileDownloader are enqueued here to pass from the
 108   // main thread to the SRPC thread. Protected by cond_mu_
 109   std::deque<std::vector<char> > data_buffers_;
 110   // Whether all data has been downloaded and copied to translation thread.
 111   // Associated with buffer_cond_
 112   bool done_;
 113
 114   int64_t compile_time_;
 115
 116   // Data about the translation files, owned by the coordinator
 117   int32_t manifest_id_;
 118   const std::vector<TempFile*>* obj_files_;
 119   TempFile* nexe_file_;
 120   nacl::DescWrapper* invalid_desc_wrapper_;
 121   ErrorInfo* coordinator_error_info_;
 122   PnaclResources* resources_;
 123   PP_PNaClOptions* pnacl_options_;
 124   nacl::string architecture_attributes_;
 125   PnaclCoordinator* coordinator_;
 126   Plugin* plugin_;
 127  private:
 128   NACL_DISALLOW_COPY_AND_ASSIGN(PnaclTranslateThread);
 129 };
 130
 131 }
 132 #endif // NATIVE_CLIENT_SRC_TRUSTED_PLUGIN_PNACL_TRANSLATE_THREAD_H_