cpython/Python/pathconfig.c at startup_debug · 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

/* Path configuration like module_search_path (sys.path) */

#include "Python.h"

#include "osdefs.h"

#include "pycore_fileutils.h"

#include "pycore_pathconfig.h"

#include "pycore_pymem.h"

#include "pycore_pystate.h"

#include <wchar.h>

#ifdef __cplusplus

extern "C" {

#endif

_PyPathConfig _Py_path_config = _PyPathConfig_INIT;

static int

copy_wstr(wchar_t **dst, const wchar_t *src)

{

if (src != NULL) {

*dst = _PyMem_RawWcsdup(src);

if (*dst == NULL) {

return -1;

}

else {

*dst = NULL;

}

return 0;

}

static void

_PyPathConfig_Clear(_PyPathConfig *config)

{

/* _PyMem_SetDefaultAllocator() is needed to get a known memory allocator,

since Py_SetPath(), Py_SetPythonHome() and Py_SetProgramName() can be

called before Py_Initialize() which can changes the memory allocator. */

PyMemAllocatorEx old_alloc;

_PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

#define CLEAR(ATTR) \

do { \

PyMem_RawFree(ATTR); \

ATTR = NULL; \

} while (0)

CLEAR(config->prefix);

CLEAR(config->program_full_path);

CLEAR(config->exec_prefix);

#ifdef MS_WINDOWS

CLEAR(config->dll_path);

#endif

CLEAR(config->module_search_path);

CLEAR(config->home);

CLEAR(config->program_name);

#undef CLEAR

PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

}

/* Calculate the path configuration: initialize path_config from core_config */

static _PyInitError

_PyPathConfig_Calculate(_PyPathConfig *path_config,

const _PyCoreConfig *core_config)

{

_PyInitError err;

_PyPathConfig new_config = _PyPathConfig_INIT;

PyMemAllocatorEx old_alloc;

_PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

/* Calculate program_full_path, prefix, exec_prefix,

dll_path (Windows), and module_search_path */

err = _PyPathConfig_Calculate_impl(&new_config, core_config);

if (_Py_INIT_FAILED(err)) {

goto err;

}

/* Copy home and program_name from core_config */

if (copy_wstr(&new_config.home, core_config->home) < 0) {

err = _Py_INIT_NO_MEMORY();

goto err;

}

if (copy_wstr(&new_config.program_name, core_config->program_name) < 0) {

err = _Py_INIT_NO_MEMORY();

goto err;

}

_PyPathConfig_Clear(path_config);

*path_config = new_config;

err = _Py_INIT_OK();

goto done;

err:

_PyPathConfig_Clear(&new_config);

done:

PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

return err;

}

_PyInitError

_PyPathConfig_SetGlobal(const _PyPathConfig *config)

{

_PyInitError err;

_PyPathConfig new_config = _PyPathConfig_INIT;

PyMemAllocatorEx old_alloc;

_PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

#define COPY_ATTR(ATTR) \

do { \

if (copy_wstr(&new_config.ATTR, config->ATTR) < 0) { \

_PyPathConfig_Clear(&new_config); \

err = _Py_INIT_NO_MEMORY(); \

goto done; \

} \

} while (0)

COPY_ATTR(program_full_path);

COPY_ATTR(prefix);

COPY_ATTR(exec_prefix);

#ifdef MS_WINDOWS

COPY_ATTR(dll_path);

#endif

COPY_ATTR(module_search_path);

COPY_ATTR(program_name);

COPY_ATTR(home);

_PyPathConfig_Clear(&_Py_path_config);

/* Steal new_config strings; don't clear new_config */

_Py_path_config = new_config;

err = _Py_INIT_OK();

done:

PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

return err;

}

void

_PyPathConfig_ClearGlobal(void)

{

_PyPathConfig_Clear(&_Py_path_config);

}

static wchar_t*

wstrlist_join(wchar_t sep, int count, wchar_t **list)

{

size_t len = 1; /* NUL terminator */

for (int i=0; i < count; i++) {

if (i != 0) {

len++;

}

len += wcslen(list[i]);

}

wchar_t *text = PyMem_RawMalloc(len * sizeof(wchar_t));

if (text == NULL) {

return NULL;

}

wchar_t *str = text;

for (int i=0; i < count; i++) {

wchar_t *path = list[i];

if (i != 0) {

*str++ = SEP;

}

len = wcslen(path);

memcpy(str, path, len * sizeof(wchar_t));

str += len;

}

*str = L'\0';

return text;

}

/* Set the global path configuration from core_config. */

_PyInitError

_PyCoreConfig_SetPathConfig(const _PyCoreConfig *core_config)

{

PyMemAllocatorEx old_alloc;

_PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

_PyInitError err;

_PyPathConfig path_config = _PyPathConfig_INIT;

path_config.module_search_path = wstrlist_join(DELIM,

core_config->nmodule_search_path,

core_config->module_search_paths);

if (path_config.module_search_path == NULL) {

goto no_memory;

}

if (copy_wstr(&path_config.program_full_path, core_config->executable) < 0) {

goto no_memory;

}

if (copy_wstr(&path_config.prefix, core_config->prefix) < 0) {

goto no_memory;

}

if (copy_wstr(&path_config.exec_prefix, core_config->exec_prefix) < 0) {

goto no_memory;

}

#ifdef MS_WINDOWS

if (copy_wstr(&path_config.dll_path, core_config->dll_path) < 0) {

goto no_memory;

}

#endif

if (copy_wstr(&path_config.program_name, core_config->program_name) < 0) {

goto no_memory;

}

if (copy_wstr(&path_config.home, core_config->home) < 0) {

goto no_memory;

}

err = _PyPathConfig_SetGlobal(&path_config);

if (_Py_INIT_FAILED(err)) {

goto done;

}

err = _Py_INIT_OK();

goto done;

no_memory:

err = _Py_INIT_NO_MEMORY();

done:

_PyPathConfig_Clear(&path_config);

PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

return err;

}

static _PyInitError

core_config_init_module_search_paths(_PyCoreConfig *config,

_PyPathConfig *path_config)

{

assert(config->module_search_paths == NULL);

assert(config->nmodule_search_path < 0);

config->nmodule_search_path = 0;

const wchar_t *sys_path = path_config->module_search_path;

const wchar_t delim = DELIM;

const wchar_t *p = sys_path;

while (1) {

p = wcschr(sys_path, delim);

if (p == NULL) {

p = sys_path + wcslen(sys_path); /* End of string */

}

size_t path_len = (p - sys_path);

wchar_t *path = PyMem_RawMalloc((path_len + 1) * sizeof(wchar_t));

if (path == NULL) {

return _Py_INIT_NO_MEMORY();

}

memcpy(path, sys_path, path_len * sizeof(wchar_t));

path[path_len] = L'\0';

_PyInitError err = _Py_wstrlist_append(&config->nmodule_search_path,

&config->module_search_paths,

path);

PyMem_RawFree(path);

if (_Py_INIT_FAILED(err)) {

return err;

}

if (*p == '\0') {

break;

}

sys_path = p + 1;

}

return _Py_INIT_OK();

}

static _PyInitError

_PyCoreConfig_CalculatePathConfig(_PyCoreConfig *config)

{

_PyPathConfig path_config = _PyPathConfig_INIT;

_PyInitError err;

err = _PyPathConfig_Calculate(&path_config, config);

if (_Py_INIT_FAILED(err)) {

goto error;

}

if (config->nmodule_search_path < 0) {

err = core_config_init_module_search_paths(config, &path_config);

if (_Py_INIT_FAILED(err)) {

goto error;

}

if (config->executable == NULL) {

if (copy_wstr(&config->executable,

path_config.program_full_path) < 0) {

goto no_memory;

}

if (config->prefix == NULL) {

if (copy_wstr(&config->prefix, path_config.prefix) < 0) {

goto no_memory;

}

if (config->exec_prefix == NULL) {

if (copy_wstr(&config->exec_prefix,

path_config.exec_prefix) < 0) {

goto no_memory;

}

#ifdef MS_WINDOWS

if (config->dll_path == NULL) {

if (copy_wstr(&config->dll_path, path_config.dll_path) < 0) {

goto no_memory;

}

#endif

if (path_config.isolated != -1) {

config->isolated = path_config.isolated;

}

if (path_config.site_import != -1) {

config->site_import = path_config.site_import;

}

_PyPathConfig_Clear(&path_config);

return _Py_INIT_OK();

no_memory:

err = _Py_INIT_NO_MEMORY();

error:

_PyPathConfig_Clear(&path_config);

return err;

}

_PyInitError

_PyCoreConfig_InitPathConfig(_PyCoreConfig *config)

{

/* Do we need to calculate the path? */

if ((config->nmodule_search_path < 0)

|| (config->executable == NULL)

|| (config->prefix == NULL)

#ifdef MS_WINDOWS

|| (config->dll_path == NULL)

#endif

|| (config->exec_prefix == NULL))

{

_PyInitError err = _PyCoreConfig_CalculatePathConfig(config);

if (_Py_INIT_FAILED(err)) {

return err;

}

if (config->base_prefix == NULL) {

if (copy_wstr(&config->base_prefix, config->prefix) < 0) {

return _Py_INIT_NO_MEMORY();

}

if (config->base_exec_prefix == NULL) {

if (copy_wstr(&config->base_exec_prefix,

config->exec_prefix) < 0) {

return _Py_INIT_NO_MEMORY();

}

return _Py_INIT_OK();

}

static void

pathconfig_global_init(void)

{

if (_Py_path_config.module_search_path != NULL) {

/* Already initialized */

return;

}

_PyInitError err;

_PyCoreConfig config = _PyCoreConfig_INIT;

err = _PyCoreConfig_Read(&config);

if (_Py_INIT_FAILED(err)) {

goto error;

}

err = _PyCoreConfig_SetPathConfig(&config);

if (_Py_INIT_FAILED(err)) {

goto error;

}

_PyCoreConfig_Clear(&config);

return;

error:

_PyCoreConfig_Clear(&config);

_Py_FatalInitError(err);

}

/* External interface */

void

Py_SetPath(const wchar_t *path)

{

if (path == NULL) {

_PyPathConfig_Clear(&_Py_path_config);

return;

}

PyMemAllocatorEx old_alloc;

_PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

_PyPathConfig new_config;

new_config.program_full_path = _PyMem_RawWcsdup(Py_GetProgramName());

int alloc_error = (new_config.program_full_path == NULL);

new_config.prefix = _PyMem_RawWcsdup(L"");

alloc_error |= (new_config.prefix == NULL);

new_config.exec_prefix = _PyMem_RawWcsdup(L"");

alloc_error |= (new_config.exec_prefix == NULL);

#ifdef MS_WINDOWS

new_config.dll_path = _PyMem_RawWcsdup(L"");

alloc_error |= (new_config.dll_path == NULL);

#endif

new_config.module_search_path = _PyMem_RawWcsdup(path);

alloc_error |= (new_config.module_search_path == NULL);

/* steal the home and program_name values (to leave them unchanged) */

new_config.home = _Py_path_config.home;

_Py_path_config.home = NULL;

new_config.program_name = _Py_path_config.program_name;

_Py_path_config.program_name = NULL;

_PyPathConfig_Clear(&_Py_path_config);

_Py_path_config = new_config;

PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

if (alloc_error) {

Py_FatalError("Py_SetPath() failed: out of memory");

}

void

Py_SetPythonHome(const wchar_t *home)

{

if (home == NULL) {

return;

}

PyMemAllocatorEx old_alloc;

_PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

PyMem_RawFree(_Py_path_config.home);

_Py_path_config.home = _PyMem_RawWcsdup(home);

PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

if (_Py_path_config.home == NULL) {

Py_FatalError("Py_SetPythonHome() failed: out of memory");

}

void

Py_SetProgramName(const wchar_t *program_name)

{

if (program_name == NULL || program_name[0] == L'\0') {

return;

}

PyMemAllocatorEx old_alloc;

_PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

PyMem_RawFree(_Py_path_config.program_name);

_Py_path_config.program_name = _PyMem_RawWcsdup(program_name);

PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

if (_Py_path_config.program_name == NULL) {

Py_FatalError("Py_SetProgramName() failed: out of memory");

}

void

_Py_SetProgramFullPath(const wchar_t *program_full_path)

{

if (program_full_path == NULL || program_full_path[0] == L'\0') {

return;

}

PyMemAllocatorEx old_alloc;

_PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

PyMem_RawFree(_Py_path_config.program_full_path);

_Py_path_config.program_full_path = _PyMem_RawWcsdup(program_full_path);

PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);

if (_Py_path_config.program_full_path == NULL) {

Py_FatalError("_Py_SetProgramFullPath() failed: out of memory");

}

wchar_t *

Py_GetPath(void)

{

pathconfig_global_init();

return _Py_path_config.module_search_path;

}

wchar_t *

Py_GetPrefix(void)

{

pathconfig_global_init();

return _Py_path_config.prefix;

}

wchar_t *

Py_GetExecPrefix(void)

{

pathconfig_global_init();

return _Py_path_config.exec_prefix;

}

wchar_t *

Py_GetProgramFullPath(void)

{

pathconfig_global_init();

return _Py_path_config.program_full_path;

}

wchar_t*

Py_GetPythonHome(void)

{

pathconfig_global_init();

return _Py_path_config.home;

}

wchar_t *

Py_GetProgramName(void)

{

pathconfig_global_init();

return _Py_path_config.program_name;

}

/* Compute argv[0] which will be prepended to sys.argv */

PyObject*

_PyPathConfig_ComputeArgv0(int argc, wchar_t **argv)

{

wchar_t *argv0;

wchar_t *p = NULL;

Py_ssize_t n = 0;

int have_script_arg = 0;

int have_module_arg = 0;

#ifdef HAVE_READLINK

wchar_t link[MAXPATHLEN+1];

wchar_t argv0copy[2*MAXPATHLEN+1];

int nr = 0;

#endif

#if defined(HAVE_REALPATH)

wchar_t fullpath[MAXPATHLEN];

#elif defined(MS_WINDOWS)

wchar_t fullpath[MAX_PATH];

#endif

argv0 = argv[0];

if (argc > 0 && argv0 != NULL) {

have_module_arg = (wcscmp(argv0, L"-m") == 0);

have_script_arg = !have_module_arg && (wcscmp(argv0, L"-c") != 0);

}

if (have_module_arg) {

#if defined(HAVE_REALPATH) || defined(MS_WINDOWS)

_Py_wgetcwd(fullpath, Py_ARRAY_LENGTH(fullpath));

argv0 = fullpath;

n = wcslen(argv0);

#else

argv0 = L".";

n = 1;

#endif

}

#ifdef HAVE_READLINK

if (have_script_arg)

nr = _Py_wreadlink(argv0, link, MAXPATHLEN);

if (nr > 0) {

/* It's a symlink */

link[nr] = '\0';

if (link[0] == SEP)

argv0 = link; /* Link to absolute path */

else if (wcschr(link, SEP) == NULL)

; /* Link without path */

else {

/* Must join(dirname(argv0), link) */

wchar_t *q = wcsrchr(argv0, SEP);

if (q == NULL)

argv0 = link; /* argv0 without path */

else {

/* Must make a copy, argv0copy has room for 2 * MAXPATHLEN */

wcsncpy(argv0copy, argv0, MAXPATHLEN);

q = wcsrchr(argv0copy, SEP);

wcsncpy(q+1, link, MAXPATHLEN);

q[MAXPATHLEN + 1] = L'\0';

argv0 = argv0copy;

}

#endif /* HAVE_READLINK */

#if SEP == '\\'

/* Special case for Microsoft filename syntax */

if (have_script_arg) {

wchar_t *q;

#if defined(MS_WINDOWS)

/* Replace the first element in argv with the full path. */

wchar_t *ptemp;

if (GetFullPathNameW(argv0,

Py_ARRAY_LENGTH(fullpath),

fullpath,

&ptemp)) {

argv0 = fullpath;

}

#endif

p = wcsrchr(argv0, SEP);

/* Test for alternate separator */

q = wcsrchr(p ? p : argv0, '/');

if (q != NULL)

p = q;

if (p != NULL) {

n = p + 1 - argv0;

if (n > 1 && p[-1] != ':')

n--; /* Drop trailing separator */

}

#else /* All other filename syntaxes */

if (have_script_arg) {

#if defined(HAVE_REALPATH)

if (_Py_wrealpath(argv0, fullpath, Py_ARRAY_LENGTH(fullpath))) {

argv0 = fullpath;

}

#endif

p = wcsrchr(argv0, SEP);

}

if (p != NULL) {

n = p + 1 - argv0;

#if SEP == '/' /* Special case for Unix filename syntax */

if (n > 1)

n--; /* Drop trailing separator */

#endif /* Unix */

}

#endif /* All others */

return PyUnicode_FromWideChar(argv0, n);

}

#ifdef MS_WINDOWS

#define WCSTOK wcstok_s

#else

#define WCSTOK wcstok

#endif

/* Search for a prefix value in an environment file (pyvenv.cfg).

If found, copy it into the provided buffer. */

int

_Py_FindEnvConfigValue(FILE *env_file, const wchar_t *key,

wchar_t *value, size_t value_size)

{

int result = 0; /* meaning not found */

char buffer[MAXPATHLEN*2+1]; /* allow extra for key, '=', etc. */

fseek(env_file, 0, SEEK_SET);

while (!feof(env_file)) {

char * p = fgets(buffer, MAXPATHLEN*2, env_file);

if (p == NULL) {

break;

}

size_t n = strlen(p);

if (p[n - 1] != '\n') {

/* line has overflowed - bail */

break;

}

if (p[0] == '#') {

/* Comment - skip */

continue;

}

wchar_t *tmpbuffer = _Py_DecodeUTF8_surrogateescape(buffer, n);

if (tmpbuffer) {

wchar_t * state;

wchar_t * tok = WCSTOK(tmpbuffer, L" \t\r\n", &state);

if ((tok != NULL) && !wcscmp(tok, key)) {

tok = WCSTOK(NULL, L" \t", &state);

if ((tok != NULL) && !wcscmp(tok, L"=")) {

tok = WCSTOK(NULL, L"\r\n", &state);

if (tok != NULL) {

wcsncpy(value, tok, MAXPATHLEN);

result = 1;

PyMem_RawFree(tmpbuffer);

break;

}

PyMem_RawFree(tmpbuffer);

}

return result;

}

#ifdef __cplusplus

}

#endif

cpython/Python/pathconfig.c at startup_debug · native-api/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

pathconfig.c

Latest commit

History

Breadcrumbs

pathconfig.c

File metadata and controls