syslogd.tproj/daemon.h

   1 /*
   2  * Copyright (c) 2004-2012 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 __DAEMON_H__
  25 #define __DAEMON_H__
  26
  27 #include <stdio.h>
  28 #include <sys/types.h>
  29 #include <sys/queue.h>
  30 #include <time.h>
  31 #include <asl.h>
  32 #include <asl_msg.h>
  33 #include <asl_core.h>
  34 #include <asl_private.h>
  35 #include <asl_store.h>
  36 #include "asl_memory.h"
  37 #include "asl_common.h"
  38 #include <notify.h>
  39 #include <notify_keys.h>
  40 #include <launch.h>
  41 #include <dispatch/dispatch.h>
  42 #include <libkern/OSAtomic.h>
  43
  44 #include <TargetConditionals.h>
  45
  46 #define ADDFD_FLAGS_LOCAL 0x00000001
  47
  48 #define SELF_DB_NOTIFICATION "self.logger.message"
  49
  50 #define ASL_OPT_IGNORE "ignore"
  51 #define ASL_OPT_STORE "store"
  52 #define ASL_OPT_CONTROL "control"
  53 #define ASL_OPT_DB_FILE "asl_db_file"
  54 #define ASL_OPT_DB_MEMORY "asl_db_memory"
  55
  56 #if TARGET_OS_SIMULATOR
  57 /* These paths are appropriately prefixed in the simulator */
  58 extern const char *_path_pidfile;
  59 extern const char *_path_syslogd_log;
  60
  61 #define _PATH_PIDFILE _path_pidfile
  62 #define _PATH_SYSLOGD_LOG _path_syslogd_log
  63 #else
  64 #define _PATH_PIDFILE           "/var/run/syslog.pid"
  65 #define _PATH_SYSLOG_CONF   "/etc/syslog.conf"
  66 #define _PATH_SYSLOG_IN         "/var/run/syslog"
  67 #define _PATH_KLOG                      "/dev/klog"
  68 #define _PATH_SYSLOGD_LOG       "/var/log/syslogd.log"
  69 #endif
  70
  71 #define NOTIFY_PATH_SERVICE "com.apple.system.notify.service.path:0x87:"
  72
  73 #define DB_TYPE_FILE    0x00000001
  74 #define DB_TYPE_MEMORY  0x00000002
  75
  76 #define KERN_DISASTER_LEVEL 3
  77
  78 #define SOURCE_UNKNOWN      0
  79 #define SOURCE_INTERNAL     1
  80 #define SOURCE_BSD_SOCKET   2
  81 #define SOURCE_UDP_SOCKET   3
  82 #define SOURCE_KERN         4
  83 #define SOURCE_ASL_MESSAGE  5
  84 #define SOURCE_LAUNCHD      6
  85
  86 #define SOURCE_SESSION    100 /* does not generate messages */
  87
  88 #define STORE_FLAGS_FILE_CACHE_SWEEP_REQUESTED 0x00000001
  89
  90 #define FS_TTL_SEC 31622400
  91
  92 #define SEC_PER_DAY 86400
  93
  94 typedef struct sender_stats_s
  95 {
  96         char *sender;
  97         uint64_t count;
  98         uint64_t size;
  99         struct sender_stats_s *next;
 100 } sender_stats_t;
 101
 102 typedef struct
 103 {
 104         uint32_t mcount;
 105         uint32_t shim_count;
 106         uint32_t bucket_count;
 107         sender_stats_t **bucket;
 108 } stats_table_t;
 109
 110 typedef struct
 111 {
 112         const char *name;
 113         int enabled;
 114         int (*init)(void);
 115         int (*reset)(void);
 116         int (*close)(void);
 117 } module_t;
 118
 119 struct global_s
 120 {
 121         OSSpinLock lock;
 122         int client_count;
 123         int disaster_occurred;
 124         mach_port_t listen_set;
 125         mach_port_t server_port;
 126         mach_port_t dead_session_port;
 127         launch_data_t launch_dict;
 128         int *lockdown_session_fds;
 129         int lockdown_session_count;
 130         int watchers_active;
 131         int reset;
 132         pid_t pid;
 133         int32_t work_queue_count;
 134         /* memory_size must be aligned for OSAtomicAdd64 */
 135         __attribute__((aligned(8))) int64_t memory_size;
 136         int32_t asl_queue_count;
 137         int32_t bsd_queue_count;
 138         pthread_mutex_t *db_lock;
 139         pthread_cond_t work_queue_cond;
 140         dispatch_queue_t work_queue;
 141         dispatch_source_t mark_timer;
 142         dispatch_source_t sig_hup_src;
 143         asl_store_t *file_db;
 144         asl_memory_t *memory_db;
 145         asl_memory_t *disaster_db;
 146         int module_count;
 147         int bsd_out_enabled;
 148         int launchd_enabled;
 149         module_t **module;
 150         asl_out_module_t *asl_out_module;
 151         time_t stats_last;
 152         stats_table_t *stats;
 153
 154         /* parameters below are configurable as command-line args or in /etc/asl.conf */
 155         int debug;
 156         char *debug_file;
 157         char *hostname;
 158         int dbtype;
 159         uint32_t db_file_max;
 160         uint32_t db_memory_max;
 161         uint32_t db_memory_str_max;
 162         uint32_t mps_limit;
 163         uint32_t remote_delay_time;
 164         uint64_t bsd_max_dup_time;
 165         uint64_t mark_time;
 166         time_t utmp_ttl;
 167         time_t stats_interval;
 168         int64_t memory_max;
 169 };
 170
 171 extern struct global_s global;
 172
 173 void init_globals(void);
 174
 175 void config_debug(int enable, const char *path);
 176 void config_data_store(int type, uint32_t file_max, uint32_t memory_max, uint32_t str_memory_max);
 177
 178 void asl_mark(void);
 179 void asl_archive(void);
 180
 181 void asl_client_count_increment();
 182 void asl_client_count_decrement();
 183
 184 int asldebug(const char *, ...);
 185 int internal_log_message(const char *str);
 186
 187 void send_to_direct_watchers(asl_msg_t *msg);
 188
 189 #if !TARGET_OS_SIMULATOR
 190 void launchd_callback();
 191 #endif
 192
 193 int asl_syslog_faciliy_name_to_num(const char *fac);
 194 const char *asl_syslog_faciliy_num_to_name(int num);
 195 asl_msg_t *asl_input_parse(const char *in, int len, char *rhost, uint32_t source);
 196
 197 void process_message(asl_msg_t *msg, uint32_t source);
 198 void asl_out_message(asl_msg_t *msg, int64_t msize);
 199 void bsd_out_message(asl_msg_t *msg, int64_t msize);
 200 int control_set_param(const char *s, bool eval);
 201 int asl_action_control_set_param(const char *s);
 202 void asl_action_out_module_query(asl_msg_t *q, asl_msg_t *m, bool all);
 203
 204 /* notify SPI */
 205 uint32_t notify_register_plain(const char *name, int *out_token);
 206
 207 #endif /* __DAEMON_H__ */