source: subversion/applications/utils/mod_tile/mod_tile.c @ 8647

Last change on this file since 8647 was 8425, checked in by jonb, 11 years ago

mod_tile: Move map style & font location into render_config.h. Fix up operation with non-metatile rendering. Several utilities are not implemented for non-metatile (render_list, render_old, speedtest).

File size: 15.2 KB
Line 
1#include "apr.h"
2#include "apr_strings.h"
3#include "apr_thread_proc.h"    /* for RLIMIT stuff */
4#include "apr_optional.h"
5#include "apr_buckets.h"
6#include "apr_lib.h"
7#include "apr_poll.h"
8
9#define APR_WANT_STRFUNC
10#define APR_WANT_MEMFUNC
11#include "apr_want.h"
12
13#include "util_filter.h"
14#include "ap_config.h"
15#include "httpd.h"
16#include "http_config.h"
17#include "http_request.h"
18#include "http_core.h"
19#include "http_protocol.h"
20#include "http_main.h"
21#include "http_log.h"
22#include "util_script.h"
23#include "ap_mpm.h"
24#include "mod_core.h"
25#include "mod_cgi.h"
26
27module AP_MODULE_DECLARE_DATA tile_module;
28
29#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
32#include <stdarg.h>
33#include <sys/types.h>
34#include <sys/stat.h>
35#include <sys/socket.h>
36#include <sys/un.h>
37#include <unistd.h>
38#include <fcntl.h>
39#include <errno.h>
40#include <limits.h>
41#include <time.h>
42
43#include "gen_tile.h"
44#include "protocol.h"
45#include "render_config.h"
46#include "store.h"
47#include "dir_utils.h"
48
49enum tileState { tileMissing, tileOld, tileCurrent };
50
51static int error_message(request_rec *r, const char *format, ...)
52                 __attribute__ ((format (printf, 2, 3)));
53
54static int error_message(request_rec *r, const char *format, ...)
55{
56    va_list ap;
57    va_start(ap, format);
58    int len;
59    char *msg;
60
61    len = vasprintf(&msg, format, ap);
62
63    if (msg) {
64        //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "%s", msg);
65        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r, "%s", msg);
66        r->content_type = "text/plain";
67        if (!r->header_only)
68            ap_rputs(msg, r);
69        free(msg);
70    }
71
72    return OK;
73}
74
75
76int socket_init(request_rec *r)
77{
78    const char *spath = RENDER_SOCKET;
79    int fd;
80    struct sockaddr_un addr;
81
82    //fprintf(stderr, "Starting rendering client\n");
83
84    fd = socket(PF_UNIX, SOCK_STREAM, 0);
85    if (fd < 0) {
86        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "failed to create unix socket");
87        return FD_INVALID;
88    }
89
90    bzero(&addr, sizeof(addr));
91    addr.sun_family = AF_UNIX;
92    strncpy(addr.sun_path, spath, sizeof(addr.sun_path));
93
94    if (connect(fd, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
95        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "socket connect failed for: %s", spath);
96        close(fd);
97        return FD_INVALID;
98    }
99    return fd;
100}
101
102static pthread_key_t key;
103static pthread_once_t key_once = PTHREAD_ONCE_INIT;
104
105static void pfd_free(void *ptr)
106{
107    int *pfd = ptr;
108
109    if (*pfd != FD_INVALID)
110        close(*pfd);
111    free(pfd);
112}
113
114static void make_key(void)
115{
116    (void) pthread_key_create(&key, pfd_free);
117}
118
119
120int request_tile(request_rec *r, int dirtyOnly)
121{
122    struct protocol cmd;
123    int *pfd;
124    int ret = 0;
125    int retry = 1;
126    int x, y, z, n, limit, oob;
127
128    /* URI = .../<z>/<x>/<y>.png[/option] */
129    n = sscanf(r->uri, TILE_PATH "/%d/%d/%d", &z, &x, &y);
130    if (n != 3)
131        return 0;
132
133    //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "z(%d) x(%d) y(%d)", z, x, y);
134
135    // Validate tile co-ordinates
136    oob = (z < 0 || z > MAX_ZOOM);
137    if (!oob) {
138         // valid x/y for tiles are 0 ... 2^zoom-1
139        limit = (1 << z) - 1;
140        oob =  (x < 0 || x > limit || y < 0 || y > limit);
141    }
142
143    if (oob)
144        return 0;
145
146    (void) pthread_once(&key_once, make_key);
147    if ((pfd = pthread_getspecific(key)) == NULL) {
148        pfd = malloc(sizeof(*pfd));
149        if (!pfd)
150            return 0;
151        *pfd = FD_INVALID;
152        (void) pthread_setspecific(key, pfd);
153    }
154
155    if (*pfd == FD_INVALID) {
156        *pfd = socket_init(r);
157
158        if (*pfd == FD_INVALID) {
159            //fprintf(stderr, "Failed to connect to renderer\n");
160            return 0;
161        } else {
162            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r, "Connected to renderer");
163        }
164    }
165
166    bzero(&cmd, sizeof(cmd));
167
168    cmd.ver = PROTO_VER;
169    cmd.cmd = dirtyOnly ? cmdDirty : cmdRender;
170    cmd.z = z;
171    cmd.x = x;
172    cmd.y = y;
173
174    //fprintf(stderr, "Requesting tile(%d,%d,%d)\n", z,x,y);
175    do {
176        ret = send(*pfd, &cmd, sizeof(cmd), 0);
177
178        if (ret == sizeof(cmd))
179            break;
180
181        if (errno != EPIPE)
182            return 0;
183 
184         close(*pfd);
185         *pfd = socket_init(r);
186         if (*pfd == FD_INVALID)
187             return 0;
188         ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r, "Reconnected to renderer");
189    } while (retry--);
190
191    if (!dirtyOnly) {
192        struct timeval tv = { REQUEST_TIMEOUT, 0 };
193        fd_set rx;
194        int s;
195
196        while (1) {
197            FD_ZERO(&rx);
198            FD_SET(*pfd, &rx);
199            s = select((*pfd)+1, &rx, NULL, NULL, &tv);
200            if (s == 1) {
201                bzero(&cmd, sizeof(cmd));
202                ret = recv(*pfd, &cmd, sizeof(cmd), 0);
203                if (ret != sizeof(cmd)) {
204                    if (errno == EPIPE) {
205                        close(*pfd);
206                        *pfd = FD_INVALID;
207                    }
208                    //perror("recv error");
209                    break;
210                }
211                //fprintf(stderr, "Completed tile(%d,%d,%d)\n", z,x,y);
212                if (cmd.x == x && cmd.y == y && cmd.z == z) {
213                    if (cmd.cmd == cmdDone)
214                        return 1;
215                    else
216                        return 0;
217                }
218            } else if (s == 0) {
219                break;
220            } else {
221                if (errno == EPIPE) {
222                    close(*pfd);
223                    *pfd = FD_INVALID;
224                    break;
225                }
226            }
227        }
228    }
229    return 0;
230}
231
232pthread_mutex_t planet_lock = PTHREAD_MUTEX_INITIALIZER;
233
234
235static int getPlanetTime(request_rec *r)
236{
237    static time_t last_check;
238    static time_t planet_timestamp;
239    time_t now = time(NULL);
240    struct stat buf;
241
242    pthread_mutex_lock(&planet_lock);
243    // Only check for updates periodically
244    if (now < last_check + 300) {
245        pthread_mutex_unlock(&planet_lock);
246        return planet_timestamp;
247    }
248
249    last_check = now;
250    if (stat(PLANET_TIMESTAMP, &buf)) {
251        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "Planet timestamp file " PLANET_TIMESTAMP " is missing");
252        // Make something up
253        planet_timestamp = now - 3 * 24 * 60 * 60;
254    } else {
255        if (buf.st_mtime != planet_timestamp) {
256            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r, "Planet file updated at %s", ctime(&buf.st_mtime));
257            planet_timestamp = buf.st_mtime;
258        }
259    }
260    pthread_mutex_unlock(&planet_lock);
261    return planet_timestamp;
262}
263
264static enum tileState tile_state_once(request_rec *r)
265{
266    // FIXME: Apache already has most, if not all, this info recorded in r->fileinfo, use this instead!
267    struct stat buf;
268
269    if (stat(r->filename, &buf))
270        return tileMissing; 
271
272    if (buf.st_mtime < getPlanetTime(r))
273        return tileOld;
274
275    return tileCurrent;
276}
277
278static enum tileState tile_state(request_rec *r)
279{
280    enum tileState state = tile_state_once(r);
281#ifdef METATILE
282    if (state == tileMissing) {
283        // Try fallback to plain .png
284        char path[PATH_MAX];
285        int x, y, z, n;
286        /* URI = .../<z>/<x>/<y>.png[/option] */
287        n = sscanf(r->uri, TILE_PATH "/%d/%d/%d", &z, &x, &y);
288        if (n == 3) {
289            xyz_to_path(path, sizeof(path), x,y,z);
290            r->filename = apr_pstrdup(r->pool, path);
291            state = tile_state_once(r);
292            //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "png fallback %d/%d/%d",x,y,z);
293
294            if (state == tileMissing) {
295                // PNG not available either, if it gets rendered, it'll now be a .meta
296                xyz_to_meta(path, sizeof(path), x,y,z);
297                r->filename = apr_pstrdup(r->pool, path);
298            }
299        }
300    }
301#endif
302    return state;
303}
304
305static void add_expiry(request_rec *r)
306{
307    apr_time_t expires, holdoff, nextPlanet;
308    apr_table_t *t = r->headers_out;
309    enum tileState state = tile_state(r);
310    char *timestr;
311
312    /* Append expiry headers ... */
313
314    //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "expires(%s), uri(%s), filename(%s), path_info(%s)\n",
315    //              r->handler, r->uri, r->filename, r->path_info);
316
317    // current tiles will expire after next planet dump is due
318    // or after 1 hour if the planet dump is late or tile is due for re-render
319    nextPlanet = (state == tileCurrent) ? apr_time_from_sec(getPlanetTime(r) + PLANET_INTERVAL) : 0;
320    holdoff = r->request_time + apr_time_from_sec(60 * 60);
321    expires = MAX(holdoff, nextPlanet);
322
323    apr_table_mergen(t, "Cache-Control",
324                     apr_psprintf(r->pool, "max-age=%" APR_TIME_T_FMT,
325                     apr_time_sec(expires - r->request_time)));
326    timestr = apr_palloc(r->pool, APR_RFC822_DATE_LEN);
327    apr_rfc822_date(timestr, expires);
328    apr_table_setn(t, "Expires", timestr);
329}
330
331static apr_status_t expires_filter(ap_filter_t *f, apr_bucket_brigade *b)
332{
333    request_rec *r = f->r;
334
335    add_expiry(r);
336
337    ap_remove_output_filter(f);
338    return ap_pass_brigade(f->next, b);
339}
340
341
342double get_load_avg(request_rec *r)
343{
344    double loadavg[1];
345    int n = getloadavg(loadavg, 1);
346
347    if (n < 1)
348        return 1000;
349    else
350        return loadavg[0];
351}
352
353static int tile_handler_dirty(request_rec *r)
354{
355    if(strcmp(r->handler, "tile_dirty"))
356        return DECLINED;
357
358    //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "handler(%s), uri(%s), filename(%s), path_info(%s)",
359    //              r->handler, r->uri, r->filename, r->path_info);
360
361    request_tile(r, 1);
362    return error_message(r, "Tile submitted for rendering");
363}
364
365
366
367static int tile_storage_hook(request_rec *r)
368{
369    int avg;
370    enum tileState state;
371
372    if (!r->handler || strcmp(r->handler, "tile_serve"))
373        return DECLINED;
374
375    avg = get_load_avg(r);
376    state = tile_state(r);
377
378    switch (state) {
379        case tileCurrent:
380            return OK;
381            break;
382        case tileOld:
383            if (avg > MAX_LOAD_OLD) {
384               // Too much load to render it now, mark dirty but return old tile
385               request_tile(r, 1);
386               return OK;
387            }
388            break;
389        case tileMissing:
390            if (avg > MAX_LOAD_MISSING) {
391               request_tile(r, 1);
392               return HTTP_NOT_FOUND;
393            }
394            break;
395    }
396
397    if (request_tile(r, 0))
398        return OK;
399
400    if (state == tileOld)
401        return OK;
402
403    return HTTP_NOT_FOUND;
404}
405
406static int tile_handler_status(request_rec *r)
407{
408    // FIXME: Apache already has most, if not all, this info recorded in r->fileinfo, use this instead!
409    struct stat buf;
410    time_t now;
411    int old;
412    char MtimeStr[32]; // At least 26 according to man ctime_r
413    char AtimeStr[32]; // At least 26 according to man ctime_r
414    char *p;
415
416    if(strcmp(r->handler, "tile_status"))
417        return DECLINED;
418
419    //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "handler(%s), uri(%s), filename(%s), path_info(%s)",
420    //              r->handler, r->uri, r->filename, r->path_info);
421
422    if (stat(r->filename, &buf))
423        return error_message(r, "Unable to find a tile at %s", r->filename);
424
425    now = time(NULL);
426    old = (buf.st_mtime < getPlanetTime(r));
427
428    MtimeStr[0] = '\0';
429    ctime_r(&buf.st_mtime, MtimeStr);
430    AtimeStr[0] = '\0';
431    ctime_r(&buf.st_atime, AtimeStr);
432
433    if ((p = strrchr(MtimeStr, '\n')))
434        *p = '\0';
435    if ((p = strrchr(AtimeStr, '\n')))
436        *p = '\0';
437
438    //return error_message(r, "Tile is %s. Last rendered at %s. Last accessed at %s", old ? "due to be rendered" : "clean", MtimeStr, AtimeStr);
439    return error_message(r, "Tile is %s. Last rendered at %s", old ? "due to be rendered" : "clean", MtimeStr);
440}
441
442static int tile_translate(request_rec *r)
443{
444    int x, y, z, n, limit;
445    char option[11];
446    int oob;
447    char abs_path[PATH_MAX];
448
449    option[0] = '\0';
450
451    //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "translate uri(%s)", r->uri);
452
453    /* URI = .../<z>/<x>/<y>.png[/option] */
454    n = sscanf(r->uri, TILE_PATH "/%d/%d/%d.png/%10s", &z, &x, &y, option);
455    /* The original rewrite config matched anything that ended with 3 numbers */
456    //if (n < 3)
457    //        n = sscanf(r->uri, TILE_PATH "%*[^0-9]%d/%d/%d.png/%10s", &z, &x, &y, option);
458
459    if (n < 3)
460        return DECLINED;
461
462    //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "z(%d) x(%d) y(%d)", z, x, y);
463
464    // Validate tile co-ordinates
465    oob = (z < 0 || z > MAX_ZOOM);
466    if (!oob) {
467         // valid x/y for tiles are 0 ... 2^zoom-1
468        limit = (1 << z) - 1;
469        oob =  (x < 0 || x > limit || y < 0 || y > limit);
470    }
471
472    if (oob) {
473        sleep(CLIENT_PENALTY);
474        return HTTP_NOT_FOUND;
475    }
476
477
478    // Generate the tile filename
479#ifdef METATILE
480    xyz_to_meta(abs_path, sizeof(abs_path), x, y, z);
481#else
482    xyz_to_path(abs_path, sizeof(abs_path), x, y, z);
483#endif
484    //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "abs_path(%s), rel_path(%s)", abs_path, rel_path);
485    r->filename = apr_pstrdup(r->pool, abs_path);
486
487    if (n == 4) {
488        if (!strcmp(option, "status"))
489            r->handler = "tile_status";
490        else if (!strcmp(option, "dirty"))
491            r->handler = "tile_dirty";
492        else
493            return DECLINED;
494    } else 
495        r->handler = "tile_serve";
496
497    return OK;
498}
499
500
501
502static int tile_handler_serve(request_rec *r)
503{
504    int x, y, z, n, limit, oob;
505    char *buf;
506    int len;
507    const int tile_max = 1024 * 1024;
508
509    if(strcmp(r->handler, "tile_serve"))
510        return DECLINED;
511
512    /* URI = .../<z>/<x>/<y>.png[/option] */
513    n = sscanf(r->uri, TILE_PATH "/%d/%d/%d", &z, &x, &y);
514    if (n != 3)
515        return 0;
516
517    // Validate tile co-ordinates
518    oob = (z < 0 || z > MAX_ZOOM);
519    if (!oob) {
520         // valid x/y for tiles are 0 ... 2^zoom-1
521        limit = (1 << z) - 1;
522        oob =  (x < 0 || x > limit || y < 0 || y > limit);
523    }
524
525    if (oob) {
526        sleep(CLIENT_PENALTY);
527        return HTTP_NOT_FOUND;
528    }
529
530    //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "serve handler(%s), uri(%s), filename(%s), path_info(%s)",
531    //              r->handler, r->uri, r->filename, r->path_info);
532
533    buf = malloc(tile_max);
534    if (!buf)
535        return HTTP_INTERNAL_SERVER_ERROR;
536
537    len = tile_read(x,y,z,buf, tile_max);
538    if (len > 0) {
539        ap_set_content_type(r, "image/png");
540        ap_set_content_length(r, len);
541        add_expiry(r);
542        ap_rwrite(buf, len, r);
543        free(buf);
544        //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "fulfilled via meta");
545        return OK;
546    }
547    free(buf);
548    //ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "len = %d", len);
549
550    return DECLINED;
551}
552
553
554
555static void register_hooks(__attribute__((unused)) apr_pool_t *p)
556{
557    ap_register_output_filter("MOD_TILE", expires_filter, NULL, APR_HOOK_MIDDLE);
558    ap_hook_handler(tile_handler_serve, NULL, NULL, APR_HOOK_MIDDLE);
559    ap_hook_handler(tile_handler_dirty, NULL, NULL, APR_HOOK_MIDDLE);
560    ap_hook_handler(tile_handler_status, NULL, NULL, APR_HOOK_MIDDLE);
561    ap_hook_translate_name(tile_translate, NULL, NULL, APR_HOOK_MIDDLE);
562    ap_hook_map_to_storage(tile_storage_hook, NULL, NULL, APR_HOOK_FIRST);
563}
564
565module AP_MODULE_DECLARE_DATA tile_module =
566{
567    STANDARD20_MODULE_STUFF,
568    NULL,           /* dir config creater */
569    NULL,           /* dir merger --- default is to override */
570    NULL,           /* server config */
571    NULL,           /* merge server config */
572    NULL,           /* command apr_table_t */
573    register_hooks  /* register hooks */
574};
Note: See TracBrowser for help on using the repository browser.