python/PC/_subprocess.c at master · java66liu/python · GitHub

History

589 lines (485 loc) · 14.2 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

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

* support routines for subprocess module

* Currently, this extension module is only required when using the

* subprocess module on Windows, but in the future, stubs for other

* platforms might be added here as well.

* By obtaining, using, and/or copying this software and/or its

* associated documentation, you agree that you have read, understood,

* and will comply with the following terms and conditions:

* Permission to use, copy, modify, and distribute this software and

* its associated documentation for any purpose and without fee is

* hereby granted, provided that the above copyright notice appears in

* all copies, and that both that copyright notice and this permission

* notice appear in supporting documentation, and that the name of the

* authors not be used in advertising or publicity pertaining to

* distribution of the software without specific, written prior

* permission.

* THE AUTHORS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,

* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.

* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR

* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS

* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,

* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION

* WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

/* Licensed to PSF under a Contributor Agreement. */

/* See http://www.python.org/2.4/license for licensing details. */

/* TODO: handle unicode command lines? */

/* TODO: handle unicode environment? */

#include "Python.h"

#define WINDOWS_LEAN_AND_MEAN

#include "windows.h"

/* -------------------------------------------------------------------- */

/* handle wrapper. note that this library uses integers when passing

handles to a function, and handle wrappers when returning handles.

the wrapper is used to provide Detach and Close methods */

typedef struct {

PyObject_HEAD

HANDLE handle;

} sp_handle_object;

staticforward PyTypeObject sp_handle_type;

static PyObject*

sp_handle_new(HANDLE handle)

{

sp_handle_object* self;

self = PyObject_NEW(sp_handle_object, &sp_handle_type);

if (self == NULL)

return NULL;

self->handle = handle;

return (PyObject*) self;

}

#if defined(MS_WIN32) && !defined(MS_WIN64)

#define HANDLE_TO_PYNUM(handle) PyInt_FromLong((long) handle)

#define PY_HANDLE_PARAM "l"

#else

#define HANDLE_TO_PYNUM(handle) PyLong_FromLongLong((long long) handle)

#define PY_HANDLE_PARAM "L"

#endif

static PyObject*

sp_handle_detach(sp_handle_object* self, PyObject* args)

{

HANDLE handle;

if (! PyArg_ParseTuple(args, ":Detach"))

return NULL;

handle = self->handle;

self->handle = NULL;

/* note: return the current handle, as an integer */

return HANDLE_TO_PYNUM(handle);

}

static PyObject*

sp_handle_close(sp_handle_object* self, PyObject* args)

{

if (! PyArg_ParseTuple(args, ":Close"))

return NULL;

if (self->handle != INVALID_HANDLE_VALUE) {

CloseHandle(self->handle);

self->handle = INVALID_HANDLE_VALUE;

}

Py_INCREF(Py_None);

return Py_None;

}

static void

sp_handle_dealloc(sp_handle_object* self)

{

if (self->handle != INVALID_HANDLE_VALUE)

CloseHandle(self->handle);

PyObject_FREE(self);

}

static PyMethodDef sp_handle_methods[] = {

{"Detach", (PyCFunction) sp_handle_detach, METH_VARARGS},

{"Close", (PyCFunction) sp_handle_close, METH_VARARGS},

{NULL, NULL}

};

static PyObject*

sp_handle_getattr(sp_handle_object* self, char* name)

{

return Py_FindMethod(sp_handle_methods, (PyObject*) self, name);

}

static PyObject*

sp_handle_as_int(sp_handle_object* self)

{

return HANDLE_TO_PYNUM(self->handle);

}

static PyNumberMethods sp_handle_as_number;

statichere PyTypeObject sp_handle_type = {

PyObject_HEAD_INIT(NULL)

0, /*ob_size*/

"_subprocess_handle", sizeof(sp_handle_object), 0,

(destructor) sp_handle_dealloc, /*tp_dealloc*/

0, /*tp_print*/

(getattrfunc) sp_handle_getattr,/*tp_getattr*/

0, /*tp_setattr*/

0, /*tp_compare*/

0, /*tp_repr*/

&sp_handle_as_number, /*tp_as_number */

0, /*tp_as_sequence */

0, /*tp_as_mapping */

0 /*tp_hash*/

};

/* -------------------------------------------------------------------- */

/* windows API functions */

static PyObject *

sp_GetStdHandle(PyObject* self, PyObject* args)

{

HANDLE handle;

int std_handle;

if (! PyArg_ParseTuple(args, "i:GetStdHandle", &std_handle))

return NULL;

Py_BEGIN_ALLOW_THREADS

handle = GetStdHandle((DWORD) std_handle);

Py_END_ALLOW_THREADS

if (handle == INVALID_HANDLE_VALUE)

return PyErr_SetFromWindowsErr(GetLastError());

if (! handle) {

Py_INCREF(Py_None);

return Py_None;

}

/* note: returns integer, not handle object */

return HANDLE_TO_PYNUM(handle);

}

static PyObject *

sp_GetCurrentProcess(PyObject* self, PyObject* args)

{

if (! PyArg_ParseTuple(args, ":GetCurrentProcess"))

return NULL;

return sp_handle_new(GetCurrentProcess());

}

static PyObject *

sp_DuplicateHandle(PyObject* self, PyObject* args)

{

HANDLE target_handle;

BOOL result;

HANDLE source_process_handle;

HANDLE source_handle;

HANDLE target_process_handle;

int desired_access;

int inherit_handle;

int options = 0;

if (! PyArg_ParseTuple(args,

PY_HANDLE_PARAM PY_HANDLE_PARAM PY_HANDLE_PARAM

"ii|i:DuplicateHandle",

&source_process_handle,

&source_handle,

&target_process_handle,

&desired_access,

&inherit_handle,

&options))

return NULL;

Py_BEGIN_ALLOW_THREADS

result = DuplicateHandle(

source_process_handle,

source_handle,

target_process_handle,

&target_handle,

desired_access,

inherit_handle,

options

);

Py_END_ALLOW_THREADS

if (! result)

return PyErr_SetFromWindowsErr(GetLastError());

return sp_handle_new(target_handle);

}

static PyObject *

sp_CreatePipe(PyObject* self, PyObject* args)

{

HANDLE read_pipe;

HANDLE write_pipe;

BOOL result;

PyObject* pipe_attributes; /* ignored */

int size;

if (! PyArg_ParseTuple(args, "Oi:CreatePipe", &pipe_attributes, &size))

return NULL;

Py_BEGIN_ALLOW_THREADS

result = CreatePipe(&read_pipe, &write_pipe, NULL, size);

Py_END_ALLOW_THREADS

if (! result)

return PyErr_SetFromWindowsErr(GetLastError());

return Py_BuildValue(

"NN", sp_handle_new(read_pipe), sp_handle_new(write_pipe));

}

/* helpers for createprocess */

static int

getint(PyObject* obj, char* name)

{

PyObject* value;

int ret;

value = PyObject_GetAttrString(obj, name);

if (! value) {

PyErr_Clear(); /* FIXME: propagate error? */

return 0;

}

ret = (int) PyInt_AsLong(value);

Py_DECREF(value);

return ret;

}

static HANDLE

gethandle(PyObject* obj, char* name)

{

sp_handle_object* value;

HANDLE ret;

value = (sp_handle_object*) PyObject_GetAttrString(obj, name);

if (! value) {

PyErr_Clear(); /* FIXME: propagate error? */

return NULL;

}

if (value->ob_type != &sp_handle_type)

ret = NULL;

else

ret = value->handle;

Py_DECREF(value);

return ret;

}

static PyObject*

getenvironment(PyObject* environment)

{

int i, envsize;

PyObject* out = NULL;

PyObject* keys;

PyObject* values;

char* p;

/* convert environment dictionary to windows enviroment string */

if (! PyMapping_Check(environment)) {

PyErr_SetString(

PyExc_TypeError, "environment must be dictionary or None");

return NULL;

}

envsize = PyMapping_Length(environment);

keys = PyMapping_Keys(environment);

values = PyMapping_Values(environment);

if (!keys || !values)

goto error;

out = PyString_FromStringAndSize(NULL, 2048);

if (! out)

goto error;

p = PyString_AS_STRING(out);

for (i = 0; i < envsize; i++) {

int ksize, vsize, totalsize;

PyObject* key = PyList_GET_ITEM(keys, i);

PyObject* value = PyList_GET_ITEM(values, i);

if (! PyString_Check(key) || ! PyString_Check(value)) {

PyErr_SetString(PyExc_TypeError,

"environment can only contain strings");

goto error;

}

ksize = PyString_GET_SIZE(key);

vsize = PyString_GET_SIZE(value);

totalsize = (p - PyString_AS_STRING(out)) + ksize + 1 +

vsize + 1 + 1;

if (totalsize > PyString_GET_SIZE(out)) {

int offset = p - PyString_AS_STRING(out);

_PyString_Resize(&out, totalsize + 1024);

p = PyString_AS_STRING(out) + offset;

}

memcpy(p, PyString_AS_STRING(key), ksize);

p += ksize;

*p++ = '=';

memcpy(p, PyString_AS_STRING(value), vsize);

p += vsize;

*p++ = '\0';

}

/* add trailing null byte */

*p++ = '\0';

_PyString_Resize(&out, p - PyString_AS_STRING(out));

/* PyObject_Print(out, stdout, 0); */

Py_XDECREF(keys);

Py_XDECREF(values);

return out;

error:

Py_XDECREF(out);

Py_XDECREF(keys);

Py_XDECREF(values);

return NULL;

}

static PyObject *

sp_CreateProcess(PyObject* self, PyObject* args)

{

BOOL result;

PROCESS_INFORMATION pi;

STARTUPINFO si;

PyObject* environment;

char* application_name;

char* command_line;

PyObject* process_attributes; /* ignored */

PyObject* thread_attributes; /* ignored */

int inherit_handles;

int creation_flags;

PyObject* env_mapping;

char* current_directory;

PyObject* startup_info;

if (! PyArg_ParseTuple(args, "zzOOiiOzO:CreateProcess",

&application_name,

&command_line,

&process_attributes,

&thread_attributes,

&inherit_handles,

&creation_flags,

&env_mapping,

&current_directory,

&startup_info))

return NULL;

ZeroMemory(&si, sizeof(si));

si.cb = sizeof(si);

/* note: we only support a small subset of all SI attributes */

si.dwFlags = getint(startup_info, "dwFlags");

si.wShowWindow = getint(startup_info, "wShowWindow");

si.hStdInput = gethandle(startup_info, "hStdInput");

si.hStdOutput = gethandle(startup_info, "hStdOutput");

si.hStdError = gethandle(startup_info, "hStdError");

if (PyErr_Occurred())

return NULL;

if (env_mapping == Py_None)

environment = NULL;

else {

environment = getenvironment(env_mapping);

if (! environment)

return NULL;

}

Py_BEGIN_ALLOW_THREADS

result = CreateProcess(application_name,

command_line,

NULL,

inherit_handles,

creation_flags,

environment ? PyString_AS_STRING(environment) : NULL,

current_directory,

&si,

&pi);

Py_END_ALLOW_THREADS

Py_XDECREF(environment);

if (! result)

return PyErr_SetFromWindowsErr(GetLastError());

return Py_BuildValue("NNii",

sp_handle_new(pi.hProcess),

sp_handle_new(pi.hThread),

pi.dwProcessId,

pi.dwThreadId);

}

static PyObject *

sp_TerminateProcess(PyObject* self, PyObject* args)

{

BOOL result;

HANDLE process;

int exit_code;

if (! PyArg_ParseTuple(args, PY_HANDLE_PARAM "i:TerminateProcess",

&process, &exit_code))

return NULL;

result = TerminateProcess(process, exit_code);

if (! result)

return PyErr_SetFromWindowsErr(GetLastError());

Py_INCREF(Py_None);

return Py_None;

}

static PyObject *

sp_GetExitCodeProcess(PyObject* self, PyObject* args)

{

DWORD exit_code;

BOOL result;

HANDLE process;

if (! PyArg_ParseTuple(args, PY_HANDLE_PARAM ":GetExitCodeProcess", &process))

return NULL;

result = GetExitCodeProcess(process, &exit_code);

if (! result)

return PyErr_SetFromWindowsErr(GetLastError());

return PyInt_FromLong(exit_code);

}

static PyObject *

sp_WaitForSingleObject(PyObject* self, PyObject* args)

{

DWORD result;

HANDLE handle;

int milliseconds;

if (! PyArg_ParseTuple(args, PY_HANDLE_PARAM "i:WaitForSingleObject",

&handle,

&milliseconds))

return NULL;

Py_BEGIN_ALLOW_THREADS

result = WaitForSingleObject(handle, (DWORD) milliseconds);

Py_END_ALLOW_THREADS

if (result == WAIT_FAILED)

return PyErr_SetFromWindowsErr(GetLastError());

return PyInt_FromLong((int) result);

}

static PyObject *

sp_GetVersion(PyObject* self, PyObject* args)

{

if (! PyArg_ParseTuple(args, ":GetVersion"))

return NULL;

return PyInt_FromLong((int) GetVersion());

}

static PyObject *

sp_GetModuleFileName(PyObject* self, PyObject* args)

{

BOOL result;

HMODULE module;

TCHAR filename[MAX_PATH];

if (! PyArg_ParseTuple(args, PY_HANDLE_PARAM ":GetModuleFileName",

&module))

return NULL;

result = GetModuleFileName(module, filename, MAX_PATH);

filename[MAX_PATH-1] = '\0';

if (! result)

return PyErr_SetFromWindowsErr(GetLastError());

return PyString_FromString(filename);

}

static PyMethodDef sp_functions[] = {

{"GetStdHandle", sp_GetStdHandle, METH_VARARGS},

{"GetCurrentProcess", sp_GetCurrentProcess, METH_VARARGS},

{"DuplicateHandle", sp_DuplicateHandle, METH_VARARGS},

{"CreatePipe", sp_CreatePipe, METH_VARARGS},

{"CreateProcess", sp_CreateProcess, METH_VARARGS},

{"TerminateProcess", sp_TerminateProcess, METH_VARARGS},

{"GetExitCodeProcess", sp_GetExitCodeProcess, METH_VARARGS},

{"WaitForSingleObject", sp_WaitForSingleObject, METH_VARARGS},

{"GetVersion", sp_GetVersion, METH_VARARGS},

{"GetModuleFileName", sp_GetModuleFileName, METH_VARARGS},

{NULL, NULL}

};

/* -------------------------------------------------------------------- */

static void

defint(PyObject* d, const char* name, int value)

{

PyObject* v = PyInt_FromLong((long) value);

if (v) {

PyDict_SetItemString(d, (char*) name, v);

Py_DECREF(v);

}

#if PY_VERSION_HEX >= 0x02030000

PyMODINIT_FUNC

#else

DL_EXPORT(void)

#endif

init_subprocess()

{

PyObject *d;

PyObject *m;

/* patch up object descriptors */

sp_handle_type.ob_type = &PyType_Type;

sp_handle_as_number.nb_int = (unaryfunc) sp_handle_as_int;

m = Py_InitModule("_subprocess", sp_functions);

if (m == NULL)

return;

d = PyModule_GetDict(m);

/* constants */

defint(d, "STD_INPUT_HANDLE", STD_INPUT_HANDLE);

defint(d, "STD_OUTPUT_HANDLE", STD_OUTPUT_HANDLE);

defint(d, "STD_ERROR_HANDLE", STD_ERROR_HANDLE);

defint(d, "DUPLICATE_SAME_ACCESS", DUPLICATE_SAME_ACCESS);

defint(d, "STARTF_USESTDHANDLES", STARTF_USESTDHANDLES);

defint(d, "STARTF_USESHOWWINDOW", STARTF_USESHOWWINDOW);

defint(d, "SW_HIDE", SW_HIDE);

defint(d, "INFINITE", INFINITE);

defint(d, "WAIT_OBJECT_0", WAIT_OBJECT_0);

defint(d, "CREATE_NEW_CONSOLE", CREATE_NEW_CONSOLE);

}

python/PC/_subprocess.c at master · java66liu/python · GitHub

Expand file tree

Breadcrumbs

_subprocess.c

Latest commit

History

Breadcrumbs

_subprocess.c

File metadata and controls