projects / exim.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Reduce delivery process startup time
[exim.git] / src / src / functions.h
... / ...
CommitLineData
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
5/* Copyright (c) University of Cambridge 1995 - 2018 */
6/* See the file NOTICE for conditions of use and distribution. */
7
8
9/* Prototypes for functions that appear in various modules. Gathered together
10to avoid having a lot of tiddly little headers with only a couple of lines in
11them. However, some functions that are used (or not used) by utility programs
12are in in fact in separate headers. */
13#ifndef _FUNCTIONS_H_
14#define _FUNCTIONS_H_
15
16#include <sys/time.h>
17
18
19#ifdef EXIM_PERL
20extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
21 uschar **) WARN_UNUSED_RESULT;
22extern void cleanup_perl(void);
23extern uschar *init_perl(uschar *);
24#endif
25
26
27#ifndef DISABLE_TLS
28extern const char *
29 std_dh_prime_default(void);
30extern const char *
31 std_dh_prime_named(const uschar *);
32
33extern uschar * tls_cert_crl_uri(void *, uschar * mod);
34extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
35extern uschar * tls_cert_issuer(void *, uschar * mod);
36extern uschar * tls_cert_not_before(void *, uschar * mod);
37extern uschar * tls_cert_not_after(void *, uschar * mod);
38extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
39extern uschar * tls_cert_serial_number(void *, uschar * mod);
40extern uschar * tls_cert_signature(void *, uschar * mod);
41extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
42extern uschar * tls_cert_subject(void *, uschar * mod);
43extern uschar * tls_cert_subject_altname(void *, uschar * mod);
44extern uschar * tls_cert_version(void *, uschar * mod);
45
46extern uschar * tls_cert_der_b64(void * cert);
47extern uschar * tls_cert_fprt_md5(void *);
48extern uschar * tls_cert_fprt_sha1(void *);
49extern uschar * tls_cert_fprt_sha256(void *);
50
51extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *,
52 void *, tls_support *, uschar **);
53
54extern void tls_close(void *, int);
55extern BOOL tls_could_read(void);
56extern void tls_daemon_init(void);
57extern BOOL tls_dropprivs_validate_require_cipher(BOOL);
58extern BOOL tls_export_cert(uschar *, size_t, void *);
59extern int tls_feof(void);
60extern int tls_ferror(void);
61extern void tls_free_cert(void **);
62extern int tls_getc(unsigned);
63extern uschar *tls_getbuf(unsigned *);
64extern void tls_get_cache(void);
65extern BOOL tls_import_cert(const uschar *, void **);
66extern int tls_read(void *, uschar *, size_t);
67extern int tls_server_start(const uschar *, uschar **);
68extern BOOL tls_smtp_buffered(void);
69extern int tls_ungetc(int);
70extern int tls_write(void *, const uschar *, size_t, BOOL);
71extern uschar *tls_validate_require_cipher(void);
72extern void tls_version_report(FILE *);
73# ifdef USE_OPENSSL
74extern BOOL tls_openssl_options_parse(uschar *, long *);
75# endif
76extern uschar * tls_field_from_dn(uschar *, const uschar *);
77extern BOOL tls_is_name_for_cert(const uschar *, void *);
78
79# ifdef SUPPORT_DANE
80extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
81# endif
82
83#endif /*DISABLE_TLS*/
84
85
86/* Everything else... */
87
88extern acl_block *acl_read(uschar *(*)(void), uschar **);
89extern int acl_check(int, uschar *, uschar *, uschar **, uschar **);
90extern int acl_eval(int, uschar *, uschar **, uschar **);
91
92extern tree_node *acl_var_create(uschar *);
93extern void acl_var_write(uschar *, uschar *, void *);
94
95#ifdef EXPERIMENTAL_ARC
96extern void *arc_ams_setup_sign_bodyhash(void);
97extern const uschar *arc_header_feed(gstring *, BOOL);
98extern gstring *arc_sign(const uschar *, gstring *, uschar **);
99extern void arc_sign_init(void);
100extern const uschar *acl_verify_arc(void);
101extern uschar * fn_arc_domains(void);
102#endif
103
104extern void assert_no_variables(void *, int, const char *, int);
105extern int auth_call_pam(const uschar *, uschar **);
106extern int auth_call_pwcheck(uschar *, uschar **);
107extern int auth_call_radius(const uschar *, uschar **);
108extern int auth_call_saslauthd(const uschar *, const uschar *,
109 const uschar *, const uschar *, uschar **);
110extern int auth_check_serv_cond(auth_instance *);
111extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
112extern int auth_client_item(void *, auth_instance *, const uschar **,
113 unsigned, int, uschar *, int);
114
115
116extern int auth_get_data(uschar **, const uschar *, int);
117extern int auth_get_no64_data(uschar **, uschar *);
118extern int auth_prompt(const uschar *);
119extern int auth_read_input(const uschar *);
120extern void auth_show_supported(FILE *);
121extern uschar *auth_xtextencode(uschar *, int);
122extern int auth_xtextdecode(uschar *, uschar **);
123
124#ifdef EXPERIMENTAL_ARC
125extern gstring *authres_arc(gstring *);
126#endif
127#ifndef DISABLE_DKIM
128extern gstring *authres_dkim(gstring *);
129#endif
130#ifdef SUPPORT_DMARC
131extern gstring *authres_dmarc(gstring *);
132#endif
133extern gstring *authres_smtpauth(gstring *);
134#ifdef SUPPORT_SPF
135extern gstring *authres_spf(gstring *);
136#endif
137
138extern uschar *b64encode(const uschar *, int);
139extern int b64decode(const uschar *, uschar **);
140extern int bdat_getc(unsigned);
141extern uschar *bdat_getbuf(unsigned *);
142extern int bdat_ungetc(int);
143extern void bdat_flush_data(void);
144
145extern void bits_clear(unsigned int *, size_t, int *);
146extern void bits_set(unsigned int *, size_t, int *);
147
148extern void cancel_cutthrough_connection(BOOL, const uschar *);
149extern int check_host(void *, const uschar *, const uschar **, uschar **);
150extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
151extern pid_t child_open_uid(const uschar **, const uschar **, int,
152 uid_t *, gid_t *, int *, int *, uschar *, BOOL);
153extern BOOL cleanup_environment(void);
154extern void cutthrough_data_puts(uschar *, int);
155extern void cutthrough_data_put_nl(void);
156extern uschar *cutthrough_finaldot(void);
157extern BOOL cutthrough_flush_send(void);
158extern BOOL cutthrough_headers_send(void);
159extern BOOL cutthrough_predata(void);
160extern void release_cutthrough_connection(const uschar *);
161
162extern void daemon_go(void);
163
164#ifdef EXPERIMENTAL_DCC
165extern int dcc_process(uschar **);
166#endif
167
168extern void debug_logging_activate(uschar *, uschar *);
169extern void debug_logging_stop(void);
170extern void debug_print_argv(const uschar **);
171extern void debug_print_ids(uschar *);
172extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
173extern void debug_print_string(uschar *);
174extern void debug_print_tree(tree_node *);
175extern void debug_vprintf(int, const char *, va_list);
176extern void decode_bits(unsigned int *, size_t, int *,
177 uschar *, bit_table *, int, uschar *, int);
178extern address_item *deliver_make_addr(uschar *, BOOL);
179extern void delivery_log(int, address_item *, int, uschar *);
180extern int deliver_message(uschar *, BOOL, BOOL);
181extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
182extern void deliver_set_expansions(address_item *);
183extern int deliver_split_address(address_item *);
184extern void deliver_succeeded(address_item *);
185
186extern uschar *deliver_get_sender_address (uschar *id);
187extern void delivery_re_exec(int);
188
189extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
190#ifndef DISABLE_DKIM
191extern uschar *dkim_exim_query_dns_txt(const uschar *);
192extern void dkim_exim_sign_init(void);
193
194extern BOOL dkim_transport_write_message(transport_ctx *,
195 struct ob_dkim *, const uschar ** errstr);
196#endif
197extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
198extern int dns_basic_lookup(dns_answer *, const uschar *, int);
199extern void dns_build_reverse(const uschar *, uschar *);
200extern time_t dns_expire_from_soa(dns_answer *);
201extern void dns_init(BOOL, BOOL, BOOL);
202extern BOOL dns_is_aa(const dns_answer *);
203extern BOOL dns_is_secure(const dns_answer *);
204extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
205extern void dns_pattern_init(void);
206extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
207extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
208extern uschar *dns_text_type(int);
209extern void dscp_list_to_stream(FILE *);
210extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
211
212extern void enq_end(uschar *);
213extern BOOL enq_start(uschar *, unsigned);
214#ifndef DISABLE_EVENT
215extern uschar *event_raise(uschar *, const uschar *, uschar *);
216extern void msg_event_raise(const uschar *, const address_item *);
217#endif
218
219extern int exim_chown_failure(int, const uschar*, uid_t, gid_t);
220extern const uschar * exim_errstr(int);
221extern void exim_exit(int, const uschar *) NORETURN;
222extern void exim_nullstd(void);
223extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
224extern void exim_underbar_exit(int);
225extern void exim_wait_tick(struct timeval *, int);
226extern int exp_bool(address_item *addr,
227 uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
228 uschar *svalue, BOOL *rvalue);
229extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
230extern uschar *expand_file_big_buffer(const uschar *);
231extern uschar *expand_string(uschar *); /* public, cannot make const */
232extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
233extern uschar *expand_hide_passwords(uschar * );
234extern uschar *expand_string_copy(const uschar *);
235extern int_eximarith_t expand_string_integer(uschar *, BOOL);
236extern void modify_variable(uschar *, void *);
237
238extern BOOL fd_ready(int, time_t);
239
240extern int filter_interpret(uschar *, int, address_item **, uschar **);
241extern BOOL filter_personal(string_item *, BOOL);
242extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
243extern BOOL filter_system_interpret(address_item **, uschar **);
244
245extern uschar * fn_hdrs_added(void);
246
247extern void header_add(int, const char *, ...);
248extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
249extern int header_checkname(header_line *, BOOL);
250extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
251extern int host_address_extract_port(uschar *);
252extern uschar *host_and_ident(BOOL);
253extern int host_aton(const uschar *, int *);
254extern void host_build_hostlist(host_item **, const uschar *, BOOL);
255extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
256extern void host_build_log_info(void);
257extern void host_build_sender_fullhost(void);
258extern int host_find_byname(host_item *, const uschar *, int,
259 const uschar **, BOOL);
260extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
261 uschar *, const dnssec_domains *, const uschar **, BOOL *);
262extern ip_address_item *host_find_interfaces(void);
263extern BOOL host_is_in_net(const uschar *, const uschar *, int);
264extern BOOL host_is_tls_on_connect_port(int);
265extern int host_item_get_port(host_item *);
266extern void host_mask(int, int *, int);
267extern int host_name_lookup(void);
268extern int host_nmtoa(int, int *, int, uschar *, int);
269extern uschar *host_ntoa(int, const void *, uschar *, int *);
270extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
271
272extern uschar *imap_utf7_encode(uschar *, const uschar *,
273 uschar, uschar *, uschar **);
274
275extern void invert_address(uschar *, uschar *);
276extern int ip_addr(void *, int, const uschar *, int);
277extern int ip_bind(int, int, uschar *, int);
278extern int ip_connect(int, int, const uschar *, int, int, const blob *);
279extern int ip_connectedsocket(int, const uschar *, int, int,
280 int, host_item *, uschar **, const blob *);
281extern int ip_get_address_family(int);
282extern void ip_keepalive(int, const uschar *, BOOL);
283extern int ip_recv(client_conn_ctx *, uschar *, int, time_t);
284extern int ip_socket(int, int);
285
286extern int ip_tcpsocket(const uschar *, uschar **, int);
287extern int ip_unixsocket(const uschar *, uschar **);
288extern int ip_streamsocket(const uschar *, uschar **, int);
289
290extern int ipv6_nmtoa(int *, uschar *);
291
292extern uschar *local_part_quote(uschar *);
293extern int log_create(uschar *);
294extern int log_create_as_exim(uschar *);
295extern void log_close_all(void);
296
297extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
298extern BOOL macro_read_assignment(uschar *);
299extern uschar *macros_expand(int, int *, BOOL *);
300extern void mainlog_close(void);
301#ifdef WITH_CONTENT_SCAN
302extern int malware(const uschar *, int);
303extern int malware_in_file(uschar *);
304extern void malware_init(void);
305extern void malware_show_supported(FILE *);
306#endif
307extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
308 unsigned int *, int, int, const uschar **);
309extern int match_address_list_basic(const uschar *, const uschar **, int);
310extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
311 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
312 const uschar *, const uschar **);
313extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
314 unsigned int *, int, BOOL, const uschar **);
315extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
316 const uschar **);
317extern void md5_end(md5 *, const uschar *, int, uschar *);
318extern void md5_mid(md5 *, const uschar *);
319extern void md5_start(md5 *);
320extern void millisleep(int);
321#ifdef WITH_CONTENT_SCAN
322struct mime_boundary_context;
323extern int mime_acl_check(uschar *acl, FILE *f,
324 struct mime_boundary_context *, uschar **, uschar **);
325extern int mime_decode(const uschar **);
326extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
327extern int mime_regex(const uschar **);
328extern void mime_set_anomaly(int);
329#endif
330extern uschar *moan_check_errorcopy(uschar *);
331extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
332 BOOL, uschar *);
333extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
334extern BOOL moan_send_message(uschar *, int, error_block *eblock,
335 header_line *, FILE *, uschar *);
336extern void moan_tell_someone(uschar *, address_item *,
337 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
338extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
339extern void moan_write_from(FILE *);
340extern void moan_write_references(FILE *, uschar *);
341extern FILE *modefopen(const uschar *, const char *, mode_t);
342
343extern int open_cutthrough_connection( address_item * addr );
344
345extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
346 BOOL);
347extern int parse_forward_list(uschar *, int, address_item **, uschar **,
348 const uschar *, uschar *, error_block **);
349extern uschar *parse_find_address_end(uschar *, BOOL);
350extern uschar *parse_find_at(uschar *);
351extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
352extern uschar *parse_message_id(uschar *, uschar **, uschar **);
353extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
354extern uschar *parse_date_time(uschar *str, time_t *t);
355extern int vaguely_random_number(int);
356#ifndef DISABLE_TLS
357extern int vaguely_random_number_fallback(int);
358#endif
359
360extern BOOL queue_action(uschar *, int, uschar **, int, int);
361extern void queue_check_only(void);
362extern void queue_list(int, uschar **, int);
363extern void queue_count(void);
364extern void queue_run(uschar *, uschar *, BOOL);
365
366extern int random_number(int);
367extern const uschar *rc_to_string(int);
368extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
369 uschar *, uschar *, uschar *, ugid_block *, address_item **,
370 uschar **, error_block **, int *, uschar *);
371extern int rda_is_filter(const uschar *);
372extern BOOL readconf_depends(driver_instance *, uschar *);
373extern void readconf_driver_init(uschar *, driver_instance **,
374 driver_info *, int, void *, int, optionlist *, int);
375extern uschar *readconf_find_option(void *);
376extern void readconf_main(BOOL);
377extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
378extern BOOL readconf_print(uschar *, uschar *, BOOL);
379extern uschar *readconf_printtime(int);
380extern uschar *readconf_readname(uschar *, int, uschar *);
381extern int readconf_readtime(const uschar *, int, BOOL);
382extern void readconf_rest(void);
383extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
384extern void readconf_save_config(const uschar *);
385extern void read_message_body(BOOL);
386extern void receive_bomb_out(uschar *, uschar *) NORETURN;
387extern BOOL receive_check_fs(int);
388extern BOOL receive_check_set_sender(uschar *);
389extern BOOL receive_msg(BOOL);
390extern int_eximarith_t receive_statvfs(BOOL, int *);
391extern void receive_swallow_smtp(void);
392#ifdef WITH_CONTENT_SCAN
393extern int regex(const uschar **);
394#endif
395extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
396extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
397extern void retry_add_item(address_item *, uschar *, int);
398extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
399 uschar **, uschar **);
400extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
401extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
402 dbdata_retry *, time_t);
403extern void retry_update(address_item **, address_item **, address_item **);
404extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
405extern uschar *rewrite_address_qualify(uschar *, BOOL);
406extern header_line *rewrite_header(header_line *,
407 const uschar *, const uschar *,
408 rewrite_rule *, int, BOOL);
409extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
410 rewrite_rule *);
411extern void rewrite_test(uschar *);
412extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
413 uschar **);
414extern int route_address(address_item *, address_item **, address_item **,
415 address_item **, address_item **, int);
416extern int route_check_prefix(const uschar *, const uschar *);
417extern int route_check_suffix(const uschar *, const uschar *);
418extern BOOL route_findgroup(uschar *, gid_t *);
419extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
420extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
421 uschar **);
422extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
423 struct passwd **, uid_t *, uschar **);
424extern void route_init(void);
425extern void route_show_supported(FILE *);
426extern void route_tidyup(void);
427
428extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
429 int, int *);
430extern int search_findtype(const uschar *, int);
431extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
432 int *);
433extern void *search_open(uschar *, int, int, uid_t *, gid_t *);
434extern void search_tidyup(void);
435extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
436extern void sha1_end(hctx *, const uschar *, int, uschar *);
437extern void sha1_mid(hctx *, const uschar *);
438extern void sha1_start(hctx *);
439extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
440 uschar *, address_item **, uschar **);
441extern void sigalrm_handler(int);
442extern BOOL smtp_buffered(void);
443extern void smtp_closedown(uschar *);
444extern void smtp_command_timeout_exit(void) NORETURN;
445extern void smtp_command_sigterm_exit(void) NORETURN;
446extern void smtp_data_timeout_exit(void) NORETURN;
447extern void smtp_data_sigint_exit(void) NORETURN;
448extern void smtp_deliver_init(void);
449extern uschar *smtp_cmd_hist(void);
450extern int smtp_connect(smtp_connect_args *, const blob *);
451extern int smtp_sock_connect(host_item *, int, int, uschar *,
452 transport_instance * tb, int, const blob *);
453extern int smtp_feof(void);
454extern int smtp_ferror(void);
455extern uschar *smtp_get_connection_info(void);
456extern BOOL smtp_get_interface(uschar *, int, address_item *,
457 uschar **, uschar *);
458extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
459extern int smtp_getc(unsigned);
460extern uschar *smtp_getbuf(unsigned *);
461extern void smtp_get_cache(void);
462extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
463extern void smtp_log_no_mail(void);
464extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
465extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
466extern BOOL smtp_read_response(void *, uschar *, int, int, int);
467extern void *smtp_reset(void *);
468extern void smtp_respond(uschar *, int, BOOL, uschar *);
469extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
470extern void smtp_port_for_connect(host_item *, int);
471extern void smtp_send_prohibition_message(int, uschar *);
472extern int smtp_setup_msg(void);
473extern BOOL smtp_start_session(void);
474extern int smtp_ungetc(int);
475extern BOOL smtp_verify_helo(void);
476extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
477#ifdef WITH_CONTENT_SCAN
478extern int spam(const uschar **);
479extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
480#endif
481extern void spool_clear_header_globals(void);
482extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
483extern int spool_open_datafile(uschar *);
484extern int spool_open_temp(uschar *);
485extern int spool_read_header(uschar *, BOOL, BOOL);
486extern int spool_write_header(uschar *, int, uschar **);
487extern int stdin_getc(unsigned);
488extern int stdin_feof(void);
489extern int stdin_ferror(void);
490extern int stdin_ungetc(int);
491
492extern void store_exit(void);
493extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
494extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
495extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
496extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
497extern uschar *string_base62(unsigned long int);
498extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
499extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
500extern int string_compare_by_pointer(const void *, const void *);
501extern uschar *string_copy_dnsdomain(uschar *);
502extern uschar *string_copy_malloc(const uschar *);
503extern uschar *string_dequote(const uschar **);
504extern uschar *string_format_size(int, uschar *);
505extern int string_interpret_escape(const uschar **);
506extern int string_is_ip_address(const uschar *, int *);
507#ifdef SUPPORT_I18N
508extern BOOL string_is_utf8(const uschar *);
509#endif
510extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
511extern const uschar *string_printing2(const uschar *, BOOL);
512extern uschar *string_split_message(uschar *);
513extern uschar *string_unprinting(uschar *);
514#ifdef SUPPORT_I18N
515extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
516extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
517extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
518extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
519extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
520#endif
521
522#define string_format(buf, siz, fmt, ...) \
523 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
524extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned,
525 const char *, ...) ALMOST_PRINTF(5,6);
526
527#define string_vformat(g, flgs, fmt, ap) \
528 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
529 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
530extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
531 unsigned, unsigned, const char *, va_list);
532
533#define string_open_failed(eno, fmt, ...) \
534 string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
535extern uschar *string_open_failed_trc(int, const uschar *, unsigned,
536 const char *, ...) PRINTF_FUNCTION(4,5);
537
538extern int strcmpic(const uschar *, const uschar *);
539extern int strncmpic(const uschar *, const uschar *, int);
540extern uschar *strstric(uschar *, uschar *, BOOL);
541
542extern void tcp_init(void);
543#ifdef EXIM_TFO_PROBE
544extern void tfo_probe(void);
545#endif
546extern void tls_modify_variables(tls_support *);
547extern uschar *tod_stamp(int);
548
549extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
550 BOOL *, oicf, void*);
551extern void transport_init(void);
552extern void transport_do_pass_socket(const uschar *, const uschar *,
553 const uschar *, uschar *, int);
554extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
555 int);
556extern uschar *transport_rcpt_address(address_item *, BOOL);
557extern BOOL transport_set_up_command(const uschar ***, uschar *,
558 BOOL, int, address_item *, uschar *, uschar **);
559extern void transport_update_waiting(host_item *, uschar *);
560extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
561extern void transport_write_reset(int);
562extern BOOL transport_write_string(int, const char *, ...);
563extern BOOL transport_headers_send(transport_ctx *,
564 BOOL (*)(transport_ctx *, uschar *, int));
565extern void transport_show_supported(FILE *);
566extern BOOL transport_write_message(transport_ctx *, int);
567extern void tree_add_duplicate(uschar *, address_item *);
568extern void tree_add_nonrecipient(uschar *);
569extern void tree_add_unusable(host_item *);
570extern void tree_dup(tree_node **, tree_node *);
571extern int tree_insertnode(tree_node **, tree_node *);
572extern tree_node *tree_search(tree_node *, const uschar *);
573extern void tree_write(tree_node *, FILE *);
574extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
575
576#ifdef WITH_CONTENT_SCAN
577extern void unspool_mbox(void);
578#endif
579#ifdef SUPPORT_I18N
580extern void utf8_version_report(FILE *);
581#endif
582
583extern int verify_address(address_item *, FILE *, int, int, int, int,
584 uschar *, uschar *, BOOL *);
585extern int verify_check_dnsbl(int, const uschar **, uschar **);
586extern int verify_check_header_address(uschar **, uschar **, int, int, int,
587 uschar *, uschar *, int, int *);
588extern int verify_check_headers(uschar **);
589extern int verify_check_header_names_ascii(uschar **);
590extern int verify_check_host(uschar **);
591extern int verify_check_notblind(BOOL);
592extern int verify_check_given_host(const uschar **, const host_item *);
593extern int verify_check_this_host(const uschar **, unsigned int *,
594 const uschar*, const uschar *, const uschar **);
595extern address_item *verify_checked_sender(uschar *);
596extern void verify_get_ident(int);
597extern BOOL verify_sender(int *, uschar **);
598extern BOOL verify_sender_preliminary(int *, uschar **);
599extern void version_init(void);
600
601extern BOOL write_chunk(transport_ctx *, uschar *, int);
602extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
603
604
605#if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
606/* exim_chown - in some NFSv4 setups *seemes* to be an issue with
607chown(<exim-uid>, <exim-gid>).
608
609Probably because the idmapping is broken, misconfigured or set up in
610an unusal way. (see Bug 2931). As I'm not sure, if this was a single
611case of misconfiguration, or if there are more such broken systems
612out, I try to impose as least impact as possible and for now just write
613a panic log entry pointing to the bug report. You're encouraged to
614contact the developers, if you experience this issue.
615
616fd the file descriptor (or -1 if not valid)
617name the file name for error messages or for file operations,
618 if fd is < 0
619owner the owner
620group the group
621
622returns 0 on success, -1 on failure */
623
624static inline int
625exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
626{
627return fchown(fd, owner, group)
628 ? exim_chown_failure(fd, name, owner, group) : 0;
629}
630
631static inline int
632exim_chown(const uschar *name, uid_t owner, gid_t group)
633{
634return chown(CCS name, owner, group)
635 ? exim_chown_failure(-1, name, owner, group) : 0;
636}
637
638#endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
639/******************************************************************************/
640/* String functions */
641
642#if !defined(MACRO_PREDEF)
643/*************************************************
644* Copy and save string *
645*************************************************/
646
647/* This function assumes that memcpy() is faster than strcpy().
648*/
649
650static inline uschar *
651string_copy_taint_trc(const uschar *s, BOOL tainted, const char * func, int line)
652{
653int len = Ustrlen(s) + 1;
654uschar *ss = store_get_3(len, tainted, func, line);
655memcpy(ss, s, len);
656return ss;
657}
658
659#define string_copy_taint(s, tainted) \
660 string_copy_taint_trc((s), tainted, __FUNCTION__, __LINE__)
661
662static inline uschar *
663string_copy(const uschar * s)
664{
665return string_copy_taint((s), is_tainted(s));
666}
667
668
669/*************************************************
670* Copy, lowercase and save string *
671*************************************************/
672
673/*
674Argument: string to copy
675Returns: copy of string in new store, with letters lowercased
676*/
677
678static inline uschar *
679string_copylc(const uschar *s)
680{
681uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
682uschar *p = ss;
683while (*s != 0) *p++ = tolower(*s++);
684*p = 0;
685return ss;
686}
687
688
689
690/*************************************************
691* Copy and save string, given length *
692*************************************************/
693
694/* It is assumed the data contains no zeros. A zero is added
695onto the end.
696
697Arguments:
698 s string to copy
699 n number of characters
700
701Returns: copy of string in new store
702
703This is an API for local_scan hence not static.
704*/
705
706static inline uschar *
707string_copyn(const uschar *s, int n)
708{
709uschar *ss = store_get(n + 1, is_tainted(s));
710Ustrncpy(ss, s, n);
711ss[n] = 0;
712return ss;
713}
714
715/*************************************************
716* Copy, lowercase, and save string, given length *
717*************************************************/
718
719/* It is assumed the data contains no zeros. A zero is added
720onto the end.
721
722Arguments:
723 s string to copy
724 n number of characters
725
726Returns: copy of string in new store, with letters lowercased
727*/
728
729static inline uschar *
730string_copynlc(uschar *s, int n)
731{
732uschar *ss = store_get(n + 1, is_tainted(s));
733uschar *p = ss;
734while (n-- > 0) *p++ = tolower(*s++);
735*p = 0;
736return ss;
737}
738
739
740# ifndef COMPILE_UTILITY
741/*************************************************
742* Copy and save string in longterm store *
743*************************************************/
744
745/* This function assumes that memcpy() is faster than strcpy().
746
747Argument: string to copy
748Returns: copy of string in new store
749*/
750
751static inline uschar *
752string_copy_perm(const uschar *s, BOOL force_taint)
753{
754int old_pool = store_pool;
755int len = Ustrlen(s) + 1;
756uschar *ss;
757
758store_pool = POOL_PERM;
759ss = store_get(len, force_taint || is_tainted(s));
760memcpy(ss, s, len);
761store_pool = old_pool;
762return ss;
763}
764# endif
765
766
767
768/* sprintf into a buffer, taint-unchecked */
769
770static inline void
771string_format_nt(uschar * buf, int siz, const char * fmt, ...)
772{
773gstring gs = { .size = siz, .ptr = 0, .s = buf };
774va_list ap;
775va_start(ap, fmt);
776(void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
777va_end(ap);
778}
779
780
781
782/******************************************************************************/
783/* Growable-string functions */
784
785/* Create a growable-string with some preassigned space */
786
787#define string_get_tainted(size, tainted) \
788 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
789
790static inline gstring *
791string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
792{
793gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
794g->size = size;
795g->ptr = 0;
796g->s = US(g + 1);
797return g;
798}
799
800#define string_get(size) \
801 string_get_trc((size), __FUNCTION__, __LINE__)
802
803static inline gstring *
804string_get_trc(unsigned size, const char * func, unsigned line)
805{
806return string_get_tainted_trc(size, FALSE, func, line);
807}
808
809/* NUL-terminate the C string in the growable-string, and return it. */
810
811static inline uschar *
812string_from_gstring(gstring * g)
813{
814if (!g) return NULL;
815g->s[g->ptr] = '\0';
816return g->s;
817}
818
819
820#define gstring_release_unused(g) \
821 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
822
823static inline void
824gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
825{
826if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
827}
828
829
830/* sprintf-append to a growable-string */
831
832#define string_fmt_append(g, fmt, ...) \
833 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
834 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
835
836#define string_fmt_append_f(g, flgs, fmt, ...) \
837 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
838 flgs, fmt, __VA_ARGS__)
839
840static inline gstring *
841string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
842 unsigned flags, const char *format, ...)
843{
844va_list ap;
845va_start(ap, format);
846g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
847 flags, format, ap);
848va_end(ap);
849return g;
850}
851
852/******************************************************************************/
853
854#define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
855
856static inline dns_answer *
857store_get_dns_answer_trc(const uschar * func, unsigned line)
858{
859return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); /* use tainted mem */
860}
861
862/******************************************************************************/
863/* Routines with knowledge of spool layout */
864
865# ifndef COMPILE_UTILITY
866static inline void
867spool_pname_buf(uschar * buf, int len)
868{
869snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
870}
871
872static inline uschar *
873spool_dname(const uschar * purpose, uschar * subdir)
874{
875return string_sprintf("%s/%s/%s/%s",
876 spool_directory, queue_name, purpose, subdir);
877}
878# endif
879
880static inline uschar *
881spool_sname(const uschar * purpose, uschar * subdir)
882{
883return string_sprintf("%s%s%s%s%s",
884 queue_name, *queue_name ? "/" : "",
885 purpose,
886 *subdir ? "/" : "", subdir);
887}
888
889static inline uschar *
890spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
891 const uschar * suffix)
892{
893return string_sprintf("%s/%s/%s/%s/%s%s",
894 spool_directory, queue_name, purpose, subdir, fname, suffix);
895}
896
897static inline void
898set_subdir_str(uschar * subdir_str, const uschar * name,
899 int search_sequence)
900{
901subdir_str[0] = split_spool_directory == (search_sequence == 0)
902 ? name[5] : '\0';
903subdir_str[1] = '\0';
904}
905
906/******************************************************************************/
907static inline void
908timesince(struct timeval * diff, struct timeval * then)
909{
910gettimeofday(diff, NULL);
911diff->tv_sec -= then->tv_sec;
912if ((diff->tv_usec -= then->tv_usec) < 0)
913 {
914 diff->tv_sec--;
915 diff->tv_usec += 1000*1000;
916 }
917}
918
919static inline uschar *
920string_timediff(struct timeval * diff)
921{
922static uschar buf[sizeof("0.000s")];
923
924if (diff->tv_sec >= 5 || !LOGGING(millisec))
925 return readconf_printtime((int)diff->tv_sec);
926
927sprintf(CS buf, "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
928return buf;
929}
930
931
932static inline uschar *
933string_timesince(struct timeval * then)
934{
935struct timeval diff;
936timesince(&diff, then);
937return string_timediff(&diff);
938}
939
940static inline void
941report_time_since(struct timeval * t0, uschar * where)
942{
943# ifdef MEASURE_TIMING
944struct timeval diff;
945timesince(&diff, t0);
946fprintf(stderr, "%d %s:\t%ld.%06ld\n",
947 (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
948# endif
949}
950
951
952static inline void
953testharness_pause_ms(int millisec)
954{
955#ifndef MEASURE_TIMING
956if (f.running_in_test_harness) millisleep(millisec);
957#endif
958}
959
960#endif /* !MACRO_PREDEF */
961
962#endif /* _FUNCTIONS_H_ */
963
964/* vi: aw
965*/
966/* End of functions.h */
Unnamed repository; edit this file 'description' to name the repository.