1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "http_request.h"
20 #include "http_config.h"
21 #include "http_protocol.h"
23 #include "apr_strings.h"
26 #include "ap_socache.h"
28 #include "distcache/dc_client.h"
30 #if !defined(DISTCACHE_CLIENT_API) || (DISTCACHE_CLIENT_API < 0x0001)
31 #error "You must compile with a more recent version of the distcache-base package"
34 struct ap_socache_instance_t {
35 /* Configured target server: */
37 /* distcache client context: */
41 static const char *socache_dc_create(ap_socache_instance_t **context,
43 apr_pool_t *tmp, apr_pool_t *p)
45 struct ap_socache_instance_t *ctx;
47 ctx = *context = apr_palloc(p, sizeof *ctx);
49 ctx->target = apr_pstrdup(p, arg);
54 static apr_status_t socache_dc_init(ap_socache_instance_t *ctx,
55 const char *namespace,
56 const struct ap_socache_hints *hints,
57 server_rec *s, apr_pool_t *p)
60 /* If a "persistent connection" mode of operation is preferred, you *must*
61 * also use the PIDCHECK flag to ensure fork()'d processes don't interlace
62 * comms on the same connection as each other. */
63 #define SESSION_CTX_FLAGS SESSION_CTX_FLAG_PERSISTENT | \
64 SESSION_CTX_FLAG_PERSISTENT_PIDCHECK | \
65 SESSION_CTX_FLAG_PERSISTENT_RETRY | \
66 SESSION_CTX_FLAG_PERSISTENT_LATE
68 /* This mode of operation will open a temporary connection to the 'target'
69 * for each cache operation - this makes it safe against fork()
70 * automatically. This mode is preferred when running a local proxy (over
71 * unix domain sockets) because overhead is negligable and it reduces the
72 * performance/stability danger of file-descriptor bloatage. */
73 #define SESSION_CTX_FLAGS 0
75 ctx->dc = DC_CTX_new(ctx->target, SESSION_CTX_FLAGS);
77 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, "distributed scache failed to obtain context");
80 ap_log_error(APLOG_MARK, APLOG_INFO, 0, s, "distributed scache context initialised");
85 static void socache_dc_destroy(ap_socache_instance_t *ctx, server_rec *s)
93 static apr_status_t socache_dc_store(ap_socache_instance_t *ctx, server_rec *s,
94 const unsigned char *id, unsigned int idlen,
96 unsigned char *der, unsigned int der_len,
99 /* !@#$%^ - why do we deal with *absolute* time anyway???
100 * Uhm - because most things expire things at a specific time?
101 * Were the API were thought out expiry - r->request_time is a good approximation
103 expiry -= apr_time_t(NULL);
104 /* Send the serialised session to the distributed cache context */
105 if (!DC_CTX_add_session(ctx->dc, id, idlen, der, der_len,
106 apr_time_in_msec(expiry)) {
107 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, "distributed scache 'store' failed");
110 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s, "distributed scache 'store' successful");
114 static apr_status_t socache_dc_retrieve(ap_socache_instance_t *ctx, server_rec *s,
115 const unsigned char *id, unsigned int idlen,
116 unsigned char *dest, unsigned int *destlen,
119 unsigned int data_len;
121 /* Retrieve any corresponding session from the distributed cache context */
122 if (!DC_CTX_get_session(ctx->dc, id, idlen, dest, *destlen, &data_len)) {
123 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s, "distributed scache 'retrieve' MISS");
126 if (data_len > *destlen) {
127 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, "distributed scache 'retrieve' OVERFLOW");
131 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s, "distributed scache 'retrieve' HIT");
135 static apr_status_t socache_dc_remove(ap_socache_instance_t *ctx,
136 server_rec *s, const unsigned char *id,
137 unsigned int idlen, apr_pool_t *p)
139 /* Remove any corresponding session from the distributed cache context */
140 if (!DC_CTX_remove_session(ctx->dc, id, idlen)) {
141 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, "distributed scache 'remove' MISS");
144 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, "distributed scache 'remove' HIT");
149 static void socache_dc_status(ap_socache_instance_t *ctx, request_rec *r, int flags)
151 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
152 "distributed scache 'socache_dc_status'");
153 ap_rprintf(r, "cache type: <b>DC (Distributed Cache)</b>, "
154 " target: <b>%s</b><br>", ctx->target);
157 static apr_status_t socache_dc_iterate(ap_socache_instance_t *instance,
158 server_rec *s, void *userctx,
159 ap_socache_iterator_t *iterator,
165 static const ap_socache_provider_t socache_dc = {
178 static void register_hooks(apr_pool_t *p)
180 ap_register_provider(p, AP_SOCACHE_PROVIDER_GROUP, "dc",
181 AP_SOCACHE_PROVIDER_VERSION,
185 AP_DECLARE_MODULE(socache_dc) = {
186 STANDARD20_MODULE_STUFF,
187 NULL, NULL, NULL, NULL, NULL,