Mercurial > vim
view src/dosinst.h @ 32936:c517845bd10e v9.0.1776
patch 9.0.1776: No support for stable Python 3 ABI
Commit: https://github.com/vim/vim/commit/c13b3d1350b60b94fe87f0761ea31c0e7fb6ebf3
Author: Yee Cheng Chin <ychin.git@gmail.com>
Date: Sun Aug 20 21:18:38 2023 +0200
patch 9.0.1776: No support for stable Python 3 ABI
Problem: No support for stable Python 3 ABI
Solution: Support Python 3 stable ABI
Commits:
1) Support Python 3 stable ABI to allow mixed version interoperatbility
Vim currently supports embedding Python for use with plugins, and the
"dynamic" linking option allows the user to specify a locally installed
version of Python by setting `pythonthreedll`. However, one caveat is
that the Python 3 libs are not binary compatible across minor versions,
and mixing versions can potentially be dangerous (e.g. let's say Vim was
linked against the Python 3.10 SDK, but the user sets `pythonthreedll`
to a 3.11 lib). Usually, nothing bad happens, but in theory this could
lead to crashes, memory corruption, and other unpredictable behaviors.
It's also difficult for the user to tell something is wrong because Vim
has no way of reporting what Python 3 version Vim was linked with.
For Vim installed via a package manager, this usually isn't an issue
because all the dependencies would already be figured out. For prebuilt
Vim binaries like MacVim (my motivation for working on this), AppImage,
and Win32 installer this could potentially be an issue as usually a
single binary is distributed. This is more tricky when a new Python
version is released, as there's a chicken-and-egg issue with deciding
what Python version to build against and hard to keep in sync when a new
Python version just drops and we have a mix of users of different Python
versions, and a user just blindly upgrading to a new Python could lead to
bad interactions with Vim.
Python 3 does have a solution for this problem: stable ABI / limited API
(see https://docs.python.org/3/c-api/stable.html). The C SDK limits the
API to a set of functions that are promised to be stable across
versions. This pull request adds an ifdef config that allows us to turn
it on when building Vim. Vim binaries built with this option should be
safe to freely link with any Python 3 libraies without having the
constraint of having to use the same minor version.
Note: Python 2 has no such concept and this doesn't change how Python 2
integration works (not that there is going to be a new version of Python
2 that would cause compatibility issues in the future anyway).
---
Technical details:
======
The stable ABI can be accessed when we compile with the Python 3 limited
API (by defining `Py_LIMITED_API`). The Python 3 code (in `if_python3.c`
and `if_py_both.h`) would now handle this and switch to limited API
mode. Without it set, Vim will still use the full API as before so this
is an opt-in change.
The main difference is that `PyType_Object` is now an opaque struct that
we can't directly create "static types" out of, and we have to create
type objects as "heap types" instead. This is because the struct is not
stable and changes from version to version (e.g. 3.8 added a
`tp_vectorcall` field to it). I had to change all the types to be
allocated on the heap instead with just a pointer to them.
Other functions are also simply missing in limited API, or they are
introduced too late (e.g. `PyUnicode_AsUTF8AndSize` in 3.10) to it that
we need some other ways to do the same thing, so I had to abstract a few
things into macros, and sometimes re-implement functions like
`PyObject_NEW`.
One caveat is that in limited API, `OutputType` (used for replacing
`sys.stdout`) no longer inherits from `PyStdPrinter_Type` which I don't
think has any real issue other than minor differences in how they
convert to a string and missing a couple functions like `mode()` and
`fileno()`.
Also fixed an existing bug where `tp_basicsize` was set incorrectly for
`BufferObject`, `TabListObject, `WinListObject`.
Technically, there could be a small performance drop, there is a little
more indirection with accessing type objects, and some APIs like
`PyUnicode_AsUTF8AndSize` are missing, but in practice I didn't see any
difference, and any well-written Python plugin should try to avoid
excessing callbacks to the `vim` module in Python anyway.
I only tested limited API mode down to Python 3.7, which seemes to
compile and work fine. I haven't tried earlier Python versions.
2) Fix PyIter_Check on older Python vers / type##Ptr unused warning
For PyIter_Check, older versions exposed them as either macros (used in
full API), or a function (for use in limited API). A previous change
exposed PyIter_Check to the dynamic build because Python just moved it
to function-only in 3.10 anyway. Because of that, just make sure we
always grab the function in dynamic builds in earlier versions since
that's what Python eventually did anyway.
3) Move Py_LIMITED_API define to configure script
Can now use --with-python-stable-abi flag to customize what stable ABI
version to target. Can also use an env var to do so as well.
4) Show +python/dyn-stable in :version, and allow has() feature query
Not sure if the "/dyn-stable" suffix would break things, or whether we
should do it another way. Or just don't show it in version and rely on
has() feature checking.
5) Documentation first draft. Still need to implement v:python3_version
6) Fix PyIter_Check build breaks when compiling against Python 3.8
7) Add CI coverage stable ABI on Linux/Windows / make configurable on Windows
This adds configurable options for Windows make files (both MinGW and
MSVC). CI will also now exercise both traditional full API and stable
ABI for Linux and Windows in the matrix for coverage.
Also added a "dynamic" option to Linux matrix as a drive-by change to
make other scripting languages like Ruby / Perl testable under both
static and dynamic builds.
8) Fix inaccuracy in Windows docs
Python's own docs are confusing but you don't actually want to use
`python3.dll` for the dynamic linkage.
9) Add generated autoconf file
10) Add v:python3_version support
This variable indicates the version of Python3 that Vim was built
against (PY_VERSION_HEX), and will be useful to check whether the Python
library you are loading in dynamically actually fits it. When built with
stable ABI, it will be the limited ABI version instead
(`Py_LIMITED_API`), which indicates the minimum version of Python 3 the
user should have, rather than the exact match. When stable ABI is used,
we won't be exposing PY_VERSION_HEX in this var because it just doesn't
seem necessary to do so (the whole point of stable ABI is the promise
that it will work across versions), and I don't want to confuse the user
with too many variables.
Also, cleaned up some documentation, and added help tags.
11) Fix Python 3.7 compat issues
Fix a couple issues when using limited API < 3.8
- Crash on exit: In Python 3.7, if a heap-allocated type is destroyed
before all instances are, it would cause a crash later. This happens
when we destroyed `OptionsType` before calling `Py_Finalize` when
using the limited API. To make it worse, later versions changed the
semantics and now each instance has a strong reference to its own type
and the recommendation has changed to have each instance de-ref its
own type and have its type in GC traversal. To avoid dealing with
these cross-version variations, we just don't free the heap type. They
are static types in non-limited-API anyway and are designed to last
through the entirety of the app, and we also don't restart the Python
runtime and therefore do not need it to have absolutely 0 leaks.
See:
- https://docs.python.org/3/whatsnew/3.8.html#changes-in-the-c-api
- https://docs.python.org/3/whatsnew/3.9.html#changes-in-the-c-api
- PyIter_Check: This function is not provided in limited APIs older than
3.8. Previously I was trying to mock it out using manual
PyType_GetSlot() but it was brittle and also does not actually work
properly for static types (it will generate a Python error). Just
return false. It does mean using limited API < 3.8 is not recommended
as you lose the functionality to handle iterators, but from playing
with plugins I couldn't find it to be an issue.
- Fix loading of PyIter_Check so it will be done when limited API < 3.8.
Otherwise loading a 3.7 Python lib will fail even if limited API was
specified to use it.
12) Make sure to only load `PyUnicode_AsUTF8AndSize` in needed in limited API
We don't use this function unless limited API >= 3.10, but we were
loading it regardless. Usually it's ok in Unix-like systems where Python
just has a single lib that we load from, but in Windows where there is a
separate python3.dll this would not work as the symbol would not have
been exposed in this more limited DLL file. This makes it much clearer
under what condition is this function needed.
closes: #12032
Signed-off-by: Christian Brabandt <cb@256bit.org>
Co-authored-by: Yee Cheng Chin <ychin.git@gmail.com>
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sun, 20 Aug 2023 21:30:04 +0200 |
parents | 495d55210aac |
children |
line wrap: on
line source
/* vi:set ts=8 sts=4 sw=4 noet: * * VIM - Vi IMproved by Bram Moolenaar * * Do ":help uganda" in Vim to read copying and usage conditions. * Do ":help credits" in Vim to see a list of people who contributed. * See README.txt for an overview of the Vim source code. */ /* * dosinst.h: Common code for dosinst.c and uninstall.c */ #include <stdio.h> #include <stdlib.h> #include <string.h> #include <sys/stat.h> #include <fcntl.h> #ifndef UNIX_LINT # include <io.h> # include <ctype.h> # include <direct.h> # include <windows.h> # include <shlobj.h> #endif #ifdef UNIX_LINT // Running lint on Unix: Some things are missing. char *searchpath(char *name); #endif #if defined(UNIX_LINT) # include <unistd.h> # include <errno.h> #endif #include "version.h" #if defined(UNIX_LINT) # define vim_mkdir(x, y) mkdir((char *)(x), y) #else # define vim_mkdir(x, y) _mkdir((char *)(x)) #endif #define sleep(n) Sleep((n) * 1000) // ---------------------------------------- #define BUFSIZE (MAX_PATH*2) // long enough to hold a file name path #define NUL 0 #define FAIL 0 #define OK 1 #ifndef FALSE # define FALSE 0 #endif #ifndef TRUE # define TRUE 1 #endif /* * Modern way of creating registry entries, also works on 64 bit windows when * compiled as a 32 bit program. */ # ifndef KEY_WOW64_64KEY # define KEY_WOW64_64KEY 0x0100 # endif # ifndef KEY_WOW64_32KEY # define KEY_WOW64_32KEY 0x0200 # endif #ifdef __MINGW32__ # define UNUSED __attribute__((unused)) #else # define UNUSED #endif #define VIM_STARTMENU "Programs\\Vim " VIM_VERSION_SHORT int interactive; // non-zero when running interactively /* * Call malloc() and exit when out of memory. */ static void * alloc(int len) { void *p; p = malloc(len); if (p == NULL) { printf("ERROR: out of memory\n"); exit(1); } return p; } /* * The toupper() in Bcc 5.5 doesn't work, use our own implementation. */ static int mytoupper(int c) { if (c >= 'a' && c <= 'z') return c - 'a' + 'A'; return c; } static void myexit(int n) { if (!interactive) { // Present a prompt, otherwise error messages can't be read. printf("Press Enter to continue\n"); rewind(stdin); (void)getchar(); } exit(n); } typedef BOOL (WINAPI *LPFN_ISWOW64PROCESS)(HANDLE, PBOOL); /* * Check if this is a 64-bit OS. */ static BOOL is_64bit_os(void) { #ifdef _WIN64 return TRUE; #else BOOL bIsWow64 = FALSE; LPFN_ISWOW64PROCESS pIsWow64Process; pIsWow64Process = (LPFN_ISWOW64PROCESS)GetProcAddress( GetModuleHandle("kernel32"), "IsWow64Process"); if (pIsWow64Process != NULL) pIsWow64Process(GetCurrentProcess(), &bIsWow64); return bIsWow64; #endif } static char * searchpath(char *name) { static char widename[2 * BUFSIZE]; static char location[2 * BUFSIZE + 2]; // There appears to be a bug in FindExecutableA() on Windows NT. // Use FindExecutableW() instead... MultiByteToWideChar(CP_ACP, 0, (LPCTSTR)name, -1, (LPWSTR)widename, BUFSIZE); if (FindExecutableW((LPCWSTR)widename, (LPCWSTR)"", (LPWSTR)location) > (HINSTANCE)32) { WideCharToMultiByte(CP_ACP, 0, (LPWSTR)location, -1, (LPSTR)widename, 2 * BUFSIZE, NULL, NULL); return widename; } return NULL; } /* * Call searchpath() and save the result in allocated memory, or return NULL. */ static char * searchpath_save(char *name) { char *p; char *s; p = searchpath(name); if (p == NULL) return NULL; s = alloc(strlen(p) + 1); strcpy(s, p); return s; } #ifndef CSIDL_COMMON_PROGRAMS # define CSIDL_COMMON_PROGRAMS 0x0017 #endif #ifndef CSIDL_COMMON_DESKTOPDIRECTORY # define CSIDL_COMMON_DESKTOPDIRECTORY 0x0019 #endif /* * Get the path to a requested Windows shell folder. * * Return FAIL on error, OK on success */ int get_shell_folder_path( char *shell_folder_path, const char *shell_folder_name) { /* * The following code was successfully built with make_mvc.mak. * The resulting executable worked on Windows 95, Millennium Edition, and * 2000 Professional. But it was changed after testing... */ LPITEMIDLIST pidl = 0; // Pointer to an Item ID list allocated below LPMALLOC pMalloc; // Pointer to an IMalloc interface int csidl; int alt_csidl = -1; static int desktop_csidl = -1; static int programs_csidl = -1; int *pcsidl; int r; if (strcmp(shell_folder_name, "desktop") == 0) { pcsidl = &desktop_csidl; csidl = CSIDL_COMMON_DESKTOPDIRECTORY; alt_csidl = CSIDL_DESKTOP; } else if (strncmp(shell_folder_name, "Programs", 8) == 0) { pcsidl = &programs_csidl; csidl = CSIDL_COMMON_PROGRAMS; alt_csidl = CSIDL_PROGRAMS; } else { printf("\nERROR (internal) unrecognised shell_folder_name: \"%s\"\n\n", shell_folder_name); return FAIL; } // Did this stuff before, use the same ID again. if (*pcsidl >= 0) { csidl = *pcsidl; alt_csidl = -1; } retry: // Initialize pointer to IMalloc interface if (NOERROR != SHGetMalloc(&pMalloc)) { printf("\nERROR getting interface for shell_folder_name: \"%s\"\n\n", shell_folder_name); return FAIL; } // Get an ITEMIDLIST corresponding to the folder code if (NOERROR != SHGetSpecialFolderLocation(0, csidl, &pidl)) { if (alt_csidl < 0 || NOERROR != SHGetSpecialFolderLocation(0, alt_csidl, &pidl)) { printf("\nERROR getting ITEMIDLIST for shell_folder_name: \"%s\"\n\n", shell_folder_name); return FAIL; } csidl = alt_csidl; alt_csidl = -1; } // Translate that ITEMIDLIST to a string r = SHGetPathFromIDList(pidl, shell_folder_path); // Free the data associated with pidl pMalloc->lpVtbl->Free(pMalloc, pidl); // Release the IMalloc interface pMalloc->lpVtbl->Release(pMalloc); if (!r) { if (alt_csidl >= 0) { // We probably get here for Windows 95: the "all users" // desktop/start menu entry doesn't exist. csidl = alt_csidl; alt_csidl = -1; goto retry; } printf("\nERROR translating ITEMIDLIST for shell_folder_name: \"%s\"\n\n", shell_folder_name); return FAIL; } // If there is an alternative: verify we can write in this directory. // This should cause a retry when the "all users" directory exists but we // are a normal user and can't write there. if (alt_csidl >= 0) { char tbuf[BUFSIZE]; FILE *fd; strcpy(tbuf, shell_folder_path); strcat(tbuf, "\\vim write test"); fd = fopen(tbuf, "w"); if (fd == NULL) { csidl = alt_csidl; alt_csidl = -1; goto retry; } fclose(fd); unlink(tbuf); } /* * Keep the found csidl for next time, so that we don't have to do the * write test every time. */ if (*pcsidl < 0) *pcsidl = csidl; if (strncmp(shell_folder_name, "Programs\\", 9) == 0) strcat(shell_folder_path, shell_folder_name + 8); return OK; } /* * List of targets. The first one (index zero) is used for the default path * for the batch files. */ #define TARGET_COUNT 9 struct { char *name; // Vim exe name (without .exe) char *batname; // batch file name char *lnkname; // shortcut file name char *exename; // exe file name char *exenamearg; // exe file name when using exearg char *exearg; // argument for vim.exe or gvim.exe char *oldbat; // path to existing xxx.bat or NULL char *oldexe; // path to existing xxx.exe or NULL char batpath[BUFSIZE]; // path of batch file to create; not // created when it's empty } targets[TARGET_COUNT] = { {"all", "batch files", NULL, NULL, NULL, NULL, NULL, NULL, ""}, {"vim", "vim.bat", "Vim.lnk", "vim.exe", "vim.exe", "", NULL, NULL, ""}, {"gvim", "gvim.bat", "gVim.lnk", "gvim.exe", "gvim.exe", "", NULL, NULL, ""}, {"evim", "evim.bat", "gVim Easy.lnk", "evim.exe", "gvim.exe", "-y", NULL, NULL, ""}, {"view", "view.bat", "Vim Read-only.lnk", "view.exe", "vim.exe", "-R", NULL, NULL, ""}, {"gview", "gview.bat", "gVim Read-only.lnk", "gview.exe", "gvim.exe", "-R", NULL, NULL, ""}, {"vimdiff", "vimdiff.bat", "Vim Diff.lnk", "vimdiff.exe","vim.exe", "-d", NULL, NULL, ""}, {"gvimdiff","gvimdiff.bat", "gVim Diff.lnk", "gvimdiff.exe","gvim.exe", "-d", NULL, NULL, ""}, {"vimtutor","vimtutor.bat", "Vim tutor.lnk", "vimtutor.bat", "vimtutor.bat", "", NULL, NULL, ""}, }; /* Uninstall key for vim.bat, etc. */ #define VIMBAT_UNINSTKEY "rem # uninstall key: " VIM_VERSION_NODOT " #" #define ICON_COUNT 3 char *(icon_names[ICON_COUNT]) = {"gVim " VIM_VERSION_SHORT, "gVim Easy " VIM_VERSION_SHORT, "gVim Read only " VIM_VERSION_SHORT}; char *(icon_link_names[ICON_COUNT]) = {"gVim " VIM_VERSION_SHORT ".lnk", "gVim Easy " VIM_VERSION_SHORT ".lnk", "gVim Read only " VIM_VERSION_SHORT ".lnk"}; /* This is only used for dosinst.c. */ #if defined(DOSINST) /* * Run an external command and wait for it to finish. */ static void run_command(char *cmd) { char *cmd_path; char cmd_buf[BUFSIZE * 2 + 35]; char *p; // On WinNT, 'start' is a shell built-in for cmd.exe rather than an // executable (start.exe) like in Win9x. cmd_path = searchpath_save("cmd.exe"); if (cmd_path != NULL) { // There is a cmd.exe, so this might be Windows NT. If it is, // we need to call cmd.exe explicitly. If it is a later OS, // calling cmd.exe won't hurt if it is present. // Also, "start" on NT expects a window title argument. // Replace the slashes with backslashes. while ((p = strchr(cmd_path, '/')) != NULL) *p = '\\'; sprintf(cmd_buf, "%s /c start \"vimcmd\" /wait %s", cmd_path, cmd); free(cmd_path); } else { // No cmd.exe, just make the call and let the system handle it. sprintf(cmd_buf, "start /w %s", cmd); } system(cmd_buf); } #endif /* * Append a backslash to "name" if there isn't one yet. */ void add_pathsep(char *name) { int len = strlen(name); if (len > 0 && name[len - 1] != '\\' && name[len - 1] != '/') strcat(name, "\\"); } /* * The normal chdir() does not change the default drive. This one does. */ int change_drive(int drive) { char temp[3] = "-:"; temp[0] = (char)(drive + 'A' - 1); return !SetCurrentDirectory(temp); } /* * Change directory to "path". * Return 0 for success, -1 for failure. */ int mch_chdir(char *path) { if (path[0] == NUL) // just checking... return 0; if (path[1] == ':') // has a drive name { if (change_drive(mytoupper(path[0]) - 'A' + 1)) return -1; // invalid drive name path += 2; } if (*path == NUL) // drive name only return 0; return chdir(path); // let the normal chdir() do the rest } /* * Expand the executable name into a full path name. */ static char * my_fullpath(char *buf, char *fname UNUSED, int len) { // Only GetModuleFileName() will get the long file name path. // GetFullPathName() may still use the short (FAT) name. DWORD len_read = GetModuleFileName(NULL, buf, (size_t)len); return (len_read > 0 && len_read < (DWORD)len) ? buf : NULL; } /* * Remove the tail from a file or directory name. * Puts a NUL on the last '/' or '\'. */ static void remove_tail(char *path) { int i; for (i = strlen(path) - 1; i > 0; --i) if (path[i] == '/' || path[i] == '\\') { path[i] = NUL; break; } } char installdir[MAX_PATH-9]; // top of the installation dir, where the // install.exe is located, E.g.: // "c:\vim\vim60" int runtimeidx; // index in installdir[] where "vim60" starts char *sysdrive; // system drive or "c:\" /* * Setup for using this program. * Sets "installdir[]". */ static void do_inits(char **argv) { // Find out the full path of our executable. if (my_fullpath(installdir, argv[0], sizeof(installdir)) == NULL) { printf("ERROR: Cannot get name of executable\n"); myexit(1); } // remove the tail, the executable name "install.exe" remove_tail(installdir); // change to the installdir mch_chdir(installdir); // Find the system drive. Only used for searching the Vim executable, not // very important. sysdrive = getenv("SYSTEMDRIVE"); if (sysdrive == NULL || *sysdrive == NUL) sysdrive = "C:\\"; }