rstudio/src/cpp/session/SessionAsyncRProcess.cpp at master · pearsonca/rstudio · GitHub

History

301 lines (249 loc) · 8.06 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

* SessionAsyncRProcess.cpp

* Unless you have received this program directly from RStudio pursuant

* to the terms of a commercial license agreement with RStudio, then

* this program is licensed to you under the terms of version 3 of the

* GNU Affero General Public License. This program is distributed WITHOUT

* ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,

* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the

* AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.

#include <session/prefs/UserPrefs.hpp>

#include <session/SessionConsoleProcess.hpp>

#include <session/SessionModuleContext.hpp>

#include <core/system/Environment.hpp>

#include <core/system/Process.hpp>

#include <r/RExec.hpp>

#include <r/session/RSessionUtils.hpp>

#include <session/SessionAsyncRProcess.hpp>

namespace rstudio {

namespace session {

namespace async_r {

AsyncRProcess::AsyncRProcess():

isRunning_(false),

terminationRequested_(false)

{

}

void AsyncRProcess::start(const char* rCommand,

core::system::Options environment,

const core::FilePath& workingDir,

AsyncRProcessOptions rOptions,

std::vector<core::FilePath> rSourceFiles,

const std::string& input)

{

// file paths to be used for IPC (if any) requested by child process

ipcRequests_ = module_context::tempFile("rstudio-ipc-requests-", "rds");

ipcResponse_ = module_context::tempFile("rstudio-ipc-response-", "rds");

sharedSecret_ = core::system::generateUuid();

// R binary

core::FilePath rProgramPath;

core::Error error = module_context::rScriptPath(&rProgramPath);

if (error)

{

LOG_ERROR(error);

onCompleted(EXIT_FAILURE);

return;

}

// core R files for augmented async processes

if (rOptions & R_PROCESS_AUGMENTED)

{

// R files we wish to source to provide functionality to async process

const core::FilePath modulesPath =

session::options().modulesRSourcePath();

const core::FilePath rPath =

session::options().coreRSourcePath();

const core::FilePath rTools = rPath.completeChildPath("Tools.R");

// insert at begin as Tools.R needs to be sourced first

rSourceFiles.insert(rSourceFiles.begin(), rTools);

}

// args

std::vector<std::string> args;

args.push_back("--slave");

if (rOptions & R_PROCESS_VANILLA)

args.push_back("--vanilla");

if (rOptions & R_PROCESS_NO_RDATA)

{

args.push_back("--no-save");

args.push_back("--no-restore");

}

// for windows we need to forward setInternet2

#ifdef _WIN32

if (!r::session::utils::isR3_3() && prefs::userPrefs().useInternet2())

args.push_back("--internet2");

#endif

args.push_back("-e");

bool needsQuote = false;

// On Windows, we turn the vector of strings into a single

// string to send over the command line, so we must ensure

// that the arguments following '-e' are quoted, so that

// they are all interpretted as a single argument (rather

// than multiple arguments) to '-e'.

#ifdef _WIN32

needsQuote = strlen(rCommand) > 0 && rCommand[0] != '"';

#endif

std::stringstream command;

if (needsQuote)

command << "\"";

std::string escapedCommand = rCommand;

if (needsQuote)

boost::algorithm::replace_all(escapedCommand, "\"", "\\\"");

if (rSourceFiles.size())

{

// add in the r source files requested

for (std::vector<core::FilePath>::const_iterator it = rSourceFiles.begin();

it != rSourceFiles.end();

++it)

{

command << "source('" << it->getAbsolutePath() << "');";

}

command << escapedCommand;

}

else

{

command << escapedCommand;

}

if (needsQuote)

command << "\"";

args.push_back(command.str());

// options

core::system::ProcessOptions options;

options.terminateChildren = true;

if (rOptions & R_PROCESS_REDIRECTSTDERR)

options.redirectStdErrToStdOut = true;

// if a working directory was specified, use it

if (!workingDir.isEmpty())

{

options.workingDir = workingDir;

}

// forward R_LIBS so the child process has access to the same libraries

// we do

core::system::Options childEnv;

core::system::environment(&childEnv);

std::string libPaths = module_context::libPathsString();

if (!libPaths.empty())

{

core::system::setenv(&childEnv, "R_LIBS", libPaths);

}

// forward passed environment variables

for (const core::system::Option& var : environment)

{

core::system::setenv(&childEnv, var.first, var.second);

}

// set environment variables used for IPC

core::system::setenv(&childEnv, "RSTUDIOAPI_IPC_REQUESTS_FILE", ipcRequests_.getAbsolutePath());

core::system::setenv(&childEnv, "RSTUDIOAPI_IPC_RESPONSE_FILE", ipcResponse_.getAbsolutePath());

core::system::setenv(&childEnv, "RSTUDIOAPI_IPC_SHARED_SECRET", sharedSecret_);

// update environment used for child process

options.environment = childEnv;

core::system::ProcessCallbacks cb;

using namespace module_context;

cb.onContinue = boost::bind(&AsyncRProcess::onContinue,

AsyncRProcess::shared_from_this());

cb.onStdout = boost::bind(&AsyncRProcess::onStdout,

AsyncRProcess::shared_from_this(),

_2);

cb.onStderr = boost::bind(&AsyncRProcess::onStderr,

AsyncRProcess::shared_from_this(),

_2);

cb.onExit = boost::bind(&AsyncRProcess::onProcessCompleted,

AsyncRProcess::shared_from_this(),

_1);

cb.onStarted = boost::bind(&AsyncRProcess::onStarted,

AsyncRProcess::shared_from_this(),

_1);

// forward input if requested

input_ = input;

error = module_context::processSupervisor().runProgram(

rProgramPath.getAbsolutePath(),

args,

options,

cb);

if (error)

{

LOG_ERROR(error);

onCompleted(EXIT_FAILURE);

}

else

{

isRunning_ = true;

}

void AsyncRProcess::onStarted(core::system::ProcessOperations& operations)

{

if (!input_.empty())

{

core::Error error = operations.writeToStdin(input_, true);

if (error)

{

LOG_ERROR(error);

error = operations.terminate();

if (error)

LOG_ERROR(error);

}

void AsyncRProcess::onStdout(const std::string& output)

{

// no-op stub for optional implementation by derived classees

}

void AsyncRProcess::onStderr(const std::string& output)

{

// no-op stub for optional implementation by derived classees

}

bool AsyncRProcess::onContinue()

{

if (terminationRequested_)

return false;

// check for request requiring a response

if (ipcRequests_.exists())

{

core::Error error = r::exec::RFunction(".rs.rstudioapi.processRequest")

.addParam(ipcRequests_.getAbsolutePathNative())

.addParam(ipcResponse_.getAbsolutePathNative())

.addParam(sharedSecret_)

.call();

if (error)

{

LOG_ERROR(error);

// remove the requests file so we don't attempt to re-log

core::Error error = ipcRequests_.removeIfExists();

if (error)

LOG_ERROR(error);

return false;

}

return true;

}

bool AsyncRProcess::terminationRequested()

{

return terminationRequested_;

}

void AsyncRProcess::onProcessCompleted(int exitStatus)

{

markCompleted();

ipcRequests_.removeIfExists();

ipcResponse_.removeIfExists();

onCompleted(exitStatus);

}

bool AsyncRProcess::isRunning()

{

return isRunning_;

}

void AsyncRProcess::terminate()

{

terminationRequested_ = true;

}

void AsyncRProcess::markCompleted()

{

isRunning_ = false;

}

AsyncRProcess::~AsyncRProcess()

{

}

} // namespace async_r

} // namespace session

} // namespace rstudio

rstudio/src/cpp/session/SessionAsyncRProcess.cpp at master · pearsonca/rstudio · GitHub

Expand file tree

Breadcrumbs

SessionAsyncRProcess.cpp

Latest commit

History

Breadcrumbs

SessionAsyncRProcess.cpp

File metadata and controls