src/src/functions.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
   6 /* Copyright (c) University of Cambridge 1995 - 2018 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8 /* SPDX-License-Identifier: GPL-2.0-or-later */
   9
  10
  11 /* Prototypes for functions that appear in various modules. Gathered together
  12 to avoid having a lot of tiddly little headers with only a couple of lines in
  13 them. However, some functions that are used (or not used) by utility programs
  14 are in in fact in separate headers. */
  15 #ifndef _FUNCTIONS_H_
  16 #define _FUNCTIONS_H_
  17
  18 #include <ctype.h>
  19 #include <sys/time.h>
  20
  21
  22 #ifndef DISABLE_TLS
  23 extern const char *
  24                std_dh_prime_default(void);
  25 extern const char *
  26                std_dh_prime_named(const uschar *);
  27
  28 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
  29 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
  30 extern uschar * tls_cert_issuer(void *, uschar * mod);
  31 extern uschar * tls_cert_not_before(void *, uschar * mod);
  32 extern uschar * tls_cert_not_after(void *, uschar * mod);
  33 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
  34 extern uschar * tls_cert_serial_number(void *, uschar * mod);
  35 extern uschar * tls_cert_signature(void *, uschar * mod);
  36 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
  37 extern uschar * tls_cert_subject(void *, uschar * mod);
  38 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
  39 extern uschar * tls_cert_version(void *, uschar * mod);
  40
  41 extern uschar * tls_cert_der_b64(void * cert);
  42 extern uschar * tls_cert_fprt_md5(void *);
  43 extern uschar * tls_cert_fprt_sha1(void *);
  44 extern uschar * tls_cert_fprt_sha256(void *);
  45
  46 extern void    tls_clean_env(void);
  47 extern BOOL    tls_client_start(client_conn_ctx *, smtp_connect_args *,
  48                   void *, tls_support *, uschar **);
  49 extern BOOL    tls_client_adjunct_start(host_item *, client_conn_ctx *,
  50                   const uschar *, uschar **);
  51 extern void    tls_client_creds_reload(BOOL);
  52
  53 extern void    tls_close(void *, int);
  54 extern BOOL    tls_could_getc(void);
  55 extern void    tls_daemon_init(void);
  56 extern int     tls_daemon_tick(void);
  57 extern BOOL    tls_dropprivs_validate_require_cipher(BOOL);
  58 extern BOOL    tls_export_cert(uschar *, size_t, void *);
  59 extern int     tls_feof(void);
  60 extern int     tls_ferror(void);
  61 extern uschar *tls_field_from_dn(uschar *, const uschar *);
  62 extern void    tls_free_cert(void **);
  63 extern int     tls_getc(unsigned);
  64 extern uschar *tls_getbuf(unsigned *);
  65 extern void    tls_get_cache(unsigned);
  66 extern BOOL    tls_hasc(void);
  67 extern BOOL    tls_import_cert(const uschar *, void **);
  68 extern BOOL    tls_is_name_for_cert(const uschar *, void *);
  69 # ifdef USE_OPENSSL
  70 extern BOOL    tls_openssl_options_parse(uschar *, long *);
  71 # endif
  72 extern int     tls_read(void *, uschar *, size_t);
  73 extern int     tls_server_start(uschar **);
  74 extern void    tls_shutdown_wr(void *);
  75 extern BOOL    tls_smtp_buffered(void);
  76 extern int     tls_ungetc(int);
  77 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
  78 extern void    tls_watch_discard_event(int);
  79 extern void    tls_watch_invalidate(void);
  80 #endif
  81 extern int     tls_write(void *, const uschar *, size_t, BOOL);
  82 extern uschar *tls_validate_require_cipher(void);
  83 extern gstring *tls_version_report(gstring *);
  84
  85 # ifdef SUPPORT_DANE
  86 extern int     tlsa_lookup(const host_item *, dns_answer *, BOOL);
  87 # endif
  88
  89 #endif  /*DISABLE_TLS*/
  90
  91
  92 /* Everything else... */
  93
  94 extern acl_block *acl_read(uschar *(*)(void), uschar **);
  95 extern int     acl_check(int, const uschar *, uschar *, uschar **, uschar **);
  96 extern uschar *acl_current_verb(void);
  97 extern int     acl_eval(int, uschar *, uschar **, uschar **);
  98 extern uschar *acl_standalone_setvar(const uschar *, BOOL);
  99
 100 extern tree_node *acl_var_create(uschar *);
 101 extern void    acl_var_write(uschar *, uschar *, void *);
 102 extern void    add_driver_info(driver_info **, const driver_info *, size_t);
 103
 104
 105 extern void    assert_no_variables(void *, int, const char *, int);
 106 extern int     auth_call_pwcheck(uschar *, uschar **);
 107 extern int     auth_call_saslauthd(const uschar *, const uschar *,
 108                  const uschar *, const uschar *, uschar **);
 109 extern int     auth_check_serv_cond(auth_instance *);
 110 extern int     auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
 111 extern int     auth_client_item(void *, auth_instance *, const uschar **,
 112                  unsigned, int, uschar *, int);
 113
 114
 115 extern int     auth_get_data(uschar **, const uschar *, int);
 116 extern int     auth_get_no64_data(uschar **, uschar *);
 117 extern int     auth_prompt(const uschar *);
 118 extern int     auth_read_input(const uschar *);
 119 extern gstring * auth_show_supported(gstring *);
 120 extern uschar *authenticator_current_name(void);
 121
 122 extern gstring *authres_smtpauth(gstring *);
 123
 124 extern uschar *b64encode(const uschar *, int);
 125 extern uschar *b64encode_taint(const uschar *, int, const void *);
 126 extern int     b64decode(const uschar *, uschar **, const void *);
 127 extern int     bdat_getc(unsigned);
 128 extern uschar *bdat_getbuf(unsigned *);
 129 extern BOOL    bdat_hasc(void);
 130 extern int     bdat_ungetc(int);
 131 extern void    bdat_flush_data(void);
 132
 133 extern void    bits_clear(unsigned int *, size_t, int *);
 134 extern void    bits_set(unsigned int *, size_t, int *);
 135
 136 extern void    cancel_cutthrough_connection(BOOL, const uschar *);
 137 extern gstring *cat_file(FILE *, gstring *, uschar *);
 138 extern gstring *cat_file_tls(void *, gstring *, uschar *);
 139 extern int     check_host(void *, const uschar *, const uschar **, uschar **);
 140 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
 141 extern pid_t   child_open_exim_function(int *, const uschar *);
 142 extern pid_t   child_open_exim2_function(int *, uschar *, uschar *,
 143                  const uschar *);
 144 extern pid_t   child_open_function(uschar **, uschar **, int,
 145                  int *, int *, BOOL, const uschar *);
 146 extern pid_t   child_open_uid(const uschar **, const uschar **, int,
 147                  uid_t *, gid_t *, int *, int *, uschar *, BOOL, const uschar *);
 148 extern BOOL    cleanup_environment(void);
 149 extern void    cutthrough_data_puts(uschar *, int);
 150 extern void    cutthrough_data_put_nl(void);
 151 extern uschar *cutthrough_finaldot(void);
 152 extern BOOL    cutthrough_flush_send(void);
 153 extern BOOL    cutthrough_headers_send(void);
 154 extern BOOL    cutthrough_predata(void);
 155 extern void    release_cutthrough_connection(const uschar *);
 156
 157 extern void    daemon_go(void);
 158 #ifndef COMPILE_UTILITY
 159 extern ssize_t daemon_client_sockname(struct sockaddr_un *, uschar **);
 160 extern ssize_t daemon_notifier_sockname(struct sockaddr_un *);
 161 #endif
 162
 163 #ifdef EXPERIMENTAL_DCC
 164 extern int     dcc_process(uschar **);
 165 #endif
 166
 167 extern void    debug_logging_activate(const uschar *, const uschar *);
 168 extern void    debug_logging_from_spool(const uschar *);
 169 extern void    debug_logging_stop(BOOL);
 170 extern void    debug_print_argv(const uschar **);
 171 extern void    debug_print_ids(uschar *);
 172 extern void    debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
 173 extern void    debug_print_string(uschar *);
 174 extern void    debug_print_tree(const char *, tree_node *);
 175 extern void    debug_vprintf(int, const char *, va_list);
 176 extern void    debug_pretrigger_setup(const uschar *);
 177 extern void    debug_pretrigger_discard(void);
 178 extern void    debug_print_socket(int);
 179 extern void    debug_trigger_fire(void);
 180
 181 extern void    decode_bits(unsigned int *, size_t, int *,
 182                    const uschar *, bit_table *, int, uschar *, int);
 183 extern void    delete_pid_file(void);
 184 extern void    deliver_local(address_item *, BOOL);
 185 extern address_item *deliver_make_addr(const uschar *, BOOL);
 186 extern void    delivery_log(int, address_item *, int, uschar *);
 187 extern int     deliver_message(const uschar *, BOOL, BOOL);
 188 extern void    deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
 189 extern void    deliver_set_expansions(address_item *);
 190 extern int     deliver_split_address(address_item *);
 191 extern void    deliver_succeeded(address_item *);
 192
 193 extern void    delivery_re_exec(int);
 194
 195 extern void    die_tainted(const uschar *, const uschar *, int);
 196 extern BOOL    directory_make(const uschar *, const uschar *, int, BOOL);
 197 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
 198 extern int     dns_basic_lookup(dns_answer *, const uschar *, int);
 199 extern uschar *dns_build_reverse(const uschar *);
 200 extern time_t  dns_expire_from_soa(dns_answer *, int);
 201 extern void    dns_init(BOOL, BOOL, BOOL);
 202 extern BOOL    dns_is_aa(const dns_answer *);
 203 extern BOOL    dns_is_secure(const dns_answer *);
 204 extern int     dns_lookup(dns_answer *, const uschar *, int, const uschar **);
 205 extern void    dns_pattern_init(void);
 206 extern int     dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
 207 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
 208 extern uschar *dns_text_type(int);
 209 extern void    dscp_list_to_stream(FILE *);
 210 extern BOOL    dscp_lookup(const uschar *, int, int *, int *, int *);
 211
 212 extern void    enq_end(uschar *);
 213 extern BOOL    enq_start(uschar *, unsigned);
 214 #ifndef DISABLE_EVENT
 215 extern uschar *event_raise(const uschar *, const uschar *, const uschar *, int *);
 216 extern void    msg_event_raise(const uschar *, const address_item *);
 217 #endif
 218
 219 extern int     exim_chown_failure(int, const uschar*, uid_t, gid_t);
 220 extern const uschar * exim_errstr(int);
 221 extern void    exim_exit(int) NORETURN;
 222 extern void    exim_gettime(struct timeval *);
 223 extern void    exim_nullstd(void);
 224 extern void    exim_setugid(uid_t, gid_t, BOOL, const uschar *);
 225 extern void    exim_underbar_exit(int) NORETURN;
 226 extern void    exim_wait_tick(struct timeval *, int);
 227 extern int     exp_bool(address_item *,
 228   const uschar *, const uschar *, unsigned, uschar *, BOOL bvalue,
 229   const uschar *, BOOL *);
 230 extern BOOL    expand_check_condition(const uschar *, const uschar *, const uschar *);
 231 extern uschar *expand_file_big_buffer(const uschar *);
 232 extern uschar *expand_string(uschar *); /* public, cannot make const */
 233 extern const uschar *expand_string_2(const uschar *, BOOL *);
 234 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
 235 extern uschar *expand_getkeyed(const uschar *, const uschar *);
 236
 237 extern uschar *expand_hide_passwords(uschar * );
 238 extern uschar *expand_string_copy(const uschar *);
 239 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
 240 extern void    modify_variable(uschar *, void *);
 241
 242 extern BOOL    fd_ready(int, time_t);
 243 extern BOOL    filter_runtest(int, const uschar *, BOOL, BOOL);
 244
 245 extern uschar * fn_hdrs_added(void);
 246 extern void    force_fd(int, int);
 247
 248 extern void    header_add(int, const char *, ...);
 249 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
 250 extern int     header_checkname(header_line *, BOOL);
 251 extern BOOL    header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
 252 extern int     host_address_extract_port(uschar *);
 253 extern uschar *host_and_ident(BOOL);
 254 extern int     host_aton(const uschar *, int *);
 255 extern void    host_build_hostlist(host_item **, const uschar *, BOOL);
 256 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
 257 extern void    host_build_log_info(void);
 258 extern void    host_build_sender_fullhost(void);
 259 extern int     host_find_byname(host_item *, const uschar *, int,
 260                                 const uschar **, BOOL);
 261 extern int     host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
 262                  uschar *, const dnssec_domains *, const uschar **, BOOL *);
 263 extern ip_address_item *host_find_interfaces(void);
 264 extern BOOL    host_is_in_net(const uschar *, const uschar *, int);
 265 extern BOOL    host_is_tls_on_connect_port(int);
 266 extern int     host_item_get_port(host_item *);
 267 extern void    host_mask(int, int *, int);
 268 extern int     host_name_lookup(void);
 269 extern int     host_nmtoa(int, const int *, int, uschar *, int);
 270 extern uschar *host_ntoa(int, const void *, uschar *, int *);
 271 extern int     host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
 272
 273 extern uschar *imap_utf7_encode(uschar *, const uschar *,
 274                                  uschar, uschar *, uschar **);
 275
 276 extern void    invert_address(uschar *, uschar *);
 277 extern int     ip_addr(void *, int, const uschar *, int);
 278 extern int     ip_bind(int, int, uschar *, int);
 279 extern int     ip_connect(int, int, const uschar *, int, int, const blob *);
 280 extern int     ip_connectedsocket(int, const uschar *, int, int,
 281                  int, host_item *, uschar **, const blob *);
 282 extern int     ip_get_address_family(int);
 283 extern void    ip_keepalive(int, const uschar *, BOOL);
 284 extern int     ip_recv(client_conn_ctx *, uschar *, int, time_t);
 285 extern int     ip_socket(int, int);
 286
 287 extern int     ip_tcpsocket(const uschar *, uschar **, int, host_item *);
 288 extern int     ip_unixsocket(const uschar *, uschar **);
 289 extern int     ip_streamsocket(const uschar *, uschar **, int, host_item *);
 290
 291 extern int     ipv6_nmtoa(int *, uschar *);
 292
 293 extern const uschar *local_part_quote(const uschar *);
 294 extern int     log_open_as_exim(const uschar * const);
 295 extern void    log_close_all(void);
 296 extern const lookup_info * lookup_with_acq_num(unsigned);
 297 #ifdef LOOKUP_MODULE_DIR
 298 extern BOOL    lookup_one_mod_load(const uschar *, uschar **);
 299 #endif
 300
 301
 302 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
 303 extern BOOL    macro_read_assignment(uschar *);
 304 extern uschar *macros_expand(int, int *, BOOL *);
 305 extern void    mainlog_close(void);
 306 #ifdef WITH_CONTENT_SCAN
 307 extern int     malware(const uschar *, BOOL, int);
 308 extern int     malware_in_file(const uschar *);
 309 extern void    malware_init(void);
 310 extern gstring * malware_show_supported(gstring *);
 311 #endif
 312 extern int     match_address_list(const uschar *, BOOL, BOOL, const uschar **,
 313                  unsigned int *, int, int, const uschar **);
 314 extern int     match_address_list_basic(const uschar *, const uschar **, int);
 315 extern int     match_check_list(const uschar **, int, tree_node **, unsigned int **,
 316                  int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
 317                  const uschar *, const uschar **);
 318 extern int     match_isinlist(const uschar *, const uschar **, int, tree_node **,
 319                  unsigned int *, int, BOOL, const uschar **);
 320 extern int     match_check_string(const uschar *, const uschar *, int, mcs_flags,
 321                  const uschar **);
 322
 323 extern void    message_start(void);
 324 extern void    message_tidyup(void);
 325 extern void    md5_end(md5 *, const uschar *, int, uschar *);
 326 extern void    md5_mid(md5 *, const uschar *);
 327 extern void    md5_start(md5 *);
 328 extern void    millisleep(int);
 329 #ifdef WITH_CONTENT_SCAN
 330 struct mime_boundary_context;
 331 extern int     mime_acl_check(uschar *acl, FILE *f,
 332                  struct mime_boundary_context *, uschar **, uschar **);
 333 extern int     mime_decode(const uschar **);
 334 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
 335 extern int     mime_regex(const uschar **, BOOL);
 336 extern void    mime_set_anomaly(int);
 337 #endif
 338
 339 extern gstring *misc_mod_authres(gstring *);
 340 extern int     misc_mod_conn_init(const uschar *, const uschar *);
 341 extern misc_module_info * misc_mod_find(const uschar * modname, uschar **);
 342 extern misc_module_info * misc_mod_findonly(const uschar * modname);
 343 extern int     misc_mod_msg_init(void);
 344 extern void    misc_mod_smtp_reset(void);
 345
 346 extern uschar *moan_check_errorcopy(const uschar *);
 347 extern BOOL    moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
 348                  BOOL, uschar *);
 349 extern void    moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
 350 extern BOOL    moan_send_message(const uschar *, int, error_block *eblock,
 351                  header_line *, FILE *, uschar *);
 352 extern void    moan_tell_someone(uschar *, address_item *,
 353                  const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
 354 extern BOOL    moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
 355 extern void    moan_write_from(FILE *);
 356 extern void    moan_write_references(FILE *, uschar *);
 357 #ifdef LOOKUP_MODULE_DIR
 358 //extern void    mod_load_check(const uschar *);
 359 #endif
 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(const uschar *, uschar **, int *, int *, int *,
 365                  BOOL);
 366 extern int     parse_forward_list(const uschar *, int, address_item **, uschar **,
 367                  const uschar *, const uschar *, error_block **);
 368 extern uschar *parse_find_address_end(const uschar *, BOOL);
 369 extern const uschar *parse_find_at(const uschar *);
 370 extern const uschar *parse_fix_phrase(const uschar *, int);
 371 extern const uschar *parse_message_id(const uschar *, uschar **, uschar **);
 372 extern const uschar *parse_quote_2047(const uschar *, int, const uschar *,
 373                                       BOOL);
 374 extern const uschar *parse_date_time(const uschar *str, time_t *t);
 375 extern void priv_drop_temp(const uid_t, const gid_t);
 376 extern void priv_restore(void);
 377 #ifdef SUPPORT_PROXY
 378 extern BOOL     proxy_protocol_host(void);
 379 extern void     proxy_protocol_setup(void);
 380 #endif
 381
 382 extern BOOL    queue_action(const uschar *, int, const uschar **, int, int);
 383 extern void    queue_check_only(void);
 384 extern unsigned queue_count(void);
 385 extern unsigned queue_count_cached(void);
 386 extern void    queue_list(int, const uschar **, int);
 387 #ifndef DISABLE_QUEUE_RAMP
 388 extern void    queue_notify_daemon(const uschar * hostname);
 389 #endif
 390 extern void    queue_run(qrunner *, const uschar *, const uschar *, BOOL);
 391
 392 extern int     random_number(int);
 393 extern const uschar *rc_to_string(int);
 394 extern int     rda_interpret(redirect_block *, int, const uschar *,
 395                 const sieve_block *, const ugid_block *, address_item **,
 396                 uschar **, error_block **, int *, const uschar *);
 397 extern int     rda_is_filter(const uschar *);
 398 extern BOOL    readconf_depends(driver_instance *, uschar *);
 399 extern void    readconf_driver_init(driver_instance **, driver_info **, int,
 400                 void *, int, optionlist *, int, const uschar *);
 401 extern const uschar *readconf_find_option(void *);
 402 extern void    readconf_main(BOOL);
 403 extern void    readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
 404 extern BOOL    readconf_print(const uschar *, const uschar *, BOOL);
 405 extern uschar *readconf_printtime(int);
 406 extern const uschar *readconf_readname(uschar *, int, const uschar *);
 407 extern int     readconf_readtime(const uschar *, int, BOOL);
 408 extern void    readconf_rest(void);
 409 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
 410 extern void    readconf_save_config(const uschar *);
 411 extern void    read_message_body(BOOL);
 412 extern void    receive_bomb_out(uschar *, uschar *) NORETURN;
 413 extern BOOL    receive_check_fs(int);
 414 extern BOOL    receive_check_set_sender(const uschar *);
 415 extern BOOL    receive_msg(BOOL);
 416 extern int_eximarith_t receive_statvfs(BOOL, int *);
 417 extern void    receive_swallow_smtp(void);
 418 extern int     recv_fd_from_sock(int);
 419 #ifdef WITH_CONTENT_SCAN
 420 extern int     regex(const uschar **, BOOL);
 421 extern void    regex_vars_clear(void);
 422 #endif
 423 extern void    regex_at_daemon(const uschar *);
 424 extern BOOL    regex_match(const pcre2_code *, const uschar *, int, uschar **);
 425 extern BOOL    regex_match_and_setup(const pcre2_code *, const uschar *, int, int);
 426 extern const pcre2_code *regex_compile(const uschar *, mcs_flags, uschar **,
 427                 pcre2_compile_context *);
 428 extern const pcre2_code *regex_must_compile(const uschar *, mcs_flags, BOOL);
 429
 430 extern void    retry_add_item(address_item *, const uschar *, int);
 431 extern BOOL    retry_check_address(const uschar *, host_item *, uschar *, BOOL,
 432                  const uschar **, const uschar **);
 433 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
 434 extern const uschar *retry_host_key_build(const host_item *, BOOL,
 435                   const uschar *);
 436 extern BOOL    retry_ultimate_address_timeout(const uschar *, const uschar *,
 437                  dbdata_retry *, time_t);
 438 extern void    retry_update(address_item **, address_item **, address_item **);
 439 extern const uschar *rewrite_address(const uschar *, BOOL, BOOL, rewrite_rule *, int);
 440 extern const uschar *rewrite_address_qualify(const uschar *, BOOL);
 441 extern header_line *rewrite_header(header_line *,
 442                const uschar *, const uschar *,
 443                rewrite_rule *, int, BOOL);
 444 extern const uschar *rewrite_one(const uschar *, int, BOOL *, BOOL, uschar *,
 445                  rewrite_rule *);
 446 extern void    rewrite_test(const uschar *);
 447 extern uschar *rfc2047_decode2(uschar *, BOOL, const uschar *, int, int *,
 448                                      int *, uschar **);
 449 extern int     route_address(address_item *, address_item **, address_item **,
 450                  address_item **, address_item **, int);
 451 extern int     route_check_prefix(const uschar *, const uschar *, unsigned *);
 452 extern int     route_check_suffix(const uschar *, const uschar *, unsigned *);
 453 extern BOOL    route_findgroup(uschar *, gid_t *);
 454 extern BOOL    route_finduser(const uschar *, struct passwd **, uid_t *);
 455 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
 456                  uschar **);
 457 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
 458                  struct passwd **, uid_t *, uschar **);
 459 extern void    route_init(void);
 460 extern gstring * route_show_supported(gstring *);
 461 extern void    route_tidyup(void);
 462 extern uschar *router_current_name(void);
 463
 464 extern uschar *search_args(const lookup_info *, uschar *, uschar *, uschar **,
 465                 const uschar *);
 466 extern uschar *search_find(void *, const uschar *, const uschar *, int,
 467                  const uschar *, int, int, int *, const uschar *);
 468 extern const lookup_info * search_findtype(const uschar *, int);
 469 extern const lookup_info * search_findtype_partial(const uschar *, int *,
 470                 const uschar **, int *, int *, const uschar **);
 471 extern void   *search_open(const uschar *, const lookup_info *, int,
 472                 uid_t *, gid_t *);
 473 extern void    search_tidyup(void);
 474 extern BOOL    send_fd_over_socket(int, int);
 475 extern uschar *sender_helo_verified_boolstr(void);
 476 extern void    set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
 477 extern void    sha1_end(hctx *, const uschar *, int, uschar *);
 478 extern void    sha1_mid(hctx *, const uschar *);
 479 extern void    sha1_start(hctx *);
 480 extern void    sigalrm_handler(int);
 481 extern void    single_queue_run(qrunner *, const uschar *, const uschar *);
 482 extern int     smtp_boundsock(smtp_connect_args *);
 483 extern void    smtp_closedown(uschar *);
 484 extern void    smtp_command_timeout_exit(void) NORETURN;
 485 extern void    smtp_command_sigterm_exit(void) NORETURN;
 486 extern void    smtp_data_timeout_exit(void) NORETURN;
 487 extern void    smtp_data_sigint_exit(void) NORETURN;
 488 extern void    smtp_deliver_init(void);
 489 extern uschar *smtp_cmd_hist(void);
 490 extern int     smtp_connect(smtp_connect_args *, const blob *);
 491 extern int     smtp_feof(void);
 492 extern int     smtp_ferror(void);
 493 extern uschar *smtp_get_connection_info(void);
 494 extern BOOL    smtp_get_interface(uschar *, int, address_item *,
 495                  uschar **, uschar *);
 496 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
 497 extern int     smtp_getc(unsigned);
 498 extern uschar *smtp_getbuf(unsigned *);
 499 extern void    smtp_get_cache(unsigned);
 500 extern BOOL    smtp_hasc(void);
 501 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
 502 extern void    smtp_log_no_mail(void);
 503 extern void    smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
 504 extern void    smtp_proxy_tls(void *, uschar *, size_t, int *, int, const uschar *) NORETURN;
 505 extern BOOL    smtp_read_response(void *, uschar *, int, int, int);
 506 extern void   *smtp_reset(void *);
 507 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
 508 extern void    smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
 509 extern void    smtp_port_for_connect(host_item *, int);
 510 extern void    smtp_send_prohibition_message(int, uschar *);
 511 extern int     smtp_setup_msg(void);
 512 extern int     smtp_sock_connect(smtp_connect_args *, int, const blob *);
 513 extern BOOL    smtp_start_session(void);
 514 extern int     smtp_ungetc(int);
 515 extern void    smtp_verify_feed(const uschar *, unsigned);
 516 extern BOOL    smtp_verify_helo(void);
 517 extern int     smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
 518 #ifdef WITH_CONTENT_SCAN
 519 extern int     spam(const uschar **);
 520 extern FILE   *spool_mbox(unsigned long *, const uschar *, uschar **);
 521 #endif
 522 extern void    spool_clear_header_globals(void);
 523 extern BOOL    spool_move_message(const uschar *, const uschar *, const uschar *, const uschar *);
 524 extern int     spool_open_datafile(const uschar *);
 525 extern int     spool_open_temp(uschar *);
 526 extern int     spool_read_header(uschar *, BOOL, BOOL);
 527 extern uschar *spool_sender_from_msgid(const uschar *);
 528 extern int     spool_write_header(const uschar *, int, uschar **);
 529 extern int     stdin_getc(unsigned);
 530 extern int     stdin_feof(void);
 531 extern int     stdin_ferror(void);
 532 extern BOOL    stdin_hasc(void);
 533 extern int     stdin_ungetc(int);
 534
 535 extern void    stackdump(void);
 536 extern void    store_exit(void);
 537 extern void    store_init(void);
 538 extern void    store_writeprotect(int);
 539
 540 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
 541 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
 542 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
 543 extern gstring *string_append_listele_fmt(gstring *, uschar, BOOL, const char *, ...) WARN_UNUSED_RESULT;
 544 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
 545 extern uschar *string_base62_32(unsigned long int);
 546 extern uschar *string_base62_64(unsigned long int);
 547 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
 548 extern int     string_compare_by_pointer(const void *, const void *);
 549 extern uschar *string_copy_dnsdomain(uschar *);
 550 extern uschar *string_copy_malloc(const uschar *);
 551 extern uschar *string_dequote(const uschar **);
 552 extern uschar *string_format_size(int, uschar *);
 553 extern int     string_interpret_escape(const uschar **);
 554 extern int     string_is_ip_address(const uschar *, int *);
 555 extern int     string_is_ip_addressX(const uschar *, int *, const uschar **);
 556 #ifdef SUPPORT_I18N
 557 extern BOOL    string_is_utf8(const uschar *);
 558 #endif
 559 extern const uschar *string_printing2(const uschar *, int);
 560 extern uschar *string_split_message(uschar *);
 561 extern uschar *string_unprinting(uschar *);
 562 #ifdef SUPPORT_I18N
 563 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
 564 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
 565 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
 566 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
 567 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
 568 #endif
 569
 570 #define string_format(buf, siz, fmt, ...) \
 571         string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 572 extern BOOL    string_format_trc(uschar *, int, const uschar *, unsigned,
 573                         const char *, ...) ALMOST_PRINTF(5,6);
 574
 575 #define string_vformat(g, flgs, fmt, ap) \
 576         string_vformat_trc(g, US __FUNCTION__, __LINE__, \
 577                          STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
 578 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
 579                         unsigned, unsigned, const char *, va_list);
 580
 581 #define string_open_failed(fmt, ...) \
 582         string_open_failed_trc(US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 583 extern uschar *string_open_failed_trc(const uschar *, unsigned,
 584                         const char *, ...) PRINTF_FUNCTION(3,4);
 585
 586 #define string_nextinlist(lp, sp, b, l) \
 587         string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
 588 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
 589                         const uschar * func, int line);
 590
 591 extern int     strcmpic(const uschar *, const uschar *);
 592 extern int     strncmpic(const uschar *, const uschar *, int);
 593 extern uschar *strstric(uschar *, uschar *, BOOL);
 594 extern const uschar *strstric_c(const uschar *, const uschar *, BOOL);
 595
 596 extern int     test_harness_fudged_queue_time(int);
 597 extern void    tcp_init(void);
 598 #ifdef EXIM_TFO_PROBE
 599 extern void    tfo_probe(void);
 600 #endif
 601 extern void    tls_modify_variables(tls_support *);
 602 extern uschar *tod_stamp(int);
 603
 604 extern BOOL    transport_check_waiting(const uschar *, const uschar *, int, uschar *,
 605                  oicf, void*);
 606 extern uschar *transport_current_name(void);
 607 extern void    transport_do_pass_socket(const uschar *, const uschar *,
 608                  const uschar *, uschar *, int);
 609 extern void    transport_init(void);
 610 extern const uschar *transport_rcpt_address(address_item *, BOOL);
 611 extern BOOL    transport_set_up_command(const uschar ***, const uschar *,
 612                  unsigned, int, address_item *, const uschar *, uschar **);
 613 extern void    transport_update_waiting(host_item *, const uschar *);
 614 extern BOOL    transport_write_block(transport_ctx *, uschar *, int, BOOL);
 615 extern void    transport_write_reset(int);
 616 extern BOOL    transport_write_string(int, const char *, ...);
 617 extern BOOL    transport_headers_send(transport_ctx *,
 618                  BOOL (*)(transport_ctx *, const uschar *, int));
 619 extern gstring * transport_show_supported(gstring *);
 620 extern BOOL    transport_write_message(transport_ctx *, int);
 621 extern void    tree_add_duplicate(const uschar *, address_item *);
 622 extern void    tree_add_nonrecipient(const uschar *);
 623 extern void    tree_add_unusable(const host_item *);
 624 extern void    tree_dup(tree_node **, tree_node *);
 625 extern int     tree_insertnode(tree_node **, tree_node *);
 626 extern tree_node *tree_search(tree_node *, const uschar *);
 627 extern void    tree_write(tree_node *, FILE *);
 628 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
 629
 630 #ifdef WITH_CONTENT_SCAN
 631 extern void    unspool_mbox(void);
 632 #endif
 633 #ifdef SUPPORT_I18N
 634 extern gstring *utf8_version_report(gstring *);
 635 #endif
 636
 637 extern int     vaguely_random_number(int);
 638 #ifndef DISABLE_TLS
 639 extern int     vaguely_random_number_fallback(int);
 640 #endif
 641 extern int     verify_address(address_item *, FILE *, int, int, int, int,
 642                  uschar *, uschar *, BOOL *);
 643 extern int     verify_check_dnsbl(int, const uschar **, uschar **);
 644 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
 645                  uschar *, uschar *, int, int *);
 646 extern int     verify_check_headers(uschar **);
 647 extern int     verify_check_header_names_ascii(uschar **);
 648 extern int     verify_check_host(uschar **);
 649 extern int     verify_check_notblind(BOOL);
 650 extern int     verify_check_given_host(const uschar **, const host_item *);
 651 extern int     verify_check_this_host(const uschar **, unsigned int *,
 652                  const uschar*, const uschar *, const uschar **);
 653 extern address_item *verify_checked_sender(const uschar *);
 654 extern void    verify_get_ident(int);
 655 extern void    verify_quota(uschar *);
 656 extern int     verify_quota_call(const uschar *, int, int, uschar **);
 657 extern BOOL    verify_sender(int *, uschar **);
 658 extern BOOL    verify_sender_preliminary(int *, uschar **);
 659 extern void    version_init(void);
 660
 661 extern BOOL    write_chunk(transport_ctx *, const uschar *, int);
 662 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
 663 extern uschar *wrap_header(const uschar *, unsigned, unsigned, const uschar *, unsigned);
 664
 665 #ifdef EXPERIMENTAL_XCLIENT
 666 extern uschar * xclient_smtp_command(uschar *, int *, BOOL *);
 667 extern gstring * xclient_smtp_advertise_str(gstring *);
 668 #endif
 669 extern uschar *xtextencode(uschar *, int);
 670 extern int     xtextdecode(uschar *, uschar **);
 671
 672
 673 /******************************************************************************/
 674 /* Predicate: if an address is in a tainted pool.
 675 By extension, a variable pointing to this address is tainted.
 676 */
 677
 678 static inline BOOL
 679 is_tainted(const void * p)
 680 {
 681 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
 682 return FALSE;
 683
 684 #else
 685 extern BOOL is_tainted_fn(const void *);
 686 return is_tainted_fn(p);
 687 #endif
 688 }
 689
 690 static inline BOOL
 691 is_incompatible(const void * old, const void * new)
 692 {
 693 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
 694 return FALSE;
 695
 696 #else
 697 extern BOOL is_incompatible_fn(const void *, const void *);
 698 return is_incompatible_fn(old, new);
 699 #endif
 700 }
 701
 702 /******************************************************************************/
 703 /* String functions */
 704 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
 705 {
 706 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 707 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
 708 #endif
 709 return US strcat(CS dst, CCS src);
 710 }
 711 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
 712 {
 713 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 714 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
 715 #endif
 716 return US strcpy(CS dst, CCS src);
 717 }
 718 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 719 {
 720 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 721 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
 722 #endif
 723 return US strncat(CS dst, CCS src, n);
 724 }
 725 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 726 {
 727 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 728 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
 729 #endif
 730 return US strncpy(CS dst, CCS src, n);
 731 }
 732 /*XXX will likely need unchecked copy also */
 733
 734
 735 /* Advance the string pointer given over any whitespace.
 736 Return the next char as there's enough places using it to be useful. */
 737
 738 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
 739
 740 static inline uschar skip_whitespace(const uschar ** sp)
 741 { while (isspace(**sp)) (*sp)++; return **sp; }
 742
 743 /* Ditto, non-whitespace */
 744
 745 #define Uskip_nonwhite(sp) skip_nonwhite(CUSS sp)
 746 static inline uschar skip_nonwhite(const uschar ** sp)
 747 { while (**sp && !isspace(**sp)) (*sp)++; return **sp; }
 748
 749
 750 /******************************************************************************/
 751
 752 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
 753 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
 754 chown(<exim-uid>, <exim-gid>).
 755
 756 Probably because the idmapping is broken, misconfigured or set up in
 757 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
 758 case of misconfiguration, or if there are more such broken systems
 759 out, I try to impose as least impact as possible and for now just write
 760 a panic log entry pointing to the bug report. You're encouraged to
 761 contact the developers, if you experience this issue.
 762
 763 fd     the file descriptor (or -1 if not valid)
 764 name   the file name for error messages or for file operations,
 765   if fd is < 0
 766 owner  the owner
 767 group  the group
 768
 769 returns 0 on success, -1 on failure */
 770
 771 static inline int
 772 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
 773 {
 774 return fchown(fd, owner, group)
 775   ? exim_chown_failure(fd, name, owner, group) : 0;
 776 }
 777
 778 static inline int
 779 exim_chown(const uschar *name, uid_t owner, gid_t group)
 780 {
 781 return chown(CCS name, owner, group)
 782   ? exim_chown_failure(-1, name, owner, group) : 0;
 783 }
 784 #endif  /* !MACRO_PREDEF && !COMPILE_UTILITY */
 785
 786 /******************************************************************************/
 787 /* String functions */
 788
 789 #if !defined(MACRO_PREDEF)
 790 /*************************************************
 791 *            Copy and save string                *
 792 *************************************************/
 793
 794 /* This function assumes that memcpy() is faster than strcpy().
 795 The result is explicitly nul-terminated.
 796 */
 797
 798 static inline uschar *
 799 string_copyn_taint_trc(const uschar * s, unsigned len,
 800         const void * proto_mem, const char * func, int line)
 801 {
 802 uschar * ss;
 803 unsigned slen = Ustrlen(s);
 804 if (len > slen) len = slen;
 805 ss = store_get_3(len + 1, proto_mem, func, line);
 806 memcpy(ss, s, len);
 807 ss[len] = '\0';
 808 return ss;
 809 }
 810
 811 static inline uschar *
 812 string_copy_taint_trc(const uschar * s, const void * proto_mem, const char * func, int line)
 813 { return string_copyn_taint_trc(s, Ustrlen(s), proto_mem, func, line); }
 814
 815 static inline uschar *
 816 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
 817 { return string_copyn_taint_trc(s, len, s, func, line); }
 818 static inline uschar *
 819 string_copy_trc(const uschar * s, const char * func, int line)
 820 { return string_copy_taint_trc(s, s, func, line); }
 821
 822
 823 /* String-copy functions explicitly setting the taint status */
 824
 825 #define string_copyn_taint(s, len, proto_mem) \
 826         string_copyn_taint_trc((s), (len), (proto_mem), __FUNCTION__, __LINE__)
 827 #define string_copy_taint(s, proto_mem) \
 828         string_copy_taint_trc((s), (proto_mem), __FUNCTION__, __LINE__)
 829
 830 /* Simple string-copy functions maintaining the taint */
 831
 832 #define string_copyn(s, len) \
 833         string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
 834 #define string_copy(s) \
 835         string_copy_trc((s), __FUNCTION__, __LINE__)
 836
 837
 838 /*************************************************
 839 *       Copy, lowercase and save string          *
 840 *************************************************/
 841
 842 /*
 843 Argument: string to copy
 844 Returns:  copy of string in new store, with letters lowercased
 845 */
 846
 847 static inline uschar *
 848 string_copylc(const uschar * s)
 849 {
 850 uschar * ss = store_get(Ustrlen(s) + 1, s);
 851 uschar * p = ss;
 852 while (*s) *p++ = tolower(*s++);
 853 *p = 0;
 854 return ss;
 855 }
 856
 857
 858
 859 /*************************************************
 860 * Copy, lowercase, and save string, given length *
 861 *************************************************/
 862
 863 /* It is assumed the data contains no zeros. A zero is added
 864 onto the end.
 865
 866 Arguments:
 867   s         string to copy
 868   n         number of characters
 869
 870 Returns:    copy of string in new store, with letters lowercased
 871 */
 872
 873 static inline uschar *
 874 string_copynlc(uschar * s, int n)
 875 {
 876 uschar * ss = store_get(n + 1, s);
 877 uschar * p = ss;
 878 while (n-- > 0) *p++ = tolower(*s++);
 879 *p = 0;
 880 return ss;
 881 }
 882
 883
 884 # ifndef COMPILE_UTILITY
 885 /*************************************************
 886 *     Copy and save string in longterm store     *
 887 *************************************************/
 888
 889 /* This function assumes that memcpy() is faster than strcpy().
 890
 891 Argument: string to copy
 892 Returns:  copy of string in new store
 893 */
 894
 895 static inline uschar *
 896 string_copy_perm(const uschar *s, BOOL force_taint)
 897 {
 898 int old_pool = store_pool;
 899 int len = Ustrlen(s) + 1;
 900 uschar *ss;
 901
 902 store_pool = POOL_PERM;
 903 ss = store_get(len, force_taint ? GET_TAINTED : s);
 904 memcpy(ss, s, len);
 905 store_pool = old_pool;
 906 return ss;
 907 }
 908 # endif
 909
 910
 911
 912 /* sprintf into a buffer, taint-unchecked */
 913
 914 static inline void
 915 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
 916 {
 917 gstring gs = { .size = siz, .ptr = 0, .s = buf };
 918 va_list ap;
 919 va_start(ap, fmt);
 920 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
 921 va_end(ap);
 922 }
 923
 924
 925
 926 /******************************************************************************/
 927 /* Growable-string functions */
 928
 929 /* Create a growable-string with some preassigned space */
 930
 931 #define string_get_tainted(size, proto_mem) \
 932         string_get_tainted_trc((size), (proto_mem), __FUNCTION__, __LINE__)
 933
 934 static inline gstring *
 935 string_get_tainted_trc(unsigned size, const void * proto_mem, const char * func, unsigned line)
 936 {
 937 gstring * g = store_get_3(sizeof(gstring) + size, proto_mem, func, line);
 938 g->size = size;         /*XXX would be good if we could see the actual alloc size */
 939 g->ptr = 0;
 940 g->s = US(g + 1);
 941 return g;
 942 }
 943
 944 #define string_get(size) \
 945         string_get_trc((size), __FUNCTION__, __LINE__)
 946
 947 static inline gstring *
 948 string_get_trc(unsigned size, const char * func, unsigned line)
 949 {
 950 return string_get_tainted_trc(size, GET_UNTAINTED, func, line);
 951 }
 952
 953 /* NUL-terminate the C string in the growable-string, and return it. */
 954
 955 static inline uschar *
 956 string_from_gstring(gstring * g)
 957 {
 958 if (!g) return NULL;
 959 g->s[g->ptr] = '\0';
 960 return g->s;
 961 }
 962
 963 static inline int
 964 len_string_from_gstring(gstring * g, uschar ** sp)
 965 {
 966 if (g)
 967   {
 968   *sp = g->s;
 969   g->s[g->ptr] = '\0';
 970   return g->ptr;
 971   }
 972 else
 973   {
 974   *sp = NULL;
 975   return 0;
 976   }
 977 }
 978
 979 static inline uschar *
 980 string_copy_from_gstring(gstring * g)
 981 {
 982 return g ? string_copyn(g->s, g->ptr) : NULL;
 983 }
 984
 985 static inline unsigned
 986 gstring_length(const gstring * g)
 987 {
 988 return g ? (unsigned)g->ptr : 0;
 989 }
 990
 991 static inline uschar
 992 gstring_last_char(gstring * g)
 993 {
 994 return g && g->ptr > 0 ? g->s[g->ptr-1] : '\0';
 995 }
 996
 997 static inline void
 998 gstring_trim(gstring * g, unsigned amount)
 999 {
1000 g->ptr -= amount;
1001 }
1002
1003 static inline void
1004 gstring_trim_trailing(gstring * g, uschar c)
1005 {
1006 if (gstring_last_char(g) == c) gstring_trim(g, 1);
1007 }
1008
1009 static inline void
1010 gstring_reset(gstring * g)
1011 {
1012 g->ptr = 0;
1013 }
1014
1015
1016 #define gstring_release_unused(g) \
1017         gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
1018
1019 static inline void
1020 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
1021 {
1022 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
1023 }
1024
1025
1026 /* plain string append to a growable-string */
1027
1028 static inline gstring * string_cat(gstring * g, const uschar * s)
1029  WARN_UNUSED_RESULT;
1030
1031 static inline gstring *
1032 string_cat(gstring * g, const uschar * s)
1033 {
1034 return string_catn(g, s, Ustrlen(s));
1035 }
1036
1037
1038 /* sprintf-append to a growable-string */
1039
1040 #define string_fmt_append(g, fmt, ...) \
1041         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
1042         SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
1043
1044 #define string_fmt_append_f(g, flgs, fmt, ...) \
1045         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
1046         flgs,         fmt, __VA_ARGS__)
1047
1048 static inline gstring *
1049 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
1050   unsigned flags, const char *format, ...)
1051 {
1052 va_list ap;
1053 va_start(ap, format);
1054 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
1055                         flags, format, ap);
1056 va_end(ap);
1057 return g;
1058 }
1059
1060
1061 /* Copy the content of a string to tainted memory.  The proto_mem arg
1062 will always be tainted, and suitable as a prototype. */
1063
1064 static inline void
1065 gstring_rebuffer(gstring * g, const void * proto_mem)
1066 {
1067 uschar * s = store_get_3(g->size, proto_mem, __FUNCTION__, __LINE__);
1068 memcpy(s, g->s, g->ptr);
1069 g->s = s;
1070 }
1071
1072 /* Append one gstring to another */
1073
1074 static inline gstring *
1075 gstring_append(gstring * dest, gstring * item)
1076 {
1077 return item ? string_catn(dest, item->s, item->ptr) : dest;
1078 }
1079
1080
1081 # ifndef COMPILE_UTILITY
1082 /******************************************************************************/
1083 /* Use store_malloc for DNSA structs, and explicit frees. Using the same pool
1084 for them as the strings we proceed to copy from them meant they could not be
1085 released, hence blowing 64k for every DNS lookup. That mounted up. With malloc
1086 we do have to take care over marking tainted all copied strings.  A separate pool
1087 could be used and would handle that implicitly. */
1088
1089 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
1090
1091 static inline dns_answer *
1092 store_get_dns_answer_trc(const uschar * func, unsigned line)
1093 {
1094 return store_malloc_3(sizeof(dns_answer), CCS func, line);
1095 }
1096
1097 #define store_free_dns_answer(dnsa) store_free_dns_answer_trc(dnsa, CUS __FUNCTION__, __LINE__)
1098
1099 static inline void
1100 store_free_dns_answer_trc(dns_answer * dnsa, const uschar * func, unsigned line)
1101 {
1102 store_free_3(dnsa, CCS func, line);
1103 }
1104
1105
1106 /* Check for an RR being large enough.  Return TRUE iff bad. */
1107 static inline BOOL
1108 rr_bad_size(const dns_record * rr, size_t minbytes)
1109 {
1110 return rr->size < minbytes;
1111 }
1112
1113 /* Check for an RR having further data beyond a given pointer.
1114 Return TRUE iff bad. */
1115 static inline BOOL
1116 rr_bad_increment(const dns_record * rr, const uschar * ptr, size_t minbytes)
1117 {
1118 return rr_bad_size(rr, ptr - rr->data + minbytes);
1119 }
1120
1121 /******************************************************************************/
1122 /* Routines with knowledge of spool layout */
1123
1124 static inline void
1125 spool_pname_buf(uschar * buf, int len)
1126 {
1127 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
1128 }
1129
1130 static inline uschar *
1131 spool_dname(const uschar * purpose, uschar * subdir)
1132 {
1133 return string_sprintf("%s/%s/%s/%s",
1134         spool_directory, queue_name, purpose, subdir);
1135 }
1136 # endif
1137
1138 static inline uschar *
1139 spool_q_sname(const uschar * purpose, const uschar * q, const uschar * subdir)
1140 {
1141 return string_sprintf("%s%s%s%s%s",
1142                     q, *q ? "/" : "",
1143                     purpose,
1144                     *subdir ? "/" : "", subdir);
1145 }
1146
1147 static inline uschar *
1148 spool_sname(const uschar * purpose, const uschar * subdir)
1149 {
1150 return spool_q_sname(purpose, queue_name, subdir);
1151 }
1152
1153 static inline uschar *
1154 spool_q_fname(const uschar * purpose, const uschar * q,
1155         const uschar * subdir, const uschar * fname, const uschar * suffix)
1156 {
1157 return string_sprintf("%s/%s/%s/%s/%s%s",
1158         spool_directory, q, purpose, subdir, fname, suffix);
1159 }
1160
1161 static inline uschar *
1162 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1163         const uschar * suffix)
1164 {
1165 #ifdef COMPILE_UTILITY          /* version avoiding string-extension */
1166 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1167         + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1168 uschar * buf = store_get(len, GET_UNTAINTED);
1169 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1170         spool_directory, queue_name, purpose, subdir, fname, suffix);
1171 return buf;
1172 #else
1173 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1174 #endif
1175 }
1176
1177 static inline void
1178 set_subdir_str(uschar * subdir_str, const uschar * name,
1179         int search_sequence)
1180 {
1181 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1182        ? name[MESSAGE_ID_TIME_LEN-1] : '\0';
1183 subdir_str[1] = '\0';
1184 }
1185
1186 /******************************************************************************/
1187 /* Message-ID format transition knowlege */
1188
1189 static inline BOOL
1190 is_new_message_id(const uschar * id)
1191 {
1192 return id[MESSAGE_ID_TIME_LEN + 1 + MESSAGE_ID_PID_LEN] == '-';
1193 }
1194
1195 static inline BOOL
1196 is_old_message_id(const uschar * id)
1197 {
1198 return id[MESSAGE_ID_TIME_LEN + 1 + MESSAGE_ID_PID_LEN_OLD] == '-';
1199 }
1200
1201 static inline unsigned
1202 spool_data_start_offset(const uschar * id)
1203 {
1204 if (is_old_message_id(id)) return SPOOL_DATA_START_OFFSET_OLD;
1205 return SPOOL_DATA_START_OFFSET;
1206 }
1207
1208 /******************************************************************************/
1209 /* Time calculations */
1210
1211 /* Diff two times (later, earlier) returning diff in 1st arg */
1212 static inline void
1213 timediff(struct timeval * later, const struct timeval * earlier)
1214 {
1215 later->tv_sec -= earlier->tv_sec;
1216 if ((later->tv_usec -= earlier->tv_usec) < 0)
1217   {
1218   later->tv_sec--;
1219   later->tv_usec += 1000*1000;
1220   }
1221 }
1222
1223 static inline void
1224 timesince(struct timeval * diff, const struct timeval * then)
1225 {
1226 gettimeofday(diff, NULL);
1227 timediff(diff, then);
1228 }
1229
1230 static inline uschar *
1231 string_timediff(const struct timeval * diff)
1232 {
1233 static uschar buf[16];
1234
1235 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1236   return readconf_printtime((int)diff->tv_sec);
1237
1238 snprintf(CS buf, sizeof(buf), "%u.%03us",
1239           (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1240 return buf;
1241 }
1242
1243
1244 static inline uschar *
1245 string_timesince(const struct timeval * then)
1246 {
1247 struct timeval diff;
1248 timesince(&diff, then);
1249 return string_timediff(&diff);
1250 }
1251
1252 static inline void
1253 report_time_since(const struct timeval * t0, const uschar * where)
1254 {
1255 # ifdef MEASURE_TIMING
1256 struct timeval diff;
1257 timesince(&diff, t0);
1258 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1259        (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1260 # endif
1261 }
1262
1263
1264 static inline void
1265 testharness_pause_ms(int millisec)
1266 {
1267 #ifndef MEASURE_TIMING
1268 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1269 #endif
1270 }
1271
1272 /******************************************************************************/
1273 /* Taint-checked file opens. Return values/errno per open(2). */
1274
1275 static inline int
1276 exim_open2(const char *pathname, int flags)
1277 {
1278 if (!is_tainted(pathname)) return open(pathname, flags);
1279 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1280 errno = EACCES;
1281 return -1;
1282 }
1283 static inline int
1284 exim_open(const char *pathname, int flags, mode_t mode)
1285 {
1286 if (!is_tainted(pathname)) return open(pathname, flags, mode);
1287 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1288 errno = EACCES;
1289 return -1;
1290 }
1291 #ifdef EXIM_HAVE_OPENAT
1292 static inline int
1293 exim_openat(int dirfd, const char *pathname, int flags)
1294 {
1295 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
1296 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1297 errno = EACCES;
1298 return -1;
1299 }
1300 static inline int
1301 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1302 {
1303 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
1304 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1305 errno = EACCES;
1306 return -1;
1307 }
1308 #endif
1309
1310 static inline FILE *
1311 exim_fopen(const char *pathname, const char *mode)
1312 {
1313 if (!is_tainted(pathname)) return fopen(pathname, mode);
1314 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1315 errno = EACCES;
1316 return NULL;
1317 }
1318
1319 static inline DIR *
1320 exim_opendir(const uschar * name)
1321 {
1322 if (!is_tainted(name)) return opendir(CCS name);
1323 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name);
1324 errno = EACCES;
1325 return NULL;
1326 }
1327
1328 /******************************************************************************/
1329 # if !defined(COMPILE_UTILITY)
1330
1331 /* We use the PID of the head process for a connection-id.  Note that
1332 this is only for tracking a received connection and what it directly
1333 causes; there is no inttent to describe transport-initiated TCP connections.
1334 The value is intented to be a cookie usable for logging, and we might change
1335 the generator for it at any time. */
1336
1337 static inline void
1338 set_connection_id(void)
1339 {
1340 connection_id = string_sprintf("%lu", (u_long)getpid());
1341 }
1342
1343
1344 /* Process manipulation */
1345
1346 static inline pid_t
1347 exim_fork(const unsigned char * purpose)
1348 {
1349 pid_t pid;
1350 DEBUG(D_any)
1351   debug_printf_indent("%s forking for %s\n", process_purpose, purpose);
1352 if ((pid = fork()) == 0)
1353   {
1354   f.daemon_listen = FALSE;
1355   process_purpose = purpose;
1356   DEBUG(D_any) debug_printf_indent("postfork: %s\n", purpose);
1357   }
1358 else
1359   {
1360   testharness_pause_ms(100); /* let child work */
1361   DEBUG(D_any) debug_printf_indent("%s forked for %s: %d\n",
1362                                   process_purpose, purpose, (int)pid);
1363   }
1364 return pid;
1365 }
1366
1367
1368 static inline pid_t
1369 child_open_exim(int * fdptr, const uschar * purpose)
1370 { return child_open_exim_function(fdptr, purpose); }
1371
1372 static inline pid_t
1373 child_open_exim2(int * fdptr, uschar * sender,
1374   uschar * sender_auth, const uschar * purpose)
1375 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1376
1377 static inline pid_t
1378 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1379   int *outfdptr, BOOL make_leader, const uschar * purpose)
1380 { return child_open_function(argv, envp, newumask, infdptr,
1381   outfdptr, make_leader, purpose);
1382 }
1383
1384 /* Return 1 if fd is usable per pollbits, else 0 */
1385 static inline int
1386 poll_one_fd(int fd, short pollbits, int tmo_millisec)
1387 {
1388 struct pollfd p = {.fd = fd, .events = pollbits};
1389 return poll(&p, 1, tmo_millisec);
1390 }
1391
1392 /******************************************************************************/
1393 /* Client-side smtp log string, for debug */
1394
1395 static inline void
1396 smtp_debug_cmd_log_init(void)
1397 {
1398 #  ifndef DISABLE_CLIENT_CMD_LOG
1399 int old_pool = store_pool;
1400 store_pool = POOL_PERM;
1401 client_cmd_log = string_get_tainted(56, GET_TAINTED);
1402 *client_cmd_log->s = '\0';
1403 store_pool = old_pool;
1404 #  endif
1405 }
1406
1407
1408 static inline void
1409 smtp_debug_cmd(const uschar * buf, int mode)
1410 {
1411 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent("  SMTP%c> %s\n",
1412   mode == SCMD_BUFFER ? '|' : mode == SCMD_MORE ? '+' : '>', buf);
1413
1414 #  ifndef DISABLE_CLIENT_CMD_LOG
1415   {
1416   int len = Ustrcspn(buf, " \n"), old_pool = store_pool;
1417   store_pool = POOL_PERM;       /* Main pool ACL allocations eg. callouts get released */
1418   client_cmd_log = string_append_listele_n(client_cmd_log, ':', buf, MIN(len, 8));
1419   if (mode == SCMD_BUFFER)
1420     client_cmd_log = string_catn(client_cmd_log, US"|", 1);
1421   else if (mode == SCMD_MORE)
1422     client_cmd_log = string_catn(client_cmd_log, US"+", 1);
1423   store_pool = old_pool;
1424   }
1425 #  endif
1426 }
1427
1428
1429 /* This might be called both due to callout and then from delivery.
1430 Use memory that will not be released between those phases.
1431 */
1432 static inline void
1433 smtp_debug_resp(const uschar * buf)
1434 {
1435 #  ifndef DISABLE_CLIENT_CMD_LOG
1436 int old_pool = store_pool;
1437 store_pool = POOL_PERM;
1438 client_cmd_log = string_append_listele_n(client_cmd_log, ':', buf,
1439   buf[3] == '-' ? 4 : 3);
1440 store_pool = old_pool;
1441 #  endif
1442 }
1443
1444
1445 static inline void
1446 smtp_debug_cmd_report(void)
1447 {
1448 #  ifndef DISABLE_CLIENT_CMD_LOG
1449 if (client_cmd_log && *client_cmd_log->s)
1450   {
1451   debug_printf("cmdlog: '%Y'\n", client_cmd_log);
1452   gstring_reset(client_cmd_log);
1453   }
1454 else
1455   debug_printf("cmdlog: (unset)\n");
1456 #  endif
1457 }
1458
1459
1460
1461 static inline int
1462 expand_max_rcpt(const uschar * str_max_rcpt)
1463 {
1464 const uschar * s = expand_cstring(str_max_rcpt);
1465 int res;
1466 return !s || !*s || (res = Uatoi(s)) == 0 ? UNLIMITED_ADDRS : res;
1467 }
1468
1469 /******************************************************************************/
1470 /* Queue-runner operations */
1471
1472 static inline BOOL
1473 is_onetime_qrun(void)
1474 {
1475 return qrunners && !qrunners->next && qrunners->interval == 0;
1476 }
1477
1478 static inline BOOL
1479 is_multiple_qrun(void)
1480 {
1481 return qrunners && (qrunners->interval > 0 || qrunners->next);
1482 }
1483
1484
1485 # endif /* !COMPILE_UTILITY */
1486
1487 /******************************************************************************/
1488 #endif  /* !MACRO_PREDEF */
1489
1490 #endif  /* _FUNCTIONS_H_ */
1491
1492 /* vi: aw ai sw=2
1493 */
1494 /* End of functions.h */