Mirror of Apache Portable Runtime
C M4 C++ Python Perl Shell Other
Switch branches/tags
Latest commit d6d48dd Sep 19, 2017 @notroj notroj * test/testlock.c (test_timeoutcond): Increase fudge factor in
  checking timeout precision; 100ms failed regularly in Fedora builds,
  500ms has Never Failed(TM).


git-svn-id: https://svn.apache.org/repos/asf/apr/apr/trunk@1808910 13f79535-47bb-0310-9956-ffa450edef68
Permalink
Failed to load latest commit information.
atomic atomic: fix API of atomic_{cas,xchg}ptr() for APR-2. Oct 6, 2016
buckets Follow up to r1788334: apr_allocator_align() should take an allocator as Apr 3, 2017
build Rather than fetch-me-a-rock, report all tool check results for Jun 8, 2017
crypto apr_crypto: follow up to r1772803. Feb 2, 2017
dbd Add include and lib paths for dependecies in some of the Jun 25, 2015
dbm Add include and lib paths for dependecies in some of the Jun 25, 2015
docs Fix typo noticed by Mike Rumph and Christophe Jaillet. Dec 14, 2013
dso Fix copy/paste typo Feb 17, 2009
encoding apr_base64_encode_len() already inclues the \0. Jan 24, 2017
file_io Win32: Create and use file mutex only for files opened with APR_FOPEN… Sep 15, 2017
helpers Limit the renames performed in apr_rename.pl to the newest ones only. Nov 30, 2002
hooks https://issues.apache.org/bugzilla/show_bug.cgi?id=51256 May 24, 2011
include * include/arch/unix/apr_arch_poll_private.h, Aug 18, 2017
locks On Windows, OS2 and BEOS, the singluar lock mechanisms were already c… Jun 2, 2017
memcache Save some cycles by not copying the pollfds. Jun 2, 2017
memory/unix Factor out common code in apr_pools.c. No function changes intended. Aug 26, 2017
misc apr_socket_listen(): Allow larger backlog queue lengths on Windows 8+. Aug 17, 2017
mmap Use CreateFileMappingW on Unicode capable Windows. Dec 18, 2016
network_io * network_io/unix/sockaddr.c (looks_like_ip): Fail for the empty Sep 11, 2017
passwd Whitespace. Sync with branches. Oct 3, 2013
poll * include/arch/unix/apr_arch_poll_private.h, Aug 18, 2017
random/unix Removed tabs; fixed braces indent; added ASF header. May 23, 2013
redis apr_redis: reserve buffer space for trailing \0. Feb 7, 2017
shmem Add apr_shm_delete() Apr 28, 2014
strings Follow-up to r1726928: Add APR_DECLARE() to apr_cstr_*() functions Oct 28, 2016
strmatch Convert various APU_DECLARE into APR_DECLARE. Jul 16, 2009
support fix a bit of 'if FOO'/'ifdef FOO' confusion Mar 29, 2011
tables apr_table_overlap: Add APR_OVERLAP_TABLES_ADD to merge and set when Mar 7, 2016
test * test/testlock.c (test_timeoutcond): Increase fudge factor in Sep 19, 2017
threadproc Use 'apr_pstrmemdup' instead of 'apr_pstrndup' when applicable in ord… Oct 24, 2015
time Bounds-check human-readable date fields (credit: Stefan Sperling) Sep 10, 2017
tools Split the ability to filter LDAP escape sequences into DN escaping or… Apr 21, 2014
uri apr_uri_parse(): Do not accept invalid characters in the scheme. Mar 28, 2013
user Use 'apr_pstrmemdup' instead of 'apr_pstrndup' when applicable in ord… Oct 24, 2015
util-misc apr_queue: Add apr_queue_timedpush() and apr_queue_timedpop() to Mar 16, 2015
xlate z/OS iconv uses ISO charset names with only one dash, e.g. ISO8859-1 Jul 22, 2011
xml apr_xml_to_text: Add style APR_XML_X2T_PARSED to maintain a consisten… Jun 12, 2016
CHANGES Win32: Don't seek to the end when opening files with APR_FOPEN_APPEND. Sep 15, 2017
CMakeLists.txt Register testsiphash for cmake. Jan 10, 2017
LICENSE Seems we forgot to merge apr-util/LICENSE while folding apr-util into… Feb 25, 2016
Makefile.in Remove my experimental vpath dox regen logic, at least till I validat… Mar 30, 2017
Makefile.win spelling fix Mar 30, 2013
NOTICE Happy New Year 2017 Jan 2, 2017
NWGNUmakefile Redis in APR_2.0 too Nov 5, 2016
README Reflect -2 suffixes Jun 25, 2015
README.FREETDS Fix line endings of trunk-specific text files Oct 29, 2013
README.cmake Fix the statement about OpenSSL and cmake 3.1.3. (Thanks, Bert) Apr 5, 2015
SConscript Revert testcstr.c for the time being while tests are structured Jan 27, 2016
SConstruct SCons: Remove unneeded file copy. Mar 24, 2009
STATUS Axe addressed showstopper (r1733775 and follow ups). Mar 6, 2016
apr-config.in Drop the incomplete LDAP abstraction layer from APR 2.0 as decided on… May 31, 2011
apr.dsp Provide apr_siphash*() functions family. Oct 7, 2016
apr.dsw Backport windows crypto build files from apr-util. We still need port… Dec 8, 2011
apr.pc.in fix the apr.pc.in file to include the cppflags in the Cflags varaible. Apr 7, 2005
build.conf Redis in APR_2.0 too Nov 5, 2016
buildconf For buildbot's sake, keep these non-fatal when scriped, for the time … Sep 9, 2015
config.layout * configure.in, config.layout: Add -version suffix to default Jun 30, 2004
configure.in locks: when pthread_mutex_timedlock() isn't available, fall back to an Apr 5, 2017
emacs-mode Help idiots like me who use emacs. Nov 6, 2003
libapr.dsp Provide apr_siphash*() functions family. Oct 7, 2016
libapr.rc Remove more Win9x support (trunk only). Jan 18, 2014

README

Apache Portable Runtime Library (APR)
=====================================

   The Apache Portable Runtime Library provides a predictable and
   consistent interface to underlying platform-specific
   implementations, with an API to which software developers may code
   and be assured of predictable if not identical behavior regardless
   of the platform on which their software is built, relieving them of
   the need to code special-case conditions to work around or take
   advantage of platform-specific deficiencies or features.

   APR and its companion libraries are implemented entirely in C
   and provide a common programming interface across a wide variety
   of operating system platforms without sacrificing performance.
   Currently supported platforms include:

     UNIX variants
     Windows
     Netware
     Mac OS X
     OS/2

   To give a brief overview, the primary core
   subsystems of APR 1.3 include the following:

     Atomic operations
     Dynamic Shared Object loading
     File I/O
     Locks (mutexes, condition variables, etc)
     Memory management (high performance allocators)
     Memory-mapped files
     Multicast Sockets
     Network I/O
     Shared memory
     Thread and Process management
     Various data structures (tables, hashes, priority queues, etc)

   APR 2.0 also provides a number of utility functions and library
   compatibility interfaces.  These were formerly part of APR-util,
   a seperate utility library in version 1 releases.  These include;

     Hashing and UUID services
     Multiple SQL DBD client interfaces
     Multiple flat-database DBM client interfaces
     Typesafe function Hooks abstraction
     MemCache interface
     Date parsing rourtines
     Resource Lists
     Thread Pools
     Queues
     Relocatable Memory Management functions
     String filename-style pattern matching
     URI Parsing
     Charset translation (iconv based)
     XML parsing (expat based)

   For a more complete list, please refer to the following URLs:

     http://apr.apache.org/docs/apr/modules.html

   Users of APR 0.9 should be aware that migrating to the APR 1.x
   programming interfaces may require some adjustments; APR 1.x is
   neither source nor binary compatible with earlier APR 0.9 releases.
   Users of APR 1.x can expect consistent interfaces and binary backwards
   compatibility throughout the entire APR 1.x release cycle, as defined
   in our versioning rules:

     http://apr.apache.org/versioning.html

   APR is already used extensively by the Apache HTTP Server
   version 2 and the Subversion revision control system, to
   name but a few.  We list all known projects using APR at
   http://apr.apache.org/projects.html -- so please let us know
   if you find our libraries useful in your own projects!


Database Providers
==================
Interfaces for copy-left licensed MySQL and gdbm DBD drivers, and 
Berkeley DB DBM all ship as part of the distribution.  To avoid licensing
incompatibilities, these are not built by default.  To enable support, 
the corresponding use the --with-{provider} option, but be aware that 
these licenses may introduce licensing implications for your compiled code.
Similarly, the bindings for propritary drivers such as Oracle must also be 
explicitly enabled.

Whenever distributing apr-util in combination with database client 
drivers, always review the license requirements of all components.


Using a Subversion Checkout on Unix
===================================

If you are building APR from SVN, you need to perform a prerequisite
step.  You must have autoconf, libtool and python installed for this 
to work.  The prerequisite is simply;

  ./buildconf

If you are building APR from a distribution tarball, buildconf is
already run for you, and you do not need autoconf, libtool or python
installed or to run buildconf unless you have patched APR's buildconf 
inputs (such as configure.in, build.conf, virtually any file within 
the build/ tree, or you add or remove source files).

Remember when updating from svn that you must rerun ./buildconf again 
to effect any changes made to the build schema in your fresh update.


Configuring and Building APR on Unix
====================================

Simply;

   ./configure --prefix=/desired/path/of/apr
   make
   make test
   make install

Configure has additional options, ./configure --help will offer you
those choices.  You may also add CC=compiler CFLAGS="compiler flags"
etc. prior to the ./configure statement (on the same line).  Please
be warned, some flags must be passed as part of the CC command,
itself, in order for autoconf to make the right determinations. Eg.;

  CC="gcc -m64" ./configure --prefix=/desired/path/of/apr

will inform APR that you are compiling to a 64 bit CPU, and autoconf
must consider that when setting up all of APR's internal and external
type declarations.

For more verbose output from testall, you may wish to invoke testall
with the flag;

   cd test
   ./testall -v


Building APR RPM files on Linux
===============================

Run the following to create SRPMs:

rpmbuild -ts apr-<version>.tar.bz2
rpmbuild -ts apr-util-<version>.tar.bz2

Run the following to create RPMs (or build from the SRPMs):

rpmbuild -tb apr-<version>.tar.bz2
rpmbuild -tb apr-util-<version>.tar.bz2

Resolve dependencies as appropriate.


Configuring and Building APR on Windows
=======================================

Using Visual Studio, you can build and run the test validation of APR.
The Makefile.win make file has a bunch of documentation about it's
options, but a trivial build is simply;

  nmake -f Makefile.win 
  nmake -f Makefile.win PREFIX=c:\desired\path\of\apr install

Note you must manually modify the include\apr.hw file before you
build to change default options, see the #define APR_HAS_... or the
#define APR_HAVE_... statements.  Be careful, many of these aren't
appropriate to be modified.  The most common change is 

#define APR_HAVE_IPV6           1

rather than 0 if this build of APR will be used strictly on machines
with the IPv6 adapter support installed.

It's trivial to include the apr.dsp (for a static library) or the
libapr.dsp (for a dynamic library) in your own build project, or you
can load apr.dsw in Visual Studio 2002 (.NET) or later, which will
convert these for you into apr.sln and associated .vcproj files.

When using APR as a dynamic library, nothing special is required,
simply link to libapr-2.lib.  To use it as a static library, simply 
define APR_DECLARE_STATIC before you include any apr header files 
in your source, and link to apr-2.lib instead.

On windows, selection of database drivers is via the environment values
DBD_LIST (for mysql, oracle, pgsql, sqlite2 and/or sqlite3) 
and DBM_LIST (db and/or gdbm).  DBD odbc and DBM sdbm are unconditionally
compiled and installed, do not include these in the list.


Generating Test Coverage information with gcc
=============================================

If you want to generate test coverage data, use the following steps:

  ./buildconf
  CFLAGS="-fprofile-arcs -ftest-coverage" ./configure
  make
  cd test
  make
  ./testall
  cd ..
  make gcov


Cryptographic Software Notice
=============================
This distribution includes cryptographic software.  The country in 
which you currently reside may have restrictions on the import, 
possession, use, and/or re-export to another country, of 
encryption software.  BEFORE using any encryption software, please 
check your country's laws, regulations and policies concerning the
import, possession, or use, and re-export of encryption software, to 
see if this is permitted.  See http://www.wassenaar.org/ for more
information.

The U.S. Government Department of Commerce, Bureau of Industry and
Security (BIS), has classified this software as Export Commodity 
Control Number (ECCN) 5D002.C.1, which includes information security
software using or performing cryptographic functions with asymmetric
algorithms.  The form and manner of this Apache Software Foundation
distribution makes it eligible for export under the License Exception
ENC Technology Software Unrestricted (TSU) exception (see the BIS 
Export Administration Regulations, Section 740.13) for both object 
code and source code.

The following provides more details on the included cryptographic
software:

  APR provides an abstract interface for symmetrical cryptographic
  functions that make use of a general-purpose encryption library,
  such as OpenSSL, NSS, or the operating system's platform-specific
  facilities. This interface is known as the apr_crypto interface,
  with implementation beneath the /crypto directory.