2 * Copyright (c) 1998, 1999 Matthew R. Green
5 * Perry E. Metzger. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed for the NetBSD Project
18 * by Perry E. Metzger.
19 * 4. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 * $NetBSD: rcorder.c,v 1.7 2000/08/04 07:33:55 enami Exp $
34 * $DragonFly: src/sbin/rcorder/rcorder.c,v 1.7 2005/02/20 19:47:17 dillon Exp $
37 #include <sys/types.h>
52 # define DPRINTF(args) if (debug) { fflush(stdout); fprintf args; }
54 # define DPRINTF(args)
59 #define REQUIRE_STR "# REQUIRE:"
60 #define REQUIRE_LEN (sizeof(REQUIRE_STR) - 1)
61 #define REQUIRES_STR "# REQUIRES:"
62 #define REQUIRES_LEN (sizeof(REQUIRES_STR) - 1)
63 #define PROVIDE_STR "# PROVIDE:"
64 #define PROVIDE_LEN (sizeof(PROVIDE_STR) - 1)
65 #define PROVIDES_STR "# PROVIDES:"
66 #define PROVIDES_LEN (sizeof(PROVIDES_STR) - 1)
67 #define BEFORE_STR "# BEFORE:"
68 #define BEFORE_LEN (sizeof(BEFORE_STR) - 1)
69 #define KEYWORD_STR "# KEYWORD:"
70 #define KEYWORD_LEN (sizeof(KEYWORD_STR) - 1)
71 #define KEYWORDS_STR "# KEYWORDS:"
72 #define KEYWORDS_LEN (sizeof(KEYWORDS_STR) - 1)
85 Hash_Table provide_hash_s, *provide_hash;
87 typedef struct provnode provnode;
88 typedef struct filenode filenode;
89 typedef struct f_provnode f_provnode;
90 typedef struct f_reqnode f_reqnode;
91 typedef struct strnodelist strnodelist;
97 provnode *next, *last;
120 filenode *next, *last;
122 f_provnode *prov_list;
123 strnodelist *keyword_list;
126 filenode fn_head_s, *fn_head;
128 strnodelist *bl_list;
129 strnodelist *keep_list;
130 strnodelist *skip_list;
131 strnodelist *onetime_list;
133 void do_file(filenode *fnode);
134 void strnode_add(strnodelist **, char *, filenode *);
135 int skip_ok(filenode *fnode);
136 int keep_ok(filenode *fnode);
137 void satisfy_req(f_reqnode *rnode, char *filename);
138 void crunch_file(char *);
139 void parse_require(filenode *, char *);
140 void parse_provide(filenode *, char *);
141 void parse_before(filenode *, char *);
142 void parse_keywords(filenode *, char *);
143 filenode *filenode_new(char *);
144 void add_require(filenode *, char *);
145 void add_provide(filenode *, char *);
146 void add_before(filenode *, char *);
147 void add_keyword(filenode *, char *);
148 void insert_before(void);
149 Hash_Entry *make_fake_provision(filenode *);
150 void crunch_all_files(void);
151 void initialize(void);
152 void generate_ordering(void);
153 int main(int, char *[]);
156 main(int argc, char **argv)
160 while ((ch = getopt(argc, argv, "dpk:s:o:")) != -1)
166 warnx("debugging not compiled in, -d ignored");
170 strnode_add(&keep_list, optarg, 0);
173 strnode_add(&skip_list, optarg, 0);
176 strnode_add(&onetime_list, optarg, 0);
182 /* XXX should crunch it? */
191 DPRINTF((stderr, "parse_args\n"));
193 DPRINTF((stderr, "initialize\n"));
195 DPRINTF((stderr, "crunch_all_files\n"));
197 DPRINTF((stderr, "generate_ordering\n"));
203 * initialise various variables.
209 fn_head = &fn_head_s;
211 provide_hash = &provide_hash_s;
212 Hash_InitTable(provide_hash, file_count);
215 /* generic function to insert a new strnodelist element */
217 strnode_add(strnodelist **listp, char *s, filenode *fnode)
221 ent = emalloc(sizeof *ent + strlen(s));
229 * below are the functions that deal with creating the lists
230 * from the filename's given and the dependancies and provisions
231 * in each of these files. no ordering or checking is done here.
235 * we have a new filename, create a new filenode structure.
236 * fill in the bits, and put it in the filenode linked list
239 filenode_new(char *filename)
243 temp = emalloc(sizeof(*temp));
244 memset(temp, 0, sizeof(*temp));
245 temp->filename = estrdup(filename);
246 temp->req_list = NULL;
247 temp->prov_list = NULL;
248 temp->keyword_list = NULL;
249 temp->in_progress = RESET;
251 * link the filenode into the list of filenodes.
252 * note that the double linking means we can delete a
253 * filenode without searching for where it belongs.
255 temp->next = fn_head->next;
256 if (temp->next != NULL)
257 temp->next->last = temp;
258 temp->last = fn_head;
259 fn_head->next = temp;
264 * add a requirement to a filenode.
267 add_require(filenode *fnode, char *s)
273 entry = Hash_CreateEntry(provide_hash, s, &new);
275 Hash_SetValue(entry, NULL);
276 rnode = emalloc(sizeof(*rnode));
277 rnode->entry = entry;
278 rnode->next = fnode->req_list;
279 fnode->req_list = rnode;
283 * add a provision to a filenode. if this provision doesn't
284 * have a head node, create one here.
287 add_provide(filenode *fnode, char *s)
291 provnode *pnode, *head;
294 entry = Hash_CreateEntry(provide_hash, s, &new);
295 head = Hash_GetValue(entry);
297 /* create a head node if necessary. */
299 head = emalloc(sizeof(*head));
301 head->in_progress = RESET;
303 head->last = head->next = NULL;
304 Hash_SetValue(entry, head);
308 * Don't warn about this. We want to be able to support
309 * scripts that do two complex things:
311 * - Two independent scripts which both provide the
312 * same thing. Both scripts must be executed in
313 * any order to meet the barrier. An example:
325 * - Two interdependent scripts which both provide the
326 * same thing. Both scripts must be executed in
327 * graph order to meet the barrier. An example:
331 * PROVIDE: nameservice dnscache
336 * PROVIDE: nameservice nscd
340 warnx("file `%s' provides `%s'.", fnode->filename, s);
341 warnx("\tpreviously seen in `%s'.",
342 head->next->fnode->filename);
346 pnode = emalloc(sizeof(*pnode));
348 pnode->in_progress = RESET;
349 pnode->fnode = fnode;
350 pnode->next = head->next;
352 pnode->name = strdup(s);
354 if (pnode->next != NULL)
355 pnode->next->last = pnode;
357 f_pnode = emalloc(sizeof(*f_pnode));
358 f_pnode->pnode = pnode;
359 f_pnode->next = fnode->prov_list;
360 fnode->prov_list = f_pnode;
364 * put the BEFORE: lines to a list and handle them later.
367 add_before(filenode *fnode, char *s)
371 bf_ent = emalloc(sizeof *bf_ent + strlen(s));
372 bf_ent->node = fnode;
373 strcpy(bf_ent->s, s);
374 bf_ent->next = bl_list;
379 * add a key to a filenode.
382 add_keyword(filenode *fnode, char *s)
385 strnode_add(&fnode->keyword_list, s, fnode);
389 * loop over the rest of a REQUIRE line, giving each word to
390 * add_require() to do the real work.
393 parse_require(filenode *node, char *buffer)
397 while ((s = strsep(&buffer, " \t\n")) != NULL)
399 add_require(node, s);
403 * loop over the rest of a PROVIDE line, giving each word to
404 * add_provide() to do the real work.
407 parse_provide(filenode *node, char *buffer)
411 while ((s = strsep(&buffer, " \t\n")) != NULL)
413 add_provide(node, s);
417 * loop over the rest of a BEFORE line, giving each word to
418 * add_before() to do the real work.
421 parse_before(filenode *node, char *buffer)
425 while ((s = strsep(&buffer, " \t\n")) != NULL)
431 * loop over the rest of a KEYWORD line, giving each word to
432 * add_keyword() to do the real work.
435 parse_keywords(filenode *node, char *buffer)
439 while ((s = strsep(&buffer, " \t\n")) != NULL)
441 add_keyword(node, s);
445 * given a file name, create a filenode for it, read in lines looking
446 * for provision and requirement lines, building the graphs as needed.
449 crunch_file(char *filename)
453 int require_flag, provide_flag, before_flag, keywords_flag;
454 enum { BEFORE_PARSING, PARSING, PARSING_DONE } state;
456 char delims[3] = { '\\', '\\', '\0' };
459 if ((fp = fopen(filename, "r")) == NULL) {
460 warn("could not open %s", filename);
464 if (fstat(fileno(fp), &st) == -1) {
465 warn("could not stat %s", filename);
470 if (!S_ISREG(st.st_mode)) {
472 warnx("%s is not a file", filename);
478 node = filenode_new(filename);
481 * we don't care about length, line number, don't want # for comments,
484 for (state = BEFORE_PARSING; state != PARSING_DONE &&
485 (buf = fparseln(fp, NULL, NULL, delims, 0)) != NULL; free(buf)) {
486 require_flag = provide_flag = before_flag = keywords_flag = 0;
487 if (strncmp(REQUIRE_STR, buf, REQUIRE_LEN) == 0)
488 require_flag = REQUIRE_LEN;
489 else if (strncmp(REQUIRES_STR, buf, REQUIRES_LEN) == 0)
490 require_flag = REQUIRES_LEN;
491 else if (strncmp(PROVIDE_STR, buf, PROVIDE_LEN) == 0)
492 provide_flag = PROVIDE_LEN;
493 else if (strncmp(PROVIDES_STR, buf, PROVIDES_LEN) == 0)
494 provide_flag = PROVIDES_LEN;
495 else if (strncmp(BEFORE_STR, buf, BEFORE_LEN) == 0)
496 before_flag = BEFORE_LEN;
497 else if (strncmp(KEYWORD_STR, buf, KEYWORD_LEN) == 0)
498 keywords_flag = KEYWORD_LEN;
499 else if (strncmp(KEYWORDS_STR, buf, KEYWORDS_LEN) == 0)
500 keywords_flag = KEYWORDS_LEN;
502 if (state == PARSING)
503 state = PARSING_DONE;
509 parse_require(node, buf + require_flag);
510 else if (provide_flag)
511 parse_provide(node, buf + provide_flag);
512 else if (before_flag)
513 parse_before(node, buf + before_flag);
514 else if (keywords_flag)
515 parse_keywords(node, buf + keywords_flag);
521 make_fake_provision(filenode *node)
525 provnode *head, *pnode;
531 snprintf(buffer, sizeof buffer, "fake_prov_%08d", i++);
532 entry = Hash_CreateEntry(provide_hash, buffer, &new);
534 head = emalloc(sizeof(*head));
536 head->in_progress = RESET;
538 head->last = head->next = NULL;
539 Hash_SetValue(entry, head);
541 pnode = emalloc(sizeof(*pnode));
543 pnode->in_progress = RESET;
545 pnode->next = head->next;
547 pnode->name = strdup(buffer);
549 if (pnode->next != NULL)
550 pnode->next->last = pnode;
552 f_pnode = emalloc(sizeof(*f_pnode));
553 f_pnode->pnode = pnode;
554 f_pnode->next = node->prov_list;
555 node->prov_list = f_pnode;
561 * go through the BEFORE list, inserting requirements into the graph(s)
562 * as required. in the before list, for each entry B, we have a file F
563 * and a string S. we create a "fake" provision (P) that F provides.
564 * for each entry in the provision list for S, add a requirement to
565 * that provisions filenode for P.
570 Hash_Entry *entry, *fake_prov_entry;
576 while (bl_list != NULL) {
579 fake_prov_entry = make_fake_provision(bl_list->node);
581 entry = Hash_CreateEntry(provide_hash, bl_list->s, &new);
582 if (new == 1 && !provide)
583 warnx("file `%s' is before unknown provision `%s'", bl_list->node->filename, bl_list->s);
585 for (pnode = Hash_GetValue(entry); pnode; pnode = pnode->next) {
589 rnode = emalloc(sizeof(*rnode));
590 rnode->entry = fake_prov_entry;
591 rnode->next = pnode->fnode->req_list;
592 pnode->fnode->req_list = rnode;
601 * loop over all the files calling crunch_file() on them to do the
602 * real work. after we have built all the nodes, insert the BEFORE:
603 * lines into graph(s).
606 crunch_all_files(void)
610 for (i = 0; i < file_count; i++)
611 crunch_file(file_list[i]);
616 * below are the functions that traverse the graphs we have built
617 * finding out the desired ordering, printing each file in turn.
618 * if missing requirements, or cyclic graphs are detected, a
619 * warning will be issued, and we will continue on..
623 * given a requirement node (in a filename) we attempt to satisfy it.
624 * we do some sanity checking first, to ensure that we have providers,
625 * aren't already satisfied and aren't already being satisfied (ie,
626 * cyclic). if we pass all this, we loop over the provision list
627 * calling do_file() (enter recursion) for each filenode in this
631 satisfy_req(f_reqnode *rnode, char *filename)
636 entry = rnode->entry;
637 head = Hash_GetValue(entry);
640 warnx("requirement `%s' in file `%s' has no providers.",
641 Hash_GetKey(entry), filename);
646 /* return if the requirement is already satisfied. */
647 if (head->next == NULL)
651 * if list is marked as in progress,
652 * print that there is a circular dependency on it and abort
654 if (head->in_progress == SET) {
655 warnx("Circular dependency on provision `%s' in file `%s'.",
656 Hash_GetKey(entry), filename);
661 head->in_progress = SET;
664 * while provision_list is not empty
665 * do_file(first_member_of(provision_list));
667 while (head->next != NULL)
668 do_file(head->next->fnode);
672 skip_ok(filenode *fnode)
677 for (s = skip_list; s; s = s->next)
678 for (k = fnode->keyword_list; k; k = k->next)
679 if (strcmp(k->s, s->s) == 0)
686 keep_ok(filenode *fnode)
691 for (s = keep_list; s; s = s->next)
692 for (k = fnode->keyword_list; k; k = k->next)
693 if (strcmp(k->s, s->s) == 0)
696 /* an empty keep_list means every one */
701 * given a filenode, we ensure we are not a cyclic graph. if this
702 * is ok, we loop over the filenodes requirements, calling satisfy_req()
703 * for each of them.. once we have done this, remove this filenode
704 * from each provision table, as we are now done.
706 * NOTE: do_file() is called recursively from several places and cannot
707 * safely free() anything related to items that may be recursed on.
708 * Circular dependancies will cause problems if we do.
711 do_file(filenode *fnode)
713 f_reqnode *r, *r_tmp;
714 f_provnode *p, *p_tmp;
718 DPRINTF((stderr, "do_file on %s.\n", fnode->filename));
721 * if fnode is marked as in progress,
722 * print that fnode; is circularly depended upon and abort.
724 if (fnode->in_progress == SET) {
725 warnx("Circular dependency on file `%s'.",
727 was_set = exit_code = 1;
732 fnode->in_progress = SET;
735 * for each requirement of fnode -> r
736 * satisfy_req(r, filename)
741 satisfy_req(r, fnode->filename);
745 fnode->req_list = NULL;
748 * for each provision of fnode -> p
749 * remove fnode from provision list for p in hash table
751 p = fnode->prov_list;
755 if (pnode->next != NULL) {
756 pnode->next->last = pnode->last;
758 if (pnode->last != NULL) {
759 pnode->last->next = pnode->next;
765 fnode->prov_list = NULL;
768 DPRINTF((stderr, "next do: "));
770 /* if we were already in progress, don't print again */
771 if (was_set == 0 && skip_ok(fnode) && keep_ok(fnode))
772 printf("%s\n", fnode->filename);
774 if (fnode->next != NULL) {
775 fnode->next->last = fnode->last;
777 if (fnode->last != NULL) {
778 fnode->last->next = fnode->next;
781 DPRINTF((stderr, "nuking %s\n", fnode->filename));
782 /*free(fnode->filename);*/
787 generate_ordering(void)
791 * while there remain undone files{f},
792 * pick an arbitrary f, and do_file(f)
793 * Note that the first file in the file list is perfectly
794 * arbitrary, and easy to find, so we use that.
798 * N.B.: the file nodes "self delete" after they execute, so
799 * after each iteration of the loop, the head will be pointing
800 * to something totally different. The loop ends up being
801 * executed only once for every strongly connected set of
806 * List all keywords provided by the listed files
811 for (file = fn_head->next; file; file = file->next) {
812 for (f_prov = file->prov_list; f_prov; f_prov = f_prov->next) {
813 if (strncmp(f_prov->pnode->name, "fake_", 5) != 0)
814 printf("%s\n", f_prov->pnode->name);
817 } else if (onetime_list) {
819 * Only list dependanacies required to start particular
826 for (scan = onetime_list; scan; scan = scan->next) {
827 for (file = fn_head->next; file; file = file->next) {
828 for (f_prov = file->prov_list; f_prov; f_prov = f_prov->next) {
829 if (strcmp(scan->s, f_prov->pnode->name) == 0) {
839 while (fn_head->next != NULL) {
840 DPRINTF((stderr, "generate on %s\n", fn_head->next->filename));
841 do_file(fn_head->next);