mirrors/libguestfs
1
0
Fork 0
mirror of https://github.com/libguestfs/libguestfs.git synced 2026-03-21 22:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
049b5d8a58faddb69437bbafeb0d781cb4855fff
libguestfs/generator/errnostring.ml
Richard W.M. Jones 02b64d5cec generator: Use quoted string literals in many places 
This change was done almost entirely automatically using the script
below.  This uses the OCaml lexer to read the source files and extract
the strings and locations.  Strings which are "candidates" (in this
case, longer than 3 lines) are replaced in the output with quoted
string literals.

Since the OCaml lexer is used, it already substitutes all escape
sequences correctly.  I diffed the output of the generator and it is
identical after this change, except for UUIDs, which change because of
how Utils.stable_uuid is implemented.

Thanks: Nicolas Ojeda Bar

$ ocamlfind opt -package unix,compiler-libs.common find_strings.ml \
                -o find_strings.opt -linkpkg
$ for f in $( git ls-files -- \*.ml ) ; do ./find_strings.opt $f ; done

open Printf

let read_whole_file path =
  let buf = Buffer.create 16384 in
  let chan = open_in path in
  let maxlen = 16384 in
  let b = Bytes.create maxlen in
  let rec loop () =
    let r = input chan b 0 maxlen in
    if r > 0 then (
      Buffer.add_substring buf (Bytes.to_string b) 0 r;
      loop ()
    )
  in
  loop ();
  close_in chan;
  Buffer.contents buf

let count_chars c str =
  let count = ref 0 in
  for i = 0 to String.length str - 1 do
    if c = String.unsafe_get str i then incr count
  done;
  !count

let subs = ref []

let consider_string str loc =
  let nr_lines = count_chars '\n' str in
  if nr_lines > 3 then
    subs := (str, loc) :: !subs

let () =
  Lexer.init ();
  let filename = Sys.argv.(1) in
  let content = read_whole_file filename in
  let lexbuf = Lexing.from_string content in
  let rec loop () =
    let token = Lexer.token lexbuf in
    (match token with
     | Parser.EOF -> ();
     | STRING (s, loc, sopt) ->
        consider_string s loc; (* sopt? *)
        loop ();
     | token ->
        loop ();
    )
  in
  loop ();

  (* The list of subs is already reversed, which is convenient
   * because we must the file substitutions in reverse order.
   *)
  let subs = !subs in
  let new_content = ref content in
  List.iter (
    fun (str, loc) ->
      let { Location.loc_start = { pos_cnum = p1 };
            loc_end = { pos_cnum = p2 } } = loc in
      let len = String.length !new_content in
      let before = String.sub !new_content 0 (p1-1) in
      let after = String.sub !new_content (p2+1) (len - p2 - 1) in
      new_content := before ^ "{|" ^ str ^ "|}" ^ after
  ) subs;

  let new_content = !new_content in

  if content <> new_content then (
    (* Update the file in place. *)
    let new_filename = filename ^ ".new"
    and backup_filename = filename ^ ".bak" in
    let chan = open_out new_filename in
    fprintf chan "%s" new_content;
    close_out chan;
    Unix.rename filename backup_filename;
    Unix.rename new_filename filename
  )
2025-09-01 17:08:52 +01:00

339 lines
7.2 KiB
OCaml
Raw Blame History

(* libguestfs
* Copyright (C) 2010 Red Hat Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*)
(* Please read generator/README first. *)
open Printf
open Std_utils
open Types
open Utils
open Pr
open Docstrings
let generate_header = generate_header ~inputs:["generator/errnostring.ml"]
(* Generate the functions errno_to_string and string_to_errno which
* convert errno (eg. EINVAL) into string ("EINVAL") and back again,
* allowing us to portably pass error values over the protocol between
* different versions of Un*x.
*)
(* Errors found in POSIX plus additional errors found in the Linux
* header files. NOTE keep this sorted and avoid duplicates.
*)
let errnos = [
"E2BIG";
"EACCES";
"EADDRINUSE";
"EADDRNOTAVAIL";
"EADV";
"EAFNOSUPPORT";
"EAGAIN";
"EALREADY";
"EBADE";
"EBADF";
"EBADFD";
"EBADMSG";
"EBADR";
"EBADRQC";
"EBADSLT";
"EBFONT";
"EBUSY";
"ECANCELED";
"ECHILD";
"ECHRNG";
"ECOMM";
"ECONNABORTED";
"ECONNREFUSED";
"ECONNRESET";
(*"EDEADLK"; - same as EDEADLOCK*)
"EDEADLOCK";
"EDESTADDRREQ";
"EDOM";
"EDOTDOT";
"EDQUOT";
"EEXIST";
"EFAULT";
"EFBIG";
"EHOSTDOWN";
"EHOSTUNREACH";
"EIDRM";
"EILSEQ";
"EINPROGRESS";
"EINTR";
"EINVAL";
"EIO";
"EISCONN";
"EISDIR";
"EISNAM";
"EKEYEXPIRED";
"EKEYREJECTED";
"EKEYREVOKED";
"EL2HLT";
"EL2NSYNC";
"EL3HLT";
"EL3RST";
"ELIBACC";
"ELIBBAD";
"ELIBEXEC";
"ELIBMAX";
"ELIBSCN";
"ELNRNG";
"ELOOP";
"EMEDIUMTYPE";
"EMFILE";
"EMLINK";
"EMSGSIZE";
"EMULTIHOP";
"ENAMETOOLONG";
"ENAVAIL";
"ENETDOWN";
"ENETRESET";
"ENETUNREACH";
"ENFILE";
"ENOANO";
"ENOBUFS";
"ENOCSI";
"ENODATA";
"ENODEV";
"ENOENT";
"ENOEXEC";
"ENOKEY";
"ENOLCK";
"ENOLINK";
"ENOMEDIUM";
"ENOMEM";
"ENOMSG";
"ENONET";
"ENOPKG";
"ENOPROTOOPT";
"ENOSPC";
"ENOSR";
"ENOSTR";
"ENOSYS";
"ENOTBLK";
"ENOTCONN";
"ENOTDIR";
"ENOTEMPTY";
"ENOTNAM";
"ENOTRECOVERABLE";
"ENOTSOCK";
"ENOTSUP";
"ENOTTY";
"ENOTUNIQ";
"ENXIO";
(*"EOPNOTSUPP"; - duplicates another error, and we don't care because
it's a network error *)
"EOVERFLOW";
"EOWNERDEAD";
"EPERM";
"EPFNOSUPPORT";
"EPIPE";
"EPROTO";
"EPROTONOSUPPORT";
"EPROTOTYPE";
"ERANGE";
"EREMCHG";
"EREMOTE";
"EREMOTEIO";
"ERESTART";
"ERFKILL";
"EROFS";
"ESHUTDOWN";
"ESOCKTNOSUPPORT";
"ESPIPE";
"ESRCH";
"ESRMNT";
"ESTALE";
"ESTRPIPE";
"ETIME";
"ETIMEDOUT";
"ETOOMANYREFS";
"ETXTBSY";
"EUCLEAN";
"EUNATCH";
"EUSERS";
(*"EWOULDBLOCK"; - same as EAGAIN*)
"EXDEV";
"EXFULL";
(* This is a non-existent errno which is simply used to test that
* the generated code can handle such cases on future platforms
* where one of the above error codes might not exist.
*)
"EZZZ";
]
let () =
(* Check list is sorted and no duplicates. *)
let file = "generator/errnostring.ml" in
let check str =
let len = String.length str in
if len == 0 || len > 32 then
failwithf "%s: errno empty or length > 32 (%s)" file str;
if str.[0] <> 'E' then
failwithf "%s: errno string does not begin with letter 'E' (%s)" file str;
for i = 0 to len-1 do
let c = str.[i] in
if Char.uppercase_ascii c <> c then
failwithf "%s: errno string is not all uppercase (%s)" file str
done
in
let rec loop = function
| [] -> ()
| x :: y :: xs when x = y ->
failwithf "%s: errnos list contains duplicates (%s)" file x
| x :: y :: xs when x > y ->
failwithf "%s: errnos list is not sorted (%s > %s)" file x y
| x :: xs -> check x; loop xs
in
loop errnos
let generate_errnostring_h () =
generate_header CStyle LGPLv2plus;
pr {|
#ifndef GUESTFS_ERRNOSTRING_H_
#define GUESTFS_ERRNOSTRING_H_
/* Convert errno (eg. EIO) to its string representation ("EIO").
* This only works for a set of errors that are listed in the generator
* AND are supported on the local operating system. For other errors
* the string ("EINVAL") is returned.
*
* NOTE: It is an error to call this function with errnum == 0.
*/
extern const char *guestfs_int_errno_to_string (int errnum);
/* Convert string representation of an error (eg. "EIO") to the errno
* value (EIO). As for the function above, this only works for a
* subset of errors. For errors not supported by the local operating
* system, EINVAL is returned (all POSIX-conforming systems must
* support EINVAL).
*/
extern int guestfs_int_string_to_errno (const char *errnostr);
/* Private structure used by the perfect hash implementation. */
struct errnostring_entry { char *name; int errnum; };
#endif /* GUESTFS_ERRNOSTRING_H_ */
|}
let generate_errnostring_c () =
generate_header CStyle LGPLv2plus;
pr {|#include <config.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include "errnostring.h"
static const char *errno_to_string[] = {
|};
List.iter (
fun e ->
pr "#ifdef %s\n" e;
pr " [%s] = \"%s\",\n" e e;
pr "#endif\n"
) errnos;
pr {|};
#define ERRNO_TO_STRING_SIZE \
(sizeof errno_to_string / sizeof errno_to_string[0])
const char *
guestfs_int_errno_to_string (int errnum)
{
/* See function documentation. */
if (errnum == 0)
abort ();
if (errnum < 0 || (size_t) errnum >= ERRNO_TO_STRING_SIZE ||
errno_to_string[errnum] == NULL)
return "EINVAL";
else
return errno_to_string[errnum];
}
|}
let generate_errnostring_gperf () =
generate_header CStyle LGPLv2plus;
pr {|%%language=ANSI-C
%%define lookup-function-name guestfs_int_string_to_errno_lookup
%%readonly-tables
%%null-strings
%%{
#include <config.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include "errnostring.h"
|};
(* Some of these errnos might not exist on the target platform, but
* we are going to include E_ macros directly in the C output of
* gperf. To avoid this causing errors, we include macros to define
* unknown errors as EINVAL (see specification of
* guestfs_int_string_to_errno above). Note this only affects the
* single output file containing gperf-generated code.
*)
List.iter (
fun e ->
pr "#ifndef %s\n" e;
pr "#define %s EINVAL\n" e;
pr "#endif\n";
) errnos;
pr {|
%%}
struct errnostring_entry;
%%%%
|};
List.iter (
fun e ->
pr "%s, %s\n" e e
) errnos;
pr {|%%%%
int
guestfs_int_string_to_errno (const char *errnostr)
{
const struct errnostring_entry *v =
guestfs_int_string_to_errno_lookup (errnostr, strlen (errnostr));
if (v /* not necessary to check v->name != NULL here */)
return v->errnum;
else
return EINVAL;
}
|}
Reference in New Issue View Git Blame Copy Permalink