src/src/functions.h

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