daos_uns.h

Go to the documentation of this file.

/*
 * (C) Copyright 2019-2024 Intel Corporation.
 * (C) Copyright 2026 Hewlett Packard Enterprise Development LP
 *
 * SPDX-License-Identifier: BSD-2-Clause-Patent
 */
 
#ifndef __DAOS_UNS_H__
#define __DAOS_UNS_H__
 
#if defined(__cplusplus)
extern "C" {
#endif
 
#include <daos_prop.h>
#include <daos_obj_class.h>
#include <daos_cont.h>

enum {
    /*
     * String does not include daos:// prefix
     * Path that is passed does not have daos: prefix but is direct:
     * (/puuid/cuuid/xyz) and does not need to parse a path UNS attrs.
     * This is usually not set.
     */
    DUNS_NO_PREFIX = (1 << 0),
 
    /* look only at the last entry in the path. */
    DUNS_NO_REVERSE_LOOKUP = (1 << 1),
 
    /*
     * check only for direct path.
     * Do not attempt to get the extended attribute of the path, and assume
     * the path is a direct path that is either of format:
     *   - /puuid/cuuid/xyz
     *   - /pool_label/container_label/xyz
     * This is usually not set.
     */
    DUNS_NO_CHECK_PATH = (1 << 2),
};

struct duns_attr_t {
    daos_cont_layout_t  da_type;
    daos_oclass_id_t    da_oclass_id;
    daos_size_t     da_chunk_size;
    daos_prop_t     *da_props;
    uint32_t        da_flags;
    char            da_pool[DAOS_PROP_LABEL_MAX_LEN + 1];
    char            da_cont[DAOS_PROP_LABEL_MAX_LEN + 1];
    char            *da_sys;
    char            *da_rel_path;
    bool            da_on_lustre;
    bool            da_no_prefix;
    uuid_t          da_puuid;
    uuid_t          da_cuuid;
    daos_oclass_id_t    da_dir_oclass_id;
    daos_oclass_id_t    da_file_oclass_id;
    char            da_hints[DAOS_CONT_HINT_MAX_LEN];
};

#define DUNS_XATTR_NAME     "user.daos"
#define DUNS_MAX_XATTR_LEN  170
#define DUNS_XATTR_FMT      "DAOS.%s://%36s/%36s"
#define DUNS_LUSTRE_XATTR_FMT       "%36s/%36s"

int
duns_create_path(daos_handle_t poh, const char *path, struct duns_attr_t *attrp);

int
duns_resolve_path(const char *path, struct duns_attr_t *attr);

int
duns_destroy_path(daos_handle_t poh, const char *path);

int
duns_parse_attr(char *str, daos_size_t len, struct duns_attr_t *attr);

int
duns_set_sys_name(struct duns_attr_t *attrp, const char *sys);

void
duns_destroy_attr(struct duns_attr_t *attrp);

int
duns_link_cont(daos_handle_t poh, const char *cont, const char *path);
 
#if defined(__cplusplus)
}
#endif
#endif /* __DAOS_UNS_H__ */