2 * Copyright (c) 1998-2009, 2011 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.991 2011/03/15 23:14:36 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;
1498 ** If MaxQueueChildren active then test whether the start
1499 ** of the next queue group's additional queue runners (maximum)
1500 ** will result in MaxQueueChildren being exceeded.
1502 ** Note: do not use continue; even though another workgroup
1503 ** may have fewer queue runners, this would be "unfair",
1504 ** i.e., this work group might "starve" then.
1507 #if _FFR_QUEUE_SCHED_DBG
1509 sm_syslog(LOG_INFO, NOQID,
1510 "rq: curnum=%d, MaxQueueChildren=%d, CurRunners=%d, WorkGrp[curnum].wg_maxact=%d",
1511 curnum, MaxQueueChildren, CurRunners,
1512 WorkGrp[curnum].wg_maxact);
1513 #endif /* _FFR_QUEUE_SCHED_DBG */
1514 if (MaxQueueChildren > 0 &&
1515 CurRunners + WorkGrp[curnum].wg_maxact > MaxQueueChildren)
1519 ** Pick up where we left off (curnum), in case we
1520 ** used up all the children last time without finishing.
1521 ** This give a round-robin fairness to queue runs.
1523 ** Increment CurRunners before calling run_work_group()
1524 ** to avoid a "race condition" with proc_list_drop() which
1525 ** decrements CurRunners if the queue runners terminate.
1526 ** Notice: CurRunners is an upper limit, in some cases
1527 ** (too few jobs in the queue) this value is larger than
1528 ** the actual number of queue runners. The discrepancy can
1529 ** increase if some queue runners "hang" for a long time.
1532 CurRunners += WorkGrp[curnum].wg_maxact;
1534 rwgflags |= RWG_FORK;
1536 rwgflags |= RWG_VERBOSE;
1538 rwgflags |= RWG_PERSISTENT;
1540 rwgflags |= RWG_RUNALL;
1541 ret = run_work_group(curnum, rwgflags);
1544 ** Failure means a message was printed for ETRN
1545 ** and subsequent queues are likely to fail as well.
1546 ** Decrement CurRunners in that case because
1547 ** none have been started.
1552 CurRunners -= WorkGrp[curnum].wg_maxact;
1557 schedule_queue_runs(runall, curnum, true);
1558 INCR_MOD(curnum, NumWorkGroups);
1561 /* schedule left over queue runs */
1562 if (i < NumWorkGroups && !NoMoreRunners && !persistent)
1566 for (h = curnum; i < NumWorkGroups; i++)
1568 schedule_queue_runs(runall, h, false);
1569 INCR_MOD(h, NumWorkGroups);
1575 if (sm_debug_active(&DebugLeakQ, 1))
1576 sm_heap_setgroup(oldgroup);
1577 #endif /* SM_HEAP_CHECK */
1581 #if _FFR_SKIP_DOMAINS
1583 ** SKIP_DOMAINS -- Skip 'skip' number of domains in the WorkQ.
1585 ** Added by Stephen Frost <sfrost@snowman.net> to support
1586 ** having each runner process every N'th domain instead of
1587 ** every N'th message.
1590 ** skip -- number of domains in WorkQ to skip.
1593 ** total number of messages skipped.
1605 for (n = 0, seqjump = 0; n < skip && WorkQ != NULL; seqjump++)
1607 if (WorkQ->w_next != NULL)
1609 if (WorkQ->w_host != NULL &&
1610 WorkQ->w_next->w_host != NULL)
1612 if (sm_strcasecmp(WorkQ->w_host,
1613 WorkQ->w_next->w_host) != 0)
1618 if ((WorkQ->w_host != NULL &&
1619 WorkQ->w_next->w_host == NULL) ||
1620 (WorkQ->w_host == NULL &&
1621 WorkQ->w_next->w_host != NULL))
1625 WorkQ = WorkQ->w_next;
1629 #endif /* _FFR_SKIP_DOMAINS */
1632 ** RUNNER_WORK -- have a queue runner do its work
1634 ** Have a queue runner do its work a list of entries.
1635 ** When work isn't directly being done then this process can take a signal
1636 ** and terminate immediately (in a clean fashion of course).
1637 ** When work is directly being done, it's not to be interrupted
1638 ** immediately: the work should be allowed to finish at a clean point
1639 ** before termination (in a clean fashion of course).
1643 ** sequenceno -- 'th process to run WorkQ.
1644 ** didfork -- did the calling process fork()?
1645 ** skip -- process only each skip'th item.
1646 ** njobs -- number of jobs in WorkQ.
1652 ** runs things in the mail queue.
1656 runner_work(e, sequenceno, didfork, skip, njobs)
1657 register ENVELOPE *e;
1670 ** Here we temporarily block the second calling of the handlers.
1671 ** This allows us to handle the signal without terminating in the
1672 ** middle of direct work. If a signal does come, the test for
1673 ** NoMoreRunners will find it.
1679 /* process them once at a time */
1680 while (WorkQ != NULL)
1683 SM_NONVOLATILE int oldgroup = 0;
1685 if (sm_debug_active(&DebugLeakQ, 1))
1687 oldgroup = sm_heap_group();
1689 sm_dprintf("run_queue_group() heap group #%d\n",
1692 #endif /* SM_HEAP_CHECK */
1694 /* do no more work */
1697 /* Check that a valid signal handler is callable */
1698 if (Oldsh != SIG_DFL && Oldsh != SIG_IGN &&
1699 Oldsh != runners_sighup &&
1700 Oldsh != runners_sigterm)
1705 w = WorkQ; /* assign current work item */
1708 ** Set the head of the WorkQ to the next work item.
1709 ** It is set 'skip' ahead (the number of parallel queue
1710 ** runners working on WorkQ together) since each runner
1711 ** works on every 'skip'th (N-th) item.
1712 #if _FFR_SKIP_DOMAINS
1713 ** In the case of the BYHOST Queue Sort Order, the 'item'
1714 ** is a domain, so we work on every 'skip'th (N-th) domain.
1715 #endif * _FFR_SKIP_DOMAINS *
1718 #if _FFR_SKIP_DOMAINS
1719 if (QueueSortOrder == QSO_BYHOST)
1722 if (WorkQ->w_next != NULL)
1724 if (WorkQ->w_host != NULL &&
1725 WorkQ->w_next->w_host != NULL)
1727 if (sm_strcasecmp(WorkQ->w_host,
1728 WorkQ->w_next->w_host)
1730 seqjump = skip_domains(skip);
1732 WorkQ = WorkQ->w_next;
1736 if ((WorkQ->w_host != NULL &&
1737 WorkQ->w_next->w_host == NULL) ||
1738 (WorkQ->w_host == NULL &&
1739 WorkQ->w_next->w_host != NULL))
1740 seqjump = skip_domains(skip);
1742 WorkQ = WorkQ->w_next;
1746 WorkQ = WorkQ->w_next;
1749 #endif /* _FFR_SKIP_DOMAINS */
1751 for (n = 0; n < skip && WorkQ != NULL; n++)
1752 WorkQ = WorkQ->w_next;
1758 ** Ignore jobs that are too expensive for the moment.
1760 ** Get new load average every GET_NEW_LA_TIME seconds.
1764 if (shouldqueue(WkRecipFact, Current_LA_time))
1766 char *msg = "Aborting queue run: load average too high";
1771 sm_syslog(LOG_INFO, NOQID, "runqueue: %s", msg);
1774 if (shouldqueue(w->w_pri, w->w_ctime))
1777 message(EmptyString);
1778 if (QueueSortOrder == QSO_BYPRIORITY)
1781 message("Skipping %s/%s (sequence %d of %d) and flushing rest of queue",
1782 qid_printqueue(w->w_qgrp,
1784 w->w_name + 2, sequenceno,
1787 sm_syslog(LOG_INFO, NOQID,
1788 "runqueue: Flushing queue from %s/%s (pri %ld, LA %d, %d of %d)",
1789 qid_printqueue(w->w_qgrp,
1791 w->w_name + 2, w->w_pri,
1792 CurrentLA, sequenceno,
1797 message("Skipping %s/%s (sequence %d of %d)",
1798 qid_printqueue(w->w_qgrp, w->w_qdir),
1799 w->w_name + 2, sequenceno, njobs);
1805 message(EmptyString);
1806 message("Running %s/%s (sequence %d of %d)",
1807 qid_printqueue(w->w_qgrp, w->w_qdir),
1808 w->w_name + 2, sequenceno, njobs);
1810 if (didfork && MaxQueueChildren > 0)
1812 sm_blocksignal(SIGCHLD);
1813 (void) sm_signal(SIGCHLD, reapchild);
1816 sm_syslog(LOG_DEBUG, NOQID,
1817 "runqueue %s dowork(%s)",
1818 qid_printqueue(w->w_qgrp, w->w_qdir),
1821 (void) dowork(w->w_qgrp, w->w_qdir, w->w_name + 2,
1822 ForkQueueRuns, false, e);
1825 sm_free(w->w_name); /* XXX */
1826 if (w->w_host != NULL)
1827 sm_free(w->w_host); /* XXX */
1828 sm_free((char *) w); /* XXX */
1829 sequenceno += seqjump; /* next sequence number */
1831 if (sm_debug_active(&DebugLeakQ, 1))
1832 sm_heap_setgroup(oldgroup);
1833 #endif /* SM_HEAP_CHECK */
1838 /* check the signals didn't happen during the revert */
1841 /* Check that a valid signal handler is callable */
1842 if (Oldsh != SIG_DFL && Oldsh != SIG_IGN &&
1843 Oldsh != runners_sighup && Oldsh != runners_sigterm)
1847 Oldsh = SIG_DFL; /* after the NoMoreRunners check */
1850 ** RUN_WORK_GROUP -- run the jobs in a queue group from a work group.
1852 ** Gets the stuff out of the queue in some presumably logical
1853 ** order and processes them.
1856 ** wgrp -- work group to process.
1857 ** flags -- RWG_* flags
1860 ** true if the queue run successfully began.
1863 ** runs things in the mail queue.
1866 /* Minimum sleep time for persistent queue runners */
1867 #define MIN_SLEEP_TIME 5
1870 run_work_group(wgrp, flags)
1874 register ENVELOPE *e;
1877 int qgrp, endgrp, h, i;
1881 extern ENVELOPE BlankEnvelope;
1882 extern SIGFUNC_DECL reapchild __P((int));
1888 ** If no work will ever be selected, don't even bother reading
1894 if (!bitset(RWG_PERSISTENT, flags) &&
1895 shouldqueue(WkRecipFact, Current_LA_time))
1897 char *msg = "Skipping queue run -- load average too high";
1899 if (bitset(RWG_VERBOSE, flags))
1900 message("458 %s\n", msg);
1902 sm_syslog(LOG_INFO, NOQID, "runqueue: %s", msg);
1907 ** See if we already have too many children.
1910 if (bitset(RWG_FORK, flags) &&
1911 WorkGrp[wgrp].wg_lowqintvl > 0 &&
1912 !bitset(RWG_PERSISTENT, flags) &&
1913 MaxChildren > 0 && CurChildren >= MaxChildren)
1915 char *msg = "Skipping queue run -- too many children";
1917 if (bitset(RWG_VERBOSE, flags))
1918 message("458 %s (%d)\n", msg, CurChildren);
1920 sm_syslog(LOG_INFO, NOQID, "runqueue: %s (%d)",
1926 ** See if we want to go off and do other useful work.
1929 if (bitset(RWG_FORK, flags))
1933 (void) sm_blocksignal(SIGCHLD);
1934 (void) sm_signal(SIGCHLD, reapchild);
1939 const char *msg = "Skipping queue run -- fork() failed";
1940 const char *err = sm_errstring(errno);
1942 if (bitset(RWG_VERBOSE, flags))
1943 message("458 %s: %s\n", msg, err);
1945 sm_syslog(LOG_INFO, NOQID, "runqueue: %s: %s",
1947 (void) sm_releasesignal(SIGCHLD);
1952 /* parent -- pick up intermediate zombie */
1953 (void) sm_blocksignal(SIGALRM);
1955 /* wgrp only used when queue runners are persistent */
1956 proc_list_add(pid, "Queue runner", PROC_QUEUE,
1957 WorkGrp[wgrp].wg_maxact,
1958 bitset(RWG_PERSISTENT, flags) ? wgrp : -1,
1960 (void) sm_releasesignal(SIGALRM);
1961 (void) sm_releasesignal(SIGCHLD);
1965 /* child -- clean up signals */
1967 /* Reset global flags */
1968 RestartRequest = NULL;
1969 RestartWorkGroup = false;
1970 ShutdownRequest = NULL;
1972 CurrentPid = getpid();
1973 close_sendmail_pid();
1976 ** Initialize exception stack and default exception
1977 ** handler for child process.
1980 sm_exc_newthread(fatal_error);
1984 /* Add parent process as first child item */
1985 proc_list_add(CurrentPid, "Queue runner child process",
1986 PROC_QUEUE_CHILD, 0, -1, NULL);
1987 (void) sm_releasesignal(SIGCHLD);
1988 (void) sm_signal(SIGCHLD, SIG_DFL);
1989 (void) sm_signal(SIGHUP, SIG_DFL);
1990 (void) sm_signal(SIGTERM, intsig);
1994 ** Release any resources used by the daemon code.
1999 /* force it to run expensive jobs */
2002 /* drop privileges */
2003 if (geteuid() == (uid_t) 0)
2004 (void) drop_privileges(false);
2007 ** Create ourselves an envelope
2010 CurEnv = &QueueEnvelope;
2011 rpool = sm_rpool_new_x(NULL);
2012 e = newenvelope(&QueueEnvelope, CurEnv, rpool);
2013 e->e_flags = BlankEnvelope.e_flags;
2016 /* make sure we have disconnected from parent */
2017 if (bitset(RWG_FORK, flags))
2024 ** If we are running part of the queue, always ignore stored
2028 if (QueueLimitId != NULL || QueueLimitSender != NULL ||
2029 QueueLimitQuarantine != NULL ||
2030 QueueLimitRecipient != NULL)
2032 IgnoreHostStatus = true;
2037 ** Here is where we choose the queue group from the work group.
2038 ** The caller of the "domorework" label must setup a new envelope.
2041 endgrp = WorkGrp[wgrp].wg_curqgrp; /* to not spin endlessly */
2046 ** Run a queue group if:
2047 ** RWG_RUNALL bit is set or the bit for this group is set.
2054 ** Find the next queue group within the work group that
2055 ** has been marked as needing a run.
2058 qgrp = WorkGrp[wgrp].wg_qgs[WorkGrp[wgrp].wg_curqgrp]->qg_index;
2059 WorkGrp[wgrp].wg_curqgrp++; /* advance */
2060 WorkGrp[wgrp].wg_curqgrp %= WorkGrp[wgrp].wg_numqgrp; /* wrap */
2061 if (bitset(RWG_RUNALL, flags) ||
2062 (Queue[qgrp]->qg_nextrun <= now &&
2063 Queue[qgrp]->qg_nextrun != (time_t) -1))
2065 if (endgrp == WorkGrp[wgrp].wg_curqgrp)
2068 if (bitset(RWG_FORK, flags))
2069 finis(true, true, ExitStat);
2070 return true; /* we're done */
2074 qdir = Queue[qgrp]->qg_curnum; /* round-robin init of queue position */
2075 #if _FFR_QUEUE_SCHED_DBG
2077 sm_syslog(LOG_INFO, NOQID,
2078 "rwg: wgrp=%d, qgrp=%d, qdir=%d, name=%s, curqgrp=%d, numgrps=%d",
2079 wgrp, qgrp, qdir, qid_printqueue(qgrp, qdir),
2080 WorkGrp[wgrp].wg_curqgrp, WorkGrp[wgrp].wg_numqgrp);
2081 #endif /* _FFR_QUEUE_SCHED_DBG */
2084 /* tweak niceness of queue runs */
2085 if (Queue[qgrp]->qg_nice > 0)
2086 (void) nice(Queue[qgrp]->qg_nice);
2087 #endif /* HASNICE */
2089 /* XXX running queue group... */
2090 sm_setproctitle(true, CurEnv, "running queue: %s",
2091 qid_printqueue(qgrp, qdir));
2093 if (LogLevel > 69 || tTd(63, 99))
2094 sm_syslog(LOG_DEBUG, NOQID,
2095 "runqueue %s, pid=%d, forkflag=%d",
2096 qid_printqueue(qgrp, qdir), (int) CurrentPid,
2097 bitset(RWG_FORK, flags));
2100 ** Start making passes through the queue.
2101 ** First, read and sort the entire queue.
2102 ** Then, process the work in that order.
2103 ** But if you take too long, start over.
2106 for (i = 0; i < Queue[qgrp]->qg_numqueues; i++)
2108 (void) gatherq(qgrp, qdir, false, &full, &more, &h);
2110 if (ShmId != SM_SHM_NO_ID)
2111 QSHM_ENTRIES(Queue[qgrp]->qg_qpaths[qdir].qp_idx) = h;
2112 #endif /* SM_CONF_SHM */
2113 /* If there are no more items in this queue advance */
2116 /* A round-robin advance */
2118 qdir %= Queue[qgrp]->qg_numqueues;
2121 /* Has the WorkList reached the limit? */
2123 break; /* don't try to gather more */
2126 /* order the existing work requests */
2127 njobs = sortq(Queue[qgrp]->qg_maxlist);
2128 Queue[qgrp]->qg_curnum = qdir; /* update */
2131 if (!Verbose && bitnset(QD_FORK, Queue[qgrp]->qg_flags))
2133 int loop, maxrunners;
2137 ** For this WorkQ we want to fork off N children (maxrunners)
2138 ** at this point. Each child has a copy of WorkQ. Each child
2139 ** will process every N-th item. The parent will wait for all
2140 ** of the children to finish before moving on to the next
2141 ** queue group within the work group. This saves us forking
2142 ** a new runner-child for each work item.
2143 ** It's valid for qg_maxqrun == 0 since this may be an
2144 ** explicit "don't run this queue" setting.
2147 maxrunners = Queue[qgrp]->qg_maxqrun;
2150 ** If no runners are configured for this group but
2151 ** the queue is "forced" then lets use 1 runner.
2154 if (maxrunners == 0 && bitset(RWG_FORCE, flags))
2157 /* No need to have more runners then there are jobs */
2158 if (maxrunners > njobs)
2160 for (loop = 0; loop < maxrunners; loop++)
2163 ** Since the delivery may happen in a child and the
2164 ** parent does not wait, the parent may close the
2165 ** maps thereby removing any shared memory used by
2166 ** the map. Therefore, close the maps now so the
2167 ** child will dynamically open them if necessary.
2175 syserr("run_work_group: cannot fork");
2180 /* parent -- clean out connection cache */
2181 mci_flush(false, NULL);
2182 #if _FFR_SKIP_DOMAINS
2183 if (QueueSortOrder == QSO_BYHOST)
2185 sequenceno += skip_domains(1);
2188 #endif /* _FFR_SKIP_DOMAINS */
2191 WorkQ = WorkQ->w_next;
2194 proc_list_add(pid, "Queue child runner process",
2195 PROC_QUEUE_CHILD, 0, -1, NULL);
2197 /* No additional work, no additional runners */
2203 /* child -- Reset global flags */
2204 RestartRequest = NULL;
2205 RestartWorkGroup = false;
2206 ShutdownRequest = NULL;
2208 CurrentPid = getpid();
2209 close_sendmail_pid();
2212 ** Initialize exception stack and default
2213 ** exception handler for child process.
2214 ** When fork()'d the child now has a private
2215 ** copy of WorkQ at its current position.
2218 sm_exc_newthread(fatal_error);
2221 ** SMTP processes (whether -bd or -bs) set
2222 ** SIGCHLD to reapchild to collect
2223 ** children status. However, at delivery
2224 ** time, that status must be collected
2225 ** by sm_wait() to be dealt with properly
2226 ** (check success of delivery based
2227 ** on status code, etc). Therefore, if we
2228 ** are an SMTP process, reset SIGCHLD
2229 ** back to the default so reapchild
2230 ** doesn't collect status before
2234 if (OpMode == MD_SMTP ||
2235 OpMode == MD_DAEMON ||
2236 MaxQueueChildren > 0)
2239 sm_releasesignal(SIGCHLD);
2240 (void) sm_signal(SIGCHLD, SIG_DFL);
2243 /* child -- error messages to the transcript */
2244 QuickAbort = OnlyOneError = false;
2245 runner_work(e, sequenceno, true,
2248 /* This child is done */
2249 finis(true, true, ExitStat);
2254 sm_releasesignal(SIGCHLD);
2257 ** Wait until all of the runners have completed before
2258 ** seeing if there is another queue group in the
2259 ** work group to process.
2260 ** XXX Future enhancement: don't wait() for all children
2261 ** here, just go ahead and make sure that overall the number
2262 ** of children is not exceeded.
2265 while (CurChildren > 0)
2270 while ((ret = sm_wait(&status)) <= 0)
2272 proc_list_drop(ret, status, NULL);
2275 else if (Queue[qgrp]->qg_maxqrun > 0 || bitset(RWG_FORCE, flags))
2278 ** When current process will not fork children to do the work,
2279 ** it will do the work itself. The 'skip' will be 1 since
2280 ** there are no child runners to divide the work across.
2283 runner_work(e, sequenceno, false, 1, njobs);
2286 /* free memory allocated by newenvelope() above */
2287 sm_rpool_free(rpool);
2288 QueueEnvelope.e_rpool = NULL;
2290 /* Are there still more queues in the work group to process? */
2291 if (endgrp != WorkGrp[wgrp].wg_curqgrp)
2293 rpool = sm_rpool_new_x(NULL);
2294 e = newenvelope(&QueueEnvelope, CurEnv, rpool);
2295 e->e_flags = BlankEnvelope.e_flags;
2299 /* No more queues in work group to process. Now check persistent. */
2300 if (bitset(RWG_PERSISTENT, flags))
2303 sm_setproctitle(true, CurEnv, "running queue: %s",
2304 qid_printqueue(qgrp, qdir));
2307 ** close bogus maps, i.e., maps which caused a tempfail,
2308 ** so we get fresh map connections on the next lookup.
2309 ** closemaps() is also called when children are started.
2314 /* Close any cached connections. */
2315 mci_flush(true, NULL);
2317 /* Clean out expired related entries. */
2321 /* Update MX records for FallbackMX. */
2322 if (FallbackMX != NULL)
2323 (void) getfallbackmxrr(FallbackMX);
2324 #endif /* NAMED_BIND */
2327 /* close UserDatabase */
2332 if (sm_debug_active(&SmHeapCheck, 2)
2333 && access("memdump", F_OK) == 0
2339 out = sm_io_open(SmFtStdio, SM_TIME_DEFAULT,
2340 "memdump.out", SM_IO_APPEND, NULL);
2343 (void) sm_io_fprintf(out, SM_TIME_DEFAULT, "----------------------\n");
2345 sm_debug_level(&SmHeapCheck) - 1);
2346 (void) sm_io_close(out, SM_TIME_DEFAULT);
2349 #endif /* SM_HEAP_CHECK */
2351 /* let me rest for a second to catch my breath */
2352 if (njobs == 0 && WorkGrp[wgrp].wg_lowqintvl < MIN_SLEEP_TIME)
2353 sleep(MIN_SLEEP_TIME);
2354 else if (WorkGrp[wgrp].wg_lowqintvl <= 0)
2355 sleep(QueueIntvl > 0 ? QueueIntvl : MIN_SLEEP_TIME);
2357 sleep(WorkGrp[wgrp].wg_lowqintvl);
2360 ** Get the LA outside the WorkQ loop if necessary.
2361 ** In a persistent queue runner the code is repeated over
2362 ** and over but gatherq() may ignore entries due to
2363 ** shouldqueue() (do we really have to do this twice?).
2364 ** Hence the queue runners would just idle around when once
2365 ** CurrentLA caused all entries in a queue to be ignored.
2370 rpool = sm_rpool_new_x(NULL);
2371 e = newenvelope(&QueueEnvelope, CurEnv, rpool);
2372 e->e_flags = BlankEnvelope.e_flags;
2376 /* exit without the usual cleanup */
2378 if (bitset(RWG_FORK, flags))
2379 finis(true, true, ExitStat);
2385 ** DOQUEUERUN -- do a queue run?
2395 ** RUNQUEUEEVENT -- Sets a flag to indicate that a queue run should be done.
2404 ** The invocation of this function via an alarm may interrupt
2405 ** a set of actions. Thus errno may be set in that context.
2406 ** We need to restore errno at the end of this function to ensure
2407 ** that any work done here that sets errno doesn't return a
2408 ** misleading/false errno value. Errno may be EINTR upon entry to
2409 ** this function because of non-restartable/continuable system
2410 ** API was active. Iff this is true we will override errno as
2411 ** a timeout (as a more accurate error message).
2413 ** NOTE: THIS CAN BE CALLED FROM A SIGNAL HANDLER. DO NOT ADD
2414 ** ANYTHING TO THIS ROUTINE UNLESS YOU KNOW WHAT YOU ARE
2419 runqueueevent(ignore)
2422 int save_errno = errno;
2425 ** Set the general bit that we want a queue run,
2426 ** tested in doqueuerun()
2430 #if _FFR_QUEUE_SCHED_DBG
2432 sm_syslog(LOG_INFO, NOQID, "rqe: done");
2433 #endif /* _FFR_QUEUE_SCHED_DBG */
2440 ** GATHERQ -- gather messages from the message queue(s) the work queue.
2443 ** qgrp -- the index of the queue group.
2444 ** qdir -- the index of the queue directory.
2445 ** doall -- if set, include everything in the queue (even
2446 ** the jobs that cannot be run because the load
2447 ** average is too high, or MaxQueueRun is reached).
2448 ** Otherwise, exclude those jobs.
2449 ** full -- (optional) to be set 'true' if WorkList is full
2450 ** more -- (optional) to be set 'true' if there are still more
2451 ** messages in this queue not added to WorkList
2452 ** pnentries -- (optional) total nuber of entries in queue
2455 ** The number of request in the queue (not necessarily
2456 ** the number of requests in WorkList however).
2459 ** prepares available work into WorkList
2462 #define NEED_P 0001 /* 'P': priority */
2463 #define NEED_T 0002 /* 'T': time */
2464 #define NEED_R 0004 /* 'R': recipient */
2465 #define NEED_S 0010 /* 'S': sender */
2466 #define NEED_H 0020 /* host */
2467 #define HAS_QUARANTINE 0040 /* has an unexpected 'q' line */
2468 #define NEED_QUARANTINE 0100 /* 'q': reason */
2470 static WORK *WorkList = NULL; /* list of unsort work */
2471 static int WorkListSize = 0; /* current max size of WorkList */
2472 static int WorkListCount = 0; /* # of work items in WorkList */
2475 gatherq(qgrp, qdir, doall, full, more, pnentries)
2483 register struct dirent *d;
2487 int i, num_ent, wn, nentries;
2489 char qd[MAXPATHLEN];
2490 char qf[MAXPATHLEN];
2492 wn = WorkListCount - 1;
2496 (void) sm_strlcpy(qd, ".", sizeof(qd));
2498 (void) sm_strlcpyn(qd, sizeof(qd), 2,
2499 Queue[qgrp]->qg_qpaths[qdir].qp_name,
2501 Queue[qgrp]->qg_qpaths[qdir].qp_subdirs)
2506 sm_dprintf("gatherq:\n");
2508 check = QueueLimitId;
2509 while (check != NULL)
2511 sm_dprintf("\tQueueLimitId = %s%s\n",
2512 check->queue_negate ? "!" : "",
2513 check->queue_match);
2514 check = check->queue_next;
2517 check = QueueLimitSender;
2518 while (check != NULL)
2520 sm_dprintf("\tQueueLimitSender = %s%s\n",
2521 check->queue_negate ? "!" : "",
2522 check->queue_match);
2523 check = check->queue_next;
2526 check = QueueLimitRecipient;
2527 while (check != NULL)
2529 sm_dprintf("\tQueueLimitRecipient = %s%s\n",
2530 check->queue_negate ? "!" : "",
2531 check->queue_match);
2532 check = check->queue_next;
2535 if (QueueMode == QM_QUARANTINE)
2537 check = QueueLimitQuarantine;
2538 while (check != NULL)
2540 sm_dprintf("\tQueueLimitQuarantine = %s%s\n",
2541 check->queue_negate ? "!" : "",
2542 check->queue_match);
2543 check = check->queue_next;
2548 /* open the queue directory */
2552 syserr("gatherq: cannot open \"%s\"",
2553 qid_printqueue(qgrp, qdir));
2555 *full = WorkListCount >= MaxQueueRun && MaxQueueRun > 0;
2562 ** Read the work directory.
2565 while ((d = readdir(f)) != NULL)
2569 char lbuf[MAXNAME + 1];
2573 sm_dprintf("gatherq: checking %s..", d->d_name);
2575 /* is this an interesting entry? */
2576 if (!(((QueueMode == QM_NORMAL &&
2577 d->d_name[0] == NORMQF_LETTER) ||
2578 (QueueMode == QM_QUARANTINE &&
2579 d->d_name[0] == QUARQF_LETTER) ||
2580 (QueueMode == QM_LOST &&
2581 d->d_name[0] == LOSEQF_LETTER)) &&
2582 d->d_name[1] == 'f'))
2585 sm_dprintf(" skipping\n");
2591 if (strlen(d->d_name) >= MAXQFNAME)
2594 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
2595 "gatherq: %s too long, %d max characters\n",
2596 d->d_name, MAXQFNAME);
2598 sm_syslog(LOG_ALERT, NOQID,
2599 "gatherq: %s too long, %d max characters",
2600 d->d_name, MAXQFNAME);
2605 check = QueueLimitId;
2606 while (check != NULL)
2608 if (strcontainedin(false, check->queue_match,
2609 d->d_name) != check->queue_negate)
2612 check = check->queue_next;
2614 if (QueueLimitId != NULL && check == NULL)
2617 /* grow work list if necessary */
2618 if (++wn >= MaxQueueRun && MaxQueueRun > 0)
2620 if (wn == MaxQueueRun && LogLevel > 0)
2621 sm_syslog(LOG_WARNING, NOQID,
2622 "WorkList for %s maxed out at %d",
2623 qid_printqueue(qgrp, qdir),
2626 continue; /* just count entries */
2629 if (wn >= WorkListSize)
2631 grow_wlist(qgrp, qdir);
2632 if (wn >= WorkListSize)
2638 (void) sm_strlcpyn(qf, sizeof(qf), 3, qd, "/", d->d_name);
2639 if (stat(qf, &sbuf) < 0)
2641 if (errno != ENOENT)
2642 sm_syslog(LOG_INFO, NOQID,
2643 "gatherq: can't stat %s/%s",
2644 qid_printqueue(qgrp, qdir),
2649 if (!bitset(S_IFREG, sbuf.st_mode))
2651 /* Yikes! Skip it or we will hang on open! */
2652 if (!((d->d_name[0] == DATAFL_LETTER ||
2653 d->d_name[0] == NORMQF_LETTER ||
2654 d->d_name[0] == QUARQF_LETTER ||
2655 d->d_name[0] == LOSEQF_LETTER ||
2656 d->d_name[0] == XSCRPT_LETTER) &&
2657 d->d_name[1] == 'f' && d->d_name[2] == '\0'))
2658 syserr("gatherq: %s/%s is not a regular file",
2659 qid_printqueue(qgrp, qdir), d->d_name);
2664 /* avoid work if possible */
2665 if ((QueueSortOrder == QSO_BYFILENAME ||
2666 QueueSortOrder == QSO_BYMODTIME ||
2667 QueueSortOrder == QSO_NONE ||
2668 QueueSortOrder == QSO_RANDOM) &&
2669 QueueLimitQuarantine == NULL &&
2670 QueueLimitSender == NULL &&
2671 QueueLimitRecipient == NULL)
2675 w->w_name = newstr(d->d_name);
2677 w->w_lock = w->w_tooyoung = false;
2680 w->w_mtime = sbuf.st_mtime;
2685 /* open control file */
2686 cf = sm_io_open(SmFtStdio, SM_TIME_DEFAULT, qf, SM_IO_RDONLY_B,
2688 if (cf == NULL && OpMode != MD_PRINT)
2690 /* this may be some random person sending hir msgs */
2692 sm_dprintf("gatherq: cannot open %s: %s\n",
2693 d->d_name, sm_errstring(errno));
2700 w->w_name = newstr(d->d_name);
2704 w->w_lock = !lockfile(sm_io_getinfo(cf, SM_IO_WHAT_FD,
2709 w->w_tooyoung = false;
2711 /* make sure jobs in creation don't clog queue */
2712 w->w_pri = 0x7fffffff;
2714 w->w_mtime = sbuf.st_mtime;
2716 /* extract useful information */
2718 if (QueueSortOrder == QSO_BYHOST
2720 || QueueSortOrder == QSO_BYSHUFFLE
2721 #endif /* _FFR_RHS */
2724 /* need w_host set for host sort order */
2727 if (QueueLimitSender != NULL)
2729 if (QueueLimitRecipient != NULL)
2731 if (QueueLimitQuarantine != NULL)
2732 i |= NEED_QUARANTINE;
2733 while (cf != NULL && i != 0 &&
2734 sm_io_fgets(cf, SM_TIME_DEFAULT, lbuf,
2735 sizeof(lbuf)) != NULL)
2740 p = strchr(lbuf, '\n');
2745 /* flush rest of overly long line */
2746 while ((c = sm_io_getc(cf, SM_TIME_DEFAULT))
2747 != SM_IO_EOF && c != '\n')
2754 qfver = atoi(&lbuf[1]);
2758 w->w_pri = atol(&lbuf[1]);
2763 w->w_ctime = atol(&lbuf[1]);
2768 if (QueueMode != QM_QUARANTINE &&
2769 QueueMode != QM_LOST)
2772 sm_dprintf("%s not marked as quarantined but has a 'q' line\n",
2774 i |= HAS_QUARANTINE;
2776 else if (QueueMode == QM_QUARANTINE)
2778 if (QueueLimitQuarantine == NULL)
2780 i &= ~NEED_QUARANTINE;
2784 check = QueueLimitQuarantine;
2785 while (check != NULL)
2787 if (strcontainedin(false,
2790 check->queue_negate)
2793 check = check->queue_next;
2796 i &= ~NEED_QUARANTINE;
2801 if (w->w_host == NULL &&
2802 (p = strrchr(&lbuf[1], '@')) != NULL)
2805 if (QueueSortOrder == QSO_BYSHUFFLE)
2806 w->w_host = newstr(&p[1]);
2808 #endif /* _FFR_RHS */
2809 w->w_host = strrev(&p[1]);
2810 makelower(w->w_host);
2813 if (QueueLimitRecipient == NULL)
2820 p = strchr(&lbuf[1], ':');
2824 ++p; /* skip over ':' */
2828 check = QueueLimitRecipient;
2829 while (check != NULL)
2831 if (strcontainedin(true,
2834 check->queue_negate)
2837 check = check->queue_next;
2844 check = QueueLimitSender;
2845 while (check != NULL)
2847 if (strcontainedin(true,
2850 check->queue_negate)
2853 check = check->queue_next;
2861 if (MaxQueueAge > 0)
2863 time_t lasttry, delay;
2865 lasttry = (time_t) atol(&lbuf[1]);
2866 delay = MIN(lasttry - w->w_ctime,
2868 age = curtime() - lasttry;
2870 w->w_tooyoung = true;
2873 #endif /* _FFR_EXPDELAY */
2875 age = curtime() - (time_t) atol(&lbuf[1]);
2876 if (age >= 0 && MinQueueAge > 0 &&
2878 w->w_tooyoung = true;
2882 if (atol(&lbuf[1]) == 0)
2883 w->w_tooyoung = false;
2888 (void) sm_io_close(cf, SM_TIME_DEFAULT);
2890 if ((!doall && (shouldqueue(w->w_pri, w->w_ctime) ||
2892 bitset(HAS_QUARANTINE, i) ||
2893 bitset(NEED_QUARANTINE, i) ||
2894 bitset(NEED_R|NEED_S, i))
2896 /* don't even bother sorting this job in */
2898 sm_dprintf("skipping %s (%x)\n", w->w_name, i);
2899 sm_free(w->w_name); /* XXX */
2900 if (w->w_host != NULL)
2901 sm_free(w->w_host); /* XXX */
2910 i = wn - WorkListCount;
2911 WorkListCount += SM_MIN(num_ent, WorkListSize);
2914 *more = WorkListCount < wn;
2917 *full = (wn >= MaxQueueRun && MaxQueueRun > 0) ||
2918 (WorkList == NULL && wn > 0);
2920 if (pnentries != NULL)
2921 *pnentries = nentries;
2925 ** SORTQ -- sort the work list
2927 ** First the old WorkQ is cleared away. Then the WorkList is sorted
2928 ** for all items so that important (higher sorting value) items are not
2929 ** trunctated off. Then the most important items are moved from
2930 ** WorkList to WorkQ. The lower count of 'max' or MaxListCount items
2934 ** max -- maximum number of items to be placed in WorkQ
2937 ** the number of items in WorkQ
2940 ** WorkQ gets released and filled with new work. WorkList
2941 ** gets released. Work items get sorted in order.
2948 register int i; /* local counter */
2949 register WORK *w; /* tmp item pointer */
2950 int wc = WorkListCount; /* trim size for WorkQ */
2956 /* Clear out old WorkQ. */
2957 for (w = WorkQ; w != NULL; w = nw)
2960 sm_free(w->w_name); /* XXX */
2961 if (w->w_host != NULL)
2962 sm_free(w->w_host); /* XXX */
2963 sm_free((char *) w); /* XXX */
2968 if (WorkList == NULL || wc <= 0)
2972 ** The sort now takes place using all of the items in WorkList.
2973 ** The list gets trimmed to the most important items after the sort.
2974 ** If the trim were to happen before the sort then one or more
2975 ** important items might get truncated off -- not what we want.
2978 if (QueueSortOrder == QSO_BYHOST)
2981 ** Sort the work directory for the first time,
2982 ** based on host name, lock status, and priority.
2985 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf1);
2988 ** If one message to host is locked, "lock" all messages
2995 if (!WorkList[i].w_lock)
3003 if (WorkList[i].w_host == NULL &&
3005 WorkList[i].w_lock = true;
3006 else if (WorkList[i].w_host != NULL &&
3007 w->w_host != NULL &&
3008 sm_strcasecmp(WorkList[i].w_host,
3010 WorkList[i].w_lock = true;
3017 ** Sort the work directory for the second time,
3018 ** based on lock status, host name, and priority.
3021 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf2);
3023 else if (QueueSortOrder == QSO_BYTIME)
3026 ** Simple sort based on submission time only.
3029 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf3);
3031 else if (QueueSortOrder == QSO_BYFILENAME)
3034 ** Sort based on queue filename.
3037 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf4);
3039 else if (QueueSortOrder == QSO_RANDOM)
3042 ** Sort randomly. To avoid problems with an instable sort,
3043 ** use a random index into the queue file name to start
3047 randi = get_rand_mod(MAXQFNAME);
3050 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf5);
3052 else if (QueueSortOrder == QSO_BYMODTIME)
3055 ** Simple sort based on modification time of queue file.
3056 ** This puts the oldest items first.
3059 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf6);
3062 else if (QueueSortOrder == QSO_BYSHUFFLE)
3065 ** Simple sort based on shuffled host name.
3068 init_shuffle_alphabet();
3069 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf7);
3071 #endif /* _FFR_RHS */
3072 else if (QueueSortOrder == QSO_BYPRIORITY)
3075 ** Simple sort based on queue priority only.
3078 qsort((char *) WorkList, wc, sizeof(*WorkList), workcmpf0);
3080 /* else don't sort at all */
3082 /* Check if the per queue group item limit will be exceeded */
3083 if (wc > max && max > 0)
3087 ** Convert the work list into canonical form.
3088 ** Should be turning it into a list of envelopes here perhaps.
3089 ** Only take the most important items up to the per queue group
3093 for (i = wc; --i >= 0; )
3095 w = (WORK *) xalloc(sizeof(*w));
3096 w->w_qgrp = WorkList[i].w_qgrp;
3097 w->w_qdir = WorkList[i].w_qdir;
3098 w->w_name = WorkList[i].w_name;
3099 w->w_host = WorkList[i].w_host;
3100 w->w_lock = WorkList[i].w_lock;
3101 w->w_tooyoung = WorkList[i].w_tooyoung;
3102 w->w_pri = WorkList[i].w_pri;
3103 w->w_ctime = WorkList[i].w_ctime;
3104 w->w_mtime = WorkList[i].w_mtime;
3109 /* free the rest of the list */
3110 for (i = WorkListCount; --i >= wc; )
3112 sm_free(WorkList[i].w_name);
3113 if (WorkList[i].w_host != NULL)
3114 sm_free(WorkList[i].w_host);
3117 if (WorkList != NULL)
3118 sm_free(WorkList); /* XXX */
3125 for (w = WorkQ; w != NULL; w = w->w_next)
3127 if (w->w_host != NULL)
3128 sm_dprintf("%22s: pri=%ld %s\n",
3129 w->w_name, w->w_pri, w->w_host);
3131 sm_dprintf("%32s: pri=%ld\n",
3132 w->w_name, w->w_pri);
3136 return wc; /* return number of WorkQ items */
3139 ** GROW_WLIST -- make the work list larger
3142 ** qgrp -- the index for the queue group.
3143 ** qdir -- the index for the queue directory.
3149 ** Adds another QUEUESEGSIZE entries to WorkList if possible.
3150 ** It can fail if there isn't enough memory, so WorkListSize
3151 ** should be checked again upon return.
3155 grow_wlist(qgrp, qdir)
3160 sm_dprintf("grow_wlist: WorkListSize=%d\n", WorkListSize);
3161 if (WorkList == NULL)
3163 WorkList = (WORK *) xalloc((sizeof(*WorkList)) *
3164 (QUEUESEGSIZE + 1));
3165 WorkListSize = QUEUESEGSIZE;
3169 int newsize = WorkListSize + QUEUESEGSIZE;
3170 WORK *newlist = (WORK *) sm_realloc((char *) WorkList,
3171 (unsigned) sizeof(WORK) * (newsize + 1));
3173 if (newlist != NULL)
3175 WorkListSize = newsize;
3179 sm_syslog(LOG_INFO, NOQID,
3180 "grew WorkList for %s to %d",
3181 qid_printqueue(qgrp, qdir),
3185 else if (LogLevel > 0)
3187 sm_syslog(LOG_ALERT, NOQID,
3188 "FAILED to grow WorkList for %s to %d",
3189 qid_printqueue(qgrp, qdir), newsize);
3193 sm_dprintf("grow_wlist: WorkListSize now %d\n", WorkListSize);
3196 ** WORKCMPF0 -- simple priority-only compare function.
3199 ** a -- the first argument.
3200 ** b -- the second argument.
3225 ** WORKCMPF1 -- first compare function for ordering work based on host name.
3227 ** Sorts on host name, lock status, and priority in that order.
3230 ** a -- the first argument.
3231 ** b -- the second argument.
3248 if (a->w_host != NULL && b->w_host == NULL)
3250 else if (a->w_host == NULL && b->w_host != NULL)
3252 if (a->w_host != NULL && b->w_host != NULL &&
3253 (i = sm_strcasecmp(a->w_host, b->w_host)) != 0)
3257 if (a->w_lock != b->w_lock)
3258 return b->w_lock - a->w_lock;
3261 return workcmpf0(a, b);
3264 ** WORKCMPF2 -- second compare function for ordering work based on host name.
3266 ** Sorts on lock status, host name, and priority in that order.
3269 ** a -- the first argument.
3270 ** b -- the second argument.
3287 if (a->w_lock != b->w_lock)
3288 return a->w_lock - b->w_lock;
3291 if (a->w_host != NULL && b->w_host == NULL)
3293 else if (a->w_host == NULL && b->w_host != NULL)
3295 if (a->w_host != NULL && b->w_host != NULL &&
3296 (i = sm_strcasecmp(a->w_host, b->w_host)) != 0)
3300 return workcmpf0(a, b);
3303 ** WORKCMPF3 -- simple submission-time-only compare function.
3306 ** a -- the first argument.
3307 ** b -- the second argument.
3321 if (a->w_ctime > b->w_ctime)
3323 else if (a->w_ctime < b->w_ctime)
3329 ** WORKCMPF4 -- compare based on file name
3332 ** a -- the first argument.
3333 ** b -- the second argument.
3347 return strcmp(a->w_name, b->w_name);
3350 ** WORKCMPF5 -- compare based on assigned random number
3353 ** a -- the first argument.
3354 ** b -- the second argument.
3366 if (strlen(a->w_name) < randi || strlen(b->w_name) < randi)
3368 return a->w_name[randi] - b->w_name[randi];
3371 ** WORKCMPF6 -- simple modification-time-only compare function.
3374 ** a -- the first argument.
3375 ** b -- the second argument.
3389 if (a->w_mtime > b->w_mtime)
3391 else if (a->w_mtime < b->w_mtime)
3398 ** WORKCMPF7 -- compare function for ordering work based on shuffled host name.
3400 ** Sorts on lock status, host name, and priority in that order.
3403 ** a -- the first argument.
3404 ** b -- the second argument.
3421 if (a->w_lock != b->w_lock)
3422 return a->w_lock - b->w_lock;
3425 if (a->w_host != NULL && b->w_host == NULL)
3427 else if (a->w_host == NULL && b->w_host != NULL)
3429 if (a->w_host != NULL && b->w_host != NULL &&
3430 (i = sm_strshufflecmp(a->w_host, b->w_host)) != 0)
3434 return workcmpf0(a, b);
3436 #endif /* _FFR_RHS */
3438 ** STRREV -- reverse string
3440 ** Returns a pointer to a new string that is the reverse of
3441 ** the string pointed to by fwd. The space for the new
3442 ** string is obtained using xalloc().
3445 ** fwd -- the string to reverse.
3448 ** the reversed string.
3459 rev = xalloc(len + 1);
3460 for (cnt = 0; cnt < len; ++cnt)
3461 rev[cnt] = fwd[len - cnt - 1];
3471 static unsigned char ShuffledAlphabet[NCHAR];
3474 init_shuffle_alphabet()
3476 static bool init = false;
3482 /* fill the ShuffledAlphabet */
3483 for (i = 0; i < NASCII; i++)
3484 ShuffledAlphabet[i] = i;
3487 for (i = 1; i < NASCII; i++)
3489 register int j = get_random() % NASCII;
3492 tmp = ShuffledAlphabet[j];
3493 ShuffledAlphabet[j] = ShuffledAlphabet[i];
3494 ShuffledAlphabet[i] = tmp;
3497 /* make it case insensitive */
3498 for (i = 'A'; i <= 'Z'; i++)
3499 ShuffledAlphabet[i] = ShuffledAlphabet[i + 'a' - 'A'];
3501 /* fill the upper part */
3502 for (i = 0; i < NASCII; i++)
3503 ShuffledAlphabet[i + NASCII] = ShuffledAlphabet[i];
3508 sm_strshufflecmp(a, b)
3512 const unsigned char *us1 = (const unsigned char *) a;
3513 const unsigned char *us2 = (const unsigned char *) b;
3515 while (ShuffledAlphabet[*us1] == ShuffledAlphabet[*us2++])
3520 return (ShuffledAlphabet[*us1] - ShuffledAlphabet[*--us2]);
3522 #endif /* _FFR_RHS */
3525 ** DOWORK -- do a work request.
3528 ** qgrp -- the index of the queue group for the job.
3529 ** qdir -- the index of the queue directory for the job.
3530 ** id -- the ID of the job to run.
3531 ** forkflag -- if set, run this in background.
3532 ** requeueflag -- if set, reinstantiate the queue quickly.
3533 ** This is used when expanding aliases in the queue.
3534 ** If forkflag is also set, it doesn't wait for the
3536 ** e - the envelope in which to run it.
3539 ** process id of process that is running the queue job.
3542 ** The work request is satisfied if possible.
3546 dowork(qgrp, qdir, id, forkflag, requeueflag, e)
3552 register ENVELOPE *e;
3558 sm_dprintf("dowork(%s/%s)\n", qid_printqueue(qgrp, qdir), id);
3567 ** Since the delivery may happen in a child and the
3568 ** parent does not wait, the parent may close the
3569 ** maps thereby removing any shared memory used by
3570 ** the map. Therefore, close the maps now so the
3571 ** child will dynamically open them if necessary.
3579 syserr("dowork: cannot fork");
3584 /* parent -- clean out connection cache */
3585 mci_flush(false, NULL);
3590 ** Initialize exception stack and default exception
3591 ** handler for child process.
3594 /* Reset global flags */
3595 RestartRequest = NULL;
3596 RestartWorkGroup = false;
3597 ShutdownRequest = NULL;
3599 CurrentPid = getpid();
3600 sm_exc_newthread(fatal_error);
3603 ** See note above about SMTP processes and SIGCHLD.
3606 if (OpMode == MD_SMTP ||
3607 OpMode == MD_DAEMON ||
3608 MaxQueueChildren > 0)
3611 sm_releasesignal(SIGCHLD);
3612 (void) sm_signal(SIGCHLD, SIG_DFL);
3615 /* child -- error messages to the transcript */
3616 QuickAbort = OnlyOneError = false;
3628 ** Lock the control file to avoid duplicate deliveries.
3629 ** Then run the file as though we had just read it.
3630 ** We save an idea of the temporary name so we
3631 ** can recover on interrupt.
3636 /* Reset global flags */
3637 RestartRequest = NULL;
3638 RestartWorkGroup = false;
3639 ShutdownRequest = NULL;
3643 /* set basic modes, etc. */
3646 rpool = sm_rpool_new_x(NULL);
3647 clearenvelope(e, false, rpool);
3648 e->e_flags |= EF_QUEUERUN|EF_GLOBALERRS;
3649 set_delivery_mode(SM_DELIVER, e);
3650 e->e_errormode = EM_MAIL;
3654 GrabTo = UseErrorsTo = false;
3659 set_op_mode(MD_QUEUERUN);
3661 sm_setproctitle(true, e, "%s from queue", qid_printname(e));
3663 sm_syslog(LOG_DEBUG, e->e_id, "dowork, pid=%d",
3666 /* don't use the headers from sendmail.cf... */
3669 /* read the queue control file -- return if locked */
3670 if (!readqf(e, false))
3672 if (tTd(40, 4) && e->e_id != NULL)
3673 sm_dprintf("readqf(%s) failed\n",
3677 finis(false, true, EX_OK);
3680 /* adding this frees 8 bytes */
3681 clearenvelope(e, false, rpool);
3683 /* adding this frees 12 bytes */
3684 sm_rpool_free(rpool);
3690 e->e_flags |= EF_INQUEUE;
3691 eatheader(e, requeueflag, true);
3694 queueup(e, false, false);
3696 /* do the delivery */
3697 sendall(e, SM_DELIVER);
3699 /* finish up and exit */
3701 finis(true, true, ExitStat);
3704 (void) dropenvelope(e, true, false);
3705 sm_rpool_free(rpool);
3714 ** DOWORKLIST -- process a list of envelopes as work requests
3716 ** Similar to dowork(), except that after forking, it processes an
3717 ** envelope and its siblings, treating each envelope as a work request.
3720 ** el -- envelope to be processed including its siblings.
3721 ** forkflag -- if set, run this in background.
3722 ** requeueflag -- if set, reinstantiate the queue quickly.
3723 ** This is used when expanding aliases in the queue.
3724 ** If forkflag is also set, it doesn't wait for the
3728 ** process id of process that is running the queue job.
3731 ** The work request is satisfied if possible.
3735 doworklist(el, forkflag, requeueflag)
3744 sm_dprintf("doworklist()\n");
3753 ** Since the delivery may happen in a child and the
3754 ** parent does not wait, the parent may close the
3755 ** maps thereby removing any shared memory used by
3756 ** the map. Therefore, close the maps now so the
3757 ** child will dynamically open them if necessary.
3765 syserr("doworklist: cannot fork");
3770 /* parent -- clean out connection cache */
3771 mci_flush(false, NULL);
3776 ** Initialize exception stack and default exception
3777 ** handler for child process.
3780 /* Reset global flags */
3781 RestartRequest = NULL;
3782 RestartWorkGroup = false;
3783 ShutdownRequest = NULL;
3785 CurrentPid = getpid();
3786 sm_exc_newthread(fatal_error);
3789 ** See note above about SMTP processes and SIGCHLD.
3792 if (OpMode == MD_SMTP ||
3793 OpMode == MD_DAEMON ||
3794 MaxQueueChildren > 0)
3797 sm_releasesignal(SIGCHLD);
3798 (void) sm_signal(SIGCHLD, SIG_DFL);
3801 /* child -- error messages to the transcript */
3802 QuickAbort = OnlyOneError = false;
3815 ** Lock the control file to avoid duplicate deliveries.
3816 ** Then run the file as though we had just read it.
3817 ** We save an idea of the temporary name so we
3818 ** can recover on interrupt.
3823 /* Reset global flags */
3824 RestartRequest = NULL;
3825 RestartWorkGroup = false;
3826 ShutdownRequest = NULL;
3830 /* set basic modes, etc. */
3833 GrabTo = UseErrorsTo = false;
3838 set_op_mode(MD_QUEUERUN);
3841 sm_syslog(LOG_DEBUG, el->e_id, "doworklist, pid=%d",
3844 for (ei = el; ei != NULL; ei = ei->e_sibling)
3849 if (WILL_BE_QUEUED(ei->e_sendmode))
3851 else if (QueueMode != QM_QUARANTINE &&
3852 ei->e_quarmsg != NULL)
3855 rpool = sm_rpool_new_x(NULL);
3856 clearenvelope(&e, true, rpool);
3857 e.e_flags |= EF_QUEUERUN|EF_GLOBALERRS;
3858 set_delivery_mode(SM_DELIVER, &e);
3859 e.e_errormode = EM_MAIL;
3861 e.e_qgrp = ei->e_qgrp;
3862 e.e_qdir = ei->e_qdir;
3864 sm_setproctitle(true, &e, "%s from queue", qid_printname(&e));
3866 /* don't use the headers from sendmail.cf... */
3870 /* read the queue control file -- return if locked */
3871 if (readqf(&e, false))
3873 e.e_flags |= EF_INQUEUE;
3874 eatheader(&e, requeueflag, true);
3877 queueup(&e, false, false);
3879 /* do the delivery */
3880 sendall(&e, SM_DELIVER);
3881 (void) dropenvelope(&e, true, false);
3885 if (tTd(40, 4) && e.e_id != NULL)
3886 sm_dprintf("readqf(%s) failed\n",
3889 sm_rpool_free(rpool);
3893 /* restore CurEnv */
3896 /* finish up and exit */
3898 finis(true, true, ExitStat);
3902 ** READQF -- read queue file and set up environment.
3905 ** e -- the envelope of the job to run.
3906 ** openonly -- only open the qf (returned as e_lockfp)
3909 ** true if it successfully read the queue file.
3913 ** The queue file is returned locked.
3918 register ENVELOPE *e;
3921 register SM_FILE_T *qfp;
3923 struct stat st, stf;
3930 bool nomore = false;
3934 char qf[MAXPATHLEN];
3939 ** Read and process the file.
3942 SM_REQUIRE(e != NULL);
3944 (void) sm_strlcpy(qf, queuename(e, ANYQFL_LETTER), sizeof(qf));
3945 qfp = sm_io_open(SmFtStdio, SM_TIME_DEFAULT, qf, SM_IO_RDWR_B, NULL);
3948 int save_errno = errno;
3951 sm_dprintf("readqf(%s): sm_io_open failure (%s)\n",
3952 qf, sm_errstring(errno));
3956 syserr("readqf: no control file %s", qf);
3961 if (!lockfile(sm_io_getinfo(qfp, SM_IO_WHAT_FD, NULL), qf, NULL,
3964 /* being processed by another queuer */
3966 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
3967 "%s: locked\n", e->e_id);
3969 sm_dprintf("%s: locked\n", e->e_id);
3971 sm_syslog(LOG_DEBUG, e->e_id, "locked");
3972 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
3980 ** Prevent locking race condition.
3982 ** Process A: readqf(): qfp = fopen(qffile)
3983 ** Process B: queueup(): rename(tf, qf)
3984 ** Process B: unlocks(tf)
3985 ** Process A: lockfile(qf);
3987 ** Process A (us) has the old qf file (before the rename deleted
3988 ** the directory entry) and will be delivering based on old data.
3989 ** This can lead to multiple deliveries of the same recipients.
3991 ** Catch this by checking if the underlying qf file has changed
3992 ** *after* acquiring our lock and if so, act as though the file
3993 ** was still locked (i.e., just return like the lockfile() case
3997 if (stat(qf, &stf) < 0 ||
3998 fstat(sm_io_getinfo(qfp, SM_IO_WHAT_FD, NULL), &st) < 0)
4000 /* must have been being processed by someone else */
4002 sm_dprintf("readqf(%s): [f]stat failure (%s)\n",
4003 qf, sm_errstring(errno));
4004 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4008 if (st.st_nlink != stf.st_nlink ||
4009 st.st_dev != stf.st_dev ||
4010 ST_INODE(st) != ST_INODE(stf) ||
4011 #if HAS_ST_GEN && 0 /* AFS returns garbage in st_gen */
4012 st.st_gen != stf.st_gen ||
4013 #endif /* HAS_ST_GEN && 0 */
4014 st.st_uid != stf.st_uid ||
4015 st.st_gid != stf.st_gid ||
4016 st.st_size != stf.st_size)
4018 /* changed after opened */
4020 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4021 "%s: changed\n", e->e_id);
4023 sm_dprintf("%s: changed\n", e->e_id);
4025 sm_syslog(LOG_DEBUG, e->e_id, "changed");
4026 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4031 ** Check the queue file for plausibility to avoid attacks.
4034 qsafe = S_IWOTH|S_IWGRP;
4035 if (bitset(S_IWGRP, QueueFileMode))
4038 bogus = st.st_uid != geteuid() &&
4039 st.st_uid != TrustedUid &&
4040 geteuid() != RealUid;
4043 ** If this qf file results from a set-group-ID binary, then
4044 ** we check whether the directory is group-writable,
4045 ** the queue file mode contains the group-writable bit, and
4046 ** the groups are the same.
4047 ** Notice: this requires that the set-group-ID binary is used to
4051 if (bogus && st.st_gid == getegid() && UseMSP)
4056 bp = SM_LAST_DIR_DELIM(qf);
4064 if (stat(delim == '\0' ? "." : qf, &dst) < 0)
4065 syserr("readqf: cannot stat directory %s",
4066 delim == '\0' ? "." : qf);
4069 bogus = !(bitset(S_IWGRP, QueueFileMode) &&
4070 bitset(S_IWGRP, dst.st_mode) &&
4071 dst.st_gid == st.st_gid);
4078 bogus = bitset(qsafe, st.st_mode);
4083 sm_syslog(LOG_ALERT, e->e_id,
4084 "bogus queue file, uid=%d, gid=%d, mode=%o",
4085 st.st_uid, st.st_gid, st.st_mode);
4088 sm_dprintf("readqf(%s): bogus file\n", qf);
4089 e->e_flags |= EF_INQUEUE;
4091 loseqfile(e, "bogus file uid/gid in mqueue");
4092 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4096 if (st.st_size == 0)
4098 /* must be a bogus file -- if also old, just remove it */
4099 if (!openonly && st.st_ctime + 10 * 60 < curtime())
4101 (void) xunlink(queuename(e, DATAFL_LETTER));
4102 (void) xunlink(queuename(e, ANYQFL_LETTER));
4104 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4108 if (st.st_nlink == 0)
4111 ** Race condition -- we got a file just as it was being
4112 ** unlinked. Just assume it is zero length.
4115 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4121 ** If we don't own the file mark it as unsafe.
4122 ** However, allow TrustedUser to own it as well
4123 ** in case TrustedUser manipulates the queue.
4126 if (st.st_uid != geteuid() && st.st_uid != TrustedUid)
4127 e->e_flags |= EF_UNSAFE;
4128 #else /* _FFR_TRUSTED_QF */
4129 /* If we don't own the file mark it as unsafe */
4130 if (st.st_uid != geteuid())
4131 e->e_flags |= EF_UNSAFE;
4132 #endif /* _FFR_TRUSTED_QF */
4134 /* good file -- save this lock */
4137 /* Just wanted the open file */
4141 /* do basic system initialization */
4143 macdefine(&e->e_macro, A_PERM, 'i', e->e_id);
4146 e->e_flags |= EF_GLOBALERRS;
4147 set_op_mode(MD_QUEUERUN);
4149 e->e_qfletter = queue_letter(e, ANYQFL_LETTER);
4150 e->e_dfqgrp = e->e_qgrp;
4151 e->e_dfqdir = e->e_qdir;
4152 #if _FFR_QUEUE_MACRO
4153 macdefine(&e->e_macro, A_TEMP, macid("{queue}"),
4154 qid_printqueue(e->e_qgrp, e->e_qdir));
4155 #endif /* _FFR_QUEUE_MACRO */
4158 while (bufsize = sizeof(buf),
4159 (bp = fgetfolded(buf, &bufsize, qfp)) != NULL)
4161 unsigned long qflags;
4168 sm_dprintf("+++++ %s\n", bp);
4173 syserr("SECURITY ALERT: extra or bogus data in queue file: %s",
4175 err = "bogus queue line";
4180 case 'A': /* AUTH= parameter */
4181 if (!xtextok(&bp[1]))
4183 e->e_auth_param = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4186 case 'B': /* body type */
4187 r = check_bodytype(&bp[1]);
4188 if (!BODYTYPE_VALID(r))
4190 e->e_bodytype = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4193 case 'C': /* specify controlling user */
4194 ctladdr = setctluser(&bp[1], qfver, e);
4197 case 'D': /* data file name */
4198 /* obsolete -- ignore */
4201 case 'd': /* data file directory name */
4205 #if _FFR_MSP_PARANOIA
4206 /* forbid queue groups in MSP? */
4209 #endif /* _FFR_MSP_PARANOIA */
4211 qgrp < NumQueue && Queue[qgrp] != NULL;
4215 qdir < Queue[qgrp]->qg_numqueues;
4219 Queue[qgrp]->qg_qpaths[qdir].qp_name)
4228 err = "bogus queue file directory";
4234 case 'E': /* specify error recipient */
4235 /* no longer used */
4238 case 'F': /* flag bits */
4239 if (strncmp(bp, "From ", 5) == 0)
4241 /* we are being spoofed! */
4242 syserr("SECURITY ALERT: bogus qf line %s", bp);
4243 err = "bogus queue line";
4246 for (p = &bp[1]; *p != '\0'; p++)
4250 case '8': /* has 8 bit data */
4251 e->e_flags |= EF_HAS8BIT;
4254 case 'b': /* delete Bcc: header */
4255 e->e_flags |= EF_DELETE_BCC;
4258 case 'd': /* envelope has DSN RET= */
4259 e->e_flags |= EF_RET_PARAM;
4262 case 'n': /* don't return body */
4263 e->e_flags |= EF_NO_BODY_RETN;
4266 case 'r': /* response */
4267 e->e_flags |= EF_RESPONSE;
4270 case 's': /* split */
4271 e->e_flags |= EF_SPLIT;
4274 case 'w': /* warning sent */
4275 e->e_flags |= EF_WARNING;
4281 case 'q': /* quarantine reason */
4282 e->e_quarmsg = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4283 macdefine(&e->e_macro, A_PERM,
4284 macid("{quarantine}"), e->e_quarmsg);
4287 case 'H': /* header */
4290 ** count size before chompheader() destroys the line.
4291 ** this isn't accurate due to macro expansion, but
4292 ** better than before. "-3" to skip H?? at least.
4295 hdrsize += strlen(bp) - 3;
4296 (void) chompheader(&bp[1], CHHDR_QUEUE, NULL, e);
4299 case 'I': /* data file's inode number */
4300 /* regenerated below */
4303 case 'K': /* time of last delivery attempt */
4304 e->e_dtime = atol(&buf[1]);
4307 case 'L': /* Solaris Content-Length: */
4308 case 'M': /* message */
4309 /* ignore this; we want a new message next time */
4312 case 'N': /* number of delivery attempts */
4313 e->e_ntries = atoi(&buf[1]);
4315 /* if this has been tried recently, let it be */
4317 if (e->e_ntries > 0 && e->e_dtime <= now &&
4318 now < e->e_dtime + MinQueueAge)
4322 howlong = pintvl(now - e->e_dtime, true);
4324 (void) sm_io_fprintf(smioout,
4326 "%s: too young (%s)\n",
4329 sm_dprintf("%s: too young (%s)\n",
4332 sm_syslog(LOG_DEBUG, e->e_id,
4341 macdefine(&e->e_macro, A_TEMP,
4342 macid("{ntries}"), &buf[1]);
4345 /* adjust BIND parameters immediately */
4346 if (e->e_ntries == 0)
4348 _res.retry = TimeOuts.res_retry[RES_TO_FIRST];
4349 _res.retrans = TimeOuts.res_retrans[RES_TO_FIRST];
4353 _res.retry = TimeOuts.res_retry[RES_TO_NORMAL];
4354 _res.retrans = TimeOuts.res_retrans[RES_TO_NORMAL];
4356 #endif /* NAMED_BIND */
4359 case 'P': /* message priority */
4360 e->e_msgpriority = atol(&bp[1]) + WkTimeFact;
4363 case 'Q': /* original recipient */
4364 orcpt = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4367 case 'r': /* final recipient */
4368 frcpt = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4371 case 'R': /* specify recipient */
4377 while (*++p != '\0' && *p != ':')
4382 qflags |= QHASNOTIFY;
4386 qflags |= QPINGONSUCCESS;
4390 qflags |= QPINGONFAILURE;
4394 qflags |= QPINGONDELAY;
4402 if (ctladdr != NULL)
4403 ctladdr->q_flags |= QALIAS;
4406 default: /* ignore or complain? */
4413 macdefine(&e->e_macro, A_PERM, macid("{addr_type}"),
4416 q = parseaddr(++p, NULLADDR, RF_COPYALL, '\0',
4422 /* make sure we keep the current qgrp */
4423 if (ISVALIDQGRP(e->e_qgrp))
4424 q->q_qgrp = e->e_qgrp;
4425 q->q_alias = ctladdr;
4427 q->q_flags &= ~Q_PINGFLAGS;
4428 q->q_flags |= qflags;
4429 q->q_finalrcpt = frcpt;
4431 (void) recipient(q, &e->e_sendqueue, 0, e);
4435 macdefine(&e->e_macro, A_PERM, macid("{addr_type}"),
4439 case 'S': /* sender */
4440 setsender(sm_rpool_strdup_x(e->e_rpool, &bp[1]),
4441 e, NULL, '\0', true);
4444 case 'T': /* init time */
4445 e->e_ctime = atol(&bp[1]);
4448 case 'V': /* queue file version number */
4449 qfver = atoi(&bp[1]);
4450 if (qfver <= QF_VERSION)
4452 syserr("Version number in queue file (%d) greater than max (%d)",
4454 err = "unsupported queue file version";
4459 case 'Z': /* original envelope id from ESMTP */
4460 e->e_envid = sm_rpool_strdup_x(e->e_rpool, &bp[1]);
4461 macdefine(&e->e_macro, A_PERM,
4462 macid("{dsn_envid}"), e->e_envid);
4465 case '!': /* deliver by */
4467 /* format: flag (1 char) space long-integer */
4468 e->e_dlvr_flag = buf[1];
4469 e->e_deliver_by = strtol(&buf[3], NULL, 10);
4471 case '$': /* define macro */
4475 /* XXX elimate p? */
4476 r = macid_parse(&bp[1], &ep);
4479 p = sm_rpool_strdup_x(e->e_rpool, ep);
4480 macdefine(&e->e_macro, A_PERM, r, p);
4484 case '.': /* terminate file */
4493 ** Maintain backward compatibility for
4494 ** users who defined _FFR_QUEUEDELAY in
4495 ** previous releases. Remove this
4496 ** code in 8.14 or 8.15.
4499 if (qfver == 5 || qfver == 7)
4502 /* If not qfver 5 or 7, then 'G' or 'Y' is invalid */
4504 #endif /* _FFR_QUEUEDELAY */
4507 syserr("readqf: %s: line %d: bad line \"%s\"",
4508 qf, LineNumber, shortenstring(bp, MAXSHORTSTR));
4509 err = "unrecognized line";
4518 ** If we haven't read any lines, this queue file is empty.
4519 ** Arrange to remove it without referencing any null pointers.
4522 if (LineNumber == 0)
4525 e->e_flags |= EF_CLRQUEUE|EF_FATALERRS|EF_RESPONSE;
4529 /* Check to make sure we have a complete queue file read */
4532 syserr("readqf: %s: incomplete queue file read", qf);
4533 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4537 #if _FFR_QF_PARANOIA
4538 /* Check to make sure key fields were read */
4539 if (e->e_from.q_mailer == NULL)
4541 syserr("readqf: %s: sender not specified in queue file", qf);
4542 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4546 #endif /* _FFR_QF_PARANOIA */
4548 /* possibly set ${dsn_ret} macro */
4549 if (bitset(EF_RET_PARAM, e->e_flags))
4551 if (bitset(EF_NO_BODY_RETN, e->e_flags))
4552 macdefine(&e->e_macro, A_PERM,
4553 macid("{dsn_ret}"), "hdrs");
4555 macdefine(&e->e_macro, A_PERM,
4556 macid("{dsn_ret}"), "full");
4560 ** Arrange to read the data file.
4563 p = queuename(e, DATAFL_LETTER);
4564 e->e_dfp = sm_io_open(SmFtStdio, SM_TIME_DEFAULT, p, SM_IO_RDONLY_B,
4566 if (e->e_dfp == NULL)
4568 syserr("readqf: cannot open %s", p);
4572 e->e_flags |= EF_HAS_DF;
4573 if (fstat(sm_io_getinfo(e->e_dfp, SM_IO_WHAT_FD, NULL), &st)
4576 e->e_msgsize = st.st_size + hdrsize;
4577 e->e_dfdev = st.st_dev;
4578 e->e_dfino = ST_INODE(st);
4579 (void) sm_snprintf(buf, sizeof(buf), "%ld",
4581 macdefine(&e->e_macro, A_TEMP, macid("{msg_size}"),
4590 ** There was some error reading the qf file (reason is in err var.)
4592 ** close file; clear e_lockfp since it is the same as qfp,
4593 ** hence it is invalid (as file) after qfp is closed;
4594 ** the qf file is on disk, so set the flag to avoid calling
4595 ** queueup() with bogus data.
4601 (void) sm_io_close(qfp, SM_TIME_DEFAULT);
4603 e->e_flags |= EF_INQUEUE;
4608 ** PRTSTR -- print a string, "unprintable" characters are shown as \oct
4611 ** s -- string to print
4612 ** ml -- maximum length of output
4615 ** number of entries
4618 ** Prints a string on stdout.
4621 static void prtstr __P((char *, int));
4632 while (ml-- > 0 && ((c = *s++) != '\0'))
4638 (void) sm_io_putc(smioout, SM_TIME_DEFAULT, c);
4639 (void) sm_io_putc(smioout, SM_TIME_DEFAULT, c);
4642 else if (isascii(c) && isprint(c))
4643 (void) sm_io_putc(smioout, SM_TIME_DEFAULT, c);
4647 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4648 "\\%03o", c & 0xFF);
4653 ** PRINTNQE -- print out number of entries in the mail queue
4656 ** out -- output file pointer.
4657 ** prefix -- string to output in front of each line.
4664 printnqe(out, prefix)
4669 int i, k = 0, nrequests = 0;
4670 bool unknown = false;
4672 if (ShmId == SM_SHM_NO_ID)
4675 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4676 "Data unavailable: shared memory not updated\n");
4678 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4679 "%sNOTCONFIGURED:-1\r\n", prefix);
4682 for (i = 0; i < NumQueue && Queue[i] != NULL; i++)
4687 for (j = 0; j < Queue[i]->qg_numqueues; j++)
4694 n = QSHM_ENTRIES(Queue[i]->qg_qpaths[j].qp_idx);
4696 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4698 prefix, qid_printqueue(i, j), n);
4701 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4702 "%s: unknown number of entries\n",
4703 qid_printqueue(i, j));
4708 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4710 qid_printqueue(i, j));
4714 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4716 qid_printqueue(i, j), n);
4722 if (prefix == NULL && k > 1)
4723 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4724 "\t\tTotal requests: %d%s\n",
4725 nrequests, unknown ? " (about)" : "");
4726 #else /* SM_CONF_SHM */
4728 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4729 "Data unavailable without shared memory support\n");
4731 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
4732 "%sNOTAVAILABLE:-1\r\n", prefix);
4733 #endif /* SM_CONF_SHM */
4736 ** PRINTQUEUE -- print out a representation of the mail queue
4745 ** Prints a listing of the mail queue on the standard output.
4751 int i, k = 0, nrequests = 0;
4753 for (i = 0; i < NumQueue && Queue[i] != NULL; i++)
4758 for (j = 0; j < Queue[i]->qg_numqueues; j++)
4762 nrequests += print_single_queue(i, j);
4767 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4768 "\t\tTotal requests: %d\n",
4772 ** PRINT_SINGLE_QUEUE -- print out a representation of a single mail queue
4775 ** qgrp -- the index of the queue group.
4776 ** qdir -- the queue directory.
4779 ** number of requests in mail queue.
4782 ** Prints a listing of the mail queue on the standard output.
4786 print_single_queue(qgrp, qdir)
4793 char qd[MAXPATHLEN];
4794 char qddf[MAXPATHLEN];
4799 (void) sm_strlcpy(qd, ".", sizeof(qd));
4800 (void) sm_strlcpy(qddf, ".", sizeof(qddf));
4804 (void) sm_strlcpyn(qd, sizeof(qd), 2,
4805 Queue[qgrp]->qg_qpaths[qdir].qp_name,
4807 Queue[qgrp]->qg_qpaths[qdir].qp_subdirs)
4809 (void) sm_strlcpyn(qddf, sizeof(qddf), 2,
4810 Queue[qgrp]->qg_qpaths[qdir].qp_name,
4812 Queue[qgrp]->qg_qpaths[qdir].qp_subdirs)
4817 ** Check for permission to print the queue
4820 if (bitset(PRIV_RESTRICTMAILQ, PrivacyFlags) && RealUid != 0)
4825 extern GIDSET_T InitialGidSet[NGROUPS_MAX];
4826 #endif /* NGROUPS_MAX */
4828 if (stat(qd, &st) < 0)
4830 syserr("Cannot stat %s",
4831 qid_printqueue(qgrp, qdir));
4838 if (InitialGidSet[n] == st.st_gid)
4841 if (n < 0 && RealGid != st.st_gid)
4842 #else /* NGROUPS_MAX */
4843 if (RealGid != st.st_gid)
4844 #endif /* NGROUPS_MAX */
4846 usrerr("510 You are not permitted to see the queue");
4853 ** Read and order the queue.
4856 nrequests = gatherq(qgrp, qdir, true, NULL, NULL, NULL);
4857 (void) sortq(Queue[qgrp]->qg_maxlist);
4860 ** Print the work list that we have read.
4863 /* first see if there is anything */
4866 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%s is empty\n",
4867 qid_printqueue(qgrp, qdir));
4871 sm_getla(); /* get load average */
4873 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "\t\t%s (%d request%s",
4874 qid_printqueue(qgrp, qdir),
4875 nrequests, nrequests == 1 ? "" : "s");
4876 if (MaxQueueRun > 0 && nrequests > MaxQueueRun)
4877 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4878 ", only %d printed", MaxQueueRun);
4880 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4881 ")\n-----Q-ID----- --Size-- -Priority- ---Q-Time--- --------Sender/Recipient--------\n");
4883 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4884 ")\n-----Q-ID----- --Size-- -----Q-Time----- ------------Sender/Recipient-----------\n");
4885 for (w = WorkQ; w != NULL; w = w->w_next)
4888 auto time_t submittime = 0;
4892 char quarmsg[MAXLINE];
4893 char statmsg[MAXLINE];
4894 char bodytype[MAXNAME + 1];
4895 char qf[MAXPATHLEN];
4900 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%13s",
4902 (void) sm_strlcpyn(qf, sizeof(qf), 3, qd, "/", w->w_name);
4903 f = sm_io_open(SmFtStdio, SM_TIME_DEFAULT, qf, SM_IO_RDONLY_B,
4908 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4909 " (permission denied)\n");
4910 else if (errno == ENOENT)
4911 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4912 " (job completed)\n");
4914 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
4916 sm_errstring(errno));
4920 w->w_name[0] = DATAFL_LETTER;
4921 (void) sm_strlcpyn(qf, sizeof(qf), 3, qddf, "/", w->w_name);
4922 if (stat(qf, &st) >= 0)
4923 dfsize = st.st_size;
4929 ** Maybe the df file can't be statted because
4930 ** it is in a different directory than the qf file.
4931 ** In order to find out, we must read the qf file.
4934 newenvelope(&e, &BlankEnvelope, sm_rpool_new_x(NULL));
4935 e.e_id = w->w_name + 2;
4939 if (readqf(&e, false))
4941 char *df = queuename(&e, DATAFL_LETTER);
4942 if (stat(df, &st) >= 0)
4943 dfsize = st.st_size;
4945 if (e.e_lockfp != NULL)
4947 (void) sm_io_close(e.e_lockfp, SM_TIME_DEFAULT);
4950 clearenvelope(&e, false, e.e_rpool);
4951 sm_rpool_free(e.e_rpool);
4954 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "*");
4955 else if (QueueMode == QM_LOST)
4956 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "?");
4957 else if (w->w_tooyoung)
4958 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "-");
4959 else if (shouldqueue(w->w_pri, w->w_ctime))
4960 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "X");
4962 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, " ");
4967 statmsg[0] = bodytype[0] = '\0';
4969 while (sm_io_fgets(f, SM_TIME_DEFAULT, buf, sizeof(buf)) != NULL)
4980 case 'V': /* queue file version */
4981 qfver = atoi(&buf[1]);
4984 case 'M': /* error message */
4985 if ((i = strlen(&buf[1])) >= sizeof(statmsg))
4986 i = sizeof(statmsg) - 1;
4987 memmove(statmsg, &buf[1], i);
4991 case 'q': /* quarantine reason */
4992 if ((i = strlen(&buf[1])) >= sizeof(quarmsg))
4993 i = sizeof(quarmsg) - 1;
4994 memmove(quarmsg, &buf[1], i);
4998 case 'B': /* body type */
4999 if ((i = strlen(&buf[1])) >= sizeof(bodytype))
5000 i = sizeof(bodytype) - 1;
5001 memmove(bodytype, &buf[1], i);
5005 case 'S': /* sender name */
5008 (void) sm_io_fprintf(smioout,
5010 "%8ld %10ld%c%.12s ",
5013 bitset(EF_WARNING, flags)
5015 ctime(&submittime) + 4);
5016 prtstr(&buf[1], 78);
5020 (void) sm_io_fprintf(smioout,
5024 ctime(&submittime));
5025 prtstr(&buf[1], 39);
5028 if (quarmsg[0] != '\0')
5030 (void) sm_io_fprintf(smioout,
5032 "\n QUARANTINE: %.*s",
5038 if (statmsg[0] != '\0' || bodytype[0] != '\0')
5040 (void) sm_io_fprintf(smioout,
5044 if (statmsg[0] != '\0')
5045 (void) sm_io_fprintf(smioout,
5054 case 'C': /* controlling user */
5056 (void) sm_io_fprintf(smioout,
5058 "\n\t\t\t\t\t\t(---%.64s---)",
5062 case 'R': /* recipient name */
5073 (void) sm_io_fprintf(smioout,
5080 (void) sm_io_fprintf(smioout,
5085 if (Verbose && statmsg[0] != '\0')
5087 (void) sm_io_fprintf(smioout,
5095 case 'T': /* creation time */
5096 submittime = atol(&buf[1]);
5099 case 'F': /* flag bits */
5100 for (p = &buf[1]; *p != '\0'; p++)
5105 flags |= EF_WARNING;
5111 if (submittime == (time_t) 0)
5112 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
5113 " (no control file)");
5114 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "\n");
5115 (void) sm_io_close(f, SM_TIME_DEFAULT);
5121 ** QUEUE_LETTER -- get the proper queue letter for the current QueueMode.
5124 ** e -- envelope to build it in/from.
5125 ** type -- the file type, used as the first character
5126 ** of the file name.
5129 ** the letter to use
5133 queue_letter(e, type)
5137 /* Change type according to QueueMode */
5138 if (type == ANYQFL_LETTER)
5140 if (e->e_quarmsg != NULL)
5141 type = QUARQF_LETTER;
5147 type = NORMQF_LETTER;
5151 type = QUARQF_LETTER;
5155 type = LOSEQF_LETTER;
5159 /* should never happen */
5169 ** QUEUENAME -- build a file name in the queue directory for this envelope.
5172 ** e -- envelope to build it in/from.
5173 ** type -- the file type, used as the first character
5174 ** of the file name.
5177 ** a pointer to the queue name (in a static buffer).
5180 ** If no id code is already assigned, queuename() will
5181 ** assign an id code with assign_queueid(). If no queue
5182 ** directory is assigned, one will be set with setnewqueue().
5187 register ENVELOPE *e;
5193 static char buf[MAXPATHLEN];
5195 /* Assign an ID if needed */
5196 if (e->e_id == NULL)
5202 type = queue_letter(e, type);
5204 /* begin of filename */
5205 pref[0] = (char) type;
5209 /* Assign a queue group/directory if needed */
5210 if (type == XSCRPT_LETTER)
5213 ** We don't want to call setnewqueue() if we are fetching
5214 ** the pathname of the transcript file, because setnewqueue
5215 ** chooses a queue, and sometimes we need to write to the
5216 ** transcript file before we have gathered enough information
5217 ** to choose a queue.
5220 if (e->e_xfqgrp == NOQGRP || e->e_xfqdir == NOQDIR)
5222 if (e->e_qgrp != NOQGRP && e->e_qdir != NOQDIR)
5224 e->e_xfqgrp = e->e_qgrp;
5225 e->e_xfqdir = e->e_qdir;
5230 if (Queue[e->e_xfqgrp]->qg_numqueues <= 1)
5234 e->e_xfqdir = get_rand_mod(
5235 Queue[e->e_xfqgrp]->qg_numqueues);
5244 if (e->e_qgrp == NOQGRP || e->e_qdir == NOQDIR)
5248 (void) setnewqueue(e);
5250 if (type == DATAFL_LETTER)
5262 /* xf files always have a valid qd and qg picked above */
5263 if ((qd == NOQDIR || qg == NOQGRP) && type != XSCRPT_LETTER)
5264 (void) sm_strlcpyn(buf, sizeof(buf), 2, pref, e->e_id);
5270 if (bitset(QP_SUBDF, Queue[qg]->qg_qpaths[qd].qp_subdirs))
5279 if (bitset(QP_SUBQF, Queue[qg]->qg_qpaths[qd].qp_subdirs))
5284 if (bitset(QP_SUBXF, Queue[qg]->qg_qpaths[qd].qp_subdirs))
5291 sm_abort("queuename: bad queue file type %d", type);
5294 (void) sm_strlcpyn(buf, sizeof(buf), 4,
5295 Queue[qg]->qg_qpaths[qd].qp_name,
5296 sub, pref, e->e_id);
5300 sm_dprintf("queuename: %s\n", buf);
5305 ** INIT_QID_ALG -- Initialize the (static) parameters that are used to
5306 ** generate a queue ID.
5308 ** This function is called by the daemon to reset
5309 ** LastQueueTime and LastQueuePid which are used by assign_queueid().
5310 ** Otherwise the algorithm may cause problems because
5311 ** LastQueueTime and LastQueuePid are set indirectly by main()
5312 ** before the daemon process is started, hence LastQueuePid is not
5313 ** the pid of the daemon and therefore a child of the daemon can
5314 ** actually have the same pid as LastQueuePid which means the section
5315 ** in assign_queueid():
5316 ** * see if we need to get a new base time/pid *
5317 ** is NOT triggered which will cause the same queue id to be generated.
5334 ** ASSIGN_QUEUEID -- assign a queue ID for this envelope.
5336 ** Assigns an id code if one does not already exist.
5337 ** This code assumes that nothing will remain in the queue for
5338 ** longer than 60 years. It is critical that files with the given
5339 ** name do not already exist in the queue.
5340 ** [No longer initializes e_qdir to NOQDIR.]
5343 ** e -- envelope to set it in.
5349 static const char QueueIdChars[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
5351 # define QIC_LEN_R 62
5354 ** Note: the length is "officially" 60 because minutes and seconds are
5355 ** usually only 0-59. However (Linux):
5356 ** tm_sec The number of seconds after the minute, normally in
5357 ** the range 0 to 59, but can be up to 61 to allow for
5359 ** Hence the real length of the string is 62 to take this into account.
5360 ** Alternatively % QIC_LEN can (should) be used for access everywhere.
5363 # define queuenextid() CurrentPid
5364 #define QIC_LEN_SQR (QIC_LEN * QIC_LEN)
5368 register ENVELOPE *e;
5370 pid_t pid = queuenextid();
5371 static unsigned int cX = 0;
5372 static unsigned int random_offset;
5374 char idbuf[MAXQFNAME - 2];
5377 if (e->e_id != NULL)
5380 /* see if we need to get a new base time/pid */
5381 if (cX >= QIC_LEN_SQR || LastQueueTime == 0 || LastQueuePid != pid)
5383 time_t then = LastQueueTime;
5385 /* if the first time through, pick a random offset */
5386 if (LastQueueTime == 0)
5387 random_offset = ((unsigned int)get_random())
5390 while ((LastQueueTime = curtime()) == then &&
5391 LastQueuePid == pid)
5395 LastQueuePid = queuenextid();
5400 ** Generate a new sequence number between 0 and QIC_LEN_SQR-1.
5401 ** This lets us generate up to QIC_LEN_SQR unique queue ids
5402 ** per second, per process. With envelope splitting,
5403 ** a single message can consume many queue ids.
5406 seq = (cX + random_offset) % QIC_LEN_SQR;
5409 sm_dprintf("assign_queueid: random_offset=%u (%u)\n",
5410 random_offset, seq);
5412 tm = gmtime(&LastQueueTime);
5413 idbuf[0] = QueueIdChars[tm->tm_year % QIC_LEN];
5414 idbuf[1] = QueueIdChars[tm->tm_mon];
5415 idbuf[2] = QueueIdChars[tm->tm_mday];
5416 idbuf[3] = QueueIdChars[tm->tm_hour];
5417 idbuf[4] = QueueIdChars[tm->tm_min % QIC_LEN_R];
5418 idbuf[5] = QueueIdChars[tm->tm_sec % QIC_LEN_R];
5419 idbuf[6] = QueueIdChars[seq / QIC_LEN];
5420 idbuf[7] = QueueIdChars[seq % QIC_LEN];
5421 (void) sm_snprintf(&idbuf[8], sizeof(idbuf) - 8, "%06d",
5422 (int) LastQueuePid);
5423 e->e_id = sm_rpool_strdup_x(e->e_rpool, idbuf);
5424 macdefine(&e->e_macro, A_PERM, 'i', e->e_id);
5426 /* XXX: inherited from MainEnvelope */
5427 e->e_qgrp = NOQGRP; /* too early to do anything else */
5429 e->e_xfqgrp = NOQGRP;
5432 /* New ID means it's not on disk yet */
5433 e->e_qfletter = '\0';
5436 sm_dprintf("assign_queueid: assigned id %s, e=%p\n",
5439 sm_syslog(LOG_DEBUG, e->e_id, "assigned id");
5442 ** SYNC_QUEUE_TIME -- Assure exclusive PID in any given second
5444 ** Make sure one PID can't be used by two processes in any one second.
5446 ** If the system rotates PIDs fast enough, may get the
5447 ** same pid in the same second for two distinct processes.
5448 ** This will interfere with the queue file naming system.
5460 #if FAST_PID_RECYCLE
5461 if (OpMode != MD_TEST &&
5462 OpMode != MD_CHECKCONFIG &&
5463 OpMode != MD_VERIFY &&
5464 LastQueueTime > 0 &&
5465 LastQueuePid == CurrentPid &&
5466 curtime() == LastQueueTime)
5468 #endif /* FAST_PID_RECYCLE */
5471 ** UNLOCKQUEUE -- unlock the queue entry for a specified envelope
5474 ** e -- the envelope to unlock.
5480 ** unlocks the queue for `e'.
5488 sm_dprintf("unlockqueue(%s)\n",
5489 e->e_id == NULL ? "NOQUEUE" : e->e_id);
5492 /* if there is a lock file in the envelope, close it */
5493 if (e->e_lockfp != NULL)
5494 (void) sm_io_close(e->e_lockfp, SM_TIME_DEFAULT);
5497 /* don't create a queue id if we don't already have one */
5498 if (e->e_id == NULL)
5501 /* remove the transcript */
5503 sm_syslog(LOG_DEBUG, e->e_id, "unlock");
5505 (void) xunlink(queuename(e, XSCRPT_LETTER));
5508 ** SETCTLUSER -- create a controlling address
5510 ** Create a fake "address" given only a local login name; this is
5511 ** used as a "controlling user" for future recipient addresses.
5514 ** user -- the user name of the controlling user.
5515 ** qfver -- the version stamp of this queue file.
5519 ** An address descriptor for the controlling user,
5520 ** using storage allocated from e->e_rpool.
5525 setctluser(user, qfver, e)
5530 register ADDRESS *a;
5535 ** See if this clears our concept of controlling user.
5538 if (user == NULL || *user == '\0')
5542 ** Set up addr fields for controlling user.
5545 a = (ADDRESS *) sm_rpool_malloc_x(e->e_rpool, sizeof(*a));
5546 memset((char *) a, '\0', sizeof(*a));
5551 a->q_user = sm_rpool_strdup_x(e->e_rpool, p);
5555 p = strtok(user, ":");
5556 a->q_user = sm_rpool_strdup_x(e->e_rpool, user);
5559 if ((p = strtok(NULL, ":")) != NULL)
5561 if ((p = strtok(NULL, ":")) != NULL)
5563 if ((p = strtok(NULL, ":")) != NULL)
5567 a->q_flags |= QGOODUID;
5569 /* if there is another ':': restore it */
5570 if ((o = strtok(NULL, ":")) != NULL && o > p)
5574 else if ((pw = sm_getpwnam(user)) != NULL)
5576 if (*pw->pw_dir == '\0')
5578 else if (strcmp(pw->pw_dir, "/") == 0)
5581 a->q_home = sm_rpool_strdup_x(e->e_rpool, pw->pw_dir);
5582 a->q_uid = pw->pw_uid;
5583 a->q_gid = pw->pw_gid;
5584 a->q_flags |= QGOODUID;
5588 a->q_flags |= QPRIMARY; /* flag as a "ctladdr" */
5589 a->q_mailer = LocalMailer;
5591 a->q_paddr = sm_rpool_strdup_x(e->e_rpool, a->q_user);
5593 a->q_paddr = sm_rpool_strdup_x(e->e_rpool, p);
5597 ** LOSEQFILE -- rename queue file with LOSEQF_LETTER & try to let someone know
5600 ** e -- the envelope (e->e_id will be used).
5601 ** why -- reported to whomever can hear.
5609 register ENVELOPE *e;
5614 char buf[MAXPATHLEN];
5616 if (e == NULL || e->e_id == NULL)
5618 p = queuename(e, ANYQFL_LETTER);
5619 if (sm_strlcpy(buf, p, sizeof(buf)) >= sizeof(buf))
5621 if (!bitset(EF_INQUEUE, e->e_flags))
5622 queueup(e, false, true);
5623 else if (QueueMode == QM_LOST)
5626 /* if already lost, no need to re-lose */
5629 p = queuename(e, LOSEQF_LETTER);
5630 if (rename(buf, p) < 0)
5631 syserr("cannot rename(%s, %s), uid=%d",
5632 buf, p, (int) geteuid());
5633 else if (LogLevel > 0)
5634 sm_syslog(LOG_ALERT, e->e_id,
5635 "Losing %s: %s", buf, why);
5637 if (e->e_dfp != NULL)
5639 (void) sm_io_close(e->e_dfp, SM_TIME_DEFAULT);
5642 e->e_flags &= ~EF_HAS_DF;
5645 ** NAME2QID -- translate a queue group name to a queue group id
5648 ** queuename -- name of queue group.
5651 ** queue group id if found.
5652 ** NOQGRP otherwise.
5661 s = stab(queuename, ST_QUEUE, ST_FIND);
5664 return s->s_quegrp->qg_index;
5667 ** QID_PRINTNAME -- create externally printable version of queue id
5670 ** e -- the envelope.
5673 ** a printable version
5681 static char idbuf[MAXQFNAME + 34];
5686 if (e->e_id == NULL)
5691 if (e->e_qdir == NOQDIR)
5694 (void) sm_snprintf(idbuf, sizeof(idbuf), "%.32s/%s",
5695 Queue[e->e_qgrp]->qg_qpaths[e->e_qdir].qp_name,
5700 ** QID_PRINTQUEUE -- create full version of queue directory for data files
5703 ** qgrp -- index in queue group.
5704 ** qdir -- the short version of the queue directory
5707 ** the full pathname to the queue (might point to a static var)
5711 qid_printqueue(qgrp, qdir)
5716 static char dir[MAXPATHLEN];
5719 return Queue[qgrp]->qg_qdir;
5721 if (strcmp(Queue[qgrp]->qg_qpaths[qdir].qp_name, ".") == 0)
5724 subdir = Queue[qgrp]->qg_qpaths[qdir].qp_name;
5726 (void) sm_strlcpyn(dir, sizeof(dir), 4,
5727 Queue[qgrp]->qg_qdir,
5728 subdir == NULL ? "" : "/",
5729 subdir == NULL ? "" : subdir,
5731 Queue[qgrp]->qg_qpaths[qdir].qp_subdirs)
5737 ** PICKQDIR -- Pick a queue directory from a queue group
5740 ** qg -- queue group
5741 ** fsize -- file size in bytes
5742 ** e -- envelope, or NULL
5745 ** NOQDIR if no queue directory in qg has enough free space to
5746 ** hold a file of size 'fsize', otherwise the index of
5747 ** a randomly selected queue directory which resides on a
5748 ** file system with enough disk space.
5749 ** XXX This could be extended to select a queuedir with
5750 ** a few (the fewest?) number of entries. That data
5751 ** is available if shared memory is used.
5754 ** If the request fails and e != NULL then sm_syslog is called.
5758 pickqdir(qg, fsize, e)
5767 /* Pick a random directory, as a starting point. */
5768 if (qg->qg_numqueues <= 1)
5771 qdir = get_rand_mod(qg->qg_numqueues);
5776 #endif /* _FFR_TESTS */
5777 if (MinBlocksFree <= 0 && fsize <= 0)
5781 ** Now iterate over the queue directories,
5782 ** looking for a directory with enough space for this message.
5788 QPATHS *qp = &qg->qg_qpaths[i];
5793 needed += fsize / FILE_SYS_BLKSIZE(qp->qp_fsysidx)
5794 + ((fsize % FILE_SYS_BLKSIZE(qp->qp_fsysidx)
5796 if (MinBlocksFree > 0)
5797 needed += MinBlocksFree;
5798 fsavail = FILE_SYS_AVAIL(qp->qp_fsysidx);
5805 ** might be not correctly updated,
5806 ** let's try to get the info directly.
5809 fsavail = freediskspace(FILE_SYS_NAME(qp->qp_fsysidx),
5814 #endif /* SM_CONF_SHM */
5815 if (needed <= fsavail)
5817 if (avail < fsavail)
5820 if (qg->qg_numqueues > 0)
5821 i = (i + 1) % qg->qg_numqueues;
5822 } while (i != qdir);
5824 if (e != NULL && LogLevel > 0)
5825 sm_syslog(LOG_ALERT, e->e_id,
5826 "low on space (%s needs %ld bytes + %ld blocks in %s), max avail: %ld",
5827 CurHostName == NULL ? "SMTP-DAEMON" : CurHostName,
5828 fsize, MinBlocksFree,
5829 qg->qg_qdir, avail);
5833 ** SETNEWQUEUE -- Sets a new queue group and directory
5835 ** Assign a queue group and directory to an envelope and store the
5836 ** directory in e->e_qdir.
5839 ** e -- envelope to assign a queue for.
5842 ** true if successful
5846 ** On success, e->e_qgrp and e->e_qdir are non-negative.
5847 ** On failure (not enough disk space),
5848 ** e->qgrp = NOQGRP, e->e_qdir = NOQDIR
5849 ** and usrerr() is invoked (which could raise an exception).
5857 sm_dprintf("setnewqueue: called\n");
5859 /* not set somewhere else */
5860 if (e->e_qgrp == NOQGRP)
5865 ** Use the queue group of the "first" recipient, as set by
5866 ** the "queuegroup" rule set. If that is not defined, then
5867 ** use the queue group of the mailer of the first recipient.
5868 ** If that is not defined either, then use the default
5870 ** Notice: "first" depends on the sorting of sendqueue
5872 ** To avoid problems with "bad" recipients look
5873 ** for a valid address first.
5878 (QS_IS_BADADDR(q->q_state) || QS_IS_DEAD(q->q_state)))
5884 else if (q->q_qgrp >= 0)
5885 e->e_qgrp = q->q_qgrp;
5886 else if (q->q_mailer != NULL &&
5887 ISVALIDQGRP(q->q_mailer->m_qgrp))
5888 e->e_qgrp = q->q_mailer->m_qgrp;
5891 e->e_dfqgrp = e->e_qgrp;
5894 if (ISVALIDQDIR(e->e_qdir) && ISVALIDQDIR(e->e_dfqdir))
5897 sm_dprintf("setnewqueue: e_qdir already assigned (%s)\n",
5898 qid_printqueue(e->e_qgrp, e->e_qdir));
5903 e->e_qdir = pickqdir(Queue[e->e_qgrp], e->e_msgsize, e);
5904 if (e->e_qdir == NOQDIR)
5907 if (!bitset(EF_FATALERRS, e->e_flags))
5908 usrerr("452 4.4.5 Insufficient disk space; try again later");
5909 e->e_flags |= EF_FATALERRS;
5914 sm_dprintf("setnewqueue: Assigned queue directory %s\n",
5915 qid_printqueue(e->e_qgrp, e->e_qdir));
5917 if (e->e_xfqgrp == NOQGRP || e->e_xfqdir == NOQDIR)
5919 e->e_xfqgrp = e->e_qgrp;
5920 e->e_xfqdir = e->e_qdir;
5922 e->e_dfqdir = e->e_qdir;
5926 ** CHKQDIR -- check a queue directory
5929 ** name -- name of queue directory
5930 ** sff -- flags for safefile()
5933 ** is it a queue directory?
5936 static bool chkqdir __P((char *, long));
5946 /* skip over . and .. directories */
5947 if (name[0] == '.' &&
5948 (name[1] == '\0' || (name[1] == '.' && name[2] == '\0')))
5951 if (lstat(name, &statb) < 0)
5952 #else /* HASLSTAT */
5953 if (stat(name, &statb) < 0)
5954 #endif /* HASLSTAT */
5957 sm_dprintf("chkqdir: stat(\"%s\"): %s\n",
5958 name, sm_errstring(errno));
5962 if (S_ISLNK(statb.st_mode))
5965 ** For a symlink we need to make sure the
5966 ** target is a directory
5969 if (stat(name, &statb) < 0)
5972 sm_dprintf("chkqdir: stat(\"%s\"): %s\n",
5973 name, sm_errstring(errno));
5977 #endif /* HASLSTAT */
5979 if (!S_ISDIR(statb.st_mode))
5982 sm_dprintf("chkqdir: \"%s\": Not a directory\n",
5987 /* Print a warning if unsafe (but still use it) */
5988 /* XXX do this only if we want the warning? */
5989 i = safedirpath(name, RunAsUid, RunAsGid, NULL, sff, 0, 0);
5993 sm_dprintf("chkqdir: \"%s\": Not safe: %s\n",
5994 name, sm_errstring(i));
5997 sm_syslog(LOG_WARNING, NOQID,
5998 "queue directory \"%s\": Not safe: %s",
5999 name, sm_errstring(i));
6000 #endif /* _FFR_CHK_QUEUE */
6005 ** MULTIQUEUE_CACHE -- cache a list of paths to queues.
6007 ** Each potential queue is checked as the cache is built.
6008 ** Thereafter, each is blindly trusted.
6009 ** Note that we can be called again after a timeout to rebuild
6010 ** (although code for that is not ready yet).
6013 ** basedir -- base of all queue directories.
6014 ** blen -- strlen(basedir).
6015 ** qg -- queue group.
6016 ** qn -- number of queue directories already cached.
6017 ** phash -- pointer to hash value over queue dirs.
6019 ** only used if shared memory is active.
6020 #endif * SM_CONF_SHM *
6023 ** new number of queue directories.
6026 #define INITIAL_SLOTS 20
6027 #define ADD_SLOTS 10
6030 multiqueue_cache(basedir, blen, qg, qn, phash)
6035 unsigned int *phash;
6040 long sff = SFF_ANYFILE;
6041 char qpath[MAXPATHLEN];
6042 char subdir[MAXPATHLEN];
6043 char prefix[MAXPATHLEN]; /* dir relative to basedir */
6046 sm_dprintf("multiqueue_cache: called\n");
6048 /* Initialize to current directory */
6051 if (qg->qg_numqueues != 0 && qg->qg_qpaths != NULL)
6053 for (i = 0; i < qg->qg_numqueues; i++)
6055 if (qg->qg_qpaths[i].qp_name != NULL)
6056 (void) sm_free(qg->qg_qpaths[i].qp_name); /* XXX */
6058 (void) sm_free((char *) qg->qg_qpaths); /* XXX */
6059 qg->qg_qpaths = NULL;
6060 qg->qg_numqueues = 0;
6063 /* If running as root, allow safedirpath() checks to use privs */
6067 sff |= SFF_SAFEDIRPATH|SFF_NOWWFILES;
6069 sff |= SFF_NOGWFILES;
6070 #endif /* _FFR_CHK_QUEUE */
6072 if (!SM_IS_DIR_START(qg->qg_qdir))
6075 ** XXX we could add basedir, but then we have to realloc()
6076 ** the string... Maybe another time.
6079 syserr("QueuePath %s not absolute", qg->qg_qdir);
6080 ExitStat = EX_CONFIG;
6084 /* qpath: directory of current workgroup */
6085 len = sm_strlcpy(qpath, qg->qg_qdir, sizeof(qpath));
6086 if (len >= sizeof(qpath))
6088 syserr("QueuePath %.256s too long (%d max)",
6089 qg->qg_qdir, (int) sizeof(qpath));
6090 ExitStat = EX_CONFIG;
6094 /* begin of qpath must be same as basedir */
6095 if (strncmp(basedir, qpath, blen) != 0 &&
6096 (strncmp(basedir, qpath, blen - 1) != 0 || len != blen - 1))
6098 syserr("QueuePath %s not subpath of QueueDirectory %s",
6100 ExitStat = EX_CONFIG;
6104 /* Do we have a nested subdirectory? */
6105 if (blen < len && SM_FIRST_DIR_DELIM(qg->qg_qdir + blen) != NULL)
6108 /* Copy subdirectory into prefix for later use */
6109 if (sm_strlcpy(prefix, qg->qg_qdir + blen, sizeof(prefix)) >=
6112 syserr("QueuePath %.256s too long (%d max)",
6113 qg->qg_qdir, (int) sizeof(qpath));
6114 ExitStat = EX_CONFIG;
6117 cp = SM_LAST_DIR_DELIM(prefix);
6118 SM_ASSERT(cp != NULL);
6119 *cp = '\0'; /* cut off trailing / */
6122 /* This is guaranteed by the basedir check above */
6123 SM_ASSERT(len >= blen - 1);
6124 cp = &qpath[len - 1];
6128 register struct dirent *d;
6131 char relpath[MAXPATHLEN];
6133 *cp = '\0'; /* Overwrite wildcard */
6134 if ((cp = SM_LAST_DIR_DELIM(qpath)) == NULL)
6136 syserr("QueueDirectory: can not wildcard relative path");
6138 sm_dprintf("multiqueue_cache: \"%s*\": Can not wildcard relative path.\n",
6140 ExitStat = EX_CONFIG;
6146 ** Special case of top level wildcard, like /foo*
6150 (void) sm_strlcpy(qpath + 1, qpath, sizeof(qpath) - 1);
6154 *(cp++) = '\0'; /* Replace / with \0 */
6155 len = strlen(cp); /* Last component of queue directory */
6158 ** Path relative to basedir, with trailing /
6159 ** It will be modified below to specify the subdirectories
6160 ** so they can be opened without chdir().
6163 off = sm_strlcpyn(relpath, sizeof(relpath), 2, prefix, "/");
6164 SM_ASSERT(off < sizeof(relpath));
6167 sm_dprintf("multiqueue_cache: prefix=\"%s%s\"\n",
6170 /* It is always basedir: we don't need to store it per group */
6171 /* XXX: optimize this! -> one more global? */
6172 qg->qg_qdir = newstr(basedir);
6173 qg->qg_qdir[blen - 1] = '\0'; /* cut off trailing / */
6176 ** XXX Should probably wrap this whole loop in a timeout
6177 ** in case some wag decides to NFS mount the queues.
6180 /* Test path to get warning messages. */
6183 /* XXX qg_runasuid and qg_runasgid for specials? */
6184 i = safedirpath(basedir, RunAsUid, RunAsGid, NULL,
6186 if (i != 0 && tTd(41, 2))
6187 sm_dprintf("multiqueue_cache: \"%s\": Not safe: %s\n",
6188 basedir, sm_errstring(i));
6191 if ((dp = opendir(prefix)) == NULL)
6193 syserr("can not opendir(%s/%s)", qg->qg_qdir, prefix);
6195 sm_dprintf("multiqueue_cache: opendir(\"%s/%s\"): %s\n",
6196 qg->qg_qdir, prefix,
6197 sm_errstring(errno));
6198 ExitStat = EX_CONFIG;
6201 while ((d = readdir(dp)) != NULL)
6203 /* Skip . and .. directories */
6204 if (strcmp(d->d_name, ".") == 0 ||
6205 strcmp(d->d_name, "..") == 0)
6208 i = strlen(d->d_name);
6209 if (i < len || strncmp(d->d_name, cp, len) != 0)
6212 sm_dprintf("multiqueue_cache: \"%s\", skipped\n",
6217 /* Create relative pathname: prefix + local directory */
6218 i = sizeof(relpath) - off;
6219 if (sm_strlcpy(relpath + off, d->d_name, i) >= i)
6220 continue; /* way too long */
6222 if (!chkqdir(relpath, sff))
6225 if (qg->qg_qpaths == NULL)
6227 slotsleft = INITIAL_SLOTS;
6228 qg->qg_qpaths = (QPATHS *)xalloc((sizeof(*qg->qg_qpaths)) *
6230 qg->qg_numqueues = 0;
6232 else if (slotsleft < 1)
6234 qg->qg_qpaths = (QPATHS *)sm_realloc((char *)qg->qg_qpaths,
6235 (sizeof(*qg->qg_qpaths)) *
6238 if (qg->qg_qpaths == NULL)
6240 (void) closedir(dp);
6243 slotsleft += ADD_SLOTS;
6247 qg->qg_qpaths[qg->qg_numqueues].qp_subdirs = QP_NOSUB;
6249 #define CHKRSUBDIR(name, flag) \
6250 (void) sm_strlcpyn(subdir, sizeof(subdir), 3, relpath, "/", name); \
6251 if (chkqdir(subdir, sff)) \
6252 qg->qg_qpaths[qg->qg_numqueues].qp_subdirs |= flag; \
6256 CHKRSUBDIR("qf", QP_SUBQF);
6257 CHKRSUBDIR("df", QP_SUBDF);
6258 CHKRSUBDIR("xf", QP_SUBXF);
6260 /* assert(strlen(d->d_name) < MAXPATHLEN - 14) */
6261 /* maybe even - 17 (subdirs) */
6263 if (prefix[0] != '.')
6264 qg->qg_qpaths[qg->qg_numqueues].qp_name =
6267 qg->qg_qpaths[qg->qg_numqueues].qp_name =
6271 sm_dprintf("multiqueue_cache: %d: \"%s\" cached (%x).\n",
6272 qg->qg_numqueues, relpath,
6273 qg->qg_qpaths[qg->qg_numqueues].qp_subdirs);
6275 qg->qg_qpaths[qg->qg_numqueues].qp_idx = qn;
6276 *phash = hash_q(relpath, *phash);
6277 #endif /* SM_CONF_SHM */
6282 (void) closedir(dp);
6287 if (qg->qg_numqueues == 0)
6289 qg->qg_qpaths = (QPATHS *) xalloc(sizeof(*qg->qg_qpaths));
6291 /* test path to get warning messages */
6292 i = safedirpath(qpath, RunAsUid, RunAsGid, NULL, sff, 0, 0);
6295 syserr("can not opendir(%s)", qpath);
6297 sm_dprintf("multiqueue_cache: opendir(\"%s\"): %s\n",
6298 qpath, sm_errstring(i));
6299 ExitStat = EX_CONFIG;
6303 qg->qg_qpaths[0].qp_subdirs = QP_NOSUB;
6304 qg->qg_numqueues = 1;
6307 #define CHKSUBDIR(name, flag) \
6308 (void) sm_strlcpyn(subdir, sizeof(subdir), 3, qg->qg_qdir, "/", name); \
6309 if (chkqdir(subdir, sff)) \
6310 qg->qg_qpaths[0].qp_subdirs |= flag; \
6313 CHKSUBDIR("qf", QP_SUBQF);
6314 CHKSUBDIR("df", QP_SUBDF);
6315 CHKSUBDIR("xf", QP_SUBXF);
6317 if (qg->qg_qdir[blen - 1] != '\0' &&
6318 qg->qg_qdir[blen] != '\0')
6321 ** Copy the last component into qpaths and
6325 qg->qg_qpaths[0].qp_name = newstr(qg->qg_qdir + blen);
6326 qg->qg_qdir[blen - 1] = '\0';
6329 qg->qg_qpaths[0].qp_name = newstr(".");
6332 qg->qg_qpaths[0].qp_idx = qn;
6333 *phash = hash_q(qg->qg_qpaths[0].qp_name, *phash);
6334 #endif /* SM_CONF_SHM */
6341 ** FILESYS_FIND -- find entry in FileSys table, or add new one
6343 ** Given the pathname of a directory, determine the file system
6344 ** in which that directory resides, and return a pointer to the
6345 ** entry in the FileSys table that describes the file system.
6346 ** A new entry is added if necessary (and requested).
6347 ** If the directory does not exist, -1 is returned.
6350 ** name -- name of directory (must be persistent!)
6351 ** path -- pathname of directory (name plus maybe "/df")
6352 ** add -- add to structure if not found.
6355 ** >=0: found: index in file system table
6356 ** <0: some error, i.e.,
6357 ** FSF_TOO_MANY: too many filesystems (-> syserr())
6358 ** FSF_STAT_FAIL: can't stat() filesystem (-> syserr())
6359 ** FSF_NOT_FOUND: not in list
6362 static short filesys_find __P((const char *, const char *, bool));
6364 #define FSF_NOT_FOUND (-1)
6365 #define FSF_STAT_FAIL (-2)
6366 #define FSF_TOO_MANY (-3)
6369 filesys_find(name, path, add)
6377 if (stat(path, &st) < 0)
6379 syserr("cannot stat queue directory %s", path);
6380 return FSF_STAT_FAIL;
6382 for (i = 0; i < NumFileSys; ++i)
6384 if (FILE_SYS_DEV(i) == st.st_dev)
6387 ** Make sure the file system (FS) name is set:
6388 ** even though the source code indicates that
6389 ** FILE_SYS_DEV() is only set below, it could be
6390 ** set via shared memory, hence we need to perform
6391 ** this check/assignment here.
6394 if (NULL == FILE_SYS_NAME(i))
6395 FILE_SYS_NAME(i) = name;
6399 if (i >= MAXFILESYS)
6401 syserr("too many queue file systems (%d max)", MAXFILESYS);
6402 return FSF_TOO_MANY;
6405 return FSF_NOT_FOUND;
6408 FILE_SYS_NAME(i) = name;
6409 FILE_SYS_DEV(i) = st.st_dev;
6410 FILE_SYS_AVAIL(i) = 0;
6411 FILE_SYS_BLKSIZE(i) = 1024; /* avoid divide by zero */
6416 ** FILESYS_SETUP -- set up mapping from queue directories to file systems
6418 ** This data structure is used to efficiently check the amount of
6419 ** free space available in a set of queue directories.
6422 ** add -- initialize structure if necessary.
6426 ** <0: some error, i.e.,
6427 ** FSF_NOT_FOUND: not in list
6428 ** FSF_STAT_FAIL: can't stat() filesystem (-> syserr())
6429 ** FSF_TOO_MANY: too many filesystems (-> syserr())
6432 static int filesys_setup __P((bool));
6443 for (i = 0; i < NumQueue && Queue[i] != NULL; i++)
6445 for (j = 0; j < Queue[i]->qg_numqueues; ++j)
6447 QPATHS *qp = &Queue[i]->qg_qpaths[j];
6448 char qddf[MAXPATHLEN];
6450 (void) sm_strlcpyn(qddf, sizeof(qddf), 2, qp->qp_name,
6451 (bitset(QP_SUBDF, qp->qp_subdirs)
6453 fs = filesys_find(qp->qp_name, qddf, add);
6455 qp->qp_fsysidx = fs;
6466 ** FILESYS_UPDATE -- update amount of free space on all file systems
6468 ** The FileSys table is used to cache the amount of free space
6469 ** available on all queue directory file systems.
6470 ** This function updates the cached information if it has expired.
6479 ** Updates FileSys table.
6486 long avail, blksize;
6488 static time_t nextupdate = 0;
6492 ** Only the daemon updates the shared memory, i.e.,
6493 ** if shared memory is available but the pid is not the
6494 ** one of the daemon, then don't do anything.
6497 if (ShmId != SM_SHM_NO_ID && DaemonPid != CurrentPid)
6499 #endif /* SM_CONF_SHM */
6501 if (now < nextupdate)
6503 nextupdate = now + FILESYS_UPDATE_INTERVAL;
6504 for (i = 0; i < NumFileSys; ++i)
6506 FILESYS *fs = &FILE_SYS(i);
6508 avail = freediskspace(FILE_SYS_NAME(i), &blksize);
6509 if (avail < 0 || blksize <= 0)
6512 sm_syslog(LOG_ERR, NOQID,
6513 "filesys_update failed: %s, fs=%s, avail=%ld, blocksize=%ld",
6514 sm_errstring(errno),
6515 FILE_SYS_NAME(i), avail, blksize);
6517 fs->fs_blksize = 1024; /* avoid divide by zero */
6518 nextupdate = now + 2; /* let's do this soon again */
6522 fs->fs_avail = avail;
6523 fs->fs_blksize = blksize;
6528 #if _FFR_ANY_FREE_FS
6530 ** FILESYS_FREE -- check whether there is at least one fs with enough space.
6533 ** fsize -- file size in bytes
6536 ** true iff there is one fs with more than fsize bytes free.
6547 for (i = 0; i < NumFileSys; ++i)
6551 if (FILE_SYS_AVAIL(i) < 0 || FILE_SYS_BLKSIZE(i) <= 0)
6553 needed += fsize / FILE_SYS_BLKSIZE(i)
6554 + ((fsize % FILE_SYS_BLKSIZE(i)
6557 if (needed <= FILE_SYS_AVAIL(i))
6562 #endif /* _FFR_ANY_FREE_FS */
6565 ** DISK_STATUS -- show amount of free space in queue directories
6568 ** out -- output file pointer.
6569 ** prefix -- string to output in front of each line.
6576 disk_status(out, prefix)
6581 long avail, blksize;
6584 for (i = 0; i < NumFileSys; ++i)
6586 avail = freediskspace(FILE_SYS_NAME(i), &blksize);
6587 if (avail >= 0 && blksize > 0)
6589 free = (long)((double) avail *
6590 ((double) blksize / 1024));
6594 (void) sm_io_fprintf(out, SM_TIME_DEFAULT,
6605 ** INIT_SEM -- initialize semaphore system
6608 ** owner -- is this the owner of semaphores?
6614 #if _FFR_USE_SEM_LOCKING
6616 static int SemId = -1; /* Semaphore Id */
6617 int SemKey = SM_SEM_KEY;
6618 #endif /* SM_CONF_SEM */
6619 #endif /* _FFR_USE_SEM_LOCKING */
6621 static void init_sem __P((bool));
6627 #if _FFR_USE_SEM_LOCKING
6629 SemId = sm_sem_start(SemKey, 1, 0, owner);
6632 sm_syslog(LOG_ERR, NOQID,
6633 "func=init_sem, sem_key=%ld, sm_sem_start=%d, error=%s",
6634 (long) SemKey, SemId, sm_errstring(-SemId));
6637 if (owner && RunAsUid != 0)
6641 r = sm_semsetowner(SemId, RunAsUid, RunAsGid, 0660);
6643 sm_syslog(LOG_ERR, NOQID,
6644 "key=%ld, sm_semsetowner=%d, RunAsUid=%d, RunAsGid=%d",
6645 (long) SemKey, r, RunAsUid, RunAsGid);
6647 #endif /* SM_CONF_SEM */
6648 #endif /* _FFR_USE_SEM_LOCKING */
6653 ** STOP_SEM -- stop semaphore system
6656 ** owner -- is this the owner of semaphores?
6662 static void stop_sem __P((bool));
6668 #if _FFR_USE_SEM_LOCKING
6670 if (owner && SemId >= 0)
6672 #endif /* SM_CONF_SEM */
6673 #endif /* _FFR_USE_SEM_LOCKING */
6678 ** UPD_QS -- update information about queue when adding/deleting an entry
6682 ** count -- add/remove entry (+1/0/-1: add/no change/remove)
6683 ** space -- update the space available as well.
6684 ** (>0/0/<0: add/no change/remove)
6685 ** where -- caller (for logging)
6691 ** Modifies available space in filesystem.
6692 ** Changes number of entries in queue directory.
6696 upd_qs(e, count, space, where)
6704 # if _FFR_USE_SEM_LOCKING
6706 # endif /* _FFR_USE_SEM_LOCKING */
6709 if (ShmId == SM_SHM_NO_ID || e == NULL)
6711 if (e->e_qgrp == NOQGRP || e->e_qdir == NOQDIR)
6713 idx = Queue[e->e_qgrp]->qg_qpaths[e->e_qdir].qp_idx;
6715 sm_dprintf("func=upd_qs, count=%d, space=%d, where=%s, idx=%d, entries=%d\n",
6716 count, space, where, idx, QSHM_ENTRIES(idx));
6718 /* XXX in theory this needs to be protected with a mutex */
6719 if (QSHM_ENTRIES(idx) >= 0 && count != 0)
6721 # if _FFR_USE_SEM_LOCKING
6722 r = sm_sem_acq(SemId, 0, 1);
6723 # endif /* _FFR_USE_SEM_LOCKING */
6724 QSHM_ENTRIES(idx) += count;
6725 # if _FFR_USE_SEM_LOCKING
6727 r = sm_sem_rel(SemId, 0, 1);
6728 # endif /* _FFR_USE_SEM_LOCKING */
6731 fidx = Queue[e->e_qgrp]->qg_qpaths[e->e_qdir].qp_fsysidx;
6735 /* update available space also? (might be loseqfile) */
6739 /* convert size to blocks; this causes rounding errors */
6740 s = e->e_msgsize / FILE_SYS_BLKSIZE(fidx);
6744 /* XXX in theory this needs to be protected with a mutex */
6746 FILE_SYS_AVAIL(fidx) += s;
6748 FILE_SYS_AVAIL(fidx) -= s;
6752 static bool write_key_file __P((char *, long));
6753 static long read_key_file __P((char *, long));
6756 ** WRITE_KEY_FILE -- record some key into a file.
6759 ** keypath -- file name.
6760 ** key -- key to write.
6763 ** true iff file could be written.
6770 write_key_file(keypath, key)
6779 if (keypath == NULL || *keypath == '\0')
6781 sff = SFF_NOLINK|SFF_ROOTOK|SFF_REGONLY|SFF_CREAT;
6782 if (TrustedUid != 0 && RealUid == TrustedUid)
6783 sff |= SFF_OPENASROOT;
6784 keyf = safefopen(keypath, O_WRONLY|O_TRUNC, FileMode, sff);
6787 sm_syslog(LOG_ERR, NOQID, "unable to write %s: %s",
6788 keypath, sm_errstring(errno));
6792 if (geteuid() == 0 && RunAsUid != 0)
6798 if (fd >= 0 && fchown(fd, RunAsUid, -1) < 0)
6802 sm_syslog(LOG_ALERT, NOQID,
6803 "ownership change on %s to %d failed: %s",
6804 keypath, RunAsUid, sm_errstring(err));
6806 # endif /* HASFCHOWN */
6808 ok = sm_io_fprintf(keyf, SM_TIME_DEFAULT, "%ld\n", key) !=
6810 ok = (sm_io_close(keyf, SM_TIME_DEFAULT) != SM_IO_EOF) && ok;
6816 ** READ_KEY_FILE -- read a key from a file.
6819 ** keypath -- file name.
6820 ** key -- default key.
6827 read_key_file(keypath, key)
6835 if (keypath == NULL || *keypath == '\0')
6837 sff = SFF_NOLINK|SFF_ROOTOK|SFF_REGONLY;
6838 if (RealUid == 0 || (TrustedUid != 0 && RealUid == TrustedUid))
6839 sff |= SFF_OPENASROOT;
6840 keyf = safefopen(keypath, O_RDONLY, FileMode, sff);
6843 sm_syslog(LOG_ERR, NOQID, "unable to read %s: %s",
6844 keypath, sm_errstring(errno));
6848 r = sm_io_fscanf(keyf, SM_TIME_DEFAULT, "%ld", &n);
6851 (void) sm_io_close(keyf, SM_TIME_DEFAULT);
6857 ** INIT_SHM -- initialize shared memory structure
6859 ** Initialize or attach to shared memory segment.
6860 ** Currently it is not a fatal error if this doesn't work.
6861 ** However, it causes us to have a "fallback" storage location
6862 ** for everything that is supposed to be in the shared memory,
6863 ** which makes the code slightly ugly.
6866 ** qn -- number of queue directories.
6867 ** owner -- owner of shared memory.
6868 ** hash -- identifies data that is stored in shared memory.
6874 static void init_shm __P((int, bool, unsigned int));
6877 init_shm(qn, owner, hash)
6887 PtrFileSys = &FileSys[0];
6888 PNumFileSys = &Numfilesys;
6889 /* if this "key" is specified: select one yourself */
6890 #define SEL_SHM_KEY ((key_t) -1)
6891 #define FIRST_SHM_KEY 25
6893 /* This allows us to disable shared memory at runtime. */
6898 shms = SM_T_SIZE + qn * sizeof(QUEUE_SHM_T);
6899 keyselect = ShmKey == SEL_SHM_KEY;
6903 ShmKey = FIRST_SHM_KEY;
6907 ShmKey = read_key_file(ShmKeyFile, ShmKey);
6909 if (ShmKey == SEL_SHM_KEY)
6911 save_errno = (errno != 0) ? errno : EINVAL;
6918 /* allow read/write access for group? */
6919 Pshm = sm_shmstart(ShmKey, shms,
6920 SHM_R|SHM_W|(SHM_R>>3)|(SHM_W>>3),
6923 if (Pshm != NULL || !sm_file_exists(save_errno))
6931 /* back where we started? */
6932 if (ShmKey == SEL_SHM_KEY)
6939 /* only sleep if we are at the first key */
6940 if (!keyselect || ShmKey == SEL_SHM_KEY)
6948 (void) write_key_file(ShmKeyFile, (long) ShmKey);
6949 if (owner && RunAsUid != 0)
6951 i = sm_shmsetowner(ShmId, RunAsUid, RunAsGid, 0660);
6953 sm_syslog(LOG_ERR, NOQID,
6954 "key=%ld, sm_shmsetowner=%d, RunAsUid=%d, RunAsGid=%d",
6955 (long) ShmKey, i, RunAsUid, RunAsGid);
6961 *((pid_t *) SHM_OFF_PID(Pshm)) = CurrentPid;
6962 p = (int *) SHM_OFF_TAG(Pshm);
6967 if (*p != (int) shms)
6969 save_errno = EINVAL;
6973 p = (int *) SHM_OFF_TAG(Pshm);
6974 if (*p != (int) hash)
6976 save_errno = EINVAL;
6982 ** XXX how to check the pid?
6983 ** Read it from the pid-file? That does
6984 ** not need to exist.
6985 ** We could disable shm if we can't confirm
6986 ** that it is the right one.
6990 PtrFileSys = (FILESYS *) OFF_FILE_SYS(Pshm);
6991 PNumFileSys = (int *) OFF_NUM_FILE_SYS(Pshm);
6992 QShm = (QUEUE_SHM_T *) OFF_QUEUE_SHM(Pshm);
6993 PRSATmpCnt = (int *) OFF_RSA_TMP_CNT(Pshm);
6997 /* initialize values in shared memory */
6999 for (i = 0; i < qn; i++)
7000 QShm[i].qs_entries = -1;
7006 if (LogLevel > (owner ? 8 : 11))
7008 sm_syslog(owner ? LOG_ERR : LOG_NOTICE, NOQID,
7009 "can't %s shared memory, key=%ld: %s",
7010 owner ? "initialize" : "attach to",
7011 (long) ShmKey, sm_errstring(save_errno));
7014 #endif /* SM_CONF_SHM */
7018 ** SETUP_QUEUES -- set up all queue groups
7021 ** owner -- owner of shared memory?
7028 ** attaches shared memory.
7029 #endif * SM_CONF_SHM *
7037 unsigned int hashval;
7039 char basedir[MAXPATHLEN];
7043 ** Determine basedir for all queue directories.
7044 ** All queue directories must be (first level) subdirectories
7045 ** of the basedir. The basedir is the QueueDir
7046 ** without wildcards, but with trailing /
7051 len = sm_strlcpy(basedir, QueueDir, sizeof(basedir));
7053 /* Provide space for trailing '/' */
7054 if (len >= sizeof(basedir) - 1)
7056 syserr("QueueDirectory: path too long: %d, max %d",
7057 len, (int) sizeof(basedir) - 1);
7058 ExitStat = EX_CONFIG;
7062 if (basedir[len - 1] == '*')
7066 cp = SM_LAST_DIR_DELIM(basedir);
7069 syserr("QueueDirectory: can not wildcard relative path \"%s\"",
7072 sm_dprintf("setup_queues: \"%s\": Can not wildcard relative path.\n",
7074 ExitStat = EX_CONFIG;
7078 /* cut off wildcard pattern */
7082 else if (!SM_IS_DIR_DELIM(basedir[len - 1]))
7084 /* append trailing slash since it is a directory */
7086 basedir[++len] = '\0';
7089 /* len counts up to the last directory delimiter */
7090 SM_ASSERT(basedir[len - 1] == '/');
7092 if (chdir(basedir) < 0)
7094 int save_errno = errno;
7096 syserr("can not chdir(%s)", basedir);
7097 if (save_errno == EACCES)
7098 (void) sm_io_fprintf(smioerr, SM_TIME_DEFAULT,
7099 "Program mode requires special privileges, e.g., root or TrustedUser.\n");
7101 sm_dprintf("setup_queues: \"%s\": %s\n",
7102 basedir, sm_errstring(errno));
7103 ExitStat = EX_CONFIG;
7107 hashval = hash_q(basedir, hashval);
7108 #endif /* SM_CONF_SHM */
7110 /* initialize for queue runs */
7113 for (i = 0; i < NumQueue && Queue[i] != NULL; i++)
7114 Queue[i]->qg_nextrun = now;
7117 if (UseMSP && OpMode != MD_TEST)
7119 long sff = SFF_CREAT;
7121 if (stat(".", &st) < 0)
7123 syserr("can not stat(%s)", basedir);
7125 sm_dprintf("setup_queues: \"%s\": %s\n",
7126 basedir, sm_errstring(errno));
7127 ExitStat = EX_CONFIG;
7134 ** Check queue directory permissions.
7135 ** Can we write to a group writable queue directory?
7138 if (bitset(S_IWGRP, QueueFileMode) &&
7139 bitset(S_IWGRP, st.st_mode) &&
7140 safefile(" ", RunAsUid, RunAsGid, RunAsUserName, sff,
7141 QueueFileMode, NULL) != 0)
7143 syserr("can not write to queue directory %s (RunAsGid=%d, required=%d)",
7144 basedir, (int) RunAsGid, (int) st.st_gid);
7146 if (bitset(S_IWOTH|S_IXOTH, st.st_mode))
7148 #if _FFR_MSP_PARANOIA
7149 syserr("dangerous permissions=%o on queue directory %s",
7150 (int) st.st_mode, basedir);
7151 #else /* _FFR_MSP_PARANOIA */
7153 sm_syslog(LOG_ERR, NOQID,
7154 "dangerous permissions=%o on queue directory %s",
7155 (int) st.st_mode, basedir);
7156 #endif /* _FFR_MSP_PARANOIA */
7158 #if _FFR_MSP_PARANOIA
7160 syserr("can not use multiple queues for MSP");
7161 #endif /* _FFR_MSP_PARANOIA */
7164 /* initial number of queue directories */
7166 for (i = 0; i < NumQueue && Queue[i] != NULL; i++)
7167 qn = multiqueue_cache(basedir, len, Queue[i], qn, &hashval);
7170 init_shm(qn, owner, hashval);
7171 i = filesys_setup(owner || ShmId == SM_SHM_NO_ID);
7172 if (i == FSF_NOT_FOUND)
7175 ** We didn't get the right filesystem data
7176 ** This may happen if we don't have the right shared memory.
7177 ** So let's do this without shared memory.
7181 cleanup_shm(false); /* release shared memory */
7182 i = filesys_setup(false);
7184 syserr("filesys_setup failed twice, result=%d", i);
7185 else if (LogLevel > 8)
7186 sm_syslog(LOG_WARNING, NOQID,
7187 "shared memory does not contain expected data, ignored");
7189 #else /* SM_CONF_SHM */
7190 i = filesys_setup(true);
7191 #endif /* SM_CONF_SHM */
7193 ExitStat = EX_CONFIG;
7198 ** CLEANUP_SHM -- do some cleanup work for shared memory etc
7201 ** owner -- owner of shared memory?
7207 ** detaches shared memory.
7214 if (ShmId != SM_SHM_NO_ID)
7216 if (sm_shmstop(Pshm, ShmId, owner) < 0 && LogLevel > 8)
7217 sm_syslog(LOG_INFO, NOQID, "sm_shmstop failed=%s",
7218 sm_errstring(errno));
7220 ShmId = SM_SHM_NO_ID;
7224 #endif /* SM_CONF_SHM */
7227 ** CLEANUP_QUEUES -- do some cleanup work for queues
7243 ** SET_DEF_QUEUEVAL -- set default values for a queue group.
7246 ** qg -- queue group
7247 ** all -- set all values (true for default group)?
7253 ** sets default values for the queue group.
7257 set_def_queueval(qg, all)
7261 if (bitnset(QD_DEFINED, qg->qg_flags))
7264 qg->qg_qdir = QueueDir;
7265 #if _FFR_QUEUE_GROUP_SORTORDER
7266 qg->qg_sortorder = QueueSortOrder;
7267 #endif /* _FFR_QUEUE_GROUP_SORTORDER */
7268 qg->qg_maxqrun = all ? MaxRunnersPerQueue : -1;
7269 qg->qg_nice = NiceQueueRun;
7272 ** MAKEQUEUE -- define a new queue.
7275 ** line -- description of queue. This is in labeled fields.
7277 ** F -- the flags associated with the queue
7278 ** I -- the interval between running the queue
7279 ** J -- the maximum # of jobs in work list
7280 ** [M -- the maximum # of jobs in a queue run]
7281 ** N -- the niceness at which to run
7282 ** P -- the path to the queue
7283 ** S -- the queue sorting order
7284 ** R -- number of parallel queue runners
7285 ** r -- max recipients per envelope
7286 ** The first word is the canonical name of the queue.
7287 ** qdef -- this is a 'Q' definition from .cf
7293 ** enters the queue into the queue table.
7297 makequeue(line, qdef)
7302 register QUEUEGRP *qg;
7307 /* allocate a queue and set up defaults */
7308 qg = (QUEUEGRP *) xalloc(sizeof(*qg));
7309 memset((char *) qg, '\0', sizeof(*qg));
7311 if (line[0] == '\0')
7313 syserr("name required for queue");
7317 /* collect the queue name */
7319 *p != '\0' && *p != ',' && !(isascii(*p) && isspace(*p));
7324 qg->qg_name = newstr(line);
7326 /* set default values, can be overridden below */
7327 set_def_queueval(qg, false);
7329 /* now scan through and assign info from the fields */
7332 auto char *delimptr;
7334 while (*p != '\0' &&
7335 (*p == ',' || (isascii(*p) && isspace(*p))))
7338 /* p now points to field code */
7340 while (*p != '\0' && *p != '=' && *p != ',')
7344 syserr("queue %s: `=' expected", qg->qg_name);
7347 while (isascii(*p) && isspace(*p))
7350 /* p now points to the field body */
7351 p = munchstring(p, &delimptr, ',');
7353 /* install the field into the queue struct */
7356 case 'P': /* pathname */
7358 syserr("queue %s: empty path name",
7361 qg->qg_qdir = newstr(p);
7364 case 'F': /* flags */
7365 for (; *p != '\0'; p++)
7366 if (!(isascii(*p) && isspace(*p)))
7367 setbitn(*p, qg->qg_flags);
7371 ** Do we need two intervals here:
7372 ** One for persistent queue runners,
7373 ** one for "normal" queue runs?
7376 case 'I': /* interval between running the queue */
7377 qg->qg_queueintvl = convtime(p, 'm');
7380 case 'N': /* run niceness */
7381 qg->qg_nice = atoi(p);
7384 case 'R': /* maximum # of runners for the group */
7387 /* can't have more runners than allowed total */
7388 if (MaxQueueChildren > 0 && i > MaxQueueChildren)
7390 qg->qg_maxqrun = MaxQueueChildren;
7391 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
7392 "Q=%s: R=%d exceeds MaxQueueChildren=%d, set to MaxQueueChildren\n",
7400 case 'J': /* maximum # of jobs in work list */
7401 qg->qg_maxlist = atoi(p);
7404 case 'r': /* max recipients per envelope */
7405 qg->qg_maxrcpt = atoi(p);
7408 #if _FFR_QUEUE_GROUP_SORTORDER
7409 case 'S': /* queue sorting order */
7412 case 'h': /* Host first */
7414 qg->qg_sortorder = QSO_BYHOST;
7417 case 'p': /* Priority order */
7419 qg->qg_sortorder = QSO_BYPRIORITY;
7422 case 't': /* Submission time */
7424 qg->qg_sortorder = QSO_BYTIME;
7427 case 'f': /* File name */
7429 qg->qg_sortorder = QSO_BYFILENAME;
7432 case 'm': /* Modification time */
7434 qg->qg_sortorder = QSO_BYMODTIME;
7437 case 'r': /* Random */
7439 qg->qg_sortorder = QSO_RANDOM;
7443 case 's': /* Shuffled host name */
7445 qg->qg_sortorder = QSO_BYSHUFFLE;
7447 # endif /* _FFR_RHS */
7449 case 'n': /* none */
7451 qg->qg_sortorder = QSO_NONE;
7455 syserr("Invalid queue sort order \"%s\"", p);
7458 #endif /* _FFR_QUEUE_GROUP_SORTORDER */
7461 syserr("Q%s: unknown queue equate %c=",
7462 qg->qg_name, fcode);
7470 if (qg->qg_nice != NiceQueueRun)
7472 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
7473 "Q%s: Warning: N= set on system that doesn't support nice()\n",
7476 #endif /* !HASNICE */
7478 /* do some rationality checking */
7479 if (NumQueue >= MAXQUEUEGROUPS)
7481 syserr("too many queue groups defined (%d max)",
7486 if (qg->qg_qdir == NULL)
7488 if (QueueDir == NULL || *QueueDir == '\0')
7490 syserr("QueueDir must be defined before queue groups");
7493 qg->qg_qdir = newstr(QueueDir);
7496 if (qg->qg_maxqrun > 1 && !bitnset(QD_FORK, qg->qg_flags))
7498 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
7499 "Warning: Q=%s: R=%d: multiple queue runners specified\n\tbut flag '%c' is not set\n",
7500 qg->qg_name, qg->qg_maxqrun, QD_FORK);
7503 /* enter the queue into the symbol table */
7505 sm_syslog(LOG_INFO, NOQID,
7506 "Adding %s to stab, path: %s", qg->qg_name,
7508 s = stab(qg->qg_name, ST_QUEUE, ST_ENTER);
7509 if (s->s_quegrp != NULL)
7511 i = s->s_quegrp->qg_index;
7513 /* XXX what about the pointers inside this struct? */
7514 sm_free(s->s_quegrp); /* XXX */
7518 Queue[i] = s->s_quegrp = qg;
7521 /* set default value for max queue runners */
7522 if (qg->qg_maxqrun < 0)
7524 if (MaxRunnersPerQueue > 0)
7525 qg->qg_maxqrun = MaxRunnersPerQueue;
7530 setbitn(QD_DEFINED, qg->qg_flags);
7534 ** HASHFQN -- calculate a hash value for a fully qualified host name
7537 ** fqn -- an all lower-case host.domain string
7538 ** buckets -- the number of buckets (queue directories)
7541 ** a bucket number (signed integer)
7544 ** Contributed by Exactis.com, Inc.
7548 hashfqn(fqn, buckets)
7553 register int h = 0, hash, cnt;
7559 ** A variation on the gdb hash
7560 ** This is the best as of Feb 19, 1996 --bcx
7564 h = 0x238F13AF * strlen(p);
7565 for (cnt = 0; *p != 0; ++p, cnt++)
7567 h = (h + (*p << (cnt * 5 % 24))) & 0x7FFFFFFF;
7569 h = (1103515243 * h + 12345) & 0x7FFFFFFF;
7573 hash = (h % buckets);
7580 ** A structure for sorting Queue according to maxqrun without
7581 ** screwing up Queue itself.
7586 int sg_idx; /* original index */
7587 int sg_maxqrun; /* max queue runners */
7589 typedef struct sortqgrp SORTQGRP_T;
7590 static int cmpidx __P((const void *, const void *));
7597 /* The sort is highest to lowest, so the comparison is reversed */
7598 if (((SORTQGRP_T *)a)->sg_maxqrun < ((SORTQGRP_T *)b)->sg_maxqrun)
7600 else if (((SORTQGRP_T *)a)->sg_maxqrun > ((SORTQGRP_T *)b)->sg_maxqrun)
7607 ** MAKEWORKGROUP -- balance queue groups into work groups per MaxQueueChildren
7609 ** Take the now defined queue groups and assign them to work groups.
7610 ** This is done to balance out the number of concurrently active
7611 ** queue runners such that MaxQueueChildren is not exceeded. This may
7612 ** result in more than one queue group per work group. In such a case
7613 ** the number of running queue groups in that work group will have no
7614 ** more than the work group maximum number of runners (a "fair" portion
7615 ** of MaxQueueRunners). All queue groups within a work group will get a
7616 ** chance at running.
7625 ** Sets up WorkGrp structure.
7631 int i, j, total_runners, dir, h;
7632 SORTQGRP_T si[MAXQUEUEGROUPS + 1];
7635 if (NumQueue == 1 && strcmp(Queue[0]->qg_name, "mqueue") == 0)
7638 ** There is only the "mqueue" queue group (a default)
7639 ** containing all of the queues. We want to provide to
7640 ** this queue group the maximum allowable queue runners.
7641 ** To match older behavior (8.10/8.11) we'll try for
7642 ** 1 runner per queue capping it at MaxQueueChildren.
7643 ** So if there are N queues, then there will be N runners
7644 ** for the "mqueue" queue group (where N is kept less than
7645 ** MaxQueueChildren).
7649 WorkGrp[0].wg_numqgrp = 1;
7650 WorkGrp[0].wg_qgs = (QUEUEGRP **) xalloc(sizeof(QUEUEGRP *));
7651 WorkGrp[0].wg_qgs[0] = Queue[0];
7652 if (MaxQueueChildren > 0 &&
7653 Queue[0]->qg_numqueues > MaxQueueChildren)
7654 WorkGrp[0].wg_runners = MaxQueueChildren;
7656 WorkGrp[0].wg_runners = Queue[0]->qg_numqueues;
7658 Queue[0]->qg_wgrp = 0;
7660 /* can't have more runners than allowed total */
7661 if (MaxQueueChildren > 0 &&
7662 Queue[0]->qg_maxqrun > MaxQueueChildren)
7663 Queue[0]->qg_maxqrun = MaxQueueChildren;
7664 WorkGrp[0].wg_maxact = Queue[0]->qg_maxqrun;
7665 WorkGrp[0].wg_lowqintvl = Queue[0]->qg_queueintvl;
7669 for (i = 0; i < NumQueue; i++)
7671 si[i].sg_maxqrun = Queue[i]->qg_maxqrun;
7674 qsort(si, NumQueue, sizeof(si[0]), cmpidx);
7677 for (i = 0; i < NumQueue; i++)
7679 total_runners += si[i].sg_maxqrun;
7680 if (MaxQueueChildren <= 0 || total_runners <= MaxQueueChildren)
7686 if (NumWorkGroups < 1)
7687 NumWorkGroups = 1; /* gotta have one at least */
7688 else if (NumWorkGroups > MAXWORKGROUPS)
7689 NumWorkGroups = MAXWORKGROUPS; /* the limit */
7692 ** We now know the number of work groups to pack the queue groups
7693 ** into. The queue groups in 'Queue' are sorted from highest
7694 ** to lowest for the number of runners per queue group.
7695 ** We put the queue groups with the largest number of runners
7696 ** into work groups first. Then the smaller ones are fitted in
7697 ** where it looks best.
7702 for (i = 0; i < NumQueue; i++)
7704 /* a to-and-fro packing scheme, continue from last position */
7705 if (j >= NumWorkGroups)
7708 j = NumWorkGroups - 1;
7716 if (WorkGrp[j].wg_qgs == NULL)
7717 WorkGrp[j].wg_qgs = (QUEUEGRP **)sm_malloc(sizeof(QUEUEGRP *) *
7718 (WorkGrp[j].wg_numqgrp + 1));
7720 WorkGrp[j].wg_qgs = (QUEUEGRP **)sm_realloc(WorkGrp[j].wg_qgs,
7721 sizeof(QUEUEGRP *) *
7722 (WorkGrp[j].wg_numqgrp + 1));
7723 if (WorkGrp[j].wg_qgs == NULL)
7725 syserr("!cannot allocate memory for work queues, need %d bytes",
7726 (int) (sizeof(QUEUEGRP *) *
7727 (WorkGrp[j].wg_numqgrp + 1)));
7731 WorkGrp[j].wg_qgs[WorkGrp[j].wg_numqgrp] = Queue[h];
7732 WorkGrp[j].wg_numqgrp++;
7733 WorkGrp[j].wg_runners += Queue[h]->qg_maxqrun;
7734 Queue[h]->qg_wgrp = j;
7736 if (WorkGrp[j].wg_maxact == 0)
7738 /* can't have more runners than allowed total */
7739 if (MaxQueueChildren > 0 &&
7740 Queue[h]->qg_maxqrun > MaxQueueChildren)
7741 Queue[h]->qg_maxqrun = MaxQueueChildren;
7742 WorkGrp[j].wg_maxact = Queue[h]->qg_maxqrun;
7746 ** XXX: must wg_lowqintvl be the GCD?
7747 ** qg1: 2m, qg2: 3m, minimum: 2m, when do queue runs for
7751 /* keep track of the lowest interval for a persistent runner */
7752 if (Queue[h]->qg_queueintvl > 0 &&
7753 WorkGrp[j].wg_lowqintvl < Queue[h]->qg_queueintvl)
7754 WorkGrp[j].wg_lowqintvl = Queue[h]->qg_queueintvl;
7759 for (i = 0; i < NumWorkGroups; i++)
7761 sm_dprintf("Workgroup[%d]=", i);
7762 for (j = 0; j < WorkGrp[i].wg_numqgrp; j++)
7765 WorkGrp[i].wg_qgs[j]->qg_name);
7773 ** DUP_DF -- duplicate envelope data file
7775 ** Copy the data file from the 'old' envelope to the 'new' envelope
7776 ** in the most efficient way possible.
7778 ** Create a hard link from the 'old' data file to the 'new' data file.
7779 ** If the old and new queue directories are on different file systems,
7780 ** then the new data file link is created in the old queue directory,
7781 ** and the new queue file will contain a 'd' record pointing to the
7782 ** directory containing the new data file.
7785 ** old -- old envelope.
7786 ** new -- new envelope.
7789 ** Returns true on success, false on failure.
7792 ** On success, the new data file is created.
7793 ** On fatal failure, EF_FATALERRS is set in old->e_flags.
7796 static bool dup_df __P((ENVELOPE *, ENVELOPE *));
7804 char opath[MAXPATHLEN];
7805 char npath[MAXPATHLEN];
7807 if (!bitset(EF_HAS_DF, old->e_flags))
7810 ** this can happen if: SuperSafe != True
7811 ** and a bounce mail is sent that is split.
7814 queueup(old, false, true);
7816 SM_REQUIRE(ISVALIDQGRP(old->e_qgrp) && ISVALIDQDIR(old->e_qdir));
7817 SM_REQUIRE(ISVALIDQGRP(new->e_qgrp) && ISVALIDQDIR(new->e_qdir));
7819 (void) sm_strlcpy(opath, queuename(old, DATAFL_LETTER), sizeof(opath));
7820 (void) sm_strlcpy(npath, queuename(new, DATAFL_LETTER), sizeof(npath));
7822 if (old->e_dfp != NULL)
7824 r = sm_io_setinfo(old->e_dfp, SM_BF_COMMIT, NULL);
7825 if (r < 0 && errno != EINVAL)
7827 syserr("@can't commit %s", opath);
7828 old->e_flags |= EF_FATALERRS;
7834 ** Attempt to create a hard link, if we think both old and new
7835 ** are on the same file system, otherwise copy the file.
7837 ** Don't waste time attempting a hard link unless old and new
7838 ** are on the same file system.
7841 SM_REQUIRE(ISVALIDQGRP(old->e_dfqgrp) && ISVALIDQDIR(old->e_dfqdir));
7842 SM_REQUIRE(ISVALIDQGRP(new->e_dfqgrp) && ISVALIDQDIR(new->e_dfqdir));
7844 ofs = Queue[old->e_dfqgrp]->qg_qpaths[old->e_dfqdir].qp_fsysidx;
7845 nfs = Queue[new->e_dfqgrp]->qg_qpaths[new->e_dfqdir].qp_fsysidx;
7846 if (FILE_SYS_DEV(ofs) == FILE_SYS_DEV(nfs))
7848 if (link(opath, npath) == 0)
7850 new->e_flags |= EF_HAS_DF;
7851 SYNC_DIR(npath, true);
7858 ** Can't link across queue directories, so try to create a hard
7859 ** link in the same queue directory as the old df file.
7860 ** The qf file will refer to the new df file using a 'd' record.
7863 new->e_dfqgrp = old->e_dfqgrp;
7864 new->e_dfqdir = old->e_dfqdir;
7865 (void) sm_strlcpy(npath, queuename(new, DATAFL_LETTER), sizeof(npath));
7866 if (link(opath, npath) == 0)
7868 new->e_flags |= EF_HAS_DF;
7869 SYNC_DIR(npath, true);
7875 sm_syslog(LOG_ERR, old->e_id,
7876 "dup_df: can't link %s to %s, error=%s, envelope splitting failed",
7877 opath, npath, sm_errstring(errno));
7882 ** SPLIT_ENV -- Allocate a new envelope based on a given envelope.
7886 ** sendqueue -- sendqueue for new envelope.
7887 ** qgrp -- index of queue group.
7888 ** qdir -- queue directory.
7895 static ENVELOPE *split_env __P((ENVELOPE *, ADDRESS *, int, int));
7898 split_env(e, sendqueue, qgrp, qdir)
7906 ee = (ENVELOPE *) sm_rpool_malloc_x(e->e_rpool, sizeof(*ee));
7907 STRUCTCOPY(*e, *ee);
7908 ee->e_message = NULL; /* XXX use original message? */
7911 ee->e_sendqueue = sendqueue;
7912 ee->e_flags &= ~(EF_INQUEUE|EF_CLRQUEUE|EF_FATALERRS
7913 |EF_SENDRECEIPT|EF_RET_PARAM|EF_HAS_DF);
7914 ee->e_flags |= EF_NORECEIPT; /* XXX really? */
7915 ee->e_from.q_state = QS_SENDER;
7917 ee->e_lockfp = NULL;
7918 if (e->e_xfp != NULL)
7919 ee->e_xfp = sm_io_dup(e->e_xfp);
7921 /* failed to dup e->e_xfp, start a new transcript */
7922 if (ee->e_xfp == NULL)
7925 ee->e_qgrp = ee->e_dfqgrp = qgrp;
7926 ee->e_qdir = ee->e_dfqdir = qdir;
7927 ee->e_errormode = EM_MAIL;
7928 ee->e_statmsg = NULL;
7929 if (e->e_quarmsg != NULL)
7930 ee->e_quarmsg = sm_rpool_strdup_x(ee->e_rpool,
7934 ** XXX Not sure if this copying is necessary.
7935 ** sendall() does this copying, but I (dm) don't know if that is
7936 ** because of the storage management discipline we were using
7937 ** before rpools were introduced, or if it is because these lists
7938 ** can be modified later.
7941 ee->e_header = copyheader(e->e_header, ee->e_rpool);
7942 ee->e_errorqueue = copyqueue(e->e_errorqueue, ee->e_rpool);
7947 /* return values from split functions, check also below! */
7948 #define SM_SPLIT_FAIL (0)
7949 #define SM_SPLIT_NONE (1)
7950 #define SM_SPLIT_NEW(n) (1 + (n))
7953 ** SPLIT_ACROSS_QUEUE_GROUPS
7955 ** This function splits an envelope across multiple queue groups
7956 ** based on the queue group of each recipient.
7962 ** SM_SPLIT_FAIL on failure
7963 ** SM_SPLIT_NONE if no splitting occurred,
7964 ** or 1 + the number of additional envelopes created.
7967 ** On success, e->e_sibling points to a list of zero or more
7968 ** additional envelopes, and the associated data files exist
7969 ** on disk. But the queue files are not created.
7971 ** On failure, e->e_sibling is not changed.
7972 ** The order of recipients in e->e_sendqueue is permuted.
7973 ** Abandoned data files for additional envelopes that failed
7974 ** to be created may exist on disk.
7977 static int q_qgrp_compare __P((const void *, const void *));
7978 static int e_filesys_compare __P((const void *, const void *));
7981 q_qgrp_compare(p1, p2)
7985 ADDRESS **pq1 = (ADDRESS **) p1;
7986 ADDRESS **pq2 = (ADDRESS **) p2;
7988 return (*pq1)->q_qgrp - (*pq2)->q_qgrp;
7992 e_filesys_compare(p1, p2)
7996 ENVELOPE **pe1 = (ENVELOPE **) p1;
7997 ENVELOPE **pe2 = (ENVELOPE **) p2;
8000 fs1 = Queue[(*pe1)->e_qgrp]->qg_qpaths[(*pe1)->e_qdir].qp_fsysidx;
8001 fs2 = Queue[(*pe2)->e_qgrp]->qg_qpaths[(*pe2)->e_qdir].qp_fsysidx;
8002 if (FILE_SYS_DEV(fs1) < FILE_SYS_DEV(fs2))
8004 if (FILE_SYS_DEV(fs1) > FILE_SYS_DEV(fs2))
8009 static int split_across_queue_groups __P((ENVELOPE *));
8011 split_across_queue_groups(e)
8014 int naddrs, nsplits, i;
8017 ADDRESS *q, **addrs;
8019 ENVELOPE *splits[MAXQUEUEGROUPS];
8020 char pvpbuf[PSBUFSIZE];
8022 SM_REQUIRE(ISVALIDQGRP(e->e_qgrp));
8024 /* Count addresses and assign queue groups. */
8027 for (q = e->e_sendqueue; q != NULL; q = q->q_next)
8029 if (QS_IS_DEAD(q->q_state))
8033 /* bad addresses and those already sent stay put */
8034 if (QS_IS_BADADDR(q->q_state) ||
8035 QS_IS_SENT(q->q_state))
8036 q->q_qgrp = e->e_qgrp;
8037 else if (!ISVALIDQGRP(q->q_qgrp))
8039 /* call ruleset which should return a queue group */
8040 i = rscap(RS_QUEUEGROUP, q->q_user, NULL, e, &pvp,
8041 pvpbuf, sizeof(pvpbuf));
8043 pvp != NULL && pvp[0] != NULL &&
8044 (pvp[0][0] & 0377) == CANONNET &&
8045 pvp[1] != NULL && pvp[1][0] != '\0')
8047 i = name2qid(pvp[1]);
8053 sm_syslog(LOG_INFO, NOQID,
8054 "queue group name %s -> %d",
8058 else if (LogLevel > 10)
8059 sm_syslog(LOG_INFO, NOQID,
8060 "can't find queue group name %s, selection ignored",
8063 if (q->q_mailer != NULL &&
8064 ISVALIDQGRP(q->q_mailer->m_qgrp))
8067 q->q_qgrp = q->q_mailer->m_qgrp;
8069 else if (ISVALIDQGRP(e->e_qgrp))
8070 q->q_qgrp = e->e_qgrp;
8076 /* only one address? nothing to split. */
8077 if (naddrs <= 1 && !changed)
8078 return SM_SPLIT_NONE;
8080 /* sort the addresses by queue group */
8081 addrs = sm_rpool_malloc_x(e->e_rpool, naddrs * sizeof(ADDRESS *));
8082 for (i = 0, q = e->e_sendqueue; q != NULL; q = q->q_next)
8084 if (QS_IS_DEAD(q->q_state))
8088 qsort(addrs, naddrs, sizeof(ADDRESS *), q_qgrp_compare);
8090 /* split into multiple envelopes, by queue group */
8093 e->e_sendqueue = NULL;
8094 for (i = 0; i < naddrs; ++i)
8096 if (i == naddrs - 1 || addrs[i]->q_qgrp != addrs[i + 1]->q_qgrp)
8097 addrs[i]->q_next = NULL;
8099 addrs[i]->q_next = addrs[i + 1];
8101 /* same queue group as original envelope? */
8102 if (addrs[i]->q_qgrp == e->e_qgrp)
8104 if (e->e_sendqueue == NULL)
8105 e->e_sendqueue = addrs[i];
8109 /* different queue group than original envelope */
8110 if (es == NULL || addrs[i]->q_qgrp != es->e_qgrp)
8112 ee = split_env(e, addrs[i], addrs[i]->q_qgrp, NOQDIR);
8114 splits[nsplits++] = ee;
8118 /* no splits? return right now. */
8120 return SM_SPLIT_NONE;
8122 /* assign a queue directory to each additional envelope */
8123 for (i = 0; i < nsplits; ++i)
8127 es->e_qdir = pickqdir(Queue[es->e_qgrp], es->e_msgsize, es);
8129 if (!setnewqueue(es))
8133 /* sort the additional envelopes by queue file system */
8134 qsort(splits, nsplits, sizeof(ENVELOPE *), e_filesys_compare);
8136 /* create data files for each additional envelope */
8137 if (!dup_df(e, splits[0]))
8142 for (i = 1; i < nsplits; ++i)
8144 /* copy or link to the previous data file */
8145 if (!dup_df(splits[i - 1], splits[i]))
8149 /* success: prepend the new envelopes to the e->e_sibling list */
8150 for (i = 0; i < nsplits; ++i)
8153 es->e_sibling = e->e_sibling;
8156 return SM_SPLIT_NEW(nsplits);
8158 /* failure: clean up */
8164 for (j = 0; j < i; j++)
8165 (void) unlink(queuename(splits[j], DATAFL_LETTER));
8167 e->e_sendqueue = addrs[0];
8168 for (i = 0; i < naddrs - 1; ++i)
8169 addrs[i]->q_next = addrs[i + 1];
8170 addrs[naddrs - 1]->q_next = NULL;
8171 return SM_SPLIT_FAIL;
8175 ** SPLIT_WITHIN_QUEUE
8177 ** Split an envelope with multiple recipients into several
8178 ** envelopes within the same queue directory, if the number of
8179 ** recipients exceeds the limit for the queue group.
8185 ** SM_SPLIT_FAIL on failure
8186 ** SM_SPLIT_NONE if no splitting occurred,
8187 ** or 1 + the number of additional envelopes created.
8190 #define SPLIT_LOG_LEVEL 8
8192 static int split_within_queue __P((ENVELOPE *));
8195 split_within_queue(e)
8198 int maxrcpt, nrcpt, ndead, nsplit, i;
8201 ADDRESS *q, **addrs;
8202 ENVELOPE *ee, *firstsibling;
8204 if (!ISVALIDQGRP(e->e_qgrp) || bitset(EF_SPLIT, e->e_flags))
8205 return SM_SPLIT_NONE;
8207 /* don't bother if there is no recipient limit */
8208 maxrcpt = Queue[e->e_qgrp]->qg_maxrcpt;
8210 return SM_SPLIT_NONE;
8212 /* count recipients */
8214 for (q = e->e_sendqueue; q != NULL; q = q->q_next)
8216 if (QS_IS_DEAD(q->q_state))
8220 if (nrcpt <= maxrcpt)
8221 return SM_SPLIT_NONE;
8224 ** Preserve the recipient list
8225 ** so that we can restore it in case of error.
8226 ** (But we discard dead addresses.)
8229 addrs = sm_rpool_malloc_x(e->e_rpool, nrcpt * sizeof(ADDRESS *));
8230 for (i = 0, q = e->e_sendqueue; q != NULL; q = q->q_next)
8232 if (QS_IS_DEAD(q->q_state))
8238 ** Partition the recipient list so that bad and sent addresses
8239 ** come first. These will go with the original envelope, and
8240 ** do not count towards the maxrcpt limit.
8241 ** addrs[] does not contain QS_IS_DEAD() addresses.
8245 for (i = 0; i < nrcpt; ++i)
8247 if (QS_IS_BADADDR(addrs[i]->q_state) ||
8248 QS_IS_SENT(addrs[i]->q_state) ||
8249 QS_IS_DEAD(addrs[i]->q_state)) /* for paranoia's sake */
8253 ADDRESS *tmp = addrs[i];
8255 addrs[i] = addrs[ndead];
8262 /* Check if no splitting required. */
8263 if (nrcpt - ndead <= maxrcpt)
8264 return SM_SPLIT_NONE;
8267 for (i = 0; i < nrcpt - 1; ++i)
8268 addrs[i]->q_next = addrs[i + 1];
8269 addrs[nrcpt - 1]->q_next = NULL;
8270 e->e_sendqueue = addrs[0];
8272 /* prepare buffer for logging */
8273 if (LogLevel > SPLIT_LOG_LEVEL)
8276 lsplits = sm_malloc(l);
8277 if (lsplits != NULL)
8283 /* get rid of stupid compiler warnings */
8288 /* split the envelope */
8289 firstsibling = e->e_sibling;
8290 i = maxrcpt + ndead;
8294 addrs[i - 1]->q_next = NULL;
8295 ee = split_env(e, addrs[i], e->e_qgrp, e->e_qdir);
8302 (void) unlink(queuename(ee, DATAFL_LETTER));
8306 /* Error. Restore e's sibling & recipient lists. */
8307 e->e_sibling = firstsibling;
8308 for (i = 0; i < nrcpt - 1; ++i)
8309 addrs[i]->q_next = addrs[i + 1];
8310 if (lsplits != NULL)
8312 return SM_SPLIT_FAIL;
8315 /* prepend the new envelope to e->e_sibling */
8316 ee->e_sibling = e->e_sibling;
8319 if (LogLevel > SPLIT_LOG_LEVEL && lsplits != NULL)
8321 if (j >= l - strlen(ee->e_id) - 3)
8326 p = sm_realloc(lsplits, l);
8329 /* let's try to get this done */
8336 if (lsplits != NULL)
8339 j += sm_strlcat(lsplits + j,
8343 j += sm_strlcat2(lsplits + j,
8350 if (nrcpt - i <= maxrcpt)
8354 if (LogLevel > SPLIT_LOG_LEVEL && lsplits != NULL)
8358 sm_syslog(LOG_NOTICE, e->e_id,
8359 "split: maxrcpts=%d, rcpts=%d, count=%d, id%s=%s",
8360 maxrcpt, nrcpt - ndead, nsplit,
8361 nsplit > 1 ? "s" : "", lsplits);
8365 return SM_SPLIT_NEW(nsplit);
8368 ** SPLIT_BY_RECIPIENT
8370 ** Split an envelope with multiple recipients into multiple
8371 ** envelopes as required by the sendmail configuration.
8377 ** Returns true on success, false on failure.
8380 ** see split_across_queue_groups(), split_within_queue(e)
8384 split_by_recipient(e)
8387 int split, n, i, j, l;
8389 ENVELOPE *ee, *next, *firstsibling;
8391 if (OpMode == SM_VERIFY || !ISVALIDQGRP(e->e_qgrp) ||
8392 bitset(EF_SPLIT, e->e_flags))
8394 n = split_across_queue_groups(e);
8395 if (n == SM_SPLIT_FAIL)
8397 firstsibling = ee = e->e_sibling;
8398 if (n > 1 && LogLevel > SPLIT_LOG_LEVEL)
8401 lsplits = sm_malloc(l);
8402 if (lsplits != NULL)
8408 /* get rid of stupid compiler warnings */
8412 for (i = 1; i < n; ++i)
8414 next = ee->e_sibling;
8415 if (split_within_queue(ee) == SM_SPLIT_FAIL)
8417 e->e_sibling = firstsibling;
8420 ee->e_flags |= EF_SPLIT;
8421 if (LogLevel > SPLIT_LOG_LEVEL && lsplits != NULL)
8423 if (j >= l - strlen(ee->e_id) - 3)
8428 p = sm_realloc(lsplits, l);
8431 /* let's try to get this done */
8438 if (lsplits != NULL)
8441 j += sm_strlcat(lsplits + j,
8444 j += sm_strlcat2(lsplits + j, "; ",
8451 if (LogLevel > SPLIT_LOG_LEVEL && lsplits != NULL && n > 1)
8453 sm_syslog(LOG_NOTICE, e->e_id, "split: count=%d, id%s=%s",
8454 n - 1, n > 2 ? "s" : "", lsplits);
8457 split = split_within_queue(e) != SM_SPLIT_FAIL;
8459 e->e_flags |= EF_SPLIT;
8464 ** QUARANTINE_QUEUE_ITEM -- {un,}quarantine a single envelope
8466 ** Add/remove quarantine reason and requeue appropriately.
8469 ** qgrp -- queue group for the item
8470 ** qdir -- queue directory in the given queue group
8471 ** e -- envelope information for the item
8472 ** reason -- quarantine reason, NULL means unquarantine.
8475 ** true if item changed, false otherwise
8478 ** Changes quarantine tag in queue file and renames it.
8482 quarantine_queue_item(qgrp, qdir, e, reason)
8489 bool failing = false;
8490 bool foundq = false;
8491 bool finished = false;
8497 MODE_T oldumask = 0;
8498 SM_FILE_T *oldqfp, *tempqfp;
8501 char oldqf[MAXPATHLEN];
8502 char tempqf[MAXPATHLEN];
8503 char newqf[MAXPATHLEN];
8506 oldtype = queue_letter(e, ANYQFL_LETTER);
8507 (void) sm_strlcpy(oldqf, queuename(e, ANYQFL_LETTER), sizeof(oldqf));
8508 (void) sm_strlcpy(tempqf, queuename(e, NEWQFL_LETTER), sizeof(tempqf));
8511 ** Instead of duplicating all the open
8512 ** and lock code here, tell readqf() to
8513 ** do that work and return the open
8514 ** file pointer in e_lockfp. Note that
8515 ** we must release the locks properly when
8519 if (!readqf(e, true))
8521 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8522 "Skipping %s\n", qid_printname(e));
8525 oldqfp = e->e_lockfp;
8527 /* open the new queue file */
8528 flags = O_CREAT|O_WRONLY|O_EXCL;
8529 if (bitset(S_IWGRP, QueueFileMode))
8530 oldumask = umask(002);
8531 fd = open(tempqf, flags, QueueFileMode);
8532 if (bitset(S_IWGRP, QueueFileMode))
8533 (void) umask(oldumask);
8539 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8540 "Skipping %s: Could not open %s: %s\n",
8541 qid_printname(e), tempqf,
8542 sm_errstring(save_errno));
8543 (void) sm_io_close(oldqfp, SM_TIME_DEFAULT);
8546 if (!lockfile(fd, tempqf, NULL, LOCK_EX|LOCK_NB))
8548 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8549 "Skipping %s: Could not lock %s\n",
8550 qid_printname(e), tempqf);
8552 (void) sm_io_close(oldqfp, SM_TIME_DEFAULT);
8556 tempqfp = sm_io_open(SmFtStdiofd, SM_TIME_DEFAULT, (void *) &fd,
8557 SM_IO_WRONLY_B, NULL);
8558 if (tempqfp == NULL)
8560 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8561 "Skipping %s: Could not lock %s\n",
8562 qid_printname(e), tempqf);
8564 (void) sm_io_close(oldqfp, SM_TIME_DEFAULT);
8568 /* Copy the data over, changing the quarantine reason */
8569 while (bufsize = sizeof(buf),
8570 (bp = fgetfolded(buf, &bufsize, oldqfp)) != NULL)
8573 sm_dprintf("+++++ %s\n", bp);
8576 case 'q': /* quarantine reason */
8582 (void) sm_io_fprintf(smioout,
8584 "%s: Removed quarantine of \"%s\"\n",
8587 sm_syslog(LOG_INFO, e->e_id, "unquarantine");
8590 else if (strcmp(reason, &bp[1]) == 0)
8594 (void) sm_io_fprintf(smioout,
8596 "%s: Already quarantined with \"%s\"\n",
8599 (void) sm_io_fprintf(tempqfp, SM_TIME_DEFAULT,
8606 (void) sm_io_fprintf(smioout,
8608 "%s: Quarantine changed from \"%s\" to \"%s\"\n",
8612 (void) sm_io_fprintf(tempqfp, SM_TIME_DEFAULT,
8614 sm_syslog(LOG_INFO, e->e_id, "quarantine=%s",
8622 ** If we are quarantining an unquarantined item,
8623 ** need to put in a new 'q' line before it's
8627 if (!foundq && reason != NULL)
8631 (void) sm_io_fprintf(smioout,
8633 "%s: Quarantined with \"%s\"\n",
8636 (void) sm_io_fprintf(tempqfp, SM_TIME_DEFAULT,
8638 sm_syslog(LOG_INFO, e->e_id, "quarantine=%s",
8644 /* Copy the line to the new file */
8645 (void) sm_io_fprintf(tempqfp, SM_TIME_DEFAULT,
8654 /* Copy the line to the new file */
8655 (void) sm_io_fprintf(tempqfp, SM_TIME_DEFAULT,
8663 /* Make sure we read the whole old file */
8664 errno = sm_io_error(tempqfp);
8665 if (errno != 0 && errno != SM_IO_EOF)
8668 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8669 "Skipping %s: Error reading %s: %s\n",
8670 qid_printname(e), oldqf,
8671 sm_errstring(save_errno));
8675 if (!failing && !finished)
8677 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8678 "Skipping %s: Incomplete file: %s\n",
8679 qid_printname(e), oldqf);
8683 /* Check if we actually changed anything or we can just bail now */
8686 /* pretend we failed, even though we technically didn't */
8690 /* Make sure we wrote things out safely */
8692 (sm_io_flush(tempqfp, SM_TIME_DEFAULT) != 0 ||
8693 ((SuperSafe == SAFE_REALLY ||
8694 SuperSafe == SAFE_REALLY_POSTMILTER ||
8695 SuperSafe == SAFE_INTERACTIVE) &&
8696 fsync(sm_io_getinfo(tempqfp, SM_IO_WHAT_FD, NULL)) < 0) ||
8697 ((errno = sm_io_error(tempqfp)) != 0)))
8700 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8701 "Skipping %s: Error writing %s: %s\n",
8702 qid_printname(e), tempqf,
8703 sm_errstring(save_errno));
8708 /* Figure out the new filename */
8709 newtype = (reason == NULL ? NORMQF_LETTER : QUARQF_LETTER);
8710 if (oldtype == newtype)
8712 /* going to rename tempqf to oldqf */
8713 (void) sm_strlcpy(newqf, oldqf, sizeof(newqf));
8717 /* going to rename tempqf to new name based on newtype */
8718 (void) sm_strlcpy(newqf, queuename(e, newtype), sizeof(newqf));
8723 /* rename tempqf to newqf */
8725 rename(tempqf, newqf) < 0)
8726 save_errno = (errno == 0) ? EINVAL : errno;
8728 /* Check rename() success */
8729 if (!failing && save_errno != 0)
8731 sm_syslog(LOG_DEBUG, e->e_id,
8732 "quarantine_queue_item: rename(%s, %s): %s",
8733 tempqf, newqf, sm_errstring(save_errno));
8735 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8736 "Error renaming %s to %s: %s\n",
8738 sm_errstring(save_errno));
8739 if (oldtype == newtype)
8742 ** Bail here since we don't know the state of
8743 ** the filesystem and may need to keep tempqf
8744 ** for the user to rescue us.
8749 syserr("!452 Error renaming control file %s", tempqf);
8754 /* remove new file (if rename() half completed) */
8755 if (xunlink(newqf) < 0)
8758 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8759 "Error removing %s: %s\n",
8761 sm_errstring(save_errno));
8764 /* tempqf removed below */
8770 /* If changing file types, need to remove old type */
8771 if (!failing && oldtype != newtype)
8773 if (xunlink(oldqf) < 0)
8776 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8777 "Error removing %s: %s\n",
8778 oldqf, sm_errstring(save_errno));
8782 /* see if anything above failed */
8785 /* Something failed: remove new file, old file still there */
8786 (void) xunlink(tempqf);
8790 ** fsync() after file operations to make sure metadata is
8791 ** written to disk on filesystems in which renames are
8792 ** not guaranteed. It's ok if they fail, mail won't be lost.
8795 if (SuperSafe != SAFE_NO)
8797 /* for soft-updates */
8798 (void) fsync(sm_io_getinfo(tempqfp,
8799 SM_IO_WHAT_FD, NULL));
8803 /* for soft-updates */
8804 (void) fsync(sm_io_getinfo(oldqfp,
8805 SM_IO_WHAT_FD, NULL));
8808 /* for other odd filesystems */
8809 SYNC_DIR(tempqf, false);
8814 if (tempqfp != NULL)
8815 (void) sm_io_close(tempqfp, SM_TIME_DEFAULT);
8817 (void) sm_io_close(oldqfp, SM_TIME_DEFAULT);
8824 ** QUARANTINE_QUEUE -- {un,}quarantine matching items in the queue
8826 ** Read all matching queue items, add/remove quarantine
8827 ** reason, and requeue appropriately.
8830 ** reason -- quarantine reason, "." means unquarantine.
8831 ** qgrplimit -- limit to single queue group unless NOQGRP
8837 ** Lots of changes to the queue.
8841 quarantine_queue(reason, qgrplimit)
8848 /* Convert internal representation of unquarantine */
8849 if (reason != NULL && reason[0] == '.' && reason[1] == '\0')
8855 reason = newstr(denlstring(reason, true, true));
8858 for (qgrp = 0; qgrp < NumQueue && Queue[qgrp] != NULL; qgrp++)
8862 if (qgrplimit != NOQGRP && qgrplimit != qgrp)
8865 for (qdir = 0; qdir < Queue[qgrp]->qg_numqueues; qdir++)
8873 nrequests = gatherq(qgrp, qdir, true, NULL, NULL, NULL);
8875 /* first see if there is anything */
8880 (void) sm_io_fprintf(smioout,
8881 SM_TIME_DEFAULT, "%s: no matches\n",
8882 qid_printqueue(qgrp, qdir));
8889 (void) sm_io_fprintf(smioout,
8890 SM_TIME_DEFAULT, "Processing %s:\n",
8891 qid_printqueue(qgrp, qdir));
8894 for (i = 0; i < WorkListCount; i++)
8901 /* setup envelope */
8902 clearenvelope(&e, true, sm_rpool_new_x(NULL));
8903 e.e_id = WorkList[i].w_name + 2;
8909 sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8910 "Would do %s\n", e.e_id);
8913 else if (quarantine_queue_item(qgrp, qdir,
8918 sm_rpool_free(e.e_rpool);
8921 if (WorkList != NULL)
8922 sm_free(WorkList); /* XXX */
8931 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8934 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
8937 changed == 1 ? "" : "s");