Skip to content

Readme.EN.md

Latest commit

 

History

History
228 lines (156 loc) · 6.64 KB

Readme.EN.md

File metadata and controls

228 lines (156 loc) · 6.64 KB

micro self-executable SAPI for PHP

Chinese readme php License tests

micro self-executable SAPI makes PHP self-executable.

Just concatenate micro.sfx and a random PHP source file or PHAR into a single file to use it.

Compatibility

Currently, it only supports PHP8+ on Windows, Linux, and macOS (and maybe some BSDs).

Fetch and Usage

A micro micro.sfx binary containing the minimal extensions set is built automatically in Github Actions. If you need more extensions, build your own micro or use crazywhalecc/static-php-cli (swoole/swow/libevent) or grab one in lwmbs actions(swow)

To use it, simply concatenate the micro.sfx file and any PHP source.

For example: if the content of myawesomeapp.php is

<?php
echo "hello, this is my awesome app." . PHP_EOL;

On Linux/macOS:

Note for macOS users: If you've downloaded micro.sfx and macOS does not let you execute it, try:

sudo xattr -d com.apple.quarantine /path/to/micro.sfx

then

cat /path/to/micro.sfx myawesomeapp.php > myawesomeapp
chmod 0755 ./myawesomeapp
./myawesomeapp
# shows "hello, this is my awesome app."

or Windows:

COPY /b \path\to\micro.sfx + myawesomeapp.php myawesomeapp.exe
myawesomeapp.exe
REM shows "hello, this is my awesome app."

Build micro.sfx

Preparation

1.Clone this repository into sapi/micro under the PHP source directory

# prepare PHP source
git clone --branch 'PHP-choose-a-release' https://github.com/php/php-src/ php-src
cd php-src
# at PHP source dir
git clone <url for this repo> sapi/micro

2.Apply patches

Patches are placed in the "patches" directory. Choose patch(es) as you like, see Readme.md in the patches dir for detail

Apply a patch:

# at PHP source dir
patch -p1 < sapi/micro/patches/<name of patch>

UNIX-like Build

0.Prepare the build environment according to the official PHP documents.

1.buildconf

# at PHP source dir
./buildconf --force

2.configure

# at PHP source dir
./configure <options>

Options for reference:

--disable-phpdbg --disable-cgi --disable-cli --disable-all --enable-micro --enable-phar --with-ffi --enable-zlib

On Linux, libc compatibility can be a problem. To address this, micro provides two kinds of configure arguments:

  • --enable-micro=yesor--enable-micro: this will make PIE shared ELF micro sfx, this kind of binary cannot be invoked cross libc (i.e. you cannot run such a binary which was built on alpine with musl on any glibc-based CentOS), but the binary can do ffi and PHP dl() function.
  • --enable-micro=all-static: this will make full static ELF micro sfx, this kind of binary can even run barely on top of any linux kernel, but ffi/dl() is not supported.

3.make

# at PHP source dir
make micro

(make all(aka. make) may work also, but it is recommended to only build the micro SAPI.)

The built file will be located at sapi/micro/micro.sfx.

Windows Build

0.Prepare the build environment according to the official PHP documents, you may also try my scripts

1.buildconf

# at PHP source dir
buildconf

2.configure

# at PHP source dir
configure <options>

Options for reference:

--disable-all --disable-zts --enable-micro --enable-phar --with-ffi --enable-zlib

3.make Due to the PHP build system's inability to statically build PHP binaries on Windows, you cannot build micro with nmake command.

# at PHP source dir
nmake micro

That built file is at <arch name like x64>\\<configuration like Release>\\micro.sfx.

Optimizations

The Hugepages optimization for Linux in the PHP build system results in a large sfx size. If you do not take advantage of Hugepages, use disable_huge_page.patch to reduce the sfx size.

A static build under Linux requires libc. The most common libc, glibc, may be large, so musl is recommended instead. Manually installed musl or some distros provided musl will provide musl-gcc or musl-clang wrapper, use one of them before configure by specify CC/CXX environs, for example

# ./buildconf things...
export CC=musl-gcc
export CXX=musl-gcc
# ./configure things
# make things

We aim to have all dependencies statically linked into sfx. However, some distro does not provide static versions of them. We may manually build them.

libffi for example (note that the ffi extension is not supported in all-static builds):

# fetch sources througe git
git clone https://github.com/libffi/libffi
cd libffi
git checkout <version you like, v3.3 for example>
autoreconf -i
# or download tarball
wget <url>
tar xf <tar name>
cd <extracted name>
# if we use musl
export CC=musl-gcc
export CXX=musl-gcc
# build, install it
./configure --prefix=/my/prefered/path &&
make -j`nproc` &&
make install

then build micro as

# ./buildconf things...
# export CC=musl-xxx things...
export PKG_CONFIG_PATH=/my/prefered/path/lib/pkgconfig
# ./configure things
# make things

Some details

INI settings

See wiki：INI-settings

PHP_BINARY constant

In micro, the PHP_BINARY constant is an empty string. You can modify it using an ini setting: micro.php_binary=somestring

Section settings

Section settings allows you code sign the concatenated executable, see wiki: Section Settings

OSS License

Copyright 2020 Longyan

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

remind me to update the English readme and fix typos and strange or offensive expressions