incubator-nuttx/sched/tls/tls.h

121 lines
3.7 KiB
C

/****************************************************************************
* sched/tls/tls.h
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you 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 __SCHED_TLS_TLS_H
#define __SCHED_TLS_TLS_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/arch.h>
#include <nuttx/sched.h>
#include <nuttx/tls.h>
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: up_tls_size
*
* Description:
* Get TLS (sizeof(struct tls_info_s) + tdata + tbss) section size.
*
* Returned Value:
* Size of (sizeof(struct tls_info_s) + tdata + tbss).
*
****************************************************************************/
#ifdef CONFIG_SCHED_THREAD_LOCAL
# define tls_info_size() up_tls_size()
#else
# define tls_info_size() sizeof(struct tls_info_s)
#endif
/****************************************************************************
* Name: task_init_info
*
* Description:
* Allocate and initialize task_info_s structure.
*
* Input Parameters:
* - group: The group of new task
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
int task_init_info(FAR struct task_group_s *group);
/****************************************************************************
* Name: task_uninit_info
*
* Description:
* Uninitilize and free task_info_s structure.
*
* Input Parameters:
* - group: The group of new task
*
* Returned Value:
* None.
*
****************************************************************************/
void task_uninit_info(FAR struct task_group_s *group);
/****************************************************************************
* Name: tls_init_info
*
* Description:
* Allocate and initialize tls_info_s structure.
*
* Input Parameters:
* - tcb: The TCB of new task
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
int tls_init_info(FAR struct tcb_s *tcb);
/****************************************************************************
* Name: tls_dup_info
*
* Description:
* Allocate and duplicate tls_info_s structure.
*
* Input Parameters:
* - dst: The TCB of new task
* - src: The TCB of source task
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
int tls_dup_info(FAR struct tcb_s *dst, FAR struct tcb_s *src);
#endif /* __SCHED_TLS_TLS_H */