Copyright updates:
[exim.git] / src / src / functions.h
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
f9ba5e22 5/* Copyright (c) University of Cambridge 1995 - 2018 */
1e1ddfac 6/* Copyright (c) The Exim Maintainers 2020 */
059ec3d9
PH
7/* See the file NOTICE for conditions of use and distribution. */
8
9
10/* Prototypes for functions that appear in various modules. Gathered together
11to avoid having a lot of tiddly little headers with only a couple of lines in
12them. However, some functions that are used (or not used) by utility programs
13are in in fact in separate headers. */
b66fecb4
HSHR
14#ifndef _FUNCTIONS_H_
15#define _FUNCTIONS_H_
059ec3d9 16
137ae145 17#include <ctype.h>
9f01e50d
JH
18#include <sys/time.h>
19
059ec3d9
PH
20
21#ifdef EXIM_PERL
acec9514 22extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
268d00ff 23 uschar **) WARN_UNUSED_RESULT;
059ec3d9
PH
24extern void cleanup_perl(void);
25extern uschar *init_perl(uschar *);
26#endif
27
28
01603eec 29#ifndef DISABLE_TLS
a799883d
PP
30extern const char *
31 std_dh_prime_default(void);
32extern const char *
33 std_dh_prime_named(const uschar *);
9d1c15ef 34
9e4dddbd 35extern uschar * tls_cert_crl_uri(void *, uschar * mod);
9d1c15ef 36extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
9e4dddbd
JH
37extern uschar * tls_cert_issuer(void *, uschar * mod);
38extern uschar * tls_cert_not_before(void *, uschar * mod);
39extern uschar * tls_cert_not_after(void *, uschar * mod);
40extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
41extern uschar * tls_cert_serial_number(void *, uschar * mod);
42extern uschar * tls_cert_signature(void *, uschar * mod);
43extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
44extern uschar * tls_cert_subject(void *, uschar * mod);
45extern uschar * tls_cert_subject_altname(void *, uschar * mod);
46extern uschar * tls_cert_version(void *, uschar * mod);
9d1c15ef 47
59b87190 48extern uschar * tls_cert_der_b64(void * cert);
6a8a60e0
JH
49extern uschar * tls_cert_fprt_md5(void *);
50extern uschar * tls_cert_fprt_sha1(void *);
9ef9101c 51extern uschar * tls_cert_fprt_sha256(void *);
6a8a60e0 52
6b5cbf74 53extern void tls_clean_env(void);
c05bdbd6
JH
54extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *,
55 void *, tls_support *, uschar **);
56
74f1a423 57extern void tls_close(void *, int);
925ac8e4 58extern BOOL tls_could_read(void);
b10c87b3 59extern void tls_daemon_init(void);
d85cdeb5 60extern BOOL tls_dropprivs_validate_require_cipher(BOOL);
2944124c 61extern BOOL tls_export_cert(uschar *, size_t, void *);
059ec3d9
PH
62extern int tls_feof(void);
63extern int tls_ferror(void);
790fbb71 64extern void tls_free_cert(void **);
bd8fbe36 65extern int tls_getc(unsigned);
0d81dabc 66extern uschar *tls_getbuf(unsigned *);
584e96c6 67extern void tls_get_cache(void);
b2827658 68extern BOOL tls_import_cert(const uschar *, void **);
74f1a423 69extern int tls_read(void *, uschar *, size_t);
cf0c6164 70extern int tls_server_start(const uschar *, uschar **);
58eb016e 71extern BOOL tls_smtp_buffered(void);
059ec3d9 72extern int tls_ungetc(int);
74f1a423 73extern int tls_write(void *, const uschar *, size_t, BOOL);
3375e053 74extern uschar *tls_validate_require_cipher(void);
36f12725 75extern void tls_version_report(FILE *);
de517fd3 76# ifdef USE_OPENSSL
77bb000f 77extern BOOL tls_openssl_options_parse(uschar *, long *);
e51c7be2 78# endif
55414b25
JH
79extern uschar * tls_field_from_dn(uschar *, const uschar *);
80extern BOOL tls_is_name_for_cert(const uschar *, void *);
0e66b3b6 81
c0635b6d 82# ifdef SUPPORT_DANE
4b0fe319 83extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
0e66b3b6
JH
84# endif
85
01603eec 86#endif /*DISABLE_TLS*/
059ec3d9
PH
87
88
89/* Everything else... */
90
91extern acl_block *acl_read(uschar *(*)(void), uschar **);
92extern int acl_check(int, uschar *, uschar *, uschar **, uschar **);
05caaeaa 93extern int acl_eval(int, uschar *, uschar **, uschar **);
333eea9c 94
38a0a95f
PH
95extern tree_node *acl_var_create(uschar *);
96extern void acl_var_write(uschar *, uschar *, void *);
617d3932
JH
97
98#ifdef EXPERIMENTAL_ARC
99extern void *arc_ams_setup_sign_bodyhash(void);
100extern const uschar *arc_header_feed(gstring *, BOOL);
101extern gstring *arc_sign(const uschar *, gstring *, uschar **);
b3d9ebf5 102extern void arc_sign_init(void);
617d3932 103extern const uschar *acl_verify_arc(void);
9cffa436 104extern uschar * fn_arc_domains(void);
617d3932
JH
105#endif
106
cf0812d5 107extern void assert_no_variables(void *, int, const char *, int);
e1af7642 108extern int auth_call_pam(const uschar *, uschar **);
059ec3d9 109extern int auth_call_pwcheck(uschar *, uschar **);
93a6fce2
JH
110extern int auth_call_radius(const uschar *, uschar **);
111extern int auth_call_saslauthd(const uschar *, const uschar *,
112 const uschar *, const uschar *, uschar **);
16ff981e 113extern int auth_check_serv_cond(auth_instance *);
44bbabb5 114extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
37942ad8
JH
115extern int auth_client_item(void *, auth_instance *, const uschar **,
116 unsigned, int, uschar *, int);
44bbabb5 117
e1d04f48 118
1f20760b 119extern int auth_get_data(uschar **, const uschar *, int);
059ec3d9 120extern int auth_get_no64_data(uschar **, uschar *);
8238bc7b 121extern int auth_prompt(const uschar *);
37942ad8 122extern int auth_read_input(const uschar *);
ab1604ea 123extern gstring * auth_show_supported(gstring *);
059ec3d9
PH
124extern uschar *auth_xtextencode(uschar *, int);
125extern int auth_xtextdecode(uschar *, uschar **);
126
c9cf9ac4
JH
127#ifdef EXPERIMENTAL_ARC
128extern gstring *authres_arc(gstring *);
dfbcb5ac
JH
129#endif
130#ifndef DISABLE_DKIM
131extern gstring *authres_dkim(gstring *);
132#endif
1a2e76e1 133#ifdef SUPPORT_DMARC
c9cf9ac4
JH
134extern gstring *authres_dmarc(gstring *);
135#endif
136extern gstring *authres_smtpauth(gstring *);
137#ifdef SUPPORT_SPF
138extern gstring *authres_spf(gstring *);
617d3932 139#endif
dfbcb5ac 140
1f20760b 141extern uschar *b64encode(const uschar *, int);
b1a32a3c 142extern uschar *b64encode_taint(const uschar *, int, BOOL);
35cf75e9 143extern int b64decode(const uschar *, uschar **);
bd8fbe36 144extern int bdat_getc(unsigned);
0d81dabc 145extern uschar *bdat_getbuf(unsigned *);
f6f4a58d 146extern int bdat_ungetc(int);
1ebe15c3
JH
147extern void bdat_flush_data(void);
148
6c6d6e48
TF
149extern void bits_clear(unsigned int *, size_t, int *);
150extern void bits_set(unsigned int *, size_t, int *);
151
57cc2785 152extern void cancel_cutthrough_connection(BOOL, const uschar *);
1950cf85
JH
153extern gstring *cat_file(FILE *, gstring *, uschar *);
154extern gstring *cat_file_tls(void *, gstring *, uschar *);
55414b25 155extern int check_host(void *, const uschar *, const uschar **, uschar **);
059ec3d9 156extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
8e9fdd63
JH
157extern pid_t child_open_exim_function(int *, const uschar *);
158extern pid_t child_open_exim2_function(int *, uschar *, uschar *,
159 const uschar *);
46d2a5e6
JH
160extern pid_t child_open_function(uschar **, uschar **, int,
161 int *, int *, BOOL, const uschar *);
55414b25 162extern pid_t child_open_uid(const uschar **, const uschar **, int,
eb24befc 163 uid_t *, gid_t *, int *, int *, uschar *, BOOL, const uschar *);
bc3c7bb7 164extern BOOL cleanup_environment(void);
6851a9c5
JH
165extern void cutthrough_data_puts(uschar *, int);
166extern void cutthrough_data_put_nl(void);
e4bdf652
JH
167extern uschar *cutthrough_finaldot(void);
168extern BOOL cutthrough_flush_send(void);
169extern BOOL cutthrough_headers_send(void);
170extern BOOL cutthrough_predata(void);
57cc2785 171extern void release_cutthrough_connection(const uschar *);
059ec3d9
PH
172
173extern void daemon_go(void);
6a8f9482
TK
174
175#ifdef EXPERIMENTAL_DCC
176extern int dcc_process(uschar **);
177#endif
178
ed7f7860 179extern void debug_logging_activate(uschar *, uschar *);
b0d68adc 180extern void debug_logging_stop(void);
55414b25 181extern void debug_print_argv(const uschar **);
059ec3d9 182extern void debug_print_ids(uschar *);
e1d04f48 183extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
059ec3d9
PH
184extern void debug_print_string(uschar *);
185extern void debug_print_tree(tree_node *);
398f9af3 186extern void debug_vprintf(int, const char *, va_list);
6c6d6e48
TF
187extern void decode_bits(unsigned int *, size_t, int *,
188 uschar *, bit_table *, int, uschar *, int);
01446a56 189extern void delete_pid_file(void);
059ec3d9 190extern address_item *deliver_make_addr(uschar *, BOOL);
817d9f57 191extern void delivery_log(int, address_item *, int, uschar *);
059ec3d9 192extern int deliver_message(uschar *, BOOL, BOOL);
e0df1c83 193extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
059ec3d9
PH
194extern void deliver_set_expansions(address_item *);
195extern int deliver_split_address(address_item *);
196extern void deliver_succeeded(address_item *);
a39bd74d
JB
197
198extern uschar *deliver_get_sender_address (uschar *id);
57cc2785 199extern void delivery_re_exec(int);
a39bd74d 200
36eb5d3d 201extern void die_tainted(const uschar *, const uschar *, int);
1ba28e2b 202extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
80a47a2c 203#ifndef DISABLE_DKIM
fc2ba7b9 204extern uschar *dkim_exim_query_dns_txt(const uschar *);
617d3932
JH
205extern void dkim_exim_sign_init(void);
206
42055a33 207extern BOOL dkim_transport_write_message(transport_ctx *,
b9df1829 208 struct ob_dkim *, const uschar ** errstr);
f7572e5a 209#endif
059ec3d9 210extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
476be7e2 211extern int dns_basic_lookup(dns_answer *, const uschar *, int);
152481a0 212extern uschar *dns_build_reverse(const uschar *);
a713f766 213extern time_t dns_expire_from_soa(dns_answer *, int);
8c51eead 214extern void dns_init(BOOL, BOOL, BOOL);
0539a19d 215extern BOOL dns_is_aa(const dns_answer *);
1dc92d5a 216extern BOOL dns_is_secure(const dns_answer *);
55414b25 217extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
476be7e2 218extern void dns_pattern_init(void);
55414b25 219extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
dd708fd7 220extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
059ec3d9 221extern uschar *dns_text_type(int);
36a3ae5f 222extern void dscp_list_to_stream(FILE *);
9e4f5962 223extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
059ec3d9
PH
224
225extern void enq_end(uschar *);
e8ae7214 226extern BOOL enq_start(uschar *, unsigned);
0cbf2b82 227#ifndef DISABLE_EVENT
55414b25 228extern uschar *event_raise(uschar *, const uschar *, uschar *);
5ef5dd52 229extern void msg_event_raise(const uschar *, const address_item *);
774ef2d7 230#endif
b66fecb4
HSHR
231
232extern int exim_chown_failure(int, const uschar*, uid_t, gid_t);
37f3dc43 233extern const uschar * exim_errstr(int);
81022793 234extern void exim_exit(int) NORETURN;
059ec3d9
PH
235extern void exim_nullstd(void);
236extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
81022793 237extern void exim_underbar_exit(int) NORETURN;
059ec3d9 238extern void exim_wait_tick(struct timeval *, int);
9c695f6d
JH
239extern int exp_bool(address_item *addr,
240 uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
241 uschar *svalue, BOOL *rvalue);
059ec3d9 242extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
617d3932 243extern uschar *expand_file_big_buffer(const uschar *);
93a6fce2
JH
244extern uschar *expand_string(uschar *); /* public, cannot make const */
245extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
be24b950
JH
246extern uschar *expand_getkeyed(const uschar *, const uschar *);
247
f42deca9 248extern uschar *expand_hide_passwords(uschar * );
55414b25 249extern uschar *expand_string_copy(const uschar *);
97d17305 250extern int_eximarith_t expand_string_integer(uschar *, BOOL);
d9b2312b 251extern void modify_variable(uschar *, void *);
059ec3d9 252
0a5441fc 253extern BOOL fd_ready(int, time_t);
4e71661f 254
059ec3d9
PH
255extern int filter_interpret(uschar *, int, address_item **, uschar **);
256extern BOOL filter_personal(string_item *, BOOL);
f05da2e8 257extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
059ec3d9
PH
258extern BOOL filter_system_interpret(address_item **, uschar **);
259
362145b5
JH
260extern uschar * fn_hdrs_added(void);
261
1ba28e2b 262extern void header_add(int, const char *, ...);
049782c0 263extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
059ec3d9
PH
264extern int header_checkname(header_line *, BOOL);
265extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
7cd1141b 266extern int host_address_extract_port(uschar *);
059ec3d9 267extern uschar *host_and_ident(BOOL);
55414b25
JH
268extern int host_aton(const uschar *, int *);
269extern void host_build_hostlist(host_item **, const uschar *, BOOL);
270extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
059ec3d9
PH
271extern void host_build_log_info(void);
272extern void host_build_sender_fullhost(void);
a207d5dd 273extern int host_find_byname(host_item *, const uschar *, int,
1f155f8e 274 const uschar **, BOOL);
55414b25 275extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
7cd171b7 276 uschar *, const dnssec_domains *, const uschar **, BOOL *);
059ec3d9 277extern ip_address_item *host_find_interfaces(void);
55414b25 278extern BOOL host_is_in_net(const uschar *, const uschar *, int);
059ec3d9 279extern BOOL host_is_tls_on_connect_port(int);
7cd1141b 280extern int host_item_get_port(host_item *);
059ec3d9
PH
281extern void host_mask(int, int *, int);
282extern int host_name_lookup(void);
6f0c9a4f 283extern int host_nmtoa(int, int *, int, uschar *, int);
059ec3d9
PH
284extern uschar *host_ntoa(int, const void *, uschar *, int *);
285extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
286
94431adb 287extern uschar *imap_utf7_encode(uschar *, const uschar *,
ed0512a1
JH
288 uschar, uschar *, uschar **);
289
83e029d5 290extern void invert_address(uschar *, uschar *);
7eb6c37c 291extern int ip_addr(void *, int, const uschar *, int);
059ec3d9 292extern int ip_bind(int, int, uschar *, int);
0ab63f3d 293extern int ip_connect(int, int, const uschar *, int, int, const blob *);
b1f8e4f8 294extern int ip_connectedsocket(int, const uschar *, int, int,
4a5cbaff 295 int, host_item *, uschar **, const blob *);
13363eba 296extern int ip_get_address_family(int);
55414b25 297extern void ip_keepalive(int, const uschar *, BOOL);
0a5441fc 298extern int ip_recv(client_conn_ctx *, uschar *, int, time_t);
059ec3d9
PH
299extern int ip_socket(int, int);
300
7d2f2d36 301extern int ip_tcpsocket(const uschar *, uschar **, int, host_item *);
3e60dd41 302extern int ip_unixsocket(const uschar *, uschar **);
7d2f2d36 303extern int ip_streamsocket(const uschar *, uschar **, int, host_item *);
3e60dd41 304
fc4a7f70
JH
305extern int ipv6_nmtoa(int *, uschar *);
306
921b12ca 307extern uschar *local_part_quote(uschar *);
4840604e 308extern int log_create(uschar *);
921b12ca 309extern int log_create_as_exim(uschar *);
059ec3d9
PH
310extern void log_close_all(void);
311
d185889f 312extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
c246a1de
JH
313extern BOOL macro_read_assignment(uschar *);
314extern uschar *macros_expand(int, int *, BOOL *);
9cd319d9 315extern void mainlog_close(void);
8523533c 316#ifdef WITH_CONTENT_SCAN
0f0c8159 317extern int malware(const uschar *, int);
dbc4b90d 318extern int malware_in_file(uschar *);
476be7e2 319extern void malware_init(void);
ab1604ea 320extern gstring * malware_show_supported(gstring *);
8523533c 321#endif
55414b25
JH
322extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
323 unsigned int *, int, int, const uschar **);
36d295f1 324extern int match_address_list_basic(const uschar *, const uschar **, int);
55414b25
JH
325extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
326 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
327 const uschar *, const uschar **);
328extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
329 unsigned int *, int, BOOL, const uschar **);
330extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
331 const uschar **);
059ec3d9
PH
332extern void md5_end(md5 *, const uschar *, int, uschar *);
333extern void md5_mid(md5 *, const uschar *);
334extern void md5_start(md5 *);
335extern void millisleep(int);
8523533c
TK
336#ifdef WITH_CONTENT_SCAN
337struct mime_boundary_context;
54cdb463
PH
338extern int mime_acl_check(uschar *acl, FILE *f,
339 struct mime_boundary_context *, uschar **, uschar **);
55414b25 340extern int mime_decode(const uschar **);
f4d091fb 341extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
55414b25 342extern int mime_regex(const uschar **);
f4d091fb 343extern void mime_set_anomaly(int);
8523533c 344#endif
059ec3d9
PH
345extern uschar *moan_check_errorcopy(uschar *);
346extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
347 BOOL, uschar *);
e0df1c83 348extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
5455f548
JH
349extern BOOL moan_send_message(uschar *, int, error_block *eblock,
350 header_line *, FILE *, uschar *);
1ba28e2b 351extern void moan_tell_someone(uschar *, address_item *,
e0df1c83 352 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
059ec3d9 353extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
0e22dfd1 354extern void moan_write_from(FILE *);
d6c829b9 355extern void moan_write_references(FILE *, uschar *);
1ba28e2b 356extern FILE *modefopen(const uschar *, const char *, mode_t);
059ec3d9 357
f9334a28 358extern int open_cutthrough_connection( address_item * addr );
e4bdf652 359
059ec3d9
PH
360extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
361 BOOL);
362extern int parse_forward_list(uschar *, int, address_item **, uschar **,
55414b25 363 const uschar *, uschar *, error_block **);
059ec3d9
PH
364extern uschar *parse_find_address_end(uschar *, BOOL);
365extern uschar *parse_find_at(uschar *);
55414b25 366extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
30dba1e6 367extern uschar *parse_message_id(uschar *, uschar **, uschar **);
55414b25 368extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
43ad7b7d 369extern uschar *parse_date_time(uschar *str, time_t *t);
17c76198 370extern int vaguely_random_number(int);
01603eec 371#ifndef DISABLE_TLS
17c76198
PP
372extern int vaguely_random_number_fallback(int);
373#endif
059ec3d9
PH
374
375extern BOOL queue_action(uschar *, int, uschar **, int, int);
376extern void queue_check_only(void);
04403ab0
JH
377extern unsigned queue_count(void);
378extern unsigned queue_count_cached(void);
ff966302
JH
379extern void queue_list(int, uschar **, int);
380#ifdef EXPERIMENTAL_QUEUE_RAMP
381extern void queue_notify_daemon(const uschar * hostname);
382#endif
059ec3d9
PH
383extern void queue_run(uschar *, uschar *, BOOL);
384
385extern int random_number(int);
aeb65e91 386extern const uschar *rc_to_string(int);
e4a89c47 387extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
efd9a422
MH
388 uschar *, uschar *, uschar *, ugid_block *, address_item **,
389 uschar **, error_block **, int *, uschar *);
059ec3d9
PH
390extern int rda_is_filter(const uschar *);
391extern BOOL readconf_depends(driver_instance *, uschar *);
392extern void readconf_driver_init(uschar *, driver_instance **,
393 driver_info *, int, void *, int, optionlist *, int);
394extern uschar *readconf_find_option(void *);
34e86e20 395extern void readconf_main(BOOL);
383832ef 396extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
2be324ee 397extern BOOL readconf_print(uschar *, uschar *, BOOL);
059ec3d9
PH
398extern uschar *readconf_printtime(int);
399extern uschar *readconf_readname(uschar *, int, uschar *);
1ad6489e 400extern int readconf_readtime(const uschar *, int, BOOL);
bf3c2c6b 401extern void readconf_rest(void);
55414b25 402extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
bf3c2c6b 403extern void readconf_save_config(const uschar *);
328895cc 404extern void read_message_body(BOOL);
1d1e7973 405extern void receive_bomb_out(uschar *, uschar *) NORETURN;
059ec3d9
PH
406extern BOOL receive_check_fs(int);
407extern BOOL receive_check_set_sender(uschar *);
408extern BOOL receive_msg(BOOL);
a45431fa 409extern int_eximarith_t receive_statvfs(BOOL, int *);
059ec3d9 410extern void receive_swallow_smtp(void);
8523533c 411#ifdef WITH_CONTENT_SCAN
55414b25 412extern int regex(const uschar **);
8523533c 413#endif
1dc92d5a 414extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
476be7e2 415extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
059ec3d9 416extern void retry_add_item(address_item *, uschar *, int);
55414b25 417extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
059ec3d9 418 uschar **, uschar **);
55414b25
JH
419extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
420extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
ba9af0af 421 dbdata_retry *, time_t);
059ec3d9
PH
422extern void retry_update(address_item **, address_item **, address_item **);
423extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
424extern uschar *rewrite_address_qualify(uschar *, BOOL);
55414b25
JH
425extern header_line *rewrite_header(header_line *,
426 const uschar *, const uschar *,
059ec3d9
PH
427 rewrite_rule *, int, BOOL);
428extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
429 rewrite_rule *);
430extern void rewrite_test(uschar *);
431extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
432 uschar **);
433extern int route_address(address_item *, address_item **, address_item **,
434 address_item **, address_item **, int);
759502e5
JH
435extern int route_check_prefix(const uschar *, const uschar *, unsigned *);
436extern int route_check_suffix(const uschar *, const uschar *, unsigned *);
059ec3d9 437extern BOOL route_findgroup(uschar *, gid_t *);
55414b25 438extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
059ec3d9
PH
439extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
440 uschar **);
441extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
442 struct passwd **, uid_t *, uschar **);
443extern void route_init(void);
ab1604ea 444extern gstring * route_show_supported(gstring *);
059ec3d9
PH
445extern void route_tidyup(void);
446
d447dbd1 447extern uschar *search_find(void *, const uschar *, uschar *, int,
67a57a5a 448 const uschar *, int, int, int *, const uschar *);
55414b25
JH
449extern int search_findtype(const uschar *, int);
450extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
67a57a5a 451 int *, const uschar **);
d447dbd1 452extern void *search_open(const uschar *, int, int, uid_t *, gid_t *);
059ec3d9 453extern void search_tidyup(void);
e0df1c83 454extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
5fb822fc
JH
455extern void sha1_end(hctx *, const uschar *, int, uschar *);
456extern void sha1_mid(hctx *, const uschar *);
457extern void sha1_start(hctx *);
e4a89c47 458extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
efd9a422 459 uschar *, address_item **, uschar **);
059ec3d9 460extern void sigalrm_handler(int);
58eb016e 461extern BOOL smtp_buffered(void);
059ec3d9 462extern void smtp_closedown(uschar *);
1d1e7973
JH
463extern void smtp_command_timeout_exit(void) NORETURN;
464extern void smtp_command_sigterm_exit(void) NORETURN;
465extern void smtp_data_timeout_exit(void) NORETURN;
466extern void smtp_data_sigint_exit(void) NORETURN;
d85cdeb5 467extern void smtp_deliver_init(void);
a09f2942 468extern uschar *smtp_cmd_hist(void);
ee8b8090 469extern int smtp_connect(smtp_connect_args *, const blob *);
7eb6c37c 470extern int smtp_sock_connect(host_item *, int, int, uschar *,
0ab63f3d 471 transport_instance * tb, int, const blob *);
059ec3d9
PH
472extern int smtp_feof(void);
473extern int smtp_ferror(void);
474extern uschar *smtp_get_connection_info(void);
6f6dedcc 475extern BOOL smtp_get_interface(uschar *, int, address_item *,
059ec3d9
PH
476 uschar **, uschar *);
477extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
bd8fbe36 478extern int smtp_getc(unsigned);
0d81dabc 479extern uschar *smtp_getbuf(unsigned *);
584e96c6 480extern void smtp_get_cache(void);
059ec3d9 481extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
b4ed4da0 482extern void smtp_log_no_mail(void);
4f6ae5c3 483extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
1d1e7973 484extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
251b9eb4 485extern BOOL smtp_read_response(void *, uschar *, int, int, int);
f3ebb786 486extern void *smtp_reset(void *);
a5bd321b 487extern void smtp_respond(uschar *, int, BOOL, uschar *);
8f128379 488extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
58c30e47 489extern void smtp_port_for_connect(host_item *, int);
059ec3d9
PH
490extern void smtp_send_prohibition_message(int, uschar *);
491extern int smtp_setup_msg(void);
492extern BOOL smtp_start_session(void);
493extern int smtp_ungetc(int);
d7b47fd0 494extern BOOL smtp_verify_helo(void);
251b9eb4 495extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
8523533c 496#ifdef WITH_CONTENT_SCAN
55414b25 497extern int spam(const uschar **);
040721f2 498extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
8523533c 499#endif
4b4856ff 500extern void spool_clear_header_globals(void);
4b4856ff 501extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
789f8a4f 502extern int spool_open_datafile(uschar *);
059ec3d9
PH
503extern int spool_open_temp(uschar *);
504extern int spool_read_header(uschar *, BOOL, BOOL);
505extern int spool_write_header(uschar *, int, uschar **);
bd8fbe36 506extern int stdin_getc(unsigned);
059ec3d9
PH
507extern int stdin_feof(void);
508extern int stdin_ferror(void);
509extern int stdin_ungetc(int);
f3ebb786
JH
510
511extern void store_exit(void);
acec9514
JH
512extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
513extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
514extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
bce15b62 515extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
059ec3d9 516extern uschar *string_base62(unsigned long int);
acec9514
JH
517extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
518extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
84bbb4d8 519extern int string_compare_by_pointer(const void *, const void *);
059ec3d9 520extern uschar *string_copy_dnsdomain(uschar *);
55414b25 521extern uschar *string_copy_malloc(const uschar *);
55414b25 522extern uschar *string_dequote(const uschar **);
059ec3d9 523extern uschar *string_format_size(int, uschar *);
55414b25 524extern int string_interpret_escape(const uschar **);
b1f8e4f8 525extern int string_is_ip_address(const uschar *, int *);
8c5d388a 526#ifdef SUPPORT_I18N
0d7911ea
JH
527extern BOOL string_is_utf8(const uschar *);
528#endif
55414b25 529extern const uschar *string_printing2(const uschar *, BOOL);
e28326d8 530extern uschar *string_split_message(uschar *);
c7396ac5 531extern uschar *string_unprinting(uschar *);
8c5d388a 532#ifdef SUPPORT_I18N
3c8b3577 533extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
0d7911ea
JH
534extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
535extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
536extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
537extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
538#endif
f3ebb786
JH
539
540#define string_format(buf, siz, fmt, ...) \
c4efe382 541 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
f3ebb786
JH
542extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned,
543 const char *, ...) ALMOST_PRINTF(5,6);
544
545#define string_vformat(g, flgs, fmt, ap) \
546 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
547 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
548extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
549 unsigned, unsigned, const char *, va_list);
550
551#define string_open_failed(eno, fmt, ...) \
c4efe382 552 string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
f3ebb786
JH
553extern uschar *string_open_failed_trc(int, const uschar *, unsigned,
554 const char *, ...) PRINTF_FUNCTION(4,5);
555
ba74fb8d
JH
556#define string_nextinlist(lp, sp, b, l) \
557 string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
558extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
559 const uschar * func, int line);
560
1ba28e2b
PP
561extern int strcmpic(const uschar *, const uschar *);
562extern int strncmpic(const uschar *, const uschar *, int);
059ec3d9
PH
563extern uschar *strstric(uschar *, uschar *, BOOL);
564
44416341 565extern int test_harness_fudged_queue_time(int);
d85cdeb5 566extern void tcp_init(void);
10ac8d7f
JH
567#ifdef EXIM_TFO_PROBE
568extern void tfo_probe(void);
569#endif
32dfdf8b 570extern void tls_modify_variables(tls_support *);
059ec3d9 571extern uschar *tod_stamp(int);
41afb5cb 572
55414b25 573extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
a39bd74d 574 BOOL *, oicf, void*);
059ec3d9 575extern void transport_init(void);
57cc2785
JH
576extern void transport_do_pass_socket(const uschar *, const uschar *,
577 const uschar *, uschar *, int);
55414b25 578extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
059ec3d9
PH
579 int);
580extern uschar *transport_rcpt_address(address_item *, BOOL);
55414b25
JH
581extern BOOL transport_set_up_command(const uschar ***, uschar *,
582 BOOL, int, address_item *, uschar *, uschar **);
059ec3d9 583extern void transport_update_waiting(host_item *, uschar *);
42055a33
JH
584extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
585extern void transport_write_reset(int);
1ba28e2b 586extern BOOL transport_write_string(int, const char *, ...);
42055a33
JH
587extern BOOL transport_headers_send(transport_ctx *,
588 BOOL (*)(transport_ctx *, uschar *, int));
ab1604ea 589extern gstring * transport_show_supported(gstring *);
42055a33 590extern BOOL transport_write_message(transport_ctx *, int);
059ec3d9
PH
591extern void tree_add_duplicate(uschar *, address_item *);
592extern void tree_add_nonrecipient(uschar *);
593extern void tree_add_unusable(host_item *);
b4f579d1 594extern void tree_dup(tree_node **, tree_node *);
059ec3d9 595extern int tree_insertnode(tree_node **, tree_node *);
55414b25 596extern tree_node *tree_search(tree_node *, const uschar *);
059ec3d9 597extern void tree_write(tree_node *, FILE *);
38a0a95f 598extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
059ec3d9 599
8523533c
TK
600#ifdef WITH_CONTENT_SCAN
601extern void unspool_mbox(void);
602#endif
8c5d388a 603#ifdef SUPPORT_I18N
fc362fc5
JH
604extern void utf8_version_report(FILE *);
605#endif
8523533c 606
4deaf07d
PH
607extern int verify_address(address_item *, FILE *, int, int, int, int,
608 uschar *, uschar *, BOOL *);
379ba7d0 609extern int verify_check_dnsbl(int, const uschar **, uschar **);
4deaf07d 610extern int verify_check_header_address(uschar **, uschar **, int, int, int,
fe5b5d0b 611 uschar *, uschar *, int, int *);
059ec3d9 612extern int verify_check_headers(uschar **);
770747fd 613extern int verify_check_header_names_ascii(uschar **);
059ec3d9 614extern int verify_check_host(uschar **);
7c498df1 615extern int verify_check_notblind(BOOL);
3fb3231c 616extern int verify_check_given_host(const uschar **, const host_item *);
55414b25
JH
617extern int verify_check_this_host(const uschar **, unsigned int *,
618 const uschar*, const uschar *, const uschar **);
059ec3d9
PH
619extern address_item *verify_checked_sender(uschar *);
620extern void verify_get_ident(int);
621extern BOOL verify_sender(int *, uschar **);
622extern BOOL verify_sender_preliminary(int *, uschar **);
623extern void version_init(void);
624
42055a33 625extern BOOL write_chunk(transport_ctx *, uschar *, int);
17c76198
PP
626extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
627
6940b3df 628
36eb5d3d
JH
629/******************************************************************************/
630/* Predicate: if an address is in a tainted pool.
631By extension, a variable pointing to this address is tainted.
632*/
633
634static inline BOOL
635is_tainted(const void * p)
636{
637#if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
638return FALSE;
639
640#else
641extern BOOL is_tainted_fn(const void *);
4381d60b 642return is_tainted_fn(p);
36eb5d3d
JH
643#endif
644}
645
646/******************************************************************************/
647/* String functions */
648static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
649{
650#if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
651if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
652#endif
653return US strcat(CS dst, CCS src);
654}
655static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
656{
657#if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
658if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
659#endif
660return US strcpy(CS dst, CCS src);
661}
662static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
663{
664#if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
665if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
666#endif
667return US strncat(CS dst, CCS src, n);
668}
669static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
670{
671#if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
672if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
673#endif
674return US strncpy(CS dst, CCS src, n);
675}
676/*XXX will likely need unchecked copy also */
677
678
137ae145
JH
679/* Advance the string pointer given over any whitespace.
680Return the next char as there's enought places using it to be useful. */
681
682#define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
683
684static inline uschar skip_whitespace(const uschar ** sp)
685{ while (isspace(**sp)) (*sp)++; return **sp; }
686
687
36eb5d3d
JH
688/******************************************************************************/
689
7172970e 690#if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
b66fecb4 691/* exim_chown - in some NFSv4 setups *seemes* to be an issue with
6940b3df 692chown(<exim-uid>, <exim-gid>).
b66fecb4 693
6940b3df
JH
694Probably because the idmapping is broken, misconfigured or set up in
695an unusal way. (see Bug 2931). As I'm not sure, if this was a single
696case of misconfiguration, or if there are more such broken systems
697out, I try to impose as least impact as possible and for now just write
698a panic log entry pointing to the bug report. You're encouraged to
699contact the developers, if you experience this issue.
b66fecb4 700
6940b3df
JH
701fd the file descriptor (or -1 if not valid)
702name the file name for error messages or for file operations,
703 if fd is < 0
704owner the owner
705group the group
b66fecb4 706
6940b3df 707returns 0 on success, -1 on failure */
b66fecb4 708
6940b3df 709static inline int
b66fecb4
HSHR
710exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
711{
6940b3df
JH
712return fchown(fd, owner, group)
713 ? exim_chown_failure(fd, name, owner, group) : 0;
b66fecb4
HSHR
714}
715
6940b3df 716static inline int
b66fecb4
HSHR
717exim_chown(const uschar *name, uid_t owner, gid_t group)
718{
6940b3df
JH
719return chown(CCS name, owner, group)
720 ? exim_chown_failure(-1, name, owner, group) : 0;
b66fecb4 721}
e59797e3 722#endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
36eb5d3d 723
e59797e3
JH
724/******************************************************************************/
725/* String functions */
726
f3ebb786 727#if !defined(MACRO_PREDEF)
e59797e3
JH
728/*************************************************
729* Copy and save string *
730*************************************************/
731
732/* This function assumes that memcpy() is faster than strcpy().
a76d120a 733The result is explicitly nul-terminated.
e59797e3
JH
734*/
735
e59797e3 736static inline uschar *
a76d120a
JH
737string_copyn_taint_trc(const uschar * s, unsigned len,
738 BOOL tainted, const char * func, int line)
e59797e3 739{
a76d120a 740uschar * ss = store_get_3(len + 1, tainted, func, line);
e59797e3 741memcpy(ss, s, len);
a76d120a 742ss[len] = '\0';
e59797e3
JH
743return ss;
744}
745
a76d120a
JH
746static inline uschar *
747string_copy_taint_trc(const uschar * s, BOOL tainted, const char * func, int line)
748{ return string_copyn_taint_trc(s, Ustrlen(s), tainted, func, line); }
f3ebb786
JH
749
750static inline uschar *
a76d120a
JH
751string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
752{ return string_copyn_taint_trc(s, len, is_tainted(s), func, line); }
753static inline uschar *
677481d4 754string_copy_trc(const uschar * s, const char * func, int line)
a76d120a
JH
755{ return string_copy_taint_trc(s, is_tainted(s), func, line); }
756
f3ebb786 757
a76d120a
JH
758/* String-copy functions explicitly setting the taint status */
759
760#define string_copyn_taint(s, len, tainted) \
761 string_copyn_taint_trc((s), (len), (tainted), __FUNCTION__, __LINE__)
762#define string_copy_taint(s, tainted) \
763 string_copy_taint_trc((s), (tainted), __FUNCTION__, __LINE__)
764
765/* Simple string-copy functions maintaining the taint */
766
767#define string_copyn(s, len) \
768 string_copyn_taint_trc((s), (len), is_tainted(s), __FUNCTION__, __LINE__)
677481d4 769#define string_copy(s) \
a76d120a 770 string_copy_taint_trc((s), is_tainted(s), __FUNCTION__, __LINE__)
677481d4 771
e59797e3
JH
772
773/*************************************************
774* Copy, lowercase and save string *
775*************************************************/
776
777/*
778Argument: string to copy
779Returns: copy of string in new store, with letters lowercased
780*/
781
782static inline uschar *
783string_copylc(const uschar *s)
784{
f3ebb786 785uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
e59797e3
JH
786uschar *p = ss;
787while (*s != 0) *p++ = tolower(*s++);
788*p = 0;
789return ss;
790}
791
792
793
794/*************************************************
e59797e3
JH
795* Copy, lowercase, and save string, given length *
796*************************************************/
797
798/* It is assumed the data contains no zeros. A zero is added
799onto the end.
800
801Arguments:
802 s string to copy
803 n number of characters
804
805Returns: copy of string in new store, with letters lowercased
806*/
807
808static inline uschar *
809string_copynlc(uschar *s, int n)
810{
f3ebb786 811uschar *ss = store_get(n + 1, is_tainted(s));
e59797e3
JH
812uschar *p = ss;
813while (n-- > 0) *p++ = tolower(*s++);
814*p = 0;
815return ss;
816}
817
818
1a44d9d7 819# ifndef COMPILE_UTILITY
f3ebb786
JH
820/*************************************************
821* Copy and save string in longterm store *
822*************************************************/
823
824/* This function assumes that memcpy() is faster than strcpy().
825
826Argument: string to copy
827Returns: copy of string in new store
828*/
829
830static inline uschar *
831string_copy_perm(const uschar *s, BOOL force_taint)
832{
833int old_pool = store_pool;
834int len = Ustrlen(s) + 1;
835uschar *ss;
836
837store_pool = POOL_PERM;
838ss = store_get(len, force_taint || is_tainted(s));
839memcpy(ss, s, len);
840store_pool = old_pool;
841return ss;
842}
1a44d9d7 843# endif
f3ebb786
JH
844
845
846
847/* sprintf into a buffer, taint-unchecked */
848
849static inline void
850string_format_nt(uschar * buf, int siz, const char * fmt, ...)
851{
852gstring gs = { .size = siz, .ptr = 0, .s = buf };
853va_list ap;
854va_start(ap, fmt);
855(void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
856va_end(ap);
857}
858
859
860
e59797e3
JH
861/******************************************************************************/
862/* Growable-string functions */
863
f3ebb786
JH
864/* Create a growable-string with some preassigned space */
865
866#define string_get_tainted(size, tainted) \
867 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
e59797e3
JH
868
869static inline gstring *
f3ebb786 870string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
e59797e3 871{
f3ebb786 872gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
e59797e3
JH
873g->size = size;
874g->ptr = 0;
875g->s = US(g + 1);
876return g;
877}
878
f3ebb786
JH
879#define string_get(size) \
880 string_get_trc((size), __FUNCTION__, __LINE__)
881
882static inline gstring *
883string_get_trc(unsigned size, const char * func, unsigned line)
884{
885return string_get_tainted_trc(size, FALSE, func, line);
886}
887
e59797e3
JH
888/* NUL-terminate the C string in the growable-string, and return it. */
889
890static inline uschar *
891string_from_gstring(gstring * g)
892{
893if (!g) return NULL;
894g->s[g->ptr] = '\0';
895return g->s;
896}
897
ba5120a4
JH
898static inline unsigned
899gstring_length(const gstring * g)
900{
901return g ? (unsigned)g->ptr : 0;
902}
903
f3ebb786
JH
904
905#define gstring_release_unused(g) \
906 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
907
e59797e3 908static inline void
f3ebb786 909gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
e59797e3 910{
f3ebb786
JH
911if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
912}
913
914
915/* sprintf-append to a growable-string */
916
917#define string_fmt_append(g, fmt, ...) \
918 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
c4efe382 919 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
f3ebb786
JH
920
921#define string_fmt_append_f(g, flgs, fmt, ...) \
922 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
c4efe382 923 flgs, fmt, __VA_ARGS__)
f3ebb786
JH
924
925static inline gstring *
926string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
927 unsigned flags, const char *format, ...)
928{
929va_list ap;
930va_start(ap, format);
931g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
932 flags, format, ap);
933va_end(ap);
934return g;
e59797e3
JH
935}
936
e68def51
JH
937
938/* Copy the content of a string to tainted memory */
939
940static inline void
941gstring_rebuffer(gstring * g)
942{
943uschar * s = store_get(g->size, TRUE);
944memcpy(s, g->s, g->ptr);
945g->s = s;
946}
947
948
e59797e3 949/******************************************************************************/
8743d3ac
JH
950
951#define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
952
953static inline dns_answer *
954store_get_dns_answer_trc(const uschar * func, unsigned line)
955{
956return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); /* use tainted mem */
957}
958
59a93276
JH
959/******************************************************************************/
960/* Routines with knowledge of spool layout */
961
962# ifndef COMPILE_UTILITY
963static inline void
964spool_pname_buf(uschar * buf, int len)
965{
966snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
967}
968
969static inline uschar *
970spool_dname(const uschar * purpose, uschar * subdir)
971{
972return string_sprintf("%s/%s/%s/%s",
973 spool_directory, queue_name, purpose, subdir);
974}
975# endif
976
977static inline uschar *
fc7bae7f 978spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
59a93276
JH
979{
980return string_sprintf("%s%s%s%s%s",
fc7bae7f 981 q, *q ? "/" : "",
59a93276
JH
982 purpose,
983 *subdir ? "/" : "", subdir);
984}
985
986static inline uschar *
fc7bae7f
JH
987spool_sname(const uschar * purpose, uschar * subdir)
988{
989return spool_q_sname(purpose, queue_name, subdir);
990}
991
992static inline uschar *
993spool_q_fname(const uschar * purpose, const uschar * q,
994 const uschar * subdir, const uschar * fname, const uschar * suffix)
995{
996return string_sprintf("%s/%s/%s/%s/%s%s",
997 spool_directory, q, purpose, subdir, fname, suffix);
998}
999
1000static inline uschar *
59a93276 1001spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
8aa16eb7 1002 const uschar * suffix)
59a93276 1003{
8aa16eb7
JH
1004#ifdef COMPILE_UTILITY /* version avoiding string-extension */
1005int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1006 + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1007uschar * buf = store_get(len, FALSE);
1008string_format(buf, len, "%s/%s/%s/%s/%s%s",
1009 spool_directory, queue_name, purpose, subdir, fname, suffix);
1010return buf;
1011#else
fc7bae7f 1012return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
8aa16eb7 1013#endif
59a93276
JH
1014}
1015
9b62f401 1016static inline void
59a93276
JH
1017set_subdir_str(uschar * subdir_str, const uschar * name,
1018 int search_sequence)
1019{
1020subdir_str[0] = split_spool_directory == (search_sequence == 0)
1021 ? name[5] : '\0';
1022subdir_str[1] = '\0';
1023}
1024
1025/******************************************************************************/
9e21ce8f
JH
1026/* Time calculations */
1027
9f01e50d 1028static inline void
a55697ac 1029timesince(struct timeval * diff, const struct timeval * then)
9f01e50d
JH
1030{
1031gettimeofday(diff, NULL);
1032diff->tv_sec -= then->tv_sec;
1033if ((diff->tv_usec -= then->tv_usec) < 0)
1034 {
1035 diff->tv_sec--;
1036 diff->tv_usec += 1000*1000;
1037 }
1038}
1039
1040static inline uschar *
a55697ac 1041string_timediff(const struct timeval * diff)
9f01e50d
JH
1042{
1043static uschar buf[sizeof("0.000s")];
1044
1045if (diff->tv_sec >= 5 || !LOGGING(millisec))
1046 return readconf_printtime((int)diff->tv_sec);
1047
b09c5f34 1048snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
9f01e50d
JH
1049return buf;
1050}
1051
1052
1053static inline uschar *
a55697ac 1054string_timesince(const struct timeval * then)
9f01e50d
JH
1055{
1056struct timeval diff;
1057timesince(&diff, then);
1058return string_timediff(&diff);
1059}
1060
1061static inline void
a55697ac 1062report_time_since(const struct timeval * t0, const uschar * where)
9f01e50d
JH
1063{
1064# ifdef MEASURE_TIMING
1065struct timeval diff;
1066timesince(&diff, t0);
1067fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1068 (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1069# endif
1070}
1071
1072
1073static inline void
1074testharness_pause_ms(int millisec)
1075{
1076#ifndef MEASURE_TIMING
ff966302 1077if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
9f01e50d
JH
1078#endif
1079}
1080
9e21ce8f
JH
1081/******************************************************************************/
1082/* Taint-checked file opens */
1083
1084static inline int
1085exim_open2(const char *pathname, int flags)
1086{
1087if (!is_tainted(pathname)) return open(pathname, flags);
54a2a2a9 1088log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
9e21ce8f
JH
1089errno = EACCES;
1090return -1;
1091}
1092static inline int
1093exim_open(const char *pathname, int flags, mode_t mode)
1094{
1095if (!is_tainted(pathname)) return open(pathname, flags, mode);
54a2a2a9 1096log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
9e21ce8f
JH
1097errno = EACCES;
1098return -1;
1099}
1100static inline int
1101exim_openat(int dirfd, const char *pathname, int flags)
1102{
1103if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
54a2a2a9 1104log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
9e21ce8f
JH
1105errno = EACCES;
1106return -1;
1107}
1108static inline int
1109exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1110{
1111if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
54a2a2a9 1112log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
9e21ce8f
JH
1113errno = EACCES;
1114return -1;
1115}
1116
1117static inline FILE *
1118exim_fopen(const char *pathname, const char *mode)
1119{
1120if (!is_tainted(pathname)) return fopen(pathname, mode);
54a2a2a9
JH
1121log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1122errno = EACCES;
1123return NULL;
1124}
1125
1126static inline DIR *
1127exim_opendir(const uschar * name)
1128{
1129if (!is_tainted(name)) return opendir(CCS name);
1130log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name);
9e21ce8f
JH
1131errno = EACCES;
1132return NULL;
1133}
1134
8e9fdd63 1135/******************************************************************************/
35c3c485 1136# if !defined(COMPILE_UTILITY)
8e9fdd63
JH
1137/* Process manipulation */
1138
1139static inline pid_t
1140exim_fork(const unsigned char * purpose)
1141{
56809214
JH
1142pid_t pid;
1143DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1144if ((pid = fork()) == 0)
1145 {
1146 process_purpose = purpose;
1147 DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1148 }
1149else
1150 {
1151 testharness_pause_ms(100); /* let child work */
1152 DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1153 }
8e9fdd63
JH
1154return pid;
1155}
1156
56809214
JH
1157
1158static inline pid_t
1159child_open_exim(int * fdptr, const uschar * purpose)
1160{ return child_open_exim_function(fdptr, purpose); }
1161
1162static inline pid_t
1163child_open_exim2(int * fdptr, uschar * sender,
1164 uschar * sender_auth, const uschar * purpose)
1165{ return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1166
eb24befc
JH
1167static inline pid_t
1168child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1169 int *outfdptr, BOOL make_leader, const uschar * purpose)
1170{ return child_open_function(argv, envp, newumask, infdptr,
1171 outfdptr, make_leader, purpose);
1172}
1173
35c3c485 1174# endif /* !COMPILE_UTILITY */
8e9fdd63
JH
1175
1176/******************************************************************************/
eb2fb50d 1177#endif /* !MACRO_PREDEF */
b66fecb4
HSHR
1178
1179#endif /* _FUNCTIONS_H_ */
acec9514 1180
9d1c15ef
JH
1181/* vi: aw
1182*/
059ec3d9 1183/* End of functions.h */