2 * Copyright (c) 1998-2009, 2011, 2012 Sendmail, Inc. and its suppliers.
4 * Copyright (c) 1983, 1995-1997 Eric P. Allman. All rights reserved.
5 * Copyright (c) 1988, 1993
6 * The Regents of the University of California. All rights reserved.
8 * By using this file, you agree to the terms and conditions set
9 * forth in the LICENSE file which can be found at the top level of
10 * the sendmail distribution.
17 SM_RCSID("@(#)$Id: queue.c,v 8.998 2013/03/12 15:24:53 ca Exp $")
21 # define RELEASE_QUEUE (void) 0
22 # define ST_INODE(st) (st).st_ino
24 # define sm_file_exists(errno) ((errno) == EEXIST)
26 # if HASFLOCK && defined(O_EXLOCK)
27 # define SM_OPEN_EXLOCK 1
28 # define TF_OPEN_FLAGS (O_CREAT|O_WRONLY|O_EXCL|O_EXLOCK)
29 # else /* HASFLOCK && defined(O_EXLOCK) */
30 # define TF_OPEN_FLAGS (O_CREAT|O_WRONLY|O_EXCL)
31 # endif /* HASFLOCK && defined(O_EXLOCK) */
33 #ifndef SM_OPEN_EXLOCK
34 # define SM_OPEN_EXLOCK 0
35 #endif /* ! SM_OPEN_EXLOCK */
39 ** QF_VERSION == 4 was sendmail 8.10/8.11 without _FFR_QUEUEDELAY
40 ** QF_VERSION == 5 was sendmail 8.10/8.11 with _FFR_QUEUEDELAY
41 ** QF_VERSION == 6 was sendmail 8.12 without _FFR_QUEUEDELAY
42 ** QF_VERSION == 7 was sendmail 8.12 with _FFR_QUEUEDELAY
43 ** QF_VERSION == 8 is sendmail 8.13
46 #define QF_VERSION 8 /* version number of this queue format */
48 static char queue_letter __P((ENVELOPE *, int));
49 static bool quarantine_queue_item __P((int, int, ENVELOPE *, char *));
51 /* Naming convention: qgrp: index of queue group, qg: QUEUEGROUP */
59 char *w_name; /* name of control file */
60 char *w_host; /* name of recipient host */
61 bool w_lock; /* is message locked? */
62 bool w_tooyoung; /* is it too young to run? */
63 long w_pri; /* priority of message, see below */
64 time_t w_ctime; /* creation time */
65 time_t w_mtime; /* modification time */
66 int w_qgrp; /* queue group located in */
67 int w_qdir; /* queue directory located in */
68 struct work *w_next; /* next in queue */
71 typedef struct work WORK;
73 static WORK *WorkQ; /* queue of things to be done */
74 static int NumWorkGroups; /* number of work groups */
75 static time_t Current_LA_time = 0;
77 /* Get new load average every 30 seconds. */
78 #define GET_NEW_LA_TIME 30
80 #define SM_GET_LA(now) \
84 if (Current_LA_time < now - GET_NEW_LA_TIME) \
87 Current_LA_time = now; \
92 ** DoQueueRun indicates that a queue run is needed.
93 ** Notice: DoQueueRun is modified in a signal handler!
96 static bool volatile DoQueueRun; /* non-interrupt time queue run needed */
99 ** Work group definition structure.
100 ** Each work group contains one or more queue groups. This is done
101 ** to manage the number of queue group runners active at the same time
102 ** to be within the constraints of MaxQueueChildren (if it is set).
103 ** The number of queue groups that can be run on the next work run
104 ** is kept track of. The queue groups are run in a round robin.
109 int wg_numqgrp; /* number of queue groups in work grp */
110 int wg_runners; /* total runners */
111 int wg_curqgrp; /* current queue group */
112 QUEUEGRP **wg_qgs; /* array of queue groups */
113 int wg_maxact; /* max # of active runners */
114 time_t wg_lowqintvl; /* lowest queue interval */
115 int wg_restart; /* needs restarting? */
116 int wg_restartcnt; /* count of times restarted */
119 typedef struct workgrp WORKGRP;
121 static WORKGRP volatile WorkGrp[MAXWORKGROUPS + 1]; /* work groups */
124 static SM_DEBUG_T DebugLeakQ = SM_DEBUG_INITIALIZER("leak_q",
125 "@(#)$Debug: leak_q - trace memory leaks during queue processing $");
126 #endif /* SM_HEAP_CHECK */
129 ** We use EmptyString instead of "" to avoid
130 ** 'zero-length format string' warnings from gcc
133 static const char EmptyString[] = "";
135 static void grow_wlist __P((int, int));
136 static int multiqueue_cache __P((char *, int, QUEUEGRP *, int, unsigned int *));
137 static int gatherq __P((int, int, bool, bool *, bool *, int *));
138 static int sortq __P((int));
139 static void printctladdr __P((ADDRESS *, SM_FILE_T *));
140 static bool readqf __P((ENVELOPE *, bool));
141 static void restart_work_group __P((int));
142 static void runner_work __P((ENVELOPE *, int, bool, int, int));
143 static void schedule_queue_runs __P((bool, int, bool));
144 static char *strrev __P((char *));
145 static ADDRESS *setctluser __P((char *, int, ENVELOPE *));
147 static int sm_strshufflecmp __P((char *, char *));
148 static void init_shuffle_alphabet __P(());
149 #endif /* _FFR_RHS */
152 ** Note: workcmpf?() don't use a prototype because it will cause a conflict
153 ** with the qsort() call (which expects something like
154 ** int (*compar)(const void *, const void *), not (WORK *, WORK *))
157 static int workcmpf0();
158 static int workcmpf1();
159 static int workcmpf2();
160 static int workcmpf3();
161 static int workcmpf4();
162 static int randi = 3; /* index for workcmpf5() */
163 static int workcmpf5();
164 static int workcmpf6();
166 static int workcmpf7();
167 #endif /* _FFR_RHS */
170 # define get_rand_mod(m) ((get_random() >> RANDOMSHIFT) % (m))
171 #else /* RANDOMSHIFT */
172 # define get_rand_mod(m) (get_random() % (m))
173 #endif /* RANDOMSHIFT */
176 ** File system definition.
177 ** Used to keep track of how much free space is available
178 ** on a file system in which one or more queue directories reside.
181 typedef struct filesys_shared FILESYS;
183 struct filesys_shared
185 dev_t fs_dev; /* unique device id */
186 long fs_avail; /* number of free blocks available */
187 long fs_blksize; /* block size, in bytes */
190 /* probably kept in shared memory */
191 static FILESYS FileSys[MAXFILESYS]; /* queue file systems */
192 static const char *FSPath[MAXFILESYS]; /* pathnames for file systems */
197 ** Shared memory data
200 ** size -- size of shared memory segment
201 ** pid -- pid of owner, should be a unique id to avoid misinterpretations
202 ** by other processes.
203 ** tag -- should be a unique id to avoid misinterpretations by others.
204 ** idea: hash over configuration data that will be stored here.
205 ** NumFileSys -- number of file systems.
206 ** FileSys -- (array of) structure for used file systems.
207 ** RSATmpCnt -- counter for number of uses of ephemeral RSA key.
208 ** QShm -- (array of) structure for information about queue directories.
212 ** Queue data in shared memory
215 typedef struct queue_shared QUEUE_SHM_T;
219 int qs_entries; /* number of entries */
220 /* XXX more to follow? */
223 static void *Pshm; /* pointer to shared memory */
224 static FILESYS *PtrFileSys; /* pointer to queue file system array */
225 int ShmId = SM_SHM_NO_ID; /* shared memory id */
226 static QUEUE_SHM_T *QShm; /* pointer to shared queue data */
229 # define SHM_OFF_PID(p) (((char *) (p)) + sizeof(int))
230 # define SHM_OFF_TAG(p) (((char *) (p)) + sizeof(pid_t) + sizeof(int))
231 # define SHM_OFF_HEAD (sizeof(pid_t) + sizeof(int) * 2)
233 /* how to access FileSys */
234 # define FILE_SYS(i) (PtrFileSys[i])
236 /* first entry is a tag, for now just the size */
237 # define OFF_FILE_SYS(p) (((char *) (p)) + SHM_OFF_HEAD)
239 /* offset for PNumFileSys */
240 # define OFF_NUM_FILE_SYS(p) (((char *) (p)) + SHM_OFF_HEAD + sizeof(FileSys))
242 /* offset for PRSATmpCnt */
243 # define OFF_RSA_TMP_CNT(p) (((char *) (p)) + SHM_OFF_HEAD + sizeof(FileSys) + sizeof(int))
246 /* offset for queue_shm */
247 # define OFF_QUEUE_SHM(p) (((char *) (p)) + SHM_OFF_HEAD + sizeof(FileSys) + sizeof(int) * 2)
249 # define QSHM_ENTRIES(i) QShm[i].qs_entries
251 /* basic size of shared memory segment */
252 # define SM_T_SIZE (SHM_OFF_HEAD + sizeof(FileSys) + sizeof(int) * 2)
254 static unsigned int hash_q __P((char *, unsigned int));
257 ** HASH_Q -- simple hash function
260 ** p -- string to hash.
261 ** h -- hash start value (from previous run).
279 h += (c<<11) ^ (c>>1);
280 h ^= (d<<14) + (d<<7) + (d<<4) + d;
286 #else /* SM_CONF_SHM */
287 # define FILE_SYS(i) FileSys[i]
288 #endif /* SM_CONF_SHM */
290 /* access to the various components of file system data */
291 #define FILE_SYS_NAME(i) FSPath[i]
292 #define FILE_SYS_AVAIL(i) FILE_SYS(i).fs_avail
293 #define FILE_SYS_BLKSIZE(i) FILE_SYS(i).fs_blksize
294 #define FILE_SYS_DEV(i) FILE_SYS(i).fs_dev
298 ** Current qf file field assignments:
302 ** C controlling user
304 ** d data file directory name (added in 8.12)
307 ** G free (was: queue delay algorithm if _FFR_QUEUEDELAY)
309 ** I data file's inode number
310 ** K time of last delivery attempt
311 ** L Solaris Content-Length: header (obsolete)
313 ** N number of delivery attempts
314 ** P message priority
315 ** q quarantine reason
316 ** Q original recipient (ORCPT=)
317 ** r final recipient (Final-Recipient: DSN field)
321 ** V queue file version
322 ** X free (was: character set if _FFR_SAVE_CHARSET)
323 ** Y free (was: current delay if _FFR_QUEUEDELAY)
324 ** Z original envelope id from ESMTP
325 ** ! deliver by (added in 8.12)
331 ** QUEUEUP -- queue a message up for future transmission.
334 ** e -- the envelope to queue up.
335 ** announce -- if true, tell when you are queueing up.
336 ** msync -- if true, then fsync() if SuperSafe interactive mode.
342 ** The current request is saved in a control file.
343 ** The queue file is left locked.
347 queueup(e, announce, msync)
348 register ENVELOPE *e;
352 register SM_FILE_T *tfp;
367 ** Create control file.
372 MODE_T oldumask = 0; \
374 if (bitset(S_IWGRP, QueueFileMode)) \
375 oldumask = umask(002); \
376 tfd = open(tf, TF_OPEN_FLAGS, QueueFileMode); \
377 if (bitset(S_IWGRP, QueueFileMode)) \
378 (void) umask(oldumask); \
382 newid = (e->e_id == NULL) || !bitset(EF_INQUEUE, e->e_flags);
383 (void) sm_strlcpy(tf, queuename(e, NEWQFL_LETTER), sizeof(tf));
385 if (tfp == NULL && newid)
388 ** open qf file directly: this will give an error if the file
389 ** already exists and hence prevent problems if a queue-id
390 ** is reused (e.g., because the clock is set back).
393 (void) sm_strlcpy(tf, queuename(e, ANYQFL_LETTER), sizeof(tf));
397 !lockfile(tfd, tf, NULL, LOCK_EX|LOCK_NB) ||
398 #endif /* !SM_OPEN_EXLOCK */
399 (tfp = sm_io_open(SmFtStdiofd, SM_TIME_DEFAULT,
400 (void *) &tfd, SM_IO_WRONLY,
403 int save_errno = errno;
407 syserr("!queueup: cannot create queue file %s, euid=%d, fd=%d, fp=%p",
408 tf, (int) geteuid(), tfd, tfp);
412 upd_qs(e, 1, 0, "queueup");
415 /* if newid, write the queue file directly (instead of temp file) */
418 /* get a locked tf file */
419 for (i = 0; i < 128; i++)
428 if (LogLevel > 0 && (i % 32) == 0)
429 sm_syslog(LOG_ALERT, e->e_id,
430 "queueup: cannot create %s, euid=%d: %s",
432 sm_errstring(errno));
437 #endif /* SM_OPEN_EXLOCK */
442 /* file is locked by open() */
444 #else /* SM_OPEN_EXLOCK */
445 if (lockfile(tfd, tf, NULL, LOCK_EX|LOCK_NB))
448 #endif /* SM_OPEN_EXLOCK */
449 if (LogLevel > 0 && (i % 32) == 0)
450 sm_syslog(LOG_ALERT, e->e_id,
451 "queueup: cannot lock %s: %s",
452 tf, sm_errstring(errno));
462 /* save the old temp file away */
463 (void) rename(tf, queuename(e, TEMPQF_LETTER));
466 (void) sleep(i % 32);
468 if (tfd < 0 || (tfp = sm_io_open(SmFtStdiofd, SM_TIME_DEFAULT,
469 (void *) &tfd, SM_IO_WRONLY_B,
472 int save_errno = errno;
476 syserr("!queueup: cannot create queue temp file %s, uid=%d",
477 tf, (int) geteuid());
482 sm_dprintf("\n>>>>> queueing %s/%s%s >>>>>\n",
483 qid_printqueue(e->e_qgrp, e->e_qdir),
484 queuename(e, ANYQFL_LETTER),
485 newid ? " (new id)" : "");
488 sm_dprintf(" e_flags=");
493 sm_dprintf(" sendq=");
494 printaddr(sm_debug_file(), e->e_sendqueue, true);
499 dumpfd(sm_io_getinfo(tfp, SM_IO_WHAT_FD, NULL), true, false);
500 sm_dprintf(" lockfp=");
501 if (e->e_lockfp == NULL)
502 sm_dprintf("NULL\n");
504 dumpfd(sm_io_getinfo(e->e_lockfp, SM_IO_WHAT_FD, NULL),
509 ** If there is no data file yet, create one.
512 (void) sm_strlcpy(df, queuename(e, DATAFL_LETTER), sizeof(df));
513 if (bitset(EF_HAS_DF, e->e_flags))
515 if (e->e_dfp != NULL &&
516 SuperSafe != SAFE_REALLY &&
517 SuperSafe != SAFE_REALLY_POSTMILTER &&
518 sm_io_setinfo(e->e_dfp, SM_BF_COMMIT, NULL) < 0 &&
521 syserr("!queueup: cannot commit data file %s, uid=%d",
522 queuename(e, DATAFL_LETTER), (int) geteuid());
524 if (e->e_dfp != NULL &&
525 SuperSafe == SAFE_INTERACTIVE && msync)
528 sm_syslog(LOG_INFO, e->e_id,
529 "queueup: fsync(e->e_dfp)");
531 if (fsync(sm_io_getinfo(e->e_dfp, SM_IO_WHAT_FD,
535 syserr("!552 Error writing data file %s",
538 syserr("!452 Error writing data file %s",
547 register SM_FILE_T *dfp = NULL;
550 if (e->e_dfp != NULL &&
551 sm_io_getinfo(e->e_dfp, SM_IO_WHAT_ISTYPE, BF_FILE_TYPE))
552 syserr("committing over bf file");
554 if (bitset(S_IWGRP, QueueFileMode))
555 oldumask = umask(002);
556 dfd = open(df, O_WRONLY|O_CREAT|O_TRUNC|QF_O_EXTRA,
558 if (bitset(S_IWGRP, QueueFileMode))
559 (void) umask(oldumask);
560 if (dfd < 0 || (dfp = sm_io_open(SmFtStdiofd, SM_TIME_DEFAULT,
561 (void *) &dfd, SM_IO_WRONLY_B,
563 syserr("!queueup: cannot create data temp file %s, uid=%d",
564 df, (int) geteuid());
565 if (fstat(dfd, &stbuf) < 0)
569 e->e_dfdev = stbuf.st_dev;
570 e->e_dfino = ST_INODE(stbuf);
572 e->e_flags |= EF_HAS_DF;
573 memset(&mcibuf, '\0', sizeof(mcibuf));
574 mcibuf.mci_out = dfp;
575 mcibuf.mci_mailer = FileMailer;
576 (*e->e_putbody)(&mcibuf, e, NULL);
578 if (SuperSafe == SAFE_REALLY ||
579 SuperSafe == SAFE_REALLY_POSTMILTER ||
580 (SuperSafe == SAFE_INTERACTIVE && msync))
583 sm_syslog(LOG_INFO, e->e_id,
584 "queueup: fsync(dfp)");
586 if (fsync(sm_io_getinfo(dfp, SM_IO_WHAT_FD, NULL)) < 0)
589 syserr("!552 Error writing data file %s",
592 syserr("!452 Error writing data file %s",
597 if (sm_io_close(dfp, SM_TIME_DEFAULT) < 0)
598 syserr("!queueup: cannot save data temp file %s, uid=%d",
599 df, (int) geteuid());
600 e->e_putbody = putbody;
604 ** Output future work requests.
605 ** Priority and creation time should be first, since
606 ** they are required by gatherq.
609 /* output queue version number (must be first!) */
610 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "V%d\n", QF_VERSION);
612 /* output creation time */
613 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "T%ld\n", (long) e->e_ctime);
615 /* output last delivery time */
616 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "K%ld\n", (long) e->e_dtime);
618 /* output number of delivery attempts */
619 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "N%d\n", e->e_ntries);
621 /* output message priority */
622 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "P%ld\n", e->e_msgpriority);
625 ** If data file is in a different directory than the queue file,
626 ** output a "d" record naming the directory of the data file.
629 if (e->e_dfqgrp != e->e_qgrp)
631 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "d%s\n",
632 Queue[e->e_dfqgrp]->qg_qpaths[e->e_dfqdir].qp_name);
635 /* output inode number of data file */
636 if (e->e_dfino != -1)
638 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "I%ld/%ld/%llu\n",
639 (long) major(e->e_dfdev),
640 (long) minor(e->e_dfdev),
641 (ULONGLONG_T) e->e_dfino);
644 /* output body type */
645 if (e->e_bodytype != NULL)
646 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "B%s\n",
647 denlstring(e->e_bodytype, true, false));
649 /* quarantine reason */
650 if (e->e_quarmsg != NULL)
651 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "q%s\n",
652 denlstring(e->e_quarmsg, true, false));
654 /* message from envelope, if it exists */
655 if (e->e_message != NULL)
656 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "M%s\n",
657 denlstring(e->e_message, true, false));
659 /* send various flag bits through */
661 if (bitset(EF_WARNING, e->e_flags))
663 if (bitset(EF_RESPONSE, e->e_flags))
665 if (bitset(EF_HAS8BIT, e->e_flags))
667 if (bitset(EF_DELETE_BCC, e->e_flags))
669 if (bitset(EF_RET_PARAM, e->e_flags))
671 if (bitset(EF_NO_BODY_RETN, e->e_flags))
673 if (bitset(EF_SPLIT, e->e_flags))
677 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "F%s\n", buf);
679 /* save $={persistentMacros} macro values */
680 queueup_macros(macid("{persistentMacros}"), tfp, e);
682 /* output name of sender */
683 if (bitnset(M_UDBENVELOPE, e->e_from.q_mailer->m_flags))
686 p = e->e_from.q_paddr;
687 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "S%s\n",
688 denlstring(p, true, false));
690 /* output ESMTP-supplied "original" information */
691 if (e->e_envid != NULL)
692 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "Z%s\n",
693 denlstring(e->e_envid, true, false));
695 /* output AUTH= parameter */
696 if (e->e_auth_param != NULL)
697 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "A%s\n",
698 denlstring(e->e_auth_param, true, false));
699 if (e->e_dlvr_flag != 0)
700 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "!%c %ld\n",
701 (char) e->e_dlvr_flag, e->e_deliver_by);
703 /* output list of recipient addresses */
704 printctladdr(NULL, NULL);
705 for (q = e->e_sendqueue; q != NULL; q = q->q_next)
707 if (!QS_IS_UNDELIVERED(q->q_state))
710 /* message for this recipient, if it exists */
711 if (q->q_message != NULL)
712 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "M%s\n",
713 denlstring(q->q_message, true,
716 printctladdr(q, tfp);
717 if (q->q_orcpt != NULL)
718 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "Q%s\n",
719 denlstring(q->q_orcpt, true,
721 if (q->q_finalrcpt != NULL)
722 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "r%s\n",
723 denlstring(q->q_finalrcpt, true,
725 (void) sm_io_putc(tfp, SM_TIME_DEFAULT, 'R');
726 if (bitset(QPRIMARY, q->q_flags))
727 (void) sm_io_putc(tfp, SM_TIME_DEFAULT, 'P');
728 if (bitset(QHASNOTIFY, q->q_flags))
729 (void) sm_io_putc(tfp, SM_TIME_DEFAULT, 'N');
730 if (bitset(QPINGONSUCCESS, q->q_flags))
731 (void) sm_io_putc(tfp, SM_TIME_DEFAULT, 'S');
732 if (bitset(QPINGONFAILURE, q->q_flags))
733 (void) sm_io_putc(tfp, SM_TIME_DEFAULT, 'F');
734 if (bitset(QPINGONDELAY, q->q_flags))
735 (void) sm_io_putc(tfp, SM_TIME_DEFAULT, 'D');
736 if (q->q_alias != NULL &&
737 bitset(QALIAS, q->q_alias->q_flags))
738 (void) sm_io_putc(tfp, SM_TIME_DEFAULT, 'A');
739 (void) sm_io_putc(tfp, SM_TIME_DEFAULT, ':');
740 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "%s\n",
741 denlstring(q->q_paddr, true, false));
744 char *tag = "queued";
746 if (e->e_quarmsg != NULL)
749 e->e_to = q->q_paddr;
752 logdelivery(q->q_mailer, NULL, q->q_status,
753 tag, NULL, (time_t) 0, e);
758 sm_dprintf("queueing ");
759 printaddr(sm_debug_file(), q, false);
764 ** Output headers for this message.
765 ** Expand macros completely here. Queue run will deal with
766 ** everything as absolute headers.
767 ** All headers that must be relative to the recipient
768 ** can be cracked later.
769 ** We set up a "null mailer" -- i.e., a mailer that will have
770 ** no effect on the addresses as they are output.
773 memset((char *) &nullmailer, '\0', sizeof(nullmailer));
774 nullmailer.m_re_rwset = nullmailer.m_rh_rwset =
775 nullmailer.m_se_rwset = nullmailer.m_sh_rwset = -1;
776 nullmailer.m_eol = "\n";
777 memset(&mcibuf, '\0', sizeof(mcibuf));
778 mcibuf.mci_mailer = &nullmailer;
779 mcibuf.mci_out = tfp;
781 macdefine(&e->e_macro, A_PERM, 'g', "\201f");
782 for (h = e->e_header; h != NULL; h = h->h_link)
784 if (h->h_value == NULL)
787 /* don't output resent headers on non-resent messages */
788 if (bitset(H_RESENT, h->h_flags) &&
789 !bitset(EF_RESENT, e->e_flags))
792 /* expand macros; if null, don't output header at all */
793 if (bitset(H_DEFAULT, h->h_flags))
795 (void) expand(h->h_value, buf, sizeof(buf), e);
798 if (buf[0] == ' ' && buf[1] == '\0')
802 /* output this header */
803 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "H?");
805 /* output conditional macro if present */
806 if (h->h_macro != '\0')
808 if (bitset(0200, h->h_macro))
809 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT,
811 macname(bitidx(h->h_macro)));
813 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT,
816 else if (!bitzerop(h->h_mflags) &&
817 bitset(H_CHECK|H_ACHECK, h->h_flags))
821 /* if conditional, output the set of conditions */
822 for (j = '\0'; j <= '\177'; j++)
823 if (bitnset(j, h->h_mflags))
824 (void) sm_io_putc(tfp, SM_TIME_DEFAULT,
827 (void) sm_io_putc(tfp, SM_TIME_DEFAULT, '?');
829 /* output the header: expand macros, convert addresses */
830 if (bitset(H_DEFAULT, h->h_flags) &&
831 !bitset(H_BINDLATE, h->h_flags))
833 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "%s:%s\n",
835 denlstring(buf, false, true));
837 else if (bitset(H_FROM|H_RCPT, h->h_flags) &&
838 !bitset(H_BINDLATE, h->h_flags))
840 bool oldstyle = bitset(EF_OLDSTYLE, e->e_flags);
841 SM_FILE_T *savetrace = TrafficLogFile;
843 TrafficLogFile = NULL;
845 if (bitset(H_FROM, h->h_flags))
847 commaize(h, h->h_value, oldstyle, &mcibuf, e,
850 TrafficLogFile = savetrace;
854 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "%s:%s\n",
856 denlstring(h->h_value, false,
864 ** Write a terminator record -- this is to prevent
865 ** scurrilous crackers from appending any data.
868 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, ".\n");
870 if (sm_io_flush(tfp, SM_TIME_DEFAULT) != 0 ||
871 ((SuperSafe == SAFE_REALLY ||
872 SuperSafe == SAFE_REALLY_POSTMILTER ||
873 (SuperSafe == SAFE_INTERACTIVE && msync)) &&
874 fsync(sm_io_getinfo(tfp, SM_IO_WHAT_FD, NULL)) < 0) ||
878 syserr("!552 Error writing control file %s", tf);
880 syserr("!452 Error writing control file %s", tf);
885 char new = queue_letter(e, ANYQFL_LETTER);
887 /* rename (locked) tf to be (locked) [qh]f */
888 (void) sm_strlcpy(qf, queuename(e, ANYQFL_LETTER),
890 if (rename(tf, qf) < 0)
891 syserr("cannot rename(%s, %s), uid=%d",
892 tf, qf, (int) geteuid());
896 ** Check if type has changed and only
897 ** remove the old item if the rename above
901 if (e->e_qfletter != '\0' &&
902 e->e_qfletter != new)
906 sm_dprintf("type changed from %c to %c\n",
910 if (unlink(queuename(e, e->e_qfletter)) < 0)
912 /* XXX: something more drastic? */
914 sm_syslog(LOG_ERR, e->e_id,
915 "queueup: unlink(%s) failed: %s",
916 queuename(e, e->e_qfletter),
917 sm_errstring(errno));
924 ** fsync() after renaming to make sure metadata is
925 ** written to disk on filesystems in which renames are
929 if (SuperSafe != SAFE_NO)
931 /* for softupdates */
932 if (tfd >= 0 && fsync(tfd) < 0)
934 syserr("!queueup: cannot fsync queue temp file %s",
940 /* close and unlock old (locked) queue file */
941 if (e->e_lockfp != NULL)
942 (void) sm_io_close(e->e_lockfp, SM_TIME_DEFAULT);
947 sm_syslog(LOG_DEBUG, e->e_id, "queueup %s", qf);
953 sm_syslog(LOG_DEBUG, e->e_id, "queueup %s", tf);
955 e->e_qfletter = queue_letter(e, ANYQFL_LETTER);
959 e->e_flags |= EF_INQUEUE;
962 sm_dprintf("<<<<< done queueing %s <<<<<\n\n", e->e_id);
967 ** PRINTCTLADDR -- print control address to file.
971 ** tfp -- file pointer.
977 ** The control address (if changed) is printed to the file.
978 ** The last control address and uid are saved.
990 static ADDRESS *lastctladdr = NULL;
991 static uid_t lastuid;
994 if (a == NULL || a->q_alias == NULL || tfp == NULL)
996 if (lastctladdr != NULL && tfp != NULL)
997 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "C\n");
1003 /* find the active uid */
1013 user = q->q_ruser != NULL ? q->q_ruser : q->q_user;
1019 /* check to see if this is the same as last time */
1020 if (lastctladdr != NULL && uid == lastuid &&
1021 strcmp(lastctladdr->q_paddr, a->q_paddr) == 0)
1026 if (uid == 0 || user == NULL || user[0] == '\0')
1027 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "C");
1029 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, "C%s:%ld:%ld",
1030 denlstring(user, true, false), (long) uid,
1032 (void) sm_io_fprintf(tfp, SM_TIME_DEFAULT, ":%s\n",
1033 denlstring(a->q_paddr, true, false));
1037 ** RUNNERS_SIGTERM -- propagate a SIGTERM to queue runner process
1039 ** This propagates the signal to the child processes that are queue
1040 ** runners. This is for a queue runner "cleanup". After all of the
1041 ** child queue runner processes are signaled (it should be SIGTERM
1042 ** being the sig) then the old signal handler (Oldsh) is called
1043 ** to handle any cleanup set for this process (provided it is not
1044 ** SIG_DFL or SIG_IGN). The signal may not be handled immediately
1045 ** if the BlockOldsh flag is set. If the current process doesn't
1046 ** have a parent then handle the signal immediately, regardless of
1050 ** sig -- the signal number being sent
1056 ** Sets the NoMoreRunners boolean to true to stop more runners
1057 ** from being started in runqueue().
1059 ** NOTE: THIS CAN BE CALLED FROM A SIGNAL HANDLER. DO NOT ADD
1060 ** ANYTHING TO THIS ROUTINE UNLESS YOU KNOW WHAT YOU ARE
1064 static bool volatile NoMoreRunners = false;
1065 static sigfunc_t Oldsh_term = SIG_DFL;
1066 static sigfunc_t Oldsh_hup = SIG_DFL;
1067 static sigfunc_t volatile Oldsh = SIG_DFL;
1068 static bool BlockOldsh = false;
1069 static int volatile Oldsig = 0;
1070 static SIGFUNC_DECL runners_sigterm __P((int));
1071 static SIGFUNC_DECL runners_sighup __P((int));
1074 runners_sigterm(sig)
1077 int save_errno = errno;
1079 FIX_SYSV_SIGNAL(sig, runners_sigterm);
1081 CHECK_CRITICAL(sig);
1082 NoMoreRunners = true;
1085 proc_list_signal(PROC_QUEUE, sig);
1087 if (!BlockOldsh || getppid() <= 1)
1089 /* Check that a valid 'old signal handler' is callable */
1090 if (Oldsh_term != SIG_DFL && Oldsh_term != SIG_IGN &&
1091 Oldsh_term != runners_sigterm)
1095 return SIGFUNC_RETURN;
1098 ** RUNNERS_SIGHUP -- propagate a SIGHUP to queue runner process
1100 ** This propagates the signal to the child processes that are queue
1101 ** runners. This is for a queue runner "cleanup". After all of the
1102 ** child queue runner processes are signaled (it should be SIGHUP
1103 ** being the sig) then the old signal handler (Oldsh) is called to
1104 ** handle any cleanup set for this process (provided it is not SIG_DFL
1105 ** or SIG_IGN). The signal may not be handled immediately if the
1106 ** BlockOldsh flag is set. If the current process doesn't have
1107 ** a parent then handle the signal immediately, regardless of
1111 ** sig -- the signal number being sent
1117 ** Sets the NoMoreRunners boolean to true to stop more runners
1118 ** from being started in runqueue().
1120 ** NOTE: THIS CAN BE CALLED FROM A SIGNAL HANDLER. DO NOT ADD
1121 ** ANYTHING TO THIS ROUTINE UNLESS YOU KNOW WHAT YOU ARE
1129 int save_errno = errno;
1131 FIX_SYSV_SIGNAL(sig, runners_sighup);
1133 CHECK_CRITICAL(sig);
1134 NoMoreRunners = true;
1137 proc_list_signal(PROC_QUEUE, sig);
1139 if (!BlockOldsh || getppid() <= 1)
1141 /* Check that a valid 'old signal handler' is callable */
1142 if (Oldsh_hup != SIG_DFL && Oldsh_hup != SIG_IGN &&
1143 Oldsh_hup != runners_sighup)
1147 return SIGFUNC_RETURN;
1150 ** MARK_WORK_GROUP_RESTART -- mark a work group as needing a restart
1152 ** Sets a workgroup for restarting.
1155 ** wgrp -- the work group id to restart.
1156 ** reason -- why (signal?), -1 to turn off restart
1162 ** May set global RestartWorkGroup to true.
1164 ** NOTE: THIS CAN BE CALLED FROM A SIGNAL HANDLER. DO NOT ADD
1165 ** ANYTHING TO THIS ROUTINE UNLESS YOU KNOW WHAT YOU ARE
1170 mark_work_group_restart(wgrp, reason)
1174 if (wgrp < 0 || wgrp > NumWorkGroups)
1177 WorkGrp[wgrp].wg_restart = reason;
1179 RestartWorkGroup = true;
1182 ** RESTART_MARKED_WORK_GROUPS -- restart work groups marked as needing restart
1184 ** Restart any workgroup marked as needing a restart provided more
1185 ** runners are allowed.
1194 ** Sets global RestartWorkGroup to false.
1198 restart_marked_work_groups()
1206 /* Block SIGCHLD so reapchild() doesn't mess with us */
1207 wasblocked = sm_blocksignal(SIGCHLD);
1209 for (i = 0; i < NumWorkGroups; i++)
1211 if (WorkGrp[i].wg_restart >= 0)
1214 sm_syslog(LOG_ERR, NOQID,
1215 "restart queue runner=%d due to signal 0x%x",
1216 i, WorkGrp[i].wg_restart);
1217 restart_work_group(i);
1220 RestartWorkGroup = false;
1222 if (wasblocked == 0)
1223 (void) sm_releasesignal(SIGCHLD);
1226 ** RESTART_WORK_GROUP -- restart a specific work group
1228 ** Restart a specific workgroup provided more runners are allowed.
1229 ** If the requested work group has been restarted too many times log
1230 ** this and refuse to restart.
1233 ** wgrp -- the work group id to restart
1239 ** starts another process doing the work of wgrp
1242 #define MAX_PERSIST_RESTART 10 /* max allowed number of restarts */
1245 restart_work_group(wgrp)
1248 if (NoMoreRunners ||
1249 wgrp < 0 || wgrp > NumWorkGroups)
1252 WorkGrp[wgrp].wg_restart = -1;
1253 if (WorkGrp[wgrp].wg_restartcnt < MAX_PERSIST_RESTART)
1255 /* avoid overflow; increment here */
1256 WorkGrp[wgrp].wg_restartcnt++;
1257 (void) run_work_group(wgrp, RWG_FORK|RWG_PERSISTENT|RWG_RUNALL);
1261 sm_syslog(LOG_ERR, NOQID,
1262 "ERROR: persistent queue runner=%d restarted too many times, queue runner lost",
1267 ** SCHEDULE_QUEUE_RUNS -- schedule the next queue run for a work group.
1270 ** runall -- schedule even if individual bit is not set.
1271 ** wgrp -- the work group id to schedule.
1272 ** didit -- the queue run was performed for this work group.
1278 #define INCR_MOD(v, m) if (++v >= m) \
1283 schedule_queue_runs(runall, wgrp, didit)
1288 int qgrp, cgrp, endgrp;
1289 #if _FFR_QUEUE_SCHED_DBG
1292 #endif /* _FFR_QUEUE_SCHED_DBG */
1297 ** This is a bit ugly since we have to duplicate the
1298 ** code that "walks" through a work queue group.
1303 cgrp = endgrp = WorkGrp[wgrp].wg_curqgrp;
1308 #if _FFR_QUEUE_SCHED_DBG
1311 #endif /* _FFR_QUEUE_SCHED_DBG */
1312 qgrp = WorkGrp[wgrp].wg_qgs[cgrp]->qg_index;
1313 if (Queue[qgrp]->qg_queueintvl > 0)
1314 qintvl = Queue[qgrp]->qg_queueintvl;
1315 else if (QueueIntvl > 0)
1316 qintvl = QueueIntvl;
1318 qintvl = (time_t) 0;
1319 #if _FFR_QUEUE_SCHED_DBG
1320 lastsched = Queue[qgrp]->qg_nextrun;
1321 #endif /* _FFR_QUEUE_SCHED_DBG */
1322 if ((runall || Queue[qgrp]->qg_nextrun <= now) && qintvl > 0)
1324 #if _FFR_QUEUE_SCHED_DBG
1326 #endif /* _FFR_QUEUE_SCHED_DBG */
1327 if (minqintvl == 0 || qintvl < minqintvl)
1331 ** Only set a new time if a queue run was performed
1332 ** for this queue group. If the queue was not run,
1333 ** we could starve it by setting a new time on each
1338 Queue[qgrp]->qg_nextrun += qintvl;
1340 #if _FFR_QUEUE_SCHED_DBG
1342 sm_syslog(LOG_INFO, NOQID,
1343 "sqr: wgrp=%d, cgrp=%d, qgrp=%d, intvl=%ld, QI=%ld, runall=%d, lastrun=%ld, nextrun=%ld, sched=%d",
1344 wgrp, cgrp, qgrp, Queue[qgrp]->qg_queueintvl,
1345 QueueIntvl, runall, lastsched,
1346 Queue[qgrp]->qg_nextrun, sched);
1347 #endif /* _FFR_QUEUE_SCHED_DBG */
1348 INCR_MOD(cgrp, WorkGrp[wgrp].wg_numqgrp);
1349 } while (endgrp != cgrp);
1351 (void) sm_setevent(minqintvl, runqueueevent, 0);
1354 #if _FFR_QUEUE_RUN_PARANOIA
1356 ** CHECKQUEUERUNNER -- check whether a queue group hasn't been run.
1358 ** Use this if events may get lost and hence queue runners may not
1359 ** be started and mail will pile up in a queue.
1365 ** true if a queue run is necessary.
1368 ** may schedule a queue run.
1375 time_t now, minqintvl;
1379 for (qgrp = 0; qgrp < NumQueue && Queue[qgrp] != NULL; qgrp++)
1383 if (Queue[qgrp]->qg_queueintvl > 0)
1384 qintvl = Queue[qgrp]->qg_queueintvl;
1385 else if (QueueIntvl > 0)
1386 qintvl = QueueIntvl;
1388 qintvl = (time_t) 0;
1389 if (Queue[qgrp]->qg_nextrun <= now - qintvl)
1391 if (minqintvl == 0 || qintvl < minqintvl)
1394 sm_syslog(LOG_WARNING, NOQID,
1395 "checkqueuerunner: queue %d should have been run at %s, queue interval %ld",
1397 arpadate(ctime(&Queue[qgrp]->qg_nextrun)),
1403 (void) sm_setevent(minqintvl, runqueueevent, 0);
1408 #endif /* _FFR_QUEUE_RUN_PARANOIA */
1411 ** RUNQUEUE -- run the jobs in the queue.
1413 ** Gets the stuff out of the queue in some presumably logical
1414 ** order and processes them.
1417 ** forkflag -- true if the queue scanning should be done in
1418 ** a child process. We double-fork so it is not our
1419 ** child and we don't have to clean up after it.
1420 ** false can be ignored if we have multiple queues.
1421 ** verbose -- if true, print out status information.
1422 ** persistent -- persistent queue runner?
1423 ** runall -- run all groups or only a subset (DoQueueRun)?
1426 ** true if the queue run successfully began.
1429 ** runs things in the mail queue using run_work_group().
1430 ** maybe schedules next queue run.
1433 static ENVELOPE QueueEnvelope; /* the queue run envelope */
1434 static time_t LastQueueTime = 0; /* last time a queue ID assigned */
1435 static pid_t LastQueuePid = -1; /* last PID which had a queue ID */
1437 /* values for qp_supdirs */
1438 #define QP_NOSUB 0x0000 /* No subdirectories */
1439 #define QP_SUBDF 0x0001 /* "df" subdirectory */
1440 #define QP_SUBQF 0x0002 /* "qf" subdirectory */
1441 #define QP_SUBXF 0x0004 /* "xf" subdirectory */
1444 runqueue(forkflag, verbose, persistent, runall)
1452 static int curnum = 0;
1455 SM_NONVOLATILE int oldgroup = 0;
1457 if (sm_debug_active(&DebugLeakQ, 1))
1459 oldgroup = sm_heap_group();
1461 sm_dprintf("runqueue() heap group #%d\n", sm_heap_group());
1463 #endif /* SM_HEAP_CHECK */
1465 /* queue run has been started, don't do any more this time */
1468 /* more than one queue or more than one directory per queue */
1469 if (!forkflag && !verbose &&
1470 (WorkGrp[0].wg_qgs[0]->qg_numqueues > 1 || NumWorkGroups > 1 ||
1471 WorkGrp[0].wg_numqgrp > 1))
1475 ** For controlling queue runners via signals sent to this process.
1476 ** Oldsh* will get called too by runners_sig* (if it is not SIG_IGN
1477 ** or SIG_DFL) to preserve cleanup behavior. Now that this process
1478 ** will have children (and perhaps grandchildren) this handler will
1479 ** be left in place. This is because this process, once it has
1480 ** finished spinning off queue runners, may go back to doing something
1481 ** else (like being a daemon). And we still want on a SIG{TERM,HUP} to
1482 ** clean up the child queue runners. Only install 'runners_sig*' once
1483 ** else we'll get stuck looping forever.
1486 cursh = sm_signal(SIGTERM, runners_sigterm);
1487 if (cursh != runners_sigterm)
1489 cursh = sm_signal(SIGHUP, runners_sighup);
1490 if (cursh != runners_sighup)
1493 for (i = 0; i < NumWorkGroups && !NoMoreRunners; i++)
1495 int rwgflags = RWG_NONE;
1499 ** If MaxQueueChildren active then test whether the start
1500 ** of the next queue group's additional queue runners (maximum)
1501 ** will result in MaxQueueChildren being exceeded.
1503 ** Note: do not use continue; even though another workgroup
1504 ** may have fewer queue runners, this would be "unfair",
1505 ** i.e., this work group might "starve" then.
1508 #if _FFR_QUEUE_SCHED_DBG
1510 sm_syslog(LOG_INFO, NOQID,
1511 "rq: curnum=%d, MaxQueueChildren=%d, CurRunners=%d, WorkGrp[curnum].wg_maxact=%d",
1512 curnum, MaxQueueChildren, CurRunners,
1513 WorkGrp[curnum].wg_maxact);
1514 #endif /* _FFR_QUEUE_SCHED_DBG */
1515 if (MaxQueueChildren > 0 &&
1516 CurRunners + WorkGrp[curnum].wg_maxact > MaxQueueChildren)
1520 ** Pick up where we left off (curnum), in case we
1521 ** used up all the children last time without finishing.
1522 ** This give a round-robin fairness to queue runs.
1524 ** Increment CurRunners before calling run_work_group()
1525 ** to avoid a "race condition" with proc_list_drop() which
1526 ** decrements CurRunners if the queue runners terminate.
1527 ** Notice: CurRunners is an upper limit, in some cases
1528 ** (too few jobs in the queue) this value is larger than
1529 ** the actual number of queue runners. The discrepancy can
1530 ** increase if some queue runners "hang" for a long time.
1533 /* don't let proc_list_drop() change CurRunners */
1534 wasblocked = sm_blocksignal(SIGCHLD);
1535 CurRunners += WorkGrp[curnum].wg_maxact;
1536 if (wasblocked == 0)
1537 (void) sm_releasesignal(SIGCHLD);
1539 rwgflags |= RWG_FORK;
1541 rwgflags |= RWG_VERBOSE;
1543 rwgflags |= RWG_PERSISTENT;
1545 rwgflags |= RWG_RUNALL;
1546 ret = run_work_group(curnum, rwgflags);
1549 ** Failure means a message was printed for ETRN
1550 ** and subsequent queues are likely to fail as well.
1551 ** Decrement CurRunners in that case because
1552 ** none have been started.
1557 /* don't let proc_list_drop() change CurRunners */
1558 wasblocked = sm_blocksignal(SIGCHLD);
1559 CurRunners -= WorkGrp[curnum].wg_maxact;
1560 CHK_CUR_RUNNERS("runqueue", curnum,
1561 WorkGrp[curnum].wg_maxact);
1562 if (wasblocked == 0)
1563 (void) sm_releasesignal(SIGCHLD);
1568 schedule_queue_runs(runall, curnum, true);
1569 INCR_MOD(curnum, NumWorkGroups);
1572 /* schedule left over queue runs */
1573 if (i < NumWorkGroups && !NoMoreRunners && !persistent)
1577 for (h = curnum; i < NumWorkGroups; i++)
1579 schedule_queue_runs(runall, h, false);
1580 INCR_MOD(h, NumWorkGroups);
1586 if (sm_debug_active(&DebugLeakQ, 1))
1587 sm_heap_setgroup(oldgroup);
1588 #endif /* SM_HEAP_CHECK */
1592 #if _FFR_SKIP_DOMAINS
1594 ** SKIP_DOMAINS -- Skip 'skip' number of domains in the WorkQ.
1596 ** Added by Stephen Frost <sfrost@snowman.net> to support
1597 ** having each runner process every N'th domain instead of
1598 ** every N'th message.
1601 ** skip -- number of domains in WorkQ to skip.
1604 ** total number of messages skipped.
1616 for (n = 0, seqjump = 0; n < skip && WorkQ != NULL; seqjump++)
1618 if (WorkQ->w_next != NULL)
1620 if (WorkQ->w_host != NULL &&
1621 WorkQ->w_next->w_host != NULL)
1623 if (sm_strcasecmp(WorkQ->w_host,
1624 WorkQ->w_next->w_host) != 0)
1629 if ((WorkQ->w_host != NULL &&
1630 WorkQ->w_next->w_host == NULL) ||
1631 (WorkQ->w_host == NULL &&
1632 WorkQ->w_next->w_host != NULL))
1636 WorkQ = WorkQ->w_next;
1640 #endif /* _FFR_SKIP_DOMAINS */
1643 ** RUNNER_WORK -- have a queue runner do its work
1645 ** Have a queue runner do its work a list of entries.
1646 ** When work isn't directly being done then this process can take a signal
1647 ** and terminate immediately (in a clean fashion of course).
1648 ** When work is directly being done, it's not to be interrupted
1649 ** immediately: the work should be allowed to finish at a clean point
1650 ** before termination (in a clean fashion of course).
1654 ** sequenceno -- 'th process to run WorkQ.
1655 ** didfork -- did the calling process fork()?
1656 ** skip -- process only each skip'th item.
1657 ** njobs -- number of jobs in WorkQ.
1663 ** runs things in the mail queue.
1667 runner_work(e, sequenceno, didfork, skip, njobs)
1668 register ENVELOPE *e;
1681 ** Here we temporarily block the second calling of the handlers.
1682 ** This allows us to handle the signal without terminating in the
1683 ** middle of direct work. If a signal does come, the test for
1684 ** NoMoreRunners will find it.
1690 /* process them once at a time */
1691 while (WorkQ != NULL)
1694 SM_NONVOLATILE int oldgroup = 0;
1696 if (sm_debug_active(&DebugLeakQ, 1))
1698 oldgroup = sm_heap_group();
1700 sm_dprintf("run_queue_group() heap group #%d\n",
1703 #endif /* SM_HEAP_CHECK */
1705 /* do no more work */
1708 /* Check that a valid signal handler is callable */
1709 if (Oldsh != SIG_DFL && Oldsh != SIG_IGN &&
1710 Oldsh != runners_sighup &&
1711 Oldsh != runners_sigterm)
1716 w = WorkQ; /* assign current work item */
1719 ** Set the head of the WorkQ to the next work item.
1720 ** It is set 'skip' ahead (the number of parallel queue
1721 ** runners working on WorkQ together) since each runner
1722 ** works on every 'skip'th (N-th) item.
1723 #if _FFR_SKIP_DOMAINS
1724 ** In the case of the BYHOST Queue Sort Order, the 'item'
1725 ** is a domain, so we work on every 'skip'th (N-th) domain.
1726 #endif * _FFR_SKIP_DOMAINS *
1729 #if _FFR_SKIP_DOMAINS
1730 if (QueueSortOrder == QSO_BYHOST)
1733 if (WorkQ->w_next != NULL)
1735 if (WorkQ->w_host != NULL &&
1736 WorkQ->w_next->w_host != NULL)
1738 if (sm_strcasecmp(WorkQ->w_host,
1739 WorkQ->w_next->w_host)
1741 seqjump = skip_domains(skip);
1743 WorkQ = WorkQ->w_next;
1747 if ((WorkQ->w_host != NULL &&
1748 WorkQ->w_next->w_host == NULL) ||
1749 (WorkQ->w_host == NULL &&
1750 WorkQ->w_next->w_host != NULL))
1751 seqjump = skip_domains(skip);
1753 WorkQ = WorkQ->w_next;
1757 WorkQ = WorkQ->w_next;
1760 #endif /* _FFR_SKIP_DOMAINS */
1762 for (n = 0; n < skip && WorkQ != NULL; n++)
1763 WorkQ = WorkQ->w_next;
1769 ** Ignore jobs that are too expensive for the moment.
1771 ** Get new load average every GET_NEW_LA_TIME seconds.
1775 if (shouldqueue(WkRecipFact, Current_LA_time))
1777 char *msg = "Aborting queue run: load average too high";
1782 sm_syslog(LOG_INFO, NOQID, "runqueue: %s", msg);
1785 if (shouldqueue(w->w_pri, w->w_ctime))
1788 message(EmptyString);
1789 if (QueueSortOrder == QSO_BYPRIORITY)
1792 message("Skipping %s/%s (sequence %d of %d) and flushing rest of queue",
1793 qid_printqueue(w->w_qgrp,
1795 w->w_name + 2, sequenceno,
1798 sm_syslog(LOG_INFO, NOQID,
1799 "runqueue: Flushing queue from %s/%s (pri %ld, LA %d, %d of %d)",
1800 qid_printqueue(w->w_qgrp,
1802 w->w_name + 2, w->w_pri,
1803 CurrentLA, sequenceno,
1808 message("Skipping %s/%s (sequence %d of %d)",
1809 qid_printqueue(w->w_qgrp, w->w_qdir),
1810 w->w_name + 2, sequenceno, njobs);
1816 message(EmptyString);
1817 message("Running %s/%s (sequence %d of %d)",
1818 qid_printqueue(w->w_qgrp, w->w_qdir),
1819 w->w_name + 2, sequenceno, njobs);
1821 if (didfork && MaxQueueChildren > 0)
1823 sm_blocksignal(SIGCHLD);
1824 (void) sm_signal(SIGCHLD, reapchild);
1827 sm_syslog(LOG_DEBUG, NOQID,
1828 "runqueue %s dowork(%s)",
1829 qid_printqueue(w->w_qgrp, w->w_qdir),
1832 (void) dowork(w->w_qgrp, w->w_qdir, w->w_name + 2,
1833 ForkQueueRuns, false, e);
1836 sm_free(w->w_name); /* XXX */
1837 if (w->w_host != NULL)
1838 sm_free(w->w_host); /* XXX */
1839 sm_free((char *) w); /* XXX */
1840 sequenceno += seqjump; /* next sequence number */
1842 if (sm_debug_active(&DebugLeakQ, 1))
1843 sm_heap_setgroup(oldgroup);
1844 #endif /* SM_HEAP_CHECK */
1849 /* check the signals didn't happen during the revert */
1852 /* Check that a valid signal handler is callable */
1853 if (Oldsh != SIG_DFL && Oldsh != SIG_IGN &&
1854 Oldsh != runners_sighup && Oldsh != runners_sigterm)
1858 Oldsh = SIG_DFL; /* after the NoMoreRunners check */
1861 ** RUN_WORK_GROUP -- run the jobs in a queue group from a work group.
1863 ** Gets the stuff out of the queue in some presumably logical
1864 ** order and processes them.
1867 ** wgrp -- work group to process.
1868 ** flags -- RWG_* flags
1871 ** true if the queue run successfully began.
1874 ** runs things in the mail queue.
1877 /* Minimum sleep time for persistent queue runners */
1878 #define MIN_SLEEP_TIME 5
1881 run_work_group(wgrp, flags)
1885 register ENVELOPE *e;
1888 int qgrp, endgrp, h, i;
1892 extern ENVELOPE BlankEnvelope;
1893 extern SIGFUNC_DECL reapchild __P((int));
1899 ** If no work will ever be selected, don't even bother reading
1905 if (!bitset(RWG_PERSISTENT, flags) &&
1906 shouldqueue(WkRecipFact, Current_LA_time))
1908 char *msg = "Skipping queue run -- load average too high";
1910 if (bitset(RWG_VERBOSE, flags))
1911 message("458 %s\n", msg);
1913 sm_syslog(LOG_INFO, NOQID, "runqueue: %s", msg);
1918 ** See if we already have too many children.
1921 if (bitset(RWG_FORK, flags) &&
1922 WorkGrp[wgrp].wg_lowqintvl > 0 &&
1923 !bitset(RWG_PERSISTENT, flags) &&
1924 MaxChildren > 0 && CurChildren >= MaxChildren)
1926 char *msg = "Skipping queue run -- too many children";
1928 if (bitset(RWG_VERBOSE, flags))
1929 message("458 %s (%d)\n", msg, CurChildren);
1931 sm_syslog(LOG_INFO, NOQID, "runqueue: %s (%d)",
1937 ** See if we want to go off and do other useful work.
1940 if (bitset(RWG_FORK, flags))
1944 (void) sm_blocksignal(SIGCHLD);
1945 (void) sm_signal(SIGCHLD, reapchild);
1950 const char *msg = "Skipping queue run -- fork() failed";
1951 const char *err = sm_errstring(errno);
1953 if (bitset(RWG_VERBOSE, flags))
1954 message("458 %s: %s\n", msg, err);
1956 sm_syslog(LOG_INFO, NOQID, "runqueue: %s: %s",
1958 (void) sm_releasesignal(SIGCHLD);
1963 /* parent -- pick up intermediate zombie */
1964 (void) sm_blocksignal(SIGALRM);
1966 /* wgrp only used when queue runners are persistent */
1967 proc_list_add(pid, "Queue runner", PROC_QUEUE,
1968 WorkGrp[wgrp].wg_maxact,
1969 bitset(RWG_PERSISTENT, flags) ? wgrp : -1,
1971 (void) sm_releasesignal(SIGALRM);
1972 (void) sm_releasesignal(SIGCHLD);
1976 /* child -- clean up signals */
1978 /* Reset global flags */
1979 RestartRequest = NULL;
1980 RestartWorkGroup = false;
1981 ShutdownRequest = NULL;
1983 CurrentPid = getpid();
1984 close_sendmail_pid();
1987 ** Initialize exception stack and default exception
1988 ** handler for child process.
1991 sm_exc_newthread(fatal_error);
1995 /* Add parent process as first child item */
1996 proc_list_add(CurrentPid, "Queue runner child process",
1997 PROC_QUEUE_CHILD, 0, -1, NULL);
1998 (void) sm_releasesignal(SIGCHLD);
1999 (void) sm_signal(SIGCHLD, SIG_DFL);
2000 (void) sm_signal(SIGHUP, SIG_DFL);
2001 (void) sm_signal(SIGTERM, intsig);
2005 ** Release any resources used by the daemon code.
2010 /* force it to run expensive jobs */
2013 /* drop privileges */
2014 if (geteuid() == (uid_t) 0)
2015 (void) drop_privileges(false);
2018 ** Create ourselves an envelope
2021 CurEnv = &QueueEnvelope;
2022 rpool = sm_rpool_new_x(NULL);
2023 e = newenvelope(&QueueEnvelope, CurEnv, rpool);
2024 e->e_flags = BlankEnvelope.e_flags;
2027 /* make sure we have disconnected from parent */
2028 if (bitset(RWG_FORK, flags))
2035 ** If we are running part of the queue, always ignore stored
2039 if (QueueLimitId != NULL || QueueLimitSender != NULL ||
2040 QueueLimitQuarantine != NULL ||
2041 QueueLimitRecipient != NULL)
2043 IgnoreHostStatus = true;
2047 #endif /* _FFR_EXPDELAY */
2051 ** Here is where we choose the queue group from the work group.
2052 ** The caller of the "domorework" label must setup a new envelope.
2055 endgrp = WorkGrp[wgrp].wg_curqgrp; /* to not spin endlessly */
2060 ** Run a queue group if:
2061 ** RWG_RUNALL bit is set or the bit for this group is set.
2068 ** Find the next queue group within the work group that
2069 ** has been marked as needing a run.
2072 qgrp = WorkGrp[wgrp].wg_qgs[WorkGrp[wgrp].wg_curqgrp]->qg_index;
2073 WorkGrp[wgrp].wg_curqgrp++; /* advance */
2074 WorkGrp[wgrp].wg_curqgrp %= WorkGrp[wgrp].wg_numqgrp; /* wrap */
2075 if (bitset(RWG_RUNALL, flags) ||
2076 (Queue[qgrp]->qg_nextrun <= now &&
2077 Queue[qgrp]->qg_nextrun != (time_t) -1))
2079 if (endgrp == WorkGrp[wgrp].wg_curqgrp)
2082 if (bitset(RWG_FORK, flags))
2083 finis(true, true, ExitStat);
2084 return true; /* we're done */
2088 qdir = Queue[qgrp]->qg_curnum; /* round-robin init of queue position */
2089 #if _FFR_QUEUE_SCHED_DBG
2091 sm_syslog(LOG_INFO, NOQID,
2092 "rwg: wgrp=%d, qgrp=%d, qdir=%d, name=%s, curqgrp=%d, numgrps=%d",
2093 wgrp, qgrp, qdir, qid_printqueue(qgrp, qdir),
2094 WorkGrp[wgrp].wg_curqgrp, WorkGrp[wgrp].wg_numqgrp);
2095 #endif /* _FFR_QUEUE_SCHED_DBG */
2098 /* tweak niceness of queue runs */
2099 if (Queue[qgrp]->qg_nice > 0)
2100 (void) nice(Queue[qgrp]->qg_nice);
2101 #endif /* HASNICE */
2103 /* XXX running queue group... */
2104 sm_setproctitle(true, CurEnv, "running queue: %s",
2105 qid_printqueue(qgrp, qdir));
2107 if (LogLevel > 69 || tTd(63, 99))
2108 sm_syslog(LOG_DEBUG, NOQID,
2109 "runqueue %s, pid=%d, forkflag=%d",
2110 qid_printqueue(qgrp, qdir), (int) CurrentPid,
2111 bitset(RWG_FORK, flags));
2114 ** Start making passes through the queue.
2115 ** First, read and sort the entire queue.
2116 ** Then, process the work in that order.
2117 ** But if you take too long, start over.
2120 for (i = 0; i < Queue[qgrp]->qg_numqueues; i++)
2122 (void) gatherq(qgrp, qdir, false, &full, &more, &h);
2124 if (ShmId != SM_SHM_NO_ID)
2125 QSHM_ENTRIES(Queue[qgrp]->qg_qpaths[qdir].qp_idx) = h;
2126 #endif /* SM_CONF_SHM */
2127 /* If there are no more items in this queue advance */
2130 /* A round-robin advance */
2132 qdir %= Queue[qgrp]->qg_numqueues;
2135 /* Has the WorkList reached the limit? */
2137 break; /* don't try to gather more */
2140 /* order the existing work requests */
2141 njobs = sortq(Queue[qgrp]->qg_maxlist);
2142 Queue[qgrp]->qg_curnum = qdir; /* update */
2145 if (!Verbose && bitnset(QD_FORK, Queue[qgrp]->qg_flags))
2147 int loop, maxrunners;
2151 ** For this WorkQ we want to fork off N children (maxrunners)
2152 ** at this point. Each child has a copy of WorkQ. Each child
2153 ** will process every N-th item. The parent will wait for all
2154 ** of the children to finish before moving on to the next
2155 ** queue group within the work group. This saves us forking
2156 ** a new runner-child for each work item.
2157 ** It's valid for qg_maxqrun == 0 since this may be an
2158 ** explicit "don't run this queue" setting.
2161 maxrunners = Queue[qgrp]->qg_maxqrun;
2164 ** If no runners are configured for this group but
2165 ** the queue is "forced" then lets use 1 runner.
2168 if (maxrunners == 0 && bitset(RWG_FORCE, flags))
2171 /* No need to have more runners then there are jobs */
2172 if (maxrunners > njobs)
2174 for (loop = 0; loop < maxrunners; loop++)
2177 ** Since the delivery may happen in a child and the
2178 ** parent does not wait, the parent may close the
2179 ** maps thereby removing any shared memory used by
2180 ** the map. Therefore, close the maps now so the
2181 ** child will dynamically open them if necessary.
2189 syserr("run_work_group: cannot fork");
2194 /* parent -- clean out connection cache */
2195 mci_flush(false, NULL);
2196 #if _FFR_SKIP_DOMAINS
2197 if (QueueSortOrder == QSO_BYHOST)
2199 sequenceno += skip_domains(1);
2202 #endif /* _FFR_SKIP_DOMAINS */
2205 WorkQ = WorkQ->w_next;
2208 proc_list_add(pid, "Queue child runner process",
2209 PROC_QUEUE_CHILD, 0, -1, NULL);
2211 /* No additional work, no additional runners */
2217 /* child -- Reset global flags */
2218 RestartRequest = NULL;
2219 RestartWorkGroup = false;
2220 ShutdownRequest = NULL;
2222 CurrentPid = getpid();
2223 close_sendmail_pid();
2226 ** Initialize exception stack and default
2227 ** exception handler for child process.
2228 ** When fork()'d the child now has a private
2229 ** copy of WorkQ at its current position.
2232 sm_exc_newthread(fatal_error);
2235 ** SMTP processes (whether -bd or -bs) set
2236 ** SIGCHLD to reapchild to collect
2237 ** children status. However, at delivery
2238 ** time, that status must be collected
2239 ** by sm_wait() to be dealt with properly
2240 ** (check success of delivery based
2241 ** on status code, etc). Therefore, if we
2242 ** are an SMTP process, reset SIGCHLD
2243 ** back to the default so reapchild
2244 ** doesn't collect status before
2248 if (OpMode == MD_SMTP ||
2249 OpMode == MD_DAEMON ||
2250 MaxQueueChildren > 0)
2253 sm_releasesignal(SIGCHLD);
2254 (void) sm_signal(SIGCHLD, SIG_DFL);
2257 /* child -- error messages to the transcript */
2258 QuickAbort = OnlyOneError = false;
2259 runner_work(e, sequenceno, true,
2262 /* This child is done */
2263 finis(true, true, ExitStat);
2268 sm_releasesignal(SIGCHLD);
2271 ** Wait until all of the runners have completed before
2272 ** seeing if there is another queue group in the
2273 ** work group to process.
2274 ** XXX Future enhancement: don't wait() for all children
2275 ** here, just go ahead and make sure that overall the number
2276 ** of children is not exceeded.
2279 while (CurChildren > 0)
2284 while ((ret = sm_wait(&status)) <= 0)
2286 proc_list_drop(ret, status, NULL);
2289 else if (Queue[qgrp]->qg_maxqrun > 0 || bitset(RWG_FORCE, flags))
2292 ** When current process will not fork children to do the work,
2293 ** it will do the work itself. The 'skip' will be 1 since
2294 ** there are no child runners to divide the work across.
2297 runner_work(e, sequenceno, false, 1, njobs);
2300 /* free memory allocated by newenvelope() above */
2301 sm_rpool_free(rpool);
2302 QueueEnvelope.e_rpool = NULL;
2304 /* Are there still more queues in the work group to process? */
2305 if (endgrp != WorkGrp[wgrp].wg_curqgrp)
2307 rpool = sm_rpool_new_x(NULL);
2308 e = newenvelope(&QueueEnvelope, CurEnv, rpool);
2309 e->e_flags = BlankEnvelope.e_flags;
2313 /* No more queues in work group to process. Now check persistent. */
2314 if (bitset(RWG_PERSISTENT, flags))
2317 sm_setproctitle(true, NULL, "running queue: %s",
2318 qid_printqueue(qgrp, qdir));
2321 ** close bogus maps, i.e., maps which caused a tempfail,
2322 ** so we get fresh map connections on the next lookup.
2323 ** closemaps() is also called when children are started.
2328 /* Close any cached connections. */
2329 mci_flush(true, NULL);
2331 /* Clean out expired related entries. */
2335 /* Update MX records for FallbackMX. */
2336 if (FallbackMX != NULL)
2337 (void) getfallbackmxrr(FallbackMX);
2338 #endif /* NAMED_BIND */
2341 /* close UserDatabase */
2346 if (sm_debug_active(&SmHeapCheck, 2)
2347 && access("memdump", F_OK) == 0
2353 out = sm_io_open(SmFtStdio, SM_TIME_DEFAULT,
2354 "memdump.out", SM_IO_APPEND, NULL);
2357 (void) sm_io_fprintf(out, SM_TIME_DEFAULT, "----------------------\n");
2359 sm_debug_level(&SmHeapCheck) - 1);
2360 (void) sm_io_close(out, SM_TIME_DEFAULT);
2363 #endif /* SM_HEAP_CHECK */
2365 /* let me rest for a second to catch my breath */
2366 if (njobs == 0 && WorkGrp[wgrp].wg_lowqintvl < MIN_SLEEP_TIME)
2367 sleep(MIN_SLEEP_TIME);
2368 else if (WorkGrp[wgrp].wg_lowqintvl <= 0)
2369 sleep(QueueIntvl > 0 ? QueueIntvl : MIN_SLEEP_TIME);
2371 sleep(WorkGrp[wgrp].wg_lowqintvl);
2374 ** Get the LA outside the WorkQ loop if necessary.
2375 ** In a persistent queue runner the code is repeated over
2376 ** and over but gatherq() may ignore entries due to
2377 ** shouldqueue() (do we really have to do this twice?).
2378 ** Hence the queue runners would just idle around when once
2379 ** CurrentLA caused all entries in a queue to be ignored.
2384 rpool = sm_rpool_new_x(NULL);
2385 e = newenvelope(&QueueEnvelope, CurEnv, rpool);
2386 e->e_flags = BlankEnvelope.e_flags;
2390 /* exit without the usual cleanup */
2392 if (bitset(RWG_FORK, flags))
2393 finis(true, true, ExitStat);
2399 ** DOQUEUERUN -- do a queue run?
2409 ** RUNQUEUEEVENT -- Sets a flag to indicate that a queue run should be done.
2418 ** The invocation of this function via an alarm may interrupt
2419 ** a set of actions. Thus errno may be set in that context.
2420 ** We need to restore errno at the end of this function to ensure
2421 ** that any work done here that sets errno doesn't return a
2422 ** misleading/false errno value. Errno may be EINTR upon entry to
2423 ** this function because of non-restartable/continuable system
2424 ** API was active. Iff this is true we will override errno as
2425 ** a timeout (as a more accurate error message).
2427 ** NOTE: THIS CAN BE CALLED FROM A SIGNAL HANDLER. DO NOT ADD
2428 ** ANYTHING TO THIS ROUTINE UNLESS YOU KNOW WHAT YOU ARE
2433 runqueueevent(ignore)
2436 int save_errno = errno;
2439 ** Set the general bit that we want a queue run,
2440 ** tested in doqueuerun()
2444 #if _FFR_QUEUE_SCHED_DBG
2446 sm_syslog(LOG_INFO, NOQID, "rqe: done");
2447 #endif /* _FFR_QUEUE_SCHED_DBG */
2454 ** GATHERQ -- gather messages from the message queue(s) the work queue.
2457 ** qgrp -- the index of the queue group.
2458 ** qdir -- the index of the queue directory.
2459 ** doall -- if set, include everything in the queue (even
2460 ** the jobs that cannot be run because the load
2461 ** average is too high, or MaxQueueRun is reached).
2462 ** Otherwise, exclude those jobs.
2463 ** full -- (optional) to be set 'true' if WorkList is full
2464 ** more -- (optional) to be set 'true' if there are still more
2465 ** messages in this queue not added to WorkList
2466 ** pnentries -- (optional) total nuber of entries in queue
2469 ** The number of request in the queue (not necessarily
2470 ** the number of requests in WorkList however).
2473 ** prepares available work into WorkList
2476 #define NEED_P 0001 /* 'P': priority */
2477 #define NEED_T 0002 /* 'T': time */
2478 #define NEED_R 0004 /* 'R': recipient */
2479 #define NEED_S 0010 /* 'S': sender */
2480 #define NEED_H 0020 /* host */
2481 #define HAS_QUARANTINE 0040 /* has an unexpected 'q' line */
2482 #define NEED_QUARANTINE 0100 /* 'q': reason */
2484 static WORK *WorkList = NULL; /* list of unsort work */
2485 static int WorkListSize = 0; /* current max size of WorkList */
2486 static int WorkListCount = 0; /* # of work items in WorkList */
2489 gatherq(qgrp, qdir, doall, full, more, pnentries)
2497 register struct dirent *d;
2501 int i, num_ent, wn, nentries;
2503 char qd[MAXPATHLEN];
2504 char qf[MAXPATHLEN];
2506 wn = WorkListCount - 1;
2510 (void) sm_strlcpy(qd, ".", sizeof(qd));
2512 (void) sm_strlcpyn(qd, sizeof(qd), 2,
2513 Queue[qgrp]->qg_qpaths[qdir].qp_name,
2515 Queue[qgrp]->qg_qpaths[qdir].qp_subdirs)
2520 sm_dprintf("gatherq:\n");
2522 check = QueueLimitId;
2523 while (check != NULL)
2525 sm_dprintf("\tQueueLimitId = %s%s\n",
2526 check->queue_negate ? "!" : "",
2527 check->queue_match);
2528 check = check->queue_next;
2531 check = QueueLimitSender;
2532 while (check != NULL)
2534 sm_dprintf("\tQueueLimitSender = %s%s\n",
2535 check->queue_negate ? "!" : "",
2536 check->queue_match);
2537 check = check->queue_next;
2540 check = QueueLimitRecipient;
2541 while (check != NULL)
2543 sm_dprintf("\tQueueLimitRecipient = %s%s\n",
2544 check->queue_negate ? "!" : "",
2545 check->queue_match);
2546 check = check->queue_next;
2549 if (QueueMode == QM_QUARANTINE)
2551 check = QueueLimitQuarantine;
2552 while (check != NULL)
2554 sm_dprintf("\tQueueLimitQuarantine = %s%s\n",
2555 check->queue_negate ? "!" : "",
2556 check->queue_match);
2557 check = check->queue_next;
2562 /* open the queue directory */
2566 syserr("gatherq: cannot open \"%s\"",
2567 qid_printqueue(qgrp, qdir));
2569 *full = WorkListCount >= MaxQueueRun && MaxQueueRun > 0;
2576 ** Read the work directory.
2579 while ((d = readdir(f)) != NULL)
2583 char lbuf[MAXNAME + 1];
2587 sm_dprintf("gatherq: checking %s..", d->d_name);
2589 /* is this an interesting entry? */
2590 if (!(((QueueMode == QM_NORMAL &&
2591 d->d_name[0] == NORMQF_LETTER) ||
2592 (QueueMode == QM_QUARANTINE &&
2593 d->d_name[0] == QUARQF_LETTER) ||
2594 (QueueMode == QM_LOST &&
2595 d->d_name[0] == LOSEQF_LETTER)) &&
2596 d->d_name[1] == 'f'))
2599 sm_dprintf(" skipping\n");
2605 if (strlen(d->d_name) >= MAXQFNAME)
2608 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
2609 "gatherq: %s too long, %d max characters\n",
2610 d->d_name, MAXQFNAME);
2612 sm_syslog(LOG_ALERT, NOQID,
2613 "gatherq: %s too long, %d max characters",
2614 d->d_name, MAXQFNAME);
2619 check = QueueLimitId;
2620 while (check != NULL)
2622 if (strcontainedin(false, check->queue_match,
2623 d->d_name) != check->queue_negate)
2626 check = check->queue_next;
2628 if (QueueLimitId != NULL && check == NULL)
2631 /* grow work list if necessary */
2632 if (++wn >= MaxQueueRun && MaxQueueRun > 0)
2634 if (wn == MaxQueueRun && LogLevel > 0)
2635 sm_syslog(LOG_WARNING, NOQID,
2636 "WorkList for %s maxed out at %d",
2637 qid_printqueue(qgrp, qdir),
2640 continue; /* just count entries */
2643 if (wn >= WorkListSize)
2645 grow_wlist(qgrp, qdir);
2646 if (wn >= WorkListSize)
2652 (void) sm_strlcpyn(qf, sizeof(qf), 3, qd, "/", d->d_name);
2653 if (stat(qf, &sbuf) < 0)
2655 if (errno != ENOENT)
2656 sm_syslog(LOG_INFO, NOQID,
2657 "gatherq: can't stat %s/%s",
2658 qid_printqueue(qgrp, qdir),
2663 if (!bitset(S_IFREG, sbuf.st_mode))
2665 /* Yikes! Skip it or we will hang on open! */
2666 if (!((d->d_name[0] == DATAFL_LETTER ||
2667 d->d_name[0] == NORMQF_LETTER ||
2668 d->d_name[0] == QUARQF_LETTER ||
2669 d->d_name[0] == LOSEQF_LETTER ||
2670 d->d_name[0] == XSCRPT_LETTER) &&
2671 d->d_name[1] == 'f' && d->d_name[2] == '\0'))
2672 syserr("gatherq: %s/%s is not a regular file",
2673 qid_printqueue(qgrp, qdir), d->d_name);
2678 /* avoid work if possible */
2679 if ((QueueSortOrder == QSO_BYFILENAME ||
2680 QueueSortOrder == QSO_BYMODTIME ||
2681 QueueSortOrder == QSO_NONE ||
2682 QueueSortOrder == QSO_RANDOM) &&
2683 QueueLimitQuarantine == NULL &&
2684 QueueLimitSender == NULL &&
2685 QueueLimitRecipient == NULL)
2689 w->w_name = newstr(d->d_name);
2691 w->w_lock = w->w_tooyoung = false;
2694 w->w_mtime = sbuf.st_mtime;
2699 /* open control file */
2700 cf = sm_io_open(SmFtStdio, SM_TIME_DEFAULT, qf, SM_IO_RDONLY_B,
2702 if (cf == NULL && OpMode != MD_PRINT)
2704 /* this may be some random person sending hir msgs */
2706 sm_dprintf("gatherq: cannot open %s: %s\n",
2707 d->d_name, sm_errstring(errno));
2714 w->w_name = newstr(d->d_name);
2718 w->w_lock = !lockfile(sm_io_getinfo(cf, SM_IO_WHAT_FD,
2723 w->w_tooyoung = false;
2725 /* make sure jobs in creation don't clog queue */
2726 w->w_pri = 0x7fffffff;
2728 w->w_mtime = sbuf.st_mtime;
2730 /* extract useful information */
2732 if (QueueSortOrder == QSO_BYHOST
2734 || QueueSortOrder == QSO_BYSHUFFLE
2735 #endif /* _FFR_RHS */
2738 /* need w_host set for host sort order */
2741 if (QueueLimitSender != NULL)
2743 if (QueueLimitRecipient != NULL)
2745 if (QueueLimitQuarantine != NULL)
2746 i |= NEED_QUARANTINE;
2747 while (cf != NULL && i != 0 &&
2748 sm_io_fgets(cf, SM_TIME_DEFAULT, lbuf,
2754 p = strchr(lbuf, '\n');
2759 /* flush rest of overly long line */
2760 while ((c = sm_io_getc(cf, SM_TIME_DEFAULT))
2761 != SM_IO_EOF && c != '\n')
2768 qfver = atoi(&lbuf[1]);
2772 w->w_pri = atol(&lbuf[1]);
2777 w->w_ctime = atol(&lbuf[1]);
2782 if (QueueMode != QM_QUARANTINE &&
2783 QueueMode != QM_LOST)
2786 sm_dprintf("%s not marked as quarantined but has a 'q' line\n",
2788 i |= HAS_QUARANTINE;
2790 else if (QueueMode == QM_QUARANTINE)
2792 if (QueueLimitQuarantine == NULL)
2794 i &= ~NEED_QUARANTINE;
2798 check = QueueLimitQuarantine;
2799 while (check != NULL)
2801 if (strcontainedin(false,
2804 check->queue_negate)
2807 check = check->queue_next;
2810 i &= ~NEED_QUARANTINE;
2815 if (w->w_host == NULL &&
2816 (p = strrchr(&lbuf[1], '@')) != NULL)
2819 if (QueueSortOrder == QSO_BYSHUFFLE)
2820 w->w_host = newstr(&p[1]);
2822 #endif /* _FFR_RHS */
2823 w->w_host = strrev(&p[1]);
2824 makelower(w->w_host);
2827 if (QueueLimitRecipient == NULL)
2834 p = strchr(&lbuf[1], ':');
2838 ++p; /* skip over ':' */
2842 check = QueueLimitRecipient;
2843 while (check != NULL)
2845 if (strcontainedin(true,
2848 check->queue_negate)
2851 check = check->queue_next;
2858 check = QueueLimitSender;
2859 while (check != NULL)
2861 if (strcontainedin(true,
2864 check->queue_negate)
2867 check = check->queue_next;
2875 if (MaxQueueAge > 0)
2877 time_t lasttry, delay;
2879 lasttry = (time_t) atol(&lbuf[1]);
2880 delay = MIN(lasttry - w->w_ctime,
2882 age = curtime() - lasttry;
2884 w->w_tooyoung = true;
2887 #endif /* _FFR_EXPDELAY */
2889 age = curtime() - (time_t) atol(&lbuf[1]);
2890 if (age >= 0 && MinQueueAge > 0 &&
2892 w->w_tooyoung = true;
2896 if (atol(&lbuf[1]) == 0)
2897 w->w_tooyoung = false;
2902 (void) sm_io_close(cf, SM_TIME_DEFAULT);
2904 if ((!doall && (shouldqueue(w->w_pri, w->w_ctime) ||
2906 bitset(HAS_QUARANTINE, i) ||
2907 bitset(NEED_QUARANTINE, i) ||
2908 bitset(NEED_R|NEED_S, i))
2910 /* don't even bother sorting this job in */
2912 sm_dprintf("skipping %s (%x)\n", w->w_name, i);
2913 sm_free(w->w_name); /* XXX */
2914 if (w->w_host != NULL)
2915 sm_free(w->w_host); /* XXX */
2924 i = wn - WorkListCount;
2925 WorkListCount += SM_MIN(num_ent, WorkListSize);
2928 *more = WorkListCount < wn;
2931 *full = (wn >= MaxQueueRun && MaxQueueRun > 0) ||
2932 (WorkList == NULL && wn > 0);
2934 if (pnentries != NULL)
2935 *pnentries = nentries;
2939 ** SORTQ -- sort the work list
2941 ** First the old WorkQ is cleared away. Then the WorkList is sorted
2942 ** for all items so that important (higher sorting value) items are not
2943 ** trunctated off. Then the most important items are moved from
2944 ** WorkList to WorkQ. The lower count of 'max' or MaxListCount items
2948 ** max -- maximum number of items to be placed in WorkQ
2951 ** the number of items in WorkQ
2954 ** WorkQ gets released and filled with new work. WorkList
2955 ** gets released. Work items get sorted in order.
2962 register int i; /* local counter */
2963 register WORK *w; /* tmp item pointer */
2964 int wc = WorkListCount; /* trim size for WorkQ */
2970 /* Clear out old WorkQ. */
2971 for (w = WorkQ; w != NULL; w = nw)
2974 sm_free(w->w_name); /* XXX */
2975 if (w->w_host != NULL)
2976 sm_free(w->w_host); /* XXX */
2977 sm_free((char *) w); /* XXX */
2982 if (WorkList == NULL || wc <= 0)
2986 ** The sort now takes place using all of the items in WorkList.
2987 ** The list gets trimmed to the most important items after the sort.
2988 ** If the trim were to happen before the sort then one or more
2989 ** important items might get truncated off -- not what we want.
2992 if (QueueSortOrder == QSO_BYHOST)
2995 ** Sort the work directory for the first time,
2996 ** based on host name, lock status, and priority.
2999 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf1);
3002 ** If one message to host is locked, "lock" all messages
3009 if (!WorkList[i].w_lock)
3017 if (WorkList[i].w_host == NULL &&
3019 WorkList[i].w_lock = true;
3020 else if (WorkList[i].w_host != NULL &&
3021 w->w_host != NULL &&
3022 sm_strcasecmp(WorkList[i].w_host,
3024 WorkList[i].w_lock = true;
3031 ** Sort the work directory for the second time,
3032 ** based on lock status, host name, and priority.
3035 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf2);
3037 else if (QueueSortOrder == QSO_BYTIME)
3040 ** Simple sort based on submission time only.
3043 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf3);
3045 else if (QueueSortOrder == QSO_BYFILENAME)
3048 ** Sort based on queue filename.
3051 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf4);
3053 else if (QueueSortOrder == QSO_RANDOM)
3056 ** Sort randomly. To avoid problems with an instable sort,
3057 ** use a random index into the queue file name to start
3061 randi = get_rand_mod(MAXQFNAME);
3064 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf5);
3066 else if (QueueSortOrder == QSO_BYMODTIME)
3069 ** Simple sort based on modification time of queue file.
3070 ** This puts the oldest items first.
3073 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf6);
3076 else if (QueueSortOrder == QSO_BYSHUFFLE)
3079 ** Simple sort based on shuffled host name.
3082 init_shuffle_alphabet();
3083 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf7);
3085 #endif /* _FFR_RHS */
3086 else if (QueueSortOrder == QSO_BYPRIORITY)
3089 ** Simple sort based on queue priority only.
3092 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf0);
3094 /* else don't sort at all */
3096 /* Check if the per queue group item limit will be exceeded */
3097 if (wc > max && max > 0)
3101 ** Convert the work list into canonical form.
3102 ** Should be turning it into a list of envelopes here perhaps.
3103 ** Only take the most important items up to the per queue group
3107 for (i = wc; --i >= 0; )
3109 w = (WORK *) xalloc(sizeof(*w));
3110 w->w_qgrp = WorkList[i].w_qgrp;
3111 w->w_qdir = WorkList[i].w_qdir;
3112 w->w_name = WorkList[i].w_name;
3113 w->w_host = WorkList[i].w_host;
3114 w->w_lock = WorkList[i].w_lock;
3115 w->w_tooyoung = WorkList[i].w_tooyoung;
3116 w->w_pri = WorkList[i].w_pri;
3117 w->w_ctime = WorkList[i].w_ctime;
3118 w->w_mtime = WorkList[i].w_mtime;
3123 /* free the rest of the list */
3124 for (i = WorkListCount; --i >= wc; )
3126 sm_free(WorkList[i].w_name);
3127 if (WorkList[i].w_host != NULL)
3128 sm_free(WorkList[i].w_host);
3131 if (WorkList != NULL)
3132 sm_free(WorkList); /* XXX */
3139 for (w = WorkQ; w != NULL; w = w->w_next)
3141 if (w->w_host != NULL)
3142 sm_dprintf("%22s: pri=%ld %s\n",
3143 w->w_name, w->w_pri, w->w_host);
3145 sm_dprintf("%32s: pri=%ld\n",
3146 w->w_name, w->w_pri);
3150 return wc; /* return number of WorkQ items */
3153 ** GROW_WLIST -- make the work list larger
3156 ** qgrp -- the index for the queue group.
3157 ** qdir -- the index for the queue directory.
3163 ** Adds another QUEUESEGSIZE entries to WorkList if possible.
3164 ** It can fail if there isn't enough memory, so WorkListSize
3165 ** should be checked again upon return.
3169 grow_wlist(qgrp, qdir)
3174 sm_dprintf("grow_wlist: WorkListSize=%d\n", WorkListSize);
3175 if (WorkList == NULL)
3177 WorkList = (WORK *) xalloc((sizeof(*WorkList)) *
3178 (QUEUESEGSIZE + 1));
3179 WorkListSize = QUEUESEGSIZE;
3183 int newsize = WorkListSize + QUEUESEGSIZE;
3184 WORK *newlist = (WORK *) sm_realloc((char *) WorkList,
3185 (unsigned) sizeof(WORK) * (newsize + 1));
3187 if (newlist != NULL)
3189 WorkListSize = newsize;
3193 sm_syslog(LOG_INFO, NOQID,
3194 "grew WorkList for %s to %d",
3195 qid_printqueue(qgrp, qdir),
3199 else if (LogLevel > 0)
3201 sm_syslog(LOG_ALERT, NOQID,
3202 "FAILED to grow WorkList for %s to %d",
3203 qid_printqueue(qgrp, qdir), newsize);
3207 sm_dprintf("grow_wlist: WorkListSize now %d\n", WorkListSize);
3210 ** WORKCMPF0 -- simple priority-only compare function.
3213 ** a -- the first argument.
3214 ** b -- the second argument.
3239 ** WORKCMPF1 -- first compare function for ordering work based on host name.
3241 ** Sorts on host name, lock status, and priority in that order.
3244 ** a -- the first argument.
3245 ** b -- the second argument.
3262 if (a->w_host != NULL && b->w_host == NULL)
3264 else if (a->w_host == NULL && b->w_host != NULL)
3266 if (a->w_host != NULL && b->w_host != NULL &&
3267 (i = sm_strcasecmp(a->w_host, b->w_host)) != 0)
3271 if (a->w_lock != b->w_lock)
3272 return b->w_lock - a->w_lock;
3275 return workcmpf0(a, b);
3278 ** WORKCMPF2 -- second compare function for ordering work based on host name.
3280 ** Sorts on lock status, host name, and priority in that order.
3283 ** a -- the first argument.
3284 ** b -- the second argument.
3301 if (a->w_lock != b->w_lock)
3302 return a->w_lock - b->w_lock;
3305 if (a->w_host != NULL && b->w_host == NULL)
3307 else if (a->w_host == NULL && b->w_host != NULL)
3309 if (a->w_host != NULL && b->w_host != NULL &&
3310 (i = sm_strcasecmp(a->w_host, b->w_host)) != 0)
3314 return workcmpf0(a, b);
3317 ** WORKCMPF3 -- simple submission-time-only compare function.
3320 ** a -- the first argument.
3321 ** b -- the second argument.
3335 if (a->w_ctime > b->w_ctime)
3337 else if (a->w_ctime < b->w_ctime)
3343 ** WORKCMPF4 -- compare based on file name
3346 ** a -- the first argument.
3347 ** b -- the second argument.
3361 return strcmp(a->w_name, b->w_name);
3364 ** WORKCMPF5 -- compare based on assigned random number
3367 ** a -- the first argument.
3368 ** b -- the second argument.
3380 if (strlen(a->w_name) < randi || strlen(b->w_name) < randi)
3382 return a->w_name[randi] - b->w_name[randi];
3385 ** WORKCMPF6 -- simple modification-time-only compare function.
3388 ** a -- the first argument.
3389 ** b -- the second argument.
3403 if (a->w_mtime > b->w_mtime)
3405 else if (a->w_mtime < b->w_mtime)
3412 ** WORKCMPF7 -- compare function for ordering work based on shuffled host name.
3414 ** Sorts on lock status, host name, and priority in that order.
3417 ** a -- the first argument.
3418 ** b -- the second argument.
3435 if (a->w_lock != b->w_lock)
3436 return a->w_lock - b->w_lock;
3439 if (a->w_host != NULL && b->w_host == NULL)
3441 else if (a->w_host == NULL && b->w_host != NULL)
3443 if (a->w_host != NULL && b->w_host != NULL &&
3444 (i = sm_strshufflecmp(a->w_host, b->w_host)) != 0)
3448 return workcmpf0(a, b);
3450 #endif /* _FFR_RHS */
3452 ** STRREV -- reverse string
3454 ** Returns a pointer to a new string that is the reverse of
3455 ** the string pointed to by fwd. The space for the new
3456 ** string is obtained using xalloc().
3459 ** fwd -- the string to reverse.
3462 ** the reversed string.
3473 rev = xalloc(len + 1);
3474 for (cnt = 0; cnt < len; ++cnt)
3475 rev[cnt] = fwd[len - cnt - 1];
3485 static unsigned char ShuffledAlphabet[NCHAR];
3488 init_shuffle_alphabet()
3490 static bool init = false;
3496 /* fill the ShuffledAlphabet */
3497 for (i = 0; i < NASCII; i++)
3498 ShuffledAlphabet[i] = i;
3501 for (i = 1; i < NASCII; i++)
3503 register int j = get_random() % NASCII;
3506 tmp = ShuffledAlphabet[j];
3507 ShuffledAlphabet[j] = ShuffledAlphabet[i];
3508 ShuffledAlphabet[i] = tmp;
3511 /* make it case insensitive */
3512 for (i = 'A'; i <= 'Z'; i++)
3513 ShuffledAlphabet[i] = ShuffledAlphabet[i + 'a' - 'A'];
3515 /* fill the upper part */
3516 for (i = 0; i < NASCII; i++)
3517 ShuffledAlphabet[i + NASCII] = ShuffledAlphabet[i];
3522 sm_strshufflecmp(a, b)
3526 const unsigned char *us1 = (const unsigned char *) a;
3527 const unsigned char *us2 = (const unsigned char *) b;
3529 while (ShuffledAlphabet[*us1] == ShuffledAlphabet[*us2++])
3534 return (ShuffledAlphabet[*us1] - ShuffledAlphabet[*--us2]);
3536 #endif /* _FFR_RHS */
3539 ** DOWORK -- do a work request.
3542 ** qgrp -- the index of the queue group for the job.
3543 ** qdir -- the index of the queue directory for the job.
3544 ** id -- the ID of the job to run.
3545 ** forkflag -- if set, run this in background.
3546 ** requeueflag -- if set, reinstantiate the queue quickly.
3547 ** This is used when expanding aliases in the queue.
3548 ** If forkflag is also set, it doesn't wait for the
3550 ** e - the envelope in which to run it.
3553 ** process id of process that is running the queue job.
3556 ** The work request is satisfied if possible.
3560 dowork(qgrp, qdir, id, forkflag, requeueflag, e)
3566 register ENVELOPE *e;
3572 sm_dprintf("dowork(%s/%s)\n", qid_printqueue(qgrp, qdir), id);
3581 ** Since the delivery may happen in a child and the
3582 ** parent does not wait, the parent may close the
3583 ** maps thereby removing any shared memory used by
3584 ** the map. Therefore, close the maps now so the
3585 ** child will dynamically open them if necessary.
3593 syserr("dowork: cannot fork");
3598 /* parent -- clean out connection cache */
3599 mci_flush(false, NULL);
3604 ** Initialize exception stack and default exception
3605 ** handler for child process.
3608 /* Reset global flags */
3609 RestartRequest = NULL;
3610 RestartWorkGroup = false;
3611 ShutdownRequest = NULL;
3613 CurrentPid = getpid();
3614 sm_exc_newthread(fatal_error);
3617 ** See note above about SMTP processes and SIGCHLD.
3620 if (OpMode == MD_SMTP ||
3621 OpMode == MD_DAEMON ||
3622 MaxQueueChildren > 0)
3625 sm_releasesignal(SIGCHLD);
3626 (void) sm_signal(SIGCHLD, SIG_DFL);
3629 /* child -- error messages to the transcript */
3630 QuickAbort = OnlyOneError = false;
3642 ** Lock the control file to avoid duplicate deliveries.
3643 ** Then run the file as though we had just read it.
3644 ** We save an idea of the temporary name so we
3645 ** can recover on interrupt.
3650 /* Reset global flags */
3651 RestartRequest = NULL;
3652 RestartWorkGroup = false;
3653 ShutdownRequest = NULL;
3657 /* set basic modes, etc. */
3660 rpool = sm_rpool_new_x(NULL);
3661 clearenvelope(e, false, rpool);
3662 e->e_flags |= EF_QUEUERUN|EF_GLOBALERRS;
3663 set_delivery_mode(SM_DELIVER, e);
3664 e->e_errormode = EM_MAIL;
3668 GrabTo = UseErrorsTo = false;
3673 set_op_mode(MD_QUEUERUN);
3675 sm_setproctitle(true, e, "%s from queue", qid_printname(e));
3677 sm_syslog(LOG_DEBUG, e->e_id, "dowork, pid=%d",
3680 /* don't use the headers from sendmail.cf... */
3683 /* read the queue control file -- return if locked */
3684 if (!readqf(e, false))
3686 if (tTd(40, 4) && e->e_id != NULL)
3687 sm_dprintf("readqf(%s) failed\n",
3691 finis(false, true, EX_OK);
3694 /* adding this frees 8 bytes */
3695 clearenvelope(e, false, rpool);
3697 /* adding this frees 12 bytes */
3698 sm_rpool_free(rpool);
3704 e->e_flags |= EF_INQUEUE;
3705 eatheader(e, requeueflag, true);
3708 queueup(e, false, false);
3710 /* do the delivery */
3711 sendall(e, SM_DELIVER);
3713 /* finish up and exit */
3715 finis(true, true, ExitStat);
3718 (void) dropenvelope(e, true, false);
3719 sm_rpool_free(rpool);
3721 e->e_message = NULL;
3729 ** DOWORKLIST -- process a list of envelopes as work requests
3731 ** Similar to dowork(), except that after forking, it processes an
3732 ** envelope and its siblings, treating each envelope as a work request.
3735 ** el -- envelope to be processed including its siblings.
3736 ** forkflag -- if set, run this in background.
3737 ** requeueflag -- if set, reinstantiate the queue quickly.
3738 ** This is used when expanding aliases in the queue.
3739 ** If forkflag is also set, it doesn't wait for the
3743 ** process id of process that is running the queue job.
3746 ** The work request is satisfied if possible.
3750 doworklist(el, forkflag, requeueflag)
3759 sm_dprintf("doworklist()\n");
3768 ** Since the delivery may happen in a child and the
3769 ** parent does not wait, the parent may close the
3770 ** maps thereby removing any shared memory used by
3771 ** the map. Therefore, close the maps now so the
3772 ** child will dynamically open them if necessary.
3780 syserr("doworklist: cannot fork");
3785 /* parent -- clean out connection cache */
3786 mci_flush(false, NULL);
3791 ** Initialize exception stack and default exception
3792 ** handler for child process.
3795 /* Reset global flags */
3796 RestartRequest = NULL;
3797 RestartWorkGroup = false;
3798 ShutdownRequest = NULL;
3800 CurrentPid = getpid();
3801 sm_exc_newthread(fatal_error);
3804 ** See note above about SMTP processes and SIGCHLD.
3807 if (OpMode == MD_SMTP ||
3808 OpMode == MD_DAEMON ||
3809 MaxQueueChildren > 0)
3812 sm_releasesignal(SIGCHLD);
3813 (void) sm_signal(SIGCHLD, SIG_DFL);
3816 /* child -- error messages to the transcript */
3817 QuickAbort = OnlyOneError = false;
3830 ** Lock the control file to avoid duplicate deliveries.
3831 ** Then run the file as though we had just read it.
3832 ** We save an idea of the temporary name so we
3833 ** can recover on interrupt.
3838 /* Reset global flags */
3839 RestartRequest = NULL;
3840 RestartWorkGroup = false;
3841 ShutdownRequest = NULL;
3845 /* set basic modes, etc. */
3848 GrabTo = UseErrorsTo = false;
3853 set_op_mode(MD_QUEUERUN);
3856 sm_syslog(LOG_DEBUG, el->e_id, "doworklist, pid=%d",
3859 for (ei = el; ei != NULL; ei = ei->e_sibling)
3864 if (WILL_BE_QUEUED(ei->e_sendmode))
3866 else if (QueueMode != QM_QUARANTINE &&
3867 ei->e_quarmsg != NULL)
3870 rpool = sm_rpool_new_x(NULL);
3871 clearenvelope(&e, true, rpool);
3872 e.e_flags |= EF_QUEUERUN|EF_GLOBALERRS;
3873 set_delivery_mode(SM_DELIVER, &e);
3874 e.e_errormode = EM_MAIL;
3876 e.e_qgrp = ei->e_qgrp;
3877 e.e_qdir = ei->e_qdir;
3879 sm_setproctitle(true, &e, "%s from queue", qid_printname(&e));
3881 /* don't use the headers from sendmail.cf... */
3885 /* read the queue control file -- return if locked */
3886 if (readqf(&e, false))
3888 e.e_flags |= EF_INQUEUE;
3889 eatheader(&e, requeueflag, true);
3892 queueup(&e, false, false);
3894 /* do the delivery */
3895 sendall(&e, SM_DELIVER);
3896 (void) dropenvelope(&e, true, false);
3900 if (tTd(40, 4) && e.e_id != NULL)
3901 sm_dprintf("readqf(%s) failed\n",
3904 sm_rpool_free(rpool);
3908 /* restore CurEnv */
3911 /* finish up and exit */
3913 finis(true, true, ExitStat);
3917 ** READQF -- read queue file and set up environment.
3920 ** e -- the envelope of the job to run.
3921 ** openonly -- only open the qf (returned as e_lockfp)
3924 ** true if it successfully read the queue file.
3928 ** The queue file is returned locked.
3933 register ENVELOPE *e;
3936 register SM_FILE_T *qfp;
3938 struct stat st, stf;
3945 bool nomore = false;
3949 char qf[MAXPATHLEN];
3954 ** Read and process the file.
3957 SM_REQUIRE(e != NULL);
3959 (void) sm_strlcpy(qf, queuename(e, ANYQFL_LETTER), sizeof(qf));
3960 qfp = sm_io_open(SmFtStdio, SM_TIME_DEFAULT, qf, SM_IO_RDWR_B, NULL);
3963 int save_errno = errno;
3966 sm_dprintf("readqf(%s): sm_io_open failure (%s)\n",
3967 qf, sm_errstring(errno));
3971 syserr("readqf: no control file %s", qf);
3976 if (!lockfile(sm_io_getinfo(qfp, SM_IO_WHAT_FD, NULL), qf, NULL,
3979 /* being processed by another queuer */
3981 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
3982 "%s: locked\n", e->e_id);
3984 sm_dprintf("%s: locked\n", e->e_id);
3986 sm_syslog(LOG_DEBUG, e->e_id, "locked");
3987 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
3995 ** Prevent locking race condition.
3997 ** Process A: readqf(): qfp = fopen(qffile)
3998 ** Process B: queueup(): rename(tf, qf)
3999 ** Process B: unlocks(tf)
4000 ** Process A: lockfile(qf);
4002 ** Process A (us) has the old qf file (before the rename deleted
4003 ** the directory entry) and will be delivering based on old data.
4004 ** This can lead to multiple deliveries of the same recipients.
4006 ** Catch this by checking if the underlying qf file has changed
4007 ** *after* acquiring our lock and if so, act as though the file
4008 ** was still locked (i.e., just return like the lockfile() case
4012 if (stat(qf, &stf) < 0 ||
4013 fstat(sm_io_getinfo(qfp, SM_IO_WHAT_FD, NULL), &st) < 0)
4015 /* must have been being processed by someone else */
4017 sm_dprintf("readqf(%s): [f]stat failure (%s)\n",
4018 qf, sm_errstring(errno));
4019 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4023 if (st.st_nlink != stf.st_nlink ||
4024 st.st_dev != stf.st_dev ||
4025 ST_INODE(st) != ST_INODE(stf) ||
4026 #if HAS_ST_GEN && 0 /* AFS returns garbage in st_gen */
4027 st.st_gen != stf.st_gen ||
4028 #endif /* HAS_ST_GEN && 0 */
4029 st.st_uid != stf.st_uid ||
4030 st.st_gid != stf.st_gid ||
4031 st.st_size != stf.st_size)
4033 /* changed after opened */
4035 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4036 "%s: changed\n", e->e_id);
4038 sm_dprintf("%s: changed\n", e->e_id);
4040 sm_syslog(LOG_DEBUG, e->e_id, "changed");
4041 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4046 ** Check the queue file for plausibility to avoid attacks.
4049 qsafe = S_IWOTH|S_IWGRP;
4050 if (bitset(S_IWGRP, QueueFileMode))
4053 bogus = st.st_uid != geteuid() &&
4054 st.st_uid != TrustedUid &&
4055 geteuid() != RealUid;
4058 ** If this qf file results from a set-group-ID binary, then
4059 ** we check whether the directory is group-writable,
4060 ** the queue file mode contains the group-writable bit, and
4061 ** the groups are the same.
4062 ** Notice: this requires that the set-group-ID binary is used to
4066 if (bogus && st.st_gid == getegid() && UseMSP)
4071 bp = SM_LAST_DIR_DELIM(qf);
4079 if (stat(delim == '\0' ? "." : qf, &dst) < 0)
4080 syserr("readqf: cannot stat directory %s",
4081 delim == '\0' ? "." : qf);
4084 bogus = !(bitset(S_IWGRP, QueueFileMode) &&
4085 bitset(S_IWGRP, dst.st_mode) &&
4086 dst.st_gid == st.st_gid);
4093 bogus = bitset(qsafe, st.st_mode);
4098 sm_syslog(LOG_ALERT, e->e_id,
4099 "bogus queue file, uid=%d, gid=%d, mode=%o",
4100 st.st_uid, st.st_gid, st.st_mode);
4103 sm_dprintf("readqf(%s): bogus file\n", qf);
4104 e->e_flags |= EF_INQUEUE;
4106 loseqfile(e, "bogus file uid/gid in mqueue");
4107 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4111 if (st.st_size == 0)
4113 /* must be a bogus file -- if also old, just remove it */
4114 if (!openonly && st.st_ctime + 10 * 60 < curtime())
4116 (void) xunlink(queuename(e, DATAFL_LETTER));
4117 (void) xunlink(queuename(e, ANYQFL_LETTER));
4119 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4123 if (st.st_nlink == 0)
4126 ** Race condition -- we got a file just as it was being
4127 ** unlinked. Just assume it is zero length.
4130 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4136 ** If we don't own the file mark it as unsafe.
4137 ** However, allow TrustedUser to own it as well
4138 ** in case TrustedUser manipulates the queue.
4141 if (st.st_uid != geteuid() && st.st_uid != TrustedUid)
4142 e->e_flags |= EF_UNSAFE;
4143 #else /* _FFR_TRUSTED_QF */
4144 /* If we don't own the file mark it as unsafe */
4145 if (st.st_uid != geteuid())
4146 e->e_flags |= EF_UNSAFE;
4147 #endif /* _FFR_TRUSTED_QF */
4149 /* good file -- save this lock */
4152 /* Just wanted the open file */
4156 /* do basic system initialization */
4158 macdefine(&e->e_macro, A_PERM, 'i', e->e_id);
4161 e->e_flags |= EF_GLOBALERRS;
4162 set_op_mode(MD_QUEUERUN);
4164 e->e_qfletter = queue_letter(e, ANYQFL_LETTER);
4165 e->e_dfqgrp = e->e_qgrp;
4166 e->e_dfqdir = e->e_qdir;
4167 #if _FFR_QUEUE_MACRO
4168 macdefine(&e->e_macro, A_TEMP, macid("{queue}"),
4169 qid_printqueue(e->e_qgrp, e->e_qdir));
4170 #endif /* _FFR_QUEUE_MACRO */
4173 while (bufsize = sizeof(buf),
4174 (bp = fgetfolded(buf, &bufsize, qfp)) != NULL)
4176 unsigned long qflags;
4183 sm_dprintf("+++++ %s\n", bp);
4188 syserr("SECURITY ALERT: extra or bogus data in queue file: %s",
4190 err = "bogus queue line";
4195 case 'A': /* AUTH= parameter */
4196 if (!xtextok(&bp[1]))
4198 e->e_auth_param = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4201 case 'B': /* body type */
4202 r = check_bodytype(&bp[1]);
4203 if (!BODYTYPE_VALID(r))
4205 e->e_bodytype = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4208 case 'C': /* specify controlling user */
4209 ctladdr = setctluser(&bp[1], qfver, e);
4212 case 'D': /* data file name */
4213 /* obsolete -- ignore */
4216 case 'd': /* data file directory name */
4220 #if _FFR_MSP_PARANOIA
4221 /* forbid queue groups in MSP? */
4224 #endif /* _FFR_MSP_PARANOIA */
4226 qgrp < NumQueue && Queue[qgrp] != NULL;
4230 qdir < Queue[qgrp]->qg_numqueues;
4234 Queue[qgrp]->qg_qpaths[qdir].qp_name)
4243 err = "bogus queue file directory";
4249 case 'E': /* specify error recipient */
4250 /* no longer used */
4253 case 'F': /* flag bits */
4254 if (strncmp(bp, "From ", 5) == 0)
4256 /* we are being spoofed! */
4257 syserr("SECURITY ALERT: bogus qf line %s", bp);
4258 err = "bogus queue line";
4261 for (p = &bp[1]; *p != '\0'; p++)
4265 case '8': /* has 8 bit data */
4266 e->e_flags |= EF_HAS8BIT;
4269 case 'b': /* delete Bcc: header */
4270 e->e_flags |= EF_DELETE_BCC;
4273 case 'd': /* envelope has DSN RET= */
4274 e->e_flags |= EF_RET_PARAM;
4277 case 'n': /* don't return body */
4278 e->e_flags |= EF_NO_BODY_RETN;
4281 case 'r': /* response */
4282 e->e_flags |= EF_RESPONSE;
4285 case 's': /* split */
4286 e->e_flags |= EF_SPLIT;
4289 case 'w': /* warning sent */
4290 e->e_flags |= EF_WARNING;
4296 case 'q': /* quarantine reason */
4297 e->e_quarmsg = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4298 macdefine(&e->e_macro, A_PERM,
4299 macid("{quarantine}"), e->e_quarmsg);
4302 case 'H': /* header */
4305 ** count size before chompheader() destroys the line.
4306 ** this isn't accurate due to macro expansion, but
4307 ** better than before. "-3" to skip H?? at least.
4310 hdrsize += strlen(bp) - 3;
4311 (void) chompheader(&bp[1], CHHDR_QUEUE, NULL, e);
4314 case 'I': /* data file's inode number */
4315 /* regenerated below */
4318 case 'K': /* time of last delivery attempt */
4319 e->e_dtime = atol(&buf[1]);
4322 case 'L': /* Solaris Content-Length: */
4323 case 'M': /* message */
4324 /* ignore this; we want a new message next time */
4327 case 'N': /* number of delivery attempts */
4328 e->e_ntries = atoi(&buf[1]);
4330 /* if this has been tried recently, let it be */
4332 if (e->e_ntries > 0 && e->e_dtime <= now &&
4333 now < e->e_dtime + MinQueueAge)
4337 howlong = pintvl(now - e->e_dtime, true);
4339 (void) sm_io_fprintf(smioout,
4341 "%s: too young (%s)\n",
4344 sm_dprintf("%s: too young (%s)\n",
4347 sm_syslog(LOG_DEBUG, e->e_id,
4356 macdefine(&e->e_macro, A_TEMP,
4357 macid("{ntries}"), &buf[1]);
4360 /* adjust BIND parameters immediately */
4361 if (e->e_ntries == 0)
4363 _res.retry = TimeOuts.res_retry[RES_TO_FIRST];
4364 _res.retrans = TimeOuts.res_retrans[RES_TO_FIRST];
4368 _res.retry = TimeOuts.res_retry[RES_TO_NORMAL];
4369 _res.retrans = TimeOuts.res_retrans[RES_TO_NORMAL];
4371 #endif /* NAMED_BIND */
4374 case 'P': /* message priority */
4375 e->e_msgpriority = atol(&bp[1]) + WkTimeFact;
4378 case 'Q': /* original recipient */
4379 orcpt = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4382 case 'r': /* final recipient */
4383 frcpt = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4386 case 'R': /* specify recipient */
4392 while (*++p != '\0' && *p != ':')
4397 qflags |= QHASNOTIFY;
4401 qflags |= QPINGONSUCCESS;
4405 qflags |= QPINGONFAILURE;
4409 qflags |= QPINGONDELAY;
4417 if (ctladdr != NULL)
4418 ctladdr->q_flags |= QALIAS;
4421 default: /* ignore or complain? */
4428 macdefine(&e->e_macro, A_PERM, macid("{addr_type}"),
4431 q = parseaddr(++p, NULLADDR, RF_COPYALL, '\0',
4437 /* make sure we keep the current qgrp */
4438 if (ISVALIDQGRP(e->e_qgrp))
4439 q->q_qgrp = e->e_qgrp;
4440 q->q_alias = ctladdr;
4442 q->q_flags &= ~Q_PINGFLAGS;
4443 q->q_flags |= qflags;
4444 q->q_finalrcpt = frcpt;
4446 (void) recipient(q, &e->e_sendqueue, 0, e);
4450 macdefine(&e->e_macro, A_PERM, macid("{addr_type}"),
4454 case 'S': /* sender */
4455 setsender(sm_rpool_strdup_x(e->e_rpool, &bp[1]),
4456 e, NULL, '\0', true);
4459 case 'T': /* init time */
4460 e->e_ctime = atol(&bp[1]);
4463 case 'V': /* queue file version number */
4464 qfver = atoi(&bp[1]);
4465 if (qfver <= QF_VERSION)
4467 syserr("Version number in queue file (%d) greater than max (%d)",
4469 err = "unsupported queue file version";
4474 case 'Z': /* original envelope id from ESMTP */
4475 e->e_envid = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4476 macdefine(&e->e_macro, A_PERM,
4477 macid("{dsn_envid}"), e->e_envid);
4480 case '!': /* deliver by */
4482 /* format: flag (1 char) space long-integer */
4483 e->e_dlvr_flag = buf[1];
4484 e->e_deliver_by = strtol(&buf[3], NULL, 10);
4486 case '$': /* define macro */
4490 /* XXX elimate p? */
4491 r = macid_parse(&bp[1], &ep);
4494 p = sm_rpool_strdup_x(e->e_rpool, ep);
4495 macdefine(&e->e_macro, A_PERM, r, p);
4499 case '.': /* terminate file */
4508 ** Maintain backward compatibility for
4509 ** users who defined _FFR_QUEUEDELAY in
4510 ** previous releases. Remove this
4511 ** code in 8.14 or 8.15.
4514 if (qfver == 5 || qfver == 7)
4517 /* If not qfver 5 or 7, then 'G' or 'Y' is invalid */
4519 #endif /* _FFR_QUEUEDELAY */
4522 syserr("readqf: %s: line %d: bad line \"%s\"",
4523 qf, LineNumber, shortenstring(bp, MAXSHORTSTR));
4524 err = "unrecognized line";
4533 ** If we haven't read any lines, this queue file is empty.
4534 ** Arrange to remove it without referencing any null pointers.
4537 if (LineNumber == 0)
4540 e->e_flags |= EF_CLRQUEUE|EF_FATALERRS|EF_RESPONSE;
4544 /* Check to make sure we have a complete queue file read */
4547 syserr("readqf: %s: incomplete queue file read", qf);
4548 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4552 #if _FFR_QF_PARANOIA
4553 /* Check to make sure key fields were read */
4554 if (e->e_from.q_mailer == NULL)
4556 syserr("readqf: %s: sender not specified in queue file", qf);
4557 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4561 #endif /* _FFR_QF_PARANOIA */
4563 /* possibly set ${dsn_ret} macro */
4564 if (bitset(EF_RET_PARAM, e->e_flags))
4566 if (bitset(EF_NO_BODY_RETN, e->e_flags))
4567 macdefine(&e->e_macro, A_PERM,
4568 macid("{dsn_ret}"), "hdrs");
4570 macdefine(&e->e_macro, A_PERM,
4571 macid("{dsn_ret}"), "full");
4575 ** Arrange to read the data file.
4578 p = queuename(e, DATAFL_LETTER);
4579 e->e_dfp = sm_io_open(SmFtStdio, SM_TIME_DEFAULT, p, SM_IO_RDONLY_B,
4581 if (e->e_dfp == NULL)
4583 syserr("readqf: cannot open %s", p);
4587 e->e_flags |= EF_HAS_DF;
4588 if (fstat(sm_io_getinfo(e->e_dfp, SM_IO_WHAT_FD, NULL), &st)
4591 e->e_msgsize = st.st_size + hdrsize;
4592 e->e_dfdev = st.st_dev;
4593 e->e_dfino = ST_INODE(st);
4594 (void) sm_snprintf(buf, sizeof(buf), "%ld",
4595 PRT_NONNEGL(e->e_msgsize));
4596 macdefine(&e->e_macro, A_TEMP, macid("{msg_size}"),
4605 ** There was some error reading the qf file (reason is in err var.)
4607 ** close file; clear e_lockfp since it is the same as qfp,
4608 ** hence it is invalid (as file) after qfp is closed;
4609 ** the qf file is on disk, so set the flag to avoid calling
4610 ** queueup() with bogus data.
4616 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4618 e->e_flags |= EF_INQUEUE;
4623 ** PRTSTR -- print a string, "unprintable" characters are shown as \oct
4626 ** s -- string to print
4627 ** ml -- maximum length of output
4630 ** number of entries
4633 ** Prints a string on stdout.
4636 static void prtstr __P((char *, int));
4647 while (ml-- > 0 && ((c = *s++) != '\0'))
4653 (void) sm_io_putc(smioout, SM_TIME_DEFAULT, c);
4654 (void) sm_io_putc(smioout, SM_TIME_DEFAULT, c);
4657 else if (isascii(c) && isprint(c))
4658 (void) sm_io_putc(smioout, SM_TIME_DEFAULT, c);
4662 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4663 "\\%03o", c & 0xFF);
4668 ** PRINTNQE -- print out number of entries in the mail queue
4671 ** out -- output file pointer.
4672 ** prefix -- string to output in front of each line.
4679 printnqe(out, prefix)
4684 int i, k = 0, nrequests = 0;
4685 bool unknown = false;
4687 if (ShmId == SM_SHM_NO_ID)
4690 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4691 "Data unavailable: shared memory not updated\n");
4693 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4694 "%sNOTCONFIGURED:-1\r\n", prefix);
4697 for (i = 0; i < NumQueue && Queue[i] != NULL; i++)
4702 for (j = 0; j < Queue[i]->qg_numqueues; j++)
4709 n = QSHM_ENTRIES(Queue[i]->qg_qpaths[j].qp_idx);
4711 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4713 prefix, qid_printqueue(i, j), n);
4716 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4717 "%s: unknown number of entries\n",
4718 qid_printqueue(i, j));
4723 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4725 qid_printqueue(i, j));
4729 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4731 qid_printqueue(i, j), n);
4737 if (prefix == NULL && k > 1)
4738 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4739 "\t\tTotal requests: %d%s\n",
4740 nrequests, unknown ? " (about)" : "");
4741 #else /* SM_CONF_SHM */
4743 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4744 "Data unavailable without shared memory support\n");
4746 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4747 "%sNOTAVAILABLE:-1\r\n", prefix);
4748 #endif /* SM_CONF_SHM */
4751 ** PRINTQUEUE -- print out a representation of the mail queue
4760 ** Prints a listing of the mail queue on the standard output.
4766 int i, k = 0, nrequests = 0;
4768 for (i = 0; i < NumQueue && Queue[i] != NULL; i++)
4773 for (j = 0; j < Queue[i]->qg_numqueues; j++)
4777 nrequests += print_single_queue(i, j);
4782 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4783 "\t\tTotal requests: %d\n",
4787 ** PRINT_SINGLE_QUEUE -- print out a representation of a single mail queue
4790 ** qgrp -- the index of the queue group.
4791 ** qdir -- the queue directory.
4794 ** number of requests in mail queue.
4797 ** Prints a listing of the mail queue on the standard output.
4801 print_single_queue(qgrp, qdir)
4808 char qd[MAXPATHLEN];
4809 char qddf[MAXPATHLEN];
4814 (void) sm_strlcpy(qd, ".", sizeof(qd));
4815 (void) sm_strlcpy(qddf, ".", sizeof(qddf));
4819 (void) sm_strlcpyn(qd, sizeof(qd), 2,
4820 Queue[qgrp]->qg_qpaths[qdir].qp_name,
4822 Queue[qgrp]->qg_qpaths[qdir].qp_subdirs)
4824 (void) sm_strlcpyn(qddf, sizeof(qddf), 2,
4825 Queue[qgrp]->qg_qpaths[qdir].qp_name,
4827 Queue[qgrp]->qg_qpaths[qdir].qp_subdirs)
4832 ** Check for permission to print the queue
4835 if (bitset(PRIV_RESTRICTMAILQ, PrivacyFlags) && RealUid != 0)
4840 extern GIDSET_T InitialGidSet[NGROUPS_MAX];
4841 #endif /* NGROUPS_MAX */
4843 if (stat(qd, &st) < 0)
4845 syserr("Cannot stat %s",
4846 qid_printqueue(qgrp, qdir));
4853 if (InitialGidSet[n] == st.st_gid)
4856 if (n < 0 && RealGid != st.st_gid)
4857 #else /* NGROUPS_MAX */
4858 if (RealGid != st.st_gid)
4859 #endif /* NGROUPS_MAX */
4861 usrerr("510 You are not permitted to see the queue");
4868 ** Read and order the queue.
4871 nrequests = gatherq(qgrp, qdir, true, NULL, NULL, NULL);
4872 (void) sortq(Queue[qgrp]->qg_maxlist);
4875 ** Print the work list that we have read.
4878 /* first see if there is anything */
4881 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%s is empty\n",
4882 qid_printqueue(qgrp, qdir));
4886 sm_getla(); /* get load average */
4888 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "\t\t%s (%d request%s",
4889 qid_printqueue(qgrp, qdir),
4890 nrequests, nrequests == 1 ? "" : "s");
4891 if (MaxQueueRun > 0 && nrequests > MaxQueueRun)
4892 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4893 ", only %d printed", MaxQueueRun);
4895 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4896 ")\n-----Q-ID----- --Size-- -Priority- ---Q-Time--- --------Sender/Recipient--------\n");
4898 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4899 ")\n-----Q-ID----- --Size-- -----Q-Time----- ------------Sender/Recipient-----------\n");
4900 for (w = WorkQ; w != NULL; w = w->w_next)
4903 auto time_t submittime = 0;
4907 char quarmsg[MAXLINE];
4908 char statmsg[MAXLINE];
4909 char bodytype[MAXNAME + 1];
4910 char qf[MAXPATHLEN];
4915 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%13s",
4917 (void) sm_strlcpyn(qf, sizeof(qf), 3, qd, "/", w->w_name);
4918 f = sm_io_open(SmFtStdio, SM_TIME_DEFAULT, qf, SM_IO_RDONLY_B,
4923 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4924 " (permission denied)\n");
4925 else if (errno == ENOENT)
4926 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4927 " (job completed)\n");
4929 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4931 sm_errstring(errno));
4935 w->w_name[0] = DATAFL_LETTER;
4936 (void) sm_strlcpyn(qf, sizeof(qf), 3, qddf, "/", w->w_name);
4937 if (stat(qf, &st) >= 0)
4938 dfsize = st.st_size;
4944 ** Maybe the df file can't be statted because
4945 ** it is in a different directory than the qf file.
4946 ** In order to find out, we must read the qf file.
4949 newenvelope(&e, &BlankEnvelope, sm_rpool_new_x(NULL));
4950 e.e_id = w->w_name + 2;
4954 if (readqf(&e, false))
4956 char *df = queuename(&e, DATAFL_LETTER);
4957 if (stat(df, &st) >= 0)
4958 dfsize = st.st_size;
4960 if (e.e_lockfp != NULL)
4962 (void) sm_io_close(e.e_lockfp, SM_TIME_DEFAULT);
4965 clearenvelope(&e, false, e.e_rpool);
4966 sm_rpool_free(e.e_rpool);
4969 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "*");
4970 else if (QueueMode == QM_LOST)
4971 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "?");
4972 else if (w->w_tooyoung)
4973 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "-");
4974 else if (shouldqueue(w->w_pri, w->w_ctime))
4975 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "X");
4977 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, " ");
4982 statmsg[0] = bodytype[0] = '\0';
4984 while (sm_io_fgets(f, SM_TIME_DEFAULT, buf, sizeof(buf)) >= 0)
4995 case 'V': /* queue file version */
4996 qfver = atoi(&buf[1]);
4999 case 'M': /* error message */
5000 if ((i = strlen(&buf[1])) >= sizeof(statmsg))
5001 i = sizeof(statmsg) - 1;
5002 memmove(statmsg, &buf[1], i);
5006 case 'q': /* quarantine reason */
5007 if ((i = strlen(&buf[1])) >= sizeof(quarmsg))
5008 i = sizeof(quarmsg) - 1;
5009 memmove(quarmsg, &buf[1], i);
5013 case 'B': /* body type */
5014 if ((i = strlen(&buf[1])) >= sizeof(bodytype))
5015 i = sizeof(bodytype) - 1;
5016 memmove(bodytype, &buf[1], i);
5020 case 'S': /* sender name */
5023 (void) sm_io_fprintf(smioout,
5025 "%8ld %10ld%c%.12s ",
5028 bitset(EF_WARNING, flags)
5030 ctime(&submittime) + 4);
5031 prtstr(&buf[1], 78);
5035 (void) sm_io_fprintf(smioout,
5039 ctime(&submittime));
5040 prtstr(&buf[1], 39);
5043 if (quarmsg[0] != '\0')
5045 (void) sm_io_fprintf(smioout,
5047 "\n QUARANTINE: %.*s",
5053 if (statmsg[0] != '\0' || bodytype[0] != '\0')
5055 (void) sm_io_fprintf(smioout,
5059 if (statmsg[0] != '\0')
5060 (void) sm_io_fprintf(smioout,
5069 case 'C': /* controlling user */
5071 (void) sm_io_fprintf(smioout,
5073 "\n\t\t\t\t\t\t(---%.64s---)",
5077 case 'R': /* recipient name */
5088 (void) sm_io_fprintf(smioout,
5095 (void) sm_io_fprintf(smioout,
5100 if (Verbose && statmsg[0] != '\0')
5102 (void) sm_io_fprintf(smioout,
5110 case 'T': /* creation time */
5111 submittime = atol(&buf[1]);
5114 case 'F': /* flag bits */
5115 for (p = &buf[1]; *p != '\0'; p++)
5120 flags |= EF_WARNING;
5126 if (submittime == (time_t) 0)
5127 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
5128 " (no control file)");
5129 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "\n");
5130 (void) sm_io_close(f, SM_TIME_DEFAULT);
5136 ** QUEUE_LETTER -- get the proper queue letter for the current QueueMode.
5139 ** e -- envelope to build it in/from.
5140 ** type -- the file type, used as the first character
5141 ** of the file name.
5144 ** the letter to use
5148 queue_letter(e, type)
5152 /* Change type according to QueueMode */
5153 if (type == ANYQFL_LETTER)
5155 if (e->e_quarmsg != NULL)
5156 type = QUARQF_LETTER;
5162 type = NORMQF_LETTER;
5166 type = QUARQF_LETTER;
5170 type = LOSEQF_LETTER;
5174 /* should never happen */
5184 ** QUEUENAME -- build a file name in the queue directory for this envelope.
5187 ** e -- envelope to build it in/from.
5188 ** type -- the file type, used as the first character
5189 ** of the file name.
5192 ** a pointer to the queue name (in a static buffer).
5195 ** If no id code is already assigned, queuename() will
5196 ** assign an id code with assign_queueid(). If no queue
5197 ** directory is assigned, one will be set with setnewqueue().
5202 register ENVELOPE *e;
5208 static char buf[MAXPATHLEN];
5210 /* Assign an ID if needed */
5211 if (e->e_id == NULL)
5217 type = queue_letter(e, type);
5219 /* begin of filename */
5220 pref[0] = (char) type;
5224 /* Assign a queue group/directory if needed */
5225 if (type == XSCRPT_LETTER)
5228 ** We don't want to call setnewqueue() if we are fetching
5229 ** the pathname of the transcript file, because setnewqueue
5230 ** chooses a queue, and sometimes we need to write to the
5231 ** transcript file before we have gathered enough information
5232 ** to choose a queue.
5235 if (e->e_xfqgrp == NOQGRP || e->e_xfqdir == NOQDIR)
5237 if (e->e_qgrp != NOQGRP && e->e_qdir != NOQDIR)
5239 e->e_xfqgrp = e->e_qgrp;
5240 e->e_xfqdir = e->e_qdir;
5245 if (Queue[e->e_xfqgrp]->qg_numqueues <= 1)
5249 e->e_xfqdir = get_rand_mod(
5250 Queue[e->e_xfqgrp]->qg_numqueues);
5259 if (e->e_qgrp == NOQGRP || e->e_qdir == NOQDIR)
5263 (void) setnewqueue(e);
5265 if (type == DATAFL_LETTER)
5277 /* xf files always have a valid qd and qg picked above */
5278 if ((qd == NOQDIR || qg == NOQGRP) && type != XSCRPT_LETTER)
5279 (void) sm_strlcpyn(buf, sizeof(buf), 2, pref, e->e_id);
5285 if (bitset(QP_SUBDF, Queue[qg]->qg_qpaths[qd].qp_subdirs))
5294 if (bitset(QP_SUBQF, Queue[qg]->qg_qpaths[qd].qp_subdirs))
5299 if (bitset(QP_SUBXF, Queue[qg]->qg_qpaths[qd].qp_subdirs))
5306 sm_abort("queuename: bad queue file type %d", type);
5309 (void) sm_strlcpyn(buf, sizeof(buf), 4,
5310 Queue[qg]->qg_qpaths[qd].qp_name,
5311 sub, pref, e->e_id);
5315 sm_dprintf("queuename: %s\n", buf);
5320 ** INIT_QID_ALG -- Initialize the (static) parameters that are used to
5321 ** generate a queue ID.
5323 ** This function is called by the daemon to reset
5324 ** LastQueueTime and LastQueuePid which are used by assign_queueid().
5325 ** Otherwise the algorithm may cause problems because
5326 ** LastQueueTime and LastQueuePid are set indirectly by main()
5327 ** before the daemon process is started, hence LastQueuePid is not
5328 ** the pid of the daemon and therefore a child of the daemon can
5329 ** actually have the same pid as LastQueuePid which means the section
5330 ** in assign_queueid():
5331 ** * see if we need to get a new base time/pid *
5332 ** is NOT triggered which will cause the same queue id to be generated.
5349 ** ASSIGN_QUEUEID -- assign a queue ID for this envelope.
5351 ** Assigns an id code if one does not already exist.
5352 ** This code assumes that nothing will remain in the queue for
5353 ** longer than 60 years. It is critical that files with the given
5354 ** name do not already exist in the queue.
5355 ** [No longer initializes e_qdir to NOQDIR.]
5358 ** e -- envelope to set it in.
5364 static const char QueueIdChars[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
5366 # define QIC_LEN_R 62
5369 ** Note: the length is "officially" 60 because minutes and seconds are
5370 ** usually only 0-59. However (Linux):
5371 ** tm_sec The number of seconds after the minute, normally in
5372 ** the range 0 to 59, but can be up to 61 to allow for
5374 ** Hence the real length of the string is 62 to take this into account.
5375 ** Alternatively % QIC_LEN can (should) be used for access everywhere.
5378 # define queuenextid() CurrentPid
5379 #define QIC_LEN_SQR (QIC_LEN * QIC_LEN)
5383 register ENVELOPE *e;
5385 pid_t pid = queuenextid();
5386 static unsigned int cX = 0;
5387 static unsigned int random_offset;
5389 char idbuf[MAXQFNAME - 2];
5392 if (e->e_id != NULL)
5395 /* see if we need to get a new base time/pid */
5396 if (cX >= QIC_LEN_SQR || LastQueueTime == 0 || LastQueuePid != pid)
5398 time_t then = LastQueueTime;
5400 /* if the first time through, pick a random offset */
5401 if (LastQueueTime == 0)
5402 random_offset = ((unsigned int)get_random())
5405 while ((LastQueueTime = curtime()) == then &&
5406 LastQueuePid == pid)
5410 LastQueuePid = queuenextid();
5415 ** Generate a new sequence number between 0 and QIC_LEN_SQR-1.
5416 ** This lets us generate up to QIC_LEN_SQR unique queue ids
5417 ** per second, per process. With envelope splitting,
5418 ** a single message can consume many queue ids.
5421 seq = (cX + random_offset) % QIC_LEN_SQR;
5424 sm_dprintf("assign_queueid: random_offset=%u (%u)\n",
5425 random_offset, seq);
5427 tm = gmtime(&LastQueueTime);
5428 idbuf[0] = QueueIdChars[tm->tm_year % QIC_LEN];
5429 idbuf[1] = QueueIdChars[tm->tm_mon];
5430 idbuf[2] = QueueIdChars[tm->tm_mday];
5431 idbuf[3] = QueueIdChars[tm->tm_hour];
5432 idbuf[4] = QueueIdChars[tm->tm_min % QIC_LEN_R];
5433 idbuf[5] = QueueIdChars[tm->tm_sec % QIC_LEN_R];
5434 idbuf[6] = QueueIdChars[seq / QIC_LEN];
5435 idbuf[7] = QueueIdChars[seq % QIC_LEN];
5436 (void) sm_snprintf(&idbuf[8], sizeof(idbuf) - 8, "%06d",
5437 (int) LastQueuePid);
5438 e->e_id = sm_rpool_strdup_x(e->e_rpool, idbuf);
5439 macdefine(&e->e_macro, A_PERM, 'i', e->e_id);
5441 /* XXX: inherited from MainEnvelope */
5442 e->e_qgrp = NOQGRP; /* too early to do anything else */
5444 e->e_xfqgrp = NOQGRP;
5447 /* New ID means it's not on disk yet */
5448 e->e_qfletter = '\0';
5451 sm_dprintf("assign_queueid: assigned id %s, e=%p\n",
5454 sm_syslog(LOG_DEBUG, e->e_id, "assigned id");
5457 ** SYNC_QUEUE_TIME -- Assure exclusive PID in any given second
5459 ** Make sure one PID can't be used by two processes in any one second.
5461 ** If the system rotates PIDs fast enough, may get the
5462 ** same pid in the same second for two distinct processes.
5463 ** This will interfere with the queue file naming system.
5475 #if FAST_PID_RECYCLE
5476 if (OpMode != MD_TEST &&
5477 OpMode != MD_CHECKCONFIG &&
5478 OpMode != MD_VERIFY &&
5479 LastQueueTime > 0 &&
5480 LastQueuePid == CurrentPid &&
5481 curtime() == LastQueueTime)
5483 #endif /* FAST_PID_RECYCLE */
5486 ** UNLOCKQUEUE -- unlock the queue entry for a specified envelope
5489 ** e -- the envelope to unlock.
5495 ** unlocks the queue for `e'.
5503 sm_dprintf("unlockqueue(%s)\n",
5504 e->e_id == NULL ? "NOQUEUE" : e->e_id);
5507 /* if there is a lock file in the envelope, close it */
5508 if (e->e_lockfp != NULL)
5509 (void) sm_io_close(e->e_lockfp, SM_TIME_DEFAULT);
5512 /* don't create a queue id if we don't already have one */
5513 if (e->e_id == NULL)
5516 /* remove the transcript */
5518 sm_syslog(LOG_DEBUG, e->e_id, "unlock");
5520 (void) xunlink(queuename(e, XSCRPT_LETTER));
5523 ** SETCTLUSER -- create a controlling address
5525 ** Create a fake "address" given only a local login name; this is
5526 ** used as a "controlling user" for future recipient addresses.
5529 ** user -- the user name of the controlling user.
5530 ** qfver -- the version stamp of this queue file.
5534 ** An address descriptor for the controlling user,
5535 ** using storage allocated from e->e_rpool.
5540 setctluser(user, qfver, e)
5545 register ADDRESS *a;
5550 ** See if this clears our concept of controlling user.
5553 if (user == NULL || *user == '\0')
5557 ** Set up addr fields for controlling user.
5560 a = (ADDRESS *) sm_rpool_malloc_x(e->e_rpool, sizeof(*a));
5561 memset((char *) a, '\0', sizeof(*a));
5566 a->q_user = sm_rpool_strdup_x(e->e_rpool, p);
5570 p = strtok(user, ":");
5571 a->q_user = sm_rpool_strdup_x(e->e_rpool, user);
5574 if ((p = strtok(NULL, ":")) != NULL)
5576 if ((p = strtok(NULL, ":")) != NULL)
5578 if ((p = strtok(NULL, ":")) != NULL)
5582 a->q_flags |= QGOODUID;
5584 /* if there is another ':': restore it */
5585 if ((o = strtok(NULL, ":")) != NULL && o > p)
5589 else if ((pw = sm_getpwnam(user)) != NULL)
5591 if (*pw->pw_dir == '\0')
5593 else if (strcmp(pw->pw_dir, "/") == 0)
5596 a->q_home = sm_rpool_strdup_x(e->e_rpool, pw->pw_dir);
5597 a->q_uid = pw->pw_uid;
5598 a->q_gid = pw->pw_gid;
5599 a->q_flags |= QGOODUID;
5603 a->q_flags |= QPRIMARY; /* flag as a "ctladdr" */
5604 a->q_mailer = LocalMailer;
5606 a->q_paddr = sm_rpool_strdup_x(e->e_rpool, a->q_user);
5608 a->q_paddr = sm_rpool_strdup_x(e->e_rpool, p);
5612 ** LOSEQFILE -- rename queue file with LOSEQF_LETTER & try to let someone know
5615 ** e -- the envelope (e->e_id will be used).
5616 ** why -- reported to whomever can hear.
5624 register ENVELOPE *e;
5629 char buf[MAXPATHLEN];
5631 if (e == NULL || e->e_id == NULL)
5633 p = queuename(e, ANYQFL_LETTER);
5634 if (sm_strlcpy(buf, p, sizeof(buf)) >= sizeof(buf))
5636 if (!bitset(EF_INQUEUE, e->e_flags))
5637 queueup(e, false, true);
5638 else if (QueueMode == QM_LOST)
5641 /* if already lost, no need to re-lose */
5644 p = queuename(e, LOSEQF_LETTER);
5645 if (rename(buf, p) < 0)
5646 syserr("cannot rename(%s, %s), uid=%d",
5647 buf, p, (int) geteuid());
5648 else if (LogLevel > 0)
5649 sm_syslog(LOG_ALERT, e->e_id,
5650 "Losing %s: %s", buf, why);
5652 if (e->e_dfp != NULL)
5654 (void) sm_io_close(e->e_dfp, SM_TIME_DEFAULT);
5657 e->e_flags &= ~EF_HAS_DF;
5660 ** NAME2QID -- translate a queue group name to a queue group id
5663 ** queuename -- name of queue group.
5666 ** queue group id if found.
5667 ** NOQGRP otherwise.
5676 s = stab(queuename, ST_QUEUE, ST_FIND);
5679 return s->s_quegrp->qg_index;
5682 ** QID_PRINTNAME -- create externally printable version of queue id
5685 ** e -- the envelope.
5688 ** a printable version
5696 static char idbuf[MAXQFNAME + 34];
5701 if (e->e_id == NULL)
5706 if (e->e_qdir == NOQDIR)
5709 (void) sm_snprintf(idbuf, sizeof(idbuf), "%.32s/%s",
5710 Queue[e->e_qgrp]->qg_qpaths[e->e_qdir].qp_name,
5715 ** QID_PRINTQUEUE -- create full version of queue directory for data files
5718 ** qgrp -- index in queue group.
5719 ** qdir -- the short version of the queue directory
5722 ** the full pathname to the queue (might point to a static var)
5726 qid_printqueue(qgrp, qdir)
5731 static char dir[MAXPATHLEN];
5734 return Queue[qgrp]->qg_qdir;
5736 if (strcmp(Queue[qgrp]->qg_qpaths[qdir].qp_name, ".") == 0)
5739 subdir = Queue[qgrp]->qg_qpaths[qdir].qp_name;
5741 (void) sm_strlcpyn(dir, sizeof(dir), 4,
5742 Queue[qgrp]->qg_qdir,
5743 subdir == NULL ? "" : "/",
5744 subdir == NULL ? "" : subdir,
5746 Queue[qgrp]->qg_qpaths[qdir].qp_subdirs)
5752 ** PICKQDIR -- Pick a queue directory from a queue group
5755 ** qg -- queue group
5756 ** fsize -- file size in bytes
5757 ** e -- envelope, or NULL
5760 ** NOQDIR if no queue directory in qg has enough free space to
5761 ** hold a file of size 'fsize', otherwise the index of
5762 ** a randomly selected queue directory which resides on a
5763 ** file system with enough disk space.
5764 ** XXX This could be extended to select a queuedir with
5765 ** a few (the fewest?) number of entries. That data
5766 ** is available if shared memory is used.
5769 ** If the request fails and e != NULL then sm_syslog is called.
5773 pickqdir(qg, fsize, e)
5782 /* Pick a random directory, as a starting point. */
5783 if (qg->qg_numqueues <= 1)
5786 qdir = get_rand_mod(qg->qg_numqueues);
5791 #endif /* _FFR_TESTS */
5792 if (MinBlocksFree <= 0 && fsize <= 0)
5796 ** Now iterate over the queue directories,
5797 ** looking for a directory with enough space for this message.
5803 QPATHS *qp = &qg->qg_qpaths[i];
5808 needed += fsize / FILE_SYS_BLKSIZE(qp->qp_fsysidx)
5809 + ((fsize % FILE_SYS_BLKSIZE(qp->qp_fsysidx)
5811 if (MinBlocksFree > 0)
5812 needed += MinBlocksFree;
5813 fsavail = FILE_SYS_AVAIL(qp->qp_fsysidx);
5820 ** might be not correctly updated,
5821 ** let's try to get the info directly.
5824 fsavail = freediskspace(FILE_SYS_NAME(qp->qp_fsysidx),
5829 #endif /* SM_CONF_SHM */
5830 if (needed <= fsavail)
5832 if (avail < fsavail)
5835 if (qg->qg_numqueues > 0)
5836 i = (i + 1) % qg->qg_numqueues;
5837 } while (i != qdir);
5839 if (e != NULL && LogLevel > 0)
5840 sm_syslog(LOG_ALERT, e->e_id,
5841 "low on space (%s needs %ld bytes + %ld blocks in %s), max avail: %ld",
5842 CurHostName == NULL ? "SMTP-DAEMON" : CurHostName,
5843 fsize, MinBlocksFree,
5844 qg->qg_qdir, avail);
5848 ** SETNEWQUEUE -- Sets a new queue group and directory
5850 ** Assign a queue group and directory to an envelope and store the
5851 ** directory in e->e_qdir.
5854 ** e -- envelope to assign a queue for.
5857 ** true if successful
5861 ** On success, e->e_qgrp and e->e_qdir are non-negative.
5862 ** On failure (not enough disk space),
5863 ** e->qgrp = NOQGRP, e->e_qdir = NOQDIR
5864 ** and usrerr() is invoked (which could raise an exception).
5872 sm_dprintf("setnewqueue: called\n");
5874 /* not set somewhere else */
5875 if (e->e_qgrp == NOQGRP)
5880 ** Use the queue group of the "first" recipient, as set by
5881 ** the "queuegroup" rule set. If that is not defined, then
5882 ** use the queue group of the mailer of the first recipient.
5883 ** If that is not defined either, then use the default
5885 ** Notice: "first" depends on the sorting of sendqueue
5887 ** To avoid problems with "bad" recipients look
5888 ** for a valid address first.
5893 (QS_IS_BADADDR(q->q_state) || QS_IS_DEAD(q->q_state)))
5899 else if (q->q_qgrp >= 0)
5900 e->e_qgrp = q->q_qgrp;
5901 else if (q->q_mailer != NULL &&
5902 ISVALIDQGRP(q->q_mailer->m_qgrp))
5903 e->e_qgrp = q->q_mailer->m_qgrp;
5906 e->e_dfqgrp = e->e_qgrp;
5909 if (ISVALIDQDIR(e->e_qdir) && ISVALIDQDIR(e->e_dfqdir))
5912 sm_dprintf("setnewqueue: e_qdir already assigned (%s)\n",
5913 qid_printqueue(e->e_qgrp, e->e_qdir));
5918 e->e_qdir = pickqdir(Queue[e->e_qgrp], e->e_msgsize, e);
5919 if (e->e_qdir == NOQDIR)
5922 if (!bitset(EF_FATALERRS, e->e_flags))
5923 usrerr("452 4.4.5 Insufficient disk space; try again later");
5924 e->e_flags |= EF_FATALERRS;
5929 sm_dprintf("setnewqueue: Assigned queue directory %s\n",
5930 qid_printqueue(e->e_qgrp, e->e_qdir));
5932 if (e->e_xfqgrp == NOQGRP || e->e_xfqdir == NOQDIR)
5934 e->e_xfqgrp = e->e_qgrp;
5935 e->e_xfqdir = e->e_qdir;
5937 e->e_dfqdir = e->e_qdir;
5941 ** CHKQDIR -- check a queue directory
5944 ** name -- name of queue directory
5945 ** sff -- flags for safefile()
5948 ** is it a queue directory?
5951 static bool chkqdir __P((char *, long));
5961 /* skip over . and .. directories */
5962 if (name[0] == '.' &&
5963 (name[1] == '\0' || (name[1] == '.' && name[2] == '\0')))
5966 if (lstat(name, &statb) < 0)
5967 #else /* HASLSTAT */
5968 if (stat(name, &statb) < 0)
5969 #endif /* HASLSTAT */
5972 sm_dprintf("chkqdir: stat(\"%s\"): %s\n",
5973 name, sm_errstring(errno));
5977 if (S_ISLNK(statb.st_mode))
5980 ** For a symlink we need to make sure the
5981 ** target is a directory
5984 if (stat(name, &statb) < 0)
5987 sm_dprintf("chkqdir: stat(\"%s\"): %s\n",
5988 name, sm_errstring(errno));
5992 #endif /* HASLSTAT */
5994 if (!S_ISDIR(statb.st_mode))
5997 sm_dprintf("chkqdir: \"%s\": Not a directory\n",
6002 /* Print a warning if unsafe (but still use it) */
6003 /* XXX do this only if we want the warning? */
6004 i = safedirpath(name, RunAsUid, RunAsGid, NULL, sff, 0, 0);
6008 sm_dprintf("chkqdir: \"%s\": Not safe: %s\n",
6009 name, sm_errstring(i));
6012 sm_syslog(LOG_WARNING, NOQID,
6013 "queue directory \"%s\": Not safe: %s",
6014 name, sm_errstring(i));
6015 #endif /* _FFR_CHK_QUEUE */
6020 ** MULTIQUEUE_CACHE -- cache a list of paths to queues.
6022 ** Each potential queue is checked as the cache is built.
6023 ** Thereafter, each is blindly trusted.
6024 ** Note that we can be called again after a timeout to rebuild
6025 ** (although code for that is not ready yet).
6028 ** basedir -- base of all queue directories.
6029 ** blen -- strlen(basedir).
6030 ** qg -- queue group.
6031 ** qn -- number of queue directories already cached.
6032 ** phash -- pointer to hash value over queue dirs.
6034 ** only used if shared memory is active.
6035 #endif * SM_CONF_SHM *
6038 ** new number of queue directories.
6041 #define INITIAL_SLOTS 20
6042 #define ADD_SLOTS 10
6045 multiqueue_cache(basedir, blen, qg, qn, phash)
6050 unsigned int *phash;
6055 long sff = SFF_ANYFILE;
6056 char qpath[MAXPATHLEN];
6057 char subdir[MAXPATHLEN];
6058 char prefix[MAXPATHLEN]; /* dir relative to basedir */
6061 sm_dprintf("multiqueue_cache: called\n");
6063 /* Initialize to current directory */
6066 if (qg->qg_numqueues != 0 && qg->qg_qpaths != NULL)
6068 for (i = 0; i < qg->qg_numqueues; i++)
6070 if (qg->qg_qpaths[i].qp_name != NULL)
6071 (void) sm_free(qg->qg_qpaths[i].qp_name); /* XXX */
6073 (void) sm_free((char *) qg->qg_qpaths); /* XXX */
6074 qg->qg_qpaths = NULL;
6075 qg->qg_numqueues = 0;
6078 /* If running as root, allow safedirpath() checks to use privs */
6082 sff |= SFF_SAFEDIRPATH|SFF_NOWWFILES;
6084 sff |= SFF_NOGWFILES;
6085 #endif /* _FFR_CHK_QUEUE */
6087 if (!SM_IS_DIR_START(qg->qg_qdir))
6090 ** XXX we could add basedir, but then we have to realloc()
6091 ** the string... Maybe another time.
6094 syserr("QueuePath %s not absolute", qg->qg_qdir);
6095 ExitStat = EX_CONFIG;
6099 /* qpath: directory of current workgroup */
6100 len = sm_strlcpy(qpath, qg->qg_qdir, sizeof(qpath));
6101 if (len >= sizeof(qpath))
6103 syserr("QueuePath %.256s too long (%d max)",
6104 qg->qg_qdir, (int) sizeof(qpath));
6105 ExitStat = EX_CONFIG;
6109 /* begin of qpath must be same as basedir */
6110 if (strncmp(basedir, qpath, blen) != 0 &&
6111 (strncmp(basedir, qpath, blen - 1) != 0 || len != blen - 1))
6113 syserr("QueuePath %s not subpath of QueueDirectory %s",
6115 ExitStat = EX_CONFIG;
6119 /* Do we have a nested subdirectory? */
6120 if (blen < len && SM_FIRST_DIR_DELIM(qg->qg_qdir + blen) != NULL)
6123 /* Copy subdirectory into prefix for later use */
6124 if (sm_strlcpy(prefix, qg->qg_qdir + blen, sizeof(prefix)) >=
6127 syserr("QueuePath %.256s too long (%d max)",
6128 qg->qg_qdir, (int) sizeof(qpath));
6129 ExitStat = EX_CONFIG;
6132 cp = SM_LAST_DIR_DELIM(prefix);
6133 SM_ASSERT(cp != NULL);
6134 *cp = '\0'; /* cut off trailing / */
6137 /* This is guaranteed by the basedir check above */
6138 SM_ASSERT(len >= blen - 1);
6139 cp = &qpath[len - 1];
6143 register struct dirent *d;
6146 char relpath[MAXPATHLEN];
6148 *cp = '\0'; /* Overwrite wildcard */
6149 if ((cp = SM_LAST_DIR_DELIM(qpath)) == NULL)
6151 syserr("QueueDirectory: can not wildcard relative path");
6153 sm_dprintf("multiqueue_cache: \"%s*\": Can not wildcard relative path.\n",
6155 ExitStat = EX_CONFIG;
6161 ** Special case of top level wildcard, like /foo*
6165 (void) sm_strlcpy(qpath + 1, qpath, sizeof(qpath) - 1);
6169 *(cp++) = '\0'; /* Replace / with \0 */
6170 len = strlen(cp); /* Last component of queue directory */
6173 ** Path relative to basedir, with trailing /
6174 ** It will be modified below to specify the subdirectories
6175 ** so they can be opened without chdir().
6178 off = sm_strlcpyn(relpath, sizeof(relpath), 2, prefix, "/");
6179 SM_ASSERT(off < sizeof(relpath));
6182 sm_dprintf("multiqueue_cache: prefix=\"%s%s\"\n",
6185 /* It is always basedir: we don't need to store it per group */
6186 /* XXX: optimize this! -> one more global? */
6187 qg->qg_qdir = newstr(basedir);
6188 qg->qg_qdir[blen - 1] = '\0'; /* cut off trailing / */
6191 ** XXX Should probably wrap this whole loop in a timeout
6192 ** in case some wag decides to NFS mount the queues.
6195 /* Test path to get warning messages. */
6198 /* XXX qg_runasuid and qg_runasgid for specials? */
6199 i = safedirpath(basedir, RunAsUid, RunAsGid, NULL,
6201 if (i != 0 && tTd(41, 2))
6202 sm_dprintf("multiqueue_cache: \"%s\": Not safe: %s\n",
6203 basedir, sm_errstring(i));
6206 if ((dp = opendir(prefix)) == NULL)
6208 syserr("can not opendir(%s/%s)", qg->qg_qdir, prefix);
6210 sm_dprintf("multiqueue_cache: opendir(\"%s/%s\"): %s\n",
6211 qg->qg_qdir, prefix,
6212 sm_errstring(errno));
6213 ExitStat = EX_CONFIG;
6216 while ((d = readdir(dp)) != NULL)
6218 /* Skip . and .. directories */
6219 if (strcmp(d->d_name, ".") == 0 ||
6220 strcmp(d->d_name, "..") == 0)
6223 i = strlen(d->d_name);
6224 if (i < len || strncmp(d->d_name, cp, len) != 0)
6227 sm_dprintf("multiqueue_cache: \"%s\", skipped\n",
6232 /* Create relative pathname: prefix + local directory */
6233 i = sizeof(relpath) - off;
6234 if (sm_strlcpy(relpath + off, d->d_name, i) >= i)
6235 continue; /* way too long */
6237 if (!chkqdir(relpath, sff))
6240 if (qg->qg_qpaths == NULL)
6242 slotsleft = INITIAL_SLOTS;
6243 qg->qg_qpaths = (QPATHS *)xalloc((sizeof(*qg->qg_qpaths)) *
6245 qg->qg_numqueues = 0;
6247 else if (slotsleft < 1)
6249 qg->qg_qpaths = (QPATHS *)sm_realloc((char *)qg->qg_qpaths,
6250 (sizeof(*qg->qg_qpaths)) *
6253 if (qg->qg_qpaths == NULL)
6255 (void) closedir(dp);
6258 slotsleft += ADD_SLOTS;
6262 qg->qg_qpaths[qg->qg_numqueues].qp_subdirs = QP_NOSUB;
6264 #define CHKRSUBDIR(name, flag) \
6265 (void) sm_strlcpyn(subdir, sizeof(subdir), 3, relpath, "/", name); \
6266 if (chkqdir(subdir, sff)) \
6267 qg->qg_qpaths[qg->qg_numqueues].qp_subdirs |= flag; \
6271 CHKRSUBDIR("qf", QP_SUBQF);
6272 CHKRSUBDIR("df", QP_SUBDF);
6273 CHKRSUBDIR("xf", QP_SUBXF);
6275 /* assert(strlen(d->d_name) < MAXPATHLEN - 14) */
6276 /* maybe even - 17 (subdirs) */
6278 if (prefix[0] != '.')
6279 qg->qg_qpaths[qg->qg_numqueues].qp_name =
6282 qg->qg_qpaths[qg->qg_numqueues].qp_name =
6286 sm_dprintf("multiqueue_cache: %d: \"%s\" cached (%x).\n",
6287 qg->qg_numqueues, relpath,
6288 qg->qg_qpaths[qg->qg_numqueues].qp_subdirs);
6290 qg->qg_qpaths[qg->qg_numqueues].qp_idx = qn;
6291 *phash = hash_q(relpath, *phash);
6292 #endif /* SM_CONF_SHM */
6297 (void) closedir(dp);
6302 if (qg->qg_numqueues == 0)
6304 qg->qg_qpaths = (QPATHS *) xalloc(sizeof(*qg->qg_qpaths));
6306 /* test path to get warning messages */
6307 i = safedirpath(qpath, RunAsUid, RunAsGid, NULL, sff, 0, 0);
6310 syserr("can not opendir(%s)", qpath);
6312 sm_dprintf("multiqueue_cache: opendir(\"%s\"): %s\n",
6313 qpath, sm_errstring(i));
6314 ExitStat = EX_CONFIG;
6318 qg->qg_qpaths[0].qp_subdirs = QP_NOSUB;
6319 qg->qg_numqueues = 1;
6322 #define CHKSUBDIR(name, flag) \
6323 (void) sm_strlcpyn(subdir, sizeof(subdir), 3, qg->qg_qdir, "/", name); \
6324 if (chkqdir(subdir, sff)) \
6325 qg->qg_qpaths[0].qp_subdirs |= flag; \
6328 CHKSUBDIR("qf", QP_SUBQF);
6329 CHKSUBDIR("df", QP_SUBDF);
6330 CHKSUBDIR("xf", QP_SUBXF);
6332 if (qg->qg_qdir[blen - 1] != '\0' &&
6333 qg->qg_qdir[blen] != '\0')
6336 ** Copy the last component into qpaths and
6340 qg->qg_qpaths[0].qp_name = newstr(qg->qg_qdir + blen);
6341 qg->qg_qdir[blen - 1] = '\0';
6344 qg->qg_qpaths[0].qp_name = newstr(".");
6347 qg->qg_qpaths[0].qp_idx = qn;
6348 *phash = hash_q(qg->qg_qpaths[0].qp_name, *phash);
6349 #endif /* SM_CONF_SHM */
6356 ** FILESYS_FIND -- find entry in FileSys table, or add new one
6358 ** Given the pathname of a directory, determine the file system
6359 ** in which that directory resides, and return a pointer to the
6360 ** entry in the FileSys table that describes the file system.
6361 ** A new entry is added if necessary (and requested).
6362 ** If the directory does not exist, -1 is returned.
6365 ** name -- name of directory (must be persistent!)
6366 ** path -- pathname of directory (name plus maybe "/df")
6367 ** add -- add to structure if not found.
6370 ** >=0: found: index in file system table
6371 ** <0: some error, i.e.,
6372 ** FSF_TOO_MANY: too many filesystems (-> syserr())
6373 ** FSF_STAT_FAIL: can't stat() filesystem (-> syserr())
6374 ** FSF_NOT_FOUND: not in list
6377 static short filesys_find __P((const char *, const char *, bool));
6379 #define FSF_NOT_FOUND (-1)
6380 #define FSF_STAT_FAIL (-2)
6381 #define FSF_TOO_MANY (-3)
6384 filesys_find(name, path, add)
6392 if (stat(path, &st) < 0)
6394 syserr("cannot stat queue directory %s", path);
6395 return FSF_STAT_FAIL;
6397 for (i = 0; i < NumFileSys; ++i)
6399 if (FILE_SYS_DEV(i) == st.st_dev)
6402 ** Make sure the file system (FS) name is set:
6403 ** even though the source code indicates that
6404 ** FILE_SYS_DEV() is only set below, it could be
6405 ** set via shared memory, hence we need to perform
6406 ** this check/assignment here.
6409 if (NULL == FILE_SYS_NAME(i))
6410 FILE_SYS_NAME(i) = name;
6414 if (i >= MAXFILESYS)
6416 syserr("too many queue file systems (%d max)", MAXFILESYS);
6417 return FSF_TOO_MANY;
6420 return FSF_NOT_FOUND;
6423 FILE_SYS_NAME(i) = name;
6424 FILE_SYS_DEV(i) = st.st_dev;
6425 FILE_SYS_AVAIL(i) = 0;
6426 FILE_SYS_BLKSIZE(i) = 1024; /* avoid divide by zero */
6431 ** FILESYS_SETUP -- set up mapping from queue directories to file systems
6433 ** This data structure is used to efficiently check the amount of
6434 ** free space available in a set of queue directories.
6437 ** add -- initialize structure if necessary.
6441 ** <0: some error, i.e.,
6442 ** FSF_NOT_FOUND: not in list
6443 ** FSF_STAT_FAIL: can't stat() filesystem (-> syserr())
6444 ** FSF_TOO_MANY: too many filesystems (-> syserr())
6447 static int filesys_setup __P((bool));
6458 for (i = 0; i < NumQueue && Queue[i] != NULL; i++)
6460 for (j = 0; j < Queue[i]->qg_numqueues; ++j)
6462 QPATHS *qp = &Queue[i]->qg_qpaths[j];
6463 char qddf[MAXPATHLEN];
6465 (void) sm_strlcpyn(qddf, sizeof(qddf), 2, qp->qp_name,
6466 (bitset(QP_SUBDF, qp->qp_subdirs)
6468 fs = filesys_find(qp->qp_name, qddf, add);
6470 qp->qp_fsysidx = fs;
6481 ** FILESYS_UPDATE -- update amount of free space on all file systems
6483 ** The FileSys table is used to cache the amount of free space
6484 ** available on all queue directory file systems.
6485 ** This function updates the cached information if it has expired.
6494 ** Updates FileSys table.
6501 long avail, blksize;
6503 static time_t nextupdate = 0;
6507 ** Only the daemon updates the shared memory, i.e.,
6508 ** if shared memory is available but the pid is not the
6509 ** one of the daemon, then don't do anything.
6512 if (ShmId != SM_SHM_NO_ID && DaemonPid != CurrentPid)
6514 #endif /* SM_CONF_SHM */
6516 if (now < nextupdate)
6518 nextupdate = now + FILESYS_UPDATE_INTERVAL;
6519 for (i = 0; i < NumFileSys; ++i)
6521 FILESYS *fs = &FILE_SYS(i);
6523 avail = freediskspace(FILE_SYS_NAME(i), &blksize);
6524 if (avail < 0 || blksize <= 0)
6527 sm_syslog(LOG_ERR, NOQID,
6528 "filesys_update failed: %s, fs=%s, avail=%ld, blocksize=%ld",
6529 sm_errstring(errno),
6530 FILE_SYS_NAME(i), avail, blksize);
6532 fs->fs_blksize = 1024; /* avoid divide by zero */
6533 nextupdate = now + 2; /* let's do this soon again */
6537 fs->fs_avail = avail;
6538 fs->fs_blksize = blksize;
6543 #if _FFR_ANY_FREE_FS
6545 ** FILESYS_FREE -- check whether there is at least one fs with enough space.
6548 ** fsize -- file size in bytes
6551 ** true iff there is one fs with more than fsize bytes free.
6562 for (i = 0; i < NumFileSys; ++i)
6566 if (FILE_SYS_AVAIL(i) < 0 || FILE_SYS_BLKSIZE(i) <= 0)
6568 needed += fsize / FILE_SYS_BLKSIZE(i)
6569 + ((fsize % FILE_SYS_BLKSIZE(i)
6572 if (needed <= FILE_SYS_AVAIL(i))
6577 #endif /* _FFR_ANY_FREE_FS */
6580 ** DISK_STATUS -- show amount of free space in queue directories
6583 ** out -- output file pointer.
6584 ** prefix -- string to output in front of each line.
6591 disk_status(out, prefix)
6596 long avail, blksize;
6599 for (i = 0; i < NumFileSys; ++i)
6601 avail = freediskspace(FILE_SYS_NAME(i), &blksize);
6602 if (avail >= 0 && blksize > 0)
6604 free = (long)((double) avail *
6605 ((double) blksize / 1024));
6609 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
6620 ** INIT_SEM -- initialize semaphore system
6623 ** owner -- is this the owner of semaphores?
6629 #if _FFR_USE_SEM_LOCKING
6631 static int SemId = -1; /* Semaphore Id */
6632 int SemKey = SM_SEM_KEY;
6633 #endif /* SM_CONF_SEM */
6634 #endif /* _FFR_USE_SEM_LOCKING */
6636 static void init_sem __P((bool));
6642 #if _FFR_USE_SEM_LOCKING
6644 SemId = sm_sem_start(SemKey, 1, 0, owner);
6647 sm_syslog(LOG_ERR, NOQID,
6648 "func=init_sem, sem_key=%ld, sm_sem_start=%d, error=%s",
6649 (long) SemKey, SemId, sm_errstring(-SemId));
6652 if (owner && RunAsUid != 0)
6656 r = sm_semsetowner(SemId, RunAsUid, RunAsGid, 0660);
6658 sm_syslog(LOG_ERR, NOQID,
6659 "key=%ld, sm_semsetowner=%d, RunAsUid=%d, RunAsGid=%d",
6660 (long) SemKey, r, RunAsUid, RunAsGid);
6662 #endif /* SM_CONF_SEM */
6663 #endif /* _FFR_USE_SEM_LOCKING */
6668 ** STOP_SEM -- stop semaphore system
6671 ** owner -- is this the owner of semaphores?
6677 static void stop_sem __P((bool));
6683 #if _FFR_USE_SEM_LOCKING
6685 if (owner && SemId >= 0)
6687 #endif /* SM_CONF_SEM */
6688 #endif /* _FFR_USE_SEM_LOCKING */
6693 ** UPD_QS -- update information about queue when adding/deleting an entry
6697 ** count -- add/remove entry (+1/0/-1: add/no change/remove)
6698 ** space -- update the space available as well.
6699 ** (>0/0/<0: add/no change/remove)
6700 ** where -- caller (for logging)
6706 ** Modifies available space in filesystem.
6707 ** Changes number of entries in queue directory.
6711 upd_qs(e, count, space, where)
6719 # if _FFR_USE_SEM_LOCKING
6721 # endif /* _FFR_USE_SEM_LOCKING */
6724 if (ShmId == SM_SHM_NO_ID || e == NULL)
6726 if (e->e_qgrp == NOQGRP || e->e_qdir == NOQDIR)
6728 idx = Queue[e->e_qgrp]->qg_qpaths[e->e_qdir].qp_idx;
6730 sm_dprintf("func=upd_qs, count=%d, space=%d, where=%s, idx=%d, entries=%d\n",
6731 count, space, where, idx, QSHM_ENTRIES(idx));
6733 /* XXX in theory this needs to be protected with a mutex */
6734 if (QSHM_ENTRIES(idx) >= 0 && count != 0)
6736 # if _FFR_USE_SEM_LOCKING
6737 r = sm_sem_acq(SemId, 0, 1);
6738 # endif /* _FFR_USE_SEM_LOCKING */
6739 QSHM_ENTRIES(idx) += count;
6740 # if _FFR_USE_SEM_LOCKING
6742 r = sm_sem_rel(SemId, 0, 1);
6743 # endif /* _FFR_USE_SEM_LOCKING */
6746 fidx = Queue[e->e_qgrp]->qg_qpaths[e->e_qdir].qp_fsysidx;
6750 /* update available space also? (might be loseqfile) */
6754 /* convert size to blocks; this causes rounding errors */
6755 s = e->e_msgsize / FILE_SYS_BLKSIZE(fidx);
6759 /* XXX in theory this needs to be protected with a mutex */
6761 FILE_SYS_AVAIL(fidx) += s;
6763 FILE_SYS_AVAIL(fidx) -= s;
6767 static bool write_key_file __P((char *, long));
6768 static long read_key_file __P((char *, long));
6771 ** WRITE_KEY_FILE -- record some key into a file.
6774 ** keypath -- file name.
6775 ** key -- key to write.
6778 ** true iff file could be written.
6785 write_key_file(keypath, key)
6794 if (keypath == NULL || *keypath == '\0')
6796 sff = SFF_NOLINK|SFF_ROOTOK|SFF_REGONLY|SFF_CREAT;
6797 if (TrustedUid != 0 && RealUid == TrustedUid)
6798 sff |= SFF_OPENASROOT;
6799 keyf = safefopen(keypath, O_WRONLY|O_TRUNC, FileMode, sff);
6802 sm_syslog(LOG_ERR, NOQID, "unable to write %s: %s",
6803 keypath, sm_errstring(errno));
6807 if (geteuid() == 0 && RunAsUid != 0)
6813 if (fd >= 0 && fchown(fd, RunAsUid, -1) < 0)
6817 sm_syslog(LOG_ALERT, NOQID,
6818 "ownership change on %s to %d failed: %s",
6819 keypath, RunAsUid, sm_errstring(err));
6821 # endif /* HASFCHOWN */
6823 ok = sm_io_fprintf(keyf, SM_TIME_DEFAULT, "%ld\n", key) !=
6825 ok = (sm_io_close(keyf, SM_TIME_DEFAULT) != SM_IO_EOF) && ok;
6831 ** READ_KEY_FILE -- read a key from a file.
6834 ** keypath -- file name.
6835 ** key -- default key.
6842 read_key_file(keypath, key)
6850 if (keypath == NULL || *keypath == '\0')
6852 sff = SFF_NOLINK|SFF_ROOTOK|SFF_REGONLY;
6853 if (RealUid == 0 || (TrustedUid != 0 && RealUid == TrustedUid))
6854 sff |= SFF_OPENASROOT;
6855 keyf = safefopen(keypath, O_RDONLY, FileMode, sff);
6858 sm_syslog(LOG_ERR, NOQID, "unable to read %s: %s",
6859 keypath, sm_errstring(errno));
6863 r = sm_io_fscanf(keyf, SM_TIME_DEFAULT, "%ld", &n);
6866 (void) sm_io_close(keyf, SM_TIME_DEFAULT);
6872 ** INIT_SHM -- initialize shared memory structure
6874 ** Initialize or attach to shared memory segment.
6875 ** Currently it is not a fatal error if this doesn't work.
6876 ** However, it causes us to have a "fallback" storage location
6877 ** for everything that is supposed to be in the shared memory,
6878 ** which makes the code slightly ugly.
6881 ** qn -- number of queue directories.
6882 ** owner -- owner of shared memory.
6883 ** hash -- identifies data that is stored in shared memory.
6889 static void init_shm __P((int, bool, unsigned int));
6892 init_shm(qn, owner, hash)
6902 PtrFileSys = &FileSys[0];
6903 PNumFileSys = &Numfilesys;
6904 /* if this "key" is specified: select one yourself */
6905 #define SEL_SHM_KEY ((key_t) -1)
6906 #define FIRST_SHM_KEY 25
6908 /* This allows us to disable shared memory at runtime. */
6913 shms = SM_T_SIZE + qn * sizeof(QUEUE_SHM_T);
6914 keyselect = ShmKey == SEL_SHM_KEY;
6918 ShmKey = FIRST_SHM_KEY;
6922 ShmKey = read_key_file(ShmKeyFile, ShmKey);
6924 if (ShmKey == SEL_SHM_KEY)
6926 save_errno = (errno != 0) ? errno : EINVAL;
6933 /* allow read/write access for group? */
6934 Pshm = sm_shmstart(ShmKey, shms,
6935 SHM_R|SHM_W|(SHM_R>>3)|(SHM_W>>3),
6938 if (Pshm != NULL || !sm_file_exists(save_errno))
6946 /* back where we started? */
6947 if (ShmKey == SEL_SHM_KEY)
6954 /* only sleep if we are at the first key */
6955 if (!keyselect || ShmKey == SEL_SHM_KEY)
6963 (void) write_key_file(ShmKeyFile, (long) ShmKey);
6964 if (owner && RunAsUid != 0)
6966 i = sm_shmsetowner(ShmId, RunAsUid, RunAsGid, 0660);
6968 sm_syslog(LOG_ERR, NOQID,
6969 "key=%ld, sm_shmsetowner=%d, RunAsUid=%d, RunAsGid=%d",
6970 (long) ShmKey, i, RunAsUid, RunAsGid);
6976 *((pid_t *) SHM_OFF_PID(Pshm)) = CurrentPid;
6977 p = (int *) SHM_OFF_TAG(Pshm);
6982 if (*p != (int) shms)
6984 save_errno = EINVAL;
6988 p = (int *) SHM_OFF_TAG(Pshm);
6989 if (*p != (int) hash)
6991 save_errno = EINVAL;
6997 ** XXX how to check the pid?
6998 ** Read it from the pid-file? That does
6999 ** not need to exist.
7000 ** We could disable shm if we can't confirm
7001 ** that it is the right one.
7005 PtrFileSys = (FILESYS *) OFF_FILE_SYS(Pshm);
7006 PNumFileSys = (int *) OFF_NUM_FILE_SYS(Pshm);
7007 QShm = (QUEUE_SHM_T *) OFF_QUEUE_SHM(Pshm);
7008 PRSATmpCnt = (int *) OFF_RSA_TMP_CNT(Pshm);
7012 /* initialize values in shared memory */
7014 for (i = 0; i < qn; i++)
7015 QShm[i].qs_entries = -1;
7021 if (LogLevel > (owner ? 8 : 11))
7023 sm_syslog(owner ? LOG_ERR : LOG_NOTICE, NOQID,
7024 "can't %s shared memory, key=%ld: %s",
7025 owner ? "initialize" : "attach to",
7026 (long) ShmKey, sm_errstring(save_errno));
7029 #endif /* SM_CONF_SHM */
7033 ** SETUP_QUEUES -- set up all queue groups
7036 ** owner -- owner of shared memory?
7043 ** attaches shared memory.
7044 #endif * SM_CONF_SHM *
7052 unsigned int hashval;
7054 char basedir[MAXPATHLEN];
7058 ** Determine basedir for all queue directories.
7059 ** All queue directories must be (first level) subdirectories
7060 ** of the basedir. The basedir is the QueueDir
7061 ** without wildcards, but with trailing /
7066 len = sm_strlcpy(basedir, QueueDir, sizeof(basedir));
7068 /* Provide space for trailing '/' */
7069 if (len >= sizeof(basedir) - 1)
7071 syserr("QueueDirectory: path too long: %d, max %d",
7072 len, (int) sizeof(basedir) - 1);
7073 ExitStat = EX_CONFIG;
7077 if (basedir[len - 1] == '*')
7081 cp = SM_LAST_DIR_DELIM(basedir);
7084 syserr("QueueDirectory: can not wildcard relative path \"%s\"",
7087 sm_dprintf("setup_queues: \"%s\": Can not wildcard relative path.\n",
7089 ExitStat = EX_CONFIG;
7093 /* cut off wildcard pattern */
7097 else if (!SM_IS_DIR_DELIM(basedir[len - 1]))
7099 /* append trailing slash since it is a directory */
7101 basedir[++len] = '\0';
7104 /* len counts up to the last directory delimiter */
7105 SM_ASSERT(basedir[len - 1] == '/');
7107 if (chdir(basedir) < 0)
7109 int save_errno = errno;
7111 syserr("can not chdir(%s)", basedir);
7112 if (save_errno == EACCES)
7113 (void) sm_io_fprintf(smioerr, SM_TIME_DEFAULT,
7114 "Program mode requires special privileges, e.g., root or TrustedUser.\n");
7116 sm_dprintf("setup_queues: \"%s\": %s\n",
7117 basedir, sm_errstring(errno));
7118 ExitStat = EX_CONFIG;
7122 hashval = hash_q(basedir, hashval);
7123 #endif /* SM_CONF_SHM */
7125 /* initialize for queue runs */
7128 for (i = 0; i < NumQueue && Queue[i] != NULL; i++)
7129 Queue[i]->qg_nextrun = now;
7132 if (UseMSP && OpMode != MD_TEST)
7134 long sff = SFF_CREAT;
7136 if (stat(".", &st) < 0)
7138 syserr("can not stat(%s)", basedir);
7140 sm_dprintf("setup_queues: \"%s\": %s\n",
7141 basedir, sm_errstring(errno));
7142 ExitStat = EX_CONFIG;
7149 ** Check queue directory permissions.
7150 ** Can we write to a group writable queue directory?
7153 if (bitset(S_IWGRP, QueueFileMode) &&
7154 bitset(S_IWGRP, st.st_mode) &&
7155 safefile(" ", RunAsUid, RunAsGid, RunAsUserName, sff,
7156 QueueFileMode, NULL) != 0)
7158 syserr("can not write to queue directory %s (RunAsGid=%d, required=%d)",
7159 basedir, (int) RunAsGid, (int) st.st_gid);
7161 if (bitset(S_IWOTH|S_IXOTH, st.st_mode))
7163 #if _FFR_MSP_PARANOIA
7164 syserr("dangerous permissions=%o on queue directory %s",
7165 (int) st.st_mode, basedir);
7166 #else /* _FFR_MSP_PARANOIA */
7168 sm_syslog(LOG_ERR, NOQID,
7169 "dangerous permissions=%o on queue directory %s",
7170 (int) st.st_mode, basedir);
7171 #endif /* _FFR_MSP_PARANOIA */
7173 #if _FFR_MSP_PARANOIA
7175 syserr("can not use multiple queues for MSP");
7176 #endif /* _FFR_MSP_PARANOIA */
7179 /* initial number of queue directories */
7181 for (i = 0; i < NumQueue && Queue[i] != NULL; i++)
7182 qn = multiqueue_cache(basedir, len, Queue[i], qn, &hashval);
7185 init_shm(qn, owner, hashval);
7186 i = filesys_setup(owner || ShmId == SM_SHM_NO_ID);
7187 if (i == FSF_NOT_FOUND)
7190 ** We didn't get the right filesystem data
7191 ** This may happen if we don't have the right shared memory.
7192 ** So let's do this without shared memory.
7196 cleanup_shm(false); /* release shared memory */
7197 i = filesys_setup(false);
7199 syserr("filesys_setup failed twice, result=%d", i);
7200 else if (LogLevel > 8)
7201 sm_syslog(LOG_WARNING, NOQID,
7202 "shared memory does not contain expected data, ignored");
7204 #else /* SM_CONF_SHM */
7205 i = filesys_setup(true);
7206 #endif /* SM_CONF_SHM */
7208 ExitStat = EX_CONFIG;
7213 ** CLEANUP_SHM -- do some cleanup work for shared memory etc
7216 ** owner -- owner of shared memory?
7222 ** detaches shared memory.
7229 if (ShmId != SM_SHM_NO_ID)
7231 if (sm_shmstop(Pshm, ShmId, owner) < 0 && LogLevel > 8)
7232 sm_syslog(LOG_INFO, NOQID, "sm_shmstop failed=%s",
7233 sm_errstring(errno));
7235 ShmId = SM_SHM_NO_ID;
7239 #endif /* SM_CONF_SHM */
7242 ** CLEANUP_QUEUES -- do some cleanup work for queues
7258 ** SET_DEF_QUEUEVAL -- set default values for a queue group.
7261 ** qg -- queue group
7262 ** all -- set all values (true for default group)?
7268 ** sets default values for the queue group.
7272 set_def_queueval(qg, all)
7276 if (bitnset(QD_DEFINED, qg->qg_flags))
7279 qg->qg_qdir = QueueDir;
7280 #if _FFR_QUEUE_GROUP_SORTORDER
7281 qg->qg_sortorder = QueueSortOrder;
7282 #endif /* _FFR_QUEUE_GROUP_SORTORDER */
7283 qg->qg_maxqrun = all ? MaxRunnersPerQueue : -1;
7284 qg->qg_nice = NiceQueueRun;
7287 ** MAKEQUEUE -- define a new queue.
7290 ** line -- description of queue. This is in labeled fields.
7292 ** F -- the flags associated with the queue
7293 ** I -- the interval between running the queue
7294 ** J -- the maximum # of jobs in work list
7295 ** [M -- the maximum # of jobs in a queue run]
7296 ** N -- the niceness at which to run
7297 ** P -- the path to the queue
7298 ** S -- the queue sorting order
7299 ** R -- number of parallel queue runners
7300 ** r -- max recipients per envelope
7301 ** The first word is the canonical name of the queue.
7302 ** qdef -- this is a 'Q' definition from .cf
7308 ** enters the queue into the queue table.
7312 makequeue(line, qdef)
7317 register QUEUEGRP *qg;
7322 /* allocate a queue and set up defaults */
7323 qg = (QUEUEGRP *) xalloc(sizeof(*qg));
7324 memset((char *) qg, '\0', sizeof(*qg));
7326 if (line[0] == '\0')
7328 syserr("name required for queue");
7332 /* collect the queue name */
7334 *p != '\0' && *p != ',' && !(isascii(*p) && isspace(*p));
7339 qg->qg_name = newstr(line);
7341 /* set default values, can be overridden below */
7342 set_def_queueval(qg, false);
7344 /* now scan through and assign info from the fields */
7347 auto char *delimptr;
7349 while (*p != '\0' &&
7350 (*p == ',' || (isascii(*p) && isspace(*p))))
7353 /* p now points to field code */
7355 while (*p != '\0' && *p != '=' && *p != ',')
7359 syserr("queue %s: `=' expected", qg->qg_name);
7362 while (isascii(*p) && isspace(*p))
7365 /* p now points to the field body */
7366 p = munchstring(p, &delimptr, ',');
7368 /* install the field into the queue struct */
7371 case 'P': /* pathname */
7373 syserr("queue %s: empty path name",
7376 qg->qg_qdir = newstr(p);
7379 case 'F': /* flags */
7380 for (; *p != '\0'; p++)
7381 if (!(isascii(*p) && isspace(*p)))
7382 setbitn(*p, qg->qg_flags);
7386 ** Do we need two intervals here:
7387 ** One for persistent queue runners,
7388 ** one for "normal" queue runs?
7391 case 'I': /* interval between running the queue */
7392 qg->qg_queueintvl = convtime(p, 'm');
7395 case 'N': /* run niceness */
7396 qg->qg_nice = atoi(p);
7399 case 'R': /* maximum # of runners for the group */
7402 /* can't have more runners than allowed total */
7403 if (MaxQueueChildren > 0 && i > MaxQueueChildren)
7405 qg->qg_maxqrun = MaxQueueChildren;
7406 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
7407 "Q=%s: R=%d exceeds MaxQueueChildren=%d, set to MaxQueueChildren\n",
7415 case 'J': /* maximum # of jobs in work list */
7416 qg->qg_maxlist = atoi(p);
7419 case 'r': /* max recipients per envelope */
7420 qg->qg_maxrcpt = atoi(p);
7423 #if _FFR_QUEUE_GROUP_SORTORDER
7424 case 'S': /* queue sorting order */
7427 case 'h': /* Host first */
7429 qg->qg_sortorder = QSO_BYHOST;
7432 case 'p': /* Priority order */
7434 qg->qg_sortorder = QSO_BYPRIORITY;
7437 case 't': /* Submission time */
7439 qg->qg_sortorder = QSO_BYTIME;
7442 case 'f': /* File name */
7444 qg->qg_sortorder = QSO_BYFILENAME;
7447 case 'm': /* Modification time */
7449 qg->qg_sortorder = QSO_BYMODTIME;
7452 case 'r': /* Random */
7454 qg->qg_sortorder = QSO_RANDOM;
7458 case 's': /* Shuffled host name */
7460 qg->qg_sortorder = QSO_BYSHUFFLE;
7462 # endif /* _FFR_RHS */
7464 case 'n': /* none */
7466 qg->qg_sortorder = QSO_NONE;
7470 syserr("Invalid queue sort order \"%s\"", p);
7473 #endif /* _FFR_QUEUE_GROUP_SORTORDER */
7476 syserr("Q%s: unknown queue equate %c=",
7477 qg->qg_name, fcode);
7485 if (qg->qg_nice != NiceQueueRun)
7487 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
7488 "Q%s: Warning: N= set on system that doesn't support nice()\n",
7491 #endif /* !HASNICE */
7493 /* do some rationality checking */
7494 if (NumQueue >= MAXQUEUEGROUPS)
7496 syserr("too many queue groups defined (%d max)",
7501 if (qg->qg_qdir == NULL)
7503 if (QueueDir == NULL || *QueueDir == '\0')
7505 syserr("QueueDir must be defined before queue groups");
7508 qg->qg_qdir = newstr(QueueDir);
7511 if (qg->qg_maxqrun > 1 && !bitnset(QD_FORK, qg->qg_flags))
7513 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
7514 "Warning: Q=%s: R=%d: multiple queue runners specified\n\tbut flag '%c' is not set\n",
7515 qg->qg_name, qg->qg_maxqrun, QD_FORK);
7518 /* enter the queue into the symbol table */
7520 sm_syslog(LOG_INFO, NOQID,
7521 "Adding %s to stab, path: %s", qg->qg_name,
7523 s = stab(qg->qg_name, ST_QUEUE, ST_ENTER);
7524 if (s->s_quegrp != NULL)
7526 i = s->s_quegrp->qg_index;
7528 /* XXX what about the pointers inside this struct? */
7529 sm_free(s->s_quegrp); /* XXX */
7533 Queue[i] = s->s_quegrp = qg;
7536 /* set default value for max queue runners */
7537 if (qg->qg_maxqrun < 0)
7539 if (MaxRunnersPerQueue > 0)
7540 qg->qg_maxqrun = MaxRunnersPerQueue;
7545 setbitn(QD_DEFINED, qg->qg_flags);
7549 ** HASHFQN -- calculate a hash value for a fully qualified host name
7552 ** fqn -- an all lower-case host.domain string
7553 ** buckets -- the number of buckets (queue directories)
7556 ** a bucket number (signed integer)
7559 ** Contributed by Exactis.com, Inc.
7563 hashfqn(fqn, buckets)
7568 register int h = 0, hash, cnt;
7574 ** A variation on the gdb hash
7575 ** This is the best as of Feb 19, 1996 --bcx
7579 h = 0x238F13AF * strlen(p);
7580 for (cnt = 0; *p != 0; ++p, cnt++)
7582 h = (h + (*p << (cnt * 5 % 24))) & 0x7FFFFFFF;
7584 h = (1103515243 * h + 12345) & 0x7FFFFFFF;
7588 hash = (h % buckets);
7595 ** A structure for sorting Queue according to maxqrun without
7596 ** screwing up Queue itself.
7601 int sg_idx; /* original index */
7602 int sg_maxqrun; /* max queue runners */
7604 typedef struct sortqgrp SORTQGRP_T;
7605 static int cmpidx __P((const void *, const void *));
7612 /* The sort is highest to lowest, so the comparison is reversed */
7613 if (((SORTQGRP_T *)a)->sg_maxqrun < ((SORTQGRP_T *)b)->sg_maxqrun)
7615 else if (((SORTQGRP_T *)a)->sg_maxqrun > ((SORTQGRP_T *)b)->sg_maxqrun)
7622 ** MAKEWORKGROUP -- balance queue groups into work groups per MaxQueueChildren
7624 ** Take the now defined queue groups and assign them to work groups.
7625 ** This is done to balance out the number of concurrently active
7626 ** queue runners such that MaxQueueChildren is not exceeded. This may
7627 ** result in more than one queue group per work group. In such a case
7628 ** the number of running queue groups in that work group will have no
7629 ** more than the work group maximum number of runners (a "fair" portion
7630 ** of MaxQueueRunners). All queue groups within a work group will get a
7631 ** chance at running.
7640 ** Sets up WorkGrp structure.
7646 int i, j, total_runners, dir, h;
7647 SORTQGRP_T si[MAXQUEUEGROUPS + 1];
7650 if (NumQueue == 1 && strcmp(Queue[0]->qg_name, "mqueue") == 0)
7653 ** There is only the "mqueue" queue group (a default)
7654 ** containing all of the queues. We want to provide to
7655 ** this queue group the maximum allowable queue runners.
7656 ** To match older behavior (8.10/8.11) we'll try for
7657 ** 1 runner per queue capping it at MaxQueueChildren.
7658 ** So if there are N queues, then there will be N runners
7659 ** for the "mqueue" queue group (where N is kept less than
7660 ** MaxQueueChildren).
7664 WorkGrp[0].wg_numqgrp = 1;
7665 WorkGrp[0].wg_qgs = (QUEUEGRP **) xalloc(sizeof(QUEUEGRP *));
7666 WorkGrp[0].wg_qgs[0] = Queue[0];
7667 if (MaxQueueChildren > 0 &&
7668 Queue[0]->qg_numqueues > MaxQueueChildren)
7669 WorkGrp[0].wg_runners = MaxQueueChildren;
7671 WorkGrp[0].wg_runners = Queue[0]->qg_numqueues;
7673 Queue[0]->qg_wgrp = 0;
7675 /* can't have more runners than allowed total */
7676 if (MaxQueueChildren > 0 &&
7677 Queue[0]->qg_maxqrun > MaxQueueChildren)
7678 Queue[0]->qg_maxqrun = MaxQueueChildren;
7679 WorkGrp[0].wg_maxact = Queue[0]->qg_maxqrun;
7680 WorkGrp[0].wg_lowqintvl = Queue[0]->qg_queueintvl;
7684 for (i = 0; i < NumQueue; i++)
7686 si[i].sg_maxqrun = Queue[i]->qg_maxqrun;
7689 qsort(si, NumQueue, sizeof(si[0]), cmpidx);
7692 for (i = 0; i < NumQueue; i++)
7694 total_runners += si[i].sg_maxqrun;
7695 if (MaxQueueChildren <= 0 || total_runners <= MaxQueueChildren)
7701 if (NumWorkGroups < 1)
7702 NumWorkGroups = 1; /* gotta have one at least */
7703 else if (NumWorkGroups > MAXWORKGROUPS)
7704 NumWorkGroups = MAXWORKGROUPS; /* the limit */
7707 ** We now know the number of work groups to pack the queue groups
7708 ** into. The queue groups in 'Queue' are sorted from highest
7709 ** to lowest for the number of runners per queue group.
7710 ** We put the queue groups with the largest number of runners
7711 ** into work groups first. Then the smaller ones are fitted in
7712 ** where it looks best.
7717 for (i = 0; i < NumQueue; i++)
7719 /* a to-and-fro packing scheme, continue from last position */
7720 if (j >= NumWorkGroups)
7723 j = NumWorkGroups - 1;
7731 if (WorkGrp[j].wg_qgs == NULL)
7732 WorkGrp[j].wg_qgs = (QUEUEGRP **)sm_malloc(sizeof(QUEUEGRP *) *
7733 (WorkGrp[j].wg_numqgrp + 1));
7735 WorkGrp[j].wg_qgs = (QUEUEGRP **)sm_realloc(WorkGrp[j].wg_qgs,
7736 sizeof(QUEUEGRP *) *
7737 (WorkGrp[j].wg_numqgrp + 1));
7738 if (WorkGrp[j].wg_qgs == NULL)
7740 syserr("!cannot allocate memory for work queues, need %d bytes",
7741 (int) (sizeof(QUEUEGRP *) *
7742 (WorkGrp[j].wg_numqgrp + 1)));
7746 WorkGrp[j].wg_qgs[WorkGrp[j].wg_numqgrp] = Queue[h];
7747 WorkGrp[j].wg_numqgrp++;
7748 WorkGrp[j].wg_runners += Queue[h]->qg_maxqrun;
7749 Queue[h]->qg_wgrp = j;
7751 if (WorkGrp[j].wg_maxact == 0)
7753 /* can't have more runners than allowed total */
7754 if (MaxQueueChildren > 0 &&
7755 Queue[h]->qg_maxqrun > MaxQueueChildren)
7756 Queue[h]->qg_maxqrun = MaxQueueChildren;
7757 WorkGrp[j].wg_maxact = Queue[h]->qg_maxqrun;
7761 ** XXX: must wg_lowqintvl be the GCD?
7762 ** qg1: 2m, qg2: 3m, minimum: 2m, when do queue runs for
7766 /* keep track of the lowest interval for a persistent runner */
7767 if (Queue[h]->qg_queueintvl > 0 &&
7768 WorkGrp[j].wg_lowqintvl < Queue[h]->qg_queueintvl)
7769 WorkGrp[j].wg_lowqintvl = Queue[h]->qg_queueintvl;
7774 for (i = 0; i < NumWorkGroups; i++)
7776 sm_dprintf("Workgroup[%d]=", i);
7777 for (j = 0; j < WorkGrp[i].wg_numqgrp; j++)
7780 WorkGrp[i].wg_qgs[j]->qg_name);
7788 ** DUP_DF -- duplicate envelope data file
7790 ** Copy the data file from the 'old' envelope to the 'new' envelope
7791 ** in the most efficient way possible.
7793 ** Create a hard link from the 'old' data file to the 'new' data file.
7794 ** If the old and new queue directories are on different file systems,
7795 ** then the new data file link is created in the old queue directory,
7796 ** and the new queue file will contain a 'd' record pointing to the
7797 ** directory containing the new data file.
7800 ** old -- old envelope.
7801 ** new -- new envelope.
7804 ** Returns true on success, false on failure.
7807 ** On success, the new data file is created.
7808 ** On fatal failure, EF_FATALERRS is set in old->e_flags.
7811 static bool dup_df __P((ENVELOPE *, ENVELOPE *));
7819 char opath[MAXPATHLEN];
7820 char npath[MAXPATHLEN];
7822 if (!bitset(EF_HAS_DF, old->e_flags))
7825 ** this can happen if: SuperSafe != True
7826 ** and a bounce mail is sent that is split.
7829 queueup(old, false, true);
7831 SM_REQUIRE(ISVALIDQGRP(old->e_qgrp) && ISVALIDQDIR(old->e_qdir));
7832 SM_REQUIRE(ISVALIDQGRP(new->e_qgrp) && ISVALIDQDIR(new->e_qdir));
7834 (void) sm_strlcpy(opath, queuename(old, DATAFL_LETTER), sizeof(opath));
7835 (void) sm_strlcpy(npath, queuename(new, DATAFL_LETTER), sizeof(npath));
7837 if (old->e_dfp != NULL)
7839 r = sm_io_setinfo(old->e_dfp, SM_BF_COMMIT, NULL);
7840 if (r < 0 && errno != EINVAL)
7842 syserr("@can't commit %s", opath);
7843 old->e_flags |= EF_FATALERRS;
7849 ** Attempt to create a hard link, if we think both old and new
7850 ** are on the same file system, otherwise copy the file.
7852 ** Don't waste time attempting a hard link unless old and new
7853 ** are on the same file system.
7856 SM_REQUIRE(ISVALIDQGRP(old->e_dfqgrp) && ISVALIDQDIR(old->e_dfqdir));
7857 SM_REQUIRE(ISVALIDQGRP(new->e_dfqgrp) && ISVALIDQDIR(new->e_dfqdir));
7859 ofs = Queue[old->e_dfqgrp]->qg_qpaths[old->e_dfqdir].qp_fsysidx;
7860 nfs = Queue[new->e_dfqgrp]->qg_qpaths[new->e_dfqdir].qp_fsysidx;
7861 if (FILE_SYS_DEV(ofs) == FILE_SYS_DEV(nfs))
7863 if (link(opath, npath) == 0)
7865 new->e_flags |= EF_HAS_DF;
7866 SYNC_DIR(npath, true);
7873 ** Can't link across queue directories, so try to create a hard
7874 ** link in the same queue directory as the old df file.
7875 ** The qf file will refer to the new df file using a 'd' record.
7878 new->e_dfqgrp = old->e_dfqgrp;
7879 new->e_dfqdir = old->e_dfqdir;
7880 (void) sm_strlcpy(npath, queuename(new, DATAFL_LETTER), sizeof(npath));
7881 if (link(opath, npath) == 0)
7883 new->e_flags |= EF_HAS_DF;
7884 SYNC_DIR(npath, true);
7890 sm_syslog(LOG_ERR, old->e_id,
7891 "dup_df: can't link %s to %s, error=%s, envelope splitting failed",
7892 opath, npath, sm_errstring(errno));
7897 ** SPLIT_ENV -- Allocate a new envelope based on a given envelope.
7901 ** sendqueue -- sendqueue for new envelope.
7902 ** qgrp -- index of queue group.
7903 ** qdir -- queue directory.
7910 static ENVELOPE *split_env __P((ENVELOPE *, ADDRESS *, int, int));
7913 split_env(e, sendqueue, qgrp, qdir)
7921 ee = (ENVELOPE *) sm_rpool_malloc_x(e->e_rpool, sizeof(*ee));
7922 STRUCTCOPY(*e, *ee);
7923 ee->e_message = NULL; /* XXX use original message? */
7926 ee->e_sendqueue = sendqueue;
7927 ee->e_flags &= ~(EF_INQUEUE|EF_CLRQUEUE|EF_FATALERRS
7928 |EF_SENDRECEIPT|EF_RET_PARAM|EF_HAS_DF);
7929 ee->e_flags |= EF_NORECEIPT; /* XXX really? */
7930 ee->e_from.q_state = QS_SENDER;
7932 ee->e_lockfp = NULL;
7933 if (e->e_xfp != NULL)
7934 ee->e_xfp = sm_io_dup(e->e_xfp);
7936 /* failed to dup e->e_xfp, start a new transcript */
7937 if (ee->e_xfp == NULL)
7940 ee->e_qgrp = ee->e_dfqgrp = qgrp;
7941 ee->e_qdir = ee->e_dfqdir = qdir;
7942 ee->e_errormode = EM_MAIL;
7943 ee->e_statmsg = NULL;
7944 if (e->e_quarmsg != NULL)
7945 ee->e_quarmsg = sm_rpool_strdup_x(ee->e_rpool,
7949 ** XXX Not sure if this copying is necessary.
7950 ** sendall() does this copying, but I (dm) don't know if that is
7951 ** because of the storage management discipline we were using
7952 ** before rpools were introduced, or if it is because these lists
7953 ** can be modified later.
7956 ee->e_header = copyheader(e->e_header, ee->e_rpool);
7957 ee->e_errorqueue = copyqueue(e->e_errorqueue, ee->e_rpool);
7962 /* return values from split functions, check also below! */
7963 #define SM_SPLIT_FAIL (0)
7964 #define SM_SPLIT_NONE (1)
7965 #define SM_SPLIT_NEW(n) (1 + (n))
7968 ** SPLIT_ACROSS_QUEUE_GROUPS
7970 ** This function splits an envelope across multiple queue groups
7971 ** based on the queue group of each recipient.
7977 ** SM_SPLIT_FAIL on failure
7978 ** SM_SPLIT_NONE if no splitting occurred,
7979 ** or 1 + the number of additional envelopes created.
7982 ** On success, e->e_sibling points to a list of zero or more
7983 ** additional envelopes, and the associated data files exist
7984 ** on disk. But the queue files are not created.
7986 ** On failure, e->e_sibling is not changed.
7987 ** The order of recipients in e->e_sendqueue is permuted.
7988 ** Abandoned data files for additional envelopes that failed
7989 ** to be created may exist on disk.
7992 static int q_qgrp_compare __P((const void *, const void *));
7993 static int e_filesys_compare __P((const void *, const void *));
7996 q_qgrp_compare(p1, p2)
8000 ADDRESS **pq1 = (ADDRESS **) p1;
8001 ADDRESS **pq2 = (ADDRESS **) p2;
8003 return (*pq1)->q_qgrp - (*pq2)->q_qgrp;
8007 e_filesys_compare(p1, p2)
8011 ENVELOPE **pe1 = (ENVELOPE **) p1;
8012 ENVELOPE **pe2 = (ENVELOPE **) p2;
8015 fs1 = Queue[(*pe1)->e_qgrp]->qg_qpaths[(*pe1)->e_qdir].qp_fsysidx;
8016 fs2 = Queue[(*pe2)->e_qgrp]->qg_qpaths[(*pe2)->e_qdir].qp_fsysidx;
8017 if (FILE_SYS_DEV(fs1) < FILE_SYS_DEV(fs2))
8019 if (FILE_SYS_DEV(fs1) > FILE_SYS_DEV(fs2))
8024 static int split_across_queue_groups __P((ENVELOPE *));
8026 split_across_queue_groups(e)
8029 int naddrs, nsplits, i;
8032 ADDRESS *q, **addrs;
8034 ENVELOPE *splits[MAXQUEUEGROUPS];
8035 char pvpbuf[PSBUFSIZE];
8037 SM_REQUIRE(ISVALIDQGRP(e->e_qgrp));
8039 /* Count addresses and assign queue groups. */
8042 for (q = e->e_sendqueue; q != NULL; q = q->q_next)
8044 if (QS_IS_DEAD(q->q_state))
8048 /* bad addresses and those already sent stay put */
8049 if (QS_IS_BADADDR(q->q_state) ||
8050 QS_IS_SENT(q->q_state))
8051 q->q_qgrp = e->e_qgrp;
8052 else if (!ISVALIDQGRP(q->q_qgrp))
8054 /* call ruleset which should return a queue group */
8055 i = rscap(RS_QUEUEGROUP, q->q_user, NULL, e, &pvp,
8056 pvpbuf, sizeof(pvpbuf));
8058 pvp != NULL && pvp[0] != NULL &&
8059 (pvp[0][0] & 0377) == CANONNET &&
8060 pvp[1] != NULL && pvp[1][0] != '\0')
8062 i = name2qid(pvp[1]);
8068 sm_syslog(LOG_INFO, NOQID,
8069 "queue group name %s -> %d",
8073 else if (LogLevel > 10)
8074 sm_syslog(LOG_INFO, NOQID,
8075 "can't find queue group name %s, selection ignored",
8078 if (q->q_mailer != NULL &&
8079 ISVALIDQGRP(q->q_mailer->m_qgrp))
8082 q->q_qgrp = q->q_mailer->m_qgrp;
8084 else if (ISVALIDQGRP(e->e_qgrp))
8085 q->q_qgrp = e->e_qgrp;
8091 /* only one address? nothing to split. */
8092 if (naddrs <= 1 && !changed)
8093 return SM_SPLIT_NONE;
8095 /* sort the addresses by queue group */
8096 addrs = sm_rpool_malloc_x(e->e_rpool, naddrs * sizeof(ADDRESS *));
8097 for (i = 0, q = e->e_sendqueue; q != NULL; q = q->q_next)
8099 if (QS_IS_DEAD(q->q_state))
8103 qsort(addrs, naddrs, sizeof(ADDRESS *), q_qgrp_compare);
8105 /* split into multiple envelopes, by queue group */
8108 e->e_sendqueue = NULL;
8109 for (i = 0; i < naddrs; ++i)
8111 if (i == naddrs - 1 || addrs[i]->q_qgrp != addrs[i + 1]->q_qgrp)
8112 addrs[i]->q_next = NULL;
8114 addrs[i]->q_next = addrs[i + 1];
8116 /* same queue group as original envelope? */
8117 if (addrs[i]->q_qgrp == e->e_qgrp)
8119 if (e->e_sendqueue == NULL)
8120 e->e_sendqueue = addrs[i];
8124 /* different queue group than original envelope */
8125 if (es == NULL || addrs[i]->q_qgrp != es->e_qgrp)
8127 ee = split_env(e, addrs[i], addrs[i]->q_qgrp, NOQDIR);
8129 splits[nsplits++] = ee;
8133 /* no splits? return right now. */
8135 return SM_SPLIT_NONE;
8137 /* assign a queue directory to each additional envelope */
8138 for (i = 0; i < nsplits; ++i)
8142 es->e_qdir = pickqdir(Queue[es->e_qgrp], es->e_msgsize, es);
8144 if (!setnewqueue(es))
8148 /* sort the additional envelopes by queue file system */
8149 qsort(splits, nsplits, sizeof(ENVELOPE *), e_filesys_compare);
8151 /* create data files for each additional envelope */
8152 if (!dup_df(e, splits[0]))
8157 for (i = 1; i < nsplits; ++i)
8159 /* copy or link to the previous data file */
8160 if (!dup_df(splits[i - 1], splits[i]))
8164 /* success: prepend the new envelopes to the e->e_sibling list */
8165 for (i = 0; i < nsplits; ++i)
8168 es->e_sibling = e->e_sibling;
8171 return SM_SPLIT_NEW(nsplits);
8173 /* failure: clean up */
8179 for (j = 0; j < i; j++)
8180 (void) unlink(queuename(splits[j], DATAFL_LETTER));
8182 e->e_sendqueue = addrs[0];
8183 for (i = 0; i < naddrs - 1; ++i)
8184 addrs[i]->q_next = addrs[i + 1];
8185 addrs[naddrs - 1]->q_next = NULL;
8186 return SM_SPLIT_FAIL;
8190 ** SPLIT_WITHIN_QUEUE
8192 ** Split an envelope with multiple recipients into several
8193 ** envelopes within the same queue directory, if the number of
8194 ** recipients exceeds the limit for the queue group.
8200 ** SM_SPLIT_FAIL on failure
8201 ** SM_SPLIT_NONE if no splitting occurred,
8202 ** or 1 + the number of additional envelopes created.
8205 #define SPLIT_LOG_LEVEL 8
8207 static int split_within_queue __P((ENVELOPE *));
8210 split_within_queue(e)
8213 int maxrcpt, nrcpt, ndead, nsplit, i;
8216 ADDRESS *q, **addrs;
8217 ENVELOPE *ee, *firstsibling;
8219 if (!ISVALIDQGRP(e->e_qgrp) || bitset(EF_SPLIT, e->e_flags))
8220 return SM_SPLIT_NONE;
8222 /* don't bother if there is no recipient limit */
8223 maxrcpt = Queue[e->e_qgrp]->qg_maxrcpt;
8225 return SM_SPLIT_NONE;
8227 /* count recipients */
8229 for (q = e->e_sendqueue; q != NULL; q = q->q_next)
8231 if (QS_IS_DEAD(q->q_state))
8235 if (nrcpt <= maxrcpt)
8236 return SM_SPLIT_NONE;
8239 ** Preserve the recipient list
8240 ** so that we can restore it in case of error.
8241 ** (But we discard dead addresses.)
8244 addrs = sm_rpool_malloc_x(e->e_rpool, nrcpt * sizeof(ADDRESS *));
8245 for (i = 0, q = e->e_sendqueue; q != NULL; q = q->q_next)
8247 if (QS_IS_DEAD(q->q_state))
8253 ** Partition the recipient list so that bad and sent addresses
8254 ** come first. These will go with the original envelope, and
8255 ** do not count towards the maxrcpt limit.
8256 ** addrs[] does not contain QS_IS_DEAD() addresses.
8260 for (i = 0; i < nrcpt; ++i)
8262 if (QS_IS_BADADDR(addrs[i]->q_state) ||
8263 QS_IS_SENT(addrs[i]->q_state) ||
8264 QS_IS_DEAD(addrs[i]->q_state)) /* for paranoia's sake */
8268 ADDRESS *tmp = addrs[i];
8270 addrs[i] = addrs[ndead];
8277 /* Check if no splitting required. */
8278 if (nrcpt - ndead <= maxrcpt)
8279 return SM_SPLIT_NONE;
8282 for (i = 0; i < nrcpt - 1; ++i)
8283 addrs[i]->q_next = addrs[i + 1];
8284 addrs[nrcpt - 1]->q_next = NULL;
8285 e->e_sendqueue = addrs[0];
8287 /* prepare buffer for logging */
8288 if (LogLevel > SPLIT_LOG_LEVEL)
8291 lsplits = sm_malloc(l);
8292 if (lsplits != NULL)
8298 /* get rid of stupid compiler warnings */
8303 /* split the envelope */
8304 firstsibling = e->e_sibling;
8305 i = maxrcpt + ndead;
8309 addrs[i - 1]->q_next = NULL;
8310 ee = split_env(e, addrs[i], e->e_qgrp, e->e_qdir);
8317 (void) unlink(queuename(ee, DATAFL_LETTER));
8321 /* Error. Restore e's sibling & recipient lists. */
8322 e->e_sibling = firstsibling;
8323 for (i = 0; i < nrcpt - 1; ++i)
8324 addrs[i]->q_next = addrs[i + 1];
8325 if (lsplits != NULL)
8327 return SM_SPLIT_FAIL;
8330 /* prepend the new envelope to e->e_sibling */
8331 ee->e_sibling = e->e_sibling;
8334 if (LogLevel > SPLIT_LOG_LEVEL && lsplits != NULL)
8336 if (j >= l - strlen(ee->e_id) - 3)
8341 p = sm_realloc(lsplits, l);
8344 /* let's try to get this done */
8351 if (lsplits != NULL)
8354 j += sm_strlcat(lsplits + j,
8358 j += sm_strlcat2(lsplits + j,
8365 if (nrcpt - i <= maxrcpt)
8369 if (LogLevel > SPLIT_LOG_LEVEL && lsplits != NULL)
8373 sm_syslog(LOG_NOTICE, e->e_id,
8374 "split: maxrcpts=%d, rcpts=%d, count=%d, id%s=%s",
8375 maxrcpt, nrcpt - ndead, nsplit,
8376 nsplit > 1 ? "s" : "", lsplits);
8380 return SM_SPLIT_NEW(nsplit);
8383 ** SPLIT_BY_RECIPIENT
8385 ** Split an envelope with multiple recipients into multiple
8386 ** envelopes as required by the sendmail configuration.
8392 ** Returns true on success, false on failure.
8395 ** see split_across_queue_groups(), split_within_queue(e)
8399 split_by_recipient(e)
8402 int split, n, i, j, l;
8404 ENVELOPE *ee, *next, *firstsibling;
8406 if (OpMode == SM_VERIFY || !ISVALIDQGRP(e->e_qgrp) ||
8407 bitset(EF_SPLIT, e->e_flags))
8409 n = split_across_queue_groups(e);
8410 if (n == SM_SPLIT_FAIL)
8412 firstsibling = ee = e->e_sibling;
8413 if (n > 1 && LogLevel > SPLIT_LOG_LEVEL)
8416 lsplits = sm_malloc(l);
8417 if (lsplits != NULL)
8423 /* get rid of stupid compiler warnings */
8427 for (i = 1; i < n; ++i)
8429 next = ee->e_sibling;
8430 if (split_within_queue(ee) == SM_SPLIT_FAIL)
8432 e->e_sibling = firstsibling;
8435 ee->e_flags |= EF_SPLIT;
8436 if (LogLevel > SPLIT_LOG_LEVEL && lsplits != NULL)
8438 if (j >= l - strlen(ee->e_id) - 3)
8443 p = sm_realloc(lsplits, l);
8446 /* let's try to get this done */
8453 if (lsplits != NULL)
8456 j += sm_strlcat(lsplits + j,
8459 j += sm_strlcat2(lsplits + j, "; ",
8466 if (LogLevel > SPLIT_LOG_LEVEL && lsplits != NULL && n > 1)
8468 sm_syslog(LOG_NOTICE, e->e_id, "split: count=%d, id%s=%s",
8469 n - 1, n > 2 ? "s" : "", lsplits);
8472 split = split_within_queue(e) != SM_SPLIT_FAIL;
8474 e->e_flags |= EF_SPLIT;
8479 ** QUARANTINE_QUEUE_ITEM -- {un,}quarantine a single envelope
8481 ** Add/remove quarantine reason and requeue appropriately.
8484 ** qgrp -- queue group for the item
8485 ** qdir -- queue directory in the given queue group
8486 ** e -- envelope information for the item
8487 ** reason -- quarantine reason, NULL means unquarantine.
8490 ** true if item changed, false otherwise
8493 ** Changes quarantine tag in queue file and renames it.
8497 quarantine_queue_item(qgrp, qdir, e, reason)
8504 bool failing = false;
8505 bool foundq = false;
8506 bool finished = false;
8512 MODE_T oldumask = 0;
8513 SM_FILE_T *oldqfp, *tempqfp;
8516 char oldqf[MAXPATHLEN];
8517 char tempqf[MAXPATHLEN];
8518 char newqf[MAXPATHLEN];
8521 oldtype = queue_letter(e, ANYQFL_LETTER);
8522 (void) sm_strlcpy(oldqf, queuename(e, ANYQFL_LETTER), sizeof(oldqf));
8523 (void) sm_strlcpy(tempqf, queuename(e, NEWQFL_LETTER), sizeof(tempqf));
8526 ** Instead of duplicating all the open
8527 ** and lock code here, tell readqf() to
8528 ** do that work and return the open
8529 ** file pointer in e_lockfp. Note that
8530 ** we must release the locks properly when
8534 if (!readqf(e, true))
8536 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8537 "Skipping %s\n", qid_printname(e));
8540 oldqfp = e->e_lockfp;
8542 /* open the new queue file */
8543 flags = O_CREAT|O_WRONLY|O_EXCL;
8544 if (bitset(S_IWGRP, QueueFileMode))
8545 oldumask = umask(002);
8546 fd = open(tempqf, flags, QueueFileMode);
8547 if (bitset(S_IWGRP, QueueFileMode))
8548 (void) umask(oldumask);
8554 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8555 "Skipping %s: Could not open %s: %s\n",
8556 qid_printname(e), tempqf,
8557 sm_errstring(save_errno));
8558 (void) sm_io_close(oldqfp, SM_TIME_DEFAULT);
8561 if (!lockfile(fd, tempqf, NULL, LOCK_EX|LOCK_NB))
8563 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8564 "Skipping %s: Could not lock %s\n",
8565 qid_printname(e), tempqf);
8567 (void) sm_io_close(oldqfp, SM_TIME_DEFAULT);
8571 tempqfp = sm_io_open(SmFtStdiofd, SM_TIME_DEFAULT, (void *) &fd,
8572 SM_IO_WRONLY_B, NULL);
8573 if (tempqfp == NULL)
8575 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8576 "Skipping %s: Could not lock %s\n",
8577 qid_printname(e), tempqf);
8579 (void) sm_io_close(oldqfp, SM_TIME_DEFAULT);
8583 /* Copy the data over, changing the quarantine reason */
8584 while (bufsize = sizeof(buf),
8585 (bp = fgetfolded(buf, &bufsize, oldqfp)) != NULL)
8588 sm_dprintf("+++++ %s\n", bp);
8591 case 'q': /* quarantine reason */
8597 (void) sm_io_fprintf(smioout,
8599 "%s: Removed quarantine of \"%s\"\n",
8602 sm_syslog(LOG_INFO, e->e_id, "unquarantine");
8605 else if (strcmp(reason, &bp[1]) == 0)
8609 (void) sm_io_fprintf(smioout,
8611 "%s: Already quarantined with \"%s\"\n",
8614 (void) sm_io_fprintf(tempqfp, SM_TIME_DEFAULT,
8621 (void) sm_io_fprintf(smioout,
8623 "%s: Quarantine changed from \"%s\" to \"%s\"\n",
8627 (void) sm_io_fprintf(tempqfp, SM_TIME_DEFAULT,
8629 sm_syslog(LOG_INFO, e->e_id, "quarantine=%s",
8637 ** If we are quarantining an unquarantined item,
8638 ** need to put in a new 'q' line before it's
8642 if (!foundq && reason != NULL)
8646 (void) sm_io_fprintf(smioout,
8648 "%s: Quarantined with \"%s\"\n",
8651 (void) sm_io_fprintf(tempqfp, SM_TIME_DEFAULT,
8653 sm_syslog(LOG_INFO, e->e_id, "quarantine=%s",
8659 /* Copy the line to the new file */
8660 (void) sm_io_fprintf(tempqfp, SM_TIME_DEFAULT,
8669 /* Copy the line to the new file */
8670 (void) sm_io_fprintf(tempqfp, SM_TIME_DEFAULT,
8678 /* Make sure we read the whole old file */
8679 errno = sm_io_error(tempqfp);
8680 if (errno != 0 && errno != SM_IO_EOF)
8683 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8684 "Skipping %s: Error reading %s: %s\n",
8685 qid_printname(e), oldqf,
8686 sm_errstring(save_errno));
8690 if (!failing && !finished)
8692 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8693 "Skipping %s: Incomplete file: %s\n",
8694 qid_printname(e), oldqf);
8698 /* Check if we actually changed anything or we can just bail now */
8701 /* pretend we failed, even though we technically didn't */
8705 /* Make sure we wrote things out safely */
8707 (sm_io_flush(tempqfp, SM_TIME_DEFAULT) != 0 ||
8708 ((SuperSafe == SAFE_REALLY ||
8709 SuperSafe == SAFE_REALLY_POSTMILTER ||
8710 SuperSafe == SAFE_INTERACTIVE) &&
8711 fsync(sm_io_getinfo(tempqfp, SM_IO_WHAT_FD, NULL)) < 0) ||
8712 ((errno = sm_io_error(tempqfp)) != 0)))
8715 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8716 "Skipping %s: Error writing %s: %s\n",
8717 qid_printname(e), tempqf,
8718 sm_errstring(save_errno));
8723 /* Figure out the new filename */
8724 newtype = (reason == NULL ? NORMQF_LETTER : QUARQF_LETTER);
8725 if (oldtype == newtype)
8727 /* going to rename tempqf to oldqf */
8728 (void) sm_strlcpy(newqf, oldqf, sizeof(newqf));
8732 /* going to rename tempqf to new name based on newtype */
8733 (void) sm_strlcpy(newqf, queuename(e, newtype), sizeof(newqf));
8738 /* rename tempqf to newqf */
8740 rename(tempqf, newqf) < 0)
8741 save_errno = (errno == 0) ? EINVAL : errno;
8743 /* Check rename() success */
8744 if (!failing && save_errno != 0)
8746 sm_syslog(LOG_DEBUG, e->e_id,
8747 "quarantine_queue_item: rename(%s, %s): %s",
8748 tempqf, newqf, sm_errstring(save_errno));
8750 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8751 "Error renaming %s to %s: %s\n",
8753 sm_errstring(save_errno));
8754 if (oldtype == newtype)
8757 ** Bail here since we don't know the state of
8758 ** the filesystem and may need to keep tempqf
8759 ** for the user to rescue us.
8764 syserr("!452 Error renaming control file %s", tempqf);
8769 /* remove new file (if rename() half completed) */
8770 if (xunlink(newqf) < 0)
8773 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8774 "Error removing %s: %s\n",
8776 sm_errstring(save_errno));
8779 /* tempqf removed below */
8785 /* If changing file types, need to remove old type */
8786 if (!failing && oldtype != newtype)
8788 if (xunlink(oldqf) < 0)
8791 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8792 "Error removing %s: %s\n",
8793 oldqf, sm_errstring(save_errno));
8797 /* see if anything above failed */
8800 /* Something failed: remove new file, old file still there */
8801 (void) xunlink(tempqf);
8805 ** fsync() after file operations to make sure metadata is
8806 ** written to disk on filesystems in which renames are
8807 ** not guaranteed. It's ok if they fail, mail won't be lost.
8810 if (SuperSafe != SAFE_NO)
8812 /* for soft-updates */
8813 (void) fsync(sm_io_getinfo(tempqfp,
8814 SM_IO_WHAT_FD, NULL));
8818 /* for soft-updates */
8819 (void) fsync(sm_io_getinfo(oldqfp,
8820 SM_IO_WHAT_FD, NULL));
8823 /* for other odd filesystems */
8824 SYNC_DIR(tempqf, false);
8829 if (tempqfp != NULL)
8830 (void) sm_io_close(tempqfp, SM_TIME_DEFAULT);
8832 (void) sm_io_close(oldqfp, SM_TIME_DEFAULT);
8839 ** QUARANTINE_QUEUE -- {un,}quarantine matching items in the queue
8841 ** Read all matching queue items, add/remove quarantine
8842 ** reason, and requeue appropriately.
8845 ** reason -- quarantine reason, "." means unquarantine.
8846 ** qgrplimit -- limit to single queue group unless NOQGRP
8852 ** Lots of changes to the queue.
8856 quarantine_queue(reason, qgrplimit)
8863 /* Convert internal representation of unquarantine */
8864 if (reason != NULL && reason[0] == '.' && reason[1] == '\0')
8870 reason = newstr(denlstring(reason, true, true));
8873 for (qgrp = 0; qgrp < NumQueue && Queue[qgrp] != NULL; qgrp++)
8877 if (qgrplimit != NOQGRP && qgrplimit != qgrp)
8880 for (qdir = 0; qdir < Queue[qgrp]->qg_numqueues; qdir++)
8888 nrequests = gatherq(qgrp, qdir, true, NULL, NULL, NULL);
8890 /* first see if there is anything */
8895 (void) sm_io_fprintf(smioout,
8896 SM_TIME_DEFAULT, "%s: no matches\n",
8897 qid_printqueue(qgrp, qdir));
8904 (void) sm_io_fprintf(smioout,
8905 SM_TIME_DEFAULT, "Processing %s:\n",
8906 qid_printqueue(qgrp, qdir));
8909 for (i = 0; i < WorkListCount; i++)
8916 /* setup envelope */
8917 clearenvelope(&e, true, sm_rpool_new_x(NULL));
8918 e.e_id = WorkList[i].w_name + 2;
8924 sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8925 "Would do %s\n", e.e_id);
8928 else if (quarantine_queue_item(qgrp, qdir,
8933 sm_rpool_free(e.e_rpool);
8936 if (WorkList != NULL)
8937 sm_free(WorkList); /* XXX */
8946 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8949 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8952 changed == 1 ? "" : "s");