cpython/Modules/_winapi.c at tkinter_docs · native-api/cpython · GitHub

Repository navigation

History

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

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

* Support routines from the Windows API

* This module was originally created by merging PC/_subprocess.c with

* Modules/_multiprocessing/win32_functions.c.

* 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. */

#include "Python.h"

#include "structmember.h"

#define WINDOWS_LEAN_AND_MEAN

#include "windows.h"

#include <crtdbg.h>

#include "winreparse.h"

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

#define HANDLE_TO_PYNUM(handle) \

PyLong_FromUnsignedLong((unsigned long) handle)

#define PYNUM_TO_HANDLE(obj) ((HANDLE)PyLong_AsUnsignedLong(obj))

#define F_POINTER "k"

#define T_POINTER T_ULONG

#else

#define HANDLE_TO_PYNUM(handle) \

PyLong_FromUnsignedLongLong((unsigned long long) handle)

#define PYNUM_TO_HANDLE(obj) ((HANDLE)PyLong_AsUnsignedLongLong(obj))

#define F_POINTER "K"

#define T_POINTER T_ULONGLONG

#endif

#define F_HANDLE F_POINTER

#define F_DWORD "k"

#define T_HANDLE T_POINTER

/* Grab CancelIoEx dynamically from kernel32 */

static int has_CancelIoEx = -1;

static BOOL (CALLBACK *Py_CancelIoEx)(HANDLE, LPOVERLAPPED);

static int

check_CancelIoEx()

{

if (has_CancelIoEx == -1)

{

HINSTANCE hKernel32 = GetModuleHandle("KERNEL32");

* (FARPROC *) &Py_CancelIoEx = GetProcAddress(hKernel32,

"CancelIoEx");

has_CancelIoEx = (Py_CancelIoEx != NULL);

}

return has_CancelIoEx;

}

* A Python object wrapping an OVERLAPPED structure and other useful data

* for overlapped I/O

typedef struct {

PyObject_HEAD

OVERLAPPED overlapped;

/* For convenience, we store the file handle too */

HANDLE handle;

/* Whether there's I/O in flight */

int pending;

/* Whether I/O completed successfully */

int completed;

/* Buffer used for reading (optional) */

PyObject *read_buffer;

/* Buffer used for writing (optional) */

Py_buffer write_buffer;

} OverlappedObject;

static void

overlapped_dealloc(OverlappedObject *self)

{

DWORD bytes;

int err = GetLastError();

if (self->pending) {

if (check_CancelIoEx() &&

Py_CancelIoEx(self->handle, &self->overlapped) &&

GetOverlappedResult(self->handle, &self->overlapped, &bytes, TRUE))

{

/* The operation is no longer pending -- nothing to do. */

}

else if (_Py_IsFinalizing())

{

/* The operation is still pending -- give a warning. This

will probably only happen on Windows XP. */

PyErr_SetString(PyExc_RuntimeError,

"I/O operations still in flight while destroying "

"Overlapped object, the process may crash");

PyErr_WriteUnraisable(NULL);

}

else

{

/* The operation is still pending, but the process is

probably about to exit, so we need not worry too much

about memory leaks. Leaking self prevents a potential

crash. This can happen when a daemon thread is cleaned

up at exit -- see #19565. We only expect to get here

on Windows XP. */

CloseHandle(self->overlapped.hEvent);

SetLastError(err);

return;

}

CloseHandle(self->overlapped.hEvent);

SetLastError(err);

if (self->write_buffer.obj)

PyBuffer_Release(&self->write_buffer);

Py_CLEAR(self->read_buffer);

PyObject_Del(self);

}

/*[clinic input]

module _winapi

class _winapi.Overlapped "OverlappedObject *" "&OverlappedType"

[clinic start generated code]*/

/*[clinic end generated code: output=da39a3ee5e6b4b0d input=c13d3f5fd1dabb84]*/

/*[python input]

def create_converter(type_, format_unit):

name = type_ + '_converter'

# registered upon creation by CConverter's metaclass

type(name, (CConverter,), {'type': type_, 'format_unit': format_unit})

# format unit differs between platforms for these

create_converter('HANDLE', '" F_HANDLE "')

create_converter('HMODULE', '" F_HANDLE "')

create_converter('LPSECURITY_ATTRIBUTES', '" F_POINTER "')

create_converter('BOOL', 'i') # F_BOOL used previously (always 'i')

create_converter('DWORD', 'k') # F_DWORD is always "k" (which is much shorter)

create_converter('LPCTSTR', 's')

create_converter('LPWSTR', 'u')

create_converter('UINT', 'I') # F_UINT used previously (always 'I')

class HANDLE_return_converter(CReturnConverter):

type = 'HANDLE'

def render(self, function, data):

self.declare(data)

self.err_occurred_if("_return_value == INVALID_HANDLE_VALUE", data)

data.return_conversion.append(

'if (_return_value == NULL) {\n Py_RETURN_NONE;\n}\n')

data.return_conversion.append(

'return_value = HANDLE_TO_PYNUM(_return_value);\n')

class DWORD_return_converter(CReturnConverter):

type = 'DWORD'

def render(self, function, data):

self.declare(data)

self.err_occurred_if("_return_value == PY_DWORD_MAX", data)

data.return_conversion.append(

'return_value = Py_BuildValue("k", _return_value);\n')

[python start generated code]*/

/*[python end generated code: output=da39a3ee5e6b4b0d input=4527052fe06e5823]*/

#include "clinic/_winapi.c.h"

/*[clinic input]

_winapi.Overlapped.GetOverlappedResult

wait: bool

[clinic start generated code]*/

static PyObject *

_winapi_Overlapped_GetOverlappedResult_impl(OverlappedObject *self, int wait)

/*[clinic end generated code: output=bdd0c1ed6518cd03 input=194505ee8e0e3565]*/

{

BOOL res;

DWORD transferred = 0;

DWORD err;

Py_BEGIN_ALLOW_THREADS

res = GetOverlappedResult(self->handle, &self->overlapped, &transferred,

wait != 0);

Py_END_ALLOW_THREADS

err = res ? ERROR_SUCCESS : GetLastError();

switch (err) {

case ERROR_SUCCESS:

case ERROR_MORE_DATA:

case ERROR_OPERATION_ABORTED:

self->completed = 1;

self->pending = 0;

break;

case ERROR_IO_INCOMPLETE:

break;

default:

self->pending = 0;

return PyErr_SetExcFromWindowsErr(PyExc_OSError, err);

}

if (self->completed && self->read_buffer != NULL) {

assert(PyBytes_CheckExact(self->read_buffer));

if (transferred != PyBytes_GET_SIZE(self->read_buffer) &&

_PyBytes_Resize(&self->read_buffer, transferred))

return NULL;

}

return Py_BuildValue("II", (unsigned) transferred, (unsigned) err);

}

/*[clinic input]

_winapi.Overlapped.getbuffer

[clinic start generated code]*/

static PyObject *

_winapi_Overlapped_getbuffer_impl(OverlappedObject *self)

/*[clinic end generated code: output=95a3eceefae0f748 input=347fcfd56b4ceabd]*/

{

PyObject *res;

if (!self->completed) {

PyErr_SetString(PyExc_ValueError,

"can't get read buffer before GetOverlappedResult() "

"signals the operation completed");

return NULL;

}

res = self->read_buffer ? self->read_buffer : Py_None;

Py_INCREF(res);

return res;

}

/*[clinic input]

_winapi.Overlapped.cancel

[clinic start generated code]*/

static PyObject *

_winapi_Overlapped_cancel_impl(OverlappedObject *self)

/*[clinic end generated code: output=fcb9ab5df4ebdae5 input=cbf3da142290039f]*/

{

BOOL res = TRUE;

if (self->pending) {

Py_BEGIN_ALLOW_THREADS

if (check_CancelIoEx())

res = Py_CancelIoEx(self->handle, &self->overlapped);

else

res = CancelIo(self->handle);

Py_END_ALLOW_THREADS

}

/* CancelIoEx returns ERROR_NOT_FOUND if the I/O completed in-between */

if (!res && GetLastError() != ERROR_NOT_FOUND)

return PyErr_SetExcFromWindowsErr(PyExc_OSError, 0);

self->pending = 0;

Py_RETURN_NONE;

}

static PyMethodDef overlapped_methods[] = {

_WINAPI_OVERLAPPED_GETOVERLAPPEDRESULT_METHODDEF

_WINAPI_OVERLAPPED_GETBUFFER_METHODDEF

_WINAPI_OVERLAPPED_CANCEL_METHODDEF

{NULL}

};

static PyMemberDef overlapped_members[] = {

{"event", T_HANDLE,

offsetof(OverlappedObject, overlapped) + offsetof(OVERLAPPED, hEvent),

READONLY, "overlapped event handle"},

{NULL}

};

PyTypeObject OverlappedType = {

PyVarObject_HEAD_INIT(NULL, 0)

/* tp_name */ "_winapi.Overlapped",

/* tp_basicsize */ sizeof(OverlappedObject),

/* tp_itemsize */ 0,

/* tp_dealloc */ (destructor) overlapped_dealloc,

/* tp_print */ 0,

/* tp_getattr */ 0,

/* tp_setattr */ 0,

/* tp_reserved */ 0,

/* tp_repr */ 0,

/* tp_as_number */ 0,

/* tp_as_sequence */ 0,

/* tp_as_mapping */ 0,

/* tp_hash */ 0,

/* tp_call */ 0,

/* tp_str */ 0,

/* tp_getattro */ 0,

/* tp_setattro */ 0,

/* tp_as_buffer */ 0,

/* tp_flags */ Py_TPFLAGS_DEFAULT,

/* tp_doc */ "OVERLAPPED structure wrapper",

/* tp_traverse */ 0,

/* tp_clear */ 0,

/* tp_richcompare */ 0,

/* tp_weaklistoffset */ 0,

/* tp_iter */ 0,

/* tp_iternext */ 0,

/* tp_methods */ overlapped_methods,

/* tp_members */ overlapped_members,

/* tp_getset */ 0,

/* tp_base */ 0,

/* tp_dict */ 0,

/* tp_descr_get */ 0,

/* tp_descr_set */ 0,

/* tp_dictoffset */ 0,

/* tp_init */ 0,

/* tp_alloc */ 0,

/* tp_new */ 0,

};

static OverlappedObject *

new_overlapped(HANDLE handle)

{

OverlappedObject *self;

self = PyObject_New(OverlappedObject, &OverlappedType);

if (!self)

return NULL;

self->handle = handle;

self->read_buffer = NULL;

self->pending = 0;

self->completed = 0;

memset(&self->overlapped, 0, sizeof(OVERLAPPED));

memset(&self->write_buffer, 0, sizeof(Py_buffer));

/* Manual reset, initially non-signalled */

self->overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);

return self;

}

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

/* windows API functions */

/*[clinic input]

_winapi.CloseHandle

handle: HANDLE

Close handle.

[clinic start generated code]*/

static PyObject *

_winapi_CloseHandle_impl(PyObject *module, HANDLE handle)

/*[clinic end generated code: output=7ad37345f07bd782 input=7f0e4ac36e0352b8]*/

{

BOOL success;

Py_BEGIN_ALLOW_THREADS

success = CloseHandle(handle);

Py_END_ALLOW_THREADS

if (!success)

return PyErr_SetFromWindowsErr(0);

Py_RETURN_NONE;

}

/*[clinic input]

_winapi.ConnectNamedPipe

handle: HANDLE

overlapped as use_overlapped: bool(accept={int}) = False

[clinic start generated code]*/

static PyObject *

_winapi_ConnectNamedPipe_impl(PyObject *module, HANDLE handle,

int use_overlapped)

/*[clinic end generated code: output=335a0e7086800671 input=34f937c1c86e5e68]*/

{

BOOL success;

OverlappedObject *overlapped = NULL;

if (use_overlapped) {

overlapped = new_overlapped(handle);

if (!overlapped)

return NULL;

}

Py_BEGIN_ALLOW_THREADS

success = ConnectNamedPipe(handle,

overlapped ? &overlapped->overlapped : NULL);

Py_END_ALLOW_THREADS

if (overlapped) {

int err = GetLastError();

/* Overlapped ConnectNamedPipe never returns a success code */

assert(success == 0);

if (err == ERROR_IO_PENDING)

overlapped->pending = 1;

else if (err == ERROR_PIPE_CONNECTED)

SetEvent(overlapped->overlapped.hEvent);

else {

Py_DECREF(overlapped);

return PyErr_SetFromWindowsErr(err);

}

return (PyObject *) overlapped;

}

if (!success)

return PyErr_SetFromWindowsErr(0);

Py_RETURN_NONE;

}

/*[clinic input]

_winapi.CreateFile -> HANDLE

file_name: LPCTSTR

desired_access: DWORD

share_mode: DWORD

security_attributes: LPSECURITY_ATTRIBUTES

creation_disposition: DWORD

flags_and_attributes: DWORD

template_file: HANDLE

[clinic start generated code]*/

static HANDLE

_winapi_CreateFile_impl(PyObject *module, LPCTSTR file_name,

DWORD desired_access, DWORD share_mode,

LPSECURITY_ATTRIBUTES security_attributes,

DWORD creation_disposition,

DWORD flags_and_attributes, HANDLE template_file)

/*[clinic end generated code: output=417ddcebfc5a3d53 input=6423c3e40372dbd5]*/

{

HANDLE handle;

Py_BEGIN_ALLOW_THREADS

handle = CreateFile(file_name, desired_access,

share_mode, security_attributes,

creation_disposition,

flags_and_attributes, template_file);

Py_END_ALLOW_THREADS

if (handle == INVALID_HANDLE_VALUE)

PyErr_SetFromWindowsErr(0);

return handle;

}

/*[clinic input]

_winapi.CreateJunction

src_path: LPWSTR

dst_path: LPWSTR

[clinic start generated code]*/

static PyObject *

_winapi_CreateJunction_impl(PyObject *module, LPWSTR src_path,

LPWSTR dst_path)

/*[clinic end generated code: output=66b7eb746e1dfa25 input=8cd1f9964b6e3d36]*/

{

/* Privilege adjustment */

HANDLE token = NULL;

TOKEN_PRIVILEGES tp;

/* Reparse data buffer */

const USHORT prefix_len = 4;

USHORT print_len = 0;

USHORT rdb_size = 0;

_Py_PREPARSE_DATA_BUFFER rdb = NULL;

/* Junction point creation */

HANDLE junction = NULL;

DWORD ret = 0;

if (src_path == NULL || dst_path == NULL)

return PyErr_SetFromWindowsErr(ERROR_INVALID_PARAMETER);

if (wcsncmp(src_path, L"\\??\\", prefix_len) == 0)

return PyErr_SetFromWindowsErr(ERROR_INVALID_PARAMETER);

/* Adjust privileges to allow rewriting directory entry as a

junction point. */

if (!OpenProcessToken(GetCurrentProcess(), TOKEN_ADJUST_PRIVILEGES, &token))

goto cleanup;

if (!LookupPrivilegeValue(NULL, SE_RESTORE_NAME, &tp.Privileges[0].Luid))

goto cleanup;

tp.PrivilegeCount = 1;

tp.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;

if (!AdjustTokenPrivileges(token, FALSE, &tp, sizeof(TOKEN_PRIVILEGES),

NULL, NULL))

goto cleanup;

if (GetFileAttributesW(src_path) == INVALID_FILE_ATTRIBUTES)

goto cleanup;

/* Store the absolute link target path length in print_len. */

print_len = (USHORT)GetFullPathNameW(src_path, 0, NULL, NULL);

if (print_len == 0)

goto cleanup;

/* NUL terminator should not be part of print_len. */

--print_len;

/* REPARSE_DATA_BUFFER usage is heavily under-documented, especially for

junction points. Here's what I've learned along the way:

- A junction point has two components: a print name and a substitute

name. They both describe the link target, but the substitute name is

the physical target and the print name is shown in directory listings.

- The print name must be a native name, prefixed with "\??\".

- Both names are stored after each other in the same buffer (the

PathBuffer) and both must be NUL-terminated.

- There are four members defining their respective offset and length

inside PathBuffer: SubstituteNameOffset, SubstituteNameLength,

PrintNameOffset and PrintNameLength.

- The total size we need to allocate for the REPARSE_DATA_BUFFER, thus,

is the sum of:

- the fixed header size (REPARSE_DATA_BUFFER_HEADER_SIZE)

- the size of the MountPointReparseBuffer member without the PathBuffer

- the size of the prefix ("\??\") in bytes

- the size of the print name in bytes

- the size of the substitute name in bytes

- the size of two NUL terminators in bytes */

rdb_size = _Py_REPARSE_DATA_BUFFER_HEADER_SIZE +

sizeof(rdb->MountPointReparseBuffer) -

sizeof(rdb->MountPointReparseBuffer.PathBuffer) +

/* Two +1's for NUL terminators. */

(prefix_len + print_len + 1 + print_len + 1) * sizeof(WCHAR);

rdb = (_Py_PREPARSE_DATA_BUFFER)PyMem_RawMalloc(rdb_size);

if (rdb == NULL)

goto cleanup;

memset(rdb, 0, rdb_size);

rdb->ReparseTag = IO_REPARSE_TAG_MOUNT_POINT;

rdb->ReparseDataLength = rdb_size - _Py_REPARSE_DATA_BUFFER_HEADER_SIZE;

rdb->MountPointReparseBuffer.SubstituteNameOffset = 0;

rdb->MountPointReparseBuffer.SubstituteNameLength =

(prefix_len + print_len) * sizeof(WCHAR);

rdb->MountPointReparseBuffer.PrintNameOffset =

rdb->MountPointReparseBuffer.SubstituteNameLength + sizeof(WCHAR);

rdb->MountPointReparseBuffer.PrintNameLength = print_len * sizeof(WCHAR);

/* Store the full native path of link target at the substitute name

offset (0). */

wcscpy(rdb->MountPointReparseBuffer.PathBuffer, L"\\??\\");

if (GetFullPathNameW(src_path, print_len + 1,

rdb->MountPointReparseBuffer.PathBuffer + prefix_len,

NULL) == 0)

goto cleanup;

/* Copy everything but the native prefix to the print name offset. */

wcscpy(rdb->MountPointReparseBuffer.PathBuffer +

prefix_len + print_len + 1,

rdb->MountPointReparseBuffer.PathBuffer + prefix_len);

/* Create a directory for the junction point. */

if (!CreateDirectoryW(dst_path, NULL))

goto cleanup;

junction = CreateFileW(dst_path, GENERIC_READ | GENERIC_WRITE, 0, NULL,

OPEN_EXISTING,

FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS, NULL);

if (junction == INVALID_HANDLE_VALUE)

goto cleanup;

/* Make the directory entry a junction point. */

if (!DeviceIoControl(junction, FSCTL_SET_REPARSE_POINT, rdb, rdb_size,

NULL, 0, &ret, NULL))

goto cleanup;

cleanup:

ret = GetLastError();

CloseHandle(token);

CloseHandle(junction);

PyMem_RawFree(rdb);

if (ret != 0)

return PyErr_SetFromWindowsErr(ret);

Py_RETURN_NONE;

}

/*[clinic input]

_winapi.CreateNamedPipe -> HANDLE

name: LPCTSTR

open_mode: DWORD

pipe_mode: DWORD

max_instances: DWORD

out_buffer_size: DWORD

in_buffer_size: DWORD

default_timeout: DWORD

security_attributes: LPSECURITY_ATTRIBUTES

[clinic start generated code]*/

static HANDLE

_winapi_CreateNamedPipe_impl(PyObject *module, LPCTSTR name, DWORD open_mode,

DWORD pipe_mode, DWORD max_instances,

DWORD out_buffer_size, DWORD in_buffer_size,

DWORD default_timeout,

LPSECURITY_ATTRIBUTES security_attributes)

/*[clinic end generated code: output=80f8c07346a94fbc input=5a73530b84d8bc37]*/

{

HANDLE handle;

Py_BEGIN_ALLOW_THREADS

handle = CreateNamedPipe(name, open_mode, pipe_mode,

max_instances, out_buffer_size,

in_buffer_size, default_timeout,

security_attributes);

Py_END_ALLOW_THREADS

if (handle == INVALID_HANDLE_VALUE)

PyErr_SetFromWindowsErr(0);

return handle;

}

/*[clinic input]

_winapi.CreatePipe

pipe_attrs: object

Ignored internally, can be None.

size: DWORD

Create an anonymous pipe.

Returns a 2-tuple of handles, to the read and write ends of the pipe.

[clinic start generated code]*/

static PyObject *

_winapi_CreatePipe_impl(PyObject *module, PyObject *pipe_attrs, DWORD size)

/*[clinic end generated code: output=1c4411d8699f0925 input=c4f2cfa56ef68d90]*/

{

HANDLE read_pipe;

HANDLE write_pipe;

BOOL result;

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", HANDLE_TO_PYNUM(read_pipe), HANDLE_TO_PYNUM(write_pipe));

}

/* helpers for createprocess */

static unsigned long

getulong(PyObject* obj, const char* name)

{

PyObject* value;

unsigned long ret;

value = PyObject_GetAttrString(obj, name);

if (! value) {

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

return 0;

}

ret = PyLong_AsUnsignedLong(value);

Py_DECREF(value);

return ret;

}

static HANDLE

gethandle(PyObject* obj, const char* name)

{

PyObject* value;

HANDLE ret;

value = PyObject_GetAttrString(obj, name);

if (! value) {

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

return NULL;

}

if (value == Py_None)

ret = NULL;

else

ret = PYNUM_TO_HANDLE(value);

Py_DECREF(value);

return ret;

}

static PyObject*

getenvironment(PyObject* environment)

{

Py_ssize_t i, envsize, totalsize;

Py_UCS4 *buffer = NULL, *p, *end;

PyObject *keys, *values, *res;

/* convert environment dictionary to windows environment string */

if (! PyMapping_Check(environment)) {

PyErr_SetString(

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

return NULL;

}

keys = PyMapping_Keys(environment);

if (!keys) {

return NULL;

}

values = PyMapping_Values(environment);

if (!values) {

goto error;

}

envsize = PySequence_Fast_GET_SIZE(keys);

if (PySequence_Fast_GET_SIZE(values) != envsize) {

PyErr_SetString(PyExc_RuntimeError,

"environment changed size during iteration");

goto error;

}

totalsize = 1; /* trailing null character */

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

PyObject* key = PySequence_Fast_GET_ITEM(keys, i);

PyObject* value = PySequence_Fast_GET_ITEM(values, i);

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

PyErr_SetString(PyExc_TypeError,

"environment can only contain strings");

goto error;

}

if (PyUnicode_FindChar(key, '\0', 0, PyUnicode_GET_LENGTH(key), 1) != -1 ||

PyUnicode_FindChar(value, '\0', 0, PyUnicode_GET_LENGTH(value), 1) != -1)

{

PyErr_SetString(PyExc_ValueError, "embedded null character");

goto error;

}

/* Search from index 1 because on Windows starting '=' is allowed for

defining hidden environment variables. */

if (PyUnicode_GET_LENGTH(key) == 0 ||

PyUnicode_FindChar(key, '=', 1, PyUnicode_GET_LENGTH(key), 1) != -1)

{

PyErr_SetString(PyExc_ValueError, "illegal environment variable name");

goto error;

}

if (totalsize > PY_SSIZE_T_MAX - PyUnicode_GET_LENGTH(key) - 1) {

PyErr_SetString(PyExc_OverflowError, "environment too long");

goto error;

}

totalsize += PyUnicode_GET_LENGTH(key) + 1; /* +1 for '=' */

if (totalsize > PY_SSIZE_T_MAX - PyUnicode_GET_LENGTH(value) - 1) {

PyErr_SetString(PyExc_OverflowError, "environment too long");

goto error;

}

totalsize += PyUnicode_GET_LENGTH(value) + 1; /* +1 for '\0' */

}

buffer = PyMem_NEW(Py_UCS4, totalsize);

if (! buffer) {

PyErr_NoMemory();

goto error;

}

p = buffer;

end = buffer + totalsize;

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

PyObject* key = PySequence_Fast_GET_ITEM(keys, i);

PyObject* value = PySequence_Fast_GET_ITEM(values, i);

if (!PyUnicode_AsUCS4(key, p, end - p, 0))

goto error;

p += PyUnicode_GET_LENGTH(key);

*p++ = '=';

if (!PyUnicode_AsUCS4(value, p, end - p, 0))

goto error;

p += PyUnicode_GET_LENGTH(value);

*p++ = '\0';

}

/* add trailing null byte */

*p++ = '\0';

assert(p == end);

Py_XDECREF(keys);

Py_XDECREF(values);

res = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, buffer, p - buffer);

PyMem_Free(buffer);

return res;

error:

PyMem_Free(buffer);

Py_XDECREF(keys);

Py_XDECREF(values);

return NULL;

}

static LPHANDLE

gethandlelist(PyObject *mapping, const char *name, Py_ssize_t *size)

{

LPHANDLE ret = NULL;

PyObject *value_fast = NULL;

PyObject *value;

Py_ssize_t i;

value = PyMapping_GetItemString(mapping, name);

if (!value) {

PyErr_Clear();

return NULL;

}

if (value == Py_None) {

goto cleanup;

}

value_fast = PySequence_Fast(value, "handle_list must be a sequence or None");

if (value_fast == NULL)

goto cleanup;

*size = PySequence_Fast_GET_SIZE(value_fast) * sizeof(HANDLE);

/* Passing an empty array causes CreateProcess to fail so just don't set it */

if (*size == 0) {

goto cleanup;

}

ret = PyMem_Malloc(*size);

if (ret == NULL)

goto cleanup;

for (i = 0; i < PySequence_Fast_GET_SIZE(value_fast); i++) {

ret[i] = PYNUM_TO_HANDLE(PySequence_Fast_GET_ITEM(value_fast, i));

if (ret[i] == (HANDLE)-1 && PyErr_Occurred()) {

PyMem_Free(ret);

ret = NULL;

goto cleanup;

}

cleanup:

Py_DECREF(value);

Py_XDECREF(value_fast);

return ret;

}

typedef struct {

LPPROC_THREAD_ATTRIBUTE_LIST attribute_list;

LPHANDLE handle_list;

} AttributeList;

static void

freeattributelist(AttributeList *attribute_list)

{

if (attribute_list->attribute_list != NULL) {

DeleteProcThreadAttributeList(attribute_list->attribute_list);

PyMem_Free(attribute_list->attribute_list);

}

PyMem_Free(attribute_list->handle_list);

memset(attribute_list, 0, sizeof(*attribute_list));

}

static int

getattributelist(PyObject *obj, const char *name, AttributeList *attribute_list)

{

int ret = 0;

DWORD err;

BOOL result;

PyObject *value;

Py_ssize_t handle_list_size;

DWORD attribute_count = 0;

SIZE_T attribute_list_size = 0;

value = PyObject_GetAttrString(obj, name);

if (!value) {

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

return 0;

}

if (value == Py_None) {

ret = 0;

goto cleanup;

}

if (!PyMapping_Check(value)) {

ret = -1;

PyErr_Format(PyExc_TypeError, "%s must be a mapping or None", name);

goto cleanup;

}

attribute_list->handle_list = gethandlelist(value, "handle_list", &handle_list_size);

if (attribute_list->handle_list == NULL && PyErr_Occurred()) {

ret = -1;

goto cleanup;

}

if (attribute_list->handle_list != NULL)

++attribute_count;

/* Get how many bytes we need for the attribute list */

result = InitializeProcThreadAttributeList(NULL, attribute_count, 0, &attribute_list_size);

if (result || GetLastError() != ERROR_INSUFFICIENT_BUFFER) {

ret = -1;

PyErr_SetFromWindowsErr(GetLastError());

goto cleanup;

}

attribute_list->attribute_list = PyMem_Malloc(attribute_list_size);

if (attribute_list->attribute_list == NULL) {

ret = -1;

goto cleanup;

}

result = InitializeProcThreadAttributeList(

attribute_list->attribute_list,

attribute_count,

&attribute_list_size);

if (!result) {

err = GetLastError();

/* So that we won't call DeleteProcThreadAttributeList */

PyMem_Free(attribute_list->attribute_list);

attribute_list->attribute_list = NULL;

ret = -1;

PyErr_SetFromWindowsErr(err);

goto cleanup;

}

if (attribute_list->handle_list != NULL) {

result = UpdateProcThreadAttribute(

attribute_list->attribute_list,

PROC_THREAD_ATTRIBUTE_HANDLE_LIST,

attribute_list->handle_list,

handle_list_size,

NULL,

NULL);

if (!result) {

ret = -1;

PyErr_SetFromWindowsErr(GetLastError());

goto cleanup;

}

cleanup:

Py_DECREF(value);

if (ret < 0)

freeattributelist(attribute_list);

return ret;

}

/*[clinic input]

_winapi.CreateProcess

application_name: Py_UNICODE(accept={str, NoneType})

command_line: Py_UNICODE(accept={str, NoneType})

proc_attrs: object

Ignored internally, can be None.

thread_attrs: object

Ignored internally, can be None.

inherit_handles: BOOL

creation_flags: DWORD

env_mapping: object

current_directory: Py_UNICODE(accept={str, NoneType})

startup_info: object

Create a new process and its primary thread.

The return value is a tuple of the process handle, thread handle,

process ID, and thread ID.

[clinic start generated code]*/

static PyObject *

_winapi_CreateProcess_impl(PyObject *module, Py_UNICODE *application_name,

Py_UNICODE *command_line, PyObject *proc_attrs,

PyObject *thread_attrs, BOOL inherit_handles,

DWORD creation_flags, PyObject *env_mapping,

Py_UNICODE *current_directory,

View remainder of file in raw view

cpython/Modules/_winapi.c at tkinter_docs · native-api/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

_winapi.c

Latest commit

History

Breadcrumbs

_winapi.c

File metadata and controls