• Martin Mareš's avatar
    Added protocol debugging flags (protocol.h: D_xxx), parsing of them · 96d8e3bf
    Martin Mareš authored
    in configuration files and commands for manipulating them.
    
    Current debug message policy:
    
       o  D_STATES, D_ROUTES and D_FILTERS are handled in generic code.
       o  Other debug flags should be handled in the protocols and whenever
          the flag is set, the corresponding messages should be printed
          using calls to log(L_TRACE, ...), each message prefixed with
          the name of the protocol instance. These messages should cover
          the whole normal operation of the protocol and should be useful
          for an administrator trying to understand what does the protocol
          behave on his network or who is attempting to diagnose network
          problems. If your messages don't fit to the categories I've defined,
          feel free to add your own ones (by adding them to protocol.h
          and on two places in nest/config.Y), but please try to keep the
          categories as general as possible (i.e., not tied to your protocol).
       o  Internal debug messages not interesting even to an experienced
          user should be printed by calling DBG() which is either void or
          a call to debug() depending on setting of the LOCAL_DEBUG symbol
          at the top of your source.
       o  Dump functions (proto->dump etc.) should call debug() to print
          their messages.
       o  If you are doing any internal consistency checks, use ASSERT
          or bug().
       o  Nobody shall ever call printf() or any other stdio functions.
    
    Also please try to log any protocol errors you encounter and tag them
    with the appropriate message category (usually L_REMOTE or L_AUTH). Always
    carefully check contents of any message field you receive and verify all
    IP addresses you work with (by calling ipa_classify() or by using the
    neighbour cache if you want to check direct connectedness as well).
    96d8e3bf