forked from pyinstaller/pyinstaller
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pyi_launch.c
640 lines (542 loc) · 19.5 KB
/
pyi_launch.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
/*
* ****************************************************************************
* Copyright (c) 2013-2020, PyInstaller Development Team.
*
* Distributed under the terms of the GNU General Public License (version 2
* or later) with exception for distributing the bootloader.
*
* The full license is in the file COPYING.txt, distributed with this software.
*
* SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)
* ****************************************************************************
*/
/*
* Launch a python module from an archive.
*/
/* TODO: use safe string functions */
#define _CRT_SECURE_NO_WARNINGS 1
#if defined(__APPLE__) && defined(WINDOWED)
#include <Carbon/Carbon.h> /* TransformProcessType */
#endif
#ifdef _WIN32
#include <windows.h>
#include <winsock.h> /* ntohl */
#else
#ifdef __FreeBSD__
/* freebsd issue #188316 */
#include <arpa/inet.h> /* ntohl */
#else
#include <netinet/in.h> /* ntohl */
#endif
#include <langinfo.h> /* CODESET, nl_langinfo */
#include <limits.h> /* PATH_MAX */
#include <stdlib.h> /* malloc */
#endif
#include <locale.h> /* setlocale */
#include <stdarg.h>
#include <stddef.h> /* ptrdiff_t */
#include <stdio.h> /* vsnprintf */
#include <string.h> /* strcpy */
#include <sys/stat.h> /* struct stat */
/* PyInstaller headers. */
#include "pyi_global.h"
#include "pyi_path.h"
#include "pyi_archive.h"
#include "pyi_utils.h"
#include "pyi_python.h"
#include "pyi_pythonlib.h"
#include "pyi_win32_utils.h" /* CreateActContext */
/* Max count of possible opened archives in multipackage mode. */
#define _MAX_ARCHIVE_POOL_LEN 20
/*
* The functions in this file defined in reverse order so that forward
* declarations are not necessary.
*/
static int
checkFile(char *buf, const char *fmt, ...)
{
va_list args;
struct stat tmp;
va_start(args, fmt);
vsnprintf(buf, PATH_MAX, fmt, args);
va_end(args);
return stat(buf, &tmp);
}
/* Splits the item in the form path:filename */
static int
splitName(char *path, char *filename, const char *item)
{
char name[PATH_MAX + 1];
VS("LOADER: Splitting item into path and filename\n");
strncpy(name, item, PATH_MAX + 1);
if (name[PATH_MAX] != '\0') {
return -1;
}
strcpy(path, strtok(name, ":"));
strcpy(filename, strtok(NULL, ":"));
if (path[0] == 0 || filename[0] == 0) {
return -1;
}
return 0;
}
/* Copy the dependencies file from a directory to the tempdir */
static int
copyDependencyFromDir(ARCHIVE_STATUS *status, const char *srcpath, const char *filename)
{
if (pyi_create_temp_path(status) == -1) {
return -1;
}
VS("LOADER: Coping file %s to %s\n", srcpath, status->temppath);
if (pyi_copy_file(srcpath, status->temppath, filename) == -1) {
return -1;
}
return 0;
}
/*
* Look for the archive identified by path into the ARCHIVE_STATUS pool archive_pool.
* If the archive is found, a pointer to the associated ARCHIVE_STATUS is returned
* otherwise the needed archive is opened and added to the pool and then returned.
* If an error occurs, returns NULL.
*
* Having several archives is useful for sharing binary dependencies with several
* executables (multipackage feature).
*/
static ARCHIVE_STATUS *
_get_archive(ARCHIVE_STATUS *archive_pool[], const char *path)
{
ARCHIVE_STATUS *archive = NULL;
int index = 0;
int SELF = 0;
VS("LOADER: Getting file from archive.\n");
if (pyi_create_temp_path(archive_pool[SELF]) == -1) {
return NULL;
}
for (index = 1; archive_pool[index] != NULL; index++) {
if (strcmp(archive_pool[index]->archivename, path) == 0) {
VS("LOADER: Archive found: %s\n", path);
return archive_pool[index];
}
VS("LOADER: Checking next archive in the list...\n");
}
archive = pyi_arch_status_new();
if (archive == NULL) {
return NULL;
}
strncpy(archive->archivename, path, PATH_MAX);
strncpy(archive->homepath, archive_pool[SELF]->homepath, PATH_MAX);
strncpy(archive->temppath, archive_pool[SELF]->temppath, PATH_MAX);
if (archive->archivename[PATH_MAX-1] != '\0'
|| archive->homepath[PATH_MAX-1] != '\0'
|| archive->temppath[PATH_MAX-1] != '\0') {
FATALERROR("Archive path exceeds PATH_MAX\n");
pyi_arch_status_free(archive);
return NULL;
}
/*
* Setting this flag prevents creating another temp directory and
* the directory from the main archive status is used.
*/
archive->has_temp_directory = archive_pool[SELF]->has_temp_directory;
if (pyi_arch_open(archive)) {
FATAL_PERROR("malloc", "Error opening archive %s\n", path);
pyi_arch_status_free(archive);
return NULL;
}
archive_pool[index] = archive;
return archive;
}
/* Extract a file identifed by filename from the archive associated to status. */
static int
extractDependencyFromArchive(ARCHIVE_STATUS *status, const char *filename)
{
TOC * ptoc = status->tocbuff;
VS("LOADER: Extracting dependencies from archive\n");
while (ptoc < status->tocend) {
if (strcmp(ptoc->name, filename) == 0) {
if (pyi_arch_extract2fs(status, ptoc)) {
return -1;
}
}
ptoc = pyi_arch_increment_toc_ptr(status, ptoc);
}
return 0;
}
/* Decide if the dependency identified by item is in a onedir or onfile archive
* then call the appropriate function.
*/
static int
_extract_dependency(ARCHIVE_STATUS *archive_pool[], const char *item)
{
ARCHIVE_STATUS *status = NULL;
ARCHIVE_STATUS *archive_status = archive_pool[0];
char path[PATH_MAX];
char filename[PATH_MAX];
char srcpath[PATH_MAX];
char archive_path[PATH_MAX];
char dirname[PATH_MAX];
VS("LOADER: Extracting dependencies\n");
if (splitName(path, filename, item) == -1) {
return -1;
}
pyi_path_dirname(dirname, path);
/* We need to identify three situations: 1) dependecies are in a onedir archive
* next to the current onefile archive, 2) dependencies are in a onedir/onefile
* archive next to the current onedir archive, 3) dependencies are in a onefile
* archive next to the current onefile archive.
*/
VS("LOADER: Checking if file exists\n");
/* TODO implement pyi_path_join to accept variable length of arguments for this case. */
if (checkFile(srcpath, "%s%s%s%s%s", archive_status->homepath, PYI_SEPSTR, dirname,
PYI_SEPSTR, filename) == 0) {
VS("LOADER: File %s found, assuming is onedir\n", srcpath);
if (copyDependencyFromDir(archive_status, srcpath, filename) == -1) {
FATALERROR("Error copying %s\n", filename);
return -1;
}
/* TODO implement pyi_path_join to accept variable length of arguments for this case. */
}
else if (checkFile(srcpath, "%s%s%s%s%s%s%s", archive_status->homepath, PYI_SEPSTR,
"..", PYI_SEPSTR, dirname, PYI_SEPSTR, filename) == 0) {
VS("LOADER: File %s found, assuming is onedir\n", srcpath);
if (copyDependencyFromDir(archive_status, srcpath, filename) == -1) {
FATALERROR("Error copying %s\n", filename);
return -1;
}
}
else {
VS("LOADER: File %s not found, assuming is onefile.\n", srcpath);
/* TODO implement pyi_path_join to accept variable length of arguments for this case. */
if ((checkFile(archive_path, "%s%s%s.pkg", archive_status->homepath, PYI_SEPSTR,
path) != 0) &&
(checkFile(archive_path, "%s%s%s.exe", archive_status->homepath, PYI_SEPSTR,
path) != 0) &&
(checkFile(archive_path, "%s%s%s", archive_status->homepath, PYI_SEPSTR,
path) != 0)) {
FATALERROR("Archive not found: %s\n", archive_path);
return -1;
}
if ((status = _get_archive(archive_pool, archive_path)) == NULL) {
FATALERROR("Archive not found: %s\n", archive_path);
return -1;
}
if (extractDependencyFromArchive(status, filename) == -1) {
FATALERROR("Error extracting %s\n", filename);
pyi_arch_status_free(status);
return -1;
}
}
return 0;
}
/*
* Check if binaries need to be extracted. If not, this is probably a onedir solution,
* and a child process will not be required on windows.
*/
int
pyi_launch_need_to_extract_binaries(ARCHIVE_STATUS *archive_status)
{
TOC * ptoc = archive_status->tocbuff;
while (ptoc < archive_status->tocend) {
if (ptoc->typcd == ARCHIVE_ITEM_BINARY || ptoc->typcd == ARCHIVE_ITEM_DATA ||
ptoc->typcd == ARCHIVE_ITEM_ZIPFILE) {
return true;
}
if (ptoc->typcd == ARCHIVE_ITEM_DEPENDENCY) {
return true;
}
ptoc = pyi_arch_increment_toc_ptr(archive_status, ptoc);
}
return false;
}
/*
* Extract all binaries (type 'b') and all data files (type 'x') to the filesystem
* and checks for dependencies (type 'd'). If dependencies are found, extract them.
*
* 'Multipackage' feature includes dependencies. Dependencies are files in other
* .exe files. Having files in other executables allows share binary files among
* executables and thus reduce the final size of the executable.
*/
int
pyi_launch_extract_binaries(ARCHIVE_STATUS *archive_status)
{
int retcode = 0;
ptrdiff_t index = 0;
/*
* archive_pool[0] is reserved for the main process, the others for dependencies.
*/
ARCHIVE_STATUS *archive_pool[_MAX_ARCHIVE_POOL_LEN];
TOC * ptoc = archive_status->tocbuff;
/* Clean memory for archive_pool list. */
memset(&archive_pool, 0, _MAX_ARCHIVE_POOL_LEN * sizeof(ARCHIVE_STATUS *));
/* Current process is the 1st item. */
archive_pool[0] = archive_status;
VS("LOADER: Extracting binaries\n");
while (ptoc < archive_status->tocend) {
if (ptoc->typcd == ARCHIVE_ITEM_BINARY || ptoc->typcd == ARCHIVE_ITEM_DATA ||
ptoc->typcd == ARCHIVE_ITEM_ZIPFILE) {
if (pyi_arch_extract2fs(archive_status, ptoc)) {
retcode = -1;
break; /* No need to extract other items in case of error. */
}
}
else {
/* 'Multipackage' feature - dependency is stored in different executables. */
if (ptoc->typcd == ARCHIVE_ITEM_DEPENDENCY) {
if (_extract_dependency(archive_pool, ptoc->name) == -1) {
retcode = -1;
break; /* No need to extract other items in case of error. */
}
}
}
ptoc = pyi_arch_increment_toc_ptr(archive_status, ptoc);
}
/*
* Free memory allocated for archive_pool data. Do not free memory
* of the main process - start with 2nd item.
*/
for (index = 1; archive_pool[index] != NULL; index++) {
pyi_arch_status_free(archive_pool[index]);
}
return retcode;
}
/*
* Run scripts
* Return non zero on failure
*/
int
pyi_launch_run_scripts(ARCHIVE_STATUS *status)
{
unsigned char *data;
const char *pvalue_cchar, *tb_cchar;
char buf[PATH_MAX];
char *char_pvalue, *char_tb, *module_name;
size_t namelen;
TOC * ptoc = status->tocbuff;
PyObject *__main__;
PyObject *__file__;
PyObject *main_dict;
PyObject *code, *retval;
PyObject *ptype, *pvalue, *pvalue_str;
PyObject *ptraceback, *tb, *tb_str;
PyObject *module, *func;
__main__ = PI_PyImport_AddModule("__main__");
if (!__main__) {
FATALERROR("Could not get __main__ module.");
return -1;
}
main_dict = PI_PyModule_GetDict(__main__);
if (!main_dict) {
FATALERROR("Could not get __main__ module's dict.");
return -1;
}
/* Iterate through toc looking for scripts (type 's') */
while (ptoc < status->tocend) {
if (ptoc->typcd == ARCHIVE_ITEM_PYSOURCE) {
/* Get data out of the archive. */
data = pyi_arch_extract(status, ptoc);
/* Set the __file__ attribute within the __main__ module,
* for full compatibility with normal execution. */
namelen = strnlen(ptoc->name, PATH_MAX);
if (namelen >= PATH_MAX-strlen(".py")-1) {
FATALERROR("Name exceeds PATH_MAX\n");
return -1;
}
strcpy(buf, ptoc->name);
strcat(buf, ".py");
VS("LOADER: Running %s\n", buf);
__file__ = PI_PyUnicode_FromString(buf);
PI_PyObject_SetAttrString(__main__, "__file__", __file__);
Py_DECREF(__file__);
/* Unmarshall code object */
code = PI_PyMarshal_ReadObjectFromString((const char *) data, ntohl(ptoc->ulen));
if (!code) {
FATALERROR("Failed to unmarshal code object for %s\n", ptoc->name);
PI_PyErr_Print();
return -1;
}
/* Run it */
retval = PI_PyEval_EvalCode(code, main_dict, main_dict);
/* If retval is NULL, an error occurred. Otherwise, it is a Python object.
* (Since we evaluate module-level code, which is not allowed to return an
* object, the Python object returned is always None.) */
if (!retval) {
FATALERROR("Failed to execute script %s\n", ptoc->name);
#if defined(WINDOWED) && defined(LAUNCH_DEBUG)
/* If running in windowed mode with debug, print the
* traceback to a message box */
/* First get the value of the error */
PI_PyErr_Fetch(&ptype, &pvalue, &ptraceback);
pvalue_str = PI_PyObject_Str(pvalue);
pvalue_cchar = PI_PyUnicode_AsUTF8(pvalue_str);
FATALERROR("Error: %s\n", pvalue_cchar);
Py_DECREF(pvalue_str);
/* Attempt to get a full traceback, only works with
* --noarchive option */
module_name = "traceback";
module = PI_PyImport_ImportModule(module_name);
if (module != NULL) {
func = PI_PyObject_GetAttrString(module, "format_exception");
if (func) {
tb = PI_PyObject_CallFunctionObjArgs(func, ptype, pvalue, ptraceback, NULL);
tb_str = PI_PyObject_Str(tb);
tb_cchar = PI_PyUnicode_AsUTF8(tb_str);
FATALERROR("Traceback: %s\n", tb_cchar);
Py_DECREF(tb);
Py_DECREF(tb_str);
}
Py_DECREF(func);
}
Py_DECREF(ptype);
Py_DECREF(pvalue);
Py_DECREF(ptraceback);
Py_DECREF(module);
#else /* if defined(WINDOWED) and defined(LAUNCH_DEBUG) */
PI_PyErr_Print();
#endif /* if defined(WINDOWED) and defined(LAUNCH_DEBUG) */
return -1;
}
free(data);
}
ptoc = pyi_arch_increment_toc_ptr(status, ptoc);
}
return 0;
}
/*
* call a simple "int func(void)" entry point. Assumes such a function
* exists in the main namespace.
* Return non zero on failure, with -2 if the specific error is
* that the function does not exist in the namespace.
*/
int
callSimpleEntryPoint(char *name, int *presult)
{
int rc = -1;
/* Objects with no ref. */
PyObject *mod, *dict;
/* Objects with refs to kill. */
PyObject *func = NULL, *pyresult = NULL;
mod = PI_PyImport_AddModule("__main__"); /* NO ref added */
if (!mod) {
VS("LOADER: No __main__\n");
goto done;
}
dict = PI_PyModule_GetDict(mod); /* NO ref added */
if (!mod) {
VS("LOADER: No __dict__\n");
goto done;
}
func = PI_PyDict_GetItemString(dict, name);
if (func == NULL) { /* should explicitly check KeyError */
VS("LOADER: CallSimpleEntryPoint can't find the function name\n");
rc = -2;
goto done;
}
pyresult = PI_PyObject_CallFunction(func, "");
if (pyresult == NULL) {
goto done;
}
PI_PyErr_Clear();
*presult = PI_PyLong_AsLong(pyresult);
rc = PI_PyErr_Occurred() ? -1 : 0;
VS( rc ? "LOADER: Finished with failure\n" : "LOADER: Finished OK\n");
/* all done! */
done:
Py_XDECREF(func);
Py_XDECREF(pyresult);
/* can't leave Python error set, else it may
* cause failures in later async code */
if (rc) {
/* But we will print them 'cos they may be useful */
PI_PyErr_Print();
}
PI_PyErr_Clear();
return rc;
}
/* For finer grained control. */
void
pyi_launch_initialize(ARCHIVE_STATUS * status)
{
#if defined(_WIN32)
char * manifest;
manifest = pyi_arch_get_option(status, "pyi-windows-manifest-filename");
if (NULL != manifest) {
manifest = pyi_path_join(NULL, status->mainpath, manifest);
CreateActContext(manifest);
free(manifest);
}
#endif /* if defined(_WIN32) */
}
/*
* Once init'ed, you might want to extractBinaries()
* If you do, what comes after is very platform specific.
* Once you've taken care of the platform specific details,
* or if there are no binaries to extract, you go on
* to pyi_launch_execute(), which is the important part.
*/
int
pyi_launch_execute(ARCHIVE_STATUS *status)
{
int rc = 0;
/* Load Python DLL */
if (pyi_pylib_load(status)) {
return -1;
}
else {
/* With this flag Python cleanup will be called. */
status->is_pylib_loaded = true;
}
/* Start Python. */
if (pyi_pylib_start_python(status)) {
return -1;
}
/* Import core pyinstaller modules from the executable - bootstrap */
if (pyi_pylib_import_modules(status)) {
return -1;
}
/* Install zlibs - now all hooks in place */
if (pyi_pylib_install_zlibs(status)) {
return -1;
}
#ifndef WIN32
/*
* On Linux sys.getfilesystemencoding() returns None but should not.
* If it's None(NULL), get the filesystem encoding by using direct
* C calls and override it with correct value.
*
* TODO: This may not be needed any more. Please confirm on Linux.
*/
if (!*PI_Py_FileSystemDefaultEncoding) {
char *saved_locale, *loc_codeset;
saved_locale = strdup(setlocale(LC_CTYPE, NULL));
VS("LOADER: LC_CTYPE was %s but resulted in NULL FileSystemDefaultEncoding\n",
saved_locale);
setlocale(LC_CTYPE, "");
loc_codeset = nl_langinfo(CODESET);
setlocale(LC_CTYPE, saved_locale);
free(saved_locale);
VS("LOADER: Setting FileSystemDefaultEncoding to %s (was NULL)\n", loc_codeset);
*PI_Py_FileSystemDefaultEncoding = loc_codeset;
}
#endif /* WIN32 */
/* Run scripts */
rc = pyi_launch_run_scripts(status);
VS("LOADER: OK.\n");
return rc;
}
void
pyi_launch_finalize(ARCHIVE_STATUS *status)
{
pyi_pylib_finalize(status);
}
/*
* On OS X this ensures that the parent process goes to background.
* Call TransformProcessType() in the parent process.
*/
void
pyi_parent_to_background()
{
#if defined(__APPLE__) && defined(WINDOWED)
ProcessSerialNumber psn = { 0, kCurrentProcess };
OSStatus returnCode = TransformProcessType(&psn,
kProcessTransformToBackgroundApplication);
#endif
}