src/src/functions.h

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