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