xcode.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2015-2020 Seagate Technology LLC 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.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_XCODE_XCODE_H__
#define __MOTR_XCODE_XCODE_H__

#include "lib/vec.h"                /* m0_bufvec_cursor */
#include "lib/types.h"              /* m0_bcount_t */
#include "lib/assert.h"             /* M0_BASSERT */
#include "xcode/xcode_attr.h"       /* M0_XC_ATTR */
#include "xcode/enum.h"

/* import */
struct m0_bufvec_cursor;
struct m0_be_seg;
struct m0_be_tx;

/* export */
struct m0_xcode;
struct m0_xcode_type;
struct m0_xcode_type_ops;
struct m0_xcode_ctx;
struct m0_xcode_obj;
struct m0_xcode_field;
struct m0_xcode_cursor;
struct m0_xcode_field_ops;

enum m0_xcode_aggr {
        M0_XA_RECORD,
        M0_XA_UNION,
        M0_XA_SEQUENCE,
        M0_XA_ARRAY,
        M0_XA_TYPEDEF,
        M0_XA_OPAQUE,
        M0_XA_ATOM,
        M0_XA_NR
};

extern const char *m0_xcode_aggr_name[M0_XA_NR];

enum m0_xode_atom_type {
        M0_XAT_VOID,
        M0_XAT_U8,
        M0_XAT_U32,
        M0_XAT_U64,

        M0_XAT_NR
};

extern const char *m0_xcode_atom_type_name[M0_XAT_NR];

enum {
        M0_XCODE_DECOR_READ,
        M0_XCODE_DECOR_MAX = 10
};

struct m0_xcode_field {
        const char                 *xf_name;
        const struct m0_xcode_type *xf_type;
        uint64_t                         xf_tag;
        int                        (*xf_opaque)(const struct m0_xcode_obj *par,
                                             const struct m0_xcode_type **out);
        uint32_t                         xf_offset;
        void                        *xf_decor[M0_XCODE_DECOR_MAX];
        int                        (*xf_read)(const struct m0_xcode_cursor *it,
                                              struct m0_xcode_obj *obj,
                                              const char *str);

};

enum m0_xcode_type_flags {
        M0_XCODE_TYPE_FLAG_DOM_BE     = 1 << 0,
        M0_XCODE_TYPE_FLAG_DOM_RPC    = 1 << 1,
        M0_XCODE_TYPE_FLAG_DOM_CONF   = 1 << 2,
};
M0_BASSERT(sizeof(enum m0_xcode_type_flags) <= sizeof(uint32_t));

struct m0_xcode_type {
        enum m0_xcode_aggr              xct_aggr;
        const char                     *xct_name;
        const struct m0_xcode_type_ops *xct_ops;
        enum m0_xode_atom_type          xct_atype;
        uint32_t                        xct_flags;
        void                           *xct_decor[M0_XCODE_DECOR_MAX];
        size_t                          xct_sizeof;
        size_t                          xct_nr;
        struct m0_xcode_field           xct_child[0];
};

struct m0_xcode_obj {
        const struct m0_xcode_type *xo_type;
        void                       *xo_ptr;
};

struct m0_xcode_type_ops {
        int (*xto_length)(struct m0_xcode_ctx *ctx, const void *obj);
        int (*xto_encode)(struct m0_xcode_ctx *ctx, const void *obj);
        int (*xto_decode)(struct m0_xcode_ctx *ctx, void *obj);
        int (*xto_read)(const struct m0_xcode_cursor *it,
                        struct m0_xcode_obj *obj, const char *str);
};

enum { M0_XCODE_DEPTH_MAX = 10 };

enum m0_xcode_cursor_flag {
        M0_XCODE_CURSOR_NONE,
        M0_XCODE_CURSOR_PRE,
        M0_XCODE_CURSOR_IN,
        M0_XCODE_CURSOR_POST,
        M0_XCODE_CURSOR_NR
};

extern const char *m0_xcode_cursor_flag_name[M0_XCODE_CURSOR_NR];

struct m0_xcode_cursor {
        int xcu_depth;
        struct m0_xcode_cursor_frame {
                struct m0_xcode_obj       s_obj;
                int                       s_fieldno;
                uint64_t                  s_elno;
                enum m0_xcode_cursor_flag s_flag;
                uint64_t                  s_datum;
        } xcu_stack[M0_XCODE_DEPTH_MAX];
};

M0_INTERNAL void m0_xcode_cursor_init(struct m0_xcode_cursor *it,
                                      const struct m0_xcode_obj *obj);

M0_INTERNAL int m0_xcode_next(struct m0_xcode_cursor *it);

M0_INTERNAL void m0_xcode_skip(struct m0_xcode_cursor *it);

M0_INTERNAL struct m0_xcode_cursor_frame *
m0_xcode_cursor_top(struct m0_xcode_cursor *it);

M0_INTERNAL const struct m0_xcode_field *
m0_xcode_cursor_field(const struct m0_xcode_cursor *it);

enum m0_xcode_endianness {
        M0_XEND_LE,
        M0_XEND_BE,
        M0_XEND_NR
};

extern const char *m0_xcode_endianness_name[M0_XEND_NR];

struct m0_xcode_ctx {
        enum m0_xcode_endianness xcx_end;
        struct m0_bufvec_cursor  xcx_buf;
        struct m0_xcode_cursor   xcx_it;
        void                  *(*xcx_alloc)(struct m0_xcode_cursor *, size_t);
        void                   (*xcx_free)(struct m0_xcode_cursor *ctx);
        int                    (*xcx_iter)(const struct m0_xcode_cursor *it);
        void                  (*xcx_iter_end)(const struct m0_xcode_cursor *it);
};

M0_INTERNAL void m0_xcode_ctx_init(struct m0_xcode_ctx *ctx,
                                   const struct m0_xcode_obj *obj);

M0_INTERNAL int m0_xcode_decode(struct m0_xcode_ctx *ctx);

M0_INTERNAL int m0_xcode_encode(struct m0_xcode_ctx *ctx);

M0_INTERNAL int m0_xcode_length(struct m0_xcode_ctx *ctx);
M0_INTERNAL void m0_xcode_type_iterate(struct m0_xcode_type *xt,
                                       void (*t)(struct m0_xcode_type *,
                                                 void *),
                                       void (*f)(struct m0_xcode_type *,
                                                 struct m0_xcode_field *,
                                                 void *), void *datum);

enum m0_xcode_what {
        M0_XCODE_ENCODE = 0,
        M0_XCODE_DECODE = 1,
};

M0_INTERNAL int m0_xcode_encdec(struct m0_xcode_obj *obj,
                                struct m0_bufvec_cursor *cur,
                                enum m0_xcode_what  what);

M0_INTERNAL int m0_xcode_obj_enc_to_buf(struct m0_xcode_obj *obj,
                                        void **buf, m0_bcount_t *len);

M0_INTERNAL int m0_xcode_obj_dec_from_buf(struct m0_xcode_obj *obj,
                                          void *buf, m0_bcount_t len);

M0_INTERNAL int m0_xcode_data_size(struct m0_xcode_ctx *ctx,
                                   const struct m0_xcode_obj *obj);

M0_INTERNAL void *m0_xcode_alloc(struct m0_xcode_cursor *it, size_t nob);

M0_INTERNAL bool m0_xcode_is_byte_array(const struct m0_xcode_type *xt);

M0_INTERNAL ssize_t
m0_xcode_alloc_obj(struct m0_xcode_cursor *it,
                   void *(*alloc)(struct m0_xcode_cursor *, size_t));
M0_INTERNAL int m0_xcode_read(struct m0_xcode_obj *obj, const char *str);

M0_INTERNAL int m0_xcode_print(const struct m0_xcode_obj *obj,
                               char *str, int nr);

M0_INTERNAL void m0_xcode_free_obj(struct m0_xcode_obj *obj);
M0_INTERNAL void m0_xcode_free(struct m0_xcode_ctx *ctx);
M0_INTERNAL int m0_xcode_cmp(const struct m0_xcode_obj *o0,
                             const struct m0_xcode_obj *o1);
M0_INTERNAL int m0_xcode_dup(struct m0_xcode_ctx *dest,
                             struct m0_xcode_ctx *src);
M0_INTERNAL bool m0_xcode_type_flags(struct m0_xcode_type *xt,
                                     uint32_t on, uint32_t off,
                                     uint64_t aggr_umask);

M0_INTERNAL void *m0_xcode_addr(const struct m0_xcode_obj *obj, int fieldno,
                                uint64_t elno);

M0_INTERNAL uint64_t m0_xcode_atom(const struct m0_xcode_obj *obj);

#define M0_XCODE_VAL(obj, fieldno, elno, __type) \
        ((__type *)m0_xcode_addr(obj, fieldno, elno))

M0_INTERNAL int m0_xcode_subobj(struct m0_xcode_obj *subobj,
                                const struct m0_xcode_obj *obj, int fieldno,
                                uint64_t elno);

M0_INTERNAL uint64_t m0_xcode_tag(const struct m0_xcode_obj *obj);

M0_INTERNAL int m0_xcode_find(struct m0_xcode_obj *obj,
                              const struct m0_xcode_type *xt, void **place);

bool m0_xcode_type_invariant(const struct m0_xcode_type *xt);

M0_INTERNAL void m0_xcode_union_init(struct m0_xcode_type *un, const char *name,
                                     const char *discriminator,
                                     size_t maxbranches);

M0_INTERNAL void m0_xcode_union_fini(struct m0_xcode_type *un);

M0_INTERNAL void m0_xcode_union_add (struct m0_xcode_type *un, const char *name,
                                     const struct m0_xcode_type *xt,
                                     uint64_t tag);
M0_INTERNAL void m0_xcode_union_close(struct m0_xcode_type *un);

extern const struct m0_xcode_type M0_XT_VOID;
extern const struct m0_xcode_type M0_XT_U8;
extern const struct m0_xcode_type M0_XT_U32;
extern const struct m0_xcode_type M0_XT_U64;

extern const struct m0_xcode_type M0_XT_OPAQUE;

typedef char m0_void_t[0];

M0_INTERNAL int m0_xcode_decor_register(void);

struct m0_bob_type;

M0_INTERNAL void m0_xcode_bob_type_init(struct m0_bob_type *bt,
                                        const struct m0_xcode_type *xt,
                                        size_t magix_field, uint64_t magix);

M0_INTERNAL void *m0_xcode_ctx_top(const struct m0_xcode_ctx *ctx);

#define M0_XCODE_OBJ(type, ptr) (struct m0_xcode_obj){ \
        .xo_type = type,                               \
        .xo_ptr  = ptr,                                \
}

void m0_xc_u8_init(void);
void m0_xc_u16_init(void);
void m0_xc_u32_init(void);
void m0_xc_u64_init(void);
void m0_xc_void_init(void);
void m0_xc_opaque_init(void);

/* __MOTR_XCODE_XCODE_H__ */
#endif

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */