[BACK]Return to gnode.h CVS log [TXT][DIR] Up to [local] / src / usr.bin / make

Annotation of src/usr.bin/make/gnode.h, Revision 1.25

1.1       espie       1: #ifndef GNODE_H
                      2: #define GNODE_H
1.25    ! espie       3: /*     $OpenBSD: gnode.h,v 1.24 2013/04/23 14:32:53 espie Exp $ */
1.1       espie       4:
                      5: /*
                      6:  * Copyright (c) 2001 Marc Espie.
                      7:  *
                      8:  * Redistribution and use in source and binary forms, with or without
                      9:  * modification, are permitted provided that the following conditions
                     10:  * are met:
                     11:  * 1. Redistributions of source code must retain the above copyright
                     12:  *    notice, this list of conditions and the following disclaimer.
                     13:  * 2. Redistributions in binary form must reproduce the above copyright
                     14:  *    notice, this list of conditions and the following disclaimer in the
                     15:  *    documentation and/or other materials provided with the distribution.
                     16:  *
                     17:  * THIS SOFTWARE IS PROVIDED BY THE OPENBSD PROJECT AND CONTRIBUTORS
                     18:  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
                     19:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
                     20:  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OPENBSD
                     21:  * PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
                     22:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
                     23:  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
                     24:  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
                     25:  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
                     26:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
                     27:  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
                     28:  */
                     29:
1.24      espie      30: #include <sys/time.h>
1.1       espie      31: #ifndef LIST_TYPE
                     32: #include "lst_t.h"
                     33: #endif
1.18      espie      34: #ifndef LOCATION_TYPE
                     35: #include "location.h"
                     36: #endif
1.1       espie      37: #ifndef SYMTABLE_H
                     38: #include "symtable.h"
                     39: #endif
                     40:
                     41: /*-
                     42:  * The structure for an individual graph node. Each node has several
                     43:  * pieces of data associated with it.
                     44:  *     1) the name of the target it describes
                     45:  *     2) the location of the target file in the file system.
                     46:  *     3) the type of operator used to define its sources (qv. parse.c)
                     47:  *     4) whether it is involved in this invocation of make
                     48:  *     5) whether the target has been remade
                     49:  *     6) whether any of its children has been remade
                     50:  *     7) the number of its children that are, as yet, unmade
                     51:  *     8) its modification time
                     52:  *     9) the modification time of its youngest child (qv. make.c)
                     53:  *     10) a list of nodes for which this is a source
                     54:  *     11) a list of nodes on which this depends
                     55:  *     12) a list of nodes that depend on this, as gleaned from the
                     56:  *         transformation rules.
                     57:  *     13) a list of nodes of the same name created by the :: operator
                     58:  *     14) a list of nodes that must be made (if they're made) before
                     59:  *         this node can be, but that do no enter into the datedness of
                     60:  *         this node.
                     61:  *     15) a list of nodes that must be made (if they're made) after
                     62:  *         this node is, but that do not depend on this node, in the
                     63:  *         normal sense.
                     64:  *     16) a Lst of ``local'' variables that are specific to this target
                     65:  *        and this target only (qv. var.c [$@ $< $?, etc.])
                     66:  *     17) a Lst of strings that are commands to be given to a shell
                     67:  *        to create this target.
                     68:  */
1.5       espie      69:
1.10      espie      70: #define UNKNOWN                0
1.5       espie      71: #define BEINGMADE      1
                     72: #define MADE           2
1.15      espie      73: #define UPTODATE       3
1.5       espie      74: #define ERROR          4
                     75: #define ABORTED                5
                     76: #define CYCLE          6
                     77: #define ENDCYCLE       7
                     78: #define NOSUCHNODE     8
1.21      espie      79: #define BUILDING       9
1.23      espie      80: #define HELDBACK       10
1.5       espie      81:
1.15      espie      82: #define SPECIAL_NONE   0U
                     83: #define SPECIAL_PATH           21U
                     84: #define SPECIAL_MASK           63U
                     85: #define SPECIAL_TARGET         64U
                     86: #define SPECIAL_SOURCE         128U
1.5       espie      87: #define SPECIAL_TARGETSOURCE   (SPECIAL_TARGET|SPECIAL_SOURCE)
                     88:
1.21      espie      89: #define        SPECIAL_EXEC            4U
                     90: #define SPECIAL_IGNORE         5U
1.23      espie      91: #define SPECIAL_NOTHING        6U
1.21      espie      92: #define        SPECIAL_INVISIBLE       8U
                     93: #define SPECIAL_JOIN           9U
                     94: #define SPECIAL_MADE           11U
                     95: #define SPECIAL_MAIN           12U
                     96: #define SPECIAL_MAKE           13U
                     97: #define SPECIAL_MFLAGS         14U
                     98: #define        SPECIAL_NOTMAIN         15U
                     99: #define        SPECIAL_NOTPARALLEL     16U
                    100: #define        SPECIAL_OPTIONAL        18U
                    101: #define SPECIAL_ORDER          19U
                    102: #define SPECIAL_PARALLEL       20U
                    103: #define SPECIAL_PHONY          22U
                    104: #define SPECIAL_PRECIOUS       23U
                    105: #define SPECIAL_SILENT         25U
                    106: #define SPECIAL_SUFFIXES       27U
                    107: #define        SPECIAL_USE             28U
                    108: #define SPECIAL_WAIT           29U
                    109: #define SPECIAL_NOPATH         30U
                    110: #define SPECIAL_ERROR          31U
                    111: #define SPECIAL_CHEAP          32U
                    112: #define SPECIAL_EXPENSIVE      33U
                    113:
1.1       espie     114: struct GNode_ {
1.15      espie     115:     unsigned int special_op;   /* special op to apply */
1.5       espie     116:     unsigned char special;/* type of special node */
1.14      espie     117:     char must_make;    /* true if this target needs to be remade */
1.5       espie     118:     char childMade;    /* true if one of this target's children was
                    119:                         * made */
1.9       espie     120:     char built_status; /* Set to reflect the state of processing
1.5       espie     121:                         * on this node:
1.10      espie     122:                         *  UNKNOWN - Not examined yet
                    123:                         *  BEINGMADE - Target is currently being made.
1.21      espie     124:                         *  BUILDING - There is a job running
1.5       espie     125:                         *  MADE - Was out-of-date and has been made
                    126:                         *  UPTODATE - Was already up-to-date
                    127:                         *  ERROR - An error occurred while it was being
                    128:                         *      made (used only in compat mode)
                    129:                         *  ABORTED - The target was aborted due to
1.10      espie     130:                         *      an error making an inferior.
1.5       espie     131:                         *  CYCLE - Marked as potentially being part of
                    132:                         *      a graph cycle. If we come back to a
                    133:                         *      node marked this way, it is printed
1.9       espie     134:                         *      and 'built_status' is changed to ENDCYCLE.
1.5       espie     135:                         *  ENDCYCLE - the cycle has been completely
                    136:                         *      printed. Go back and unmark all its
                    137:                         *      members.
                    138:                         */
                    139:     char *path;                /* The full pathname of the file */
1.15      espie     140:     unsigned int type; /* Its type (see the OP flags, below) */
1.5       espie     141:     int order;         /* Its wait weight */
                    142:
                    143:     int unmade;                /* The number of unmade children */
                    144:
1.24      espie     145:     struct timespec mtime;     /* Its modification time */
                    146:     struct timespec cmtime;    /* The modification time of its youngest
                    147:                                 * child */
1.5       espie     148:
1.25    ! espie     149:     GNode *youngest;
1.8       espie     150:     GNode *impliedsrc;
1.5       espie     151:     LIST cohorts;      /* Other nodes for the :: operator */
                    152:     LIST parents;      /* Nodes that depend on this one */
                    153:     LIST children;     /* Nodes on which this one depends */
                    154:     LIST successors;   /* Nodes that must be made after this one */
                    155:     LIST preds;                /* Nodes that must be made before this one */
                    156:
                    157:     SymTable context;  /* The local variables */
                    158:     LIST commands;     /* Creation commands */
1.23      espie     159:     Suff *suffix;      /* Suffix for the node (determined by
1.5       espie     160:                         * Suff_FindDeps and opaque to everyone
                    161:                         * but the Suff module) */
1.23      espie     162:     GNode *sibling;    /* equivalent targets */
                    163:     GNode *groupling;  /* target lists */
                    164:     GNode *watched;    /* the node currently building */
1.14      espie     165:     /* stuff for target name equivalence */
                    166:     char *basename;    /* pointer to name stripped of path */
1.23      espie     167:     GNode *next;
1.5       espie     168:     char name[1];      /* The target's name */
1.20      espie     169: };
                    170:
                    171: struct command
                    172: {
                    173:        Location location;
                    174:        char string[1];
1.1       espie     175: };
                    176:
1.14      espie     177: #define has_been_built(gn) \
                    178:        ((gn)->built_status == MADE || (gn)->built_status == UPTODATE)
                    179: #define should_have_file(gn) \
                    180:        ((gn)->special == SPECIAL_NONE && \
                    181:        ((gn)->type & (OP_PHONY | OP_DUMMY)) == 0)
1.1       espie     182: /*
                    183:  * The OP_ constants are used when parsing a dependency line as a way of
                    184:  * communicating to other parts of the program the way in which a target
                    185:  * should be made. These constants are bitwise-OR'ed together and
                    186:  * placed in the 'type' field of each node. Any node that has
                    187:  * a 'type' field which satisfies the OP_NOP function was never never on
                    188:  * the lefthand side of an operator, though it may have been on the
                    189:  * righthand side...
                    190:  */
                    191: #define OP_DEPENDS     0x00000001  /* Execution of commands depends on
                    192:                                     * kids (:) */
                    193: #define OP_FORCE       0x00000002  /* Always execute commands (!) */
                    194: #define OP_DOUBLEDEP   0x00000004  /* Execution of commands depends on kids
                    195:                                     * per line (::) */
1.6       espie     196: #define OP_ERROR       0x00000000
1.1       espie     197: #define OP_OPMASK      (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
                    198:
                    199: #define OP_OPTIONAL    0x00000008  /* Don't care if the target doesn't
                    200:                                     * exist and can't be created */
                    201: #define OP_USE         0x00000010  /* Use associated commands for parents */
                    202: #define OP_EXEC        0x00000020  /* Target is never out of date, but always
                    203:                                     * execute commands anyway. Its time
                    204:                                     * doesn't matter, so it has none...sort
                    205:                                     * of */
                    206: #define OP_IGNORE      0x00000040  /* Ignore errors when creating the node */
                    207: #define OP_PRECIOUS    0x00000080  /* Don't remove the target when
                    208:                                     * interrupted */
                    209: #define OP_SILENT      0x00000100  /* Don't echo commands when executed */
1.5       espie     210: #define OP_MAKE        0x00000200  /* Target is a recursive make so its
1.1       espie     211:                                     * commands should always be executed when
                    212:                                     * it is out of date, regardless of the
                    213:                                     * state of the -n or -t flags */
                    214: #define OP_JOIN        0x00000400  /* Target is out-of-date only if any of its
                    215:                                     * children was out-of-date */
                    216: #define OP_MADE        0x00000800  /* Assume the node is already made; even if
                    217:                                     * it really is out of date */
1.14      espie     218: #define OP_INVISIBLE   0x00001000  /* The node is invisible to its parents.
1.1       espie     219:                                     * I.e. it doesn't show up in the parents's
                    220:                                     * local variables. */
1.14      espie     221: #define OP_NOTMAIN     0x00002000  /* The node is exempt from normal 'main
1.1       espie     222:                                     * target' processing in parse.c */
1.14      espie     223: #define OP_PHONY       0x00004000  /* Not a file target; run always */
                    224: #define OP_NOPATH      0x00008000  /* Don't search for file in the path */
                    225: #define OP_NODEFAULT   0x00010000  /* Special node that never needs */
1.5       espie     226:                                    /* DEFAULT commands applied */
1.14      espie     227: #define OP_DUMMY       0x00020000  /* node was created by default, but it */
1.5       espie     228:                                    /* does not really exist. */
1.1       espie     229: /* Attributes applied by PMake */
1.14      espie     230: #define OP_TRANSFORM   0x00040000  /* The node is a transformation rule */
                    231: #define OP_MEMBER      0x00080000  /* Target is a member of an archive */
1.23      espie     232: #define OP_DOUBLE      0x00100000  /* normal op with double commands */
1.14      espie     233: #define OP_ARCHV       0x00200000  /* Target is an archive construct */
                    234: #define OP_HAS_COMMANDS 0x00400000  /* Target has all the commands it should.
1.1       espie     235:                                     * Used when parsing to catch multiple
                    236:                                     * commands for a target */
1.14      espie     237: #define OP_DEPS_FOUND  0x00800000  /* Already processed by Suff_FindDeps */
1.7       espie     238: #define OP_RESOLVED    0x01000000  /* We looked harder already */
1.19      espie     239: #define OP_CHEAP       0x02000000  /* Assume job is not recursive */
                    240: #define OP_EXPENSIVE   0x04000000  /* Recursive job, don't run in parallel */
1.1       espie     241:
                    242: /*
                    243:  * OP_NOP will return true if the node with the given type was not the
                    244:  * object of a dependency operator
                    245:  */
                    246: #define OP_NOP(t)      (((t) & OP_OPMASK) == 0x00000000)
                    247:
                    248: #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM)
                    249:
                    250:
                    251: #endif