allanlw / hphpc-docker

Docker template to relive the glory days of HPHPc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

HPHPc Docker

HPHPc is a PHP to C++ compiler that was originally developed at Facebook and later abandoned in favor of HHVM's JIT-based architecture. This repo contains a Dockerfile, git submodules for the right dependencies, and some small patches to build a container with a working HPHPc in it, as one might expect to find it in early 2013. Compiling on a modern system, while theoretically possible, is likely to result in dependency hell, so using this Dockerfile can be convenient for experimentation.

To get started quickly, an example program and invocation are provided:

docker run --rm -it awirth/hphpc:latest /hphpc/test/quick_start.sh

Build

To build this repo:

git submodule init && git submodule update --recursive
docker build -t hphpc .

hphp is now built and located in /hphpc/hhvm/hphp/hphp/hphp in the container.

For convenience, I've also published to the docker hub: https://hub.docker.com/r/awirth/hphpc/

Run

Inside the container, an example invocation might be:

/hphpc/hhvm/hphp/hphp/hphp -l 4 -k 1 -o out input.php

This has maximum verbose output (-l 4), uses out as the output directory (-o out), saves the output instead of just running it and them deleting the dir (-k 1), and uses input file input.php. Inside the out directory, there will be a file program which is the compiled program. The directory also has many useful intermediate files.

Note that compilation, even for simple programs, can take a few minutes. Be patient.

A full example run inside docker might look like:

docker run -v /home/allan/src/:/src -it awirth/hphpc:latest \
    /hphpc/hhvm/hphp/hphp/hphp -l 4 -k 1 -o /src/project/out /src/project/myprogram.php

Test

Tests can be run from /hphpc/hhvm/hphp as ./test/test. A handful of fast-ish tests are run while building the container by /hphpc/test/test.sh, which also contains some useful information about the arguments to pass to the test binary.

A full "TestcodeRun" test can take quite a long time. I've run it only once.

time HPHP_VERBOSE=1 ./test/test TestCodeRun

Running this on a 4 core Digital Ocean box resulted in:

ERROR: 79/2192 unit tests failed.

real    945m58.334s
user    3262m55.673s
sys     466m0.929s

With more cores, this would likely go faster. I was not able to debug the reason that some tests failed.

Details

There has been quite a lot of bit rot that needs to be worked around. Debugging/fixing it has been a bit gory, so details follow to save future generations the trouble.

The last commit to use HPHPc is available at facebook/hhvm@b74a0da from Feb 11 2013, however this has a critical bug documented in facebook/hhvm#700 - so we use a commit from a few days earlier. Instructions for how to build on the hphp wiki are for current versions (hhvm), but build instructions for Ubuntu 12.04 (LTS) are available in an older revision.

A small patch is applied to hhvm, which fixes a few issues. First, it prevents makeflags being propagated into HPHPc's internal invocation of make through environment variables, which was causing make to output a warning on stderr, breaking the test suite. Second, It applies a fix for bug facebook/hhvm#570 which is an issue related to static initializer ordering that would sometimes cause floating point exceptions in built targets. Third, it replaces a facebook-internal path to the php reference binary for testing with the system php. Finally, it fixes a hardcoded test hostname for testing the memcached test to point to localhost.

In addition to the patch, the Dockerfile also configures the system to use bash as the system shell (not doing this breaks some scripts), and adds a symlink from /hphpc/hhvm/src to /hphpc/hhvm/hphp to work around some dangling references to the old name of this directory left over from this commit: facebook/hhvm@363d1bb To fix tests, it also adds the root user to the mail group (a test expects root to be in more than one group), generates the German, Finish, French and English locales (tests expects these to be present), and changes the timezone to "America/Los_Angeles" (again, a test expects this).

The Dockerfile then builds hphpc and then runs a small test suite. Two scripts that are not happy being called outside of a git repository and break parallel builds are called manually before kicking off make, but after that make is run in parallel. When it's done, the test script in /test/test.sh is run.

The script in /test/test.sh performs additional initilization before calling the test suite during the build. It resolves the IP address of www.iana.org and changes the hosts file to point example.com and www.example.com to point to it. This is because a test expects example.com to serve a Connection header, and it no longer does (www.iana.org seems to for now). Next, it removes the ipv6 address for localhost, as a test expects that localhost will only have a single address returned from gethostbyname. It also changes the first alias of 127.0.0.1 to be localhost.localdomain to satisfy a different test. Finally, it symlinks /dev/random to /dev/urandom to make the MCrypt test not take forever.

The testing runs the 'QuickTests', 'TestCodeRun::TestSanity' and all of the extension tests except for TestExtMysql and TestExtPdo, which have not yet been fixed. QuickTests tests some internal runtime functionality, the extension tests are unit tests for the individual builtin extensions, and TestCodeRun::TestSanity is an integration test to ensure that a simple test program can be built successfully.

Specific commits for contemporary versions of dependencies are used in the submodules, and HPHPc further includes a bunch of third party libraries inline directly. Upgrading all of them to modern versions is a bit of an endeavor. You can find some progress, at least up to Ubuntu 14.04 if you look in the tags for this repository, but you're probably much better off using the 12.04 version which should be significantly less janky.

License

The Dockerfile is licensed CC BY-SA 3.0, as it is a simple derivative of https://github.com/facebook/hhvm/wiki/Building-and-installing-HHVM-on-Ubuntu-12.04/2c4d922e8284805d05cc3917a0de2ffe22f69cfd which is CC BY-SA 3.0 as documented at https://github.com/facebook/hhvm/wiki/License

Everything else is a derivative of HHVM, so it is under the same licenses (PHP and Zend).

About

Docker template to relive the glory days of HPHPc


Languages

Language:Shell 94.1%Language:PHP 5.9%