libsystem_asl.tproj/include/asl_store.h

   1 /*
   2  * Copyright (c) 2007-2011 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef __ASL_STORE_H__
  25 #define __ASL_STORE_H__
  26
  27 #include <stdio.h>
  28 #include <stdint.h>
  29 #include <sys/time.h>
  30 #include <asl.h>
  31 #include "asl_file.h"
  32 #include <Availability.h>
  33 #include <TargetConditionals.h>
  34
  35 #if TARGET_IPHONE_SIMULATOR
  36 extern const char *_path_asl_store(void);
  37 extern const char *_path_asl_archive(void);
  38
  39 #define PATH_ASL_STORE _path_asl_store()
  40 #define PATH_ASL_ARCHIVE _path_asl_archive()
  41 #else
  42 #define PATH_ASL_STORE "/var/log/asl"
  43 #define PATH_ASL_ARCHIVE "/var/log/asl.archive"
  44 #endif
  45
  46 #define FILE_ASL_STORE_DATA "StoreData"
  47
  48 #define FILE_CACHE_SIZE 64
  49 #define FILE_CACHE_TTL 300
  50
  51 typedef struct
  52 {
  53         time_t ts;
  54         uid_t u;
  55         gid_t g;
  56         time_t bb;
  57         char *path;
  58         asl_file_t *f;
  59 } asl_cached_file_t;
  60
  61 typedef struct
  62 {
  63         char *base_dir;
  64         FILE *storedata;
  65         uint64_t next_id;
  66         asl_cached_file_t file_cache[FILE_CACHE_SIZE];
  67         void *work;
  68         time_t start_today;
  69         time_t start_tomorrow;
  70         time_t last_write;
  71         size_t max_file_size;
  72 } asl_store_t;
  73
  74 uint32_t asl_store_open_write(const char *basedir, asl_store_t **s) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  75 uint32_t asl_store_open_read(const char *basedir, asl_store_t **s) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  76 uint32_t asl_store_close(asl_store_t *s) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  77 uint32_t asl_store_statistics(asl_store_t *s, aslmsg *msg) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  78
  79 uint32_t asl_store_save(asl_store_t *s, aslmsg msg) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  80
  81 uint32_t asl_store_match(asl_store_t *s, aslresponse query, aslresponse *res, uint64_t *last_id, uint64_t start_id, uint32_t count, int32_t direction) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  82 uint32_t asl_store_match_timeout(asl_store_t *s, aslresponse query, aslresponse *res, uint64_t *last_id, uint64_t start_id, uint32_t count, int32_t direction, uint32_t usec) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_2);
  83
  84 uint32_t asl_store_match_start(asl_store_t *s, uint64_t start_id, int32_t direction) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  85 uint32_t asl_store_match_next(asl_store_t *s, aslresponse query, aslresponse *res, uint32_t count) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  86
  87 uint32_t asl_store_max_file_size(asl_store_t *s, size_t max) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  88 uint32_t asl_store_sweep_file_cache(asl_store_t *s) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_3_2);
  89
  90 uint32_t asl_store_open_aux(asl_store_t *s, aslmsg msg, int *fd, char **url) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
  91
  92 #endif /* __ASL_STORE_H__ */