Loaders and Forkers¶

"prefork" is intended to be used in two different ways.

The first is by a module that wants to indicate that another module should be loaded before forking. This is known as a "Loader".

The other is a script or module that will be initiating the forking. It will tell prefork.pm that it is either going to fork, or is about to fork, or for some other reason all modules previously mentioned by the Loaders should be loaded immediately.

Usage as a Pragma¶

A Loader can register a module to be loaded using the following

  use prefork 'My::Module';

The same thing can be done in such a way as to not require prefork being installed, but taking advantage of it if it is.

  eval "use prefork 'My::Module';";

A Forker can indicate that it will be forking with the following

  use prefork ':enable';

In any use of "prefork" as a pragma, you can only pass a single value as argument. Any additional arguments will be ignored. (This may throw an error in future versions).

Compatibility with mod_perl and others¶

Part of the design of "prefork", and its minimalistic nature, is that it is intended to work easily with existing modules, needing only small changes.

For example, "prefork" itself will detect the $ENV{MOD_PERL} environment variable and automatically start in forking mode.

prefork has support for integrating with third-party modules, such as Class::Autouse. The "notify" function allows these run-time loaders to register callbacks, to be called once prefork enters forking mode.

The synopsis entry above describes adding support for prefork.pm as a dependency. To allow your third-party module loader without a dependency and only if it is installed use the following:

  eval { require prefork; }
  prefork::notify( \&function ) unless $@;

Using prefork.pm¶

From the Loader side, it is fairly simple. prefork becomes a dependency for your module, and you use it as a pragma as documented above.

For the Forker, you have two options. Use as a dependency or optional use.

In the dependency case, you add prefork as a dependency and use it as a pragma with the ':enable' option.

To add only optional support for prefork, without requiring it to be installed, you should wait until the moment just before you fork and then call "prefork::enable" directly ONLY if it is loaded.

  # Load modules if any use the prefork pragma.
  prefork::enable() if $INC{prefork.pm};

This will cause the modules to be loaded ONLY if there are any modules that need to be loaded. The main advantage of the dependency version is that you only need to enable the module once, and not before each fork.

If you wish to have your own module leverage off the forking-detection that prefork provides, you can also do the following.

  use prefork;
  if ( $prefork::FORKING ) {
      # Complete some preparation task
  }

Modules that are prefork-aware¶

mod_perl/mod_perl2

Class::Autouse

prefork $module¶

The 'prefork' function indicates that a module should be loaded before the process will fork. If already in forking mode the module will be loaded immediately.

Otherwise it will be added to a queue to be loaded later if it receives instructions that it is going to be forking.

Returns true on success, or dies on error.

enable¶

The "enable" function indicates to the prefork module that the process is going to fork, possibly immediately.

When called, prefork.pm will immediately load all outstanding modules, and will set a flag so that any further 'prefork' calls will load the module at that time.

Returns true, dying as normal is there is a problem loading a module.

notify &function¶

The "notify" function is used to integrate support for modules other than prefork.pm itself.

A module loader calls the notify function, passing it a reference to a "CODE" reference (either anon or a function reference). "prefork" will store this CODE reference, and execute it immediately as soon as it knows it is in forking-mode, but after it loads its own modules.

Callbacks are called in the order they are registered.

Normally, this will happen as soon as the "enable" function is called.

However, you should be aware that if prefork is already in preforking mode at the time that the notify function is called, prefork.pm will execute the function immediately.

This means that any third party module loader should be fully loaded and initialised before the callback is provided to "notify".

Returns true if the function is stored, or dies if not passed a "CODE" reference, or the callback is already set in the notify queue.