lua_vmprep.h revision 39bfc06718264cb819a2646ec4cd1e9c421549b9
f3220f54126b25e1cf93cc26c17177b7aef850fdfielding/**
f3220f54126b25e1cf93cc26c17177b7aef850fdfielding * Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
#include "lua.h"
#include "lauxlib.h"
#include "lualib.h"
#include "httpd.h"
#include "apr_thread_rwlock.h"
#include "apr_strings.h"
#include "apr_tables.h"
#include "apr_hash.h"
#include "apr_buckets.h"
#include "apr_file_info.h"
#include "apr_time.h"
#include "apr_pools.h"
#ifndef VMPREP_H
#define VMPREP_H
#define APL_CODE_CACHE_STAT 1
#define APL_CODE_CACHE_FOREVER 2
#define APL_CODE_CACHE_NEVER 3
#define APL_SCOPE_ONCE 1
#define APL_SCOPE_REQUEST 2
#define APL_SCOPE_CONN 3
#define APL_SCOPE_SERVER 4
/**
* Specification for a lua virtual machine
*/
typedef struct
{
/* NEED TO ADD ADDITIONAL PACKAGE PATHS AS PART OF SPEC INSTEAD OF DIR CONFIG */
apr_array_header_t *package_paths;
apr_array_header_t *package_cpaths;
/* name of base file to load in the vm */
char *file;
/* APL_CODE_CACHE_STAT | APL_CODE_CACHE_FOREVER | APL_CODE_CACHE_NEVER */
int code_cache_style;
/* APL_SCOPE_ONCE | APL_SCOPE_REQUEST | APL_SCOPE_CONN | APL_SCOPE_SERVER */
int scope;
/* pool to use for lifecycle if APL_SCOPE_ONCE is set, otherwise unused */
apr_pool_t *pool;
/* Pre-compiled Lua Byte code to load directly. If bytecode_len is >0,
* the file part of this structure is ignored for loading purposes, but
* it is used for error messages.
*/
const char *bytecode;
apr_size_t bytecode_len;
} apl_vm_spec;
typedef struct
{
int code_cache_style;
char *function_name;
char *file_name;
int scope;
ap_regex_t *uri_pattern;
const char *bytecode;
apr_size_t bytecode_len;
} apl_mapped_handler_spec;
typedef struct
{
apr_pool_t *pool;
apr_hash_t *compiled_files;
apr_thread_rwlock_t *compiled_files_lock;
} apl_code_cache;
/* remove and make static once out of mod_wombat.c */
void apl_openlibs(lua_State *L);
/* remove and make static once out of mod_wombat.c */
void apl_registerlib(lua_State *L, char *name, lua_CFunction f);
/**
* Fake out addition of the "apache2" module
*/
void apl_load_apache2_lmodule(lua_State *L);
/**
* the apl_?getvm family of functions is used to create and/or obtain
* a handle to a lua state. If there is not an extant vm matching the
* spec then a new one is created.
*/
/* lua_State* apl_rgetvm(request_rec *r, apl_vm_spec *spec); */
/* returns NULL if the spec requires a request scope */
/* lua_State* apl_cgetvm(conn_rec *r, apl_vm_spec *spec);*/
/* returns NULL if the spec requires a request scope or conn scope */
/* lua_State* apl_sgetvm(server_rec *r, apl_vm_spec *spec); */
typedef void (*apl_lua_state_open_callback) (lua_State *L, apr_pool_t *p,
void *ctx);
/*
* alternate means of getting lua_State (preferred eventually)
* Obtain a lua_State which has loaded file and is associated with lifecycle_pool
* If one exists, will return extant one, otherwise will create, attach, and return
* This does no locking around the lua_State, so if the pool is shared between
* threads, locking is up the client.
*
* @lifecycle_pool -> pool whose lifeycle controls the lua_State
* @file file to be opened, also used as a key for uniquing lua_States
* @cb callback for vm initialization called *before* the file is opened
* @ctx a baton passed to cb
*/
lua_State *apl_get_lua_state(apr_pool_t *lifecycle_pool,
apl_vm_spec *spec,
apr_array_header_t *package_paths,
apr_array_header_t *package_cpaths,
apl_lua_state_open_callback cb, void *btn);
#endif