aboutsummaryrefslogtreecommitdiffstats
path: root/src/vpp-api/python/README.rst
blob: e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 (plain) 








 


 


light .dl { color: #e6db74 } /* Literal.String.Delimiter */
.highlight .sd { color: #e6db74 } /* Literal.String.Doc */
.highlight .s2 { color: #e6db74 } /* Literal.String.Double */
.highlight .se { color: #ae81ff } /* Literal.String.Escape */
.highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */
.highlight .si { color: #e6db74 } /* Literal.String.Interpol */
.highlight .sx { color: #e6db74 } /* Literal.String.Other */
.highlight .sr { color: #e6db74 } /* Literal.String.Regex */
.highlight .s1 { color: #e6db74 } /* Literal.String.Single */
.highlight .ss { color: #e6db74 } /* Literal.String.Symbol */
.highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #a6e22e } /* Name.Function.Magic */
.highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */
.highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */
.highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */
.highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */
.highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */
}
@media (prefers-color-scheme: light) {
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
}

/*
 * Copyright (c) 2015 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef included_vlib_parse_h
#define included_vlib_parse_h

#include <vlib/vlib.h>
#include <vlib/lex.h>
#include <vppinfra/mhash.h>

typedef struct
{
  /* Word aligned value. */
  union
  {
    u8 as_u8[32 - 1 * sizeof (u16)];
    void *as_pointer;
    uword as_uword;
    word as_word;
    u64 as_u64;
  } value;

  /* 16 bit type at end so that 30 bytes of value are aligned. */
  u16 type;
} __attribute ((packed))
  vlib_parse_value_t;

/* Instance of a type. */
     typedef struct
     {
       u32
	 type;

       u32
	 origin;

       u32
	 help_index;

       union
       {
	 void *
	   as_pointer;
	 uword
	   as_uword;
       } value;
     } vlib_parse_item_t;

     typedef struct
     {
       /* Index of item for this node. */
       u32
	 item;

       /* Graph index of peer (sibling) node (linked list of peers). */
       u32
	 peer;

       /* Graph index of deeper (child) node (linked list of children). */
       u32
	 deeper;
     } vlib_parse_graph_t;

#define foreach_parse_match_type                \
  _(MATCH_DONE)					\
  _(MATCH_RULE)					\
  _(MATCH_FAIL)					\
  _(MATCH_FULL)					\
  _(MATCH_VALUE)				\
  _(MATCH_PARTIAL)				\
  _(MATCH_AMBIGUOUS)				\
  _(MATCH_EVAL_FAIL)

     typedef enum
     {
#define _(a) VLIB_PARSE_##a,
       foreach_parse_match_type
#undef _
     } vlib_parse_match_t;

     struct vlib_parse_type;
     struct vlib_parse_main;

     typedef
     vlib_parse_match_t (vlib_parse_match_function_t)
  (struct vlib_parse_main *,
   struct vlib_parse_type *, vlib_lex_token_t *, vlib_parse_value_t *);
     typedef void (vlib_parse_value_cleanup_function_t) (vlib_parse_value_t
							 *);

     typedef struct vlib_parse_type
     {
       /* Type name. */
       char *
	 name;

       vlib_parse_match_function_t *
	 match_function;

       vlib_parse_value_cleanup_function_t *
	 value_cleanup_function;

       format_function_t *
	 format_value;

       u32
	 rule_index;
     } vlib_parse_type_t;

     typedef struct
     {
       char *
	 initializer;
       void *
	 eof_match;
       int
	 rule_length;
     } parse_registration_t;

     typedef struct vlib_parse_main
     {
       /* (type, origin, help, value) tuples */
       vlib_parse_item_t *
	 parse_items;
       mhash_t
	 parse_item_hash;

       /* (item, peer, deeper) tuples */
       vlib_parse_graph_t *
	 parse_graph;
       u32
	 root_index;

       u8 *
	 register_input;

       /* parser types */
       vlib_parse_type_t *
	 parse_types;
       uword *
	 parse_type_by_name_hash;

       /* Vector of MATCH_VALUEs */
       vlib_parse_value_t *
	 parse_value;
       u32 *
	 match_items;

       /* Parse registrations */
       parse_registration_t **
	 parse_registrations;

       /* Token vector */
       vlib_lex_token_t *
	 tokens;
       u32
	 current_token_index;

       vlib_lex_main_t *
	 lex_main;
       vlib_main_t *
	 vlib_main;
     } vlib_parse_main_t;

     vlib_parse_main_t
       vlib_parse_main;

     typedef
     vlib_parse_match_t (vlib_parse_eval_function_t)
  (vlib_parse_main_t *, vlib_parse_item_t *, vlib_parse_value_t *);

vlib_parse_match_t
vlib_parse_eval (u8 * input);

     format_function_t format_vlib_parse_value;

/* FIXME need these to be global? */
     vlib_parse_match_function_t rule_match, eof_match, word_match,
       number_match;

#define _PARSE_REGISTRATION_DATA(x) \
VLIB_ELF_SECTION_DATA(x##_registration,parse_registration_t,parse_registrations)

#define PARSE_INIT(x, s, e)                     \
static _PARSE_REGISTRATION_DATA(x) = {          \
    .initializer = s,                           \
    .eof_match = e,                             \
};

#define _PARSE_TYPE_REGISTRATION_DATA(x) \
VLIB_ELF_SECTION_DATA(x##_type_registration,vlib_parse_type_t, \
parse_type_registrations)

#define PARSE_TYPE_INIT(n, m, c, f)             \
static _PARSE_TYPE_REGISTRATION_DATA(n) = {     \
    .name = #n,                                 \
    .match_function = m,			\
    .value_cleanup_function = c,		\
    .format_value = f,				\
};

#endif /* included_vlib_parse_h */

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */