Mercurial > vim
view runtime/doc/xxd-it.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 | 2b30a2b4bde2 |
children | 65b122a95cba |
line wrap: on
line source
.TH XXD 1 "Agosto 1996" "Pagina di manuale per xxd" .\" .\" 21 Maggio 1996 .\" Autore della pagina di manuale: .\" Tony Nugent <tony@sctnugen.ppp.gu.edu.au> <T.Nugent@sct.gu.edu.au> .\" Modificato da Bram Moolenaar <Bram@vim.org> .SH NOME .I xxd \- Produce esadecimale da un file binario o viceversa. .SH SINTASSI .B xxd \-h[elp] .br .B xxd [opzioni] [input_file [output_file]] .br .B xxd \-r[evert] [opzioni] [input_file [output_file]] .SH DESCRIZIONE .I xxd crea un'immagine esadecimale di un dato file o dello "standard input". Può anche ottenere da un'immagine esadecimale il file binario originale. Come .BR uuencode (1) e .BR uudecode (1) permette di trasmettere dati binari in una rappresentazione ASCII "a prova di email", ma ha anche il vantaggio di poter decodificare sullo "standard output". Inoltre, può essere usato per effettuare delle modifiche (patch) a file binari. .SH OPZIONI Se non si specifica un .I input_file il programma legge dallo "standard input". Se .I input_file è specificato come il carattere .RB \` \- ' , l'input è letto dallo "standard input". Se non si specifica un .I output_file (o si mette al suo posto il carattere .RB \` \- ' ), i risultati sono inviati allo "standard output". .PP Si noti che la scansione dei caratteri è "pigra", e non controlla oltre la prima lettera dell'opzione, a meno che l'opzione sia seguita da un parametro. Gli spazi fra una singola lettera di opzione e il corrispondente parametro dopo di essa sono facoltativi. I parametri delle opzioni possono essere specificati usando la notazione decimale, esadecimale oppure ottale. Pertanto .BR \-c8 , .BR "\-c 8" , .B \-c 010 e .B \-cols 8 sono notazioni equivalenti fra loro. .PP .TP .IR \-a " | " \-autoskip Richiesta di autoskip: Un singolo '*' rimpiazza linee di zeri binari. Valore di default: off. .TP .IR \-b " | " \-bits Richiesta di una immagine binaria (cifre binarie), invece che esadecimale. Questa opzione scrive un byte come otto cifre "1" e "0" invece di usare i numeri esadecimali. Ogni linea è preceduta da un indirizzo in esadecimale e seguita da una decodifica ascii (o ebcdic). Le opzioni specificabili dalla linea comando \-r, \-p, \-i non funzionano in questo modo. .TP .IR "\-c colonne " | " \-cols colonne" .IR "\-c colonne " | " \-cols colonne" In ogni linea sono formattate .RI < colonne > colonne. Valore di default 16 (\-i: 12, \-ps: 30, \-b: 6). Valore massimo 256. .TP .IR \-E " | " \-EBCDIC Cambia la codifica della colonna di destra da ASCII a EBCDIC. Questo non modifica la rappresentazione esadecimale. Non ha senso specificare questa opzione in combinazione con \-r, \-p o \-i. .TP .IR "\-g numero_byte " | " \-groupsize numero_byte" Inserisci ogni .RI < numero_byte > byte di output (di due caratteri esadecimali o otto numeri binari ognuno) uno spazio bianco. Specificando .I \-g 0 i byte di output non sono separati da alcuno spazio. .RI < numero_byte > ha come valore di default " 2 in modalità normale [esadecimale] e \fI1\fP in modalità binaria. Il raggruppamento non si applica agli stili "PostScript" e "include". .TP .IR \-h " | " \-help stampa un sommario dei comandi disponibili ed esce. Non viene fatto null'altro. .TP .IR \-i " | " \-include L'output è nello stile dei file "include" in C. Viene preparata la definizione completa di un "array" [vettore], dandogli il nome del file di input), tranne che nel caso in cui xxd legga dallo "standard input". .TP .IR "\-l numero " | " \-len numero" Il programma esce dopo aver scritto .RI < numero > byte. .TP .IR \-p " | " \-ps " | " \-postscript " | " \-plain L'output è nello stile di un dump continuo sotto postscript. Noto anche come stile esadecimale semplice [plain]. .TP .IR \-r " | " \-revert ricostruzione: converte (o mette una patch) a partire dall'immagine esadecimale, creando [o modificando] il file binario. Se non diretto allo "standard output", xxd scrive nel suo file di output in maniera continua, senza interruzioni. Usare la combinazione .I \-r \-p per leggere dump in stile esadecimale semplice [plain], senza l'informazione di numero di linea e senza un particolare tracciato di colonna. Degli spazi o delle linee vuote possono essere inserite a piacere [e vengono ignorate]. .TP .I \-seek distanza Usato con l'opzione .IR \-r : (ricostruzione), .RI < distanza > viene aggiunta alla posizione nel file trovata nella immagine esadecimale. .TP .I \-s [+][\-]seek Inizia a .RI < seek > byte assoluti (o relativi) di distanza all'interno di input_file. \fI+ \fRindica che il "seek" è relativo alla posizione corrente nel file "standard input" (non significativa quando non si legge da "standard input"). \fI\- \fRindica che il "seek" dovrebbe posizionarsi ad quel numero di caratteri dalla fine dell'input (o se in combinazione con \fI+ \fR: prime della posizione corrente nel file "standard input"). Se non si specifica una opzione \-s, xxd inizia alla posizione corrente all'interno del file. .TP .I \-u usa lettere esadecimali maiuscole. Il valore di default è di usare lettere minuscole. .TP .IR \-v " | " \-version visualizza la stringa contenente la versione del programma. .SH ATTENZIONE .PP .I xxd \-r è capace di operare "magie" nell'utilizzare l'informazione "numero di linea". Se sul file di output ci si può posizionare usando la "seek", il numero di linea all'inizio di ogni riga esadecimale può essere non ordinato, delle linee possono mancare delle linee, oppure esserci delle sovrapposizioni. In simili casi xxd userà lseek(2) per raggiungere la posizione d'inizio. Se il file di output non consente di usare "seek", sono permessi solo dei "buchi", che saranno riempiti con zeri binari. .PP .I xxd \-r non genera mai errori di specifica parametri. I parametri non riconosciuti sono silenziosamente ignorati. .PP Nel modificare immagini esadecimali, tenete conto che .I xxd \-r salta il resto della linea, dopo aver letto abbastanza caratteri contenenti dati esadecimali (vedere opzione \-c). Ciò implica pure che le modifiche alle colonne di caratteri stampabili ascii (o ebcdic) sono sempre ignorate. La ricostruzione da un file immagine esadecimale in stile semplice (postscript) con xxd \-r \-p non dipende dal numero corretto di colonne. IN questo caso, qualsiasi cosa assomigli a una coppia di cifre esadecimali è interpretata [e utilizzata]. .PP Notare la differenza fra .br \fI% xxd \-i file\fR .br e .br \fI% xxd \-i \< file\fR .PP .I xxd \-s \+seek può comportarsi in modo diverso da .IR "xxd \-s seek" , perché lseek(2) è usata per tornare indietro nel file di input. Il '+' fa differenza se il file di input è lo "standard input", e se la posizione nel file di "standard input" non è all'inizio del file quando xxd è eseguito, con questo input. I seguenti esempi possono contribuire a chiarire il concetto (o ad oscurarlo!)... .PP Riavvolge lo "standard input" prima di leggere; necessario perché `cat' ha già letto lo stesso file ["file"] fino alla fine dello "standard input". .br \fI% sh \-c 'cat > copia_normale; xxd \-s 0 > copia_esadecimale' < file .PP Stampa immagine esadecimale dalla posizione file 0x480 (=1024+128) in poi. Il segno `+' vuol dire "rispetto alla posizione corrente", quindi il `128' si aggiunge a 1k (1024) dove `dd' si era fermato. .br \fI% sh \-c 'dd of=normale bs=1k count=1; xxd \-s +128 > esadecimale' < file .PP Immagine esadecimale dalla posizione 0x100 ( = 1024\-768 ) del file in avanti. .br \fI% sh \-c 'dd of=normale bs=1k count=1; xxd \-s +\-768 > esadecimale' < file .PP Comunque, questo capita raramente, e l'uso del `+' non serve quasi mai. L'autore preferisce monitorare il comportamento di xxd con strace(1) o truss(1), quando si usa l'opzione \-s. .SH ESEMPI .PP .br Stampa tutto tranne le prime tre linee (0x30 byte esadecimali) di .B file \. .br \fI% xxd \-s 0x30 file .PP .br Stampa 3 linee (0x30 byte esadecimali) alla fine di .B file \. .br \fI% xxd \-s \-0x30 file .PP .br Stampa 120 byte come immagine esadecimale continua con 20 byte per linea. .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 Stampa i primi 120 byte della pagina di manuale vim.1 a 12 byte per linea. .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 Visualizza la data dal file 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 Copiare .B input_file su .B output_file premettendogli 100 byte a 0x00. .br \fI% xxd input_file | xxd \-r \-s 100 \> output_file\fR .br .br Modificare (patch) la data nel file 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 Creare un file di 65537 byte tutto a 0x00, tranne che l'ultimo carattere che è una 'A' (esadecimale 0x41). .br \fI% echo '010000: 41' | xxd \-r \> file\fR .PP .br Stampa una immagine esadecimale del file di cui sopra con opzione autoskip. .br \fI% xxd \-a \-c 12 file\fR .br 0000000: 0000 0000 0000 0000 0000 0000 ............ .br * .br 000fffc: 0000 0000 40 ....A .PP Crea un file di 1 byte che contiene il solo carattere 'A'. Il numero dopo '\-r \-s' viene aggiunto a quello trovato nel file; in pratica, i byte precedenti non sono stampati. .br \fI% echo '010000: 41' | xxd \-r \-s \-0x10000 \> file\fR .PP Usa xxd come filtro all'interno di un editor come .B vim(1) per ottenere una immagine esadecimale di una parte di file delimitata dai marcatori `a' e `z'. .br \fI:'a,'z!xxd\fR .PP Usare xxd come filtro all'interno di un editor come .B vim(1) per ricostruire un pezzo di file binario da una immagine esadecimale delimitata dai marcatori `a' e `z'. .br \fI:'a,'z!xxd \-r\fR .PP Usare xxd come filtro all'interno di un editor come .B vim(1) per ricostruire una sola linea di file binario da una immagine esadecimale, Portare il cursore sopra la linea e battere: .br \fI!!xxd \-r\fR .PP Per leggere singoli caratteri da una linea seriale .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 CODICI DI RITORNO Il programma può restituire questi codici di errore: .TP 0 nessun errore rilevato. .TP \-1 operazione non supportata ( .I xxd \-r \-i non ancora possible). .TP 1 errore durante la scansione parametri. .TP 2 problemi con il file di input. .TP 3 problemi con il file di output. .TP 4,5 posizione "seek" specificata non raggiungibile all'interno del file. .SH VEDERE ANCHE uuencode(1), uudecode(1), patch(1) .br .SH AVVERTIMENTI La stranezza dello strumento rispecchia la mente del suo creatore. Usate a vostro rischio e pericolo. Copiate i file. Tracciate l'esecuzione. Diventate un mago. .br .SH VERSIONE Questa pagina di manuale documenta la versione 1.7 di xxd. .SH AUTORE .br (c) 1990-1997 Juergen Weigert .br <jnweiger@informatik.uni\-erlangen.de> .LP Distribuite liberamente ed attribuitemi il credito, .br fate soldi e condivideteli con me .br perdete soldi e non venite a chiederli a me. .PP Pagina di manuale messa in piedi da Tony Nugent .br <tony@sctnugen.ppp.gu.edu.au> <T.Nugent@sct.gu.edu.au> .br Piccole modifiche di Bram Moolenaar. Modificato da Juergen Weigert. .PP