ufid.h

Go to the documentation of this file.

/*
 * Copyright (c) 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_HELPERS_UFID_H__
#define __MOTR_HELPERS_UFID_H__

#include "motr/client.h"

enum {
        M0_UFID_BASE_TS          = 1514764800L,

        M0_UFID_RETRY_MAX        = 1000L,

        M0_UFID_CLOCK_SKEW_LIMIT = 300
};

enum m0_ufid_format {
        M0_UFID_SEQID_BITS       = 20UL,
        M0_UFID_PROCID_BITS      = 29UL,
        M0_UFID_GENID_BITS       = 31UL,
        M0_UFID_SALT_BITS        = 11UL,
        M0_UFID_RESERVED_BITS    = 37UL,
        M0_UFID_MAX_BITS         = 91UL
};

enum m0_ufid_gen_id_format {
        M0_UFID_GENID_HI_BITS    = 16UL,
        M0_UFID_GENID_LO_BITS    = 15UL
};

enum m0_ufid_procid_format {
        M0_UFID_PROCID_WARN_BITS = 1UL,
        M0_UFID_PROCID_SAFE_BITS = 28UL
};

#define UFID_MASK(N)          ((1UL << N) - 1UL)
#define M0_UFID_GENID_MASK    UFID_MASK(M0_UFID_GENID_BITS)
#define M0_UFID_GENID_HI_MASK UFID_MASK(M0_UFID_GENID_HI_BITS)
#define M0_UFID_GENID_LO_MASK UFID_MASK(M0_UFID_GENID_LO_BITS)
#define M0_UFID_SALT_MASK     UFID_MASK(M0_UFID_SALT_BITS)
#define M0_UFID_SEQID_MASK    UFID_MASK(M0_UFID_SEQID_BITS)
#define M0_UFID_PROCID_MASK   UFID_MASK(M0_UFID_PROCID_BITS)
#define M0_UFID_RESERVED_MASK UFID_MASK(M0_UFID_RESERVED_BITS)

#define M0_UFID_HI_RESERVED \
        (UINT64_MAX << (64UL - M0_UFID_RESERVED_BITS))
#define M0_UFID_SEQID_MAX     (1UL << M0_UFID_SEQID_BITS)
#define M0_UFID_PROCID_MAX    (1UL << M0_UFID_PROCID_BITS)

struct m0_ufid {
        uint64_t uf_reserved;   /* 37 bits reserver by MOTR */
        uint32_t uf_salt;       /* 11 bit random salt */
        uint32_t uf_gen_id;     /* 31 bit generation timestamp */
        uint32_t uf_proc_id;    /* 29 bit service uid */
        uint32_t uf_seq_id;     /* 20 bit Sequence No */
};

struct m0_ufid_generator {
        struct m0_client     *ufg_m0c;
        bool                  ufg_is_initialised;
        struct m0_mutex       ufg_lock;
        struct m0_ufid        ufg_ufid_cur;
};

#endif /* __MOTR_HELPERS_UFID_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */
/*
 * vim: tabstop=8 shiftwidth=8 noexpandtab textwidth=80 nowrap
 */