pnacl_translate_thread.h revision 5d1f7b1de12d16ceb2c938c56701a3e8bfa558f7 
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
22namespace nacl {
23class DescWrapper;
24}
25
26
27namespace plugin {
28
29class Manifest;
30class NaClSubprocess;
31class Plugin;
32class PnaclCoordinator;
33class PnaclOptions;
34class PnaclResources;
35class TempFile;
36
37struct PnaclTimeStats {
38  int64_t pnacl_llc_load_time;
39  int64_t pnacl_compile_time;
40  int64_t pnacl_ld_load_time;
41  int64_t pnacl_link_time;
42};
43
44class PnaclTranslateThread {
45 public:
46  PnaclTranslateThread();
47  ~PnaclTranslateThread();
48
49  // Start the translation process. It will continue to run and consume data
50  // as it is passed in with PutBytes.
51  void RunTranslate(const pp::CompletionCallback& finish_callback,
52                    const Manifest* manifest,
53                    const std::vector<TempFile*>* obj_files,
54                    TempFile* nexe_file,
55                    nacl::DescWrapper* invalid_desc_wrapper,
56                    ErrorInfo* error_info,
57                    PnaclResources* resources,
58                    PnaclOptions* pnacl_options,
59                    PnaclCoordinator* coordinator,
60                    Plugin* plugin);
61
62  // Kill the llc and/or ld subprocesses. This happens by closing the command
63  // channel on the plugin side, which causes the trusted code in the nexe to
64  // exit, which will cause any pending SRPCs to error. Because this is called
65  // on the main thread, the translation thread must not use the subprocess
66  // objects without the lock, other than InvokeSrpcMethod, which does not
67  // race with service runtime shutdown.
68  void AbortSubprocesses();
69
70  // Send bitcode bytes to the translator. Called from the main thread.
71  void PutBytes(std::vector<char>* data, int count);
72
73  const PnaclTimeStats& GetTimeStats() const { return time_stats_; }
74
75 private:
76  // Starts an individual llc or ld subprocess used for translation.
77  NaClSubprocess* StartSubprocess(const nacl::string& url,
78                                  const Manifest* manifest,
79                                  ErrorInfo* error_info);
80  // Helper thread entry point for translation. Takes a pointer to
81  // PnaclTranslateThread and calls DoTranslate().
82  static void WINAPI DoTranslateThread(void* arg);
83  // Runs the streaming translation. Called from the helper thread.
84  void DoTranslate() ;
85  // Signal that Pnacl translation failed, from the translation thread only.
86  void TranslateFailed(enum PluginErrorCode err_code,
87                       const nacl::string& error_string);
88  // Run the LD subprocess, returning true on success
89  bool RunLdSubprocess(int modules_used,
90                       int is_shared_library,
91                       const nacl::string& soname,
92                       const nacl::string& lib_dependencies);
93
94
95  // Callback to run when tasks are completed or an error has occurred.
96  pp::CompletionCallback report_translate_finished_;
97
98  nacl::scoped_ptr<NaClThread> translate_thread_;
99
100  // Used to guard llc_subprocess and ld_subprocess
101  struct NaClMutex subprocess_mu_;
102  nacl::scoped_ptr<NaClSubprocess> llc_subprocess_;
103  nacl::scoped_ptr<NaClSubprocess> ld_subprocess_;
104  // Used to ensure the subprocesses don't get shutdown more than once.
105  bool llc_subprocess_active_;
106  bool ld_subprocess_active_;
107
108  // Condition variable to synchronize communication with the SRPC thread.
109  // SRPC thread waits on this condvar if data_buffers_ is empty (meaning
110  // there is no bitcode to send to the translator), and the main thread
111  // appends to data_buffers_ and signals it when it receives bitcode.
112  struct NaClCondVar buffer_cond_;
113  // Mutex for buffer_cond_.
114  struct NaClMutex cond_mu_;
115  // Data buffers from FileDownloader are enqueued here to pass from the
116  // main thread to the SRPC thread. Protected by cond_mu_
117  std::deque<std::vector<char> > data_buffers_;
118  // Whether all data has been downloaded and copied to translation thread.
119  // Associated with buffer_cond_
120  bool done_;
121
122  PnaclTimeStats time_stats_;
123
124  // Data about the translation files, owned by the coordinator
125  const Manifest* manifest_;
126  const std::vector<TempFile*>* obj_files_;
127  TempFile* nexe_file_;
128  nacl::DescWrapper* invalid_desc_wrapper_;
129  ErrorInfo* coordinator_error_info_;
130  PnaclResources* resources_;
131  PnaclOptions* pnacl_options_;
132  PnaclCoordinator* coordinator_;
133  Plugin* plugin_;
134 private:
135  NACL_DISALLOW_COPY_AND_ASSIGN(PnaclTranslateThread);
136};
137
138}
139#endif // NATIVE_CLIENT_SRC_TRUSTED_PLUGIN_PNACL_TRANSLATE_THREAD_H_
140