pacemaker  1.1.18-36d2962a86
Scalable High-Availability cluster resource manager
internal.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015
3  * Andrew Beekhof <andrew@beekhof.net>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU Lesser General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19 
20 #ifndef CRM_COMMON_INTERNAL__H
21 #define CRM_COMMON_INTERNAL__H
22 
23 #include <glib.h> /* for gboolean */
24 #include <dirent.h> /* for struct dirent */
25 #include <unistd.h> /* for getpid() */
26 #include <sys/types.h> /* for uid_t and gid_t */
27 
28 #include <crm/common/logging.h>
29 
30 /* internal I/O utilities (from io.c) */
31 
32 char *generate_series_filename(const char *directory, const char *series, int sequence,
33  gboolean bzip);
34 int get_last_sequence(const char *directory, const char *series);
35 void write_last_sequence(const char *directory, const char *series, int sequence, int max);
36 int crm_chown_last_sequence(const char *directory, const char *series, uid_t uid, gid_t gid);
37 
38 gboolean crm_is_writable(const char *dir, const char *file, const char *user, const char *group,
39  gboolean need_both);
40 
41 void crm_sync_directory(const char *name);
42 
43 char *crm_read_contents(const char *filename);
44 int crm_write_sync(int fd, const char *contents);
45 
46 
47 /* internal procfs utilities (from procfs.c) */
48 
49 int crm_procfs_process_info(struct dirent *entry, char *name, int *pid);
50 int crm_procfs_pid_of(const char *name);
51 unsigned int crm_procfs_num_cores(void);
52 
53 
54 /* internal XML schema functions (from xml.c) */
55 
56 void crm_schema_init(void);
57 void crm_schema_cleanup(void);
58 
59 
60 /* internal generic string functions (from strings.c) */
61 
62 char *crm_concat(const char *prefix, const char *suffix, char join);
63 void g_hash_destroy_str(gpointer data);
64 long long crm_int_helper(const char *text, char **end_text);
65 bool crm_starts_with(const char *str, const char *prefix);
66 gboolean crm_ends_with(const char *s, const char *match);
67 gboolean crm_ends_with_ext(const char *s, const char *match);
68 char *add_list_element(char *list, const char *value);
69 bool crm_compress_string(const char *data, int length, int max, char **result,
70  unsigned int *result_len);
71 gint crm_alpha_sort(gconstpointer a, gconstpointer b);
72 
73 static inline int
74 crm_strlen_zero(const char *s)
75 {
76  return !s || *s == '\0';
77 }
78 
79 static inline char *
80 crm_getpid_s()
81 {
82  return crm_strdup_printf("%lu", (unsigned long) getpid());
83 }
84 
85 /* convenience functions for failure-related node attributes */
86 
87 #define CRM_FAIL_COUNT_PREFIX "fail-count"
88 #define CRM_LAST_FAILURE_PREFIX "last-failure"
89 
107 static inline char *
108 crm_fail_attr_name(const char *prefix, const char *rsc_id, const char *op,
109  int interval)
110 {
111  CRM_CHECK(prefix && rsc_id && op, return NULL);
112  return crm_strdup_printf("%s-%s#%s_%d", prefix, rsc_id, op, interval);
113 }
114 
115 static inline char *
116 crm_failcount_name(const char *rsc_id, const char *op, int interval)
117 {
118  return crm_fail_attr_name(CRM_FAIL_COUNT_PREFIX, rsc_id, op, interval);
119 }
120 
121 static inline char *
122 crm_lastfailure_name(const char *rsc_id, const char *op, int interval)
123 {
124  return crm_fail_attr_name(CRM_LAST_FAILURE_PREFIX, rsc_id, op, interval);
125 }
126 
127 #endif /* CRM_COMMON_INTERNAL__H */
#define CRM_CHECK(expr, failure_action)
Definition: logging.h:164
void crm_schema_init(void)
Definition: schemas.c:273
int get_last_sequence(const char *directory, const char *series)
Definition: io.c:121
#define CRM_LAST_FAILURE_PREFIX
Definition: internal.h:88
long long crm_int_helper(const char *text, char **end_text)
Definition: strings.c:80
void crm_schema_cleanup(void)
Definition: schemas.c:512
uint32_t pid
Definition: internal.h:49
char * generate_series_filename(const char *directory, const char *series, int sequence, gboolean bzip)
Definition: io.c:85
bool crm_starts_with(const char *str, const char *prefix)
Check whether a string starts with a certain sequence.
Definition: strings.c:252
Wrappers for and extensions to libqb logging.
char * crm_read_contents(const char *filename)
Definition: io.c:394
#define CRM_FAIL_COUNT_PREFIX
Definition: internal.h:87
char * add_list_element(char *list, const char *value)
Definition: strings.c:394
gint crm_alpha_sort(gconstpointer a, gconstpointer b)
Compare two strings alphabetically (case-insensitive)
Definition: strings.c:472
gboolean crm_ends_with_ext(const char *s, const char *match)
Definition: strings.c:331
gboolean crm_ends_with(const char *s, const char *match)
Definition: strings.c:302
int crm_procfs_process_info(struct dirent *entry, char *name, int *pid)
Definition: procfs.c:47
gboolean crm_is_writable(const char *dir, const char *file, const char *user, const char *group, gboolean need_both)
Definition: io.c:278
void write_last_sequence(const char *directory, const char *series, int sequence, int max)
Definition: io.c:193
bool crm_compress_string(const char *data, int length, int max, char **result, unsigned int *result_len)
Definition: strings.c:413
unsigned int crm_procfs_num_cores(void)
Definition: procfs.c:152
int crm_write_sync(int fd, const char *contents)
Definition: io.c:440
char data[0]
Definition: internal.h:58
int crm_chown_last_sequence(const char *directory, const char *series, uid_t uid, gid_t gid)
Definition: io.c:250
void crm_sync_directory(const char *name)
Definition: io.c:357
char * crm_concat(const char *prefix, const char *suffix, char join)
Definition: strings.c:32
int crm_procfs_pid_of(const char *name)
Definition: procfs.c:118
char * crm_strdup_printf(char const *format,...) __attribute__((__format__(__printf__
void g_hash_destroy_str(gpointer data)
Definition: strings.c:74