Mercurial > vim
view runtime/doc/xxd-pl.UTF-8.1 @ 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 | de5a43c5eedc |
children | 33cbd544dc46 |
line wrap: on
line source
.TH XXD 1 "Sierpień 1996" "Strona podręcznika dla xxd" .\" .\" 21st May 1996 .\" Man page author: .\" Tony Nugent <tony@sctnugen.ppp.gu.edu.au> <T.Nugent@sct.gu.edu.au> .\" Changes by Bram Moolenaar <Bram@vim.org> .SH NAZWA .I xxd \- zrzut pliku do hex lub odwrotnie .SH SYNOPSIS .B xxd \-h[elp] .br .B xxd [opcje] [plik_we [plik_wy]] .br .B xxd \-r[evert] [opcje] [plik_we [plik_wy]] .SH OPIS .I xxd tworzy zrzut heksowy podanego pliku lub standardowego wejścia. Może także przetworzyć zrzut heksowy z powrotem do oryginalnej, binarnej formy. Podobnie jak .BR uuencode (1) i .BR uudecode (1) pozwala na przekazanie danych binarnych w bezpiecznej w poczcie formie ASCII, ale ma zalety dekodowania na standardowe wyjście. Ponadto można go użyć do binarnego łatania plików. .SH OPCJE Jeśli nie podano .I plik_we xxd czyta ze standardowego wejścia. Jeśli określono .I plik_we jako znak .RB \` \- ' wtedy dane wejściowe czytane są ze standardowego wejścia. Jeśli nie podano .I plik_wy (lub podano jako .RB \` \- ' ), wyniki są wysyłane na standardowe wyjście. .PP Pamiętaj, że użyty został "leniwy" parser, który nie sprawdza więcej niż pierwszej litery opcji (o ile ta nie została obdarzona parametrem). Spacje między jedno literowymi opcjami i ich parametrami są opcjonalne. Parametry opcji mogą być określone w notacji dziesiętnej, heksadecymalej lub oktalnej. Stąd .BR \-c8 , .BR "\-c 8" , .B \-c 010 i .B \-cols 8 są sobie równoważne. .PP .TP .IR \-a " | " \-autoskip przełącza autoskip: pojedyncza '*' zastępuje linie nul. Domyślnie wyłączone. .TP .IR \-b " | " \-bits Przełącza do zrzutu bitowego (cyfr binarnych) zamiast heksowego. Opcja ta zapisuje oktety jako osiem cyfr 1 lub 0 zamiast normalnego zrzutu heksowego. Każda linia jest poprzedzona przez heksadecymalny numer linii a po nim jego reprezentacją w ascii (lub ebcdic). Opcje linii poleceń \-r, \-p, \-i nie działają w tym trybie. .TP .IR "\-c cols " | " \-cols cols" formatuje liczbę .RI < cols > oktetów na wiersz. Domyślnie 16 (\-i: 12, \-ps: 30, \-b: 6). Maks. 256. .TP .IR \-E " | "\-EBCDIC zmienia kodowanie znaków w prawej kolumnie z ASCII na EBCDIC. Nie zmienia prezentacji heksadecymalej. Opcja nie działa w połączeniu z \-r, \-p lub \-i. .TP .IR "\-g bajtów " | " \-groupsize bajtów" oddziela wyjście każdych .RI < bajtów > bajtów (dwa heksowe znaki lub osiem cyfr binarnych każde) przez biały znak. Określ .I \-g 0 by wyłączyć grupowanie. .RI < Bajtów "> domyślnie jest " 2 w trybie normalnym i \fI1\fP w trybie bitów. Grupowanie nie działa w trybie postscriptu lub włączania. .TP .IR \-h " | " \-help wypisuje podsumowanie dostępnych poleceń i kończy działanie. Nie zostaje przeprowadzony żaden zrzut. .TP .IR \-i " | " \-include wyjście w stylu włączania pliku w C. Zostaje zapisana kompletna statyczna tablica definicji (nazwana według pliku wejścia), o ile xxd nie czyta ze standardowego wejścia. .TP .IR "\-l len " | "\-len len" zakończ po wypisaniu .RI < len > oktetów. .TP .IR \-p " | " \-ps " | " \-postscript " | " \-plain wyjście w postcriptowym ciągłym stylu zrzutu heksowego. Znany także jako zwykły zrzut heksowy. .TP .IR \-r " | " \-revert odwróć operację: przekonwertuj (lub załataj) zrzut heksowy w binarkę. Jeśli nie zapisuje na standardowe wyjście, xxd zapisze plik wyjściowy bez obcinania go. Użyj kombinacji .I \-r \-p by odczytać zwykły zrzut heksadecymalny bez numerów linii i określonego układu kolumn. Dodatkowe białe znaki i łamanie wierszy są wszędzie dozwolone. .TP .I \-seek offset Kiedy użyty po .IR \-r : odwraca z .RI < offset > dodanym do pozycji w pliku odnalezionym w zrzucie heksowym. .TP .I \-s [+][\-]seek zaczyna na .RI < seek > bajtów bezwględnego (lub względnego) offsetu pliku wejściowego. \fI+ \fRwskazuje, że seek jest względne do bieżącej pozycji pliku (bez znaczenia jeśli nie wczytuje ze standardowego wejścia). \fI\- \fRwskazuje że seek powinno być o tyle znaków od końca wejścia (lub jeśli połączone z \fI+\fR: przed bieżącą pozycją pliku na standardowym wejściu). Bez opcji \-s xxd zaczyna od bieżącej pozycji w pliku. .TP .I \-u użyj wielkich liter w znakach heksowych. Domyślnie są małe znaki. .TP .IR \-v " | " \-version pokazuje wersję programu. .SH OSTRZEŻENIA .PP .I xxd \-r potrafi określić numery linii. Jeśli plik wyjścia jest możliwy do przeszukania wtedy numery linii na początku wiersza zrzutu heksowego mogą być nie po kolei, może brakować wierszy lub nakładać się na siebie. W takich wypadkach xxd użyje lseek(2) by znaleźć następną pozycję. Jeśli plik wyjściowy nie jest możliwy do przeszukania możliwe są tylko przerwy, które zostaną wypełnione bajtami null. .PP .I xxd \-r nigdy nie podaje błędów analizy. Śmieci są po cichu ignorowane. .PP W czasie edycji zrzutów heksowych, proszę zauważyć że .I xxd \-r pomija wszystko w linii wejścia po odczytaniu wystarczającej ilości kolumn danych heksadecymalnych (zobacz opcję \-c). Oznacza to także, że zmiany w drukowanych kolumnach ascii (lub ebcdic) są zawsze ignorowane. Odwrócenie zwykłego (lub postscriptowego) stylu zrzutu poprzez xxd \-r \-p nie zależy od kolejności kolumn. Tutaj cokolwiek co wygląda jak para znaków heks jest interpretowane. .PP Zauważ różnicę między .br \fI% xxd \-i plik\fR .br i .br \fI% xxd \-i < plik\fR .PP .I xxd \-s \+seek może być różne od .IR "xxd \-s seek" , ponieważ lseek(2) jest użyty do "przewinięcie" wejścia. '+' stanowi różnicę jeśli źródłem wejścia jest standardowe wejście i jeśli pozycja w pliku ze standardowego wejścia nie jest początkiem pliku w chwili uruchomienia xxd. Następujące przykłady mogą wyjaśnić (lub bardziej zmylić!)... .PP Przewiń standardowe wejście przed przeczytaniem; potrzebne ponieważ `cat' już odczytał do końca standardowego wejścia. .br \fI% sh \-c 'cat > zwykła_kopia; xxd \-s 0 > hex_kopia' < plik\fR .PP Zrzut heksowy od pozycji pliku 0x480 (=1024+128) w przód. Znak `+' oznacza "względny wobec bieżącej pozycji", stąd `128' dodaje do 1k gdzie zakończył dd. .br \fI% sh \-c 'dd of=plain_snippet bs=1k count=1; xxd \-s +128 > hex_snippet' < file\fR .PP Zrzut heksowy od pozycji pliku 0x100 ( = 1024\-768) dalej. .br \fI% sh \-c 'dd of=plain_snippet bs=1k count=1; xxd \-s +-768 > hex_snippet' < file\fR .PP Jakkolwiek, jest to rzadka sytuacja i użycie `+' jest rzadko potrzebne. Autor woli monitorować działanie xxd przy pomocy strace(1) lub truss(1) kiedy \-s jest użyte. .SH PRZYKŁADY .PP .br Wypisz wszystko z wyjątkiem pierwszych trzech linii (heksowe 0x30 bajtów) .B pliku \. .br \fI% xxd \-s 0x30 plik\fR .PP .br Wypisz trzy linie (heksowe 0x30 bajtów) z końca .B pliku \. .br \fI% xxd \-s \-0x30 plik\fR .PP .br Wypisz 120 bajtów jako ciągły zrzut heksowy z 20 oktetami na linię. .br \fI% xxd \-l 120 \-ps \-c 20 xxd.1\fR .br 2e54482058584420312022417567757374203139 .br 39362220224d616e75616c207061676520666f72 .br 20787864220a2e5c220a2e5c222032317374204d .br 617920313939360a2e5c22204d616e2070616765 .br 20617574686f723a0a2e5c2220202020546f6e79 .br 204e7567656e74203c746f6e79407363746e7567 .br .br Zrzut heksowy z pierwszymi 120 bajtami tej strony podręcznika z 12 oktetami na linię. .br \fI% xxd \-l 120 \-c 12 xxd.1\fR .br 0000000: 2e54 4820 5858 4420 3120 2241 .TH XXD 1 "A .br 000000c: 7567 7573 7420 3139 3936 2220 ugust 1996" .br 0000018: 224d 616e 7561 6c20 7061 6765 "Manual page .br 0000024: 2066 6f72 2078 7864 220a 2e5c for xxd"..\\ .br 0000030: 220a 2e5c 2220 3231 7374 204d "..\\" 21st M .br 000003c: 6179 2031 3939 360a 2e5c 2220 ay 1996..\\" .br 0000048: 4d61 6e20 7061 6765 2061 7574 Man page aut .br 0000054: 686f 723a 0a2e 5c22 2020 2020 hor:..\\" .br 0000060: 546f 6e79 204e 7567 656e 7420 Tony Nugent .br 000006c: 3c74 6f6e 7940 7363 746e 7567 <tony@sctnug .PP .br Pokaż tylko datę z pliku xxd.1 .br \fI% xxd \-s 0x36 \-l 13 \-c 13 xxd.1\fR .br 0000036: 3231 7374 204d 6179 2031 3939 36 21st May 1996 .PP .br Kopiuj .B plik_we do .B plik_wy i poprzedź 100 bajtami o wartości 0x00. .br \fI% xxd plik_we | xxd \-r \-s 100 \> plik_wy\fR .br .br Podmień datę w pliku xxd.1 .br \fI% echo '0000037: 3574 68' | xxd \-r \- xxd.1\fR .br \fI% xxd \-s 0x36 \-l 13 \-c 13 xxd.1\fR .br 0000036: 3235 7468 204d 6179 2031 3939 36 25th May 1996 .PP .br Utwórz plik o 65537 bajtach, wszystkich równych 0x00, z wyjątkiem ostatniego, który ma być 'A' (hex 0x41). .br \fI% echo '010000: 41' | xxd \-r \> plik\fR .PP .br Zrzut heksowy tego pliku z autoskipem. .br \fI% xxd \-a \-c 12 plik\fR .br 0000000: 0000 0000 0000 0000 0000 0000 ............ .br * .br 000fffc: 0000 0000 40 ....A .PP Utwórz jedno bajtowy plik zawierający pojednczą literę 'A'. Liczba po '\-r \-s' dodaje numery linii znalezione w pliku; w efekcie poprzedzające bajty są ukryte. .br \fI% echo '010000: 41' | xxd \-r \-s \-0x10000 \> plik\fR .PP Użyj xxd jako filtra wewnątrz edytora takiego jak .B vim(1) aby uzyskać zrzut heksowy zakresu między markerami `a' i `z'. .br \fI:'a,'z!xxd\fR .PP Użyj xxd jako filtra wewnątrz edytora takiego jak .B vim(1) by odzyskać binarny zrzut heksowy zakresu pomiędzy markerami `a' i `z'. .br \fI:'a,'z!xxd \-r\fR .PP Użyj xxd jako filtra wewnątrz edytora takiego jak .B vim(1) by odzyskać jedną linię zrzutu heksowego. Przejdź z kursorem na linię i wpisz: .br \fI!!xxd \-r\fR .PP Odczytaj pojednycze znaki z portu szeregowego .br \fI% xxd \-c1 < /dev/term/b &\fR .br \fI% stty < /dev/term/b \-echo \-opost \-isig \-icanon min 1\fR .br \fI% echo \-n foo > /dev/term/b\fR .PP .SH "ZWRACANE WARTOŚCI" Zwracane są następujące wartości błędów: .TP 0 nie znaleziono błędów. .TP \-1 operacja nie jest wspierana ( .I xxd \-r \-i cały czas niemożliwa). .TP 1 błąd w czasie analizowania opcji. .TP 2 problemy z plikiem wejściowym. .TP 3 problemy z plikiem wyjściowym. .TP 4,5 żądana pozycja jest nieosiągalna. .SH "ZOBACZ TAKŻE" uuencode(1), uudecode(1), patch(1) .br .SH OSTRZEŻENIA Dziwaczność narzędzi dorównuje dziwaczności mózgu twórcy. Używaj wyłącznie na własną odpowiedzialność. Kopiuj pliki. Analizuj je. Stań się czarodziejem. .br .SH WERSJA Strona podręcznika opisuje xxd w wersji 1.7 .SH AUTOR .br (c) 1990-1997 by Juergen Weigert .br <jnweiger@informatik.uni-erlangen.de> .LP Kopiuj do woli i podaj moje dane, .br zarabiaj pieniądze i dziel się ze mną, .br trać pieniądze i nie miej do mnie pretensji. .PP Strona podręcznika zapoczątkowana przez Tony'ego Nugenta .br <tony@sctnugen.ppp.gu.edu.au> <T.Nugent@sct.gu.edu.au> .br Małe zmiany: Bram Moolenaar. Redakcja: Juergen Weigert. .PP