2 /* $NetBSD: rcorder.c,v 1.7 2000/08/04 07:33:55 enami Exp $ */
6 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
8 * Copyright (c) 1998, 1999 Matthew R. Green
11 * Perry E. Metzger. All rights reserved.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. All advertising materials mentioning features or use of this software
22 * must display the following acknowledgement:
23 * This product includes software developed for the NetBSD Project
24 * by Perry E. Metzger.
25 * 4. The name of the author may not be used to endorse or promote products
26 * derived from this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
29 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
31 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
33 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
37 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include <sys/types.h>
41 __FBSDID("$FreeBSD$");
58 # define DPRINTF(args) if (debug) { fflush(stdout); fprintf args; }
60 # define DPRINTF(args)
63 #define REQUIRE_STR "# REQUIRE:"
64 #define REQUIRE_LEN (sizeof(REQUIRE_STR) - 1)
65 #define REQUIRES_STR "# REQUIRES:"
66 #define REQUIRES_LEN (sizeof(REQUIRES_STR) - 1)
67 #define PROVIDE_STR "# PROVIDE:"
68 #define PROVIDE_LEN (sizeof(PROVIDE_STR) - 1)
69 #define PROVIDES_STR "# PROVIDES:"
70 #define PROVIDES_LEN (sizeof(PROVIDES_STR) - 1)
71 #define BEFORE_STR "# BEFORE:"
72 #define BEFORE_LEN (sizeof(BEFORE_STR) - 1)
73 #define KEYWORD_STR "# KEYWORD:"
74 #define KEYWORD_LEN (sizeof(KEYWORD_STR) - 1)
75 #define KEYWORDS_STR "# KEYWORDS:"
76 #define KEYWORDS_LEN (sizeof(KEYWORDS_STR) - 1)
79 static int file_count;
80 static char **file_list;
89 static Hash_Table provide_hash_s, *provide_hash;
91 typedef struct provnode provnode;
92 typedef struct filenode filenode;
93 typedef struct f_provnode f_provnode;
94 typedef struct f_reqnode f_reqnode;
95 typedef struct strnodelist strnodelist;
101 provnode *next, *last;
123 filenode *next, *last;
125 f_provnode *prov_list;
126 strnodelist *keyword_list;
129 static filenode fn_head_s, *fn_head;
131 static strnodelist *bl_list;
132 static strnodelist *keep_list;
133 static strnodelist *skip_list;
135 static void do_file(filenode *fnode);
136 static void strnode_add(strnodelist **, char *, filenode *);
137 static int skip_ok(filenode *fnode);
138 static int keep_ok(filenode *fnode);
139 static void satisfy_req(f_reqnode *rnode, char *filename);
140 static void crunch_file(char *);
141 static void parse_require(filenode *, char *);
142 static void parse_provide(filenode *, char *);
143 static void parse_before(filenode *, char *);
144 static void parse_keywords(filenode *, char *);
145 static filenode *filenode_new(char *);
146 static void add_require(filenode *, char *);
147 static void add_provide(filenode *, char *);
148 static void add_before(filenode *, char *);
149 static void add_keyword(filenode *, char *);
150 static void insert_before(void);
151 static Hash_Entry *make_fake_provision(filenode *);
152 static void crunch_all_files(void);
153 static void initialize(void);
154 static void generate_ordering(void);
157 main(int argc, char *argv[])
161 while ((ch = getopt(argc, argv, "dk:s:")) != -1)
167 warnx("debugging not compiled in, -d ignored");
171 strnode_add(&keep_list, optarg, 0);
174 strnode_add(&skip_list, optarg, 0);
177 /* XXX should crunch it? */
186 DPRINTF((stderr, "parse_args\n"));
188 DPRINTF((stderr, "initialize\n"));
190 DPRINTF((stderr, "crunch_all_files\n"));
192 DPRINTF((stderr, "generate_ordering\n"));
198 * initialise various variables.
204 fn_head = &fn_head_s;
206 provide_hash = &provide_hash_s;
207 Hash_InitTable(provide_hash, file_count);
210 /* generic function to insert a new strnodelist element */
212 strnode_add(strnodelist **listp, char *s, filenode *fnode)
216 ent = emalloc(sizeof *ent + strlen(s));
224 * below are the functions that deal with creating the lists
225 * from the filename's given dependencies and provisions
226 * in each of these files. no ordering or checking is done here.
230 * we have a new filename, create a new filenode structure.
231 * fill in the bits, and put it in the filenode linked list
234 filenode_new(char *filename)
238 temp = emalloc(sizeof(*temp));
239 memset(temp, 0, sizeof(*temp));
240 temp->filename = estrdup(filename);
241 temp->req_list = NULL;
242 temp->prov_list = NULL;
243 temp->keyword_list = NULL;
244 temp->in_progress = RESET;
246 * link the filenode into the list of filenodes.
247 * note that the double linking means we can delete a
248 * filenode without searching for where it belongs.
250 temp->next = fn_head->next;
251 if (temp->next != NULL)
252 temp->next->last = temp;
253 temp->last = fn_head;
254 fn_head->next = temp;
259 * add a requirement to a filenode.
262 add_require(filenode *fnode, char *s)
268 entry = Hash_CreateEntry(provide_hash, s, &new);
270 Hash_SetValue(entry, NULL);
271 rnode = emalloc(sizeof(*rnode));
272 rnode->entry = entry;
273 rnode->next = fnode->req_list;
274 fnode->req_list = rnode;
278 * add a provision to a filenode. if this provision doesn't
279 * have a head node, create one here.
282 add_provide(filenode *fnode, char *s)
286 provnode *pnode, *head;
289 entry = Hash_CreateEntry(provide_hash, s, &new);
290 head = Hash_GetValue(entry);
292 /* create a head node if necessary. */
294 head = emalloc(sizeof(*head));
296 head->in_progress = RESET;
298 head->last = head->next = NULL;
299 Hash_SetValue(entry, head);
303 * Don't warn about this. We want to be able to support
304 * scripts that do two complex things:
306 * - Two independent scripts which both provide the
307 * same thing. Both scripts must be executed in
308 * any order to meet the barrier. An example:
320 * - Two interdependent scripts which both provide the
321 * same thing. Both scripts must be executed in
322 * graph order to meet the barrier. An example:
326 * PROVIDE: nameservice dnscache
331 * PROVIDE: nameservice nscd
335 warnx("file `%s' provides `%s'.", fnode->filename, s);
336 warnx("\tpreviously seen in `%s'.",
337 head->next->fnode->filename);
341 pnode = emalloc(sizeof(*pnode));
343 pnode->in_progress = RESET;
344 pnode->fnode = fnode;
345 pnode->next = head->next;
348 if (pnode->next != NULL)
349 pnode->next->last = pnode;
351 f_pnode = emalloc(sizeof(*f_pnode));
352 f_pnode->pnode = pnode;
353 f_pnode->next = fnode->prov_list;
354 fnode->prov_list = f_pnode;
358 * put the BEFORE: lines to a list and handle them later.
361 add_before(filenode *fnode, char *s)
365 bf_ent = emalloc(sizeof *bf_ent + strlen(s));
366 bf_ent->node = fnode;
367 strcpy(bf_ent->s, s);
368 bf_ent->next = bl_list;
373 * add a key to a filenode.
376 add_keyword(filenode *fnode, char *s)
379 strnode_add(&fnode->keyword_list, s, fnode);
383 * loop over the rest of a REQUIRE line, giving each word to
384 * add_require() to do the real work.
387 parse_require(filenode *node, char *buffer)
391 while ((s = strsep(&buffer, " \t\n")) != NULL)
393 add_require(node, s);
397 * loop over the rest of a PROVIDE line, giving each word to
398 * add_provide() to do the real work.
401 parse_provide(filenode *node, char *buffer)
405 while ((s = strsep(&buffer, " \t\n")) != NULL)
407 add_provide(node, s);
411 * loop over the rest of a BEFORE line, giving each word to
412 * add_before() to do the real work.
415 parse_before(filenode *node, char *buffer)
419 while ((s = strsep(&buffer, " \t\n")) != NULL)
425 * loop over the rest of a KEYWORD line, giving each word to
426 * add_keyword() to do the real work.
429 parse_keywords(filenode *node, char *buffer)
433 while ((s = strsep(&buffer, " \t\n")) != NULL)
435 add_keyword(node, s);
439 * given a file name, create a filenode for it, read in lines looking
440 * for provision and requirement lines, building the graphs as needed.
443 crunch_file(char *filename)
447 int require_flag, provide_flag, before_flag, keywords_flag;
448 enum { BEFORE_PARSING, PARSING, PARSING_DONE } state;
450 char delims[3] = { '\\', '\\', '\0' };
453 if ((fp = fopen(filename, "r")) == NULL) {
454 warn("could not open %s", filename);
458 if (fstat(fileno(fp), &st) == -1) {
459 warn("could not stat %s", filename);
464 if (!S_ISREG(st.st_mode)) {
466 warnx("%s is not a file", filename);
472 node = filenode_new(filename);
475 * we don't care about length, line number, don't want # for comments,
478 for (state = BEFORE_PARSING; state != PARSING_DONE &&
479 (buf = fparseln(fp, NULL, NULL, delims, 0)) != NULL; free(buf)) {
480 require_flag = provide_flag = before_flag = keywords_flag = 0;
481 if (strncmp(REQUIRE_STR, buf, REQUIRE_LEN) == 0)
482 require_flag = REQUIRE_LEN;
483 else if (strncmp(REQUIRES_STR, buf, REQUIRES_LEN) == 0)
484 require_flag = REQUIRES_LEN;
485 else if (strncmp(PROVIDE_STR, buf, PROVIDE_LEN) == 0)
486 provide_flag = PROVIDE_LEN;
487 else if (strncmp(PROVIDES_STR, buf, PROVIDES_LEN) == 0)
488 provide_flag = PROVIDES_LEN;
489 else if (strncmp(BEFORE_STR, buf, BEFORE_LEN) == 0)
490 before_flag = BEFORE_LEN;
491 else if (strncmp(KEYWORD_STR, buf, KEYWORD_LEN) == 0)
492 keywords_flag = KEYWORD_LEN;
493 else if (strncmp(KEYWORDS_STR, buf, KEYWORDS_LEN) == 0)
494 keywords_flag = KEYWORDS_LEN;
496 if (state == PARSING)
497 state = PARSING_DONE;
503 parse_require(node, buf + require_flag);
504 else if (provide_flag)
505 parse_provide(node, buf + provide_flag);
506 else if (before_flag)
507 parse_before(node, buf + before_flag);
508 else if (keywords_flag)
509 parse_keywords(node, buf + keywords_flag);
515 make_fake_provision(filenode *node)
519 provnode *head, *pnode;
525 snprintf(buffer, sizeof buffer, "fake_prov_%08d", i++);
526 entry = Hash_CreateEntry(provide_hash, buffer, &new);
528 head = emalloc(sizeof(*head));
530 head->in_progress = RESET;
532 head->last = head->next = NULL;
533 Hash_SetValue(entry, head);
535 pnode = emalloc(sizeof(*pnode));
537 pnode->in_progress = RESET;
539 pnode->next = head->next;
542 if (pnode->next != NULL)
543 pnode->next->last = pnode;
545 f_pnode = emalloc(sizeof(*f_pnode));
546 f_pnode->pnode = pnode;
547 f_pnode->next = node->prov_list;
548 node->prov_list = f_pnode;
554 * go through the BEFORE list, inserting requirements into the graph(s)
555 * as required. in the before list, for each entry B, we have a file F
556 * and a string S. we create a "fake" provision (P) that F provides.
557 * for each entry in the provision list for S, add a requirement to
558 * that provisions filenode for P.
563 Hash_Entry *entry, *fake_prov_entry;
569 while (bl_list != NULL) {
572 fake_prov_entry = make_fake_provision(bl_list->node);
574 entry = Hash_CreateEntry(provide_hash, bl_list->s, &new);
576 warnx("file `%s' is before unknown provision `%s'", bl_list->node->filename, bl_list->s);
578 for (pnode = Hash_GetValue(entry); pnode; pnode = pnode->next) {
582 rnode = emalloc(sizeof(*rnode));
583 rnode->entry = fake_prov_entry;
584 rnode->next = pnode->fnode->req_list;
585 pnode->fnode->req_list = rnode;
594 * loop over all the files calling crunch_file() on them to do the
595 * real work. after we have built all the nodes, insert the BEFORE:
596 * lines into graph(s).
599 crunch_all_files(void)
603 for (i = 0; i < file_count; i++)
604 crunch_file(file_list[i]);
609 * below are the functions that traverse the graphs we have built
610 * finding out the desired ordering, printing each file in turn.
611 * if missing requirements, or cyclic graphs are detected, a
612 * warning will be issued, and we will continue on..
616 * given a requirement node (in a filename) we attempt to satisfy it.
617 * we do some sanity checking first, to ensure that we have providers,
618 * aren't already satisfied and aren't already being satisfied (ie,
619 * cyclic). if we pass all this, we loop over the provision list
620 * calling do_file() (enter recursion) for each filenode in this
624 satisfy_req(f_reqnode *rnode, char *filename)
629 entry = rnode->entry;
630 head = Hash_GetValue(entry);
633 warnx("requirement `%s' in file `%s' has no providers.",
634 Hash_GetKey(entry), filename);
639 /* return if the requirement is already satisfied. */
640 if (head->next == NULL)
644 * if list is marked as in progress,
645 * print that there is a circular dependency on it and abort
647 if (head->in_progress == SET) {
648 warnx("Circular dependency on provision `%s' in file `%s'.",
649 Hash_GetKey(entry), filename);
654 head->in_progress = SET;
657 * while provision_list is not empty
658 * do_file(first_member_of(provision_list));
660 while (head->next != NULL)
661 do_file(head->next->fnode);
665 skip_ok(filenode *fnode)
670 for (s = skip_list; s; s = s->next)
671 for (k = fnode->keyword_list; k; k = k->next)
672 if (strcmp(k->s, s->s) == 0)
679 keep_ok(filenode *fnode)
684 for (s = keep_list; s; s = s->next)
685 for (k = fnode->keyword_list; k; k = k->next)
686 if (strcmp(k->s, s->s) == 0)
689 /* an empty keep_list means every one */
694 * given a filenode, we ensure we are not a cyclic graph. if this
695 * is ok, we loop over the filenodes requirements, calling satisfy_req()
696 * for each of them.. once we have done this, remove this filenode
697 * from each provision table, as we are now done.
699 * NOTE: do_file() is called recursively from several places and cannot
700 * safely free() anything related to items that may be recursed on.
701 * Circular dependencies will cause problems if we do.
704 do_file(filenode *fnode)
707 f_provnode *p, *p_tmp;
711 DPRINTF((stderr, "do_file on %s.\n", fnode->filename));
714 * if fnode is marked as in progress,
715 * print that fnode; is circularly depended upon and abort.
717 if (fnode->in_progress == SET) {
718 warnx("Circular dependency on file `%s'.",
720 was_set = exit_code = 1;
725 fnode->in_progress = SET;
728 * for each requirement of fnode -> r
729 * satisfy_req(r, filename)
733 satisfy_req(r, fnode->filename);
736 fnode->req_list = NULL;
739 * for each provision of fnode -> p
740 * remove fnode from provision list for p in hash table
742 p = fnode->prov_list;
746 if (pnode->next != NULL) {
747 pnode->next->last = pnode->last;
749 if (pnode->last != NULL) {
750 pnode->last->next = pnode->next;
756 fnode->prov_list = NULL;
759 DPRINTF((stderr, "next do: "));
761 /* if we were already in progress, don't print again */
762 if (was_set == 0 && skip_ok(fnode) && keep_ok(fnode))
763 printf("%s\n", fnode->filename);
765 if (fnode->next != NULL) {
766 fnode->next->last = fnode->last;
768 if (fnode->last != NULL) {
769 fnode->last->next = fnode->next;
772 DPRINTF((stderr, "nuking %s\n", fnode->filename));
775 free(fnode->filename);
782 generate_ordering(void)
786 * while there remain undone files{f},
787 * pick an arbitrary f, and do_file(f)
788 * Note that the first file in the file list is perfectly
789 * arbitrary, and easy to find, so we use that.
793 * N.B.: the file nodes "self delete" after they execute, so
794 * after each iteration of the loop, the head will be pointing
795 * to something totally different. The loop ends up being
796 * executed only once for every strongly connected set of
799 while (fn_head->next != NULL) {
800 DPRINTF((stderr, "generate on %s\n", fn_head->next->filename));
801 do_file(fn_head->next);