[libc.search] [PATCH 3/6] add `search.h` specifications

[SchrodingerZhu]

Summary

This patch initiates definitions for search.h as specified in POSIX.1-2001. Because this patch means to
be a part of a larger patch of hashtable implementation, the header definition is not complete,
only hsearch, hdelete, hcreate, ACTION, ENTRY (POSIX standards), and hsearch_r, hdetele_r, hcreate_r,
struct hsearch_data (GNU extensions) are added.

[SchrodingerZhu]

Rebase

[SchrodingerZhu]

@sivachandra

Hi,

I have two more questions regarding this:

• typedef enum { FIND, ENTER } ACTION; What should I do with a type-defined enum. I mean, should I trait it as a type or an enum (which seems to be distinguished in the header name such as enum_action.h and action.h)? Same question also applies to the situation of struct_action vs action.
• Should I ping the reviewers at each patch of the stacked series?

Best,
Yifan

libc/config/linux/x86_64/headers.txt

 set(TARGET_PUBLIC_HEADERS
     libc.include.assert
     libc.include.ctype
     libc.include.dirent
     libc.include.errno
     libc.include.fcntl
     libc.include.fenv
     libc.include.inttypes
     libc.include.math
     libc.include.pthread
     libc.include.sched
     libc.include.signal
+    libc.include.search
     libc.include.spawn
     libc.include.setjmp
     libc.include.stdio
     libc.include.stdlib
     libc.include.string
     libc.include.termios
     libc.include.threads
     libc.include.time

libc/include/CMakeLists.txt

add_gen_header(
   DEPENDS
     .llvm_libc_common_h
     .llvm-libc-types.mode_t
     .llvm-libc-types.pid_t
     .llvm-libc-types.posix_spawnattr_t
     .llvm-libc-types.posix_spawn_file_actions_t
 )
 
+add_gen_header(
+  search
+  DEF_FILE search.h.def
+  GEN_HDR search.h
+  DEPENDS
+    .llvm_libc_common_h
+    .llvm-libc-types.action
+    .llvm-libc-types.struct_hsearch_data
+    .llvm-libc-types.entry
+    .llvm-libc-types.size_t
+)
+
 # TODO: Not all platforms will have a include/sys directory. Add the sys
 # directory and the targets for sys/*.h files conditional to the OS requiring
 # them.
 file(MAKE_DIRECTORY "sys")
 
 add_gen_header(
   sys_auxv
   DEF_FILE sys/auxv.h.def

libc/include/llvm-libc-types/CMakeLists.txt

 add_header(thrd_t HDR thrd_t.h DEPENDS .__thread_type)
 add_header(tss_t HDR tss_t.h)
 add_header(tss_dtor_t HDR tss_dtor_t.h)
 add_header(__atexithandler_t HDR __atexithandler_t.h)
 add_header(speed_t HDR speed_t.h)
 add_header(tcflag_t HDR tcflag_t.h)
 add_header(struct_termios HDR struct_termios.h DEPENDS .cc_t .speed_t .tcflag_t)
 add_header(__getoptargv_t HDR __getoptargv_t.h)
+add_header(action HDR action.h)
+add_header(entry HDR entry.h)
+add_header(struct_hsearch_data HDR struct_hsearch_data.h)

libc/include/llvm-libc-types/action.h

+//===-- Definition of type enum ACTION ------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef __LLVM_LIBC_TYPES_ENUM_ACTION_H__
+#define __LLVM_LIBC_TYPES_ENUM_ACTION_H__
+
+typedef enum { FIND, ENTER } ACTION;
+
+#endif // __LLVM_LIBC_TYPES_ENUM_ACTION_H__

libc/include/llvm-libc-types/entry.h

+//===-- Definition of type struct ENTRY -----------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef __LLVM_LIBC_TYPES_STRUCT_ENTRY_H__
+#define __LLVM_LIBC_TYPES_STRUCT_ENTRY_H__
+
+typedef struct {
+  char *key;
+  void *data;
+} ENTRY;
+
+#endif // __LLVM_LIBC_TYPES_STRUCT_ENTRY_H__

libc/include/llvm-libc-types/struct_hsearch_data.h

+//===-- Definition of type struct hsearch_data ----------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef __LLVM_LIBC_TYPES_STRUCT_HSEARCH_DATA_H__
+#define __LLVM_LIBC_TYPES_STRUCT_HSEARCH_DATA_H__
+
+struct hsearch_data {
+  void *__opaque;
+  unsigned int __unused[2];
+};
+
+#endif // __LLVM_LIBC_TYPES_STRUCT_HSEARCH_DATA_H__

libc/include/search.h.def

+//===-- POSIX header search.h ---------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_LIBC_SEARCH_H
+#define LLVM_LIBC_SEARCH_H
+
+#include <__llvm-libc-common.h>
+#include <llvm-libc-types/action.h>
+#include <llvm-libc-types/entry.h>
+#include <llvm-libc-types/size_t.h>
+#include <llvm-libc-types/struct_hsearch_data.h>
+
+%%public_api()
+
+#endif // LLVM_LIBC_SEARCH_H

libc/spec/posix.td

[
       FunctionSpec<
           "pthread_once",
           RetValSpec<IntType>,
           [ArgSpec<PThreadOnceTPtr>, ArgSpec<PThreadOnceCallback>]
       >,
     ]
   >;
 
+  NamedType StructHsearchDataName = NamedType<"struct hsearch_data">;
+  PtrType StructHsearchDataNamePtr = PtrType<StructHsearchDataName>;
+  NamedType ActionType = NamedType<"ACTION">;
+  NamedType EntryType = NamedType<"ENTRY">;
+  PtrType EntryTypePtr = PtrType<EntryType>;
+  PtrType EntryTypePtrPtr = PtrType<EntryTypePtr>;
+
+  HeaderSpec Search = HeaderSpec<
+    "search.h",
+    [], // Macros
+    [
+        StructHsearchDataName,
+        ActionType,
+        EntryType
+    ], // Types
+    [], // Enumerations
+    [
+        FunctionSpec<
+            "hcreate",
+            RetValSpec<IntType>,
+            [
+                ArgSpec<SizeTType>
+            ]
+        >,
+        FunctionSpec<
+            "hcreate_r",
+            RetValSpec<IntType>,
+            [  
+                ArgSpec<SizeTType>, 
+                ArgSpec<StructHsearchDataNamePtr>
+            ]
+        >,
+        FunctionSpec<
+            "hdestroy",
+            RetValSpec<VoidType>,
+            [] // Args
+        >,
+        FunctionSpec<
+            "hdestroy_r",
+            RetValSpec<VoidType>,
+            [
+                ArgSpec<StructHsearchDataNamePtr>
+            ]
+        >,
+        FunctionSpec<
+            "hsearch",
+            RetValSpec<EntryTypePtr>,
+            [
+                ArgSpec<EntryType>, 
+                ArgSpec<ActionType>
+            ]
+        >,
+        FunctionSpec<
+            "hsearch_r",
+            RetValSpec<IntType>,
+            [
+                ArgSpec<EntryType>, 
+                ArgSpec<ActionType>,
+                ArgSpec<EntryTypePtrPtr>,
+                ArgSpec<StructHsearchDataNamePtr>
+            ]
+        >,
+    ]
+  >; 
+
   HeaderSpec StdIO = HeaderSpec<
       "stdio.h",
       [], // Macros
       [], // Types
       [], // Enumerations
       [
           FunctionSpec<
               "flockfile",

   let Headers = [
     CType,
     Dirent,
     Errno,
     FCntl,
     PThread,
     Signal,
     Spawn,
+    Search,
     StdIO,
     StdLib,
     SysIOctl,
     SysMMan,
     SysResource,
     SysSelect,
     SysStat,
     SysTypes,
     SysUtsName,
     SysWait,
     Time,
     Termios,
     UniStd,
     String
   ];
 }