Skip to content

Commit

Permalink
fix CHostPerl's class design & remove CHostPerl malloc-ed fnc vtbls b…
Browse files Browse the repository at this point in the history
…loat

Note, non-standard used of "static link" below, I am using it to refer
to static importing funtions/data symbols from another DLL, using the
PE import table. Opposite of "LoadLibrary()"/"GetProcAddress()"
linking. I am NOT using "static link" in typical usage of fully including
a copy of a library at compile time, through a .a/.lib/.o/.obj file.

Since commit

Revision: af2f850 10/19/2015 5:47:16 PM
const vtables in win32/perlhost.h

the vtables have been stored in read-only memory. There have been no bug
tickets or complaints since, of any users, wanting or depending on this
runtime instrumentation system.

All Win32 perl builds, are static DLL linked to a specific MSVCRT (LIBC)
at interp C compile build time. No matter the name of the CRT DLL,
msvcrt.dll, msvcrt120.dll, ucrtbase.dll, etc. Runtime swapping the
libperl MSVCRT DLL by an embedder, to his favorite CRT DLL, has never
been supported, and wouldn't even work, since perlhost.h's hooking isn't
perfect, and often Win32 Perl uses "win32_*()" functions by accident, or
explictly, and those static-link call into the hard coded CRTs. Plus
prototypes of CRT posix-ish functions have changed over the years.

What is time_t? stat_t? etc. While func symbol name stays the same.

The original commit for all this complexity, was from 5.0/5.6 era, where
it was assumed, perl 5 maint/stable releases will be abandoned by P5P
in favor of Perl 6, and all this complexity were provisions and APIs,
to fix, upgrade and improve Win32 Perl, on Microsoft's/ActiveState's
rapid release schedule, without any dependency on
P5P devs/pumpking/P5P policy, about releasing a new perl5 .tar.gz.

0f4eea8 6/19/1998 6:59:50 AM
commoit title "applied patch, along with many changes:"

"The features of this are:
1. All OS dependant code is in the Perl Host and not the Perl Core.
   (At least this is the holy grail goal of this work)
2. The Perl Host (see perl.h for description) can provide a new and
   improved interface to OS functionality if required.
3. Developers can easily hook into the OS calls for instrumentation
   or diagnostic purposes."

None of these provisions and APIs, have ever been used. CPerlHost:: never
became a separate DLL. Perl >= 5.12 has a "rapid release" policy.
ActiveState dropped sponsorship/product interest in Win32 Perl, many years
ago. Strawberry Perl took over the market. CPerlHost:: is way too
over engineereed for perl's ithreads/psuedofork, which only requires
"1 OS process" and 2 %ENVs, and 2 CWDs, functionality. Most of the
CPerlHost::* methods are jump stubs to "win32_*();" anyways, and the
hooking is redundant runtime overhead, but that is for another commit.

This commit is about removing the pointless malloc() and memcpy() of the
plain C to C++ "thunk funcs" vtables, from the RO const master copy in
perl5**.dll to each "my_perl" instance at runtime.

On x64, copying the vtables to malloc memory, wasted the following amounts
of malloc() memory. These are the actual integers passed to malloc() by
CPerlHost::/perl. malloc() secret internal headers not included in these
numbers.

perlMem, 0x38
perlMemShared, 0x38
perlMemParse, 0x38
perlEnv, 0x70
perlStdIO, 0x138
perlLIO, 0xE0
perlDir, 0x58
perlSock, 0x160
perlProc, 0x108

The old design of malloc-ed vtables, seems to have been, from the
original devs not knowing, or a poor understanding, how MS COM
(C++ obj in plain C) and MSVC ISO C++ objects (almost same ABI), are
layed out in memory. The original devs realized, if they use a ptr to
global vtable struct, they can't "cast" from the child class like
VDir:: or VMem::, back to a CPerlHost:: obj which is a design
requirement here.

But they wanted to pass around child class ptrs like VMem::* instead of one
CPerlHost:: obj ptr, and those VMem:: ptrs must be seen in 'extern "C"'
land by plain C perl, since my_perl keeps 9 of these C++ obj *s as seperate
ptrs in the my_perl "plain C" struct. So instead they made malloced copies
of the vtables, and put those copies in the CPerlHost:: obj, so from a
child class ptrs, they can C++ cast to the base class CPerlHost:: obj if
needed.

This is just wrong. Almost universally, vtables are stored in const
RO memory. Monkey-patching at runtime is a Perl lang thing, and rare
to never in C/C++land.

The ptr to "plain C to C++ func thunk vtable", CAN NOT be stored
per VDir::* or per VMem::* ptr. You can't store them, per C++ tradition,
as the 1st member/field of a VDir::/VMem:: object.

The reason is, VDir::/VMem:: objects can have refcounts, and multiple
CPerlHost:: ptrs, hold refs to one VMem:: ptr. So there is no way to
reverse a random VMem:: ptr, back to a CPerlHost:: ptr.

Main examples are VMem:: "MemShared" and VMem:: "MemParse".

Also the C->C++ thunk funcs must pick/separate, between 3 VMem:: obj ptrs.
Which are "Mem", "MemShared" and "MemParse" and stored at different
offsets in CPerlHost::*, but all 3 VMem:: derived "classes",
must have the same plain-C vtable layout with 7 extern "C" func thunk ptrs.
B/c my minimal C++ knowledge and also not wanting to add even more C++
classes to iperlsys.h perlhost.h and perllib.c, and those new C++ classes
may or may not inline-away. Don't fix this with more C++ classes.

So fix all of this, by each CPerlHost:: obj storing a ptr to the RO
vtable instead of a huge RW inlined copy of the vtable.
To keep all previous design requirements, just use
"&cperlhost_obj->vmem_whatever_vtable" as the plain-C representation
of a VMem::* ptr, instead of
"&cperlhost_obj->IPerlWhateverMem.pMalloc".

The 1 extra pointer de-ref CPU machine op, in each perl core and perl xs
caller, that executes in "iperlsys.h" family of macros I think is
irrelavent compared to the savings of having RO vtables. It is the same
machine code length on x86/x64 in each caller, comparing old vs new.

This extra ptr deref to reach the vtable can be removed, and I will
probably do it in a future commit. Not done here for bisect/small patch
reasons.

"iperlsys.h" family of macros is for example, the macro
"PerlEnv_getenv(str);"

Specific example, for macro PerlMem_free() in Perl_safesysfree()

old before this commit
----
mov     rax, [rax+0CE8h]
mov     rcx, rax
call    qword ptr [rax+10h]
-----

new after this commit
-----
mov     rcx, [rax+0CE8h]
mov     rax, [rcx]
call    qword ptr [rax+10h]
----

"mov rcx, rax" is "0x48 0x8B 0xC8" compared to
"mov rax, [rcx]" which is "0x48 0x8B 0x01".

No extra machine code "bloat" in any callers. The extra 1 memory read
is irrelavent if we are about to call malloc() or any of these other
WinOS kernel32.dll syscalls. iperlsys.h/perlhost.h does NOT hook anything
super perf critical such as "memcmp()" or "memcpy()".
  • Loading branch information
bulk88 committed Oct 28, 2024
1 parent a8a74a8 commit f4bab44
Show file tree
Hide file tree
Showing 8 changed files with 720 additions and 760 deletions.
36 changes: 18 additions & 18 deletions embed.fnc
Original file line number Diff line number Diff line change
Expand Up @@ -4048,28 +4048,28 @@ AMbdp |GV * |gv_SVadd |NULLOK GV *gv
#endif
#if defined(PERL_IMPLICIT_SYS)
CTo |PerlInterpreter *|perl_alloc_using \
|NN struct IPerlMem *ipM \
|NN struct IPerlMem *ipMS \
|NN struct IPerlMem *ipMP \
|NN struct IPerlEnv *ipE \
|NN struct IPerlStdIO *ipStd \
|NN struct IPerlLIO *ipLIO \
|NN struct IPerlDir *ipD \
|NN struct IPerlSock *ipS \
|NN struct IPerlProc *ipP
|NN const struct IPerlMem **ipM \
|NN const struct IPerlMem **ipMS \
|NN const struct IPerlMem **ipMP \
|NN const struct IPerlEnv **ipE \
|NN const struct IPerlStdIO **ipStd \
|NN const struct IPerlLIO **ipLIO \
|NN const struct IPerlDir **ipD \
|NN const struct IPerlSock **ipS \
|NN const struct IPerlProc **ipP
# if defined(USE_ITHREADS)
CTo |PerlInterpreter *|perl_clone_using \
|NN PerlInterpreter *proto_perl \
|UV flags \
|NN struct IPerlMem *ipM \
|NN struct IPerlMem *ipMS \
|NN struct IPerlMem *ipMP \
|NN struct IPerlEnv *ipE \
|NN struct IPerlStdIO *ipStd \
|NN struct IPerlLIO *ipLIO \
|NN struct IPerlDir *ipD \
|NN struct IPerlSock *ipS \
|NN struct IPerlProc *ipP
|NN const struct IPerlMem **ipM \
|NN const struct IPerlMem **ipMS \
|NN const struct IPerlMem **ipMP \
|NN const struct IPerlEnv **ipE \
|NN const struct IPerlStdIO **ipStd \
|NN const struct IPerlLIO **ipLIO \
|NN const struct IPerlDir **ipD \
|NN const struct IPerlSock **ipS \
|NN const struct IPerlProc **ipP
# endif
#else
Adp |I32 |my_pclose |NULLOK PerlIO *ptr
Expand Down
18 changes: 9 additions & 9 deletions intrpvar.h
Original file line number Diff line number Diff line change
Expand Up @@ -874,15 +874,15 @@ PERLVAR(I, psig_ptr, SV **)
PERLVAR(I, psig_name, SV **)

#if defined(PERL_IMPLICIT_SYS)
PERLVAR(I, Mem, struct IPerlMem *)
PERLVAR(I, MemShared, struct IPerlMem *)
PERLVAR(I, MemParse, struct IPerlMem *)
PERLVAR(I, Env, struct IPerlEnv *)
PERLVAR(I, StdIO, struct IPerlStdIO *)
PERLVAR(I, LIO, struct IPerlLIO *)
PERLVAR(I, Dir, struct IPerlDir *)
PERLVAR(I, Sock, struct IPerlSock *)
PERLVAR(I, Proc, struct IPerlProc *)
PERLVAR(I, Mem, const struct IPerlMem **)
PERLVAR(I, MemShared, const struct IPerlMem **)
PERLVAR(I, MemParse, const struct IPerlMem **)
PERLVAR(I, Env, const struct IPerlEnv **)
PERLVAR(I, StdIO, const struct IPerlStdIO **)
PERLVAR(I, LIO, const struct IPerlLIO **)
PERLVAR(I, Dir, const struct IPerlDir **)
PERLVAR(I, Sock, const struct IPerlSock **)
PERLVAR(I, Proc, const struct IPerlProc **)
#endif

PERLVAR(I, ptr_table, PTR_TBL_t *)
Expand Down
739 changes: 369 additions & 370 deletions iperlsys.h

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions perl.c
Original file line number Diff line number Diff line change
Expand Up @@ -167,18 +167,18 @@ Perl_sys_term(void)

#ifdef PERL_IMPLICIT_SYS
PerlInterpreter *
perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
struct IPerlMem* ipMP, struct IPerlEnv* ipE,
struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
struct IPerlDir* ipD, struct IPerlSock* ipS,
struct IPerlProc* ipP)
perl_alloc_using(const struct IPerlMem** ipM, const struct IPerlMem** ipMS,
const struct IPerlMem** ipMP, const struct IPerlEnv** ipE,
const struct IPerlStdIO** ipStd, const struct IPerlLIO** ipLIO,
const struct IPerlDir** ipD, const struct IPerlSock** ipS,
const struct IPerlProc** ipP)
{
PerlInterpreter *my_perl;

PERL_ARGS_ASSERT_PERL_ALLOC_USING;

/* Newx() needs interpreter, so call malloc() instead */
my_perl = (PerlInterpreter*)(*ipM->pCalloc)(ipM, 1, sizeof(PerlInterpreter));
my_perl = (PerlInterpreter*)((*ipM)->pCalloc)(ipM, 1, sizeof(PerlInterpreter));
S_init_tls_and_interp(my_perl);
PL_Mem = ipM;
PL_MemShared = ipMS;
Expand Down
4 changes: 2 additions & 2 deletions proto.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions sv.c
Original file line number Diff line number Diff line change
Expand Up @@ -15694,11 +15694,11 @@ perl_clone(PerlInterpreter *proto_perl, UV flags)

PerlInterpreter *
perl_clone_using(PerlInterpreter *proto_perl, UV flags,
struct IPerlMem* ipM, struct IPerlMem* ipMS,
struct IPerlMem* ipMP, struct IPerlEnv* ipE,
struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
struct IPerlDir* ipD, struct IPerlSock* ipS,
struct IPerlProc* ipP)
const struct IPerlMem** ipM, const struct IPerlMem** ipMS,
const struct IPerlMem** ipMP, const struct IPerlEnv** ipE,
const struct IPerlStdIO** ipStd, const struct IPerlLIO** ipLIO,
const struct IPerlDir** ipD, const struct IPerlSock** ipS,
const struct IPerlProc** ipP)
{
/* XXX many of the string copies here can be optimized if they're
* constants; they need to be allocated as common memory and just
Expand All @@ -15708,7 +15708,7 @@ perl_clone_using(PerlInterpreter *proto_perl, UV flags,
CLONE_PARAMS clone_params;
CLONE_PARAMS* const param = &clone_params;

PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
PerlInterpreter * const my_perl = (PerlInterpreter*)((*ipM)->pMalloc)(ipM, sizeof(PerlInterpreter));

PERL_ARGS_ASSERT_PERL_CLONE_USING;
#else /* !PERL_IMPLICIT_SYS */
Expand Down
Loading

0 comments on commit f4bab44

Please sign in to comment.