Skip to content

Improve handling of longer PV names #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eddybl wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve handling of longer PV names #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d9a9be
More consitent usage of `PV_NAME_LEN` instead of hardcoded string len…
eddybl Mar 12, 2026
0632ba7
Use EPICS base definition for PV length.
eddybl Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions asApp/src/dbrestore.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -755,7 +755,7 @@ long SR_array_restore(int pass, FILE *inp_fd, char *PVname, char *value_string,
*/
int reboot_restore(char *filename, initHookState init_state)
{
char PVname[PV_NAME_LEN + 1]; /* Must be greater than max field width ("%80s") in the sscanf format below */
char PVname[PV_NAME_LEN + 1]; /* Must be PV_NAME_LEN + 1 so that we can detect names that are too long. */
char bu_filename[PATH_SIZE + 1], fname[PATH_SIZE + 1] = "";
char buffer[BUF_SIZE], *bp;
char ebuffer[EBUF_SIZE]; /* make room for macro expansion */
Expand All @@ -770,7 +770,7 @@ int reboot_restore(char *filename, initHookState init_state)
int n, write_backup, num_errors, is_scalar;
long *pStatusVal = 0;
char *statusStr = 0;
char realName[64]; /* name without trailing '$' */
char realName[PV_NAME_LEN+1]; /* name without trailing '$' */
int is_long_string;
struct restoreFileListItem *pLI;
/* macrostring */
Expand Down Expand Up @@ -858,6 +858,7 @@ int reboot_restore(char *filename, initHookState init_state)
/* restore from data file */
num_errors = 0;
while ((bp = fgets(buffer, BUF_SIZE, inp_fd))) {
int name_len = 0;
if (handle && pairs) {
ebuffer[0] = '\0';
macExpandString(handle, buffer, ebuffer, EBUF_SIZE);
Expand All @@ -882,8 +883,16 @@ int reboot_restore(char *filename, initHookState init_state)
*/
PVname[0] = '\0';
value_string[0] = '\0';
n = sscanf(bp, "%80s%c%[^\n\r]", PVname, &c, value_string);
if (n < 3) *value_string = 0;
n = sscanf(bp, "%*s%n%c%[^\n\r]", &name_len, &c, value_string);
/* PVname can store one more character than PV_NAME_LEN. */
if (name_len <= PV_NAME_LEN) {
strncpy(PVname, bp, name_len);
PVname[name_len] = '\0';
} else {
strncpy(PVname, bp, PV_NAME_LEN);
PVname[PV_NAME_LEN] = '\0';
}
if (n < 2) *value_string = 0;
if ((n < 1) || (PVname[0] == '\0')) {
if (save_restoreDebug >= 10) {
ERRLOG("line (fragment) '%s' ignored.\n", bp);
Expand All @@ -900,7 +909,7 @@ int reboot_restore(char *filename, initHookState init_state)
}
continue;
}
if (strlen(PVname) >= 80) {
if (strlen(PVname) >= PV_NAME_LEN) {
/* must be a munged input line */
ERRLOG("'%s' is too long to be a PV name.\n", PVname);
continue;
Expand Down Expand Up @@ -930,7 +939,7 @@ int reboot_restore(char *filename, initHookState init_state)

/* dbStatic doesn't know about long-string fields (PV name with appended '$'). */
is_long_string = 0;
strNcpy(realName, PVname, 63);
strNcpy(realName, PVname, PV_NAME_LEN);
if (realName[strlen(realName) - 1] == '$') {
realName[strlen(realName) - 1] = '\0';
is_long_string = 1;
Expand Down
29 changes: 19 additions & 10 deletions asApp/src/save_restore.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ struct chlist { /* save set list element */

struct channel { /* database channel list element */
struct channel *pnext; /* next channel */
char name[64]; /* channel name */
char name[PV_NAME_LEN + 1]; /* channel name */
chid chid; /* channel access id */
char value[64]; /* value string */
short enum_val; /* short value of an enumerated field */
Expand Down Expand Up @@ -3126,7 +3126,7 @@ STATIC int do_manual_restore(char *filename, int file_type, char *macrostring)
struct channel *pchannel;
struct chlist *plist;
int found, is_scalar;
char PVname[80];
char PVname[PV_NAME_LEN + 1];
char restoreFile[MAX_PATH_LEN + 1] = "";
char bu_filename[MAX_PATH_LEN + 1] = "";
char buffer[BUF_SIZE], *bp, c;
Expand Down Expand Up @@ -3238,6 +3238,7 @@ STATIC int do_manual_restore(char *filename, int file_type, char *macrostring)

/* restore from data file */
while ((bp = fgets(buffer, BUF_SIZE, inp_fd))) {
int name_len = 0;
if (handle && pairs) {
ebuffer[0] = '\0';
macExpandString(handle, buffer, ebuffer, EBUF_SIZE);
Expand All @@ -3248,8 +3249,16 @@ STATIC int do_manual_restore(char *filename, int file_type, char *macrostring)
/* (value may be a string with leading whitespace; it may be */
/* entirely whitespace; the number of spaces may be crucial; */
/* it might also consist of zero characters) */
n = sscanf(bp, "%s%c%[^\n]", PVname, &c, value_string);
if (n < 3) *value_string = 0;
n = sscanf(bp, "%*s%n%c%[^\n]", &name_len, &c, value_string);
if (n < 2) *value_string = 0;
/* PVname can store one more character than PV_NAME_LEN. */
if (name_len <= PV_NAME_LEN) {
strncpy(PVname, bp, name_len);
PVname[name_len] = '\0';
} else {
strncpy(PVname, bp, PV_NAME_LEN);
PVname[PV_NAME_LEN] = '\0';
}
if (strncmp(PVname, "<END>", 5) == 0) { break; }
if (save_restoreDebug >= 5) { printf("save_restore:do_manual_restore: PVname='%s'\n", PVname); }
if (isValid1stPVChar((int)PVname[0])) {
Expand Down Expand Up @@ -3466,7 +3475,7 @@ STATIC int readReqFile(const char *reqFile, struct chlist *plist, char *macrostr
{
struct channel *pchannel = NULL;
FILE *inp_fd = NULL;
char name[80] = "", *t = NULL, line[BUF_SIZE] = "", eline[EBUF_SIZE] = "";
char name[PV_NAME_LEN] = "", *t = NULL, line[BUF_SIZE] = "", eline[EBUF_SIZE] = "";
char templatefile[MAX_PATH_LEN + 1] = "";
char new_macro[BUF_SIZE] = "";
int i = 0;
Expand Down Expand Up @@ -3597,7 +3606,7 @@ STATIC int readReqFile(const char *reqFile, struct chlist *plist, char *macrostr
}
plist->plast_chan = pchannel;
#endif
strNcpy(pchannel->name, name, 64);
strNcpy(pchannel->name, name, PV_NAME_LEN);
strNcpy(pchannel->value, "Not Connected", 64);
pchannel->enum_val = -1;
pchannel->max_elements = 0;
Expand All @@ -3616,16 +3625,16 @@ STATIC int readReqFile(const char *reqFile, struct chlist *plist, char *macrostr
* this can only be done when the list is defined.
*/
if (handle) {
if (macGetValue(handle, "SAVEPATHPV", name, 80) > 0) {
if (macGetValue(handle, "SAVEPATHPV", name, PV_NAME_LEN) > 0) {
plist->do_backups = 0;
strNcpy(plist->savePathPV, name, PV_NAME_LEN);
}
if (macGetValue(handle, "SAVENAMEPV", name, 80) > 0) {
if (macGetValue(handle, "SAVENAMEPV", name, PV_NAME_LEN) > 0) {
plist->do_backups = 0;
strNcpy(plist->saveNamePV, name, PV_NAME_LEN);
}
if (macGetValue(handle, "CONFIG", name, 80) > 0) { strNcpy(plist->config, name, PV_NAME_LEN); }
if (macGetValue(handle, "CONFIGMENU", name, 80) > 0) { plist->do_backups = 0; }
if (macGetValue(handle, "CONFIG", name, PV_NAME_LEN) > 0) { strNcpy(plist->config, name, PV_NAME_LEN); }
if (macGetValue(handle, "CONFIGMENU", name, PV_NAME_LEN) > 0) { plist->do_backups = 0; }
macDeleteHandle(handle);
if (pairs) free(pairs);
}
Expand Down
5 changes: 4 additions & 1 deletion asApp/src/save_restore.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/* save_restore.h */

#include <dbDefs.h> /* PVNAME_STRINGSZ for PV length*/
#include <ellLib.h> /* pass0List, pass1List */
#include <initHooks.h>
#include "save_restore_common.h"
Expand Down Expand Up @@ -51,7 +52,9 @@
#define FN_LEN 80 /* filename length */
#define STRING_LEN MAX_STRING_SIZE /* EPICS max length for string PV */
#define STATUS_STR_LEN 300
#define PV_NAME_LEN 80 /* string containing a PV name */
/* PV_NAME_LENGTH was historcially at least 80, so we ensure it is at least that and otherwise use
PVNAME_STRINGSZ from EPICS base dbDefs.h */
#define PV_NAME_LEN ((PVNAME_SZ > 80) ? (PVNAME_SZ) : (80)) /* string containing a PV name */
#define MAXSTRING 300

struct restoreFileListItem {
Expand Down
18 changes: 12 additions & 6 deletions asApp/src/verify.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@

#include "save_restore.h"

#ifndef PVNAME_STRINGSZ
#define PVNAME_STRINGSZ 61 /* includes terminating null */
#endif
#define PEND_TIME 5.0

#define FSMALL 1.e-6
Expand Down Expand Up @@ -122,6 +119,7 @@ int do_asVerify_fp(FILE *fp, int verbose, int debug, int write_restore_file, cha
}

while ((bp = fgets(s, BUF_SIZE, fp))) {
int name_len = 0;
if (debug > 3) printf("\nasVerify: buffer '%s'\n", bp);
if (bp[0] == '#') {
/* A PV to which autosave could not connect, or just a comment in the file. */
Expand All @@ -130,11 +128,19 @@ int do_asVerify_fp(FILE *fp, int verbose, int debug, int write_restore_file, cha
continue;
}
/* NOTE value_string must have room for nearly BUF_SIZE characters */
n = sscanf(bp, "%80s%c%[^\n\r]", PVname, &c, value_string);
n = sscanf(bp, "%*s%n%c%[^\n\r]", &name_len, &c, value_string);
/* PVname can store one more character than PV_NAME_LEN. */
if (name_len <= PV_NAME_LEN) {
strncpy(PVname, bp, name_len);
PVname[name_len] = '\0';
} else {
strncpy(PVname, bp, PV_NAME_LEN);
PVname[PV_NAME_LEN] = '\0';
}
if (debug > 3)
printf("\nasVerify: PVname='%s', value_string[%d]='%s'\n", PVname, (int)strlen(value_string), value_string);
if (n < 3) *value_string = 0;
if (strlen(PVname) >= PVNAME_STRINGSZ) {
if (n < 2) *value_string = 0;
if (strlen(PVname) >= PV_NAME_LEN + 1) {
/* Impossible PV name */
if (write_restore_file) fprintf(fr, "#? %s", bp);
continue;
Expand Down
Loading