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