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_IPHONE_SIMULATOR
57/* These paths are appropriately prefixed in the simulator */
58extern const char *_path_pidfile;
59extern 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/* trigger aslmanager no more often than 300 seconds */
95#define ASLMANAGER_DELAY 300
96
97typedef struct
98{
99	const char *name;
100	int enabled;
101	int (*init)(void);
102	int (*reset)(void);
103	int (*close)(void);
104} module_t;
105
106struct global_s
107{
108	OSSpinLock lock;
109	int client_count;
110	int disaster_occurred;
111	mach_port_t listen_set;
112	mach_port_t server_port;
113	mach_port_t dead_session_port;
114	launch_data_t launch_dict;
115	int *lockdown_session_fds;
116	int lockdown_session_count;
117	int watchers_active;
118	int reset;
119	pid_t pid;
120	int32_t work_queue_count;
121	int64_t work_queue_size;
122	int32_t asl_queue_count;
123	int32_t bsd_queue_count;
124	pthread_mutex_t *db_lock;
125	pthread_cond_t work_queue_cond;
126	dispatch_queue_t work_queue;
127	dispatch_source_t mark_timer;
128	dispatch_source_t sig_hup_src;
129	asl_store_t *file_db;
130	asl_memory_t *memory_db;
131	asl_memory_t *disaster_db;
132	int module_count;
133	int bsd_out_enabled;
134	int launchd_enabled;
135	module_t **module;
136	asl_out_module_t *asl_out_module;
137	time_t aslmanager_last_trigger;
138
139	/* parameters below are configurable as command-line args or in /etc/asl.conf */
140	int debug;
141	char *debug_file;
142	int dbtype;
143	uint32_t db_file_max;
144	uint32_t db_memory_max;
145	uint32_t db_memory_str_max;
146	uint32_t mps_limit;
147	uint32_t remote_delay_time;
148	uint64_t bsd_max_dup_time;
149	uint64_t mark_time;
150	time_t utmp_ttl;
151	int64_t max_work_queue_size;
152};
153
154extern struct global_s global;
155
156void init_globals(void);
157
158void config_debug(int enable, const char *path);
159void config_data_store(int type, uint32_t file_max, uint32_t memory_max, uint32_t str_memory_max);
160
161void asl_mark(void);
162void asl_archive(void);
163
164void asl_client_count_increment();
165void asl_client_count_decrement();
166
167int asldebug(const char *, ...);
168int internal_log_message(const char *str);
169
170void send_to_direct_watchers(asl_msg_t *msg);
171
172#if !TARGET_IPHONE_SIMULATOR
173void launchd_callback();
174#endif
175
176int asl_syslog_faciliy_name_to_num(const char *fac);
177const char *asl_syslog_faciliy_num_to_name(int num);
178asl_msg_t *asl_input_parse(const char *in, int len, char *rhost, uint32_t source);
179
180void process_message(asl_msg_t *msg, uint32_t source);
181void asl_out_message(asl_msg_t *msg);
182void bsd_out_message(asl_msg_t *msg);
183int control_set_param(const char *s, bool eval);
184int asl_action_control_set_param(const char *s);
185
186void trigger_aslmanager();
187
188/* notify SPI */
189uint32_t notify_register_plain(const char *name, int *out_token);
190
191#endif /* __DAEMON_H__ */
192